Support specifying a pin for merges

Author: janverb

git_aggregator/config.py

@@ -57,19 +57,23 @@ def get_repos(config, force=False):
                 try:
                     # Assume parts is a str
                     parts = merge.split(' ')
-                    if len(parts) != 2:
+                    if len(parts) not in {2, 3}:
                         raise ConfigException(
                             '%s: Merge must be formatted as '
-                            '"remote_name ref".' % directory)
+                            '"remote_name ref [pin]".' % directory)
                     merge = {
                         "remote": parts[0],
                         "ref": parts[1],
                     }
+                    if len(parts) == 3:
+                        merge["pin"] = parts[2]
                 except AttributeError:
                     # Parts is a dict
                     try:
                         merge["remote"] = str(merge["remote"])
                         merge["ref"] = str(merge["ref"])
+                        if merge.get("pin"):
+                            merge["pin"] = str(merge["pin"])
                     except KeyError:
                         raise ConfigException(
                             '%s: Merge lacks mandatory '

git_aggregator/repo.py

@@ -242,11 +242,26 @@ def fetch(self):
         basecmd = ("git", "fetch")
         logger.info("Fetching required remotes")
         for merge in self.merges:
+            pin = remote.get("pin")
             cmd = basecmd + self._fetch_options(merge) + (merge["remote"],)
             if merge["remote"] not in self.fetch_all:
+                if pin:
+                    # Probably solvable, but a little too tricky for me to
+                    # figure out right now
+                    raise GitAggregatorException(
+                        "Cannot use fetch_all with pin"
+                    )
                 cmd += (merge["ref"],)
+            merge["pin"] = pin
             self.log_call(cmd, cwd=self.cwd)
 
+    def rev_parse(self, ref):
+        return self.log_call(
+            ["git", "rev-parse", "--verify", ref],
+            callwith=subprocess.check_output,
+            cwd=self.cwd,
+        ).strip()
+
     def push(self):
         remote = self.target['remote']
         branch = self.target['branch']
@@ -295,15 +310,19 @@ def _reset_to(self, remote, ref):
     def _switch_to_branch(self, branch_name):
         # check if the branch already exists
         logger.info("Switch to branch %s", branch_name)
-        self.log_call(['git', 'checkout', '-B', branch_name], cwd=self.cwd)
+        cmd = ['git', 'checkout', '-B', branch_name]
+        if ref is not None:
+            cmd.append(self.rev_parse(ref))
+        self.log_call(cmd, cwd=self.cwd)
 
     def _execute_shell_command_after(self):
         logger.info('Execute shell after commands')
         for cmd in self.shell_command_after:
             self.log_call(cmd, shell=True, cwd=self.cwd)
 
     def _merge(self, merge):
-        logger.info("Pull %s, %s", merge["remote"], merge["ref"])
+        pin = merge.get("pin")
+        logger.info("Pull %s, %s, %s", merge["remote"], merge["ref"], pin or "no pin")
         cmd = ("git", "pull", "--ff", "--no-rebase")
         if self.git_version >= (1, 7, 10):
             # --edit and --no-edit appear with Git 1.7.10
@@ -312,7 +331,10 @@ def _merge(self, merge):
             cmd += ('--no-edit',)
         if logger.getEffectiveLevel() != logging.DEBUG:
             cmd += ('--quiet',)
-        cmd += self._fetch_options(merge) + (merge["remote"], merge["ref"])
+        if pin:
+            cmd += self._fetch_options(merge) + (merge["remote"], pin)
+        else:
+            cmd += self._fetch_options(merge) + (merge["remote"], merge["ref"])
         self.log_call(cmd, cwd=self.cwd)
 
     def _get_remotes(self):

tests/test_config.py

@@ -28,7 +28,7 @@ def test_load(self):
     merges:
         - oca 8.0
         - oca refs/pull/105/head
-        - oca refs/pull/106/head
+        - oca refs/pull/106/head 1234abcd
     target: acsone aggregated_branch_name
         """
         repos = config.get_repos(self._parse_config(config_yaml))
@@ -45,7 +45,8 @@ def test_load(self):
              'defaults': {},
              'merges': [{'ref': '8.0', 'remote': 'oca'},
                         {'ref': 'refs/pull/105/head', 'remote': 'oca'},
-                        {'ref': 'refs/pull/106/head', 'remote': 'oca'}],
+                        {'ref': 'refs/pull/106/head', 'remote': 'oca',
+                         'pin': '1234abcd'}],
              'remotes': [],
              'shell_command_after': [],
              'target': {'branch': 'aggregated_branch_name',
@@ -76,6 +77,7 @@ def test_load_defaults(self):
                     -
                         remote: oca
                         ref: refs/pull/106/head
+                        pin: 1234abcd
                 target: acsone aggregated_branch_name
         """)
         repos = config.get_repos(self._parse_config(config_yaml))
@@ -92,7 +94,8 @@ def test_load_defaults(self):
              'defaults': {'depth': 1},
              'merges': [{'ref': '8.0', 'remote': 'oca', 'depth': 1000},
                         {'ref': 'refs/pull/105/head', 'remote': 'oca'},
-                        {'ref': 'refs/pull/106/head', 'remote': 'oca'}],
+                        {'ref': 'refs/pull/106/head', 'remote': 'oca',
+                         'pin': '1234abcd'}],
              'remotes': [],
              'shell_command_after': [],
              'target': {'branch': 'aggregated_branch_name',
@@ -202,7 +205,7 @@ def test_load_merges_exception(self):
         self.assertEqual(
             ex.exception.args[0],
             '/product_attribute: Merge must be formatted as '
-            '"remote_name ref".')
+            '"remote_name ref [pin]".')
         config_yaml = """
 /product_attribute:
     remotes:

tests/test_repo.py

@@ -399,3 +399,47 @@ def test_multithreading(self):
 
         self.assertTrue(os.path.isfile(os.path.join(repo3_dir, 'tracked')))
         self.assertTrue(os.path.isfile(os.path.join(repo3_dir, 'tracked2')))
+
+    def test_pinned_base(self):
+        remotes = [{
+            'name': 'r1',
+            'url': self.url_remote1
+        }]
+        merges = [{
+            'remote': 'r1',
+            'ref': 'master',
+            'pin': self.commit_1_sha[:8]
+        }]
+        target = {
+            'remote': 'r1',
+            'branch': 'agg1'
+        }
+        repo = Repo(self.cwd, remotes, merges, target)
+        repo.aggregate()
+        last_rev = git_get_last_rev(self.cwd)
+        self.assertEqual(last_rev, self.commit_1_sha)
+
+    def test_pinned_merge(self):
+        remotes = [{
+            'name': 'r1',
+            'url': self.url_remote1
+        }, {
+            'name': 'r2',
+            'url': self.url_remote2
+        }]
+        merges = [{
+            'remote': 'r1',
+            'ref': 'tag2'
+        }, {
+            'remote': 'r2',
+            'ref': self.commit_3_sha,
+            'pin': self.commit_1_sha[:8]
+        }]
+        target = {
+            'remote': 'r1',
+            'branch': 'agg'
+        }
+        repo = Repo(self.cwd, remotes, merges, target)
+        repo.aggregate()
+        last_rev = git_get_last_rev(self.cwd)
+        self.assertEqual(last_rev, self.commit_2_sha)