Merge lp:~doanac/utah/unit-test-regressions into lp:utah

[Andy Doan]

This fixes some stuff in our client unit tests

[Max Brustkern (nuclearbob)]

On 177-181, is there a reason the with was dumped?

Other than that, this looks good to me.

[Joe Talbott (joetalbott)]

L177 seems backwards.

L46 don't we still need to raise an exception if non-root, setUp and cleanUp aren't guaranteed to be called sequentially.

Other than that, LGTM

[Andy Doan (doanac)]

177 is backwards, must have mis-merged stuff.

joe for line 46: I don't think you have to check for root in teardown, because setup will have failed if the user isn't root and thus those directories won't exist for cleanup

[lp:~doanac/utah/unit-test-regressions]

846. By Andy Doan on 2013-03-21

fix review comment

I somehow reverted this from max's branch

[Joe Talbott (joetalbott)]

L46: makes sense to me.

LGTM.

review: Approve

[Max Brustkern (nuclearbob)]

I like it. I'll go ahead and merge.

review: Approve

=== modified file 'utah/client/tests/common.py'
--- utah/client/tests/common.py	2013-03-21 21:24:22 +0000
+++ utah/client/tests/common.py	2013-03-21 21:24:22 +0000
@@ -59,8 +59,7 @@
 
 master_runlist = os.path.join(UTAH_DIR, MASTER_RUNLIST)
 master_runlist_bak = master_runlist + ".bak"
-examples_dir = os.path.join(UTAH_DIR, 'testsuites', 'examples')
-#examples_source = os.path.join(UTAH_CLIENT, 'examples')
+ts_dir = os.path.join(UTAH_DIR, 'testsuites')
 examples_source = os.path.join(get_module_path(), 'client', 'examples')
 
 
@@ -72,15 +71,21 @@
 
     # If we're not root don't bother
     if os.geteuid() != 0 and os.getuid() != 0:
-        return
+        raise RuntimeError('These tests must be run as root')
 
     # save a copy of the master runlist
     if os.path.exists(master_runlist):
         os.rename(master_runlist, master_runlist_bak)
 
-    # Copy the examples directory into the working directory
-    if not os.path.exists(examples_dir):
-        shutil.copytree(examples_source, examples_dir)
+    if os.path.exists(ts_dir):
+        shutil.rmtree(ts_dir)
+    for x in os.listdir(examples_source):
+        p = os.path.join(examples_source, x)
+        if os.path.isdir(p):
+            # NOTE: the runner expects the directory tree for test suite to
+            # look like:
+            #   /var/lib/utah/testsuites/<tsname>/<tsname>/tslist.run
+            shutil.copytree(p, os.path.join(ts_dir, x, x))
 
     with open(master_runlist, 'w') as fp:
         fp.write(master_runlist_content)
@@ -91,18 +96,14 @@
     Cleanup after ourselves.
     """
 
-    # If we're not root don't bother
-    if os.geteuid() != 0 and os.getuid() != 0:
-        return
-
     # restore the copy of the master runlist
     if os.path.exists(master_runlist_bak):
         os.rename(master_runlist_bak, master_runlist)
-    else:
+    elif os.path.exists(master_runlist):
         os.remove(master_runlist)
 
-    if os.path.exists(examples_dir):
-        shutil.rmtree(examples_dir)
+    if os.path.exists(ts_dir):
+        shutil.rmtree(ts_dir)
 
 
 def _get_partial_state_file(filename):

=== modified file 'utah/client/tests/test_runner.py'
--- utah/client/tests/test_runner.py	2013-03-21 21:24:22 +0000
+++ utah/client/tests/test_runner.py	2013-03-21 21:24:22 +0000
@@ -58,28 +58,21 @@
                 raise
 
     def test_fetch_failed(self):
-        print "Starting test"
-        # exit 2 should be flagged as an error.
-        bad_runlist_content = ('---\n'
-                               '- name: fake_tests\n'
-                               '  fetch_method: bzr\n'
-                               '  fetch_location: /dev/null\n')
+        bad_runlist_content = """---
+testsuites:
+  - name: fake_tests
+    fetch_method: bzr
+    fetch_location: /dev/null
+"""
         runlist = '/tmp/master_fetch_fails.run'
 
-        self.assertFalse(os.path.exists(runlist), runlist)
-
         with open(runlist, 'w') as fp:
             fp.write(bad_runlist_content)
 
         runner = Runner(install_type='desktop', result_class=self.result_class,
                         state_agent=self.state_agent, runlist=runlist)
 
-        # remove the runlist as early as possible to avoid leaving it
-        # laying around if this test fails.
-        try:
-            os.remove(runlist)
-        except OSError:
-            pass
+        os.remove(runlist)
 
         runner.run()
         print runner.report()
@@ -98,7 +91,7 @@
         for suite in self.runner.suites:
             self.assertTrue(suite.is_done())
 
-        self.assertEqual(retcode, ReturnCodes.ERROR)
+        self.assertEqual(retcode, ReturnCodes.FAIL)
 
     def test_missing_testdir(self):
         """

