Merge ~aluria/charm-sysconfig:makefile-20.08 into charm-sysconfig:master

[Alvaro Uria]

Standardize Makefile and tox.ini

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

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

[Giuseppe Petralia (peppepetra)]

All tests pass (I run make test). Changes look good. Thanks

review: Approve

[Xav Paice (xavpaice)]

lgtm.

review: Approve

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

Change successfully merged at revision 128b6dbe50e5f5f2d460b05e15c64116a61ec3f0

diff --git a/.gitignore b/.gitignore
index 9f8a821..6f1f367 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,32 +1,41 @@
+# Juju files
+.unit-state.db
+.go-cookies
+
+layers/*
+interfaces/*
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
+# Tests files and dir
+.pytest_cache/
+.coverage
+.tox
+report/
+htmlcov/
+
 # Log files
 *.log
 
-.tox/
-.coverage
+# pycharm
+.idea/
 
 # vi
 .*.swp
 
-# pycharm
-.idea/
-.unit-state.db
-src/.unit-state.db
-
 # version data
 repo-info
+version
 
+# Python builds
+deb_dist/
+dist/
 
-# reports
-report/*
-src/report/*
-
-# virtual env
-venv/*
+# Snaps
+*.snap
 
-# builds
-builds/*
\ No newline at end of file
+# Builds
+.build/
\ No newline at end of file
diff --git a/Makefile b/Makefile
index a74bb64..dc0b96f 100644
--- a/Makefile
+++ b/Makefile
@@ -1,59 +1,82 @@
-PROJECTPATH = $(dir $(realpath $(MAKEFILE_LIST)))
-LAYERS_DIR = $(PROJECTPATH)/layers
-INTERFACES_DIR = $(PROJECTPATH)/interfaces
+PYTHON := /usr/bin/python3
 
+PROJECTPATH=$(dir $(realpath $(MAKEFILE_LIST)))
 ifndef CHARM_BUILD_DIR
-    CHARM_BUILD_DIR := $(PROJECTPATH)
-    $(warning Warning CHARM_BUILD_DIR was not set, defaulting to $(CHARM_BUILD_DIR))
+	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, unittests and lint"
-	@echo " make unittest - run the tests defined in the unittest subdirectory"
+	@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
+	# @echo "Cloning submodules"
+	# @git submodule update --init --recursive
+	@echo "No submodules. Skipping"
+
+submodules-update:
+	# @echo "Pulling latest updates for submodules"
+	# @git submodule update --init --recursive --remote --merge
+	@echo "No submodules. Skipping"
+
+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:
-	@echo "Running flake8"
+	@echo "Running lint checks"
 	@cd src && tox -e lint
 
-test: lint unittest functional
+black:
+	@echo "Reformat files with black"
+	@cd src && tox -e black
 
-functional: build
-	@cd src && PYTEST_KEEP_MODEL=$(PYTEST_KEEP_MODEL) \
-	    PYTEST_CLOUD_NAME=$(PYTEST_CLOUD_NAME) \
-	    PYTEST_CLOUD_REGION=$(PYTEST_CLOUD_REGION) \
-	    tox -e functional
+proof:
+	@echo "Running charm proof"
+	@charm proof src
 
-unittest:
+unittests:
+	@echo "Running unit tests"
 	@cd src && tox -e unit
 
-build:
-	@echo "Building charm to base directory $(CHARM_BUILD_DIR)"
-	@-git describe --tags > ./repo-info
-	@CHARM_LAYERS_DIR=$(LAYERS_DIR) CHARM_INTERFACES_DIR=$(INTERFACES_DIR) TERM=linux\
-		charm build --output-dir $(CHARM_BUILD_DIR) $(PROJECTPATH)/src --force
-
-release: clean build
-	@echo "Charm is built at $(CHARM_BUILD_DIR)/builds"
+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"
-	@find $(PROJECTPATH)/src -iname __pycache__ -exec rm -r {} +
-	@if [ -d $(CHARM_BUILD_DIR)/builds ] ; then rm -r $(CHARM_BUILD_DIR)/builds ; fi
-	@if [ -d $(PROJECTPATH)/src/.tox ] ; then rm -r $(PROJECTPATH)/src/.tox ; fi
-	@if [ -d $(PROJECTPATH)/src/.pytest_cache ] ; then rm -r $(PROJECTPATH)/src/.pytest_cache ; fi
+test: lint proof unittests functional
+	@echo "Tests completed for charm ${CHARM_NAME}."
 
 # The targets below don't depend on a file
-.PHONY: lint test unittest functional build release clean help submodules
+.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
diff --git a/src/copyright b/src/copyright
new file mode 100644
index 0000000..c80db95
--- /dev/null
+++ b/src/copyright
@@ -0,0 +1,16 @@
+Format: http://dep.debian.net/deps/dep5/
+
+Files: *
+Copyright: Copyright 2016, Canonical Ltd.
+License: GPL-3
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License version 3, as
+ published by the Free Software Foundation.
+ .
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranties of
+ MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ PURPOSE.  See the GNU General Public License for more details.
+ .
+ You should have received a copy of the GNU General Public License
+ along with this program.  If not, see <http://www.gnu.org/licenses/>.
diff --git a/icon.svg b/src/icon.svg
similarity index 100%
rename from icon.svg
rename to src/icon.svg
diff --git a/src/tests/functional/test_deploy.py b/src/tests/functional/test_deploy.py
index 84b2cd3..68e4f28 100644
--- a/src/tests/functional/test_deploy.py
+++ b/src/tests/functional/test_deploy.py
@@ -14,10 +14,11 @@ import websockets
 pytestmark = pytest.mark.asyncio
 
 charm_build_dir = os.getenv("CHARM_BUILD_DIR", "..").rstrip("/")
+charm_name = os.getenv("CHARM_NAME", "sysconfig")
 
 series = ["focal", "bionic", "xenial"]
 
-sources = [("local", "{}/builds/sysconfig".format(charm_build_dir))]
+sources = [("local", "{}/{}".format(charm_build_dir, charm_name))]
 
 TIMEOUT = 600
 MODEL_ACTIVE_TIMEOUT = 10
diff --git a/src/tox.ini b/src/tox.ini
index f932ee3..129eaca 100644
--- a/src/tox.ini
+++ b/src/tox.ini
@@ -1,41 +1,31 @@
 [tox]
 skipsdist=True
-envlist = unit, functional
 skip_missing_interpreters = True
+envlist = lint, unit, func
 
 [testenv]
 basepython = python3
 setenv =
-  PYTHONPATH = .
-
-[testenv:unit]
-commands = pytest -v --ignore {toxinidir}/tests/functional \
-	   --cov=lib \
-	   --cov=reactive \
-	   --cov=actions \
-	   --cov-report=term \
-	   --cov-report=annotate:report/annotated \
-	   --cov-report=html:report/html
-deps = -r{toxinidir}/tests/unit/requirements.txt
-       -r{toxinidir}/requirements.txt
-setenv = PYTHONPATH={toxinidir}/lib
-
-[testenv:functional]
+  PYTHONPATH = {toxinidir}:{toxinidir}/lib/:{toxinidir}/hooks/
 passenv =
   HOME
-  CHARM_BUILD_DIR
   PATH
+  CHARM_BUILD_DIR
   PYTEST_KEEP_MODEL
   PYTEST_CLOUD_NAME
   PYTEST_CLOUD_REGION
-commands = pytest -v --ignore {toxinidir}/tests/unit
-deps = -r{toxinidir}/tests/functional/requirements.txt
-       -r{toxinidir}/requirements.txt
+  PYTEST_MODEL
+  MODEL_SETTINGS
+  HTTP_PROXY
+  HTTPS_PROXY
+  NO_PROXY
+  SNAP_HTTP_PROXY
+  SNAP_HTTPS_PROXY
 
 [testenv:lint]
 commands =
-    black --check reactive lib tests
     flake8
+    black --check --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod)/" .
 deps =
     black
     flake8
@@ -45,10 +35,37 @@ deps =
     flake8-colors
 
 [flake8]
-ignore = D100,D103  # Missing docstring in public module/function
+ignore = D100,D103
 exclude =
     .git,
     __pycache__,
     .tox,
+    charmhelpers,
+    mod,
+    .build
+
 max-line-length = 88
 max-complexity = 10
+
+[testenv:black]
+commands =
+    black --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod)/" .
+deps =
+    black
+
+[testenv:unit]
+commands =
+  pytest -v --ignore {toxinidir}/tests/functional \
+           --cov=lib \
+           --cov=reactive \
+           --cov=actions \
+           --cov=hooks \
+           --cov=src \
+           --cov-report=term \
+           --cov-report=annotate:report/annotated \
+           --cov-report=html:report/html
+deps = -r{toxinidir}/tests/unit/requirements.txt
+
+[testenv:func]
+commands = pytest -v --ignore {toxinidir}/tests/unit
+deps = -r{toxinidir}/tests/functional/requirements.txt