Merge ~xavpaice/charm-prometheus-blackbox-exporter:dev/q2-20 into charm-prometheus-blackbox-exporter:master

[Xav Paice]

[Xav Paice (xavpaice)]

Passed lint test, but unit tests are failing with https://pastebin.canonical.com/p/9tnFBtWrd8/, even after I'd added the report dir mentioned in the README. This is a sizable change, and while I appreciate that this is introducing tests where there were none, it would be good to be able to pass the tests introduced and know the change is good. It's likely that there's something on my test env that's different to the author's, which we should be able to document or, better, add to the Makefile etc.

From what I can see so far, the rest of the change looks good.

review: Needs Fixing

[Xav Paice (xavpaice)]

I've updated the change with a commit that works for functional testing and lint, and also renames the charm code itself to a name that doesn't have - (because Python).

My review now is of course a +1, but need someone else to look at it now.

[Xav Paice (xavpaice)]

Note: there's no unit tests as yet.

[Paul Goins (vultaire)]

Overall, this looks good.

I have a few comments, the most important likely being about the license, which I think requires attention. The others are things I think should be fixed but aren't really that important.

review: Needs Fixing

[Xav Paice (xavpaice)]

I've updated the commit with updates for the catches - entirely removed unit tests (since they're not actually present), updated license to GPLv3, and removed the totally unused flag.

[Paul Goins (vultaire)]

Approved!

