Merge lp:~joetalbott/utah/add_dev_method into lp:utah

[Joe Talbott]

Add 'dev' as a fetch_method option.

Copies 'fetch_location' to $TESTSUITE_NAME.

* tests added.
* documentation updated.

[Max Brustkern (nuclearbob)]

Looks good to me, but you and Javier have worked on these pieces more than I have, so if he has a chance to comment, that would be good.

review: Approve

[Javier Collado (javier.collado)]

Thanks for the update Joe.

I'm merging this with an update to `pass.run` to use `dev` as `fetch_method`
since it currently doesn't work with `bzr` as `fetch_method` since it currently
doesn't work with `bzr`.

review: Approve

[Javier Collado (javier.collado)]

In any case, I'd like to comment that it looks a little bit weird that:

- test cases use VCSHandler.get_revision and code in runner module uses VCSHandler.revision
(even if the former wraps the latter).

- to implement a fake version command a call to a real command (echo DEVELOPMENT) is needed.

=== modified file 'docs/source/development.rst'
--- docs/source/development.rst	2012-10-19 16:44:08 +0000
+++ docs/source/development.rst	2012-10-25 20:49:18 +0000
@@ -91,7 +91,7 @@
         - st4
         - st5
 
-The only required fields are ``name``, ``fetch_method`` and ``fetch_location``.  ``name`` must correspond to the name of the top-level testsuite directory.  ``fetch_method`` should be one of ``bzr``, ``bzr-export``, or ``git``.  ``fetch_location`` should be a valid location for the supplied ``fetch_method``.  If ``bzr`` is selected as the fetch method then ``fetch_location`` should point to a repository that is a valid testsuite, i.e. has a tslist.run, ts_control (if needed), and test case directories.  While ``bzr`` does a ``bzr branch`` in the implementation, ``bzr-export`` does a ``bzr export`` and accepts a bzr location that can point to a sub-directory within a repository that is a valid testsuite. 
+The only required fields are ``name``, ``fetch_method`` and ``fetch_location``.  ``name`` must correspond to the name of the top-level testsuite directory.  ``fetch_method`` should be one of ``bzr``, ``bzr-export``, ``dev``, or ``git``.  ``fetch_location`` should be a valid location for the supplied ``fetch_method``.  If ``bzr`` is selected as the fetch method then ``fetch_location`` should point to a repository that is a valid testsuite, i.e. has a tslist.run, ts_control (if needed), and test case directories.  While ``bzr`` does a ``bzr branch`` in the implementation, ``bzr-export`` does a ``bzr export`` and accepts a bzr location that can point to a sub-directory within a repository that is a valid testsuite.  If ``dev`` is selected as the fetch method then ``fetch_location`` should point to a valid testsuite directory.  The utah client will run ``cp -r <fetch_location> <testsuite_name>``.  This method is provided to allow testsuite/testcase authors to run the client on a development tree without needing to push changes each time to a repository.
 
 One caveat to note is that a ``fetch_method`` of ``bzr`` will get the revision information from the local copy of the branched repository but ``bzr-export`` will have a small race condition between the ``get`` and ``revision`` calls since the actual bzr repository must be queried for the revision.
 
 
=== modified file 'utah/client/README'
--- utah/client/README	2012-10-17 15:18:53 +0000
+++ utah/client/README	2012-10-25 20:49:18 +0000
@@ -25,7 +25,7 @@
 ######################################################################
 
 - name: <test suite name>
-  fetch_method: <'bzr', 'bzr-export', or 'git'>
+  fetch_method: <'bzr', 'bzr-export', 'dev' or 'git'>
   fetch_location: <repo location>
   [runlist: <test suite runlist>]
   [include_tests: 
 
=== modified file 'utah/client/common.py'
--- utah/client/common.py	2012-10-22 08:15:08 +0000
+++ utah/client/common.py	2012-10-25 20:49:18 +0000
@@ -449,3 +449,17 @@
                 )
 
         self.rev_command = "git rev-parse HEAD"
+
+class DevHandler(VCSHandler):
+    """ Copy from a local directory for development. """
+
+    def __init__(self, repo, destination="."):
+        self.repo = repo
+        self.destination = destination
+
+        self.get_command = "cp -r {} {}".format(
+                self.repo,
+                destination,
+                )
+
+        self.rev_command = "echo 'DEVELOPMENT'"
 
