Merge lp:~vila/u1-test-utils/sudo-opt-in into lp:u1-test-utils

[Vincent Ladeuil]

Tests requiring sudo should use an opt-in mechanism, nobody should blindly accept running them.

sudo access is hard to guess but it doesn't imply the user want to use it during tests.

This use ~/.setup_vm.use_sudo_for_tests as an opt-in mechanism instead.

[Leo Arias (elopio)]

review: Approve (code review)

[Natalia Bidart (nataliabidart)]

Looks good!

review: Approve

=== modified file 'setup_vm/tests/__init__.py'
--- setup_vm/tests/__init__.py	2013-08-08 10:10:01 +0000
+++ setup_vm/tests/__init__.py	2013-08-13 16:04:05 +0000
@@ -133,29 +133,32 @@
 qemu_img_feature = ExecutableFeature('qemu-img')
 
 
-class _SudoFeature(Feature):
+class _UseSudoForTestsFeature(Feature):
     """User has sudo access.
 
     There is no direct way to test for sudo access other than trying to use
     it. This is not something we can do in automated tests as it requires user
     input.
 
-    Instead, we look for '~/.sudo_as_admin_succesful' as a proof that the user
-    succeeded in the past.
-
-    This is mostly useful to avoid attempting to use sudo on jenkins where it's
-    unlikely to be configured.
+    Whatever trick is used to guess whether or not the user *can* sudo won't
+    tell us if she agrees to run the sudo tests. Instead, this should rely on
+    an opt-in mechanism so each user decides whether or not she wants to run
+    the tests.
     """
 
     def _probe(self):
-        path = os.path.expanduser('~/.sudo_as_admin_successful')
+        # I.e. if you want to run the tests that requires sudo issue:
+        # $ touch ~/.setup_vm.use_sudo_for_tests
+        # if you don't, issue:
+        # $ rm -f ~/.setup_vm.use_sudo_for_tests
+        path = os.path.expanduser('~/.setup_vm.use_sudo_for_tests')
         return os.path.exists(path)
 
     def feature_name(self):
         return 'sudo access'
 
 
-sudo_feature = _SudoFeature()
+use_sudo_for_tests_feature = _UseSudoForTestsFeature()
 
 
 class _SshFeature(ExecutableFeature):

=== modified file 'setup_vm/tests/test_setup_vm.py'
--- setup_vm/tests/test_setup_vm.py	2013-08-09 08:06:27 +0000
+++ setup_vm/tests/test_setup_vm.py	2013-08-13 16:04:05 +0000
@@ -169,7 +169,7 @@
 # level and be done -- vila 2013-08-06
 
     def setUp(self):
-        tests.requires_feature(self, tests.sudo_feature)
+        tests.requires_feature(self, tests.use_sudo_for_tests_feature)
         # Downloading real isos or images is too long for tests, instead, we
         # fake it by downloading a small but known to exist file: MD5SUMS
         super(TestDownload, self).setUp()
@@ -637,7 +637,7 @@
 class TestSeedImage(TestCaseWithHome):
 
     def setUp(self):
-        tests.requires_feature(self, tests.sudo_feature)
+        tests.requires_feature(self, tests.use_sudo_for_tests_feature)
         tests.requires_feature(self, tests.qemu_img_feature)
         super(TestSeedImage, self).setUp()
         self.conf = svm.VmStack('foo')
@@ -662,7 +662,7 @@
 class TestImageFromCloud(TestCaseWithHome):
 
     def setUp(self):
-        tests.requires_feature(self, tests.sudo_feature)
+        tests.requires_feature(self, tests.use_sudo_for_tests_feature)
         tests.requires_feature(self, tests.qemu_img_feature)
         super(TestImageFromCloud, self).setUp()
         self.conf = svm.VmStack('foo')
@@ -696,7 +696,7 @@
 class TestImageWithBacking(TestCaseWithHome):
 
     def setUp(self):
-        tests.requires_feature(self, tests.sudo_feature)
+        tests.requires_feature(self, tests.use_sudo_for_tests_feature)
         (download_cache_dir,
          reference_cloud_image_name) = requires_known_reference_image(self)
         super(TestImageWithBacking, self).setUp()
@@ -870,7 +870,7 @@
 class TestInstallWithSeed(TestCaseWithHome):
 
     def setUp(self):
-        tests.requires_feature(self, tests.sudo_feature)
+        tests.requires_feature(self, tests.use_sudo_for_tests_feature)
         (download_cache,
          reference_cloud_image_name) = requires_known_reference_image(self)
         super(TestInstallWithSeed, self).setUp()
@@ -907,7 +907,7 @@
 class TestInstallWithBacking(TestCaseWithHome):
 
     def setUp(self):
-        tests.requires_feature(self, tests.sudo_feature)
+        tests.requires_feature(self, tests.use_sudo_for_tests_feature)
         (download_cache_dir,
          reference_cloud_image_name) = requires_known_reference_image(self)
         super(TestInstallWithBacking, self).setUp()