Merge ~smoser/cloud-init:bug/1701325-no-dmi-data-in-container into cloud-init:master

[Scott Moser]

read_dmi_data: always return None when inside a container.

This fixes stacktrace and warning message that would be printed
to the log if running inside a container and read_dmi_data tried
to access a key that was not present.

In a container, the /sys/class/dmi/id data is not relevant to the
but to the host. Additionally an unpriviledged container might see
strange behavior:
   # cd /sys/class/dmi/id/
   # id -u
   0
   # ls -l chassis_serial
   -r-------- 1 nobody nogroup 4096 Jun 29 16:49 chassis_serial
   # cat chassis_serial
   cat: /sys/class/dmi/id/chassis_serial: Permission denied

The solution here is to just always return None when running in a
container.

LP: #1701325

[Ryan Harper (raharper)]

This is a good fix.

review: Approve

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

FAILED: Continuous integration, rev:2a60190bbc4b23d2fd907307cd41f7e04329b2b3
https://jenkins.ubuntu.com/server/job/cloud-init-ci/25/
Executed test runs:
    SUCCESS: Checkout
    FAILED: Unit & Style Tests

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

review: Needs Fixing (continuous-integration)

[Joshua Powers (powersj)]

+1 once this is fixed:
tests/unittests/test_util.py:468:1: E303 too many blank lines (3)

Create artful container, upgraded to built version of deb, rebooted. Cleaned out /var/lib/cloud (kept seed) and /var/log/cloud-init* and rebooted. All looks good and stack traces are gone.

review: Approve

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

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

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

review: Approve (continuous-integration)

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

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

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:5e35beb88381e44010b1c9fbff3f6cfecc920642
https://jenkins.ubuntu.com/server/job/cloud-init-ci/28/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    SUCCESS: CentOS 6 & 7: Build & Test
    IN_PROGRESS: Declarative: Post Actions

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

review: Approve (continuous-integration)

diff --git a/cloudinit/util.py b/cloudinit/util.py
index c93b6d7..b486e18 100644
--- a/cloudinit/util.py
+++ b/cloudinit/util.py
@@ -2397,6 +2397,10 @@ def read_dmi_data(key):
     """
     Wrapper for reading DMI data.
 
+    If running in a container return None.  This is because DMI data is
+    assumed to be not useful in a container as it does not represent the
+    container but rather the host.
+
     This will do the following (returning the first that produces a
     result):
         1) Use a mapping to translate `key` from dmidecode naming to
@@ -2407,6 +2411,9 @@ def read_dmi_data(key):
     If all of the above fail to find a value, None will be returned.
     """
 
+    if is_container():
+        return None
+
     syspath_value = _read_dmi_syspath(key)
     if syspath_value is not None:
         return syspath_value
diff --git a/tests/unittests/test_util.py b/tests/unittests/test_util.py
index a73fd26..65035be 100644
--- a/tests/unittests/test_util.py
+++ b/tests/unittests/test_util.py
@@ -365,6 +365,9 @@ class TestReadDMIData(helpers.FilesystemMockingTestCase):
         self.addCleanup(shutil.rmtree, self.new_root)
         self.patchOS(self.new_root)
         self.patchUtils(self.new_root)
+        p = mock.patch("cloudinit.util.is_container", return_value=False)
+        self.addCleanup(p.stop)
+        self._m_is_container = p.start()
 
     def _create_sysfs_parent_directory(self):
         util.ensure_dir(os.path.join('sys', 'class', 'dmi', 'id'))
@@ -453,6 +456,26 @@ class TestReadDMIData(helpers.FilesystemMockingTestCase):
         self._create_sysfs_file(sysfs_key, dmi_value)
         self.assertEqual(expected, util.read_dmi_data(dmi_key))
 
+    def test_container_returns_none(self):
+        """In a container read_dmi_data should always return None."""
+
+        # first verify we get the value if not in container
+        self._m_is_container.return_value = False
+        key, val = ("system-product-name", "my_product")
+        self._create_sysfs_file('product_name', val)
+        self.assertEqual(val, util.read_dmi_data(key))
+
+        # then verify in container returns None
+        self._m_is_container.return_value = True
+        self.assertIsNone(util.read_dmi_data(key))
+
+    def test_container_returns_none_on_unknown(self):
+        """In a container even bogus keys return None."""
+        self._m_is_container.return_value = True
+        self._create_sysfs_file('product_name', "should-be-ignored")
+        self.assertIsNone(util.read_dmi_data("bogus"))
+        self.assertIsNone(util.read_dmi_data("system-product-name"))
+
 
 class TestMultiLog(helpers.FilesystemMockingTestCase):