From b7b814bc0f4e7b63b50106d292e91f2c9555ad87 Mon Sep 17 00:00:00 2001

From: Eduardo Otubo <otubo@redhat.com>

Date: Mon, 4 May 2020 12:40:00 +0200

Subject: [PATCH 3/6] azure/net: generate_fallback_nic emits network v2 config

 instead of v1

RH-Author: Eduardo Otubo <otubo@redhat.com>

Message-id: <20200327152826.13343-4-otubo@redhat.com>

Patchwork-id: 94460

O-Subject: [RHEL-8.1.z/RHEL-8.2.z cloud-init PATCHv2 3/6] azure/net: generate_fallback_nic emits network v2 config instead of v1

Bugzilla: 1811753

RH-Acked-by: Cathy Avery <cavery@redhat.com>

RH-Acked-by: Vitaly Kuznetsov <vkuznets@redhat.com>

commit 7f674256c1426ffc419fd6b13e66a58754d94939

Author: Chad Smith <chad.smith@canonical.com>

Date:   Tue Aug 13 20:13:05 2019 +0000

    azure/net: generate_fallback_nic emits network v2 config instead of v1

    The function generate_fallback_config is used by Azure by default when

    not consuming IMDS configuration data. This function is also used by any

    datasource which does not implement it's own network config. This simple

    fallback configuration sets up dhcp on the most likely NIC. It will now

    emit network v2 instead of network v1.

    This is a step toward moving all components talking in v2 and allows us

    to avoid costly conversions between v1 and v2 for newer distributions

    which rely on netplan.

Signed-off-by: Eduardo Otubo <otubo@redhat.com>

Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>

---

 cloudinit/net/__init__.py                     | 31 +++++---------

 cloudinit/net/network_state.py                | 12 ++++--

 cloudinit/net/tests/test_init.py              | 19 +++++----

 cloudinit/sources/DataSourceAzure.py          |  7 +++-

 tests/unittests/test_datasource/test_azure.py | 59 ++++++++++++++++++++++++++-

 tests/unittests/test_net.py                   | 41 +++++++++++++++++--

 6 files changed, 130 insertions(+), 39 deletions(-)

diff --git a/cloudinit/net/__init__.py b/cloudinit/net/__init__.py

index 41659b1..b26a190 100644

--- a/cloudinit/net/__init__.py

+++ b/cloudinit/net/__init__.py

@@ -268,32 +268,23 @@ def find_fallback_nic(blacklist_drivers=None):

 def generate_fallback_config(blacklist_drivers=None, config_driver=None):

-    """Determine which attached net dev is most likely to have a connection and

-       generate network state to run dhcp on that interface"""

-

+    """Generate network cfg v2 for dhcp on the NIC most likely connected."""

     if not config_driver:

         config_driver = False

     target_name = find_fallback_nic(blacklist_drivers=blacklist_drivers)

-    if target_name:

-        target_mac = read_sys_net_safe(target_name, 'address')

-        nconf = {'config': [], 'version': 1}

-        cfg = {'type': 'physical', 'name': target_name,

-               'mac_address': target_mac, 'subnets': [{'type': 'dhcp'}]}

-        # inject the device driver name, dev_id into config if enabled and

-        # device has a valid device driver value

-        if config_driver:

-            driver = device_driver(target_name)

-            if driver:

-                cfg['params'] = {

-                    'driver': driver,

-                    'device_id': device_devid(target_name),

-                }

-        nconf['config'].append(cfg)

-        return nconf

-    else:

+    if not target_name:

         # can't read any interfaces addresses (or there are none); give up

         return None

+    target_mac = read_sys_net_safe(target_name, 'address')

+    cfg = {'dhcp4': True, 'set-name': target_name,

+           'match': {'macaddress': target_mac.lower()}}

+    if config_driver:

+        driver = device_driver(target_name)

+        if driver:

+            cfg['match']['driver'] = driver

+    nconf = {'ethernets': {target_name: cfg}, 'version': 2}

+    return nconf

 def apply_network_config_names(netcfg, strict_present=True, strict_busy=True):

diff --git a/cloudinit/net/network_state.py b/cloudinit/net/network_state.py

index 4d19f56..71d3c0f 100644

--- a/cloudinit/net/network_state.py

+++ b/cloudinit/net/network_state.py

