Merge lp:~adam-collard/charm-helpers/amulet-action-helpers into lp:charm-helpers

[Adam Collard]

Add helpers to contrib.amulet.utils for interacting with actions.

[Chris Glass (tribaal)]

Looks good, thanks a lot!

+1

(note: for some reason I had to recreate the .venvs for the tests to pass - but I suspect it's a fluke.)

review: Approve

=== modified file 'charmhelpers/contrib/amulet/utils.py'
--- charmhelpers/contrib/amulet/utils.py	2015-08-12 13:33:22 +0000
+++ charmhelpers/contrib/amulet/utils.py	2015-08-14 17:21:23 +0000
@@ -15,9 +15,11 @@
 # along with charm-helpers.  If not, see <http://www.gnu.org/licenses/>.
 
 import io
+import json
 import logging
 import os
 import re
+import subprocess
 import sys
 import time
 
@@ -551,3 +553,30 @@
             return 'Dicts within list are not identical'
 
         return None
+
+    def run_action(self, unit_sentry, action,
+                   _check_output=subprocess.check_output):
+        """Run the named action on a given unit sentry.
+
+        _check_output parameter is used for dependency injection.
+
+        @return action_id.
+        """
+        unit_id = unit_sentry.info["unit_name"]
+        command = ["juju", "action", "do", "--format=json", unit_id, action]
+        self.log.info("Running command: %s\n" % " ".join(command))
+        output = _check_output(command, universal_newlines=True)
+        data = json.loads(output)
+        action_id = data[u'Action queued with id']
+        return action_id
+
+    def wait_on_action(self, action_id, _check_output=subprocess.check_output):
+        """Wait for a given action, returning if it completed or not.
+
+        _check_output parameter is used for dependency injection.
+        """
+        command = ["juju", "action", "fetch", "--format=json", "--wait=0",
+                   action_id]
+        output = _check_output(command, universal_newlines=True)
+        data = json.loads(output)
+        return data.get(u"status") == "completed"

=== added file 'tests/contrib/amulet/__init__.py'
=== modified file 'tests/contrib/amulet/test_utils.py'
--- tests/contrib/amulet/test_utils.py	2015-08-12 14:08:25 +0000
+++ tests/contrib/amulet/test_utils.py	2015-08-14 17:21:23 +0000
@@ -103,3 +103,93 @@
         result = self.utils.validate_services_by_name(
             {self.sentry_unit: ["foo"]})
         self.assertIsNotNone(result)
+
+
+class RunActionTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.utils = AmuletUtils()
+        self.sentry_unit = FakeSentry()
+
+    def test_request_json_output(self):
+        """Juju is called with --format=json, to guarantee output format."""
+        output_calls = []
+
+        def fake_check_output(call, **kwargs):
+            output_calls.append(call)
+            return '{"Action queued with id": "action-id"}'
+
+        self.utils.run_action(
+            self.sentry_unit, "foo", _check_output=fake_check_output)
+        call, = output_calls
+        self.assertIn("--format=json", call)
+
+    def test_returns_action_id(self):
+        """JSON output is parsed and returns action_id."""
+
+        def fake_check_output(call, **kwargs):
+            return '{"Action queued with id": "action-id"}'
+
+        self.assertEqual("action-id", self.utils.run_action(
+            self.sentry_unit, "foo", _check_output=fake_check_output))
+
+
+class WaitActionTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.utils = AmuletUtils()
+        self.sentry_unit = FakeSentry()
+
+    def test_request_json_output(self):
+        """Juju is called with --format=json, to guarantee output format."""
+        output_calls = []
+
+        def fake_check_output(call, **kwargs):
+            output_calls.append(call)
+            return '{"status": "completed"}'
+
+        self.utils.wait_on_action(
+            "action-id", _check_output=fake_check_output)
+        call, = output_calls
+        self.assertIn("--format=json", call)
+
+    def test_request_indefinitely(self):
+        """Juju  with --wait=0, to block until a result is available."""
+        output_calls = []
+
+        def fake_check_output(call, **kwargs):
+            output_calls.append(call)
+            return '{"status": "completed"}'
+
+        self.utils.wait_on_action(
+            "action-id", _check_output=fake_check_output)
+        call, = output_calls
+        self.assertIn("--wait=0", call)
+
+    def test_returns_true_if_completed(self):
+        """JSON output is parsed and returns True if the action completed."""
+        def fake_check_output(call, **kwargs):
+            return '{"status": "completed"}'
+
+        self.assertTrue(self.utils.wait_on_action(
+            "action-id", _check_output=fake_check_output))
+
+    def test_returns_false_if_still_running(self):
+        """
+        JSON output is parsed and returns False if the action is still running.
+        """
+        def fake_check_output(call, **kwargs):
+            return '{"status": "running"}'
+
+        self.assertFalse(self.utils.wait_on_action(
+            "action-id", _check_output=fake_check_output))
+
+    def test_returns_false_if_no_status(self):
+        """
+        JSON output is parsed and returns False if there is no action status.
+        """
+        def fake_check_output(call, **kwargs):
+            return '{"status": "running"}'
+
+        self.assertFalse(self.utils.wait_on_action(
+            "action-id", _check_output=fake_check_output))