support network rendering to sysconfig (for centos and RHEL)

This intends to add support for rendering of network data under sysconfig
distributions (centos and rhel).  The end result will be support for
network configuration via ConfigDrive or NoCloud on these OS.

1 files changed, 155 insertions, 27 deletions

diff --git a/tests/unittests/test_net.py b/tests/unittests/test_net.py
index 7998111a..3ae00fc6 100644
--- a/tests/unittests/test_net.py
+++ b/tests/unittests/test_net.py
@@ -2,6 +2,8 @@ from cloudinit import net
 from cloudinit.net import cmdline
 from cloudinit.net import eni
 from cloudinit.net import network_state
+from cloudinit.net import sysconfig
+from cloudinit.sources.helpers import openstack
 from cloudinit import util
 
 from .helpers import mock
@@ -74,8 +76,102 @@ STATIC_EXPECTED_1 = {
                  'dns_nameservers': ['10.0.1.1']}],
 }
 
+# Examples (and expected outputs for various renderers).
+OS_SAMPLES = [
+    {
+        'in_data': {
+            "services": [{"type": "dns", "address": "172.19.0.12"}],
+            "networks": [{
+                "network_id": "dacd568d-5be6-4786-91fe-750c374b78b4",
+                "type": "ipv4", "netmask": "255.255.252.0",
+                "link": "tap1a81968a-79",
+                "routes": [{
+                    "netmask": "0.0.0.0",
+                    "network": "0.0.0.0",
+                    "gateway": "172.19.3.254",
+                }],
+                "ip_address": "172.19.1.34", "id": "network0"
+            }],
+            "links": [
+                {
+                    "ethernet_mac_address": "fa:16:3e:ed:9a:59",
+                    "mtu": None, "type": "bridge", "id":
+                    "tap1a81968a-79",
+                    "vif_id": "1a81968a-797a-400f-8a80-567f997eb93f"
+                },
+            ],
+        },
+        'in_macs': {
+            'fa:16:3e:ed:9a:59': 'eth0',
+        },
+        'out_sysconfig': [
+            ('etc/sysconfig/network-scripts/ifcfg-eth0',
+             """
+# Created by cloud-init on instance boot automatically, do not edit.
+#
+BOOTPROTO=static
+DEFROUTE=yes
+DEVICE=eth0
+GATEWAY=172.19.3.254
+HWADDR=fa:16:3e:ed:9a:59
+IPADDR=172.19.1.34
+NETMASK=255.255.252.0
+NM_CONTROLLED=no
+ONBOOT=yes
+TYPE=Ethernet
+USERCTL=no
+""".lstrip()),
+            ('etc/sysconfig/network-scripts/route-eth0',
+             """
+# Created by cloud-init on instance boot automatically, do not edit.
+#
+ADDRESS0=0.0.0.0
+GATEWAY0=172.19.3.254
+NETMASK0=0.0.0.0
+""".lstrip()),
+            ('etc/resolv.conf',
+             """
+; Created by cloud-init on instance boot automatically, do not edit.
+;
+nameserver 172.19.0.12
+""".lstrip()),
+            ('etc/udev/rules.d/70-persistent-net.rules',
+             "".join(['SUBSYSTEM=="net", ACTION=="add", DRIVERS=="?*", ',
+                      'ATTR{address}=="fa:16:3e:ed:9a:59", NAME="eth0"\n']))]
+    }
+]
+
+
+def _setup_test(tmp_dir, mock_get_devicelist, mock_sys_netdev_info,
+                mock_sys_dev_path):
+    mock_get_devicelist.return_value = ['eth1000']
+    dev_characteristics = {
+        'eth1000': {
+            "bridge": False,
+            "carrier": False,
+            "dormant": False,
+            "operstate": "down",
+            "address": "07-1C-C6-75-A4-BE",
+        }
+    }
+
+    def netdev_info(name, field):
+        return dev_characteristics[name][field]
+
+    mock_sys_netdev_info.side_effect = netdev_info
+
+    def sys_dev_path(devname, path=""):
+        return tmp_dir + devname + "/" + path
+
+    for dev in dev_characteristics:
+        os.makedirs(os.path.join(tmp_dir, dev))
+        with open(os.path.join(tmp_dir, dev, 'operstate'), 'w') as fh:
+            fh.write("down")
+
+    mock_sys_dev_path.side_effect = sys_dev_path
 
-class TestEniNetRendering(TestCase):
+
+class TestSysConfigRendering(TestCase):
 
     @mock.patch("cloudinit.net.sys_dev_path")
     @mock.patch("cloudinit.net.sys_netdev_info")
