Merge ~rgildein/charm-prometheus-openstack-exporter:lp2009616 into charm-prometheus-openstack-exporter:master

[Robert Gildein]

remove flag to be able connect multiple Grafana

Removing unnecessary flag so registration of dashboard is triggered
every time if new relation joined.
Functional test was not working with running `make functional`,
because the wrong env variable was used in local-overlay.

[🤖 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:7a549fffc50cec673512e21e80db445d054061cb
https://jenkins.canonical.com/bootstack/job/lp-charm-prometheus-openstack-exporter-ci/1/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-unit/6/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/104/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-prometheus-openstack-exporter-ci/1//rebuild

review: Approve (continuous-integration)

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

Change successfully merged at revision 0e3e426b3c4d2b07f70fd3f3b1ee2b12ffd152dc

diff --git a/Makefile b/Makefile
index 76f44ce..af35fdc 100644
--- a/Makefile
+++ b/Makefile
@@ -1,45 +1,42 @@
+# This is a template `Makefile` file for reactive charms
+# This file is managed by bootstack-charms-spec and should not be modified
+# within individual charm repos. https://launchpad.net/bootstack-charms-spec
+
 PYTHON := /usr/bin/python3
 
 PROJECTPATH=$(dir $(realpath $(MAKEFILE_LIST)))
-ifndef 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
-ifdef CONTAINER
-	BUILD_ARGS="--destructive-mode"
-endif
+CHARM_BUILD_DIR:=${PROJECTPATH}.build
+CHARM_LAYERS_DIR:=${PROJECTPATH}/layers
+CHARM_INTERFACES_DIR:=${PROJECTPATH}/interfaces
+RELEASE_CHANNEL:=edge
 METADATA_FILE="src/metadata.yaml"
-CHARM_NAME=$(shell cat ${PROJECTPATH}/${METADATA_FILE} | grep -E "^name:" | awk '{print $$2}')
+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 dev-environment - setup the development environment"
+	@echo " make pre-commit - run pre-commit checks on all the files"
+	@echo " make submodules - initialize, fetch, and checkout any nested submodules"
 	@echo " make submodules-update - update submodules to latest changes on remote branch"
+	@echo " make clean - remove unneeded files and clean charmcraft environment"
 	@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 release - run clean, build, proof target and upload charm"
+	@echo " make lint - run lint checkers"
+	@echo " make reformat - run lint tools to auto format code"
 	@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 " make test - run lint, unittests and functional targets"
 	@echo ""
 
-clean:
-	@echo "Cleaning files"
-	@git clean -ffXd -e '!.idea'
-	@echo "Cleaning existing build"
-	@rm -rf ${PROJECTPATH}/${CHARM_NAME}.charm
-	@rm -rf ${CHARM_BUILD_DIR}/*
-	@charmcraft clean
+dev-environment:
+	@echo "Creating virtualenv with pre-commit installed"
+	@cd src && tox -r -e dev-environment
+
+pre-commit:
+	@cd src && tox -e pre-commit
 
 submodules:
 	@echo "Cloning submodules"
@@ -49,40 +46,47 @@ 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
+clean:
+	@echo "Cleaning files"
+	@git clean -ffXd -e '!.idea' -e '!.vscode'
+	@echo "Cleaning existing build"
+	@rm -rf ${CHARM_BUILD_DIR}/${CHARM_NAME}
+	@rm -rf ${PROJECTPATH}/${CHARM_NAME}*.charm
+	@echo "Cleaning charmcraft"
+	@charmcraft clean
+
+build: clean
+	@echo "Building charm"
 	@charmcraft -v pack ${BUILD_ARGS}
 	@bash -c ./rename.sh
+
+proof: build
+	@echo "Running charm proof"
 	@mkdir -p ${CHARM_BUILD_DIR}/${CHARM_NAME}
 	@unzip ${PROJECTPATH}/${CHARM_NAME}.charm -d ${CHARM_BUILD_DIR}/${CHARM_NAME}
-
-release: clean build
-	@echo "Charm is built at ${PROJECTPATH}/${CHARM_NAME}.charm"
-	@charmcraft upload ${PROJECTPATH}/${CHARM_NAME}.charm --release edge
+	@charm proof ${CHARM_BUILD_DIR}/${CHARM_NAME}
+release: proof
+	@echo "Releasing charm to ${RELEASE_CHANNEL} channel"
+	@charmcraft upload ${CHARM_NAME}.charm --release ${RELEASE_CHANNEL}
 
 lint:
 	@echo "Running lint checks"
 	@cd src && tox -e lint
 
-black:
-	@echo "Reformat files with black"
-	@cd src && tox -e black
-
-proof: build
-	@echo "Running charm proof"
-	@charm proof ${CHARM_BUILD_DIR}/${CHARM_NAME}
+reformat:
+	@echo "Reformat files with black and isort"
+	@cd src && tox -e reformat
 
 unittests:
 	@echo "Running unit tests"
-	@cd src && tox -e unit
+	@cd src && tox -e unit -- ${UNIT_ARGS}
 
 functional: build
-	@echo "Executing functional tests in ${CHARM_BUILD_DIR}"
-	@cd src && CHARM_BUILD_DIR=${CHARM_BUILD_DIR} tox -e func
+	@echo "Executing functional tests using built charm at ${PROJECTPATH}"
+	@cd src && CHARM_LOCATION=${PROJECTPATH} tox -e func -- ${FUNC_ARGS}
 
 test: lint proof unittests functional
 	@echo "Tests completed for charm ${CHARM_NAME}."
 
 # The targets below don't depend on a file
-.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
+.PHONY: help dev-environment pre-commit submodules submodules-update clean build lint reformat proof unittests functional
diff --git a/charmcraft.yaml b/charmcraft.yaml
index f8312cc..13dc66a 100644
--- a/charmcraft.yaml
+++ b/charmcraft.yaml
@@ -3,7 +3,7 @@ parts:
   charm:
     source: src
     plugin: reactive
-    # using charm/3.x/stable will cause the charm unable to install on 18.04
+    # Using charm/3.x/stable will cause the charm unable to install on 18.04
     # with the following error: "pip requires Python '>=3.7' but the running
     # Python is 3.6.9". This is because charm/3.x/stable start using system
     # installation of python instead of a python snap.
@@ -26,4 +26,3 @@ bases:
           channel: "18.04"
           architectures:
               - amd64
-
diff --git a/src/metadata.yaml b/src/metadata.yaml
index 97a6694..81bec11 100644
--- a/src/metadata.yaml
+++ b/src/metadata.yaml
@@ -4,6 +4,9 @@ summary: Openstack exporter for Prometheus
 description: |
   This is an exporter that exposes information gathered from Openstack
   for use by the Prometheus monitoring system.
+# Series are needed here only because we use charm/2.x/stable, whose linter will fail
+# if it doesn't find series here. Bases in charmcraft.yaml are used instead of series.
+series: []
 tags:
   - openstack
   - monitoring
@@ -23,10 +26,6 @@ provides:
     interface: prometheus-rules
   dashboards:
     interface: grafana-dashboard
-series:
-  - bionic
-  - focal
-  - jammy
 extra-bindings:
   public:
   admin:
diff --git a/src/reactive/openstack_exporter.py b/src/reactive/openstack_exporter.py
index d38dcbe..b3e77d1 100644
--- a/src/reactive/openstack_exporter.py
+++ b/src/reactive/openstack_exporter.py
@@ -129,7 +129,6 @@ def check_reconfig_exporter():
     if data_changed("exporter.config", config):
         set_state("exporter.do-reconfig")
     remove_state("exporter.do-check-reconfig")
-    set_state("exporter.register-dashboards")
 
 
 def convert_from_base64(v):
@@ -316,14 +315,13 @@ def render_prometheus_rules(prometheus_rules):
 
 @when(
     "leadership.is_leader",
+    "prometheus-openstack-exporter-service.available",
     "endpoint.dashboards.joined",
-    "exporter.register-dashboards",
 )
 def register_grafana_dashboards():
     """Register grafana dashboards."""
     grafana_endpoint = endpoint_from_flag("endpoint.dashboards.joined")
     import_grafana_dashboards(grafana_endpoint)
-    remove_state("exporter.register-dashboards")
 
 
 def render_template(template, context):
diff --git a/src/tests/functional/tests/bundles/bionic.yaml b/src/tests/functional/tests/bundles/bionic.yaml
index 64e7bf4..3b18dcc 100644
--- a/src/tests/functional/tests/bundles/bionic.yaml
+++ b/src/tests/functional/tests/bundles/bionic.yaml
@@ -17,6 +17,7 @@ applications:
     num_units: 1
   grafana:
     charm: ch:grafana
+    series: focal
     num_units: 1
 
 relations:
diff --git a/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2 b/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
index 319de18..3a0b4cb 100644
--- a/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
+++ b/src/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
@@ -1,3 +1,3 @@
 applications:
   prometheus-openstack-exporter:
-    charm: "{{ PROJECTPATH }}/{{ charm_name }}.charm"
+    charm: "{{ CHARM_LOCATION }}/{{ charm_name }}.charm"
diff --git a/src/tox.ini b/src/tox.ini
index 361de8b..c8ed14c 100644
--- a/src/tox.ini
+++ b/src/tox.ini
@@ -10,7 +10,7 @@ setenv =
 passenv =
   HOME
   PATH
-  CHARM_BUILD_DIR
+  CHARM_*
   PYTEST_KEEP_MODEL
   PYTEST_CLOUD_NAME
   PYTEST_CLOUD_REGION
@@ -21,16 +21,7 @@ passenv =
   NO_PROXY
   SNAP_HTTP_PROXY
   SNAP_HTTPS_PROXY
-  OS_REGION_NAME
-  OS_AUTH_VERSION
-  OS_AUTH_URL
-  OS_PROJECT_DOMAIN_NAME
-  OS_USERNAME
-  OS_PASSWORD
-  OS_PROJECT_ID
-  OS_USER_DOMAIN_NAME
-  OS_PROJECT_NAME
-  OS_IDENTITY_API_VERSION
+  OS_*
 
 [testenv:lint]
 commands =