vmware customization: return network config format

For customizing the machines hosted on 'VMWare' hypervisor, the datasource
should return the 'network config' data in 'curtin' format.

This branch also fixes /etc/network/interfaces replacing the line
"source /etc/network/interfaces.d/*.cfg" which is incorrectly removed
when VMWare's Perl Customization Engine writes /etc/network/interfaces.

Modify the code to read the customization configuration and return the
converted data.

Added few tests.

LP: #1675063

1 files changed, 217 insertions, 0 deletions

diff --git a/tests/unittests/test_vmware_config_file.py b/tests/unittests/test_vmware_config_file.py
index d8651077..808d303a 100644
--- a/tests/unittests/test_vmware_config_file.py
+++ b/tests/unittests/test_vmware_config_file.py
@@ -8,9 +8,13 @@
 import logging
 import sys
 
+from cloudinit.sources.DataSourceOVF import get_network_config_from_conf
+from cloudinit.sources.DataSourceOVF import read_vmware_imc
 from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
 from cloudinit.sources.helpers.vmware.imc.config import Config
 from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
+from cloudinit.sources.helpers.vmware.imc.config_nic import gen_subnet
+from cloudinit.sources.helpers.vmware.imc.config_nic import NicConfigurator
 from cloudinit.tests.helpers import CiTestCase
 
 logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
@@ -20,6 +24,7 @@ logger = logging.getLogger(__name__)
 class TestVmwareConfigFile(CiTestCase):
 
     def test_utility_methods(self):
+        """Tests basic utility methods of ConfigFile class"""
         cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
 
         cf.clear()
@@ -43,7 +48,26 @@ class TestVmwareConfigFile(CiTestCase):
         self.assertFalse(cf.should_keep_current_value("BAR"), "keepBar")
         self.assertTrue(cf.should_remove_current_value("BAR"), "removeBar")
 
+    def test_datasource_instance_id(self):
+        """Tests instance id for the DatasourceOVF"""
+        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
+
+        instance_id_prefix = 'iid-vmware-'
+
+        conf = Config(cf)
+
+        (md1, _, _) = read_vmware_imc(conf)
+        self.assertIn(instance_id_prefix, md1["instance-id"])
+        self.assertEqual(len(md1["instance-id"]), len(instance_id_prefix) + 8)
+
+        (md2, _, _) = read_vmware_imc(conf)
+        self.assertIn(instance_id_prefix, md2["instance-id"])
+        self.assertEqual(len(md2["instance-id"]), len(instance_id_prefix) + 8)
+
+        self.assertNotEqual(md1["instance-id"], md2["instance-id"])
+
     def test_configfile_static_2nics(self):
+        """Tests Config class for a configuration with two static NICs."""
         cf = ConfigFile("tests/data/vmware/cust-static-2nic.cfg")
 
         conf = Config(cf)
@@ -81,6 +105,7 @@ class TestVmwareConfigFile(CiTestCase):
         self.assertTrue(not nics[1].staticIpv6, "ipv61 dhcp")
 
     def test_config_file_dhcp_2nics(self):
+        """Tests Config class for a configuration with two DHCP NICs."""
         cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
 
         conf = Config(cf)
@@ -117,5 +142,197 @@ class TestVmwareConfigFile(CiTestCase):
         conf = Config(cf)
         self.assertTrue(conf.reset_password, "reset password")
 
