Merge pull request #48 from janverb/optional-target

Make the `target` section optional

Author: sbidoul

README.rst

@@ -26,7 +26,6 @@ Create a ``repos.yaml`` or ``repos.yml`` file:
             - oca 8.0
             - oca refs/pull/105/head
             - oca refs/pull/106/head
-        target: acsone aggregated_branch_name
 
     ./connector-interfaces:
         remotes:
@@ -43,6 +42,8 @@ Create a ``repos.yaml`` or ``repos.yml`` file:
 
 Environment variables inside of this file will be expanded if the proper option is selected.
 
+All the ``merges`` are combined into a single branch. By default this branch is called ``_git_aggregated`` but another name may be given in the ``target`` section.
+
 Fetching only required branches
 -------------------------------
 
@@ -181,7 +182,8 @@ Use additional variables from file while expanding:
 
 The env file should contain `VAR=value` lines. Lines starting with # are ignored.
 
-You can also aggregate and automatically push the result to the target:
+You can also aggregate and automatically push the result to the target, if the
+``target`` option is configured:
 
 .. code-block:: bash
 

git_aggregator/config.py

@@ -93,16 +93,24 @@ def get_repos(config, force=False):
             repo_dict["fetch_all"] = frozenset((repo_dict["fetch_all"],))
         elif isinstance(repo_dict["fetch_all"], list):
             repo_dict["fetch_all"] = frozenset(repo_dict["fetch_all"])
-        if 'target' not in repo_data:
-            raise ConfigException('%s: No target defined.' % directory)
-        parts = (repo_data.get('target') or "") .split(' ')
-        if len(parts) != 2:
+
+        # Explicitly cast to str because e.g. `8.0` will be parsed as float
+        # There are many cases this doesn't handle, but the float one is common
+        # because of Odoo conventions
+        parts = str(repo_data.get('target', "")).split()
+        remote_name = None
+        if len(parts) == 0:
+            branch = "_git_aggregated"
+        elif len(parts) == 1:
+            branch = parts[0]
+        elif len(parts) == 2:
+            remote_name, branch = parts
+        else:
             raise ConfigException(
                 '%s: Target must be formatted as '
-                '"remote_name branch_name"' % directory)
+                '"[remote_name] branch_name"' % directory)
 
-        remote_name, branch = repo_data.get('target').split(' ')
-        if remote_name not in remote_names:
+        if remote_name is not None and remote_name not in remote_names:
             raise ConfigException(
                 '%s: Target remote %s not defined in remotes.' %
                 (directory, remote_name))

git_aggregator/repo.py

@@ -208,6 +208,10 @@ def fetch(self):
     def push(self):
         remote = self.target['remote']
         branch = self.target['branch']
+        if remote is None:
+            raise GitAggregatorException(
+                "Cannot push %s, no target remote configured" % branch
+            )
         logger.info("Push %s to %s", branch, remote)
         self.log_call(['git', 'push', '-f', remote, branch], cwd=self.cwd)
 

tests/test_config.py

@@ -252,40 +252,54 @@ def test_load_target_exception(self):
         oca: https://github.com/OCA/product-attribute.git
     merges:
         - oca 8.0
+    target: oca 8.0 extra_arg
 """
         with self.assertRaises(ConfigException) as ex:
             config.get_repos(self._parse_config(config_yaml))
-        self.assertEquals(ex.exception.args[0],
-                          '/product_attribute: No target defined.')
+        self.assertEquals(
+            ex.exception.args[0],
+            '/product_attribute: Target must be formatted as '
+            '"[remote_name] branch_name"')
 
         config_yaml = """
 /product_attribute:
     remotes:
         oca: https://github.com/OCA/product-attribute.git
     merges:
         - oca 8.0
-    target:
+    target: oba aggregated_branch
 """
         with self.assertRaises(ConfigException) as ex:
             config.get_repos(self._parse_config(config_yaml))
         self.assertEquals(
             ex.exception.args[0],
-            '/product_attribute: Target must be formatted as '
-            '"remote_name branch_name"')
+            '/product_attribute: Target remote oba not defined in remotes.')
 
+    def test_target_defaults(self):
         config_yaml = """
 /product_attribute:
     remotes:
         oca: https://github.com/OCA/product-attribute.git
     merges:
         - oca 8.0
-    target: oba aggregated_branch
+    target: 8.0
 """
-        with self.assertRaises(ConfigException) as ex:
-            config.get_repos(self._parse_config(config_yaml))
-        self.assertEquals(
-            ex.exception.args[0],
-            '/product_attribute: Target remote oba not defined in remotes.')
+        repos = config.get_repos(self._parse_config(config_yaml))
+        self.assertDictEqual(
+            repos[0]["target"], {"branch": "8.0", "remote": None}
+        )
+
+        config_yaml = """
+/product_attribute:
+    remotes:
+        oca: https://github.com/OCA/product-attribute.git
+    merges:
+        - oca 8.0
+"""
+        repos = config.get_repos(self._parse_config(config_yaml))
+        self.assertDictEqual(
+            repos[0]["target"], {"branch": "_git_aggregated", "remote": None}
+        )
 
     def test_import_config__not_found(self):
         with self.assertRaises(ConfigException) as exc:

tests/test_repo.py

@@ -150,6 +150,34 @@ def test_simple_merge(self):
         self.assertEquals(rtype, 'branch')
         self.assertTrue(sha)
 
+    def test_push_missing_remote(self):
+        remotes = [{
+            'name': 'r1',
+            'url': self.url_remote1
+        }, {
+            'name': 'r2',
+            'url': self.url_remote2
+        }]
+        merges = [{
+            'remote': 'r1',
+            'ref': 'tag1'
+        }, {
+            'remote': 'r2',
+            'ref': self.commit_3_sha
+        }]
+        target = {
+            'remote': None,
+            'branch': 'agg'
+        }
+        repo = Repo(self.cwd, remotes, merges, target, fetch_all=True)
+        repo.aggregate()
+        with self.assertRaises(exception.GitAggregatorException) as ex:
+            repo.push()
+        self.assertEquals(
+            ex.exception.args[0],
+            "Cannot push agg, no target remote configured"
+        )
+
     def test_update_aggregate(self):
         # in this test
         # * we'll aggregate a first time r1 master with r2