Merged in aznashwan/coriolis-core/netplan-support (pull request #123)

Add '_set_netplan_ethernet_configs' helper method in BaseUbuntuMorphingTools.

coriolis/osmorphing/ubuntu.py

@@ -1,9 +1,18 @@
-# Copyright 2016 Cloudbase Solutions Srl
+# Copyright 2018 Cloudbase Solutions Srl
 # All Rights Reserved.
 
+import copy
+import io
+import yaml
+
+from oslo_log import log as logging
+
 from coriolis.osmorphing import debian
 
 
+LOG = logging.getLogger(__name__)
+
+
 class BaseUbuntuMorphingTools(debian.BaseDebianMorphingTools):
     def _check_os(self):
         config = self._read_config_file("etc/lsb-release", check_exists=True)
@@ -11,3 +20,89 @@ class BaseUbuntuMorphingTools(debian.BaseDebianMorphingTools):
         if dist_id == 'Ubuntu':
             release = config.get('DISTRIB_RELEASE')
             return (dist_id, release)
+
+    def _set_netplan_ethernet_configs(
+            self, nics_info, dhcp=False, iface_name_prefix=None):
+        """ Updates any Ethernet interface configurations in /etc/netplan/*
+
+        If an 'iface_name_prefix' is given, replaces all interface names
+        consitently throughout all netplan files.
+        """
+        interface_index = 0
+        # mapping between original interface name and mapped name.
+        processed_interfaces = {}
+        for conffile in self._list_dir("etc/netplan"):
+            if not conffile.endswith(".yaml"):
+                LOG.debug(
+                    "Skipping file '%s' because of missing extension",
+                    conffile)
+                continue
+
+            # back existing file up:
+            config_path_chroot = "etc/netplan/%s" % conffile
+            config_path = "%s/%s" % (self._os_root_dir, config_path_chroot)
+            config_backup_path = "%s.bak" % config_path
+            self._exec_cmd("sudo cp '%s' '%s'" % (
+                config_path, config_backup_path))
+
+            config_contents = self._read_file(config_path_chroot)
+            config_data = yaml.load(
+                io.StringIO(config_contents.decode("utf-8")))
+
+            config_network_data = config_data.get("network")
+            if config_network_data is None:
+                LOG.debug(
+                    "Missing network config in file '%s'. Skipping" % (
+                        config_path_chroot))
+                continue
+
+            config_version = config_network_data.get("version")
+            if not config_version or int(config_version) != 2:
+                LOG.debug(
+                    "Skipping incompatible config version '%s' in file %s" % (
+                        config_version, config_path_chroot))
+                continue
+
+            ethernet_configurations = config_network_data.get("ethernets")
+            if not ethernet_configurations:
+                LOG.debug(
+                    "No Ethernet configurations in file %s",
+                    config_path_chroot)
+            new_ethernet_configurations = {}
+            set_dhcp = bool(dhcp)
+            for iface_name in ethernet_configurations.keys():
+                new_iface_name = iface_name
+                if iface_name_prefix and not iface_name.startswith(
+                        iface_name_prefix):
+                    if iface_name in processed_interfaces.keys():
+                        new_iface_name = processed_interfaces[iface_name]
+                        LOG.info(
+                            "Already processed config for interface '%s'. "
+                            "Using previously mapped name (%s)",
+                            iface_name, new_iface_name)
+                    else:
+                        new_iface_name = "%s%d" % (
+                            iface_name_prefix, interface_index)
+                        interface_index = interface_index + 1
+                    LOG.debug(
+                        "Renamed interface '%s' to '%s' in '%s'",
+                        iface_name, new_iface_name, config_path_chroot)
+                new_config = copy.deepcopy(ethernet_configurations[iface_name])
+                if set_dhcp:
+                    new_config["dhcp4"] = True
+                    new_config["dhcp6"] = True
+
+                LOG.info(
+                    "Updating netplan interface configuration from '%s' to "
+                    "'%s' in file '%s'.",
+                    {iface_name: ethernet_configurations[iface_name]},
+                    {new_iface_name: new_config},
+                    config_path_chroot)
+                new_ethernet_configurations[new_iface_name] = new_config
+                processed_interfaces[iface_name] = new_iface_name
+
+            config_data["network"]["ethernets"] = new_ethernet_configurations
+            LOG.info(
+                "Writing following configuration to '%s': %s" % (
+                    config_path_chroot, config_data))
+            self._write_file_sudo(config_path_chroot, yaml.dump(config_data))