Merge lp:~abentley/juju-ci-tools/client-for-existing into lp:juju-ci-tools

[Aaron Bentley]

Add client_for_existing.

This branch provides client_for_existing.

This can be used to instantiate a ModelClient for a specific JUJU_DATA directory. It autodetects the existing model and controller names. In this version, they cannot be overridden, but the usual clone methods can be used to change model_name.

[Curtis Hovey (sinzui)]

Thank you thank you, thank you. I think the migration and user tests might use this.

review: Approve (code)

=== modified file 'jujupy/__init__.py'
--- jujupy/__init__.py	2017-02-22 16:40:34 +0000
+++ jujupy/__init__.py	2017-02-23 19:09:25 +0000
@@ -40,6 +40,7 @@
     )
 from jujupy.version_client import (
     client_from_config,
+    client_for_existing,
     EnvJujuClient1X,
     EnvJujuClient25,
     get_client_class,
@@ -50,6 +51,7 @@
     'AgentsNotStarted',
     'AuthNotAccepted',
     'client_from_config',
+    'client_for_existing',
     'ConditionList',
     'EnvJujuClient1X',
     'EnvJujuClient25',

=== modified file 'jujupy/client.py'
--- jujupy/client.py	2017-02-22 22:04:51 +0000
+++ jujupy/client.py	2017-02-23 19:09:25 +0000
@@ -1232,6 +1232,14 @@
                 raise e
         return sub_output
 
+    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')
+        controller_name, user_model = current.split(':', 1)
+        user_name, model_name = user_model.split('/', 1)
+        return controller_name, user_name, model_name.rstrip('\n')
+
     def pause(self, seconds):
         pause(seconds)
 

=== modified file 'jujupy/fake.py'
--- jujupy/fake.py	2017-02-22 19:05:46 +0000
+++ jujupy/fake.py	2017-02-23 19:09:25 +0000
@@ -59,6 +59,7 @@
             }
         }
         self.shares = ['admin']
+        self.active_model = None
 
     def add_model(self, name):
         state = FakeEnvironmentState(self)
@@ -640,6 +641,10 @@
             if self._past_deadline and not self._ignore_soft_deadline:
                 raise SoftDeadlineExceeded()
 
+    def get_active_model(self, juju_home):
+        return (self.controller_state.name, None,
+                self.controller_state.active_model)
+
     def deploy(self, model_state, charm_name, num, service_name=None,
                series=None):
         if service_name is None:

=== modified file 'jujupy/tests/test_client.py'
--- jujupy/tests/test_client.py	2017-02-22 22:04:51 +0000
+++ jujupy/tests/test_client.py	2017-02-23 19:09:25 +0000
@@ -295,6 +295,16 @@
                                              'Operation exceeded deadline.'):
                     backend.get_juju_output('cmd', ('args',), [], 'home')
 
+    def test_get_active_model(self):
+        backend = Juju2Backend('/bin/path', '2.0', set(), debug=False,
+                               soft_deadline=None)
+        with patch('subprocess.Popen') as mock_popen:
+            mock_popen.return_value.communicate.return_value = (
+                'ctrl1:user1/model1\n', '')
+            mock_popen.return_value.returncode = 0
+            result = backend.get_active_model('/foo/bar')
+        self.assertEqual(('ctrl1', 'user1', 'model1'), result)
+
 
 class TestBaseCondition(ClientTest):
 

=== modified file 'jujupy/tests/test_version_client.py'
--- jujupy/tests/test_version_client.py	2017-02-22 18:02:19 +0000
+++ jujupy/tests/test_version_client.py	2017-02-23 19:09:25 +0000
@@ -42,15 +42,19 @@
     )
 from jujupy.configuration import get_jenv_path
 from jujupy.fake import (
+    FakeBackend,
+    FakeControllerState,
     FakeBackend2_1,
     )
 from jujupy.version_client import (
     BootstrapMismatch,
+    client_for_existing,
     client_from_config,
     EnvJujuClient1X,
     EnvJujuClient22,
     EnvJujuClient24,
     EnvJujuClient25,
+    get_client_class,
     ModelClientRC,
     IncompatibleConfigClass,
     Juju1XBackend,
@@ -214,6 +218,26 @@
         self.assertEqual(client._backend.soft_deadline, deadline)
 
 
+class TestClientForExisting(ClientTest):
+
+    def test_client_for_existing(self):
+        state = FakeControllerState()
+        state.name = 'ctrl1'
+        state.active_model = 'model1'
+        backend = FakeBackend(state, version='2.0.73', full_path='/path/juju')
+        with patch.object(ModelClient, 'get_version',
+                          return_value=backend.version) as gv_mock:
+            client_class = get_client_class(backend.version)
+            with patch.object(client_class, 'default_backend',
+                              return_value=backend) as db_mock:
+                client = client_for_existing(backend.full_path, '/juju-data')
+        self.assertEqual(client.model_name, 'model1')
+        self.assertEqual(client.env.controller.name, 'ctrl1')
+        gv_mock.assert_called_once_with(backend.full_path)
+        db_mock.assert_called_once_with(backend.full_path, backend.version,
+                                        set(), debug=False, soft_deadline=None)
+
+
 class TestModelClient2_1(ClientTest):
 
     client_version = '2.1.0'

=== modified file 'jujupy/version_client.py'
--- jujupy/version_client.py	2017-02-22 19:49:58 +0000
+++ jujupy/version_client.py	2017-02-23 19:09:25 +0000
@@ -701,6 +701,18 @@
     return client_class
 
 
+def get_full_path(juju_path):
+    """Helper to ensure a full path is used.
+
+    If juju_path is None, ModelClient.get_full_path is used.  Otherwise,
+    the supplied path is converted to absolute.
+    """
+    if juju_path is None:
+        return ModelClient.get_full_path()
+    else:
+        return os.path.abspath(juju_path)
+
+
 def client_from_config(config, juju_path, debug=False, soft_deadline=None):
     """Create a client from an environment's configuration.
 
@@ -717,9 +729,33 @@
         env = client_class.config_class('', {})
     else:
         env = client_class.config_class.from_config(config)
-    if juju_path is None:
-        full_path = ModelClient.get_full_path()
-    else:
-        full_path = os.path.abspath(juju_path)
+    full_path = get_full_path(juju_path)
     return client_class(env, version, full_path, debug=debug,
                         soft_deadline=soft_deadline)
+
+
+def client_for_existing(juju_path, juju_data_dir, debug=False,
+                        soft_deadline=None):
+    """Create a client for an existing controller/model.
+
+    :param juju_path: Path to juju binary the client should wrap.
+    :param juju_data_dir: Path to the juju data directory referring the the
+        controller and model.
+    :param debug=False: The debug flag for the client, False by default.
+    :param soft_deadline: A datetime representing the deadline by which
+        normal operations should complete.  If None, no deadline is
+        enforced.
+    """
+    version = ModelClient.get_version(juju_path)
+    client_class = get_client_class(str(version))
+    full_path = get_full_path(juju_path)
+    backend = client_class.default_backend(full_path, version, set(),
+                                           debug=debug,
+                                           soft_deadline=soft_deadline)
+    controller_name, user_name, model_name = backend.get_active_model(
+        juju_data_dir)
+    config = client_class.config_class(
+        model_name, controller=Controller(controller_name),
+        juju_home=juju_data_dir)
+    return client_class(config, version, full_path, debug=debug,
+                        soft_deadline=soft_deadline, _backend=backend)