Merge pull request #24 from absolutejam/feat/docker_local_testing

Add support for testing locally using Docker

Author: barryorourke

CHANGELOG.md

@@ -6,6 +6,7 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 ## [Unreleased]
 ### Added
 - Add support for python 3.5, which is the default version in Debian 9. (@barryorourke)
+- Added Dockerfiles and docker-compose.yml to aid with local development & testing (@absolutejam)
 
 ## [0.3.2] 2017-10-10
 ### Fixed

docker/README.md

@@ -0,0 +1,21 @@
+# README 
+
+To help lint & check the contents of this repo, docker resources have been
+provided.
+
+The simplest way to run the tests is to use `docker-compose`. Within the
+docker directory, run `docker-compose run --rm <version>`, where version is
+one of `2.7`,`3.4`,`3.5`,`3.6`. This will automatically build the docker 
+images from the `docker_build` directory and run the `run_tests` script against
+the `sensu_plugin` directory within the container, removing the container
+one exit.
+
+For any additional prerequisites that are needed (eg. python modules),
+ammend `docker_build/setup.sh` and then run `docker_build/update` (This
+copies the ammended `setup.sh` into each image directory). Procede to rebuild
+the docker images, either via. 
+`docker build -t python:2.7.14-sensuci ./docker_build/2.7`
+or with `docker-compose build 2.7`.
+
+If you are feeling adventurous, you can simply `docker-compose up` to build
+and launch all of the containers at once!

docker/docker-compose.yml

@@ -0,0 +1,38 @@
+version: "2.1"
+
+services:
+  "2.7":
+    image: "python:2.7.14-sensuci"
+    build: "./docker_build/2.7"
+    hostname: "2.7"
+    container_name: "sensuplugin_python2.7"
+    volumes:
+      - "../sensu_plugin:/sensu_plugin/"
+      - "../run_tests:/entrypoint.sh:ro"
+
+  "3.4":
+    image: "python:3.4-sensuci"
+    build: "./docker_build/3.4"
+    hostname: "3.4"
+    container_name: "sensuplugin_python3.4"
+    volumes:
+      - "../sensu_plugin:/sensu_plugin"
+      - "../run_tests:/entrypoint.sh:ro"
+
+  "3.5":
+    image: "python:3.5.4-sensuci"
+    build: "./docker_build/3.5"
+    hostname: "3.5"
+    container_name: "sensuplugin_python3.5"
+    volumes:
+      - "../sensu_plugin:/sensu_plugin"
+      - "../run_tests:/entrypoint.sh:ro"
+
+  "3.6":
+    image: "python:3.6-sensuci"
+    build: "./docker_build/3.6"
+    hostname: "3.6"
+    container_name: "sensuplugin_python3.6"
+    volumes:
+      - "../sensu_plugin:/sensu_plugin"
+      - "../run_tests:/entrypoint.sh:ro"

docker/docker_build/2.7/Dockerfile

@@ -0,0 +1,8 @@
+FROM python:2.7
+
+ADD ./setup.sh /setup.sh
+
+RUN chmod +x /setup.sh && \
+    bash -c /setup.sh
+
+ENTRYPOINT [ "/entrypoint.sh" ]

docker/docker_build/2.7/entrypoint.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+EXIT=0
+pep8 sensu_plugin
+RC=$?
+if [ $RC -ne 0 ]; then
+  EXIT=1
+fi
+pylint --rcfile=pylint.rc sensu_plugin
+RC=$?
+if [ $RC -ne 0 ]; then
+  EXIT=1
+fi
+nosetests --with-coverage --cover-package=sensu_plugin \
+  --cover-min-percentage=35 sensu_plugin/test/
+RC=$?
+if [ $RC -ne 0 ]; then
+  EXIT=1
+fi
+
+echo
+echo "Exiting with code $EXIT"
+exit $EXIT

docker/docker_build/2.7/setup.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+set -x
+
+apt update
+
+# Module requirements
+pip install requests
+
+# Testing requiremenets
+pip install pep8 pylint nose  coverage

docker/docker_build/3.4/Dockerfile

@@ -0,0 +1,8 @@
+FROM python:3.4
+
+COPY setup.sh /setup.sh
+
+RUN chmod +x /setup.sh && \
+    /setup.sh
+
+ENTRYPOINT [ "/entrypoint.sh" ]

docker/docker_build/3.4/entrypoint.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+EXIT=0
+pep8 sensu_plugin
+RC=$?
+if [ $RC -ne 0 ]; then
+  EXIT=1
+fi
+pylint --rcfile=pylint.rc sensu_plugin
+RC=$?
+if [ $RC -ne 0 ]; then
+  EXIT=1
+fi
+nosetests --with-coverage --cover-package=sensu_plugin \
+  --cover-min-percentage=35 sensu_plugin/test/
+RC=$?
+if [ $RC -ne 0 ]; then
+  EXIT=1
+fi
+
+echo
+echo "Exiting with code $EXIT"
+exit $EXIT

docker/docker_build/3.4/setup.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+set -x
+
+apt update
+
+# Module requirements
+pip install requests
+
+# Testing requiremenets
+pip install pep8 pylint nose  coverage

docker/docker_build/3.5/Dockerfile

@@ -0,0 +1,8 @@
+FROM python:3.5
+
+COPY setup.sh /setup.sh
+
+RUN chmod +x /setup.sh && \
+    /setup.sh
+
+ENTRYPOINT [ "/entrypoint.sh" ]