Merge lp:~niedbalski/juju-deployer/add-refspecs into lp:juju-deployer

[Jorge Niedbalski]

Dear Maintainer,

This change extends the VCS class for being able to handle extended options for a given branch. Extended options are passed as query string arguments following the branch name. As an example:

$ cat configs/changeref.yaml

refspec:
    series: trusty
    services:
        ceilometer:
            branch: https://review.openstack.org/openstack/charm-ceilometer#changeref=286669/1

On this case the #changeref parameter is used. Having extended options
allows to implement more fine grained VCS operations such as fetching a special change reference.

On this patch I also propose to extend the branch method of the Git base class in order to fetch any given changeref.

A Test and a sample config are also part of the change set.

Thanks.

[lp:~niedbalski/juju-deployer/add-refspecs]

167. By Jorge Niedbalski on 2016-03-02

CHanged refspec to changeref

168. By Jorge Niedbalski on 2016-03-02

Added git.launchpad.net as well

[Tim Van Steenburgh (tvansteenburgh)]

LGTM

review: Approve

=== modified file 'deployer/charm.py'
--- deployer/charm.py	2015-09-16 19:54:35 +0000
+++ deployer/charm.py	2016-03-02 19:04:13 +0000
@@ -29,12 +29,18 @@
         self._build = build
         self.vcs = self.get_vcs()
 
+    def is_git_branch(self):
+        return self.branch.startswith('git') or \
+            self.branch.find("review.openstack.org") != -1 or \
+            "github.com" in self.branch or \
+            "git.launchpad.net" in self.branch or \
+            os.path.exists(os.path.join(self.branch, '.git'))
+
     def get_vcs(self):
         if not self.branch:
             return None
-        if self.branch.startswith('git') or 'github.com' in self.branch or \
-                'git.launchpad.net' in self.branch or \
-                os.path.exists(os.path.join(self.branch, '.git')):
+
+        if self.is_git_branch():
             return Git(self.path, self.branch, self.log)
         elif self.branch.startswith("bzr") or self.branch.startswith('lp:') \
                 or os.path.exists(os.path.join(self.branch, '.bzr')) \

=== modified file 'deployer/tests/test_charm.py'
--- deployer/tests/test_charm.py	2015-07-29 21:19:32 +0000
+++ deployer/tests/test_charm.py	2016-03-02 19:04:13 +0000
@@ -291,6 +291,23 @@
         charm.fetch()
         self.assertEqual(charm.vcs.get_cur_rev(), self.tagged_revision)
 
+    def test_vcs_fetch_with_refspec(self):
+        self.setup_vcs_charm()
+        params = dict(self.charm_data)
+        params['branch'] = \
+            "https://review.openstack.org/openstack/charm-ceilometer" + \
+            "#changeref=286669/1"
+
+        charm = Charm.from_service(
+            "scratch", self.repo_path, "trusty", params)
+        charm.fetch()
+
+        self.assertEqual(charm.vcs.get_remote_origin(),
+                         "https://review.openstack.org/" +
+                         "openstack/charm-ceilometer")
+        self.assertEqual(charm.vcs.extended_options,
+                         {'changeref': "286669/1"})
+
     def test_charm_vcs_unknown(self):
         branch = self.mkdir()
         params = {

=== modified file 'deployer/vcs.py'
--- deployer/vcs.py	2015-07-21 07:50:08 +0000
+++ deployer/vcs.py	2016-03-02 19:04:13 +0000
@@ -1,5 +1,6 @@
 import subprocess
 import os
+import re
 
 from bzrlib.workingtree import WorkingTree
 
@@ -20,7 +21,12 @@
     def __init__(self, path, origin, log):
         self.path = path
         self.log = log
-        self.origin = origin
+        self.extended_options = self.get_extended_options(origin)
+
+        if self.extended_options:
+            self.origin = origin.split("#")[0]
+        else:
+            self.origin = origin
 
     def _call(self, args, error_msg, cwd=None, stderr=()):
         try:
@@ -29,7 +35,6 @@
             output = subprocess.check_output(
                 args, cwd=cwd or self.path, stderr=stderr)
         except subprocess.CalledProcessError, e:
-            #print "vcs err", " ".join(args), "[dir: %s]" % cwd, e.output
             self.log.error(error_msg % self.get_err_msg_ctx(e))
             raise ErrorExit()
         return output.strip()
@@ -42,6 +47,20 @@
             'output': e.output,
             'vcs': self.__class__.__name__.lower()}
 
+    def get_extended_options(self, origin):
+        regexp = re.compile(r"[\?#&](?P<name>[^&=]+)=(?P<value>[^&=]+)")
+        matched = regexp.findall(origin)
+
+        if matched:
+            ret = dict()
+            for option in matched:
+                (name, value) = option
+                if name in ret:
+                    raise Exception("%s option already defined" % name)
+                ret[name] = value
+            return ret
+        return {}
+
     def get_cur_rev(self):
         raise NotImplementedError()
 
@@ -103,8 +122,20 @@
         cwd = os.path.dirname(os.path.dirname(self.path))
         if not cwd:
             cwd = "."
+
         self._call(params, self.err_branch, cwd)
 
+        change_ref = self.extended_options.get('changeref', None)
+        if change_ref:
+            change_ref = 'refs/changes/{}/{}'.format(
+                change_ref.split("/")[0][-2:], change_ref)
+
+            self._call(["git", "fetch", "--depth", "1",
+                        self.origin, change_ref],
+                       self.err_branch, self.path)
+            self._call(["git", "checkout", "FETCH_HEAD"], self.err_branch,
+                       self.path)
+
     def is_modified(self):
         params = ["git", "status", "-s"]
         return bool(self._call(params, self.err_is_mod).strip())