Merge ~smoser/cloud-init:fix/freebsd-test-failure into cloud-init:master

[Scott Moser]

FreeBSD: fix test failure

The previous commit caused test failure.
This separates out _check_freebsd_cdrom and mocks it in a test
rather than patching open.

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

FAILED: Continuous integration, rev:14fc9449865810012cbf2f705b18efb3890b9096
https://jenkins.ubuntu.com/server/job/cloud-init-ci/540/
Executed test runs:
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-amd64/540/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-arm64/540/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-ppc64el/540/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=metal-s390x/540/console
    FAILURE: https://jenkins.ubuntu.com/server/job/cloud-init-ci/nodes=vm-i386/540/console

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

review: Needs Fixing (continuous-integration)

[Ryan Harper (raharper)]

Looks good.

review: Approve

[Joshua Powers (powersj)]

LGTM passes CI pipeline now.

review: Approve

[Chad Smith (chad.smith)]

minor nit and +1.

review: Approve

diff --git a/cloudinit/sources/DataSourceAzure.py b/cloudinit/sources/DataSourceAzure.py
index ebb53d0..71e7c55 100644
--- a/cloudinit/sources/DataSourceAzure.py
+++ b/cloudinit/sources/DataSourceAzure.py
@@ -803,18 +803,23 @@ def encrypt_pass(password, salt_id="$6$"):
     return crypt.crypt(password, salt_id + util.rand_str(strlen=16))
 
 
+def _check_freebsd_cdrom(cdrom_dev):
+    """Return boolean indicating path to cdrom device has content."""
+    try:
+        with open(cdrom_dev) as fp:
+            fp.read(1024)
+            return True
+    except IOError:
+        LOG.debug("cdrom (%s) is not configured", cdrom_dev)
+    return False
+
+
 def list_possible_azure_ds_devs():
     devlist = []
     if util.is_FreeBSD():
-        # add '/dev/cd0' to devlist if it is configured
-        # here wants to test whether '/dev/cd0' is available
         cdrom_dev = "/dev/cd0"
-        try:
-            with open(cdrom_dev) as fp:
-                fp.read(1024)
-                devlist.append(cdrom_dev)
-        except IOError:
-            LOG.debug("cdrom (%s) is not configured", cdrom_dev)
+        if _check_freebsd_cdrom(cdrom_dev):
+            return [cdrom_dev]
     else:
         for fstype in ("iso9660", "udf"):
             devlist.extend(util.find_devs_with("TYPE=%s" % fstype))
diff --git a/tests/unittests/test_datasource/test_azure.py b/tests/unittests/test_datasource/test_azure.py
index 114b1a5..7d33daf 100644
--- a/tests/unittests/test_datasource/test_azure.py
+++ b/tests/unittests/test_datasource/test_azure.py
@@ -7,8 +7,7 @@ from cloudinit.util import find_freebsd_part
 from cloudinit.util import get_path_dev_freebsd
 
 from ..helpers import (CiTestCase, TestCase, populate_dir, mock,
-                       ExitStack, PY26, PY3, SkipTest)
-from mock import patch, mock_open
+                       ExitStack, PY26, SkipTest)
 
 import crypt
 import os
@@ -544,14 +543,16 @@ fdescfs            /dev/fd          fdescfs rw              0 0
         ds.get_data()
         self.assertEqual(self.instance_id, ds.metadata['instance-id'])
 
-    def test_list_possible_azure_ds_devs(self):
-        devlist = []
-        with patch('platform.platform',
-                   mock.MagicMock(return_value="FreeBSD")):
-            name = 'builtins.open' if PY3 else '__builtin__.open'
-            with patch(name, mock_open(read_data="data")):
-                devlist.extend(dsaz.list_possible_azure_ds_devs())
-                self.assertEqual(devlist, ['/dev/cd0'])
+    @mock.patch("cloudinit.sources.DataSourceAzure.util.is_FreeBSD")
+    @mock.patch("cloudinit.sources.DataSourceAzure._check_freebsd_cdrom")
+    def test_list_possible_azure_ds_devs(self, m_check_fbsd_cdrom,
+                                         m_is_FreeBSD):
+        """On FreeBSD, possible devs should show /dev/cd0."""
+        m_is_FreeBSD.return_value = True
+        m_check_fbsd_cdrom.return_value = True
+        self.assertEqual(dsaz.list_possible_azure_ds_devs(), ['/dev/cd0'])
+        self.assertEqual(
+            [mock.call("/dev/cd0")], m_check_fbsd_cdrom.call_args_list)
 
 
 class TestAzureBounce(TestCase):