=== modified file 'utah/client/tests/test_state_agent.py'
--- utah/client/tests/test_state_agent.py	2013-03-21 21:24:22 +0000
+++ utah/client/tests/test_state_agent.py	2013-03-21 21:24:22 +0000
@@ -14,19 +14,16 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import os
-import shutil
 import unittest
 import yaml
 
 from utah.client.state_agent import StateAgentYAML
 from utah.client.runner import Runner
 from utah.client.result import ResultYAML
-from utah.client.common import UTAH_DIR
 
-from .common import (  # NOQA
+from utah.client.tests.common import (
     setUp,  # Used by nosetests
     tearDown,  # Used by nosetests
-    get_module_path,
     partial_state_file_content,
     partial_state_file_content_run_all,
     partial_state_file_content_done_all_failed,
@@ -40,32 +37,21 @@
         """
         self.state_file = '/tmp/state.yaml'
 
-        # Fail if there is already a test state file.
-        self.assertFalse(
-            os.path.exists(self.state_file),
-            "state file (%s) already exists" % self.state_file)
+        if os.path.exists(self.state_file):
+            os.unlink(self.state_file)
 
         self.state_agent = StateAgentYAML(state_file=self.state_file)
         self.runner = Runner(
             install_type="desktop", result_class=ResultYAML,
             state_agent=self.state_agent)
-        self.partial_state_file_content = partial_state_file_content
-        self.partial_state_file_content_run_all = \
-            partial_state_file_content_run_all
-        self.partial_state_file_content_done_all_failed = \
-            partial_state_file_content_done_all_failed
 
     def tearDown(self):
         """
         Clean up the test state file.
         """
-        try:
+
+        if os.path.exists(self.state_file):
             os.remove(self.state_file)
-        except OSError as e:
-            if e.errno == 2:  # does not exist
-                pass
-            else:
-                raise
 
     def test_creation(self):
         self.runner.run()
@@ -99,136 +85,57 @@
         self.assertEqual(self.runner.count_suites(), suite_count)
         self.assertEqual(self.runner.count_tests(), test_count)
 
-        with open(self.state_file, 'r') as fp:
-            state_data = yaml.load(fp)
+        with open(self.state_file, 'r') as f:
+            state_data = yaml.load(f)
 
         self.assertEqual(state_data['status'], 'DONE')
 
+    def _test_partial(self, content, next_test, passes, fails, errors):
+        with open(self.state_file, 'w') as f:
+            f.write(content)
+
+        # we must call the common setUp again since our object's setUp()
+        # creates a Runner object which will delete everything under
+        # /var/lib/utah/testsuites
+        setUp()
+        state_agent = StateAgentYAML(state_file=self.state_file)
+        runner = Runner(install_type="desktop",
+                        state_agent=state_agent,
+                        result_class=ResultYAML,
+                        resume=True)
+
+        self.assertEqual(runner.status, 'RUN')
+        self.assertEqual(runner.count_suites(), 3)
+        self.assertEqual(runner.count_tests(), 5)
+
+        if next_test:
+            next_test_obj = runner.get_next_test()
+            self.assertEqual(next_test_obj.name, next_test)
+
+        runner.run()
+
+        self.assertEqual(runner.passes, passes)
+        self.assertEqual(runner.failures, fails)
+        self.assertEqual(runner.errors, errors)
+        t = passes + fails + errors
+        self.assertEqual(runner.passes + runner.failures + runner.errors, t)
+
     def test_load_state_partial(self):
         """
         Test that a partially run state file can be resumed.
         """
-        with open(self.state_file, 'w') as fp:
-            fp.write(self.partial_state_file_content)
-
-        # Need to set up utah_tests since we're simulating a restart
-        test_src = os.path.join(get_module_path(), 'client',
-                                'examples', 'utah_tests')
-        test_dir = os.path.join(UTAH_DIR, 'testsuites',
-                                'utah_tests', 'utah_tests')
-        if not os.path.exists(test_dir):
-            shutil.copytree(test_src, test_dir)
-
-        # Need to set up utah_tests_sample since we're simulating a restart
-        test_src = os.path.join(get_module_path(), 'client',
-                                'examples', 'utah_tests_sample')
-        test_dir = os.path.join(UTAH_DIR, 'testsuites',
-                                'utah_tests_sample', 'utah_tests_sample')
-        if not os.path.exists(test_dir):
-            shutil.copytree(test_src, test_dir)
-
-        state_agent = StateAgentYAML(state_file=self.state_file)
-        runner = Runner(
-            install_type="desktop",
-            state_agent=state_agent,
-            result_class=ResultYAML,
-            resume=True)
-
-        self.assertEqual(runner.status, 'RUN')
-        self.assertEqual(runner.count_suites(), 3)
-        self.assertEqual(runner.count_tests(), 5)
-
-        next_test = runner.get_next_test()
-
-        self.assertEqual(next_test.name, 'test_two')
-
-        runner.run()
-
-        self.assertEqual(runner.passes, 4)
-        self.assertEqual(runner.failures, 1)
-        self.assertEqual(runner.errors, 0)
-        self.assertEqual(runner.passes + runner.failures + runner.errors, 5)
+        self._test_partial(partial_state_file_content, 'test_two', 4, 1, 0)
 
     def test_load_state_partial_run_all(self):
         """
         Test partially run state file - run all jobs.
         """
-        with open(self.state_file, 'w') as fp:
-            fp.write(self.partial_state_file_content_run_all)
-
-        # Need to set up utah_tests since we're simulating a restart
-        test_src = os.path.join(get_module_path(), 'client',
-                                'examples', 'utah_tests')
-        test_dir = os.path.join(UTAH_DIR, 'testsuites',
-                                'utah_tests', 'utah_tests')
-        if not os.path.exists(test_dir):
-            shutil.copytree(test_src, test_dir)
-
-        # Need to set up utah_tests_sample since we're simulating a restart
-        test_src = os.path.join(get_module_path(), 'client',
-                                'examples', 'utah_tests_sample')
-        test_dir = os.path.join(UTAH_DIR, 'testsuites',
-                                'utah_tests_sample', 'utah_tests_sample')
-        if not os.path.exists(test_dir):
-            shutil.copytree(test_src, test_dir)
-
-        state_agent = StateAgentYAML(state_file=self.state_file)
-        runner = Runner(install_type="desktop",
-                        state_agent=state_agent,
-                        result_class=ResultYAML,
-                        resume=True)
-
-        self.assertEqual(runner.status, 'RUN')
-        self.assertEqual(runner.count_suites(), 3)
-        self.assertEqual(runner.count_tests(), 5)
-
-        next_test = runner.get_next_test()
-
-        self.assertEqual(next_test.name, 'test_one')
-
-        runner.run()
-
-        self.assertEqual(runner.passes, 3)
-        self.assertEqual(runner.failures, 0)
-        self.assertEqual(runner.errors, 2)
-        self.assertEqual(runner.passes + runner.failures + runner.errors, 5)
+        self._test_partial(
+            partial_state_file_content_run_all, 'test_one', 3, 2, 0)
 
     def test_load_state_partial_done_all_failed(self):
         """
         Test partially run state file - all jobs failed.
         """
-        with open(self.state_file, 'w') as fp:
-            fp.write(self.partial_state_file_content_done_all_failed)
-
-        # Need to set up utah_tests since we're simulating a restart
-        test_src = os.path.join(get_module_path(), 'client',
-                                'examples', 'utah_tests')
-        test_dir = os.path.join(UTAH_DIR, 'testsuites',
-                                'utah_tests', 'utah_tests')
-        if not os.path.exists(test_dir):
-            shutil.copytree(test_src, test_dir)
-
-        # Need to set up utah_tests_sample since we're simulating a restart
-        test_src = os.path.join(get_module_path(), 'client',
-                                'examples', 'utah_tests_sample')
-        test_dir = os.path.join(UTAH_DIR, 'testsuites',
-                                'utah_tests_sample', 'utah_tests_sample')
-        if not os.path.exists(test_dir):
-            shutil.copytree(test_src, test_dir)
-
-        state_agent = StateAgentYAML(state_file=self.state_file)
-        runner = Runner(install_type="desktop",
-                        state_agent=state_agent,
-                        result_class=ResultYAML,
-                        resume=True)
-
-        self.assertEqual(runner.status, 'RUN')
-        self.assertEqual(runner.count_suites(), 3)
-        self.assertEqual(runner.count_tests(), 5)
-
-        runner.run()
-
-        self.assertEqual(runner.passes, 0)
-        self.assertEqual(runner.failures, 5)
-        self.assertEqual(runner.errors, 0)
-        self.assertEqual(runner.passes + runner.failures + runner.errors, 5)
+        self._test_partial(
+            partial_state_file_content_done_all_failed, None, 0, 5, 0)