+    def test_get_config_nameservers(self):
+        """Tests DNS and nameserver settings in a configuration."""
+        cf = ConfigFile("tests/data/vmware/cust-static-2nic.cfg")
+
+        config = Config(cf)
+
+        network_config = get_network_config_from_conf(config, False)
+
+        self.assertEqual(1, network_config.get('version'))
+
+        config_types = network_config.get('config')
+        name_servers = None
+        dns_suffixes = None
+
+        for type in config_types:
+            if type.get('type') == 'nameserver':
+                name_servers = type.get('address')
+                dns_suffixes = type.get('search')
+                break
+
+        self.assertEqual(['10.20.145.1', '10.20.145.2'],
+                         name_servers,
+                         "dns")
+        self.assertEqual(['eng.vmware.com', 'proxy.vmware.com'],
+                         dns_suffixes,
+                         "suffixes")
+
+    def test_gen_subnet(self):
+        """Tests if gen_subnet properly calculates network subnet from
+           IPv4 address and netmask"""
+        ip_subnet_list = [['10.20.87.253', '255.255.252.0', '10.20.84.0'],
+                          ['10.20.92.105', '255.255.252.0', '10.20.92.0'],
+                          ['192.168.0.10', '255.255.0.0', '192.168.0.0']]
+        for entry in ip_subnet_list:
+            self.assertEqual(entry[2], gen_subnet(entry[0], entry[1]),
+                             "Subnet for a specified ip and netmask")
+
+    def test_get_config_dns_suffixes(self):
+        """Tests if get_network_config_from_conf properly
+           generates nameservers and dns settings from a
+           specified configuration"""
+        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
+
+        config = Config(cf)
+
+        network_config = get_network_config_from_conf(config, False)
+
+        self.assertEqual(1, network_config.get('version'))
+
+        config_types = network_config.get('config')
+        name_servers = None
+        dns_suffixes = None
+
+        for type in config_types:
+            if type.get('type') == 'nameserver':
+                name_servers = type.get('address')
+                dns_suffixes = type.get('search')
+                break
+
+        self.assertEqual([],
+                         name_servers,
+                         "dns")
+        self.assertEqual(['eng.vmware.com'],
+                         dns_suffixes,
+                         "suffixes")
+
+    def test_get_nics_list_dhcp(self):
+        """Tests if NicConfigurator properly calculates network subnets
+           for a configuration with a list of DHCP NICs"""
+        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
+
+        config = Config(cf)
+
+        nicConfigurator = NicConfigurator(config.nics, False)
+        nics_cfg_list = nicConfigurator.generate()
+
+        self.assertEqual(2, len(nics_cfg_list), "number of config elements")
+
+        nic1 = {'name': 'NIC1'}
+        nic2 = {'name': 'NIC2'}
+        for cfg in nics_cfg_list:
+            if cfg.get('name') == nic1.get('name'):
+                nic1.update(cfg)
+            elif cfg.get('name') == nic2.get('name'):
+                nic2.update(cfg)
+
+        self.assertEqual('physical', nic1.get('type'), 'type of NIC1')
+        self.assertEqual('NIC1', nic1.get('name'), 'name of NIC1')
+        self.assertEqual('00:50:56:a6:8c:08', nic1.get('mac_address'),
+                         'mac address of NIC1')
+        subnets = nic1.get('subnets')
+        self.assertEqual(1, len(subnets), 'number of subnets for NIC1')
+        subnet = subnets[0]
+        self.assertEqual('dhcp', subnet.get('type'), 'DHCP type for NIC1')
+        self.assertEqual('auto', subnet.get('control'), 'NIC1 Control type')
+
+        self.assertEqual('physical', nic2.get('type'), 'type of NIC2')
+        self.assertEqual('NIC2', nic2.get('name'), 'name of NIC2')
+        self.assertEqual('00:50:56:a6:5a:de', nic2.get('mac_address'),
+                         'mac address of NIC2')
+        subnets = nic2.get('subnets')
+        self.assertEqual(1, len(subnets), 'number of subnets for NIC2')
+        subnet = subnets[0]
+        self.assertEqual('dhcp', subnet.get('type'), 'DHCP type for NIC2')
+        self.assertEqual('auto', subnet.get('control'), 'NIC2 Control type')
+
+    def test_get_nics_list_static(self):
+        """Tests if NicConfigurator properly calculates network subnets
+           for a configuration with 2 static NICs"""
+        cf = ConfigFile("tests/data/vmware/cust-static-2nic.cfg")
+
+        config = Config(cf)
+
+        nicConfigurator = NicConfigurator(config.nics, False)
+        nics_cfg_list = nicConfigurator.generate()
+
+        self.assertEqual(5, len(nics_cfg_list), "number of elements")
+
+        nic1 = {'name': 'NIC1'}
+        nic2 = {'name': 'NIC2'}
+        route_list = []
+        for cfg in nics_cfg_list:
+            cfg_type = cfg.get('type')
+            if cfg_type == 'physical':
+                if cfg.get('name') == nic1.get('name'):
+                    nic1.update(cfg)
+                elif cfg.get('name') == nic2.get('name'):
+                    nic2.update(cfg)
+            elif cfg_type == 'route':
+                route_list.append(cfg)
+
+        self.assertEqual('physical', nic1.get('type'), 'type of NIC1')
+        self.assertEqual('NIC1', nic1.get('name'), 'name of NIC1')
+        self.assertEqual('00:50:56:a6:8c:08', nic1.get('mac_address'),
+                         'mac address of NIC1')
+
+        subnets = nic1.get('subnets')
+        self.assertEqual(2, len(subnets), 'Number of subnets')
+
+        static_subnet = []
+        static6_subnet = []
+
+        for subnet in subnets:
+            subnet_type = subnet.get('type')
+            if subnet_type == 'static':
+                static_subnet.append(subnet)
+            elif subnet_type == 'static6':
+                static6_subnet.append(subnet)
+            else:
+                self.assertEqual(True, False, 'Unknown type')
+
+        self.assertEqual(1, len(static_subnet), 'Number of static subnet')
+        self.assertEqual(1, len(static6_subnet), 'Number of static6 subnet')
+
+        subnet = static_subnet[0]
+        self.assertEqual('10.20.87.154', subnet.get('address'),
+                         'IPv4 address of static subnet')
+        self.assertEqual('255.255.252.0', subnet.get('netmask'),
+                         'NetMask of static subnet')
+        self.assertEqual('auto', subnet.get('control'),
+                         'control for static subnet')
+
+        subnet = static6_subnet[0]
+        self.assertEqual('fc00:10:20:87::154', subnet.get('address'),
+                         'IPv6 address of static subnet')
+        self.assertEqual('64', subnet.get('netmask'),
+                         'NetMask of static6 subnet')
+
+        route_set = set(['10.20.87.253', '10.20.87.105', '192.168.0.10'])
+        for route in route_list:
+            self.assertEqual(10000, route.get('metric'), 'metric of route')
+            gateway = route.get('gateway')
+            if gateway in route_set:
+                route_set.discard(gateway)
+            else:
+                self.assertEqual(True, False, 'invalid gateway %s' % (gateway))
+
+        self.assertEqual('physical', nic2.get('type'), 'type of NIC2')
+        self.assertEqual('NIC2', nic2.get('name'), 'name of NIC2')
+        self.assertEqual('00:50:56:a6:ef:7d', nic2.get('mac_address'),
+                         'mac address of NIC2')
+
+        subnets = nic2.get('subnets')
+        self.assertEqual(1, len(subnets), 'Number of subnets for NIC2')
+
+        subnet = subnets[0]
+        self.assertEqual('static', subnet.get('type'), 'Subnet type')
+        self.assertEqual('192.168.6.102', subnet.get('address'),
+                         'Subnet address')
+        self.assertEqual('255.255.0.0', subnet.get('netmask'),
+                         'Subnet netmask')
+
 
 # vi: ts=4 expandtab