Model name can now be accessed through model.name

This resovles #693

Author: jack-w-shaw

juju/errors.py

@@ -63,6 +63,10 @@ def __init__(self, entity_name, entity_types=None):
         super().__init__("Entity not found: {}".format(entity_name))
 
 
+class JujuModelError(JujuError):
+    pass
+
+
 class JujuMachineError(JujuError):
     pass
 

juju/model.py

@@ -30,7 +30,7 @@
 from .controller import Controller, ConnectedController
 from .delta import get_entity_class, get_entity_delta
 from .errors import JujuAPIError, JujuError, JujuModelConfigError, JujuBackupError
-from .errors import JujuAppError, JujuUnitError, JujuAgentError, JujuMachineError, PylibjujuError
+from .errors import JujuModelError, JujuAppError, JujuUnitError, JujuAgentError, JujuMachineError, PylibjujuError
 from .exceptions import DeadEntityException
 from .names import is_valid_application
 from .offerendpoints import ParseError as OfferParseError
@@ -982,6 +982,15 @@ def charmhub(self):
     def charmstore(self):
         return self._charmstore
 
+    @property
+    def name(self):
+        """Return the name of this model
+
+        """
+        if self._info is None:
+            raise JujuModelError("Model is not connected")
+        return self._info.name
+
     @property
     def info(self):
         """Return the cached client.ModelInfo object for this Model.
@@ -2270,7 +2279,7 @@ async def list_offers(self):
         shared and who is connected.
         """
         async with ConnectedController(self.connection()) as controller:
-            return await controller.list_offers(self.info.name)
+            return await controller.list_offers(self.name)
 
     async def remove_offer(self, endpoint, force=False):
         """

tests/integration/test_controller.py

@@ -130,7 +130,7 @@ async def test_list_models(event_loop):
     async with base.CleanController() as controller:
         async with base.CleanModel() as model:
             result = await controller.list_models()
-            assert model.info.name in result
+            assert model.name in result
 
 
 @base.bootstrapped
@@ -164,9 +164,9 @@ async def test_get_model(event_loop):
         try:
             by_name = await controller.get_model(model_name)
             by_uuid = await controller.get_model(model_uuid)
-            assert by_name.info.name == model_name
+            assert by_name.name == model_name
             assert by_name.info.uuid == model_uuid
-            assert by_uuid.info.name == model_name
+            assert by_uuid.name == model_name
             assert by_uuid.info.uuid == model_uuid
         finally:
             if by_name:

tests/integration/test_crossmodel.py

@@ -25,7 +25,7 @@ async def test_offer(event_loop):
         await model.block_until(
             lambda: all(offer.application_name == 'ubuntu'
                         for offer in offers.results))
-        await model.remove_offer("admin/{}.ubuntu".format(model.info.name), force=True)
+        await model.remove_offer("admin/{}.ubuntu".format(model.name), force=True)
 
 
 @base.bootstrapped
@@ -49,13 +49,13 @@ async def test_consume(event_loop):
 
         # farm off a new model to test the consumption
         async with base.CleanModel() as model_2:
-            await model_2.consume("admin/{}.ubuntu".format(model_1.info.name))
+            await model_2.consume("admin/{}.ubuntu".format(model_1.name))
 
             status = await model_2.get_status()
             if 'ubuntu' not in status.remote_applications:
                 raise Exception("Expected ubuntu in saas")
 
-        await model_1.remove_offer("admin/{}.ubuntu".format(model_1.info.name), force=True)
+        await model_1.remove_offer("admin/{}.ubuntu".format(model_1.name), force=True)
 
 
 @base.bootstrapped
@@ -79,7 +79,7 @@ async def test_remove_saas(event_loop):
 
         # farm off a new model to test the consumption
         async with base.CleanModel() as model_2:
-            await model_2.consume("admin/{}.ubuntu".format(model_1.info.name))
+            await model_2.consume("admin/{}.ubuntu".format(model_1.name))
 
             await model_2.remove_saas('ubuntu')
             await jasyncio.sleep(5)
@@ -88,7 +88,7 @@ async def test_remove_saas(event_loop):
             if 'ubuntu' in status.remote_applications:
                 raise Exception("Expected ubuntu not to be in saas")
 
-        await model_1.remove_offer("admin/{}.ubuntu".format(model_1.info.name), force=True)
+        await model_1.remove_offer("admin/{}.ubuntu".format(model_1.name), force=True)
 
 
 @base.bootstrapped
@@ -123,7 +123,7 @@ async def test_relate_with_offer(event_loop):
                 lambda: all(unit.agent_status == 'idle'
                             for unit in application.units))
 
-            await model_2.relate("mediawiki:db", "admin/{}.mysql".format(model_1.info.name))
+            await model_2.relate("mediawiki:db", "admin/{}.mysql".format(model_1.name))
             status = await model_2.get_status()
             if 'mysql' not in status.remote_applications:
                 raise Exception("Expected mysql in saas")
@@ -135,7 +135,7 @@ async def test_relate_with_offer(event_loop):
             if 'mysql' in status.remote_applications:
                 raise Exception("Expected mysql not to be in saas")
 
-        await model_1.remove_offer("admin/{}.mysql".format(model_1.info.name), force=True)
+        await model_1.remove_offer("admin/{}.mysql".format(model_1.name), force=True)
 
 
 @base.bootstrapped
@@ -160,7 +160,7 @@ async def test_add_bundle(event_loop):
             try:
                 tmp_path = str(Path(dirpath) / 'bundle.yaml')
                 with open(tmp_path, "w") as file:
-                    file.write(file_contents.format(model_1.info.name))
+                    file.write(file_contents.format(model_1.name))
             except IOError:
                 raise
 
@@ -186,4 +186,4 @@ async def test_add_bundle(event_loop):
                 await model_2.deploy('local:{}'.format(tmp_path))
                 await model_2.wait_for_idle(status="active")
 
-            await model_1.remove_offer("admin/{}.influxdb".format(model_1.info.name), force=True)
+            await model_1.remove_offer("admin/{}.influxdb".format(model_1.name), force=True)

tests/integration/test_model.py

@@ -14,7 +14,7 @@
 import pytest
 from juju import jasyncio
 from juju.client import client
-from juju.errors import JujuError, JujuUnitError, JujuConnectionError
+from juju.errors import JujuError, JujuModelError, JujuUnitError, JujuConnectionError
 from juju.model import Model, ModelObserver
 from juju.utils import block_until, run_with_interrupt, wait_for_bundle
 
@@ -28,6 +28,19 @@
 OVERLAYS_DIR = HERE_DIR / 'bundle' / 'test-overlays'
 
 
+@base.bootstrapped
+@pytest.mark.asyncio
+async def test_model_name(event_loop):
+    model = Model()
+    with pytest.raises(JujuModelError):
+        model.name
+
+    async with base.CleanModel() as new_model:
+        await model.connect(new_model.name)
+        assert model.name == new_model.name
+        await model.disconnect()
+
+
 @base.bootstrapped
 @pytest.mark.asyncio
 async def test_deploy_local_bundle_dir(event_loop):
@@ -591,7 +604,7 @@ async def _deploy_in_loop(new_loop, model_name, jujudata):
 @pytest.mark.asyncio
 async def test_explicit_loop_threaded(event_loop):
     async with base.CleanModel() as model:
-        model_name = model.info.name
+        model_name = model.name
         new_loop = jasyncio.new_event_loop()
         with ThreadPoolExecutor(1) as executor:
             f = executor.submit(