Merge lp:~free.ekanayaka/landscape-client-charm/workload-status into lp:landscape-client-charm

[Free Ekanayaka]

This branch adds support for workload status in the client charm. The possible
situations are:

1. No account-name is set. Since this is a required user input, the unit
   transitions to "blocked"

2. The juju-info file or computer-title entry are not yet there. Since
   these should eventually get written automatically by the charm, the
   unit transitions to the "maintenance" state.

3. The registration is successful, the unit transitions to the "active"
   state.

There are some situations (e.g. missing registration key) that could
have better messages, but that would require a bit more work. I think
what's in this branch is safe and good enough for a start.

See the "Unit states" section here:

https://docs.google.com/document/d/1SsHDxi58xgrim6VTKorqMn4GlzxPV9EFvu1ueBgnMlc/edit#heading=h.lir57ztwm9ax

to know more about the semantics of each state.

Note that if you are using juju < 1.24 the status_set function in
charmhelpers will gracefully downgrade to a bare logging of
the message.

[Alberto Donato (ack)]

Looks good, +1

review: Approve

[Adam Collard (adam-collard)]

+1

review: Approve

[lp:~free.ekanayaka/landscape-client-charm/workload-status]

58. By Free Ekanayaka on 2015-07-15

Mention registration-key

=== modified file 'hooks/common.py'
--- hooks/common.py	2014-09-24 07:35:03 +0000
+++ hooks/common.py	2015-07-15 10:44:07 +0000
@@ -6,7 +6,7 @@
 from subprocess import check_output
 
 from charmhelpers.core.hookenv import (
-    log, local_unit)
+    log, local_unit, status_set)
 
 from landscape.configuration import (
     setup, register, LandscapeSetupConfiguration, ConfigurationError,
@@ -68,6 +68,7 @@
 
     def __init__(self):
         self.config = Configuration()
+        self.status_set = status_set  # For testing
 
     @property
     def local_unit(self):
@@ -108,10 +109,17 @@
             return 0
 
         if is_configured_enough:
-            return self.try_to_register()
+            exit_code = self.try_to_register()
+            if exit_code == 0:
+                self.status_set("active", "System successfully registered")
         else:
-            print ("Need account-name, computer-title and juju-info to"
-                   " proceed, skipping")
+            if not self.config.get("account_name"):
+                self.status_set(
+                    "blocked", "Need account-name/registration-key to proceed")
+            else:
+                self.status_set(
+                    "maintenance",
+                    "Need computer-title and juju-info to proceed")
             return 0
 
     @property

=== modified file 'hooks/test_hooks.py'
--- hooks/test_hooks.py	2014-09-25 07:00:05 +0000
+++ hooks/test_hooks.py	2015-07-15 10:44:07 +0000
@@ -64,6 +64,14 @@
         self.landscape_broker.config.config = os.path.join(
             data_path, "landscape.conf")
         self.landscape_broker.config.write()
+        self.workload_state = None
+        self.workload_message = None
+
+        def status_set(workload_state, message):
+            self.workload_state = workload_state
+            self.workload_message = message
+
+        self.landscape_broker.status_set = status_set
         self.juju_broker = FakeJujuBroker()
 
     def touch_juju_info_file(self):
@@ -389,7 +397,6 @@
         super(ConfigChangedTest, self).setUp()
         self.landscape_broker.config.account_name = "account1"
         self.landscape_broker.config.computer_title = "title"
-        self.touch_juju_info_file()
         self.addCleanup(setattr, hooks, "CERT_FILE", hooks.CERT_FILE)
         tmp_dir = self.mkdtemp()
         hooks.CERT_FILE = "%s/cert" % tmp_dir
@@ -398,6 +405,7 @@
         """
         A base64 encoded SSL cert in the configuration is decoded.
         """
+        self.touch_juju_info_file()
         self.juju_broker.commands["config-get"] = {
             "ssl-public-key": "base64:%s" % "foo".encode("base64"),
             "account-name": "standalone",
@@ -409,6 +417,43 @@
             hooks.CERT_FILE, self.landscape_broker.config.ssl_public_key)
         with open(hooks.CERT_FILE) as fh:
             self.assertEqual("foo", fh.read())
+        self.assertEqual("active", self.workload_state)
+        self.assertEqual(
+            "System successfully registered", self.workload_message)
+
+    def test_no_account_name(self):
+        """
+        If account-name is not set, the unit transitions to the blocked state.
+        """
+        self.touch_juju_info_file()
+        self.juju_broker.commands["config-get"] = {
+            "ssl-public-key": "base64:%s" % "foo".encode("base64"),
+            "account-name": "",
+            "ping-url": "http://127.0.0.1"}
+
+        hooks.config_changed(juju_broker=self.juju_broker,
+                             landscape_broker=self.landscape_broker)
+        self.assertEqual("blocked", self.workload_state)
+        self.assertEqual(
+            "Need account-name/registration-key to proceed",
+            self.workload_message)
+
+    def test_no_juju_info(self):
+        """
+        If the juju-info file hasn't been written yet, the unit transitions to
+        the maintenance status.
+        """
+        self.juju_broker.commands["config-get"] = {
+            "ssl-public-key": "base64:%s" % "foo".encode("base64"),
+            "account-name": "standalone",
+            "ping-url": "http://127.0.0.1"}
+
+        hooks.config_changed(juju_broker=self.juju_broker,
+                             landscape_broker=self.landscape_broker)
+        self.assertEqual("maintenance", self.workload_state)
+        self.assertEqual(
+            "Need computer-title and juju-info to proceed",
+            self.workload_message)
 
 
 class RegistrationRelationJoinedTest(HookTestCase):