Merge ~gabrielcocenza/juju-lint:bug/1990885-b into juju-lint:master

[Gabriel Cocenza]

add subdirectories and fixed functional tests

- fixed setup.py to accept subdirectories under the jujulint project
  folder.
- changed the working directory when running functional tests with
  the snap to not use local modules.
- updated contributing for func-smoke and func-dev to run functional
  tests during development.

[🤖 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)]

FAILED: Continuous integration, rev:98104f256084cb00f03b906886ed077e957f69ae
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/40/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1489/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1739/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/40//rebuild

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:98104f256084cb00f03b906886ed077e957f69ae
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/41/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1492/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1741/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/41//rebuild

review: Approve (continuous-integration)

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

FAILED: Continuous integration, rev:c0526a2bdd73aef1885cb8a3040ff7793e15e7a3
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/42/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1496/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1744/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/42//rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:c0526a2bdd73aef1885cb8a3040ff7793e15e7a3
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/43/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1497/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1745/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/43//rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:c0526a2bdd73aef1885cb8a3040ff7793e15e7a3
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/44/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1499/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1747/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/44//rebuild

review: Needs Fixing (continuous-integration)

[Eric Chen (eric-chen)]

review: Approve

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

FAILED: Continuous integration, rev:c0526a2bdd73aef1885cb8a3040ff7793e15e7a3
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/46/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1504/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1752/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/46//rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:36f4a6680caffd5ef7893cf5fe6c02173949841c
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/49/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1507/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1756/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/49//rebuild

review: Needs Fixing (continuous-integration)

[Gabriel Cocenza (gabrielcocenza)]

pastebin[0] of the unit, lint and functional tests

[0] https://pastebin.canonical.com/p/kS4CrD7pSq/

[Tianqi Xiao (txiao)]

LGTM

review: Approve

[Erhan Sunar (esunar)]

review: Approve

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

Change successfully merged at revision b30ed0bca5242d19d42d383391e0d7f7cfd4870a

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

PASSED: Continuous integration, rev:36f4a6680caffd5ef7893cf5fe6c02173949841c
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/50/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1508/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1757/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/50//rebuild

review: Approve (continuous-integration)

diff --git a/.gitignore b/.gitignore
index b095e7e..54afb54 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,7 @@
 juju_lint.egg-info/
 dist/
 tests/report/
+build/
 
 # python artefacts
 __pycache__
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2baa385..8e06d63 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -60,9 +60,9 @@ However for development purposes, the testing infrastructure also allows for ins
 and running tests against it.
 In order to invoke:
 - development smoke suite, which deselects tests running against a live lxd cloud
-  - `$ tox -e func-smoke`
+  - `$ tox -e func -- -m smoke -v`
 - development full suite, which runs all the functional tests
-  - `$ tox -e func-dev`
+  - `$ tox -e func`
 
 
 ## Canonical Contributor Agreement
diff --git a/jujulint/checks/__init__.py b/jujulint/checks/__init__.py
new file mode 100644
index 0000000..3bb8cbc
--- /dev/null
+++ b/jujulint/checks/__init__.py
@@ -0,0 +1 @@
+"""Import this library to fetch and lint the configuration and status of Juju environments."""
diff --git a/setup.py b/setup.py
index 9bd497c..6a8f82c 100644
--- a/setup.py
+++ b/setup.py
@@ -42,7 +42,7 @@ setuptools.setup(
         "Intended Audience :: System Administrators",
     ],
     python_requires=">=3.7",
-    packages=["jujulint"],
+    packages=setuptools.find_packages(include=("jujulint*")),
     entry_points={"console_scripts": ["juju-lint=jujulint.cli:main"]},
     setup_requires=["setuptools_scm"],
 )
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
index fdbd012..6620b31 100644
--- a/tests/functional/conftest.py
+++ b/tests/functional/conftest.py
@@ -25,6 +25,9 @@ def install_package():
     """
     jujulint_test_snap = os.environ.get("TEST_SNAP", None)
     if jujulint_test_snap:
+        # change directory to not import from local modules and force using the snap package
+        cwd = os.getcwd()
+        os.chdir("/tmp")
         logging.info(f"Installing {jujulint_test_snap}")
         assert os.path.isfile(jujulint_test_snap)
         assert (
@@ -49,6 +52,8 @@ def install_package():
     yield jujulint_test_snap
 
     if jujulint_test_snap:
+        # return to the previous working directory
+        os.chdir(cwd)
         logging.info("Removing snap package juju-lint")
         check_call("sudo snap remove juju-lint".split())
     else:
diff --git a/tox.ini b/tox.ini
index db766fe..8aefb78 100644
--- a/tox.ini
+++ b/tox.ini
@@ -57,7 +57,9 @@ deps =
 setenv = PYTHONPATH={toxinidir}
 
 [testenv:func]
-deps = -r{toxinidir}/tests/functional/requirements.txt
+deps =
+    -r{toxinidir}/tests/functional/requirements.txt
+    -r{toxinidir}/requirements.txt
 passenv =
     TEST_*
 commands =