Merge ~sudeephb/juju-lint:snap-template into juju-lint:master

[Sudeep Bhandari]

Apply snap template from bootstack-charms-spec

https://code.launchpad.net/bootstack-charms-spec/

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

PASSED: Continuous integration, rev:53fad34184f28e7071604519e8926755922fe565
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/30/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1169/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1590/

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

review: Approve (continuous-integration)

[Eric Chen (eric-chen)]

review: Needs Information

[Eric Chen (eric-chen)]

LGTM, just a little question inline

review: Needs Information

[Sudeep Bhandari (sudeephb)]

> LGTM, just a little question inline
I have addressed the comment. The indentations are now consistent.

[Eric Chen (eric-chen)]

review: Approve

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

FAILED: Continuous integration, rev:358294dcdf02eb2619dfd3d06a316d55b4695daf
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/31/
Executed test runs:
    ABORTED: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1181/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1592/

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

review: Needs Fixing (continuous-integration)

[Robert Gildein (rgildein)]

I tested the Makefile and tox.ini. LGTM

review: Approve

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

FAILED: Continuous integration, rev:358294dcdf02eb2619dfd3d06a316d55b4695daf
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/32/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1185/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1594/

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

review: Needs Fixing (continuous-integration)

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

PASSED: Continuous integration, rev:358294dcdf02eb2619dfd3d06a316d55b4695daf
https://jenkins.canonical.com/bootstack/job/lp-juju-lint-ci/33/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/1187/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1595/

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

review: Approve (continuous-integration)

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

Change successfully merged at revision 18b22675080effa4ee7b2962a1edf0370ad3bf5e

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index c327de3..dbf6054 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,6 +1,10 @@
+# This is a template `.pre-commit-config.yaml` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.3.0
     hooks:
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
@@ -8,12 +12,15 @@ repos:
       - id: trailing-whitespace
       - id: check-added-large-files
       - id: check-json
+      # Note(sudeephb): Using `--unsafe` with check-yaml to allow using `!include`.
+      # More info about `--unsafe`:
+      # https://github.com/pre-commit/pre-commit-hooks/blob/main/README.md?plain=1#L85
       - id: check-yaml
         args: ["--unsafe"]
   - repo: local
     hooks:
       - id: lint
         name: lint
-        entry: tox -e lint
+        entry: make lint
         language: system
         types: [ python ]
diff --git a/Makefile b/Makefile
index 7c33d38..887786e 100644
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,9 @@
+# This is a template `Makefile` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+PYTHON := /usr/bin/python3
+
 PROJECTPATH=$(dir $(realpath ${MAKEFILE_LIST}))
 SNAP_NAME=$(shell cat ${PROJECTPATH}/snap/snapcraft.yaml | grep -E '^name:' | awk '{print $$2}')
 SNAP_FILE=${PROJECTPATH}/${SNAP_NAME}.snap
@@ -41,7 +47,7 @@ clean:
 	@echo "Cleaning snap"
 	@snapcraft clean --use-lxd
 	@echo "Cleaning existing snap builds"
-	@find . -name "*.snap" -delete
+	@rm -rf ${SNAP_FILE}
 
 dev-environment:
 	@echo "Creating virtualenv and installing pre-commit"
@@ -49,7 +55,7 @@ dev-environment:
 
 functional: build
 	@echo "Executing functional tests using built snap"
-	@JUJULINT_TEST_SNAP=${SNAP_FILE} tox -e func -- ${FUNC_ARGS}
+	@TEST_SNAP=${SNAP_FILE} tox -e func -- ${FUNC_ARGS}
 
 pre-commit:
 	@tox -e pre-commit
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..c58e8e6
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,35 @@
+# This is a template `pyproject.toml` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
+[tool.flake8]
+ignore = ["C901", "D100", "D101", "D102", "D103", "W503", "W504"]
+exclude = ['.eggs', '.git', '.tox', '.venv', '.build', 'report']
+max-line-length = 120
+max-complexity = 10
+
+[tool.black]
+line-length = 88
+exclude = '''
+/(
+    | .eggs
+    | .git
+    | .tox
+    | .venv
+    | .build
+    | report
+)/
+'''
+
+[tool.isort]
+profile = "black"
+skip_glob = '''
+/(
+    | .eggs
+    | .git
+    | .tox
+    | .venv
+    | .build
+    | report
+)/
+'''
diff --git a/rename.sh b/rename.sh
index f7316d0..6d645e1 100755
--- a/rename.sh
+++ b/rename.sh
@@ -1,4 +1,8 @@
 #!/bin/bash
+# This is a template `rename.sh` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
+
 snap=$(grep -E "^name:" snap/snapcraft.yaml | awk '{print $2}')
 echo "renaming ${snap}_*.snap to ${snap}.snap"
 echo -n "pwd: "
@@ -9,5 +13,5 @@ if [[ -e "${snap}.snap" ]];
 then
     rm "${snap}.snap"
 fi
-echo "Renaming charm here."
+echo "Renaming snap here."
 mv ${snap}_*.snap ${snap}.snap
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
index 7c215c1..fdbd012 100644
--- a/tests/functional/conftest.py
+++ b/tests/functional/conftest.py
@@ -20,10 +20,10 @@ def pytest_configure(config):
 def install_package():
     """Install the package to the system and cleanup afterwards.
 
-    Depending on the environment variable JUJULINT_TEST_SNAP,
+    Depending on the environment variable TEST_SNAP,
     it will install the snap or the python package.
     """
