Merge ~vultaire/charm-prometheus-blackbox-exporter:makefile-20.08 into charm-prometheus-blackbox-exporter:master

[Paul Goins]

Updated Makefile/tox.ini/.gitignore and made related changes

Note: this charm lacked any unit tests, so while I fixed things so the unit tests would pass if there were any to test, the "make unittests" target _does_ fail since there are no tests (and thus no coverage data).

I could add a dummy test if strongly desired, but I feel like that could unintentionally "cover up" that this charm has no unit tests. At the very least I want to call this out so we can decide what to do here.

[Paul Goins (vultaire)]

Also note that the 'Fixed "make lint"' commit is a combination of tox.ini tweaks and running black, and nothing more.

[Paul Goins (vultaire)]

Re-pushed... Fixed "make lint" to _not_ run black (as that would kind of defeat the point of having a separate black commit)

[Xav Paice (xavpaice)]

LGTM

review: Approve

diff --git a/.gitignore b/.gitignore
index 2dc89c9..6f1f367 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,24 +1,41 @@
+# Juju files
+.unit-state.db
+.go-cookies
+
+layers/*
+interfaces/*
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
-# Log files
-*.log
-.tox/
+# Tests files and dir
+.pytest_cache/
 .coverage
+.tox
+report/
+htmlcov/
 
-# vi
-.*.swp
+# Log files
+*.log
 
 # pycharm
 .idea/
 
+# vi
+.*.swp
+
 # version data
 repo-info
+version
+
+# Python builds
+deb_dist/
+dist/
 
-# reports
-report/*
+# Snaps
+*.snap
 
-# layers
-layers/*
 \ No newline at end of file
+# Builds
+.build/
 \ No newline at end of file
diff --git a/Makefile b/Makefile
index 949713b..647cacd 100644
--- a/Makefile
+++ b/Makefile
@@ -1,48 +1,80 @@
+PYTHON := /usr/bin/python3
+
+PROJECTPATH=$(dir $(realpath $(MAKEFILE_LIST)))
 ifndef CHARM_BUILD_DIR
-    CHARM_BUILD_DIR=/tmp/builds
+	CHARM_BUILD_DIR=${PROJECTPATH}.build
+endif
+ifndef CHARM_LAYERS_DIR
+	CHARM_LAYERS_DIR=${PROJECTPATH}/layers
+endif
+ifndef CHARM_INTERFACES_DIR
+	CHARM_INTERFACES_DIR=${PROJECTPATH}/interfaces
 endif
+METADATA_FILE="src/metadata.yaml"
+CHARM_NAME=$(shell cat ${PROJECTPATH}/${METADATA_FILE} | grep -E "^name:" | awk '{print $$2}')
 
 help:
 	@echo "This project supports the following targets"
 	@echo ""
 	@echo " make help - show this text"
+	@echo " make clean - remove unneeded files"
 	@echo " make submodules - make sure that the submodules are up-to-date"
-	@echo " make lint - run flake8"
-	@echo " make test - run the functional tests and lint"
+	@echo " make submodules-update - update submodules to latest changes on remote branch"
+	@echo " make build - build the charm"
+	@echo " make release - run clean, submodules, and build targets"
+	@echo " make lint - run flake8 and black --check"
+	@echo " make black - run black and reformat files"
+	@echo " make proof - run charm proof"
+	@echo " make unittests - run the tests defined in the unittest subdirectory"
 	@echo " make functional - run the tests defined in the functional subdirectory"
-	@echo " make release - build the charm"
-	@echo " make clean - remove unneeded files"
+	@echo " make test - run lint, proof, unittests and functional targets"
 	@echo ""
 
+clean:
+	@echo "Cleaning files"
+	@git clean -ffXd -e '!.idea'
+	@echo "Cleaning existing build"
+	@rm -rf ${CHARM_BUILD_DIR}/${CHARM_NAME}
+
 submodules:
 	@echo "Cloning submodules"
 	@git submodule update --init --recursive
 
+submodules-update:
+	@echo "Pulling latest updates for submodules"
+	@git submodule update --init --recursive --remote --merge
+
+build:
+	@echo "Building charm to directory ${CHARM_BUILD_DIR}/${CHARM_NAME}"
+	@-git rev-parse --abbrev-ref HEAD > ./src/repo-info
+	@CHARM_LAYERS_DIR=${CHARM_LAYERS_DIR} CHARM_INTERFACES_DIR=${CHARM_INTERFACES_DIR} \
+		TERM=linux CHARM_BUILD_DIR=${CHARM_BUILD_DIR} charm build src/
+
+release: clean build
+	@echo "Charm is built at ${CHARM_BUILD_DIR}/${CHARM_NAME}"
+
 lint:
-	@mkdir -p report/lint/
-	@echo "Running flake8"
-	@tox -e lint
+	@echo "Running lint checks"
+	@cd src && tox -e lint
 
-test: lint functional
+black:
+	@echo "Reformat files with black"
+	@cd src && tox -e black
 
-functional: build
-	@echo Executing with: CHARM_BUILD_DIR=$(CHARM_BUILD_DIR) tox -e func
-	@CHARM_BUILD_DIR=$(CHARM_BUILD_DIR) tox -e func
+proof:
+	@echo "Running charm proof"
+	@charm proof src
 
-build:
-	@echo "Building charm to base directory $(CHARM_BUILD_DIR)"
-	@-git describe --tags > ./repo-info
-	@CHARM_LAYERS_DIR=./layers CHARM_INTERFACES_DIR=./interfaces TERM=linux \
-		CHARM_BUILD_DIR=$(CHARM_BUILD_DIR) charm build . --force
+unittests:
+	@echo "Running unit tests"
+	@cd src && tox -e unit
 
-release: clean build
-	@echo "Charm is built at $(CHARM_BUILD_DIR)/prometheus-blackbox-exporter"
+functional: build
+	@echo "Executing functional tests in ${CHARM_BUILD_DIR}"
+	@cd src && CHARM_BUILD_DIR=${CHARM_BUILD_DIR} tox -e func
 
-clean:
-	@echo "Cleaning files"
-	@if [ -d .tox ] ; then rm -r .tox ; fi
-	@if [ -d .pytest_cache ] ; then rm -r .pytest_cache ; fi
-	@find . -iname __pycache__ -exec rm -r {} +
+test: lint proof unittests functional
+	@echo "Tests completed for charm ${CHARM_NAME}."
 
 # The targets below don't depend on a file
-.PHONY: lint test functional build release clean help submodules
+.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
diff --git a/README.md b/src/README.md
 similarity index 100%
 rename from README.md
 rename to src/README.md
diff --git a/config.yaml b/src/config.yaml
 similarity index 100%
 rename from config.yaml
 rename to src/config.yaml
diff --git a/copyright b/src/copyright
 similarity index 100%
 rename from copyright
 rename to src/copyright
diff --git a/icon.svg b/src/icon.svg
 similarity index 100%
 rename from icon.svg
 rename to src/icon.svg
diff --git a/layer.yaml b/src/layer.yaml
 similarity index 100%
 rename from layer.yaml
 rename to src/layer.yaml
diff --git a/metadata.yaml b/src/metadata.yaml
 similarity index 100%
 rename from metadata.yaml
 rename to src/metadata.yaml
diff --git a/reactive/prometheus_blackbox_exporter.py b/src/reactive/prometheus_blackbox_exporter.py
 similarity index 100%
 rename from reactive/prometheus_blackbox_exporter.py
 rename to src/reactive/prometheus_blackbox_exporter.py
diff --git a/requirements.txt b/src/requirements.txt
 similarity index 100%
 rename from requirements.txt
 rename to src/requirements.txt
diff --git a/templates/blackbox.yaml.j2 b/src/templates/blackbox.yaml.j2
 similarity index 100%
 rename from templates/blackbox.yaml.j2
 rename to src/templates/blackbox.yaml.j2
diff --git a/tests/functional/requirements.txt b/src/tests/functional/requirements.txt
 similarity index 100%
 rename from tests/functional/requirements.txt
 rename to src/tests/functional/requirements.txt
diff --git a/tests/functional/tests/__init__.py b/src/tests/functional/tests/__init__.py
 similarity index 100%
 rename from tests/functional/tests/__init__.py
 rename to src/tests/functional/tests/__init__.py
diff --git a/tests/functional/tests/bundles/bionic.yaml b/src/tests/functional/tests/bundles/bionic.yaml
 similarity index 100%
 rename from tests/functional/tests/bundles/bionic.yaml
 rename to src/tests/functional/tests/bundles/bionic.yaml
diff --git a/tests/functional/tests/bundles/focal.yaml b/src/tests/functional/tests/bundles/focal.yaml
 similarity index 100%
 rename from tests/functional/tests/bundles/focal.yaml
 rename to src/tests/functional/tests/bundles/focal.yaml
diff --git a/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2 b/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
 similarity index 100%
 rename from tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
 rename to src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
diff --git a/tests/functional/tests/bundles/xenial.yaml b/src/tests/functional/tests/bundles/xenial.yaml
 similarity index 100%
 rename from tests/functional/tests/bundles/xenial.yaml
 rename to src/tests/functional/tests/bundles/xenial.yaml
diff --git a/tests/functional/tests/test_prometheus_blackbox_exporter.py b/src/tests/functional/tests/test_prometheus_blackbox_exporter.py
 similarity index 100%
 rename from tests/functional/tests/test_prometheus_blackbox_exporter.py
 rename to src/tests/functional/tests/test_prometheus_blackbox_exporter.py
diff --git a/tests/functional/tests/tests.yaml b/src/tests/functional/tests/tests.yaml
 similarity index 100%
 rename from tests/functional/tests/tests.yaml
 rename to src/tests/functional/tests/tests.yaml
diff --git a/src/tests/unit/requirements.txt b/src/tests/unit/requirements.txt
 new file mode 100644
index 0000000..4ebc8ae
--- /dev/null
+++ b/src/tests/unit/requirements.txt
@@ -0,0 +1 @@
+coverage
diff --git a/src/tox.ini b/src/tox.ini
 new file mode 100644
index 0000000..9cd7d44
--- /dev/null
+++ b/src/tox.ini
@@ -0,0 +1,69 @@
+[tox]
+skipsdist=True
+skip_missing_interpreters = True
+envlist = lint, unit, func
+
+[testenv]
+basepython = python3
+setenv =
+  PYTHONPATH = {toxinidir}:{toxinidir}/lib/:{toxinidir}/hooks/
+passenv =
+  HOME
+  PATH
+  CHARM_BUILD_DIR
+  PYTEST_KEEP_MODEL
+  PYTEST_CLOUD_NAME
+  PYTEST_CLOUD_REGION
+  PYTEST_MODEL
+  MODEL_SETTINGS
+  HTTP_PROXY
+  HTTPS_PROXY
+  NO_PROXY
+  SNAP_HTTP_PROXY
+  SNAP_HTTPS_PROXY
+
+[testenv:lint]
+commands =
+    flake8
+#TODO    black --check --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod)/" .
+deps =
+    black
+    flake8
+    flake8-docstrings
+    flake8-import-order
+    pep8-naming
+    flake8-colors
+
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    .tox,
+    charmhelpers,
+    mod,
+    .build
+
+#max-line-length = 88
+max-complexity = 10
+
+# From previous tox.ini
+max-line-length = 120
+import-order-style = google
+
+[testenv:black]
+commands =
+    black --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod)/" .
+deps =
+    black
+
+[testenv:unit]
+commands =
+    coverage run -m unittest discover -s {toxinidir}/tests/unit -v
+    coverage report --omit tests/*,mod/*,.tox/*
+    coverage html --omit tests/*,mod/*,.tox/*
+deps = -r{toxinidir}/tests/unit/requirements.txt
+
+[testenv:func]
+changedir = {toxinidir}/tests/functional
+commands = functest-run-suite {posargs}
+deps = -r{toxinidir}/tests/functional/requirements.txt
diff --git a/tox.ini b/tox.ini
 deleted file mode 100644
index 1859695..0000000
--- a/tox.ini
+++ /dev/null
@@ -1,65 +0,0 @@
-[tox]
-skipsdist=True
-envlist = unit, functional
-skip_missing_interpreters = True
-
-[testenv]
-basepython = python3
-setenv =
-  PYTHONPATH = .
-passenv =
-  HOME
-  CHARM_BUILD_DIR
-  MODEL_SETTINGS
-
-[testenv:unit]
-commands = pytest -v \
-	    --ignore {toxinidir}/tests/ \
-	    --ignore {toxinidir}/interfaces \
-	    --ignore {toxinidir}/layers \
-	    --cov=lib \
-	    --cov=actions \
-	    --cov-report=term \
-	    --cov-report=annotate:report/unit/coverage-annotated \
-	    --cov-report=html:report/unit/coverage-html \
-	    --html=report/unit/tests/index.html \
-	    --junitxml=report/unit/junit.xml
-deps = -r{toxinidir}/tests/unit_tests/requirements.txt
-       -r{toxinidir}/tests/requirements.txt
-setenv = PYTHONPATH={toxinidir}/lib
-
-[testenv:func]
-changedir = {toxinidir}/tests/functional
-commands = functest-run-suite --keep-model
-deps = -r{toxinidir}/tests/functional/requirements.txt
-
-[testenv:lint]
-commands = flake8 --tee
-deps =
-    flake8
-    flake8-colors
-    flake8-docstrings
-    flake8-import-order
-    pep8-naming
-
-[flake8]
-exclude =
-    .git,
-    __pycache__,
-    .tox,
-    layers,
-    interfaces,
-max-line-length = 120
-max-complexity = 10
-import-order-style = google
-
-[isort]
-order_by_type = true
-from_first = true
-line_length = 120
-
-[pytest]
-markers =
-    deploy: mark deployment tests to allow running w/o redeploy
-filterwarnings = 
-    ignore::DeprecationWarning