@@ -596,6 +596,7 @@ class NetworkStateInterpreter(object):

           eno1:

             match:

               macaddress: 00:11:22:33:44:55

+              driver: hv_netsvc

             wakeonlan: true

             dhcp4: true

             dhcp6: false

@@ -631,15 +632,18 @@ class NetworkStateInterpreter(object):

                 'type': 'physical',

                 'name': cfg.get('set-name', eth),

             }

-            mac_address = cfg.get('match', {}).get('macaddress', None)

+            match = cfg.get('match', {})

+            mac_address = match.get('macaddress', None)

             if not mac_address:

                 LOG.debug('NetworkState Version2: missing "macaddress" info '

                           'in config entry: %s: %s', eth, str(cfg))

-            phy_cmd.update({'mac_address': mac_address})

-

+            phy_cmd['mac_address'] = mac_address

+            driver = match.get('driver', None)

+            if driver:

+                phy_cmd['params'] = {'driver': driver}

             for key in ['mtu', 'match', 'wakeonlan']:

                 if key in cfg:

-                    phy_cmd.update({key: cfg.get(key)})

+                    phy_cmd[key] = cfg[key]

             subnets = self._v2_to_v1_ipcfg(cfg)

             if len(subnets) > 0:

diff --git a/cloudinit/net/tests/test_init.py b/cloudinit/net/tests/test_init.py

index 5519867..5349176 100644

--- a/cloudinit/net/tests/test_init.py

+++ b/cloudinit/net/tests/test_init.py

@@ -218,9 +218,9 @@ class TestGenerateFallbackConfig(CiTestCase):

         mac = 'aa:bb:cc:aa:bb:cc'

         write_file(os.path.join(self.sysdir, 'eth1', 'address'), mac)

         expected = {

-            'config': [{'type': 'physical', 'mac_address': mac,

-                        'name': 'eth1', 'subnets': [{'type': 'dhcp'}]}],

-            'version': 1}

+            'ethernets': {'eth1': {'match': {'macaddress': mac},

+                                   'dhcp4': True, 'set-name': 'eth1'}},

+            'version': 2}

         self.assertEqual(expected, net.generate_fallback_config())

     def test_generate_fallback_finds_dormant_eth_with_mac(self):

@@ -229,9 +229,9 @@ class TestGenerateFallbackConfig(CiTestCase):

         mac = 'aa:bb:cc:aa:bb:cc'

         write_file(os.path.join(self.sysdir, 'eth0', 'address'), mac)

         expected = {

-            'config': [{'type': 'physical', 'mac_address': mac,

-                        'name': 'eth0', 'subnets': [{'type': 'dhcp'}]}],

-            'version': 1}

+            'ethernets': {'eth0': {'match': {'macaddress': mac}, 'dhcp4': True,

+                                   'set-name': 'eth0'}},

+            'version': 2}

         self.assertEqual(expected, net.generate_fallback_config())

     def test_generate_fallback_finds_eth_by_operstate(self):

@@ -239,9 +239,10 @@ class TestGenerateFallbackConfig(CiTestCase):

         mac = 'aa:bb:cc:aa:bb:cc'

         write_file(os.path.join(self.sysdir, 'eth0', 'address'), mac)

         expected = {

-            'config': [{'type': 'physical', 'mac_address': mac,

-                        'name': 'eth0', 'subnets': [{'type': 'dhcp'}]}],

-            'version': 1}

+            'ethernets': {

+                'eth0': {'dhcp4': True, 'match': {'macaddress': mac},

+                         'set-name': 'eth0'}},

+            'version': 2}

         valid_operstates = ['dormant', 'down', 'lowerlayerdown', 'unknown']

         for state in valid_operstates:

             write_file(os.path.join(self.sysdir, 'eth0', 'operstate'), state)

diff --git a/cloudinit/sources/DataSourceAzure.py b/cloudinit/sources/DataSourceAzure.py

index 66bbe5e..8cb7e5c 100755

--- a/cloudinit/sources/DataSourceAzure.py

+++ b/cloudinit/sources/DataSourceAzure.py

@@ -1242,7 +1242,7 @@ def parse_network_config(imds_metadata):

                     privateIpv4 = addr4['privateIpAddress']

                     if privateIpv4:

                         if dev_config.get('dhcp4', False):

