Merge lp:~free.ekanayaka/landscape-charm/pause-action into lp:~landscape/landscape-charm/trunk

[Free Ekanayaka]

Add a first simplistic implementation of the pause action.

This branch is little more than wiring code, the full semantics of the pause action will be implemented in follow-up branches (for example changing leadership).

In particular:

- add an actions/ dir containing the action pause script

- move hooks/lib and hooks/charmhelpers to the root charm dir, since this
  code is shared between hooks/ and actions/

- add a lib/pause.py file implementing the behavior of the pause action

Add a first simplistic implementation of the pause action.

This branch is little more than wiring code, the full semantics of the pause action will be implemented in follow-up branches (for example changing leadership).

In particular:

- add an actions/ dir containing the action pause script

- move hooks/lib and hooks/charmhelpers to the root charm dir, since this
  code is shared between hooks/ and actions/

- add a lib/pause.py file implementing the behavior of the pause action

To test, bootstrap a Juju environment (e.g. with local provider) and then:

make repo-file-trunk
make deploy # Wait
juju action defined landscape-server # See that the pause action is listed
juju action do landscape-server/0 pause # Services will be stopped on the unit

I'm planning to add integration tests too, but in a separate branch since I'd like to move integration tests to use zope test layers first.

[Данило Шеган (danilo)]

Code looks good, I'll be doing a round of testing now.

[🤖 Landscape Builder (landscape-builder)]

Command: make ci-test
Result: Success
Revno: 260
Branch: lp:~free.ekanayaka/landscape-charm/pause-action
Jenkins: https://ci.lscape.net/job/latch-test/865/

review: Approve (test results)

[Данило Шеган (danilo)]

Works fine (and at least the appserver continues working after one unit is paused with multiple units, and haproxy detects the services as down).

review: Approve

[Alberto Donato (ack)]

Looks good, +1

review: Approve

=== modified file 'Makefile'
--- Makefile	2015-05-06 15:48:29 +0000
+++ Makefile	2015-05-07 10:31:54 +0000
@@ -2,7 +2,7 @@
 PYTHON := /usr/bin/env python
 
 test:
-	@cd hooks && trial lib
+	trial lib
 
 ci-test:
 	./dev/ubuntu-deps

=== added directory 'actions'
=== added file 'actions.yaml'
--- actions.yaml	1970-01-01 00:00:00 +0000
+++ actions.yaml	2015-05-07 10:31:54 +0000
@@ -0,0 +1,4 @@
+pause:
+  description: Pause the Landscape unit. This action will interrupt any
+    Landscape-related processing on the unit and prevent any further processing
+    from happening. It will also transition the unit to the blocked state.

=== added symlink 'actions/charmhelpers'
=== target is u'../charmhelpers/'
=== added symlink 'actions/lib'
=== target is u'../lib/'
=== added file 'actions/pause'
--- actions/pause	1970-01-01 00:00:00 +0000
+++ actions/pause	2015-05-07 10:31:54 +0000
@@ -0,0 +1,9 @@
+#!/usr/bin/python
+import sys
+
+from lib.pause import PauseAction
+
+
+if __name__ == "__main__":
+    action = PauseAction()
+    sys.exit(action())

=== modified file 'charm-helpers.yaml'
--- charm-helpers.yaml	2015-01-30 11:16:09 +0000
+++ charm-helpers.yaml	2015-05-07 10:31:54 +0000
@@ -1,5 +1,5 @@
 branch: lp:charm-helpers
-destination: hooks/charmhelpers
+destination: charmhelpers
 include:
     - __init__
     - core

=== renamed directory 'hooks/charmhelpers' => 'charmhelpers'
=== added symlink 'hooks/charmhelpers'
=== target is u'../charmhelpers/'
=== added symlink 'hooks/lib'
=== target is u'../lib/'
=== renamed directory 'hooks/lib' => 'lib'
=== modified file 'lib/callbacks/scripts.py'
--- hooks/lib/callbacks/scripts.py	2015-04-07 13:56:21 +0000
+++ lib/callbacks/scripts.py	2015-05-07 10:31:54 +0000
@@ -2,7 +2,8 @@
 
 from charmhelpers.core.services.base import ManagerCallback
 
-LSCTL = "/usr/bin/lsctl"
+from lib.paths import LSCTL
+
 SCHEMA = "/usr/bin/landscape-schema"
 
 

=== modified file 'lib/paths.py'
--- hooks/lib/paths.py	2015-05-05 12:40:55 +0000
+++ lib/paths.py	2015-05-07 10:31:54 +0000
@@ -7,6 +7,7 @@
 CONFIG_DIR = "/opt/canonical/landscape/configs/standalone"
 OFFLINE_DIR = "/opt/canonical/landscape/canonical/landscape/offline"
 LICENSE_FILE = "/etc/landscape/license.txt"
+LSCTL = "/usr/bin/lsctl"
 
 
 class Paths(object):

=== added file 'lib/pause.py'
--- lib/pause.py	1970-01-01 00:00:00 +0000
+++ lib/pause.py	2015-05-07 10:31:54 +0000
@@ -0,0 +1,18 @@
+import subprocess
+
+from charmhelpers.core import hookenv
+
+from lib.hook import Hook
+from lib.paths import LSCTL
+
+
+class PauseAction(Hook):
+    """Execute pause action logic."""
+
+    def __init__(self, hookenv=hookenv, subprocess=subprocess):
+        super(PauseAction, self).__init__(hookenv=hookenv)
+        self._subprocess = subprocess
+
+    def _run(self):
+        self._subprocess.check_call((LSCTL, "stop"))
+        self._subprocess.check_call(("service", "cron", "stop"))

=== modified file 'lib/tests/helpers.py'
--- hooks/lib/tests/helpers.py	2015-04-07 11:05:57 +0000
+++ lib/tests/helpers.py	2015-05-07 10:31:54 +0000
@@ -53,8 +53,7 @@
 
     def setUp(self):
         super(TestWithFixtures, self).setUp()
-        charm_dir = os.path.dirname(
-            os.path.dirname(os.path.dirname(os.path.dirname(__file__))))
+        charm_dir = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
         templates_dir = os.path.join(charm_dir, "templates")
         loader = Environment(loader=FileSystemLoader(templates_dir))
         self.template = loader.get_template(self.template_filename)

=== added file 'lib/tests/test_pause.py'
--- lib/tests/test_pause.py	1970-01-01 00:00:00 +0000
+++ lib/tests/test_pause.py	2015-05-07 10:31:54 +0000
@@ -0,0 +1,22 @@
+from lib.tests.helpers import HookenvTest
+from lib.tests.stubs import SubprocessStub
+from lib.pause import PauseAction
+
+
+class PauseActionTest(HookenvTest):
+
+    def setUp(self):
+        super(PauseActionTest, self).setUp()
+        self.subprocess = SubprocessStub()
+        self.action = PauseAction(
+            hookenv=self.hookenv, subprocess=self.subprocess)
+
+    def test_run(self):
+        """
+        The PauseAction stops the Landscape services.
+        """
+        self.action()
+        self.assertEqual(
+            [(("/usr/bin/lsctl", "stop"), {}),
+             (("service", "cron", "stop"), {})],
+            self.subprocess.calls)