Merge lp:~adam-collard/charm-helpers/fix-amulet-utils-validate-services-by-name into lp:charm-helpers

[Adam Collard]

Make the validate_services_by_name check actually verify that Upstart jobs are running and not just "existing".

Drive-by fixes for Python3 compatibility and dependencies for running tests (i.e. amulet, distro-info)

[lp:~adam-collard/charm-helpers/fix-amulet-utils-validate-services-by-name]

428. By Adam Collard on 2015-08-12

Add test files

[Chris Glass (tribaal)]

+1, thanks for your fix.

(Unit and amulet tests pass)

review: Approve

=== modified file 'charmhelpers/contrib/amulet/utils.py'
--- charmhelpers/contrib/amulet/utils.py	2015-08-10 12:58:05 +0000
+++ charmhelpers/contrib/amulet/utils.py	2015-08-12 14:08:32 +0000
@@ -14,17 +14,21 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
 
-import amulet
-import ConfigParser
-import distro_info
 import io
 import logging
 import os
 import re
-import six
 import sys
 import time
-import urlparse
+
+import amulet
+import distro_info
+import six
+from six.moves import configparser
+if six.PY3:
+    from urllib import parse as urlparse
+else:
+    import urlparse
 
 
 class AmuletUtils(object):
@@ -143,18 +147,22 @@
             for service_name in services_list:
                 if (self.ubuntu_releases.index(release) >= systemd_switch or
                         service_name in ['rabbitmq-server', 'apache2']):
-                    # init is systemd
+                    # init is systemd (or regular sysv)
                     cmd = 'sudo service {} status'.format(service_name)
+                    output, code = sentry_unit.run(cmd)
+                    service_running = code == 0
                 elif self.ubuntu_releases.index(release) < systemd_switch:
                     # init is upstart
                     cmd = 'sudo status {}'.format(service_name)
+                    output, code = sentry_unit.run(cmd)
+                    service_running = code == 0 and "start/running" in output
 
-                output, code = sentry_unit.run(cmd)
                 self.log.debug('{} `{}` returned '
                                '{}'.format(sentry_unit.info['unit_name'],
                                            cmd, code))
-                if code != 0:
-                    return "command `{}` returned {}".format(cmd, str(code))
+                if not service_running:
+                    return u"command `{}` returned {} {}".format(
+                        cmd, output, str(code))
         return None
 
     def _get_config(self, unit, filename):
@@ -164,7 +172,7 @@
         # NOTE(beisner):  by default, ConfigParser does not handle options
         # with no value, such as the flags used in the mysql my.cnf file.
         # https://bugs.python.org/issue7005
-        config = ConfigParser.ConfigParser(allow_no_value=True)
+        config = configparser.ConfigParser(allow_no_value=True)
         config.readfp(io.StringIO(file_contents))
         return config
 
 
=== modified file 'test_requirements.txt'
--- test_requirements.txt	2015-07-15 17:01:57 +0000
+++ test_requirements.txt	2015-08-12 14:08:32 +0000
@@ -7,6 +7,8 @@
 nose>=1.3.1
 flake8
 testtools==0.9.14  # Before dependent on modern 'six'
+amulet
+distro-info
 #
 # Specify precise versions of runtime dependencies where possible.
 netaddr==0.7.10    # trusty. precise is 0.7.5, but not in pypi.
 
=== added directory 'tests/contrib/amulet'
=== added file 'tests/contrib/amulet/test_utils.py'
--- tests/contrib/amulet/test_utils.py	1970-01-01 00:00:00 +0000
+++ tests/contrib/amulet/test_utils.py	2015-08-12 14:08:32 +0000
@@ -0,0 +1,105 @@
+# Copyright 2015 Canonical Ltd.
+#
+# Authors:
+#  Adam Collard <[e-mail]>
+
+import unittest
+
+from charmhelpers.contrib.amulet.utils import AmuletUtils
+
+
+class FakeSentry(object):
+
+    commands = {}
+
+    info = {"unit_name": "foo"}
+
+    def run(self, command):
+        return self.commands[command]
+
+
+class ValidateServicesByNameTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.utils = AmuletUtils()
+        self.sentry_unit = FakeSentry()
+
+    def test_errors_for_unknown_upstart_service(self):
+        """
+        Returns a message if the Upstart service is unknown.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "trusty", 0
+        self.sentry_unit.commands["sudo status foo"] = (
+            "status: Unknown job: foo", 1)
+
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
+
+    def test_none_for_started_upstart_service(self):
+        """
+        Returns None if the Upstart service is running.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "trusty", 0
+        self.sentry_unit.commands["sudo status foo"] = (
+            "foo start/running, process 42", 0)
+
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNone(result)
+
+    def test_errors_for_stopped_upstart_service(self):
+        """
+        Returns a message if the Upstart service is stopped.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "trusty", 0
+        self.sentry_unit.commands["sudo status foo"] = "foo stop/waiting", 0
+
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
+
+    def test_errors_for_unknown_systemd_service(self):
+        """
+        Returns a message if a systemd service is unknown.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "vivid", 0
+        self.sentry_unit.commands["sudo service foo status"] = (u"""\
+\u25cf foo.service
+   Loaded: not-found (Reason: No such file or directory)
+   Active: inactive (dead)
+""", 3)
+
+        result = self.utils.validate_services_by_name({
+            self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)
+
+    def test_none_for_started_systemd_service(self):
+        """
+        Returns None if a systemd service is running.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "vivid", 0
+        self.sentry_unit.commands["sudo service foo status"] = (u"""\
+\u25cf foo.service - Foo
+   Loaded: loaded (/lib/systemd/system/foo.service; enabled)
+   Active: active (exited) since Thu 1970-01-01 00:00:00 UTC; 42h 42min ago
+ Main PID: 3 (code=exited, status=0/SUCCESS)
+   CGroup: /system.slice/foo.service
+""", 0)
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNone(result)
+
+    def test_errors_for_stopped_systemd_service(self):
+        """
+        Returns a message if a systemd service is stopped.
+        """
+        self.sentry_unit.commands["lsb_release -cs"] = "vivid", 0
+        self.sentry_unit.commands["sudo service foo status"] = (u"""\
+\u25cf foo.service - Foo
+   Loaded: loaded (/lib/systemd/system/foo.service; disabled)
+   Active: inactive (dead)
+""", 3)
+        result = self.utils.validate_services_by_name(
+            {self.sentry_unit: ["foo"]})
+        self.assertIsNotNone(result)