-                            # Append static address config for nic > 1

+                            # Append static address config for ip > 1

                             netPrefix = intf['ipv4']['subnet'][0].get(

                                 'prefix', '24')

                             if not dev_config.get('addresses'):

@@ -1252,6 +1252,11 @@ def parse_network_config(imds_metadata):

                                     ip=privateIpv4, prefix=netPrefix))

                         else:

                             dev_config['dhcp4'] = True

+                            # non-primary interfaces should have a higher

+                            # route-metric (cost) so default routes prefer

+                            # primary nic due to lower route-metric value

+                            dev_config['dhcp4-overrides'] = {

+                                'route-metric': (idx + 1) * 100}

                 for addr6 in intf['ipv6']['ipAddress']:

                     privateIpv6 = addr6['privateIpAddress']

                     if privateIpv6:

diff --git a/tests/unittests/test_datasource/test_azure.py b/tests/unittests/test_datasource/test_azure.py

index 1fb0565..f2ff967 100644

--- a/tests/unittests/test_datasource/test_azure.py

+++ b/tests/unittests/test_datasource/test_azure.py

@@ -13,6 +13,7 @@ from cloudinit.tests.helpers import (

     HttprettyTestCase, CiTestCase, populate_dir, mock, wrap_and_call,

     ExitStack, PY26, SkipTest, resourceLocation)

+import copy

 import crypt

 import httpretty

 import json

@@ -111,6 +112,26 @@ NETWORK_METADATA = {

     }

 }

+SECONDARY_INTERFACE = {

+    "macAddress": "220D3A047598",

+    "ipv6": {

+        "ipAddress": []

+    },

+    "ipv4": {

+        "subnet": [

+            {

+                "prefix": "24",

+                "address": "10.0.1.0"

+            }

+        ],

+        "ipAddress": [

+            {

+                "privateIpAddress": "10.0.1.5",

+            }

+        ]

+    }

+}

+

 MOCKPATH = 'cloudinit.sources.DataSourceAzure.'

@@ -632,8 +653,43 @@ fdescfs            /dev/fd          fdescfs rw              0 0

             'ethernets': {

                 'eth0': {'set-name': 'eth0',

                          'match': {'macaddress': '00:0d:3a:04:75:98'},

-                         'dhcp4': True}},

+                         'dhcp4': True,

+                         'dhcp4-overrides': {'route-metric': 100}}},

+            'version': 2}

+        dsrc = self._get_ds(data)

+        dsrc.get_data()

+        self.assertEqual(expected_network_config, dsrc.network_config)

+

+    def test_network_config_set_from_imds_route_metric_for_secondary_nic(self):

+        """Datasource.network_config adds route-metric to secondary nics."""

+        sys_cfg = {'datasource': {'Azure': {'apply_network_config': True}}}

+        odata = {}

+        data = {'ovfcontent': construct_valid_ovf_env(data=odata),

+                'sys_cfg': sys_cfg}

+        expected_network_config = {

+            'ethernets': {

+                'eth0': {'set-name': 'eth0',

+                         'match': {'macaddress': '00:0d:3a:04:75:98'},

+                         'dhcp4': True,

+                         'dhcp4-overrides': {'route-metric': 100}},

+                'eth1': {'set-name': 'eth1',

+                         'match': {'macaddress': '22:0d:3a:04:75:98'},

+                         'dhcp4': True,

+                         'dhcp4-overrides': {'route-metric': 200}},

+                'eth2': {'set-name': 'eth2',

+                         'match': {'macaddress': '33:0d:3a:04:75:98'},

+                         'dhcp4': True,

+                         'dhcp4-overrides': {'route-metric': 300}}},

             'version': 2}

+        imds_data = copy.deepcopy(NETWORK_METADATA)

+        imds_data['network']['interface'].append(SECONDARY_INTERFACE)

+        third_intf = copy.deepcopy(SECONDARY_INTERFACE)

+        third_intf['macAddress'] = third_intf['macAddress'].replace('22', '33')

+        third_intf['ipv4']['subnet'][0]['address'] = '10.0.2.0'

+        third_intf['ipv4']['ipAddress'][0]['privateIpAddress'] = '10.0.2.6'

+        imds_data['network']['interface'].append(third_intf)

+

