Merge pull request #710 from cderici/fix-facade-issues-2

#710

#### Description

This is PR complements #706, and tries to address the issues being discussed in #707, by updating the `old_client`s with `2.9.34` schema and fixing the `unit.run()` function to be asynchronous, as it's (breakingly) changed to be in the `Juju 3.0`. This also brings `unit.run` and `unit.run_action` functions very close, the only difference is that the former is using `Action.Run` while the latter is using `Action.Enqueue` functions. It's plausible that one of these ways of doing the similar thing will disappear in the future since the newer versions of `Action.Run` is asynchronous anyway.

Should fix the #707.

#### QA Steps

I updated the integration tests for `run()`, so basically all the tests in the following suite (that includes `test_run` and `test_run_action`) should pass:

```python
tox -e integration -- tests/integration/test_unit.py
``` 

Additionally I added the example that I have been using myself to test this into the examples folder, so it should be running fine:

```
 $ python examples/run_action.py
```

Both the integration tests (`test_run` & `test_run_action`) and the example module are tested in the following controllers:

```
Controller Model User Access Cloud/Region Models Nodes HA Version
caner-k8s test admin superuser microk8s/localhost 2 - - 2.9.33 
caner-k8s-2929 testhede admin superuser microk8s/localhost 2 - - 2.9.29 
caner-k8s-2931 testhaylaz admin superuser microk8s/localhost 2 - - 2.9.31 
caner-k8s-2934* haylazlar admin superuser microk8s/localhost 2 - - 2.9.34 
caner-lxd-2.9 default admin superuser localhost/localhost 3 2 none 2.9.34.1 
caner-lxd-2929 default admin superuser localhost/localhost 2 1 none 2.9.29 
caner-lxd-2931 default admin superuser localhost/localhost 2 1 none 2.9.31 
caner-lxd-2932 default admin superuser localhost/localhost 2 1 none 2.9.32 
caner-lxd-3.0 canhiras admin superuser localhost/localhost 1 1 none 3.0-rc1.1 
k8s-30 test4 admin superuser microk8s/localhost 2 - - 3.0-rc1 
```

Note that, all the clients that I used `<2.9.34` are using the `ActionFacade v6`, and the ones `>=2.9.34` are using the `ActionFacade v7` (regardless of `2.9` vs` 3.0`).

#### Notes & Discussion

One of the requests was to keep the `unit.run()` function synchronous for any client using `<ActionFacade v6`. While this is a valid request from the user perspective, it also means that we would have the same function returning different types (either a dictionary or an action object) depending on the facade being used, which would make it way harder to maintain. That's why I kept the change for all the versions.

Author: jujubot

examples/run_action.py

@@ -0,0 +1,39 @@
+
+from juju import jasyncio
+from juju.model import Model
+
+# logging.basicConfig(level='DEBUG')
+
+# Get a k8s controller
+# e.g. juju bootstrap microk8s test-k8s
+
+# Add a model
+# e.g. juju add-model test-actions
+
+# Then run this module
+# e.g. python examples/run_action.py
+
+
+async def _get_password():
+    model = Model()
+    await model.connect()
+    await model.deploy('zinc-k8s')
+    await model.wait_for_idle(status="active")
+
+    unit = model.applications['zinc-k8s'].units[0]
+    action1 = await unit.run_action("get-admin-password")
+    assert action1.status == 'pending'
+
+    action2 = await action1.wait()
+    assert action2.status == 'completed'
+
+    print(action2.results["admin-password"])
+
+    # They are the same object
+    assert action1 is action2
+
+    await model.disconnect()
+
+
+if __name__ == "__main__":
+    jasyncio.run(_get_password())

juju/action.py

@@ -11,6 +11,9 @@ def __init__(self, entity_id, model, history_index=-1, connected=True):
     def status(self):
         return self.data['status']
 
-    async def wait(self):
+    async def fetch_output(self):
         self.results = await self.model.get_action_output(self.id)
+
+    async def wait(self):
+        self.results or await self.fetch_output()
         return self

juju/client/connection.py