=== modified file 'utah/client/phoenix.py'
--- utah/client/phoenix.py	2012-10-25 14:29:42 +0000
+++ utah/client/phoenix.py	2012-10-25 20:49:18 +0000
@@ -62,7 +62,7 @@
 
         self.FILE_CONTENT[MASTER_NAME] += "  - name: {}\n".format(testsuite)
         self.FILE_CONTENT[MASTER_NAME] += \
-                "    fetch_method: {} # one of 'bzr', 'bzr-export', 'git'\n".format(CHANGEME)
+                "    fetch_method: {} # one of 'bzr', 'bzr-export', 'dev', 'git'\n".format(CHANGEME)
         self.FILE_CONTENT[MASTER_NAME] += \
                 "    fetch_location: {}\n".format(CHANGEME)
 
 
=== modified file 'utah/client/runner.py'
--- utah/client/runner.py	2012-10-22 08:15:08 +0000
+++ utah/client/runner.py	2012-10-25 20:49:18 +0000
@@ -17,6 +17,7 @@
         RETURN_CODES,
         parse_yaml_file,
         BzrHandler,
+        DevHandler,
         GitHandler,
         )
 
@@ -50,7 +51,7 @@
                 },
             'fetch_method': {
                 'type': 'string',
-                'enum': ['bzr', 'bzr-export', 'git'],
+                'enum': ['bzr', 'bzr-export', 'dev', 'git'],
                 'required': True,
                 },
             'fetch_location': {
@@ -410,6 +411,8 @@
             elif fetch_method == 'bzr-export':
                 vcs_handler = BzrHandler(branch=False,
                         repo=fetch_location, destination=name)
+            elif fetch_method == 'dev':
+                vcs_handler = DevHandler(repo=fetch_location, destination=name)
             else:
                 vcs_handler = GitHandler(repo=fetch_location, destination=name)
 
 
=== added file 'utah/client/tests/test_vcs_dev.py'
--- utah/client/tests/test_vcs_dev.py	1970-01-01 00:00:00 +0000
+++ utah/client/tests/test_vcs_dev.py	2012-10-25 20:49:18 +0000
@@ -0,0 +1,78 @@
+import os
+import shutil
+import unittest
+
+from utah.client.common import DevHandler, run_cmd
+
+DEV_TEST_REPO = "/tmp/utahdevtest"
+
+
+def setUp():
+    """
+    Create a local directory to test on.
+    """
+
+    # should fail if the repo already exists.
+    os.mkdir(DEV_TEST_REPO)
+
+    run_cmd("touch test.py", cwd=DEV_TEST_REPO)
+
+
+def tearDown():
+    """
+    Remove the test repo.
+    """
+
+    # We should only ever get here if the repo was created in setUp().
+    shutil.rmtree(DEV_TEST_REPO)
+
+
+class TestDevHandler(unittest.TestCase):
+    """
+    Test the bazaar VCS handler.
+    """
+
+    def test_init(self):
+        """
+        Test the initial setup.
+        """
+
+        repo = DEV_TEST_REPO
+        dev = DevHandler(repo=repo)
+
+        self.assertIsNotNone(dev)
+        self.assertEqual(dev.repo, repo)
+        self.assertEqual(dev.get_command, "cp -r {} .".format(repo))
+        self.assertEqual(dev.rev_command, "echo 'DEVELOPMENT'")
+
+    def test_dev_get(self):
+        repo = DEV_TEST_REPO
+        dest = "utah-dev"
+        dev = DevHandler(repo=repo, destination=dest)
+        directory = "/tmp"
+        path = os.path.join(directory, dest)
+
+        self.assertFalse(os.path.exists(path), path)
+
+        result = dev.get(directory=directory)
+        self.assertEqual(result['returncode'], 0)
+
+        self.assertTrue(os.path.exists(path), path)
+        shutil.rmtree(path)
+
+    def test_dev_revision(self):
+        repo = DEV_TEST_REPO
+        dest = "utah-dev"
+        dev = DevHandler(repo=repo, destination=dest)
+        directory = "/tmp"
+        path = os.path.join(directory, dest)
+
+        self.assertFalse(os.path.exists(path))
+        result = dev.get(directory=directory)
+        self.assertEqual(result['returncode'], 0)
+        self.assertTrue(os.path.exists(path))
+
+        result = dev.get_revision(directory=path)
+
+        shutil.rmtree(path)
+        self.assertEqual(type(result), str)