Merge ~smoser/cloud-init:feature/digital-ocean-more-strict into cloud-init:master

[Scott Moser]

DigitalOcean: be more strict in network configuration conversion.

a.) warn on a 'nic' type in metadata that is unknown.
b.) raise exception if metadata defines a nic that is not present.

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

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

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

review: Approve (continuous-integration)

[Ben Howard (darkmuggle-deactivatedaccount)]

While I like the change in general, I've dropped the nic mapping in my MP submitted on 3/28.

review: Needs Fixing

[Scott Moser (smoser)]

the 2 pieces here
a.) warn on unknown type
b.) raise runtime exception

Ben's changes recently did 'b', and 'a' is not really necessary.. we still get configuration done now, we just dont pick a specific nic name.

diff --git a/cloudinit/sources/helpers/digitalocean.py b/cloudinit/sources/helpers/digitalocean.py
index 72f7bde..76ae410 100644
--- a/cloudinit/sources/helpers/digitalocean.py
+++ b/cloudinit/sources/helpers/digitalocean.py
@@ -136,11 +136,19 @@ def convert_network_configuration(config, dns_servers):
 
         mac_address = nic.get('mac')
         sysfs_name = macs_to_nics.get(mac_address)
+        if mac_address not in macs_to_nics:
+            raise RuntimeError(
+                "Did not find network interface on system with mac '%s'."
+                "Cannot apply configuration: %s" % (mac_address, nic))
         nic_type = nic.get('type', 'unknown')
         # Note: the entry 'public' above contains a list, but
         # the list will only ever have one nic inside it per digital ocean.
         # If it ever had more than one nic, then this code would
         # assign all 'public' the same name.
+        if nic_type not in NIC_MAP:
+            LOG.warn("Unknown / unexpected nic type '%s': %s" %
+                     (nic_type, nic))
+
         if_name = NIC_MAP.get(nic_type, sysfs_name)
 
         LOG.debug("mapped %s interface to %s, assigning name of %s",
diff --git a/tests/unittests/test_datasource/test_digitalocean.py b/tests/unittests/test_datasource/test_digitalocean.py
index 61d6e00..e9edbf1 100644
--- a/tests/unittests/test_datasource/test_digitalocean.py
+++ b/tests/unittests/test_datasource/test_digitalocean.py
@@ -330,4 +330,11 @@ class TestNetworkConvert(TestCase):
             sorted(['45.55.249.133', '10.17.0.5']),
             sorted([i['address'] for i in eth0['subnets']]))
 
+    @mock.patch('cloudinit.net.get_interfaces_by_mac')
+    def test_missing_nic_raises_runtime(self, m_get_interfaces_by_mac):
+        m_get_interfaces_by_mac.return_value = {'04:01:57:d1:9e:02': 'eth0'}
+        self.assertRaises(
+            RuntimeError, digitalocean.convert_network_configuration,
+            *[DO_META_2['interfaces'], DO_META_2['dns']['nameservers']])
+
 # vi: ts=4 expandtab