cloud-init-dev team mailing list archive

[Robert Schweikert <rjschwei@xxxxxxxx>]

Robert Schweikert has proposed merging ~rjschwei/cloud-init:addZyppRepos into cloud-init:master.

Requested reviews:
  cloud-init commiters (cloud-init-dev)
Related bugs:
  Bug #1718675 in cloud-init: "It should be possible to add repos in SUSE distros"
  https://bugs.launchpad.net/cloud-init/+bug/1718675

For more details, see:
https://code.launchpad.net/~rjschwei/cloud-init/+git/cloud-init/+merge/331149

Support addition of zypp repos
-- 
Your team cloud-init commiters is requested to review the proposed merge of ~rjschwei/cloud-init:addZyppRepos into cloud-init:master.

diff --git a/cloudinit/config/cc_zypp_add_repo.py b/cloudinit/config/cc_zypp_add_repo.py
new file mode 100644
index 0000000..2e0c66e
--- /dev/null
+++ b/cloudinit/config/cc_zypp_add_repo.py
@@ -0,0 +1,96 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2017 SUSE LLC.
+#
+# This file is part of cloud-init. See LICENSE file for license information.
+
+import os
+
+import configobj
+import six
+
+from cloudinit import util
+
+distros = ['opensuse', 'sles']
+
+
+def _canonicalize_id(repo_id):
+    repo_id = repo_id.replace(" ", "_")
+    return repo_id
+
+
+def _format_repo_value(val):
+    if isinstance(val, (bool)):
+        # zypp prefers 1/0
+        return str(int(val))
+    if isinstance(val, (list, tuple)):
+        return "\n    ".join([_format_repo_value(v) for v in val])
+    if not isinstance(val, six.string_types):
+        return str(val)
+    return val
+
+
+def _format_repository_config(repo_id, repo_config):
+    to_be = configobj.ConfigObj()
+    to_be[repo_id] = {}
+    # Do basic translation of the items -> values
+    for (k, v) in repo_config.items():
+        # For now assume that people using this know the format
+        # of zypper repos  and don't verify keys/values further
+        to_be[repo_id][k] = _format_repo_value(v)
+    lines = to_be.write()
+    return "\n".join(lines)
+
+
+def handle(name, cfg, _cloud, log, _args):
+    repos = cfg.get('zypp_repos')
+    if not repos:
+        log.debug(("Skipping module named %s,"
+                   " no 'zypp_repos' configuration found"), name)
+        return
+    repo_base_path = util.get_cfg_option_str(cfg, 'zypp_repo_dir',
+                                             '/etc/zypp/repos.d/')
+    repo_locations = {}
+    repo_configs = {}
+    for (repo_id, repo_config) in repos.items():
+        canon_repo_id = _canonicalize_id(repo_id)
+        repo_fn_pth = os.path.join(repo_base_path, "%s.repo" % (canon_repo_id))
+        if os.path.exists(repo_fn_pth):
+            log.info("Skipping repo %s, file %s already exists!",
+                     repo_id, repo_fn_pth)
+            continue
+        elif repo_id in repo_locations:
+            log.info("Skipping repo %s, file %s already pending!",
+                     repo_id, repo_fn_pth)
+            continue
+        if not repo_config:
+            repo_config = {}
+        # Do some basic sanity checks/cleaning
+        n_repo_config = {}
+        for (k, v) in repo_config.items():
+            k = k.lower().strip().replace("-", "_")
+            if k:
+                n_repo_config[k] = v
+        repo_config = n_repo_config
+        missing_required = 0
+        for req_field in ['baseurl']:
+            if req_field not in repo_config:
+                log.warn(("Repository %s does not contain a %s"
+                          " configuration 'required' entry"),
+                         repo_id, req_field)
+                missing_required += 1
+        for field in ['enabled', 'autorefresh']:
+            if field not in repo_config:
+                repo_config[field] = '1'
+        if not missing_required:
+            repo_configs[repo_id] = repo_config
+            repo_locations[repo_id] = repo_fn_pth
+        else:
+            log.warn("Repository %s is missing %s required fields, skipping!",
+                     repo_id, missing_required)
+    for (c_repo_id, path) in repo_locations.items():
+        repo_blob = _format_repository_config(c_repo_id,
+                                              repo_configs.get(c_repo_id))
+        util.write_file(path, repo_blob)
+
+# vi: ts=4 expandtab
diff --git a/tests/unittests/test_handler/test_handler_zypp_add_repo.py b/tests/unittests/test_handler/test_handler_zypp_add_repo.py
new file mode 100644
index 0000000..38f0f51
--- /dev/null
+++ b/tests/unittests/test_handler/test_handler_zypp_add_repo.py
@@ -0,0 +1,69 @@
+# This file is part of cloud-init. See LICENSE file for license information.
+
+from cloudinit.config import cc_zypp_add_repo
+from cloudinit import util
+
+from cloudinit.tests import helpers
+
+try:
+    from configparser import ConfigParser
+except ImportError:
+    from ConfigParser import ConfigParser
+import logging
+import shutil
+from six import StringIO
+import tempfile
+
+LOG = logging.getLogger(__name__)
+
+
+class TestConfig(helpers.FilesystemMockingTestCase):
+    def setUp(self):
+        super(TestConfig, self).setUp()
+        self.tmp = tempfile.mkdtemp()
+        self.addCleanup(shutil.rmtree, self.tmp)
+
+    def test_bad_config(self):
+        # Config has no baseurl
+        cfg = {
+            'zypp_repos': {
+                'suse-testing': {
+                    'name': 'suse-test',
+                    'enabled': '1'
+                },
+            },
+        }
+        self.patchUtils(self.tmp)
+        cc_zypp_add_repo.handle('zypp_add_repo', cfg, None, LOG, [])
+        self.assertRaises(IOError, util.load_file,
+                          "/etc/zypp/repos.d/suse-testing.repo")
+
+    def test_write_config(self):
+        cfg = {
+            'zypp_repos': {
+                'suse-testing': {
+                    'name': 'suse-test',
+                    'baseurl': 'http://dl.opensuse.org/dist/leap/v/repo/oss/',
+                    'enabled': '1',
+                    'autorefresh': '1'
+                },
+            },
+        }
+        self.patchUtils(self.tmp)
+        cc_zypp_add_repo.handle('zypp_add_repo', cfg, None, LOG, [])
+        contents = util.load_file("/etc/zypp/repos.d/suse-testing.repo")
+        parser = ConfigParser()
+        parser.readfp(StringIO(contents))
+        expected = {
+            'suse-testing': {
+                    'name': 'suse-test',
+                    'baseurl': 'http://dl.opensuse.org/dist/leap/v/repo/oss/',
+                    'enabled': '1',
+                    'autorefresh': '1'
+                }
+        }
+        for section in expected:
+            self.assertTrue(parser.has_section(section),
+                            "Contains section {0}".format(section))
+            for k, v in expected[section].items():
+                self.assertEqual(parser.get(section, k), v)