Merge ~vultaire/charm-elasticsearch:makefile-20.08 into charm-elasticsearch:master

[Paul Goins]

Makefile reworks

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

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

[Xav Paice (xavpaice)]

LGTM

review: Approve

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

Change successfully merged at revision f40a19ab29181f778500d52eabaed251110c0f31

diff --git a/.gitignore b/.gitignore
index a9bc955..6f1f367 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,13 +1,41 @@
-bin/*
-.tox/
-__pycache/
-*.pyc
-files/*
-revision
-exec.d
-local.yaml
+# Juju files
+.unit-state.db
+.go-cookies
 
-repo-info
+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
+
+# pycharm
 .idea/
-*.pyc
-__pycache__
+
+# vi
+.*.swp
+
+# version data
+repo-info
+version
+
+# Python builds
+deb_dist/
+dist/
+
+# Snaps
+*.snap
+
+# Builds
+.build/
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 8a16beb..7e1e684 100644
--- a/Makefile
+++ b/Makefile
@@ -1,42 +1,75 @@
-#!/usr/bin/make
-PYTHON := /usr/bin/env python3
-CHARM_HELPERS = charm-helpers/.gitignore
 PYTHON := /usr/bin/python3
-export PYTHONPATH := hooks
-PROJECTPATH = $(dir $(realpath $(MAKEFILE_LIST)))
-METADATA_FILE = "metadata.yaml"
-CHARM_NAME = $(shell cat ${PROJECTPATH}/${METADATA_FILE} | grep -E '^name:' | awk '{print $$2}')
+
+PROJECTPATH=$(dir $(realpath $(MAKEFILE_LIST)))
 ifndef CHARM_BUILD_DIR
-    CHARM_BUILD_DIR := /tmp/charm-builds
-    $(warning Warning CHARM_BUILD_DIR was not set, defaulting to $(CHARM_BUILD_DIR))
+	CHARM_BUILD_DIR=${PROJECTPATH}.build
 endif
+METADATA_FILE="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 submodules-update - update submodules to latest changes on remote branch"
+	@echo " make build - build the charm"
+	@echo " make release - run clean 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 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 base directory ${CHARM_BUILD_DIR}/${CHARM_NAME}"
+	@-git rev-parse --abbrev-ref HEAD > ./repo-info
+	@-git describe --always > ./version
+	@mkdir -p ${CHARM_BUILD_DIR}/${CHARM_NAME}
+	@cp -a ./* ${CHARM_BUILD_DIR}/${CHARM_NAME}
 
-build: test
-	@echo "Building charm to base directory $(CHARM_BUILD_DIR)/$(CHARM_NAME)"
-	@-git describe --tags > ./repo-info
-	@mkdir -p $(CHARM_BUILD_DIR)/$(CHARM_NAME)
-	@cp -r * $(CHARM_BUILD_DIR)/$(CHARM_NAME)
+release: clean build
+	@echo "Charm is built at ${CHARM_BUILD_DIR}/${CHARM_NAME}"
 
-lint: $(CHARM_HELPERS)
-	@tox -e pep8
-	@charm proof
+lint:
+	@echo "Running lint checks"
+	@tox -e lint
 
-test: $(CHARM_HELPERS)
-	@echo Starting unit tests...
-	@tox -e py3
+black:
+	@echo "Reformat files with black"
+	@tox -e black
 
-deploy:
-	@echo Deploying local elasticsearch charm
-	@juju deploy --num-units=2 --repository=../.. local:trusty/elasticsearch
+proof:
+	@echo "Running charm proof"
+	@-charm proof
 
-health:
-	juju ssh elasticsearch/0 "curl http://localhost:9200/_cluster/health?pretty=true"
+unittests:
+	@echo "Running unit tests"
+	@tox -e unit
 
-.PHONY: sync-charm-helpers-stable
-sync-charm-helpers-stable: $(CHARM_HELPERS)
+functional: build
+	@echo "Executing functional tests in ${CHARM_BUILD_DIR}"
+	@CHARM_BUILD_DIR=${CHARM_BUILD_DIR} tox -e func
 
-$(CHARM_HELPERS): .gitmodules
-	@git submodule update --init
+test: lint proof unittests functional
+	@echo "Charm ${CHARM_NAME} has been tested"
 
-sync-charm-helpers-master:
-	@git submodule foreach git pull origin master
+# The targets below don't depend on a file
+.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
diff --git a/bin/wait_for_peer.py b/bin/wait_for_peer.py
index bffd549..fbefcbc 100755
--- a/bin/wait_for_peer.py
+++ b/bin/wait_for_peer.py
@@ -13,10 +13,10 @@ logging.basicConfig(
     format="%(asctime)s [%(levelname)s] %(message)s",
 )
 
-import requests
+import requests  # noqa: E402
 
 sys.path.append(os.path.abspath("charm-helpers"))
-from charmhelpers.core.host import service_restart
+from charmhelpers.core.host import service_restart   # noqa: E402
 
 
 CONNECTION_TIMEOUT = 5
diff --git a/tests/functional/requirements.txt b/tests/functional/requirements.txt
new file mode 100644
index 0000000..16c7715
--- /dev/null
+++ b/tests/functional/requirements.txt
@@ -0,0 +1,2 @@
+git+https://github.com/openstack-charmers/zaza.git#egg=zaza
+
diff --git a/unit_tests/__init__.py b/tests/unit/__init__.py
similarity index 100%
rename from unit_tests/__init__.py
rename to tests/unit/__init__.py
diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt
new file mode 100644
index 0000000..e4de175
--- /dev/null
+++ b/tests/unit/requirements.txt
@@ -0,0 +1,3 @@
+PyYAML
+mock
+coverage
diff --git a/unit_tests/test_hooks.py b/tests/unit/test_hooks.py
similarity index 100%
rename from unit_tests/test_hooks.py
rename to tests/unit/test_hooks.py
diff --git a/tox.ini b/tox.ini
index 254230c..68de47d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,17 +1,69 @@
 [tox]
-envlist = py3,pep8
-skipsdist = True
+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 =
-    -rrequirements.txt
-    -rtest-requirements.txt
+    black
+    flake8
+#    flake8-docstrings
+#    flake8-import-order
+#    pep8-naming
+    flake8-colors
+
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    .tox,
+    charm-helpers,  # not part of template but needed for now
+    charmhelpers,
+    mod,
+    .build
+
+#max-line-length = 88
+max-complexity = 10
 
-[testenv:py3]
+# From old tox.ini
+max-line-length = 120
+
+[testenv:black]
 commands =
-    python -m unit_tests.test_hooks
+    black --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod)/" .
+deps =
+    black
 
-[testenv:pep8]
+[testenv:unit]
 commands =
-    python -m pycodestyle --verbose --max-line-length=120 --exclude hooks/charmhelpers hooks unit_tests
+    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