Merge ~smoser/cloud-init:fix/1792157-openstack-md-version-fix into cloud-init:master

[Scott Moser]

OpenStack: fix bug causing 'latest' version to be used from network.

Cloud-init was reading a list of versions from the OpenStack metadata
service (http://169.254.169.254/openstack/) and attempt to select the
newest known supported version. The problem was that the list
of versions was not being decoded, so we were comparing a list of
bytes (found versions) to a list of strings (known versions).

LP: #1792157

see commit message

[Scott Moser (smoser)]

tests coming. but this does fix.

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

PASSED: Continuous integration, rev:86f9ffdfc95696025dd5c012cfc578b16a753ba7
https://jenkins.ubuntu.com/server/job/cloud-init-ci/309/
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/309/rebuild

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:353c595077c4fb26abead76d7194c8da5d2300c2
https://jenkins.ubuntu.com/server/job/cloud-init-ci/310/
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/310/rebuild

review: Approve (continuous-integration)

[Chad Smith (chad.smith)]

Approve, pending your decision about adding Ocata.

review: Approve

[Scott Moser (smoser)]

https://code.launchpad.net/~smoser/cloud-init/+git/cloud-init/+merge/354796
ocata is added ^

i went down that path too, but figured it was a feature part of this bug fix.

[Scott Moser (smoser)]

review: Approve

[Scott Moser (smoser)]

bad link.
https://code.launchpad.net/~smoser/cloud-init/+git/cloud-init/+merge/354797
that one is what adds new versions.

diff --git a/cloudinit/sources/helpers/openstack.py b/cloudinit/sources/helpers/openstack.py
index 8f9c144..e3d372b 100644
--- a/cloudinit/sources/helpers/openstack.py
+++ b/cloudinit/sources/helpers/openstack.py
@@ -439,7 +439,7 @@ class MetadataReader(BaseReader):
             return self._versions
         found = []
         version_path = self._path_join(self.base_path, "openstack")
-        content = self._path_read(version_path)
+        content = self._path_read(version_path, decode=True)
         for line in content.splitlines():
             line = line.strip()
             if not line:
diff --git a/tests/unittests/test_datasource/test_openstack.py b/tests/unittests/test_datasource/test_openstack.py
index 6e1e971..ab5d3ad 100644
--- a/tests/unittests/test_datasource/test_openstack.py
+++ b/tests/unittests/test_datasource/test_openstack.py
@@ -555,4 +555,34 @@ class TestDetectOpenStack(test_helpers.CiTestCase):
         m_proc_env.assert_called_with(1)
 
 
+class TestMetadataReader(test_helpers.HttprettyTestCase):
+    """Test the MetadataReader."""
+    burl = 'http://169.254.169.254/'
+
+    def register(self, path, body=None, status=200):
+        hp.register_uri(
+            hp.GET, self.burl + "openstack" + path, status=status, body=body)
+
+    def register_versions(self, versions):
+        self.register("", '\n'.join(versions).encode('utf-8'))
+
+    def test__find_working_version(self):
+        """Test a working version ignores unsupported."""
+        unsup = "2016-11-09"
+        self.register_versions(
+            [openstack.OS_FOLSOM, openstack.OS_LIBERTY, unsup,
+             openstack.OS_LATEST])
+        self.assertEqual(
+            openstack.OS_LIBERTY,
+            openstack.MetadataReader(self.burl)._find_working_version())
+
+    def test__find_working_version_uses_latest(self):
+        """'latest' should be used if no supported versions."""
+        unsup1, unsup2 = ("2016-11-09", '2017-06-06')
+        self.register_versions([unsup1, unsup2, openstack.OS_LATEST])
+        self.assertEqual(
+            openstack.OS_LATEST,
+            openstack.MetadataReader(self.burl)._find_working_version())
+
+
 # vi: ts=4 expandtab