Merge ~txiao/charm-juju-local:fix/lp#2029516 into charm-juju-local:master

[Tianqi Xiao]

Juju 3.x support.

1. Juju 3.x snap is strictly confined and doesn't have the permission to create juju's local user directory (`~/.local/share/juju`). This PR implements a workaround for this issue
2. Refresh lxd snap to "latest/stable" to support bootstrapping Juju 3.x controller.
3. Added functional tests for Juju 3.x
4. Pin tenacity to workaround LP#2031582

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

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

[Eric Chen (eric-chen)]

It seems they don't have plan to fix it in the snap.
The suggestion is to let the user to create the folder by themselves.

review: Approve

[Ramesh Sattaru (rameshcan)]

review: Approve

[Eric Chen (eric-chen)]

I forget why we don't have jenkins CI in this project. Please attach the unit/func test log into pastebin as workaround solution.

review: Needs Information

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

FAILED: Continuous integration, rev:568ce0a79f32baa7e7f99df1b6c9215290cf14f8
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-local-ci/1/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1583/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/445/

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:bf9921b67e60cd5a0a1300bafab6ecd0cc3d4bb9
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-local-ci/2/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1584/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/446/

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:f77ce8d20e20f7786ffd3c371a10ff60e5319856
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-local-ci/3/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1585/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/447/

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

review: Needs Fixing (continuous-integration)

[Tianqi Xiao (txiao)]

Looking into the dependency issue on bionic series. Setting MP to "Work in progress"

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

PASSED: Continuous integration, rev:73a3a2b7367bc7044b05ab0e8b338725fb75eaad
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-local-ci/4/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1586/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/448/

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:aa4d37dee3b7bd4756273fc0b5f319fe7448de74
https://jenkins.canonical.com/bootstack/job/lp-charm-juju-local-ci/5/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1587/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/449/

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

review: Approve (continuous-integration)

[Eric Chen (eric-chen)]

review: Approve

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

Change successfully merged at revision d8bf76ab8face7901cea301f0f0e3ba863da7c2a

diff --git a/Makefile b/Makefile
index df5f479..ed84e3a 100644
--- a/Makefile
+++ b/Makefile
@@ -6,6 +6,7 @@ help:
 	@echo ""
 	@echo " make help - show this text"
 	@echo " make lint - run flake8"
+	@echo " make unittests - run the tests defined in the unittest subdirectory"
 	@echo " make test - run the functests and lint"
 	@echo " make functional - run the tests defined in the functional subdirectory"
 	@echo " make release - build the charm"
@@ -16,6 +17,9 @@ lint:
 	@echo "Running flake8"
 	@-tox -e lint
 
+unittests:
+	@echo "No unit tests available at the moment"
+
 test: lint functional
 
 functional: build
diff --git a/lib/lib_charm_juju_local.py b/lib/lib_charm_juju_local.py
index 39fc880..ba18467 100644
--- a/lib/lib_charm_juju_local.py
+++ b/lib/lib_charm_juju_local.py
@@ -4,6 +4,7 @@ import textwrap
 
 from charmhelpers.core import hookenv, host, templating
 from charmhelpers.fetch.ubuntu import apt_cache
+from charms.layer import snap
 
 
 LXD_BRIDGE_TMPL = "lxd-bridge.ini.j2"
@@ -46,6 +47,9 @@ class JujuLocalHelper:
             subprocess.call("sudo lxd.migrate -yes", shell=True)
 
     def lxd_init(self):