review: Approve

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..2dc89c9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,24 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Log files
+*.log
+.tox/
+.coverage
+
+# vi
+.*.swp
+
+# pycharm
+.idea/
+
+# version data
+repo-info
+
+# reports
+report/*
+
+# layers
+layers/*
\ No newline at end of file
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..949713b
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,48 @@
+ifndef CHARM_BUILD_DIR
+    CHARM_BUILD_DIR=/tmp/builds
+endif
+
+help:
+	@echo "This project supports the following targets"
+	@echo ""
+	@echo " make help - show this text"
+	@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 functional - run the tests defined in the functional subdirectory"
+	@echo " make release - build the charm"
+	@echo " make clean - remove unneeded files"
+	@echo ""
+
+submodules:
+	@echo "Cloning submodules"
+	@git submodule update --init --recursive
+
+lint:
+	@mkdir -p report/lint/
+	@echo "Running flake8"
+	@tox -e lint
+
+test: lint functional
+
+functional: build
+	@echo Executing with: CHARM_BUILD_DIR=$(CHARM_BUILD_DIR) tox -e func
+	@CHARM_BUILD_DIR=$(CHARM_BUILD_DIR) tox -e func
+
+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
+
+release: clean build
+	@echo "Charm is built at $(CHARM_BUILD_DIR)/prometheus-blackbox-exporter"
+
+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 {} +
+
+# The targets below don't depend on a file
+.PHONY: lint test functional build release clean help submodules
diff --git a/README.md b/README.md
index 58725ef..ffde3eb 100644
--- a/README.md
+++ b/README.md
@@ -16,3 +16,36 @@ you can update the charm's configuration using:
 To confirm configuration was set:
 
     juju config prometheus-blackbox-exporter
+
+## Testing
+
+# This directory needs to be create in the charm path prior to testing
+```
+mkdir -p report/lint
+```
+
+## Deployment
+
+# To avail of the metrics in grafana the following steps can be used
+```
+juju deploy grafana
+juju deploy prometheus2
+juju add-relation prometheus-blackbox-exporter:scrape prometheus2:target
+juju add-relation prometheus-blackbox-exporter:dashboards grafana:dashboards
+```
+
+# To setup reporting with nagios
+```
+juju deploy nrpe
+juju add-relation prometheus-blackbox-exporter:nrpe-external-master  nrpe:nrpe-external-master
+```
+
+# Change or update dashboards
+```
+# To provide your own dashboards, create a zip file and attach it as a resource 
+zip grafana-dashboards.zip blackbox-simple.json blackbox-advanced.json
+juju attach-resource prometheus-blackbox-exporter dashboards=./grafana-dashboards.zip
+```
+
+# Contact Information
+- Charm bugs: https://bugs.launchpad.net/charm-prometheus-blackbox-exporter
diff --git a/config.yaml b/config.yaml
index d1dc24d..2f5db13 100644
--- a/config.yaml
+++ b/config.yaml
@@ -5,6 +5,20 @@ options:
     description: |
         If install_method is set to "snap" this option controlls channel name.
         Supported values are: "stable", "candidate", "beta" and "edge"
+  nagios_context:
+    default: "juju"
+    type: string
+    description: |
+      A string that will be prepended to instance name to set the host name
+      in nagios. So for instance the hostname would be something like:
+        juju-myservice-0
+      If you're running multiple environments with the same services in them
+      this allows you to differentiate between them.
+  nagios_servicegroups:
+    default: "juju"
+    type: string
+    description: |
+      Comma separated list of nagios servicegroups
   modules:
     default: |
       http_2xx:
diff --git a/copyright b/copyright
new file mode 100644
index 0000000..8dddbf0
--- /dev/null
+++ b/copyright
@@ -0,0 +1,17 @@
+Format: http://dep.debian.net/deps/dep5/
+
+Files: *
+Copyright: Copyright 2012-2018, Canonical Ltd., All Rights Reserved.
+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 as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+ .
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY 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/icon.svg
new file mode 100644
index 0000000..96a5d0c
--- /dev/null
+++ b/icon.svg
@@ -0,0 +1,279 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:xlink="http://www.w3.org/1999/xlink"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="96"
+   height="96"
+   id="svg6517"
+   version="1.1"
+   inkscape:version="0.48+devel r12274"
+   sodipodi:docname="Juju_charm_icon_template.svg">
+  <defs
+     id="defs6519">
+    <linearGradient
+       inkscape:collect="always"
+       xlink:href="#Background"
+       id="linearGradient6461"
+       gradientUnits="userSpaceOnUse"
+       x1="0"
+       y1="970.29498"
+       x2="144"
+       y2="970.29498"
+       gradientTransform="matrix(0,-0.66666669,0.6660448,0,-866.25992,731.29077)" />
+    <linearGradient
+       id="Background">
+      <stop
+         id="stop4178"
+         offset="0"
+         style="stop-color:#b8b8b8;stop-opacity:1" />
+      <stop
+         id="stop4180"
+         offset="1"
+         style="stop-color:#c9c9c9;stop-opacity:1" />
+    </linearGradient>
+    <filter
+       style="color-interpolation-filters:sRGB;"
+       inkscape:label="Inner Shadow"
+       id="filter1121">
+      <feFlood
+         flood-opacity="0.59999999999999998"
+         flood-color="rgb(0,0,0)"
+         result="flood"
+         id="feFlood1123" />
+      <feComposite
+         in="flood"
+         in2="SourceGraphic"
+         operator="out"
+         result="composite1"
+         id="feComposite1125" />
+      <feGaussianBlur
+         in="composite1"
+         stdDeviation="1"
+         result="blur"
+         id="feGaussianBlur1127" />
+      <feOffset
+         dx="0"
+         dy="2"
+         result="offset"
+         id="feOffset1129" />
+      <feComposite
+         in="offset"
+         in2="SourceGraphic"
+         operator="atop"
+         result="composite2"
+         id="feComposite1131" />
+    </filter>
+    <filter
+       style="color-interpolation-filters:sRGB;"
+       inkscape:label="Drop Shadow"
+       id="filter950">
+      <feFlood
+         flood-opacity="0.25"
+         flood-color="rgb(0,0,0)"
+         result="flood"
+         id="feFlood952" />
+      <feComposite
+         in="flood"
+         in2="SourceGraphic"
+         operator="in"
+         result="composite1"
+         id="feComposite954" />
+      <feGaussianBlur
+         in="composite1"
+         stdDeviation="1"
+         result="blur"
+         id="feGaussianBlur956" />
+      <feOffset
+         dx="0"
+         dy="1"
+         result="offset"
+         id="feOffset958" />
+      <feComposite
+         in="SourceGraphic"
+         in2="offset"
+         operator="over"
+         result="composite2"
+         id="feComposite960" />
+    </filter>
+    <clipPath
+       clipPathUnits="userSpaceOnUse"
+       id="clipPath873">
+      <g
+         transform="matrix(0,-0.66666667,0.66604479,0,-258.25992,677.00001)"
+         id="g875"
+         inkscape:label="Layer 1"
+         style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline">
+        <path
+           style="fill:#ff00ff;fill-opacity:1;stroke:none;display:inline"
+           d="m 46.702703,898.22775 50.594594,0 C 138.16216,898.22775 144,904.06497 144,944.92583 l 0,50.73846 c 0,40.86071 -5.83784,46.69791 -46.702703,46.69791 l -50.594594,0 C 5.8378378,1042.3622 0,1036.525 0,995.66429 L 0,944.92583 C 0,904.06497 5.8378378,898.22775 46.702703,898.22775 Z"
+           id="path877"
+           inkscape:connector-curvature="0"
+           sodipodi:nodetypes="sssssssss" />
+      </g>
+    </clipPath>
+    <filter
+       inkscape:collect="always"
+       id="filter891"
+       inkscape:label="Badge Shadow">
+      <feGaussianBlur
+         inkscape:collect="always"
+         stdDeviation="0.71999962"
+         id="feGaussianBlur893" />
+    </filter>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="4.0745362"
+     inkscape:cx="18.514671"
+     inkscape:cy="49.018169"
+     inkscape:document-units="px"
+     inkscape:current-layer="layer1"
+     showgrid="true"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:window-width="1920"
+     inkscape:window-height="1029"
+     inkscape:window-x="0"
+     inkscape:window-y="24"
+     inkscape:window-maximized="1"
+     showborder="true"
+     showguides="true"
+     inkscape:guide-bbox="true"
+     inkscape:showpageshadow="false">
+    <inkscape:grid
+       type="xygrid"
+       id="grid821" />
+    <sodipodi:guide
+       orientation="1,0"
+       position="16,48"
+       id="guide823" />
+    <sodipodi:guide
+       orientation="0,1"
+       position="64,80"
+       id="guide825" />
+    <sodipodi:guide
+       orientation="1,0"
+       position="80,40"
+       id="guide827" />
+    <sodipodi:guide
+       orientation="0,1"
+       position="64,16"
+       id="guide829" />
+  </sodipodi:namedview>
+  <metadata
+     id="metadata6522">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="BACKGROUND"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(268,-635.29076)"
+     style="display:inline">
+    <path
+       style="fill:url(#linearGradient6461);fill-opacity:1;stroke:none;display:inline;filter:url(#filter1121)"
+       d="m -268,700.15563 0,-33.72973 c 0,-27.24324 3.88785,-31.13513 31.10302,-31.13513 l 33.79408,0 c 27.21507,0 31.1029,3.89189 31.1029,31.13513 l 0,33.72973 c 0,27.24325 -3.88783,31.13514 -31.1029,31.13514 l -33.79408,0 C -264.11215,731.29077 -268,727.39888 -268,700.15563 Z"
+       id="path6455"
+       inkscape:connector-curvature="0"
+       sodipodi:nodetypes="sssssssss" />
+  </g>
+  <g
+     inkscape:groupmode="layer"
+     id="layer3"
+     inkscape:label="PLACE YOUR PICTOGRAM HERE"
+     style="display:inline" />
+  <g
+     inkscape:groupmode="layer"
+     id="layer2"
+     inkscape:label="BADGE"
+     style="display:none"
+     sodipodi:insensitive="true">
+    <g
+       style="display:inline"
+       transform="translate(-340.00001,-581)"
+       id="g4394"
+       clip-path="none">
+      <g
+         id="g855">
+        <g
+           inkscape:groupmode="maskhelper"
+           id="g870"
+           clip-path="url(#clipPath873)"
+           style="opacity:0.6;filter:url(#filter891)">
+          <path
+             transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-237.54282)"
+             d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"
+             sodipodi:ry="12"
+             sodipodi:rx="12"
+             sodipodi:cy="552.36218"
+             sodipodi:cx="252"
+             id="path844"
+             style="color:#000000;fill:#000000;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             sodipodi:type="arc" />
+        </g>
+        <g
+           id="g862">
+          <path
+             sodipodi:type="arc"
+             style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             id="path4398"
+             sodipodi:cx="252"
+             sodipodi:cy="552.36218"
+             sodipodi:rx="12"
+             sodipodi:ry="12"
+             d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"
+             transform="matrix(1.4999992,0,0,1.4999992,-29.999795,-238.54282)" />
+          <path
+             transform="matrix(1.25,0,0,1.25,33,-100.45273)"
+             d="m 264,552.36218 a 12,12 0 1 1 -24,0 A 12,12 0 1 1 264,552.36218 Z"
+             sodipodi:ry="12"
+             sodipodi:rx="12"
+             sodipodi:cy="552.36218"
+             sodipodi:cx="252"
+             id="path4400"
+             style="color:#000000;fill:#dd4814;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:4;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             sodipodi:type="arc" />
+          <path
+             sodipodi:type="star"
+             style="color:#000000;fill:#f5f5f5;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:3;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
+             id="path4459"
+             sodipodi:sides="5"
+             sodipodi:cx="666.19574"
+             sodipodi:cy="589.50385"
+             sodipodi:r1="7.2431178"
+             sodipodi:r2="4.3458705"
+             sodipodi:arg1="1.0471976"
+             sodipodi:arg2="1.6755161"
+             inkscape:flatsided="false"
+             inkscape:rounded="0.1"
+             inkscape:randomized="0"
+             d="m 669.8173,595.77657 c -0.39132,0.22593 -3.62645,-1.90343 -4.07583,-1.95066 -0.44938,-0.0472 -4.05653,1.36297 -4.39232,1.06062 -0.3358,-0.30235 0.68963,-4.03715 0.59569,-4.47913 -0.0939,-0.44198 -2.5498,-3.43681 -2.36602,-3.8496 0.18379,-0.41279 4.05267,-0.59166 4.44398,-0.81759 0.39132,-0.22593 2.48067,-3.48704 2.93005,-3.4398 0.44938,0.0472 1.81505,3.67147 2.15084,3.97382 0.3358,0.30236 4.08294,1.2817 4.17689,1.72369 0.0939,0.44198 -2.9309,2.86076 -3.11469,3.27355 C 669.9821,591.68426 670.20862,595.55064 669.8173,595.77657 Z"
+             transform="matrix(1.511423,-0.16366377,0.16366377,1.511423,-755.37346,-191.93651)" />
+        </g>
+      </g>
+    </g>
+  </g>
+</svg>
diff --git a/layer.yaml b/layer.yaml
index ddd95fc..52f61b2 100644
--- a/layer.yaml
+++ b/layer.yaml
@@ -1,5 +1,10 @@
-includes: ['layer:basic', 'interface:http', 'layer:snap']
-repo: 'https://git.launchpad.net/prometheus-blackbox-exporter-charm'
+includes: 
+  - layer:basic
+  - interface:http
+  - layer:snap
+  - interface:nrpe-external-master
+  - interface:grafana-dashboard
+repo: https://git.launchpad.net/prometheus-blackbox-exporter-charm
 ignore: ['.*.swp' ]
 options:
   basic:
diff --git a/metadata.yaml b/metadata.yaml
index 831b6aa..6a9436b 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -14,3 +14,14 @@ subordinate: false
 provides:
   blackbox-exporter:
     interface: http
+  nrpe-external-master:
+    interface: nrpe-external-master
+    scope: container
+  dashboards:
+    interface: grafana-dashboard
+resources:
+  dashboards:
+    type: file
+    filename: grafana-dashboards.zip
+    description:
+      Zip file to provide grafana dashboards
diff --git a/reactive/prometheus-blackbox-exporter.py b/reactive/prometheus_blackbox_exporter.py
similarity index 60%
rename from reactive/prometheus-blackbox-exporter.py
rename to reactive/prometheus_blackbox_exporter.py
index 2da0bed..eb4677d 100644
--- a/reactive/prometheus-blackbox-exporter.py
+++ b/reactive/prometheus_blackbox_exporter.py
@@ -1,18 +1,30 @@
-import yaml
+#!/usr/bin/python3
+"""Installs and configures prometheus-blackbox-exporter."""
+
+import os
+from pathlib import Path
+import shutil
+from zipfile import BadZipFile, ZipFile
 
-from charmhelpers.core import host, hookenv
+from charmhelpers.contrib.charmsupport import nrpe
+from charmhelpers.core import hookenv, host
 from charmhelpers.core.templating import render
+from charms.layer import snap
 from charms.reactive import (
+    endpoint_from_flag,
     endpoint_from_name,
+    hook,
     remove_state,
     set_state,
     when,
+    when_all,
     when_not,
 )
 from charms.reactive.helpers import any_file_changed, data_changed
-from charms.layer import snap
+import yaml
 
 
+DASHBOARD_PATH = os.getcwd() + '/templates/'
 SNAP_NAME = 'prometheus-blackbox-exporter'
 SVC_NAME = 'snap.prometheus-blackbox-exporter.daemon'
 PORT_DEF = 9115
@@ -21,11 +33,13 @@ CONF_FILE_PATH = '/var/snap/prometheus-blackbox-exporter/current/blackbox.yml'
 
 
 def templates_changed(tmpl_list):
+    """Return list of changed files."""
     return any_file_changed(['templates/{}'.format(x) for x in tmpl_list])
 
 
 @when_not('blackbox-exporter.installed')
 def install_packages():
+    """Installs the snap exporter."""
     hookenv.status_set('maintenance', 'Installing software')
     config = hookenv.config()
     channel = config.get('snap_channel', 'stable')
@@ -34,11 +48,21 @@ def install_packages():
     set_state('blackbox-exporter.do-check-reconfig')
 
 
+@hook('upgrade-charm')
+def upgrade():
+    """Reset the install state on upgrade, to ensure resource extraction."""
+    hookenv.status_set('maintenance', 'Charm upgrade in progress')
+    update_dashboards_from_resource()
+    set_state('blackbox-exporter.do-restart')
+
+
 def get_modules():
+    """Load the modules."""
     config = hookenv.config()
     try:
         modules = yaml.safe_load(config.get('modules'))
-    except:
+    except yaml.YAMLError as error:
+        hookenv.log('Failed to load modules, error {}'.format(error))
         return None
 
     if 'modules' in modules:
@@ -50,6 +74,7 @@ def get_modules():
 @when('blackbox-exporter.installed')
 @when('blackbox-exporter.do-reconfig-yaml')
 def write_blackbox_exporter_config_yaml():
+    """Render the template."""
     modules = get_modules()
     render(source=BLACKBOX_EXPORTER_YML_TMPL,
            target=CONF_FILE_PATH,
@@ -62,11 +87,13 @@ def write_blackbox_exporter_config_yaml():
 
 @when('blackbox-exporter.started')
 def check_config():
+    """Check the config once started."""
     set_state('blackbox-exporter.do-check-reconfig')
 
 
 @when('blackbox-exporter.do-check-reconfig')
 def check_reconfig_blackbox_exporter():
+    """Configure the exporter."""
     config = hookenv.config()
 
     if data_changed('blackbox-exporter.config', config):
@@ -80,6 +107,7 @@ def check_reconfig_blackbox_exporter():
 
 @when('blackbox-exporter.do-restart')
 def restart_blackbox_exporter():
+    """Restart the exporter."""
     if not host.service_running(SVC_NAME):
         hookenv.log('Starting {}...'.format(SVC_NAME))
         host.service_start(SVC_NAME)
@@ -93,7 +121,98 @@ def restart_blackbox_exporter():
 
 # Relations
 @when('blackbox-exporter.started')
-@when('blackbox-exporter.available') # Relation name is "blackbox-exporter"
+@when('blackbox-exporter.available')
 def configure_blackbox_exporter_relation():
+    """Configure the http relation."""
     target = endpoint_from_name('blackbox-exporter')
     target.configure(PORT_DEF)
+    remove_state('blackbox-exporter.configured')
+
+
+@when('nrpe-external-master.changed')
+def nrpe_changed():
+    """Trigger nrpe update."""
+    remove_state('blackbox-exporter.configured')
+
+
+@when('blackbox-exporter.changed')
+def prometheus_changed():
+    """Trigger prometheus update."""
+    remove_state('blackbox-exporter.configured')
+
+
+@when('nrpe-external-master.available')
+@when_not('blackbox-exporter.configured')
+def update_nrpe_config(svc):
+    """Configure the nrpe check for the service."""
+    if not os.path.exists('/var/lib/nagios'):
+        hookenv.status_set('blocked', 'Waiting for nrpe package installation')
+        return
+
+    hookenv.status_set('maintenance', 'Configuring nrpe checks')
+
+    hostname = nrpe.get_nagios_hostname()
+    nrpe_setup = nrpe.NRPE(hostname=hostname)
+    nrpe_setup.add_check(shortname='prometheus_blackbox_exporter_http',
+                         check_cmd='check_http -I 127.0.0.1 -p {} -u /metrics'.format(PORT_DEF),
+                         description='Prometheus blackbox Exporter HTTP check')
+    nrpe_setup.write()
+    hookenv.status_set('active', 'Ready')
+    set_state('blackbox-exporter.configured')
+
+
+@when('blackbox-exporter.configured')
+@when_not('nrpe-external-master.available')
+def remove_nrpe_check():
+    """Remove the nrpe check."""
+    hostname = nrpe.get_nagios_hostname()
+    nrpe_setup = nrpe.NRPE(hostname=hostname)
+    nrpe_setup.remove_check(shortname="prometheus_blackbox_exporter_http")
+    remove_state('blackbox-exporter.configured')
+
+
+@when_all('endpoint.dashboards.joined')
+def register_grafana_dashboards():
+    """After joining to grafana, push the dashboard."""
+    grafana_endpoint = endpoint_from_flag('endpoint.dashboards.joined')
+
+    if grafana_endpoint is None:
+        return
+
+    hookenv.log('Grafana relation joined, push dashboard')
+
+    # load pre-distributed dashboards, that may havew been overwritten by resource
+    dash_dir = Path(DASHBOARD_PATH)
+    for dash_file in dash_dir.glob('*.json'):
+        dashboard = dash_file.read_text()
+        grafana_endpoint.register_dashboard(dash_file.stem, dashboard)
+        hookenv.log('Pushed {}'.format(dash_file))
+
+
+def update_dashboards_from_resource():
+    """Extract resource zip file into templates directory."""
+    dashboards_zip_resource = hookenv.resource_get('dashboards')
+    if not dashboards_zip_resource:
+        hookenv.log('No dashboards resource found', hookenv.DEBUG)
+        # no dashboards zip found, go with the default distributed dashboard
+        return
+
+    hookenv.log('Installing dashboards from resource', hookenv.DEBUG)
+    try:
+        shutil.copy(dashboards_zip_resource, DASHBOARD_PATH)
+    except IOError as error:
+        hookenv.log('Problem copying resource: {}'.format(error), hookenv.ERROR)
+        return
+
+    try:
+        with ZipFile(dashboards_zip_resource, 'r') as zipfile:
+            zipfile.extractall(path=DASHBOARD_PATH)
+            hookenv.log('Extracted dashboards from resource', hookenv.DEBUG)
+    except BadZipFile as error:
+        hookenv.log('BadZipFile: {}'.format(error), hookenv.ERROR)
+        return
+    except PermissionError as error:
+        hookenv.log('Unable to unzip the provided resource: {}'.format(error), hookenv.ERROR)
+        return
+
+    register_grafana_dashboards()
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..1713f68
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+# Include python requirements here
\ No newline at end of file
diff --git a/tests/functional/requirements.txt b/tests/functional/requirements.txt
new file mode 100644
index 0000000..b7c9112
--- /dev/null
+++ b/tests/functional/requirements.txt
@@ -0,0 +1 @@
+git+https://github.com/openstack-charmers/zaza.git#egg=zaza
diff --git a/tests/functional/tests/__init__.py b/tests/functional/tests/__init__.py
new file mode 100644
index 0000000..d236d73
--- /dev/null
+++ b/tests/functional/tests/__init__.py
@@ -0,0 +1 @@
+"""Zaza tests."""
diff --git a/tests/functional/tests/bundles/bionic.yaml b/tests/functional/tests/bundles/bionic.yaml
new file mode 100644
index 0000000..4b510f1
--- /dev/null
+++ b/tests/functional/tests/bundles/bionic.yaml
@@ -0,0 +1,16 @@
+series: bionic
+applications:
+  prometheus-blackbox-exporter:
+    options:
+      snap_channel: stable
+    num_units: 1
+  nrpe:
+    charm: cs:nrpe
+  prometheus:
+    charm: cs:prometheus2
+    num_units: 1
+relations:
+  - - prometheus-blackbox-exporter:nrpe-external-master
+    - nrpe:nrpe-external-master
+  - - prometheus-blackbox-exporter:blackbox-exporter
+    - prometheus:target
\ No newline at end of file
diff --git a/tests/functional/tests/bundles/focal.yaml b/tests/functional/tests/bundles/focal.yaml
new file mode 100644
index 0000000..2f3dc6c
--- /dev/null
+++ b/tests/functional/tests/bundles/focal.yaml
@@ -0,0 +1,16 @@
+series: focal
+applications:
+  prometheus-blackbox-exporter:
+    options:
+      snap_channel: stable
+    num_units: 1
+  nrpe:
+    charm: cs:nrpe
+  prometheus:
+    charm: cs:prometheus2
+    num_units: 1
+relations:
+  - - prometheus-blackbox-exporter:nrpe-external-master
+    - nrpe:nrpe-external-master
+  - - prometheus-blackbox-exporter:blackbox-exporter
+    - prometheus:target
\ No newline at end of file
diff --git a/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2 b/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
new file mode 100644
index 0000000..df81abd
--- /dev/null
+++ b/tests/functional/tests/bundles/overlays/local-charm-overlay.yaml.j2
@@ -0,0 +1,3 @@
+applications:
+  prometheus-blackbox-exporter:
+    charm: "{{ CHARM_BUILD_DIR }}/{{ charm_name }}"
diff --git a/tests/functional/tests/bundles/xenial.yaml b/tests/functional/tests/bundles/xenial.yaml
new file mode 100644
index 0000000..be4f6dc
--- /dev/null
+++ b/tests/functional/tests/bundles/xenial.yaml
@@ -0,0 +1,16 @@
+series: xenial
+applications:
+  prometheus-blackbox-exporter:
+    options:
+      snap_channel: stable
+    num_units: 1
+  nrpe:
+    charm: cs:nrpe
+  prometheus:
+    charm: cs:prometheus2
+    num_units: 1
+relations:
+  - - prometheus-blackbox-exporter:nrpe-external-master
+    - nrpe:nrpe-external-master
+  - - prometheus-blackbox-exporter:blackbox-exporter
+    - prometheus:target
\ No newline at end of file
diff --git a/tests/functional/tests/test_prometheus_blackbox_exporter.py b/tests/functional/tests/test_prometheus_blackbox_exporter.py
new file mode 100644
index 0000000..b02154b
--- /dev/null
+++ b/tests/functional/tests/test_prometheus_blackbox_exporter.py
@@ -0,0 +1,78 @@
+"""Encapsulate prometheus-blackbox-exporter testing."""
+import logging
+import time
+import unittest
+
+import zaza.model as model
+
+
+CURL_TIMEOUT = 180
+REQ_TIMEOUT = 12
+DEFAULT_API_PORT = "9115"
+DEFAULT_API_URL = "/metrics"
+
+
+class BasePrometheusBlackboxExporterTest(unittest.TestCase):
+    """Base for Prometheus-blackbox-exporter charm tests."""
+
+    @classmethod
+    def setUpClass(cls):
+        """Set up tests."""
+        super(BasePrometheusBlackboxExporterTest, cls).setUpClass()
+        cls.model_name = model.get_juju_model()
+        cls.application_name = "prometheus-blackbox-exporter"
+        cls.lead_unit_name = model.get_lead_unit_name(
+            cls.application_name, model_name=cls.model_name
+        )
+        cls.units = model.get_units(
+            cls.application_name, model_name=cls.model_name
+        )
+        cls.prometheus_blackbox_exporter_ip = model.get_app_ips(cls.application_name)[0]
+
+
+class CharmOperationTest(BasePrometheusBlackboxExporterTest):
+    """Verify operations."""
+
+    def test_01_api_ready(self):
+        """Verify if the API is ready.
+
+        Curl the api endpoint.
+        We'll retry until the CURL_TIMEOUT.
+        """
+        curl_command = "curl http://localhost:{}/metrics".format(DEFAULT_API_PORT)
+        timeout = time.time() + CURL_TIMEOUT
+        while time.time() < timeout:
+            response = model.run_on_unit(self.lead_unit_name, curl_command)
+            if response["Code"] == "0":
+                return
+            logging.warning(
+                "Unexpected curl response: {}. Retrying in 30s.".format(
+                    response
+                )
+            )
+            time.sleep(30)
+
+        # we didn't get rc=0 in the allowed time, fail the test
+        self.fail(
+            "Prometheus-blackbox-exporter didn't respond to the command \n"
+            "'{curl_command}' as expected.\n"
+            "Result: {result}".format(
+                curl_command=curl_command, result=response
+            )
+        )
+
+    def test_02_nrpe_http_check(self):
+        """Verify nrpe check exists."""
+        expected_nrpe_check = "command[check_prometheus_blackbox_exporter_http]={} -I 127.0.0.1 -p {} -u {}".format(
+            "/usr/lib/nagios/plugins/check_http",
+            DEFAULT_API_PORT,
+            DEFAULT_API_URL
+        )
+        logging.debug('Verify the nrpe check is created and has the required content...')
+        cmd = "cat /etc/nagios/nrpe.d/check_prometheus_blackbox_exporter_http.cfg"
+        result = model.run_on_unit(self.lead_unit_name, cmd)
+        code = result.get('Code')
+        if code != '0':
+            raise model.CommandRunFailed(cmd, result)
+        content = result.get('Stdout')
+        self.assertTrue(expected_nrpe_check in content)
diff --git a/tests/functional/tests/tests.yaml b/tests/functional/tests/tests.yaml
new file mode 100644
index 0000000..dd32bc7
--- /dev/null
+++ b/tests/functional/tests/tests.yaml
@@ -0,0 +1,11 @@
+charm_name: prometheus-blackbox-exporter
+gate_bundles:
+  - focal
+  - bionic
+  - xenial
+smoke_bundles:
+  - bionic
+dev_bundles:
+  - bionic
+tests:
+  - tests.test_prometheus_blackbox_exporter.CharmOperationTest
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..1859695
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,65 @@
+[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