Merge ~mvoelker/cloud-init:id_vmware_openstack into cloud-init:master

[Mark T. Voelker]

Allow identification of OpenStack by Asset Tag

When OpenStack is deployed on some hypervisors (such as VMware
vSphere), cloud-init doesn't detect that it needs to probe the
metadata service because the DMI product name field can't be set
to a field that is recognized by cloud-init. However, the asset
tag field can be set via flavor extra specs or image metadata.
A similar approach is already used to identify Open Telekom Cloud.

This patch allows cloud init to recognize "OpenStack Nova" or
"OpenStack Compute" in the asset tag field as an indication that
the instance being configured is running on an OpenStack platform.

LP: #1669875

[Ryan Harper (raharper)]

Thanks for putting up a patch for this.

I've added a comment below and I'd like to have you
add the following unittests for this change to your branch.

http://paste.ubuntu.com/p/ybhFdggWZY/

review: Needs Fixing

[Mark T. Voelker (mvoelker)]

Thanks for the suggestions Ryan! I'll touch it up once I get back to my
desk (I'm unfortunately traveling this week).

a79dc33... by Mark T. Voelker on 2019-05-20

Merge branch 'id_vmware_openstack' of ssh://git.launchpad.net/~mvoelker/cloud-init into id_vmware_openstack

[Robert Schweikert (rjschwei)]

We've also run into this with SLES in VMWare, can this be moved forward?

[Ryan Harper (raharper)]

I've pointed CI at this branch. Otherwise looks good to go.

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

PASSED: Continuous integration, rev:a79dc3374ab7681f344f2a74762b7924830df09f
https://jenkins.ubuntu.com/server/job/cloud-init-ci/731/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

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

review: Approve (continuous-integration)

diff --git a/tests/unittests/test_ds_identify.py b/tests/unittests/test_ds_identify.py
index 8c18aa1..7575223 100644
--- a/tests/unittests/test_ds_identify.py
+++ b/tests/unittests/test_ds_identify.py
@@ -435,6 +435,14 @@ class TestDsIdentify(DsIdentifyBase):
         """Open Telecom identification."""
         self._test_ds_found('OpenStack-OpenTelekom')
 
+    def test_openstack_asset_tag_nova(self):
+        """OpenStack identification via asset tag OpenStack Nova."""
+        self._test_ds_found('OpenStack-AssetTag-Nova')
+
+    def test_openstack_asset_tag_copute(self):
+        """OpenStack identification via asset tag OpenStack Compute."""
+        self._test_ds_found('OpenStack-AssetTag-Compute')
+
     def test_openstack_on_non_intel_is_maybe(self):
         """On non-Intel, openstack without dmi info is maybe.
 
@@ -759,6 +767,18 @@ VALID_CFG = {
         'files': {P_CHASSIS_ASSET_TAG: 'OpenTelekomCloud\n'},
         'mocks': [MOCK_VIRT_IS_XEN],
     },
+    'OpenStack-AssetTag-Nova': {
+        # VMware vSphere can't modify product-name, LP: #1669875
+        'ds': 'OpenStack',
+        'files': {P_CHASSIS_ASSET_TAG: 'OpenStack Nova\n'},
+        'mocks': [MOCK_VIRT_IS_XEN],
+    },
+    'OpenStack-AssetTag-Compute': {
+        # VMware vSphere can't modify product-name, LP: #1669875
+        'ds': 'OpenStack',
+        'files': {P_CHASSIS_ASSET_TAG: 'OpenStack Compute\n'},
+        'mocks': [MOCK_VIRT_IS_XEN],
+    },
     'OVF-seed': {
         'ds': 'OVF',
         'files': {
diff --git a/tools/ds-identify b/tools/ds-identify
index 6518901..e16708f 100755
--- a/tools/ds-identify
+++ b/tools/ds-identify
@@ -979,6 +979,14 @@ dscheck_OpenStack() {
         return ${DS_FOUND}
     fi
 
+    # LP: #1669875 : allow identification of OpenStack by asset tag
+    if dmi_chassis_asset_tag_matches "$nova"; then
+        return ${DS_FOUND}
+    fi
+    if dmi_chassis_asset_tag_matches "$compute"; then
+        return ${DS_FOUND}
+    fi
+
     # LP: #1715241 : arch other than intel are not identified properly.
     case "$DI_UNAME_MACHINE" in
         i?86|x86_64) :;;