From 1d8c327139a8c291eeb244ee1a6a8badd83e9e72 Mon Sep 17 00:00:00 2001
From: Chad Smith <chad.smith@canonical.com>
Date: Fri, 26 Jan 2018 13:36:30 -0700
Subject: Fix potential cases of uninitialized variables.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

While addressing undeclared variable in 'cloud-init status', I also fixed
the errors raised by automated code reviews against cloud-init master at
https://lgtm.com/projects/g/cloud-init/cloud-init/alerts

The following items are addressed:

 * Fix 'cloud-init status':
    * Only report 'running' state when any stage in
      /run/cloud-init/status.json has a start time but no finished time.
      Default start time to 0 if null.
    * undeclared variable 'reason' now reports 'Cloud-init enabled by
      systemd cloud-init-generator' when systemd enables cloud-init

 * cc_rh_subscription.py util.subp return values aren't set during if an
   exception is raised, use ProcessExecution as e instead.

 * distros/freebsd.py:
   * Drop repetitive looping over ipv4 and ipv6 nic lists.
   * Initialize bsddev to 'NOTFOUND' in the event that no devs are
     discovered
   * declare nics_with_addresses = set() in broader scope outside
     check_downable conditional

 * cloudinit/util.py: Raise TypeError if mtype parameter isn't string,
   iterable or None.

LP: #1744796
---
 cloudinit/cmd/status.py            |  7 +++++--
 cloudinit/cmd/tests/test_status.py | 21 ++++++++++++++++++---
 2 files changed, 23 insertions(+), 5 deletions(-)

(limited to 'cloudinit/cmd')

diff --git a/cloudinit/cmd/status.py b/cloudinit/cmd/status.py
index 3e5d0d07..d7aaee9d 100644
--- a/cloudinit/cmd/status.py
+++ b/cloudinit/cmd/status.py
@@ -93,6 +93,8 @@ def _is_cloudinit_disabled(disable_file, paths):
     elif not os.path.exists(os.path.join(paths.run_dir, 'enabled')):
         is_disabled = True
         reason = 'Cloud-init disabled by cloud-init-generator'
+    else:
+        reason = 'Cloud-init enabled by systemd cloud-init-generator'
     return (is_disabled, reason)
 
 
@@ -127,10 +129,11 @@ def _get_status_details(paths):
             status_detail = value
         elif isinstance(value, dict):
             errors.extend(value.get('errors', []))
+            start = value.get('start') or 0
             finished = value.get('finished') or 0
-            if finished == 0:
+            if finished == 0 and start != 0:
                 status = STATUS_RUNNING
-            event_time = max(value.get('start', 0), finished)
+            event_time = max(start, finished)
             if event_time > latest_event:
                 latest_event = event_time
     if errors:
diff --git a/cloudinit/cmd/tests/test_status.py b/cloudinit/cmd/tests/test_status.py
index 6d4a11e8..a7c0a91a 100644
--- a/cloudinit/cmd/tests/test_status.py
+++ b/cloudinit/cmd/tests/test_status.py
@@ -93,6 +93,19 @@ class TestStatus(CiTestCase):
         self.assertTrue(is_disabled, 'expected disabled cloud-init')
         self.assertEqual('Cloud-init disabled by cloud-init-generator', reason)
 
+    def test__is_cloudinit_disabled_false_when_enabled_in_systemd(self):
+        '''Report enabled when systemd generator creates the enabled file.'''
+        enabled_file = os.path.join(self.paths.run_dir, 'enabled')
+        write_file(enabled_file, '')
+        (is_disabled, reason) = wrap_and_call(
+            'cloudinit.cmd.status',
+            {'uses_systemd': True,
+             'get_cmdline': 'something ignored'},
+            status._is_cloudinit_disabled, self.disable_file, self.paths)
+        self.assertFalse(is_disabled, 'expected enabled cloud-init')
+        self.assertEqual(
+            'Cloud-init enabled by systemd cloud-init-generator', reason)
+
     def test_status_returns_not_run(self):
         '''When status.json does not exist yet, return 'not run'.'''
         self.assertFalse(
@@ -137,8 +150,9 @@ class TestStatus(CiTestCase):
         self.assertEqual(expected, m_stdout.getvalue())
 
     def test_status_returns_running(self):
-        '''Report running when status file exists but isn't finished.'''
-        write_json(self.status_file, {'v1': {'init': {'finished': None}}})
+        '''Report running when status exists with an unfinished stage.'''
+        write_json(self.status_file,
+                   {'v1': {'init': {'start': 1, 'finished': None}}})
         cmdargs = myargs(long=False, wait=False)
         with mock.patch('sys.stdout', new_callable=StringIO) as m_stdout:
             retcode = wrap_and_call(
@@ -338,7 +352,8 @@ class TestStatus(CiTestCase):
 
     def test_status_main(self):
         '''status.main can be run as a standalone script.'''
-        write_json(self.status_file, {'v1': {'init': {'finished': None}}})
+        write_json(self.status_file,
+                   {'v1': {'init': {'start': 1, 'finished': None}}})
         with self.assertRaises(SystemExit) as context_manager:
             with mock.patch('sys.stdout', new_callable=StringIO) as m_stdout:
                 wrap_and_call(
-- 
cgit v1.2.3