@@ -17,7 +17,7 @@
 log = logging.getLogger('juju.client.connection')
 
 client_facades = {
-    'Action': {'versions': [2, 7]},
+    'Action': {'versions': [2, 6, 7]},
     'ActionPruner': {'versions': [1]},
     'Agent': {'versions': [2, 3]},
     'AgentTools': {'versions': [1]},

juju/client/old_clients/_client.py

@@ -4,7 +4,7 @@
 from juju.client.old_clients._definitions import *
 
 
-from juju.client.old_clients import _client2, _client1, _client3, _client4, _client5, _client8, _client7, _client9, _client10, _client6, _client12, _client11, _client13, _client15, _client16, _client17, _client18
+from juju.client.old_clients import _client2, _client1, _client3, _client4, _client5, _client8, _client7, _client9, _client10, _client6, _client12, _client11, _client13, _client15, _client16, _client17, _client18, _client14
 
 
 CLIENTS = {
@@ -24,11 +24,11 @@
     "15": _client15,
     "16": _client16,
     "17": _client17,
-    "18": _client18
+    "18": _client18,
+    "14": _client14
 }
 
 
-
 def lookup_facade(name, version):
     """
     Given a facade name and version, attempt to pull that facade out
@@ -46,7 +46,6 @@ def lookup_facade(name, version):
                           "{}".format(name))
 
 
-
 class TypeFactory:
     @classmethod
     def from_connection(cls, connection):
@@ -260,6 +259,10 @@ class EntityWatcherFacade(TypeFactory):
     pass
 
 
+class EnvironUpgraderFacade(TypeFactory):
+    pass
+
+
 class ExternalControllerUpdaterFacade(TypeFactory):
     pass
 

juju/client/old_clients/_client1.py

@@ -3610,6 +3610,18 @@ class CAASUnitProvisionerFacade(Type):
                                                      'error': {'$ref': '#/definitions/Error'}},
                                       'required': ['config'],
                                       'type': 'object'},
+                     'DockerImageInfo': {'additionalProperties': False,
+                                         'properties': {'auth': {'type': 'string'},
+                                                        'email': {'type': 'string'},
+                                                        'identitytoken': {'type': 'string'},
+                                                        'image-name': {'type': 'string'},
+                                                        'password': {'type': 'string'},
+                                                        'registrytoken': {'type': 'string'},
+                                                        'repository': {'type': 'string'},
+                                                        'serveraddress': {'type': 'string'},
+                                                        'username': {'type': 'string'}},
+                                         'required': ['image-name'],
+                                         'type': 'object'},
                      'Entities': {'additionalProperties': False,
                                   'properties': {'entities': {'items': {'$ref': '#/definitions/Entity'},
                                                               'type': 'array'}},
@@ -3736,7 +3748,7 @@ class CAASUnitProvisionerFacade(Type):
                                                                                'type': 'array'},
                                                                    'filesystems': {'items': {'$ref': '#/definitions/KubernetesFilesystemParams'},
                                                                                    'type': 'array'},
-                                                                   'operator-image-path': {'type': 'string'},
+                                                                   'image-repo': {'$ref': '#/definitions/DockerImageInfo'},
                                                                    'pod-spec': {'type': 'string'},
                                                                    'raw-k8s-spec': {'type': 'string'},
                                                                    'tags': {'patternProperties': {'.*': {'type': 'string'}},
@@ -6999,7 +7011,8 @@ class CrossModelRelationsFacade(Type):
                                                                   'unit-count': {'type': 'integer'}},
                                                    'required': ['relation-token',
                                                                 'application-token',
-                                                                'life'],
+                                                                'life',
+                                                                'unit-count'],
                                                    'type': 'object'},
                      'RemoteRelationDetails': {'additionalProperties': False,
                                                'properties': {'bakery-version': {'type': 'integer'},
@@ -11858,13 +11871,15 @@ class RemoteRelationsFacade(Type):
                                                        'remote-application-name': {'type': 'string'},
                                                        'remote-endpoint-name': {'type': 'string'},
                                                        'source-model-uuid': {'type': 'string'},
-                                                       'suspended': {'type': 'boolean'}},
+                                                       'suspended': {'type': 'boolean'},
+                                                       'unit-count': {'type': 'integer'}},
                                         'required': ['life',
                                                      'suspended',
                                                      'id',
                                                      'key',
                                                      'application-name',
                                                      'endpoint',
+                                                     'unit-count',
                                                      'remote-application-name',
                                                      'remote-endpoint-name',
                                                      'source-model-uuid'],
@@ -11889,7 +11904,8 @@ class RemoteRelationsFacade(Type):
                                                                   'unit-count': {'type': 'integer'}},
                                                    'required': ['relation-token',
                                                                 'application-token',
-                                                                'life'],
+                                                                'life',
+                                                                'unit-count'],
                                                    'type': 'object'},
                      'RemoteRelationResult': {'additionalProperties': False,
                                               'properties': {'error': {'$ref': '#/definitions/Error'},