Merge ~vultaire/charm-juju-controller:functest-fix into charm-juju-controller:master

[Paul Goins]

Multiple fixes to enable functional tests

Added a TEST_REPO_ROOT env var, which will be passed through by zaza,
for exposing the root directory of the repository. This allows us
to cleanly refer to the locally-prepped customized Ubuntu charm
required for functional testing.

Additionally, refactored overlays to reduce duplication, and added
a missing num_units setting needed for proper deployment.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:f55b284492defa73a05224f7acd3ef0a091f8bef
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-controller-ci/7/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/6/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/360/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-controller-ci/7//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:2b01a2b268094f03f9664f36cd8b5a1b85908601
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-controller-ci/8/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/7/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/361/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-controller-ci/8//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:bcb1ef16ee3dcdcd40908f38023fa6e7290b4b2a
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-controller-ci/11/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-unit/162/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/432/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-controller-ci/11//rebuild

review: Approve (continuous-integration)

[Xav Paice (xavpaice)]

lgtm

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 5fb92590ad858507172a49f0c0d346d06036b50e

diff --git a/src/tests/functional/tests/bundles/overlays/bionic.yaml.j2 b/src/tests/functional/tests/bundles/overlays/bionic.yaml.j2
index fad7d28..65b2826 100644
--- a/src/tests/functional/tests/bundles/overlays/bionic.yaml.j2
+++ b/src/tests/functional/tests/bundles/overlays/bionic.yaml.j2
@@ -1,4 +1 @@
 series: bionic
-applications:
-  {{ charm_name }}:
-    charm: "{{ CHARM_BUILD_DIR }}/{{ charm_name }}"
diff --git a/src/tests/functional/tests/bundles/overlays/focal.yaml.j2 b/src/tests/functional/tests/bundles/overlays/focal.yaml.j2
index 1eabba4..d3f46ab 100644
--- a/src/tests/functional/tests/bundles/overlays/focal.yaml.j2
+++ b/src/tests/functional/tests/bundles/overlays/focal.yaml.j2
@@ -1,4 +1 @@
 series: focal
-applications:
-  {{ charm_name }}:
-    charm: "{{ CHARM_BUILD_DIR }}/{{ charm_name }}"
diff --git a/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2 b/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
index 4d6e8b6..f4145eb 100644
--- a/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
+++ b/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
@@ -1,3 +1,3 @@
 applications:
   ubuntu:
-    charm: {{ CHARM_BUILD_DIR }}/../testing-charms/ubuntu-lxd-profile
+    charm: {{ TEST_REPO_ROOT }}/testing-charms/ubuntu-lxd-profile
diff --git a/src/tests/functional/tests/tests_juju_controller.py b/src/tests/functional/tests/tests_juju_controller.py
index 110cb20..fd7b048 100644
--- a/src/tests/functional/tests/tests_juju_controller.py
+++ b/src/tests/functional/tests/tests_juju_controller.py
@@ -5,8 +5,7 @@ import os
 import unittest
 from pathlib import Path
 
-from zaza import model, sync_wrapper
-from zaza.charm_lifecycle import utils as lifecycle_utils
+from zaza import model
 
 
 CHARM_BUILD_DIR = os.environ.get("CHARM_BUILD_DIR", "/tmp/charm-builds")
@@ -39,27 +38,21 @@ async def check_for_inner_status(unit, inner_model, inner_app, target="active"):
     return False
 
 
-async def async_block_until_inner_app(unit, inner_model, app):
+def block_until_inner_app(unit, inner_model, app):
     """Wait for app to be active."""
-    await model.async_block_until(
+    model.block_until(
         lambda: check_for_inner_status(unit, inner_model, app),
         timeout=600,
         wait_period=2,
     )
 
 
-block_until_inner_app = sync_wrapper(async_block_until_inner_app)
-
-
 class JujuControllerTestBase(unittest.TestCase):
     """Base class for charm functional tests."""
 
     @classmethod
     def setUpClass(cls):
         """Set up test environment."""
-        cls.model_name = model.get_juju_model()
-        cls.test_config = lifecycle_utils.get_charm_config()
-        model.block_until_all_units_idle()
         cls.unit = "ubuntu/0"
         cls.enable_ha()
         cls.deploy_juju_controller()
diff --git a/src/tox.ini b/src/tox.ini
index 24fb13b..b16ed99 100644
--- a/src/tox.ini
+++ b/src/tox.ini
@@ -69,3 +69,5 @@ deps = -r{toxinidir}/tests/unit/requirements.txt
 changedir = {toxinidir}/tests/functional
 commands = functest-run-suite {posargs}
 deps = -r{toxinidir}/tests/functional/requirements.txt
+setenv =
+  TEST_REPO_ROOT = {toxinidir}/..