Merge pull request #1035 from Aflynn50/bugfix-NoneType

#1035

#### Description

*<Please add why this change is needed and what it does.>*
Fix for #1028 
The logger is not passed to calls of `utils.run_with_interupt` from model.py and controller.py. The default value is `None`, so when it is later used we get the error. 
*<Fixes: >*


#### QA Steps
Added a `raise Exception("my random exception")` to the `Next` method of `ModelSummeryWatcherFacade`. This is hit by the `run_with_interupt` in controller and we can observe that when we run the file `modelsummaries.py`, if the log arguments added in this PR are not there then we get the None Type error and if they are there, we do not.

Jira: JUJU-5610

Author: jujubot

.gitignore

@@ -15,3 +15,4 @@ pytestdebug.log
 .vscode/
 deb_dist
 *.tar.gz
+.idea/

juju/controller.py

@@ -828,7 +828,8 @@ async def _watcher(stop_event):
                     try:
                         results = await utils.run_with_interrupt(
                             watcher.Next(),
-                            stop_event)
+                            stop_event,
+                            log=log)
                     except JujuAPIError as e:
                         if 'watcher was stopped' not in str(e):
                             raise

juju/model.py

@@ -1115,7 +1115,8 @@ async def _all_watcher():
                     try:
                         results = await utils.run_with_interrupt(
                             allwatcher.Next(),
-                            self._watch_stopping)
+                            self._watch_stopping,
+                            log=log)
                     except JujuAPIError as e:
                         if 'watcher was stopped' not in str(e):
                             raise

tests/integration/test_application.py