@@ -83,35 +179,67 @@ class TestEniNetRendering(TestCase):
     def test_default_generation(self, mock_get_devicelist,
                                 mock_sys_netdev_info,
                                 mock_sys_dev_path):
-        mock_get_devicelist.return_value = ['eth1000', 'lo']
-
-        dev_characteristics = {
-            'eth1000': {
-                "bridge": False,
-                "carrier": False,
-                "dormant": False,
-                "operstate": "down",
-                "address": "07-1C-C6-75-A4-BE",
-            }
-        }
+        tmp_dir = tempfile.mkdtemp()
+        self.addCleanup(shutil.rmtree, tmp_dir)
+        _setup_test(tmp_dir, mock_get_devicelist,
+                    mock_sys_netdev_info, mock_sys_dev_path)
 
-        def netdev_info(name, field):
-            return dev_characteristics[name][field]
+        network_cfg = net.generate_fallback_config()
+        ns = network_state.parse_net_config_data(network_cfg,
+                                                 skip_broken=False)
 
-        mock_sys_netdev_info.side_effect = netdev_info
+        render_dir = os.path.join(tmp_dir, "render")
+        os.makedirs(render_dir)
 
+        renderer = sysconfig.Renderer()
+        renderer.render_network_state(render_dir, ns)
+
+        render_file = 'etc/sysconfig/network-scripts/ifcfg-eth1000'
+        with open(os.path.join(render_dir, render_file)) as fh:
+            content = fh.read()
+            expected_content = """
+# Created by cloud-init on instance boot automatically, do not edit.
+#
+BOOTPROTO=dhcp
+DEVICE=eth1000
+HWADDR=07-1C-C6-75-A4-BE
+NM_CONTROLLED=no
+ONBOOT=yes
+TYPE=Ethernet
+USERCTL=no
+""".lstrip()
+            self.assertEqual(expected_content, content)
+
+    def test_openstack_rendering_samples(self):
         tmp_dir = tempfile.mkdtemp()
         self.addCleanup(shutil.rmtree, tmp_dir)
+        render_dir = os.path.join(tmp_dir, "render")
+        for os_sample in OS_SAMPLES:
+            ex_input = os_sample['in_data']
+            ex_mac_addrs = os_sample['in_macs']
+            network_cfg = openstack.convert_net_json(
+                ex_input, known_macs=ex_mac_addrs)
+            ns = network_state.parse_net_config_data(network_cfg,
+                                                     skip_broken=False)
+            renderer = sysconfig.Renderer()
+            renderer.render_network_state(render_dir, ns)
+            for fn, expected_content in os_sample.get('out_sysconfig', []):
+                with open(os.path.join(render_dir, fn)) as fh:
+                    self.assertEqual(expected_content, fh.read())
 
-        def sys_dev_path(devname, path=""):
-            return tmp_dir + devname + "/" + path
 
-        for dev in dev_characteristics:
-            os.makedirs(os.path.join(tmp_dir, dev))
-            with open(os.path.join(tmp_dir, dev, 'operstate'), 'w') as fh:
-                fh.write("down")
+class TestEniNetRendering(TestCase):
 
-        mock_sys_dev_path.side_effect = sys_dev_path
+    @mock.patch("cloudinit.net.sys_dev_path")
+    @mock.patch("cloudinit.net.sys_netdev_info")
+    @mock.patch("cloudinit.net.get_devicelist")
+    def test_default_generation(self, mock_get_devicelist,
+                                mock_sys_netdev_info,
+                                mock_sys_dev_path):
+        tmp_dir = tempfile.mkdtemp()
+        self.addCleanup(shutil.rmtree, tmp_dir)
+        _setup_test(tmp_dir, mock_get_devicelist,
+                    mock_sys_netdev_info, mock_sys_dev_path)
 
         network_cfg = net.generate_fallback_config()
         ns = network_state.parse_net_config_data(network_cfg,
@@ -120,11 +248,11 @@ class TestEniNetRendering(TestCase):
         render_dir = os.path.join(tmp_dir, "render")
         os.makedirs(render_dir)
 
-        renderer = eni.Renderer()
-        renderer.render_network_state(render_dir, ns,
-                                      eni="interfaces",
-                                      links_prefix=None,
-                                      netrules=None)
+        renderer = eni.Renderer(
+            {'links_path_prefix': None,
+             'eni_path': 'interfaces', 'netrules_path': None,
+             })
+        renderer.render_network_state(render_dir, ns)
 
         self.assertTrue(os.path.exists(os.path.join(render_dir,
                                                     'interfaces')))