-    jujulint_test_snap = os.environ.get("JUJULINT_TEST_SNAP", None)
+    jujulint_test_snap = os.environ.get("TEST_SNAP", None)
     if jujulint_test_snap:
         logging.info(f"Installing {jujulint_test_snap}")
         assert os.path.isfile(jujulint_test_snap)
@@ -63,7 +63,7 @@ def basedir():
     This will ease testing the rules files that we ship
     with the juju-lint snap.
     """
-    if os.environ.get("JUJULINT_TEST_SNAP", None):
+    if os.environ.get("TEST_SNAP", None):
         basedir = "/snap/juju-lint/current/"
     else:
         basedir = os.getcwd()
diff --git a/tox.ini b/tox.ini
index 08183e2..db766fe 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,14 +1,6 @@
-[flake8]
-exclude =
-    .git,
-    __pycache__,
-    .tox,
-    .eggs,
-    .venv,
-    venv,
-max-line-length = 120
-max-complexity = 10
-ignore = D100, D103, C901, W503
+# This is a template `tox.ini` file for snaps
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual snap repos. https://launchpad.net/bootstack-charms-spec
 
 [tox]
 skipsdist=True
@@ -18,107 +10,55 @@ skip_missing_interpreters = True
 [testenv]
 basepython = python3
 
-[testenv:unit]
-deps =
-    -r{toxinidir}/requirements.txt
-    -r{toxinidir}/tests/unit/requirements.txt
-commands =
-    pytest -vv \
-    --cov=jujulint \
-    --new-first \
-    --last-failed \
-    --last-failed-no-failures all \
-    --cov-fail-under=100 \
-    --cov-report=term-missing \
-    --cov-report=annotate:tests/unit/report/coverage-annotated \
-    --cov-report=html:tests/unit/report/coverage-html \
-    --html=tests/unit/report/index.html \
-    --junitxml=tests/unit/report/junit.xml \
-    --ignore={toxinidir}/tests/functional
-setenv = PYTHONPATH={toxinidir}
-
-[testenv:func]
-deps = -r{toxinidir}/tests/functional/requirements.txt
-passenv =
-    JUJULINT_TEST_*
-commands =
-    pytest -v \
-    --log-cli-level=WARNING \
-    --ignore={toxinidir}/tests/unit \
-    {posargs}
-
-[testenv:func-smoke]
+[testenv:dev-environment]
+envdir = {toxinidir}/.venv
 deps =
+    pre-commit
+    {[testenv:lint]deps}
+    {[testenv:unit]deps}
     {[testenv:func]deps}
-    -r{toxinidir}/requirements.txt
 commands =
-    pytest -v \
-    --log-cli-level=WARNING \
-    --ignore={toxinidir}/tests/unit \
-    -m smoke
+    pre-commit install
 
-[testenv:func-dev]
-deps =
-    {[testenv:func]deps}
-    -r{toxinidir}/requirements.txt
-commands =
-    pytest -v \
-    --log-cli-level=WARNING \
-    --ignore={toxinidir}/tests/unit
+[testenv:pre-commit]
+envdir = {[testenv:dev-environment]envdir}
+deps = {[testenv:dev-environment]deps}  # ensure that dev-environment is installed
+commands = pre-commit run --all-files
 
 [testenv:lint]
+commands =
+    pflake8
+    black --check --diff --color .
+    isort --check --diff --color .
 deps =
     black
-    colorama
     flake8
-    flake8-colors
+    pyproject-flake8
     flake8-docstrings
-    flake8-html
-    isort
     pep8-naming
-    pyflakes
-
-commands =
-    flake8 --color always
-    black --check --diff --color .
-    isort --check-only --diff --color .
+    flake8-colors
+    colorama
+    isort
 
 [testenv:reformat]
-deps = {[testenv:lint]deps}
+envdir = {toxworkdir}/lint
 commands =
     black .
     isort .
+deps = {[testenv:lint]deps}
 
-[pytest]
-filterwarnings =
-    ignore::DeprecationWarning
-
-[isort]
-profile = black
-skip_glob =
-    .eggs,
-    __pycache__,
-    .git,
-    .tox,
-    .venv,
-    .build,
-    venv,
-    dist,
-    mod,
-    build,
-
-[testenv:dev-environment]
+[testenv:unit]
+commands = pytest {toxinidir}/tests/unit
 deps =
-    pre-commit
-    {[testenv:lint]deps}
-    {[testenv:unit]deps}
-    {[testenv:func]deps}
-envdir = {toxinidir}/.venv
-commands =
-    pre-commit install
+    -r {toxinidir}/requirements.txt
+    -r {toxinidir}/tests/unit/requirements.txt
+    pytest
+    pytest-cov
+setenv = PYTHONPATH={toxinidir}
 
-[testenv:pre-commit]
-deps = {[testenv:dev-environment]deps}
-envdir = {[testenv:dev-environment]envdir}
+[testenv:func]
+deps = -r{toxinidir}/tests/functional/requirements.txt
+passenv =
+    TEST_*
 commands =
-    pre-commit run -a
+    pytest {toxinidir}/tests/functional {posargs:-v}