@@ -19,7 +19,7 @@
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_action(event_loop):
+async def test_action():
     async with base.CleanModel() as model:
         ubuntu_app = await model.deploy(
             'percona-cluster',
@@ -57,7 +57,7 @@ async def test_action(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_get_set_config(event_loop):
+async def test_get_set_config():
     async with base.CleanModel() as model:
         ubuntu_app = await model.deploy(
             'percona-cluster',
@@ -82,7 +82,7 @@ async def test_get_set_config(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_status_is_not_unset(event_loop):
+async def test_status_is_not_unset():
     async with base.CleanModel() as model:
         app = await model.deploy(
             'ubuntu',
@@ -96,7 +96,7 @@ async def test_status_is_not_unset(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_status(event_loop):
+async def test_status():
     async with base.CleanModel() as model:
         app = await model.deploy('cs:~juju-qa/blocked-0')
 
@@ -111,7 +111,7 @@ def app_ready():
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_add_units(event_loop):
+async def test_add_units():
     from juju.unit import Unit
 
     async with base.CleanModel() as model:
@@ -130,7 +130,7 @@ async def test_add_units(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_deploy_charmhub_charm(event_loop):
+async def test_deploy_charmhub_charm():
     async with base.CleanModel() as model:
         app = await model.deploy('ch:hello-juju')
         await model.block_until(lambda: (len(app.units) > 0 and
@@ -140,7 +140,7 @@ async def test_deploy_charmhub_charm(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_upgrade_charm_switch_channel(event_loop):
+async def test_upgrade_charm_switch_channel():
     # Note for future:
     # This test requires a charm that has different
     # revisions for different channels/risks.
@@ -184,7 +184,7 @@ async def test_upgrade_charm_switch_channel(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_upgrade_local_charm(event_loop):
+async def test_upgrade_local_charm():
     # Skip temporarily due to a known problem:
     pytest.skip('cannot upgrade application "ubuntu" to charm "local:focal/ubuntu-0": required storage "files" removed')
     async with base.CleanModel() as model:
@@ -201,7 +201,7 @@ async def test_upgrade_local_charm(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_upgrade_switch_charmstore_to_charmhub(event_loop):
+async def test_upgrade_switch_charmstore_to_charmhub():
     async with base.CleanModel() as model:
         app = await model.deploy('cs:ubuntu', series='focal')
         await model.wait_for_idle(status="active")
@@ -213,7 +213,7 @@ async def test_upgrade_switch_charmstore_to_charmhub(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_upgrade_charm_resource(event_loop):
+async def test_upgrade_charm_resource():
     async with base.CleanModel() as model:
         app = await model.deploy('cs:~juju-qa/bionic/upgrade-charm-resource-test-0')
 
@@ -233,7 +233,7 @@ async def test_upgrade_charm_resource(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_refresh_with_resource_argument(event_loop):
+async def test_refresh_with_resource_argument():
     async with base.CleanModel() as model:
         app = await model.deploy('juju-qa-test', resources={'foo-file': 2})
         res2 = await app.get_resources()
@@ -245,7 +245,7 @@ async def test_refresh_with_resource_argument(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_upgrade_charm_resource_same_rev_no_update(event_loop):
+async def test_upgrade_charm_resource_same_rev_no_update():
     async with base.CleanModel() as model:
         app = await model.deploy('keystone', channel='victoria/stable')
         ress = await app.get_resources()
@@ -256,7 +256,7 @@ async def test_upgrade_charm_resource_same_rev_no_update(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_refresh_charmhub_to_local(event_loop):
+async def test_refresh_charmhub_to_local():
     charm_path = INTEGRATION_TEST_DIR / 'charm'
     async with base.CleanModel() as model:
         app = await model.deploy('ubuntu', application_name='ubu-path')
@@ -270,7 +270,7 @@ async def test_refresh_charmhub_to_local(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_local_refresh(event_loop):
+async def test_local_refresh():
     charm_path = INTEGRATION_TEST_DIR / 'charm'
     async with base.CleanModel() as model:
         app = await model.deploy('ubuntu')
@@ -286,7 +286,7 @@ async def test_local_refresh(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_upgrade_local_charm_with_resource(event_loop):
+async def test_upgrade_local_charm_with_resource():
     charm_path = INTEGRATION_TEST_DIR / 'file-resource-charm'
     async with base.CleanModel() as model:
         app = await model.deploy(str(charm_path))
@@ -308,7 +308,7 @@ async def test_upgrade_local_charm_with_resource(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_trusted(event_loop):
+async def test_trusted():
     async with base.CleanModel() as model:
         await model.deploy('ubuntu', trust=True)
 
@@ -323,7 +323,7 @@ async def test_trusted(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_app_remove_wait_flag(event_loop):
+async def test_app_remove_wait_flag():
     async with base.CleanModel() as model:
         app = await model.deploy('ubuntu')
         a_name = app.name
@@ -335,7 +335,7 @@ async def test_app_remove_wait_flag(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_app_charm_name(event_loop):
+async def test_app_charm_name():
     async with base.CleanModel() as model:
         app = await model.deploy('ubuntu')
         await model.wait_for_idle(status="active")

tests/integration/test_charmhub.py

@@ -10,7 +10,7 @@
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_info(event_loop):
+async def test_info():
     async with base.CleanModel() as model:
         result = await model.charmhub.info("hello-juju")
 
@@ -19,7 +19,7 @@ async def test_info(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_info_with_channel(event_loop):
+async def test_info_with_channel():
     async with base.CleanModel() as model:
         result = await model.charmhub.info("hello-juju", "latest/stable")
 
@@ -29,7 +29,7 @@ async def test_info_with_channel(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_info_not_found(event_loop):
+async def test_info_not_found():
     async with base.CleanModel() as model:
         try:
             await model.charmhub.info("badnameforapp")
@@ -41,7 +41,7 @@ async def test_info_not_found(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_find(event_loop):
+async def test_find():
     async with base.CleanModel() as model:
         result = await model.charmhub.find("kube")
 
@@ -53,7 +53,7 @@ async def test_find(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_find_bundles(event_loop):
+async def test_find_bundles():
     async with base.CleanModel() as model:
         result = await model.charmhub.find("kube", charm_type="bundle")
 
@@ -65,7 +65,7 @@ async def test_find_bundles(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_find_all(event_loop):
+async def test_find_all():
     async with base.CleanModel() as model:
         result = await model.charmhub.find("")
 
@@ -77,7 +77,7 @@ async def test_find_all(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_subordinate_charm_zero_units(event_loop):
+async def test_subordinate_charm_zero_units():
     # normally in pylibjuju deploy num_units defaults to 1, we switch
     # that to 0 behind the scenes if we see that the charmhub charm
     # we're deploying is a subordinate charm
@@ -104,7 +104,7 @@ async def test_subordinate_charm_zero_units(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_list_resources(event_loop):
+async def test_list_resources():
     async with base.CleanModel() as model:
         resources = await model.charmhub.list_resources('hello-kubecon')
         assert isinstance(resources, list) and len(resources) > 0

tests/integration/test_client.py

@@ -10,7 +10,7 @@
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_user_info(event_loop):
+async def test_user_info():
     async with base.CleanModel() as model:
         controller_conn = await model.connection().controller()
 

tests/integration/test_connection.py

@@ -26,7 +26,7 @@
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_connection_happy_path(event_loop):
+async def test_connection_happy_path():
     async with base.CleanController() as contr:
         conn = contr.connection()
         new_cont = Controller()
@@ -40,7 +40,7 @@ async def test_connection_happy_path(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_monitor(event_loop):
+async def test_monitor():
     async with base.CleanModel() as model:
         conn = model.connection()
         assert conn.monitor.status == 'connected'
@@ -51,7 +51,7 @@ async def test_monitor(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_monitor_catches_error(event_loop):
+async def test_monitor_catches_error():
 
     async with base.CleanModel() as model:
         conn = model.connection()
@@ -72,7 +72,7 @@ async def test_monitor_catches_error(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_full_status(event_loop):
+async def test_full_status():
     async with base.CleanModel() as model:
         await model.deploy(
             'ubuntu',
@@ -88,7 +88,7 @@ async def test_full_status(event_loop):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_reconnect(event_loop):
+async def test_reconnect():
     async with base.CleanModel() as model:
         kwargs = model.connection().connect_params()
         conn = await Connection.connect(**kwargs)
@@ -105,7 +105,7 @@ async def test_reconnect(event_loop):
 @base.bootstrapped
 @pytest.mark.asyncio
 @pytest.mark.skip('tests the websocket protocol, not pylibjuju, needs to be revised')
-async def test_redirect(event_loop):
+async def test_redirect():
     controller = Controller()
     await controller.connect()
     kwargs = controller.connection().connect_params()
@@ -258,7 +258,7 @@ def _find_free_port(self):
 
 @base.bootstrapped
 @pytest.mark.asyncio
-async def test_verify_controller_cert(event_loop):
+async def test_verify_controller_cert():
     jujudata = FileJujuData()
     controller_name = jujudata.current_controller()
     endpoint = jujudata.controllers()[controller_name]['api-endpoints'][0]