+        self.m_get_metadata_from_imds.return_value = imds_data

         dsrc = self._get_ds(data)

         dsrc.get_data()

         self.assertEqual(expected_network_config, dsrc.network_config)

@@ -936,6 +992,7 @@ fdescfs            /dev/fd          fdescfs rw              0 0

         expected_cfg = {

             'ethernets': {

                 'eth0': {'dhcp4': True,

+                         'dhcp4-overrides': {'route-metric': 100},

                          'match': {'macaddress': '00:0d:3a:04:75:98'},

                          'set-name': 'eth0'}},

             'version': 2}

diff --git a/tests/unittests/test_net.py b/tests/unittests/test_net.py

index a975678..206de56 100644

--- a/tests/unittests/test_net.py

+++ b/tests/unittests/test_net.py

@@ -1651,7 +1651,7 @@ DEFAULT_DEV_ATTRS = {

         "carrier": False,

         "dormant": False,

         "operstate": "down",

-        "address": "07-1C-C6-75-A4-BE",

+        "address": "07-1c-c6-75-a4-be",

         "device/driver": None,

         "device/device": None,

         "name_assign_type": "4",

@@ -1702,6 +1702,39 @@ class TestGenerateFallbackConfig(CiTestCase):

     @mock.patch("cloudinit.net.sys_dev_path")

     @mock.patch("cloudinit.net.read_sys_net")

     @mock.patch("cloudinit.net.get_devicelist")

+    def test_device_driver_v2(self, mock_get_devicelist, mock_read_sys_net,

+                              mock_sys_dev_path):

+        """Network configuration for generate_fallback_config is version 2."""

+        devices = {

+            'eth0': {

+                'bridge': False, 'carrier': False, 'dormant': False,

+                'operstate': 'down', 'address': '00:11:22:33:44:55',

+                'device/driver': 'hv_netsvc', 'device/device': '0x3',

+                'name_assign_type': '4'},

+            'eth1': {

+                'bridge': False, 'carrier': False, 'dormant': False,

+                'operstate': 'down', 'address': '00:11:22:33:44:55',

+                'device/driver': 'mlx4_core', 'device/device': '0x7',

+                'name_assign_type': '4'},

+

+        }

+

+        tmp_dir = self.tmp_dir()

+        _setup_test(tmp_dir, mock_get_devicelist,

+                    mock_read_sys_net, mock_sys_dev_path,

+                    dev_attrs=devices)

+

+        network_cfg = net.generate_fallback_config(config_driver=True)

+        expected = {

+            'ethernets': {'eth0': {'dhcp4': True, 'set-name': 'eth0',

+                                   'match': {'macaddress': '00:11:22:33:44:55',

+                                             'driver': 'hv_netsvc'}}},

+            'version': 2}

+        self.assertEqual(expected, network_cfg)

+

+    @mock.patch("cloudinit.net.sys_dev_path")

+    @mock.patch("cloudinit.net.read_sys_net")

+    @mock.patch("cloudinit.net.get_devicelist")

     def test_device_driver(self, mock_get_devicelist, mock_read_sys_net,

                            mock_sys_dev_path):

         devices = {

@@ -1981,7 +2014,7 @@ class TestRhelSysConfigRendering(CiTestCase):

 #

 BOOTPROTO=dhcp

 DEVICE=eth1000

-HWADDR=07-1C-C6-75-A4-BE

+HWADDR=07-1c-c6-75-a4-be

 ONBOOT=yes

 TYPE=Ethernet

 USERCTL=no

@@ -2354,7 +2387,7 @@ class TestOpenSuseSysConfigRendering(CiTestCase):

 #

 BOOTPROTO=dhcp

 DEVICE=eth1000

-HWADDR=07-1C-C6-75-A4-BE

+HWADDR=07-1c-c6-75-a4-be

 NM_CONTROLLED=no

 ONBOOT=yes

 TYPE=Ethernet

@@ -2728,13 +2761,13 @@ class TestNetplanNetRendering(CiTestCase):

         expected = """

 network:

-    version: 2

     ethernets:

         eth1000:

             dhcp4: true

             match:

                 macaddress: 07-1c-c6-75-a4-be

             set-name: eth1000

+    version: 2

 """

         self.assertEqual(expected.lstrip(), contents.lstrip())

         self.assertEqual(1, mock_clean_default.call_count)

-- 

1.8.3.1