Merge ~xnox/cloud-init:master into cloud-init:master

[Dimitri John Ledkov]

net: kernel lies about vlans not stealing mac addresses, when they do

Introduce is_vlan function and call that when building dictionary of
interfaces by mac address.

LP: #1682871

[Server Team CI bot (server-team-bot)]

FAILED: Continuous integration, rev:9cff0a5689846ebb92219efbed3f7f8d7748dd06
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~xnox/cloud-init/+git/cloud-init/+merge/322828/+edit-commit-message

https://jenkins.ubuntu.com/server/job/cloud-init-ci/257/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/257
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/257
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/257
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/257
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/257

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/257/rebuild

review: Needs Fixing (continuous-integration)

[Dimitri John Ledkov (xnox)]

I did pass all the tests, and have set the commit message now.
I am unable to retrigger jenkins =(

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:9cff0a5689846ebb92219efbed3f7f8d7748dd06
https://jenkins.ubuntu.com/server/job/cloud-init-ci/258/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/258
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/258
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/258
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/258
    SUCCESS: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/258

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/258/rebuild

review: Approve (continuous-integration)

[Scott Moser (smoser)]

review: Approve

diff --git a/cloudinit/net/__init__.py b/cloudinit/net/__init__.py
index 346be5d..a072a8d 100644
--- a/cloudinit/net/__init__.py
+++ b/cloudinit/net/__init__.py
@@ -86,6 +86,11 @@ def is_bridge(devname):
     return os.path.exists(sys_dev_path(devname, "bridge"))
 
 
+def is_vlan(devname):
+    uevent = str(read_sys_net_safe(devname, "uevent"))
+    return 'DEVTYPE=vlan' in uevent.splitlines()
+
+
 def is_connected(devname):
     # is_connected isn't really as simple as that.  2 is
     # 'physically connected'. 3 is 'not connected'. but a wlan interface will
@@ -393,6 +398,8 @@ def get_interfaces_by_mac():
             continue
         if is_bridge(name):
             continue
+        if is_vlan(name):
+            continue
         mac = get_interface_mac(name)
         # some devices may not have a mac (tun0)
         if not mac:
diff --git a/tests/unittests/test_net.py b/tests/unittests/test_net.py
index 9cc5e4a..89e7536 100644
--- a/tests/unittests/test_net.py
+++ b/tests/unittests/test_net.py
@@ -1463,13 +1463,16 @@ class TestNetRenderers(CiTestCase):
 
 class TestGetInterfacesByMac(CiTestCase):
     _data = {'devices': ['enp0s1', 'enp0s2', 'bond1', 'bridge1',
-                         'bridge1-nic', 'tun0'],
+                         'bridge1-nic', 'tun0', 'bond1.101'],
              'bonds': ['bond1'],
              'bridges': ['bridge1'],
-             'own_macs': ['enp0s1', 'enp0s2', 'bridge1-nic', 'bridge1'],
+             'vlans': ['bond1.101'],
+             'own_macs': ['enp0s1', 'enp0s2', 'bridge1-nic', 'bridge1',
+                          'bond1.101'],
              'macs': {'enp0s1': 'aa:aa:aa:aa:aa:01',
                       'enp0s2': 'aa:aa:aa:aa:aa:02',
                       'bond1': 'aa:aa:aa:aa:aa:01',
+                      'bond1.101': 'aa:aa:aa:aa:aa:01',
                       'bridge1': 'aa:aa:aa:aa:aa:03',
                       'bridge1-nic': 'aa:aa:aa:aa:aa:03',
                       'tun0': None}}
@@ -1484,13 +1487,16 @@ class TestGetInterfacesByMac(CiTestCase):
     def _se_is_bridge(self, name):
         return name in self.data['bridges']
 
+    def _se_is_vlan(self, name):
+        return name in self.data['vlans']
+
     def _se_interface_has_own_mac(self, name):
         return name in self.data['own_macs']
 
     def _mock_setup(self):
         self.data = copy.deepcopy(self._data)
         mocks = ('get_devicelist', 'get_interface_mac', 'is_bridge',
-                 'interface_has_own_mac')
+                 'interface_has_own_mac', 'is_vlan')
         self.mocks = {}
         for n in mocks:
             m = mock.patch('cloudinit.net.' + n,
@@ -1536,6 +1542,24 @@ class TestGetInterfacesByMac(CiTestCase):
              mock.call('b1')],
             any_order=True)
 
+    def test_excludes_vlans(self):
+        self._mock_setup()
+        # add a device 'b1', make all return they have their "own mac",
+        # set everything other than 'b1' to be a vlan.
+        # then expect b1 is the only thing left.
+        self.data['macs']['b1'] = 'aa:aa:aa:aa:aa:b1'
+        self.data['devices'].append('b1')
+        self.data['bonds'] = []
+        self.data['bridges'] = []
+        self.data['own_macs'] = self.data['devices']
+        self.data['vlans'] = [f for f in self.data['devices'] if f != "b1"]
+        ret = net.get_interfaces_by_mac()
+        self.assertEqual({'aa:aa:aa:aa:aa:b1': 'b1'}, ret)
+        self.mocks['is_vlan'].assert_has_calls(
+            [mock.call('bridge1'), mock.call('enp0s1'), mock.call('bond1'),
+             mock.call('b1')],
+            any_order=True)
+
 
 def _gzip_data(data):
     with io.BytesIO() as iobuf: