Merge lp:~abentley/juju-ci-tools/wait-for-py into lp:juju-ci-tools

[Aaron Bentley]

Add wait_for.py

This branch provides ModelClient.wait_for as a script.

This is mainly useful as a way to monitor interative tests.

Right now, it supports WaitAgentsStarted, which is roughly equivalent to ModelCient.wait_for_started.

It should be trivial to add additional conditions, though ConditionList would be awkward to specify at the commandline.

It also improves error handling when there's no active model, and fixes some lint.

[lp:~abentley/juju-ci-tools/wait-for-py]

1986. By Aaron Bentley on 2017-04-07

Fix python3 compatibility.

[Curtis Hovey (sinzui)]

Thank you.

review: Approve (code)

=== modified file 'jujupy/client.py'
--- jujupy/client.py	2017-04-07 20:20:17 +0000
+++ jujupy/client.py	2017-04-07 20:33:23 +0000
@@ -138,6 +138,10 @@
     """Raised when the provided auth was not accepted."""
 
 
+class NoActiveModel(Exception):
+    """Raised when no active model could be found."""
+
+
 def get_timeout_prefix(duration, timeout_path=None):
     """Return extra arguments to run a command with a timeout."""
     if timeout_path is None:
@@ -1286,8 +1290,14 @@
 
     def get_active_model(self, juju_data_dir):
         """Determine the active model in a juju data dir."""
-        current = self.get_juju_output(
-            'switch', (), set(), juju_data_dir, model=None).decode('ascii')
+        try:
+            current = self.get_juju_output(
+                'switch', (), set(), juju_data_dir, model=None).decode('ascii')
+        except subprocess.CalledProcessError as e:
+            if b'no currently specified model' not in e.stderr:
+                raise
+            raise NoActiveModel(
+                'No active model for {}'.format(juju_data_dir))
         controller_name, user_model = current.split(':', 1)
         user_name, model_name = user_model.split('/', 1)
         return controller_name, user_name, model_name.rstrip('\n')
@@ -1452,6 +1462,7 @@
 
 
 class WaitAgentsStarted(BaseCondition):
+    """Wait until all agents are idle or started."""
 
     def __init__(self, timeout=1200):
         super(WaitAgentsStarted, self).__init__(timeout)

=== modified file 'jujupy/tests/test_client.py'
--- jujupy/tests/test_client.py	2017-04-07 20:20:17 +0000
+++ jujupy/tests/test_client.py	2017-04-07 20:33:23 +0000
@@ -70,6 +70,7 @@
     make_safe_config,
     ModelClient,
     NameNotAccepted,
+    NoActiveModel,
     NoopCondition,
     NoProvider,
     parse_new_state_server_from_error,
@@ -321,6 +322,14 @@
             result = backend.get_active_model('/foo/bar')
         self.assertEqual(('ctrl1', 'user1', 'model1'), result)
 
+    def test_get_active_model_none(self):
+        backend = Juju2Backend('/bin/path', '2.0', set(), debug=False,
+                               soft_deadline=None)
+        with patch('subprocess.Popen', autospec=True, return_value=FakePopen(
+                   '', 'ERROR no currently specified model', 1)):
+            with self.assertRaises(NoActiveModel):
+                backend.get_active_model('/foo/bar')
+
 
 def backend_call(client, cmd, args, model=None, check=True, timeout=None,
                  extra_env=None):

=== modified file 'tests/test_deploy_stack.py'
--- tests/test_deploy_stack.py	2017-04-05 23:07:51 +0000
+++ tests/test_deploy_stack.py	2017-04-07 20:33:23 +0000
@@ -71,7 +71,6 @@
     )
 
 from jujupy.client import (
-    NoopCondition,
     CommandTime,
 )
 from jujupy.configuration import (

=== added file 'wait_for.py'
--- wait_for.py	1970-01-01 00:00:00 +0000
+++ wait_for.py	2017-04-07 20:33:23 +0000
@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+from __future__ import print_function
+
+
+from argparse import ArgumentParser
+import sys
+
+from jujupy import (
+    client_for_existing,
+    get_juju_data,
+    )
+from jujupy.client import (
+    NoActiveModel,
+    WaitAgentsStarted,
+    )
+
+
+def main():
+    parser = ArgumentParser()
+    subparsers = parser.add_subparsers(dest='cmd')
+    started_parser = subparsers.add_parser(
+        'agents-started', description=WaitAgentsStarted.__doc__,
+        )
+    started_parser.set_defaults(factory=WaitAgentsStarted)
+    started_parser.add_argument('--timeout', type=int)
+    args = parser.parse_args()
+    try:
+        client = client_for_existing(None, get_juju_data())
+    except NoActiveModel as e:
+        print(e, file=sys.stderr)
+        sys.exit(1)
+    kwargs = dict((k, v) for k, v in vars(args).items()
+                  if k not in ('factory', 'cmd'))
+    client.wait_for(args.factory(**kwargs))
+
+
+if __name__ == '__main__':
+    main()