Merge lp:~lazypower/charm-helpers/payload-tracking into lp:charm-helpers

[Charles Butler]

Adds the payload tracking commands to charmhelpers.core.hookenv

adds:
 - payload_register
 - payload_unregister
 - payload_status_set

[Matt Bruzek (mbruzek)]

+1 LGTM

review: Approve

=== modified file 'charmhelpers/core/hookenv.py'
--- charmhelpers/core/hookenv.py	2015-11-23 08:58:18 +0000
+++ charmhelpers/core/hookenv.py	2015-12-08 17:50:38 +0000
@@ -878,6 +878,40 @@
     subprocess.check_call(cmd)
 
 
+@translate_exc(from_exc=OSError, to_exc=NotImplementedError)
+def payload_register(ptype, klass, pid):
+    """ is used while a hook is running to let Juju know that a
+        payload has been started."""
+    cmd = ['payload-register']
+    for x in [ptype, klass, pid]:
+        cmd.append(x)
+    subprocess.check_call(cmd)
+
+
+@translate_exc(from_exc=OSError, to_exc=NotImplementedError)
+def payload_unregister(klass, pid):
+    """ is used while a hook is running to let Juju know
+    that a payload has been manually stopped. The <class> and <id> provided
+    must match a payload that has been previously registered with juju using
+    payload-register."""
+    cmd = ['payload-unregister']
+    for x in [klass, pid]:
+        cmd.append(x)
+    subprocess.check_call(cmd)
+
+
+@translate_exc(from_exc=OSError, to_exc=NotImplementedError)
+def payload_status_set(klass, pid, status):
+    """is used to update the current status of a registered payload.
+    The <class> and <id> provided must match a payload that has been previously
+    registered with juju using payload-register. The <status> must be one of the
+    follow: starting, started, stopping, stopped"""
+    cmd = ['payload-status-set']
+    for x in [klass, pid, status]:
+        cmd.append(x)
+    subprocess.check_call(cmd)
+
+
 @cached
 def juju_version():
     """Full version string (eg. '1.23.3.1-trusty-amd64')"""

=== modified file 'tests/core/test_hookenv.py'
--- tests/core/test_hookenv.py	2015-10-26 10:22:43 +0000
+++ tests/core/test_hookenv.py	2015-12-08 17:50:38 +0000
@@ -1171,6 +1171,24 @@
         check_output_.return_value = b'true'
         self.assertTrue(hookenv.is_leader())
 
+    @patch('subprocess.check_call')
+    def test_payload_register(self, check_call_):
+        hookenv.payload_register('monitoring', 'docker', 'abc123')
+        check_call_.assert_called_with(['payload-register', 'monitoring',
+                                        'docker', 'abc123'])
+
+    @patch('subprocess.check_call')
+    def test_payload_unregister(self, check_call_):
+        hookenv.payload_unregister('monitoring', 'abc123')
+        check_call_.assert_called_with(['payload-unregister', 'monitoring',
+                                        'abc123'])
+
+    @patch('subprocess.check_call')
+    def test_payload_status_set(self, check_call_):
+        hookenv.payload_status_set('monitoring', 'abc123', 'Running')
+        check_call_.assert_called_with(['payload-status-set', 'monitoring',
+                                        'abc123', 'Running'])
+
 
 class HooksTest(TestCase):
     def setUp(self):