Merge pull request #212 from gnuoy/add-custom-assertions

Add custom assertions

zaza/openstack/charm_tests/test_utils.py

@@ -350,10 +350,10 @@ class BaseCharmTest(unittest.TestCase):
             self.lead_unit,
             'active',
             model_name=self.model_name)
-        model.run_action(
+        generic_utils.assertActionRanOK(model.run_action(
             self.lead_unit,
             'pause',
-            model_name=self.model_name)
+            model_name=self.model_name))
         model.block_until_unit_wl_status(
             self.lead_unit,
             'maintenance',
@@ -366,10 +366,10 @@ class BaseCharmTest(unittest.TestCase):
             model_name=self.model_name,
             pgrep_full=pgrep_full)
         yield
-        model.run_action(
+        generic_utils.assertActionRanOK(model.run_action(
             self.lead_unit,
             'resume',
-            model_name=self.model_name)
+            model_name=self.model_name))
         model.block_until_unit_wl_status(
             self.lead_unit,
             'active',

zaza/openstack/utilities/generic.py

@@ -28,6 +28,48 @@ from zaza.openstack.utilities import exceptions as zaza_exceptions
 from zaza.openstack.utilities.os_versions import UBUNTU_OPENSTACK_RELEASE
 
 
+def assertActionRanOK(action):
+    """Assert that the remote action ran successfully.
+
+    Example usage::
+
+        self.assertActionRanOK(model.run_action(
+            unit,
+            'pause',
+            model_name=self.model_name))
+
+        self.assertActionRanOK(model.run_action_on_leader(
+            unit,
+            'pause',
+            model_name=self.model_name))
+
+    :param action: Action object to check.
+    :type action: juju.action.Action
+    :raises: AssertionError if the assertion fails.
+    """
+    if action.status != 'completed':
+        msg = ("Action '{name}' exited with status '{status}': "
+               "'{message}'").format(**action.data)
+        raise AssertionError(msg)
+
+
+def assertRemoteRunOK(run_output):
+    """Use with zaza.model.run_on_unit.
+
+    Example usage::
+
+        self.assertRemoteRunOK(zaza.model.run_on_unit(
+            unit,
+            'ls /tmp/'))
+
+    :param action: Dict returned from remote run.
+    :type action: dict
+    :raises: AssertionError if the assertion fails.
+    """
+    if int(run_output['Code']) != 0:
+        raise AssertionError("Command failed: {}".format(run_output))
+
+
 def dict_to_yaml(dict_data):
     """Return YAML from dictionary.