+        # Refresh lxd snap to "latest/stable" channel for Juju 3.x support.
+        snap.refresh("lxd", channel="latest/stable")
+
         install_sh = textwrap.dedent(
             """
             lxd init --auto --storage-backend dir
@@ -64,6 +68,14 @@ class JujuLocalHelper:
                 shell=True,
             )
         series = host.lsb_release()["DISTRIB_CODENAME"]
+
+        # Create juju's local user directory if missing
+        # This is a workaround for LP #1988355
+        subprocess.call(
+            "sudo -u ubuntu mkdir -p /home/ubuntu/.local/share/juju",
+            shell=True,
+        )
+
         subprocess.call(
             textwrap.dedent(
                 f"""
diff --git a/tests/bundles/focal-juju3.yaml b/tests/bundles/focal-juju3.yaml
new file mode 120000
index 0000000..f81f6ff
--- /dev/null
+++ b/tests/bundles/focal-juju3.yaml
@@ -0,0 +1 @@
+base.yaml
\ No newline at end of file
diff --git a/tests/bundles/jammy-juju3.yaml b/tests/bundles/jammy-juju3.yaml
new file mode 120000
index 0000000..f81f6ff
--- /dev/null
+++ b/tests/bundles/jammy-juju3.yaml
@@ -0,0 +1 @@
+base.yaml
\ No newline at end of file
diff --git a/tests/bundles/overlays/focal-juju3.yaml.j2 b/tests/bundles/overlays/focal-juju3.yaml.j2
new file mode 100644
index 0000000..e0bb1d4
--- /dev/null
+++ b/tests/bundles/overlays/focal-juju3.yaml.j2
@@ -0,0 +1,5 @@
+series: focal
+applications:
+  {{ charm_name }}:
+    options:
+      juju-channel: "3.1/stable"
diff --git a/tests/bundles/overlays/jammy-juju3.yaml.j2 b/tests/bundles/overlays/jammy-juju3.yaml.j2
new file mode 100644
index 0000000..6dac327
--- /dev/null
+++ b/tests/bundles/overlays/jammy-juju3.yaml.j2
@@ -0,0 +1,5 @@
+series: jammy
+applications:
+  {{ charm_name }}:
+    options:
+      juju-channel: "3.1/stable"
diff --git a/tests/tests.yaml b/tests/tests.yaml
index 4476d69..c0f919c 100644
--- a/tests/tests.yaml
+++ b/tests/tests.yaml
@@ -2,12 +2,16 @@ charm_name: juju-local
 tests:
   - tests.tests_juju_local.CharmJujuLocalTest
 gate_bundles:
+  - jammy-juju3
+  - focal-juju3
   - jammy
   - focal
   - bionic
 dev_bundles:
+  - jammy-juju3
   - jammy
 smoke_bundles:
+  - focal-juju3
   - focal
 target_deploy_status:
   juju-local:
diff --git a/tests/tests_juju_local.py b/tests/tests_juju_local.py
index b3f8a09..d34cf34 100644
--- a/tests/tests_juju_local.py
+++ b/tests/tests_juju_local.py
@@ -13,8 +13,13 @@ class CharmJujuLocalTest(unittest.TestCase):
         cls.model_name = model.get_juju_model()
         cls.test_config = lifecycle_utils.get_charm_config()
         model.block_until_all_units_idle()
+        # Add a test model in the remote Juju cloud 
+        # This is needed becuase in Juju 3.x there's no default model created
+        # after bootstrapping the controller
+        cls.remote_juju(["add-model", "test"], None)
 
-    def remote_juju(self, args, format="json"):
+    @classmethod
+    def remote_juju(cls, args, format="json"):
         if format:
             fmt = "--format={}".format(format)
         else:
@@ -22,11 +27,18 @@ class CharmJujuLocalTest(unittest.TestCase):
         cmd = """sudo -u ubuntu bash -c '/snap/bin/juju {} {}'""".format(
             " ".join(args), fmt
         )
-        res = model.run_on_unit(self.jlocal_unit, cmd)
-        return res.get("Stdout"), res.get("Stderr")
+        res = model.run_on_unit(cls.jlocal_unit, cmd)
+        return_code = int(res["Code"])
+        if return_code != 0:
+            raise RuntimeError(
+                "Failed to execute command in juju-local unit.\nStderr: {}".format(
+                    res.get("Stderr")
+                )
+            )
+        return res.get("Stdout")
 
     def juju_status(self):
-        stdout, _ = self.remote_juju(["status"])
+        stdout = self.remote_juju(["status"])
         return json.loads(stdout)
 
     def test_juju_status(self):
@@ -34,7 +46,7 @@ class CharmJujuLocalTest(unittest.TestCase):
         self.assertEqual(jstatus["model"]["controller"], "lxd")
 
     def test_juju_users(self):
-        stdout, _ = self.remote_juju(["users"])
+        stdout = self.remote_juju(["users"])
         userobjects = json.loads(stdout)
         usernames = set(u["user-name"] for u in userobjects)
         self.assertTrue("admin" in usernames)
diff --git a/wheelhouse.txt b/wheelhouse.txt
index 02a822a..65c7e41 100644
--- a/wheelhouse.txt
+++ b/wheelhouse.txt
@@ -1 +1,2 @@
 Markupsafe<2.0.0  # for xenial support
+tenacity<5.0.4 # workaround for LP#2031582