Merge pull request #68 from ccin2p3/feature/load_default_ca_certs

[TLS] Always load system default C.A files

.github/workflows/unittest.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  gitHubActionForPytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+    name: GitHub Action
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Lint
+      run: |
+        pip3 install --upgrade pip wheel setuptools
+        pip3 install pylint
+        python3 -m pylint check_http_json.py
+    - name: Unit Test
+      run: |
+        python3 -m unittest discover
+    - name: Coverage
+      run: |
+        pip3 install coverage
+        python3 -m coverage run -m unittest discover
+        python3 -m coverage report -m --include check_http_json.py

.gitignore

@@ -0,0 +1,64 @@
+#Emacs
+\#*
+.\#*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+.venv/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

.pylintrc

@@ -0,0 +1,5 @@
+# pylint config
+[MESSAGES CONTROL]
+disable=line-too-long, redefined-outer-name, too-many-arguments, too-many-instance-attributes, fixme, invalid-name, superfluous-parens, missing-function-docstring, missing-module-docstring, multiple-imports, no-else-return, too-many-return-statements, too-many-branches, too-many-statements
+[MASTER]
+ignore-patterns=^test.*

README.md

@@ -1,15 +1,218 @@
+![CI](https://github.com/drewkerrigan/nagios-http-json/workflows/CI/badge.svg)
+
 # Nagios Json Plugin
 
 This is a generic plugin for Nagios which checks json values from a given HTTP endpoint against argument specified rules and determines the status and performance data for that service.
 
-### Installation
+## Links
 
-#### Requirements
+* [CLI Usage](#cli-usage)
+* [Examples](#examples)
+    * [Riak Stats](docs/RIAK.md)
+    * [Docker](docs/DOCKER.md)
+* [Nagios Installation](#nagios-installation)
 
-* Nagios
+## CLI Usage
-* Python
 
-### Nagios Configuration
+Executing `./check_http_json.py -h` will yield the following details:
+
+```
+usage: check_http_json.py [-h] [-d] [-s] -H HOST [-k] [-V] [--cacert CACERT]
+                          [--cert CERT] [--key KEY] [-P PORT] [-p PATH]
+                          [-t TIMEOUT] [-B AUTH] [-D DATA] [-A HEADERS]
+                          [-f FIELD_SEPARATOR] [-F VALUE_SEPARATOR]
+                          [-w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]]
+                          [-c [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]]]
+                          [-e [KEY_LIST [KEY_LIST ...]]]
+                          [-E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]]
+                          [-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]]
+                          [-Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]]
+                          [-u [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]]]
+                          [-y [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]]]
+                          [-Y [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]]]
+                          [-m [METRIC_LIST [METRIC_LIST ...]]]
+
+Check HTTP JSON Nagios Plugin
+
+Generic Nagios plugin which checks json values from a given endpoint against
+argument specified rules and determines the status and performance data for
+that service.
+
+Version: 2.0.0 (2020-03-22)
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -d, --debug           debug mode
+  -s, --ssl             use TLS to connect to remote host
+  -H HOST, --host HOST  remote host to query
+  -k, --insecure        do not check server SSL certificate
+  -V, --version         print version of this plugin
+  --cacert CACERT       SSL CA certificate
+  --cert CERT           SSL client certificate
+  --key KEY             SSL client key ( if not bundled into the cert )
+  -P PORT, --port PORT  TCP port
+  -p PATH, --path PATH  Path
+  -t TIMEOUT, --timeout TIMEOUT
+                        Connection timeout (seconds)
+  -B AUTH, --basic-auth AUTH
+                        Basic auth string "username:password"
+  -D DATA, --data DATA  The http payload to send as a POST
+  -A HEADERS, --headers HEADERS
+                        The http headers in JSON format.
+  -f SEPARATOR, --field_separator SEPARATOR
+                        JSON Field separator, defaults to "."; Select element
+                        in an array with "(" ")"
+  -F SEPARATOR, --value_separator SEPARATOR
+                        JSON Value separator, defaults to ":";
+  -w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]], --warning [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]
+                        Warning threshold for these values
+                        (key1[>alias],WarnRange key2[>alias],WarnRange).
+                        WarnRange is in the format [@]start:end, more
+                        information at nagios-plugins.org/doc/guidelines.html.
+  -c [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]], --critical [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]]
+                        Critical threshold for these values
+                        (key1[>alias],CriticalRange
+                        key2[>alias],CriticalRange. CriticalRange is in the
+                        format [@]start:end, more information at nagios-
+                        plugins.org/doc/guidelines.html.
+  -e [KEY_LIST [KEY_LIST ...]], --key_exists [KEY_LIST [KEY_LIST ...]]
+                        Checks existence of these keys to determine status.
+                        Return warning if key is not present.
+  -E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]], --key_exists_critical [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]
+                        Same as -e but return critical if key is not present.
+  -q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]], --key_equals [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]
+                        Checks equality of these keys and values
+                        (key[>alias],value key2,value2) to determine status.
+                        Multiple key values can be delimited with colon
+                        (key,value1:value2). Return warning if equality check
+                        fails
+  -Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]], --key_equals_critical [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]
+                        Same as -q but return critical if equality check
+                        fails.
+  -u [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]], --key_equals_unknown [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]]
+                        Same as -q but return unknown if equality check fails.
+  -y [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]], --key_not_equals [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]]
+                        Checks equality of these keys and values
+                        (key[>alias],value key2,value2) to determine status.
+                        Multiple key values can be delimited with colon
+                        (key,value1:value2). Return warning if equality check
+                        succeeds
+  -Y [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]], --key_not_equals_critical [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]]
+                        Same as -q but return critical if equality check
+                        succeeds.
+  -m [METRIC_LIST [METRIC_LIST ...]], --key_metric [METRIC_LIST [METRIC_LIST ...]]
+                        Gathers the values of these keys (key[>alias],
+                        UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for
+                        Nagios performance data. More information about Range
+                        format and units of measure for nagios can be found at
+                        nagios-plugins.org/doc/guidelines.html Additional
+                        formats for this parameter are: (key[>alias]),
+                        (key[>alias],UnitOfMeasure),
+                        (key[>alias],UnitOfMeasure,WarnRange, CriticalRange).
+```
+
+## Examples
+
+### Key Naming
+
+**Data for key** `value`:
+
+    { "value": 1000 }
+
+**Data for key** `capacity.value`:
+
+    {
+        "capacity": {
+            "value": 1000
+        }
+    }
+
+**Data for key** `(0).capacity.value`:
+
+    [
+        {
+            "capacity": {
+                "value": 1000
+            }
+        }
+    ]
+
+**Data for keys of all items in a list** `(*).capacity.value`:
+
+    [
+        {
+            "capacity": {
+                "value": 1000
+            }
+        },
+        {
+            "capacity": {
+                "value": 2200
+            }
+        }
+    ]
+
+**Data for separator** `-f _` **and key** `(0)_gauges_jvm.buffers.direct.capacity_value`:
+
+    [
+        {
+            "gauges": {
+                "jvm.buffers.direct.capacity":
+                    "value": 1000
+                }
+            }
+        }
+    ]
+
+**Data for keys** `ring_members(0)`, `ring_members(1)`, `ring_members(2)`:
+
+    {
+        "ring_members": [
+            "riak1@127.0.0.1",
+            "riak2@127.0.0.1",
+            "riak3@127.0.0.1"
+        ]
+    }
+
+### Thresholds and Ranges
+
+**Data**:
+
+    { "metric": 1000 }
+
+#### Relevant Commands
+
+* **Warning:** `./check_http_json.py -H <host>:<port> -p <path> -w "metric,RANGE"`
+* **Critical:** `./check_http_json.py -H <host>:<port> -p <path> -c "metric,RANGE"`
+* **Metrics with Warning:** `./check_http_json.py -H <host>:<port> -p <path> -w "metric,RANGE"`
+* **Metrics with Critical:**
+
+        ./check_http_json.py -H <host>:<port> -p <path> -w "metric,,,RANGE"
+        ./check_http_json.py -H <host>:<port> -p <path> -w "metric,,,,MIN,MAX"
+
+#### Range Definitions
+
+* **Format:** [@]START:END
+* **Generates a Warning or Critical if...**
+    * **Value is less than 0 or greater than 1000:** `1000` or `0:1000`
+    * **Value is greater than or equal to 1000, or less than or equal to 0:** `@1000` or `@0:1000`
+    * **Value is less than 1000:** `1000:`
+    * **Value is greater than 1000:** `~:1000`
+    * **Value is greater than or equal to 1000:** `@1000:`
+
+More info about Nagios Range format and Units of Measure can be found at [https://nagios-plugins.org/doc/guidelines.html](https://nagios-plugins.org/doc/guidelines.html).
+
+#### Using Headers
+
+* `./check_http_json.py -H <host>:<port> -p <path> -A '{"content-type": "application/json"}' -w "metric,RANGE"`
+
+## Nagios Installation
+
+### Requirements
+
+* Python 3.6+
+
+### Configuration
 
 Assuming a standard installation of Nagios, the plugin can be executed from the machine that Nagios is running on.
 
@@ -42,226 +245,10 @@ define command{
 
 ```
 
-More info about options in Usage.
+## Icinga2 configuration
 
-### CLI Usage
+The Icinga2 command definition can be found here: (contrib/icinga2_check_command_definition.conf)
 
-Executing `./check_http_json.py -h` will yield the following details:
-
-```
-usage: check_http_json.py [-h] [-d] [-s] -H HOST [-P PORT] [-p PATH]
-                          [-t TIMEOUT] [-B AUTH] [-D DATA] [-f SEPARATOR]
-                          [-w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]]
-                          [-c [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]]]
-                          [-e [KEY_LIST [KEY_LIST ...]]]
-                          [-E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]]
-                          [-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]]
-                          [-Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]]
-                          [-m [METRIC_LIST [METRIC_LIST ...]]]
-
-Nagios plugin which checks json values from a given endpoint against argument
-specified rules and determines the status and performance data for that
-service
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -d, --debug           Debug mode.
-  -s, --ssl             HTTPS mode.
-  -H HOST, --host HOST  Host.
-  -P PORT, --port PORT  TCP port
-  -p PATH, --path PATH  Path.
-  -t TIMEOUT, --timeout TIMEOUT
-                        Connection timeout (seconds)
-  -B AUTH, --basic-auth AUTH
-                        Basic auth string "username:password"
-  -D DATA, --data DATA  The http payload to send as a POST
-  -f SEPARATOR, --field_separator SEPARATOR
-                        Json Field separator, defaults to "." ; Select element
-                        in an array with "(" ")"
-  -w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]], --warning [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]
-                        Warning threshold for these values
-                        (key1[>alias],WarnRange key2[>alias],WarnRange).
-                        WarnRange is in the format [@]start:end, more
-                        information at nagios-plugins.org/doc/guidelines.html.
-  -c [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]], --critical [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]]
-                        Critical threshold for these values
-                        (key1[>alias],CriticalRange
-                        key2[>alias],CriticalRange. CriticalRange is in the
-                        format [@]start:end, more information at nagios-
-                        plugins.org/doc/guidelines.html.
-  -e [KEY_LIST [KEY_LIST ...]], --key_exists [KEY_LIST [KEY_LIST ...]]
-                        Checks existence of these keys to determine status.
-                        Return warning if key is not present.
-  -E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]], --key_exists_critical [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]
-                        Same as -e but return critical if key is not present.
-  -q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]], --key_equals [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]
-                        Checks equality of these keys and values
-                        (key[>alias],value key2,value2) to determine status.
-                        Multiple key values can be delimited with colon
-                        (key,value1:value2). Return warning if equality check
-                        fails
-  -Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]], --key_equals_critical [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]
-                        Same as -q but return critical if equality check
-                        fails.
-  -m [METRIC_LIST [METRIC_LIST ...]], --key_metric [METRIC_LIST [METRIC_LIST ...]]
-                        Gathers the values of these keys (key[>alias],UnitOfMe
-                        asure,WarnRange,CriticalRange,Min,Max) for Nagios
-                        performance data. More information about Range format
-                        and units of measure for nagios can be found at
-                        nagios-plugins.org/doc/guidelines.html Additional
-                        formats for this parameter are: (key[>alias]),
-                        (key[>alias],UnitOfMeasure),
-                        (key[>alias],UnitOfMeasure,WarnRange,CriticalRange).
-```
-
-Access a specific JSON field by following this syntax: `alpha.beta.gamma(3).theta.omega(0)`
-Dots are field separators (changeable), parentheses are for entering arrays.
-
-If the root of the JSON data is itself an array like the following:
-
-```
-[
-{ "gauges": { "jvm.buffers.direct.capacity": {"value": 215415}}}
-]
-```
-
-The beginning of the key should start with ($index) as in this example:
-
-```
-./check_http_json.py -H localhost:8081 -p metrics --key_exists "(0)_gauges_jvm.buffers.direct.capacity_value" -f _
-```
-
-More info about Nagios Range format and Units of Measure can be found at [https://nagios-plugins.org/doc/guidelines.html](https://nagios-plugins.org/doc/guidelines.html).
-
-### Docker Info Example Plugin
-
-#### Description
-
-Let's say we want to use `check_http_json.py` to read from Docker's `/info` HTTP API endpoint with the following parameters:
-
-##### Connection information
-
-* Host = 127.0.0.1:4243
-* Path = /info
-
-##### Rules for "aliveness"
-
-* Verify that the key `Containers` exists in the outputted JSON
-* Verify that the key `IPv4Forwarding` has a value of `1`
-* Verify that the key `Debug` has a value less than or equal to `2`
-* Verify that the key `Images` has a value greater than or equal to `1`
-* If any of these criteria are not met, report a WARNING to Nagios
-
-##### Gather Metrics
-
-* Report value of the key `Containers` with a MinValue of 0 and a MaxValue of 1000 as performance data
-* Report value of the key `Images` as performance data
-* Report value of the key `NEventsListener` as performance data
-* Report value of the key `NFd` as performance data
-* Report value of the key `NGoroutines` as performance data
-* Report value of the key `SwapLimit` as performance data
-
-#### Service Definition
-
-`localhost.cfg`
-
-```
-define service {
-        use                             local-service
-        host_name                       localhost
-        service_description             Docker info status checker
-        check_command                   check_docker
-        }
-```
-
-#### Command Definition with Arguments
-
-`commands.cfg`
-
-```
-define command{
-        command_name    check_docker
-        command_line    /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p info -e Containers -q IPv4Forwarding,1 -w Debug,2:2 -c Images,1:1 -m Containers,0:250,0:500,0,1000 Images NEventsListener NFd NGoroutines SwapLimit
-        }
-```
-
-#### Sample Output
-
-```
-OK: Status OK.|'Containers'=1;0;1000 'Images'=11;0;0 'NEventsListener'=3;0;0 'NFd'=10;0;0 'NGoroutines'=14;0;0 'SwapLimit'=1;0;0
-```
-
-### Docker Container Monitor Example Plugin
-
-`check_http_json.py` is generic enough to read and evaluate rules on any HTTP endpoint that returns JSON. In this example we'll get the status of a specific container using it's ID which camn be found by using the list containers endpoint (`curl http://127.0.0.1:4243/containers/json?all=1`).
-
-##### Connection information
-
-* Host = 127.0.0.1:4243
-* Path = /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json
-
-##### Rules for "aliveness"
-
-* Verify that the key `ID` exists and is equal to the value `2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615`
-* Verify that the key `State.Running` has a value of `True`
-
-#### Service Definition
-
-`localhost.cfg`
-
-```
-define service {
-        use                             local-service
-        host_name                       localhost
-        service_description             Docker container liveness check
-        check_command                   check_my_container
-        }
-```
-
-#### Command Definition with Arguments
-
-`commands.cfg`
-
-```
-define command{
-        command_name    check_my_container
-        command_line    /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json -q ID,2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615 State.Running,True
-        }
-```
-
-#### Sample Output
-
-```
-WARNING: Status check failed, reason: Value True for key State.Running did not match.
-```
-
-The plugin threw a warning because the Container ID I used on my system has the following State object:
-
-```
- u'State': {...
-            u'Running': False,
-            ...
-```
-
-If I change the command to have the parameter -q parameter `State.Running,False`, the output becomes:
-
-```
-OK: Status OK.
-```
-
-### Dropwizard / Fieldnames Containing '.' Example
-
-Simply choose a separator to  deal with data such as this:
-
-```
-{ "gauges": { "jvm.buffers.direct.capacity": {"value": 215415}}}
-```
-
-In this example I've chosen `_` to separate `guages` from `jvm` and `capacity` from `value`. The CLI invocation then becomes:
-
-```
-./check_http_json.py -H localhost:8081 -p metrics --key_exists gauges_jvm.buffers.direct.capacity_value -f _
-```
 
 ## License
 

contrib/icinga2_check_command_definition.conf

@@ -0,0 +1,106 @@
+object CheckCommand "http_json" {
+		import "plugin-check-command"
+
+		command = [ PluginDir + "/check_http_json.py" ]
+
+		arguments = {
+		"--host" = {
+			value = "$address$"
+			description = "Hostname or address of the interface to query"
+			required = true
+		}
+		"--port" = {
+			value = "$http_json_port$"
+			description = "TCP port number"
+		}
+		"--path" = {
+			value = "$http_json_path$"
+			description = "URL path to query (i.e.: /v1/service/xyz)"
+		}
+		"--timeout" = {
+			value = "$http_json_timeout$"
+			description = "Connection timeout (seconds)"
+		}
+		"--basic-auth" = {
+			value = "$http_json_basic_auth$"
+			description = "Basic auth string 'username:password'"
+		}
+		"--ssl" = {
+			set_if = "$http_json_ssl$"
+			description = "use TLS to connect to remote host"
+		}
+		"--insecure" = {
+			set_if = "$http_json_insecure$"
+			description = "do not check server SSL certificate"
+		}
+		"--cacert" = {
+			value = "$http_json_cacert_file$"
+			description = "path of cacert file to validate server cert"
+		}
+		"--cert" = {
+			value = "$http_json_cert_file$"
+			description = "client certificate in PEM format"
+		}
+		"--key" = {
+			value = "$http_json_key_file$"
+			description = "client certificate key file in PEM format ( if not bundled into the cert )"
+		}
+		"--data" = {
+			value = "$http_json_post_data$"
+			description = "the http payload to send as a POST"
+		}
+		"--headers" = {
+			value = "$http_json_headers$"
+			description = "additional http headers in JSON format to send with the request"
+		}
+		"--field_separator" = {
+			value = "$http_json_field_separator$"
+			description = "JSON Field separator, defaults to '.'; Select element in an array with '(' ')'"
+		}
+		"--value_separator" = {
+			value = "$http_json_value_separator$"
+			description = "JSON Value separator, defaults to ':'"
+		}
+		"--warning" = {
+			value = "$http_json_warning$"
+			description = "Warning threshold for these values, WarningRange is in the format [@]start:end"
+		}
+		"--critical" = {
+			value = "$http_json_critical$"
+			description = "Critical threshold for these values, CriticalRange is in the format [@]start:end"
+		}
+		"--key_exists" = {
+			value = "$http_json_key_exists$"
+			description = "Checks existence of these keys to determine status. Return warning if key is not present."
+		}
+		"--key_exists_critical" = {
+			value = "$http_json_key_exists_critical$"
+			description = "Checks existence of these keys to determine status. Return critical if key is not present."
+		}
+		"--key_equals" = {
+			value = "$http_json_key_equals$"
+			description = "Checks equality of these keys and values. Return warning if equality check fails"
+		}
+		"--key_equals_critical" = {
+			value = "$http_json_key_equals_critical$"
+			description = "Checks equality of these keys and values. Return critical if equality check fails"
+		}
+		"--key_equals_unknown" = {
+			value = "$http_json_key_equals_unknown$"
+			description = "Checks equality of these keys and values. Return unknown if equality check fails"
+		}
+		"--key_not_equals" = {
+			value = "$http_json_key_not_equals$"
+			description = "Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values can be delimited with colon (key,value1:value2). Return warning if equality check succeeds."
+		}
+		"--key_not_equals_critical" = {
+			value = "$http_json_key_not_equals_critical$"
+			description = "Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values can be delimited with colon (key,value1:value2). Return critical if equality check succeeds."
+		}
+		"--key_metric" = {
+			value = "$http_json_key_metric$"
+			description = "Gathers the values of these keys"
+		}
+	}
+}
+

docs/DOCKER.md

@@ -0,0 +1,115 @@
+### Docker Info Example Plugin
+
+#### Description
+
+Let's say we want to use `check_http_json.py` to read from Docker's `/info` HTTP API endpoint with the following parameters:
+
+##### Connection information
+
+* Host = 127.0.0.1:4243
+* Path = /info
+
+##### Rules for "aliveness"
+
+* Verify that the key `Containers` exists in the outputted JSON
+* Verify that the key `IPv4Forwarding` has a value of `1`
+* Verify that the key `Debug` has a value less than or equal to `2`
+* Verify that the key `Images` has a value greater than or equal to `1`
+* If any of these criteria are not met, report a WARNING to Nagios
+
+##### Gather Metrics
+
+* Report value of the key `Containers` with a MinValue of 0 and a MaxValue of 1000 as performance data
+* Report value of the key `Images` as performance data
+* Report value of the key `NEventsListener` as performance data
+* Report value of the key `NFd` as performance data
+* Report value of the key `NGoroutines` as performance data
+* Report value of the key `SwapLimit` as performance data
+
+#### Service Definition
+
+`localhost.cfg`
+
+```
+define service {
+        use                             local-service
+        host_name                       localhost
+        service_description             Docker info status checker
+        check_command                   check_docker
+        }
+```
+
+#### Command Definition with Arguments
+
+`commands.cfg`
+
+```
+define command{
+        command_name    check_docker
+        command_line    /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p info -e Containers -q IPv4Forwarding,1 -w Debug,2:2 -c Images,1:1 -m Containers,0:250,0:500,0,1000 Images NEventsListener NFd NGoroutines SwapLimit
+        }
+```
+
+#### Sample Output
+
+```
+OK: Status OK.|'Containers'=1;0;1000 'Images'=11;0;0 'NEventsListener'=3;0;0 'NFd'=10;0;0 'NGoroutines'=14;0;0 'SwapLimit'=1;0;0
+```
+
+### Docker Container Monitor Example Plugin
+
+`check_http_json.py` is generic enough to read and evaluate rules on any HTTP endpoint that returns JSON. In this example we'll get the status of a specific container using it's ID which camn be found by using the list containers endpoint (`curl http://127.0.0.1:4243/containers/json?all=1`).
+
+##### Connection information
+
+* Host = 127.0.0.1:4243
+* Path = /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json
+
+##### Rules for "aliveness"
+
+* Verify that the key `ID` exists and is equal to the value `2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615`
+* Verify that the key `State.Running` has a value of `True`
+
+#### Service Definition
+
+`localhost.cfg`
+
+```
+define service {
+        use                             local-service
+        host_name                       localhost
+        service_description             Docker container liveness check
+        check_command                   check_my_container
+        }
+```
+
+#### Command Definition with Arguments
+
+`commands.cfg`
+
+```
+define command{
+        command_name    check_my_container
+        command_line    /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json -q ID,2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615 State.Running,True
+        }
+```
+
+#### Sample Output
+
+```
+WARNING: Status check failed, reason: Value True for key State.Running did not match.
+```
+
+The plugin threw a warning because the Container ID I used on my system has the following State object:
+
+```
+ u'State': {...
+            u'Running': False,
+            ...
+```
+
+If I change the command to have the parameter -q parameter `State.Running,False`, the output becomes:
+
+```
+OK: Status OK.
+```

docs/RIAK.md

@@ -0,0 +1,227 @@
+# Riak Stats Example
+
+## Description
+
+For this example we're going to use `check_http_json.py` as a pure CLI tool to read Riak's `/stats` endpoint
+
+## Connection information
+
+* Host = 127.0.0.1:8098
+* Path = /stats
+
+## JSON Stats Data
+
+* Full Riak HTTP Stats information can be found here: [http://docs.basho.com/riak/latest/dev/references/http/status/](http://docs.basho.com/riak/latest/dev/references/http/status/)
+* Information related to specific interesting stats can be found here: [http://docs.basho.com/riak/latest/ops/running/stats-and-monitoring/](http://docs.basho.com/riak/latest/ops/running/stats-and-monitoring/)
+
+## Connectivity Check
+
+* `ring_members`: We can use an existence check to monitor the number of ring members
+* `connected_nodes`: Similarly we can check the number of nodes that are in communication with this node, but this list will be empty in a 1 node cluster
+
+#### Sample Command
+
+For a single node dev "cluster", you might have a `ring_members` value like this:
+
+```
+"ring_members": [
+    "riak@127.0.0.1"
+],
+```
+
+To validate that we have a single node, we can use this check:
+
+```
+$ ./check_http_json.py -H localhost -P 8098 -p stats -E "ring_members(0)"
+OK: Status OK.
+```
+
+If we were expecting at least 2 nodes in the cluster, we would use this check:
+
+```
+$ ./check_http_json.py -H localhost -P 8098 -p stats -E "ring_members(1)"
+CRITICAL: Status CRITICAL. Key ring_members(1) did not exist.
+```
+
+Obviously this fails because we only had a single `ring_member`. If we prefer to only get a warning instead of a critical for this check, we just use the correct flag:
+
+```
+$ ./check_http_json.py -H localhost -P 8098 -p stats -e "ring_members(1)"
+WARNING: Status WARNING. Key ring_members(1) did not exist.
+```
+
+## Gather Metrics
+
+The thresholds for acceptable values for these metrics will vary from system to system, following are the stats we'll be checking:
+
+### Throughput Metrics:
+
+* `node_gets`
+* `node_puts`
+* `vnode_counter_update`
+* `vnode_set_update`
+* `vnode_map_update`
+* `search_query_throughput_one`
+* `search_index_throughtput_one`
+* `consistent_gets`
+* `consistent_puts`
+* `vnode_index_reads`
+
+#### Sample Command
+
+```
+./check_http_json.py -H localhost -P 8098 -p stats -m \
+    "node_gets" \
+    "node_puts" \
+    "vnode_counter_update" \
+    "vnode_set_update" \
+    "vnode_map_update" \
+    "search_query_throughput_one" \
+    "search_index_throughtput_one" \
+    "consistent_gets" \
+    "consistent_puts" \
+    "vnode_index_reads"
+```
+
+#### Sample Output
+
+```
+OK: Status OK.|'node_gets'=0 'node_puts'=0 'vnode_counter_update'=0 'vnode_set_update'=0 'vnode_map_update'=0 'search_query_throughput_one'=0 'consistent_gets'=0 'consistent_puts'=0 'vnode_index_reads'=0
+```
+
+### Latency Metrics:
+
+* `node_get_fsm_time_mean,_median,_95,_99,_100`
+* `node_put_fsm_time_mean,_median,_95,_99,_100`
+* `object_counter_merge_time_mean,_median,_95,_99,_100`
+* `object_set_merge_time_mean,_median,_95,_99,_100`
+* `object_map_merge_time_mean,_median,_95,_99,_100`
+* `search_query_latency_median,_min,_95,_99,_999`
+* `search_index_latency_median,_min,_95,_99,_999`
+* `consistent_get_time_mean,_median,_95,_99,_100`
+* `consistent_put_time_mean,_median,_95,_99,_100`
+
+#### Sample Command
+
+```
+./check_http_json.py -H localhost -P 8098 -p stats -m \
+    "node_get_fsm_time_mean,,0:100,0:1000" \
+    "node_get_fsm_time_median,,0:100,0:1000" \
+    "node_get_fsm_time_95,,0:100,0:1000" \
+    "node_get_fsm_time_99,,0:100,0:1000" \
+    "node_get_fsm_time_100,,0:100,0:1000" \
+    "node_put_fsm_time_mean,,0:100,0:1000" \
+    "node_put_fsm_time_median,,0:100,0:1000" \
+    "node_put_fsm_time_95,,0:100,0:1000" \
+    "node_put_fsm_time_99,,0:100,0:1000" \
+    "node_put_fsm_time_100,,0:100,0:1000" \
+    "object_counter_merge_time_mean,,0:100,0:1000" \
+    "object_counter_merge_time_median,,0:100,0:1000" \
+    "object_counter_merge_time_95,,0:100,0:1000" \
+    "object_counter_merge_time_99,,0:100,0:1000" \
+    "object_counter_merge_time_100,,0:100,0:1000" \
+    "object_set_merge_time_mean,,0:100,0:1000" \
+    "object_set_merge_time_median,,0:100,0:1000" \
+    "object_set_merge_time_95,,0:100,0:1000" \
+    "object_set_merge_time_99,,0:100,0:1000" \
+    "object_set_merge_time_100,,0:100,0:1000" \
+    "object_map_merge_time_mean,,0:100,0:1000" \
+    "object_map_merge_time_median,,0:100,0:1000" \
+    "object_map_merge_time_95,,0:100,0:1000" \
+    "object_map_merge_time_99,,0:100,0:1000" \
+    "object_map_merge_time_100,,0:100,0:1000" \
+    "consistent_get_time_mean,,0:100,0:1000" \
+    "consistent_get_time_median,,0:100,0:1000" \
+    "consistent_get_time_95,,0:100,0:1000" \
+    "consistent_get_time_99,,0:100,0:1000" \
+    "consistent_get_time_100,,0:100,0:1000" \
+    "consistent_put_time_mean,,0:100,0:1000" \
+    "consistent_put_time_median,,0:100,0:1000" \
+    "consistent_put_time_95,,0:100,0:1000" \
+    "consistent_put_time_99,,0:100,0:1000" \
+    "consistent_put_time_100,,0:100,0:1000" \
+    "search_query_latency_median,,0:100,0:1000" \
+    "search_query_latency_min,,0:100,0:1000" \
+    "search_query_latency_95,,0:100,0:1000" \
+    "search_query_latency_99,,0:100,0:1000" \
+    "search_query_latency_999,,0:100,0:1000" \
+    "search_index_latency_median,,0:100,0:1000" \
+    "search_index_latency_min,,0:100,0:1000" \
+    "search_index_latency_95,,0:100,0:1000" \
+    "search_index_latency_99,,0:100,0:1000" \
+    "search_index_latency_999,,0:100,0:1000"
+```
+
+#### Sample Output
+
+```
+OK: Status OK.|'node_get_fsm_time_mean'=0;0:100;0:1000 'node_get_fsm_time_median'=0;0:100;0:1000 'node_get_fsm_time_95'=0;0:100;0:1000 'node_get_fsm_time_99'=0;0:100;0:1000 'node_get_fsm_time_100'=0;0:100;0:1000 'node_put_fsm_time_mean'=0;0:100;0:1000 'node_put_fsm_time_median'=0;0:100;0:1000 'node_put_fsm_time_95'=0;0:100;0:1000 'node_put_fsm_time_99'=0;0:100;0:1000 'node_put_fsm_time_100'=0;0:100;0:1000 'object_counter_merge_time_mean'=0;0:100;0:1000 'object_counter_merge_time_median'=0;0:100;0:1000 'object_counter_merge_time_95'=0;0:100;0:1000 'object_counter_merge_time_99'=0;0:100;0:1000 'object_counter_merge_time_100'=0;0:100;0:1000 'object_set_merge_time_mean'=0;0:100;0:1000 'object_set_merge_time_median'=0;0:100;0:1000 'object_set_merge_time_95'=0;0:100;0:1000 'object_set_merge_time_99'=0;0:100;0:1000 'object_set_merge_time_100'=0;0:100;0:1000 'object_map_merge_time_mean'=0;0:100;0:1000 'object_map_merge_time_median'=0;0:100;0:1000 'object_map_merge_time_95'=0;0:100;0:1000 'object_map_merge_time_99'=0;0:100;0:1000 'object_map_merge_time_100'=0;0:100;0:1000 'consistent_get_time_mean'=0;0:100;0:1000 'consistent_get_time_median'=0;0:100;0:1000 'consistent_get_time_95'=0;0:100;0:1000 'consistent_get_time_99'=0;0:100;0:1000 'consistent_get_time_100'=0;0:100;0:1000 'consistent_put_time_mean'=0;0:100;0:1000 'consistent_put_time_median'=0;0:100;0:1000 'consistent_put_time_95'=0;0:100;0:1000 'consistent_put_time_99'=0;0:100;0:1000 'consistent_put_time_100'=0;0:100;0:1000 'search_query_latency_median'=0;0:100;0:1000 'search_query_latency_min'=0;0:100;0:1000 'search_query_latency_95'=0;0:100;0:1000 'search_query_latency_99'=0;0:100;0:1000 'search_query_latency_999'=0;0:100;0:1000 'search_index_latency_median'=0;0:100;0:1000 'search_index_latency_min'=0;0:100;0:1000 'search_index_latency_95'=0;0:100;0:1000 'search_index_latency_99'=0;0:100;0:1000 'search_index_latency_999'=0;0:100;0:1000
+```
+
+### Erlang Resource Usage Metrics:
+
+* `sys_process_count`
+* `memory_processes`
+* `memory_processes_used`
+
+#### Sample Command
+
+```
+./check_http_json.py -H localhost -P 8098 -p stats -m \
+    "sys_process_count,,0:5000,0:10000" \
+    "memory_processes,,0:50000000,0:100000000" \
+    "memory_processes_used,,0:50000000,0:100000000"
+```
+
+#### Sample Output
+
+```
+OK: Status OK.|'sys_process_count'=1637;0:5000;0:10000 'memory_processes'=46481112;0:50000000;0:100000000 'memory_processes_used'=46476880;0:50000000;0:100000000
+```
+
+### General Riak Load / Health Metrics:
+
+* `node_get_fsm_siblings_mean,_median,_95,_99,_100`
+* `node_get_fsm_objsize_mean,_median,_95,_99,_100`
+* `riak_search_vnodeq_mean,_median,_95,_99,_100`
+* `search_index_fail_one`
+* `pbc_active`
+* `pbc_connects`
+* `read_repairs`
+* `list_fsm_active`
+* `node_get_fsm_rejected`
+* `node_put_fsm_rejected`
+
+#### Sample Command
+
+```
+./check_http_json.py -H localhost -P 8098 -p stats -m \
+    "node_get_fsm_siblings_mean,,0:100,0:1000" \
+    "node_get_fsm_siblings_median,,0:100,0:1000" \
+    "node_get_fsm_siblings_95,,0:100,0:1000" \
+    "node_get_fsm_siblings_99,,0:100,0:1000" \
+    "node_get_fsm_siblings_100,,0:100,0:1000" \
+    "node_get_fsm_objsize_mean,,0:100,0:1000" \
+    "node_get_fsm_objsize_median,,0:100,0:1000" \
+    "node_get_fsm_objsize_95,,0:100,0:1000" \
+    "node_get_fsm_objsize_99,,0:100,0:1000" \
+    "node_get_fsm_objsize_100,,0:100,0:1000" \
+    "riak_search_vnodeq_mean,,0:100,0:1000" \
+    "riak_search_vnodeq_median,,0:100,0:1000" \
+    "riak_search_vnodeq_95,,0:100,0:1000" \
+    "riak_search_vnodeq_99,,0:100,0:1000" \
+    "riak_search_vnodeq_100,,0:100,0:1000" \
+    "search_index_fail_one,,0:100,0:1000" \
+    "pbc_active,,0:100,0:1000" \
+    "pbc_connects,,0:100,0:1000" \
+    "read_repairs,,0:100,0:1000" \
+    "list_fsm_active,,0:100,0:1000" \
+    "node_get_fsm_rejected,,0:100,0:1000" \
+    "node_put_fsm_rejected,,0:100,0:1000"
+```
+
+#### Sample Output
+
+```
+OK: Status OK.|'node_get_fsm_siblings_mean'=0;0:100;0:1000 'node_get_fsm_siblings_median'=0;0:100;0:1000 'node_get_fsm_siblings_95'=0;0:100;0:1000 'node_get_fsm_siblings_99'=0;0:100;0:1000 'node_get_fsm_siblings_100'=0;0:100;0:1000 'node_get_fsm_objsize_mean'=0;0:100;0:1000 'node_get_fsm_objsize_median'=0;0:100;0:1000 'node_get_fsm_objsize_95'=0;0:100;0:1000 'node_get_fsm_objsize_99'=0;0:100;0:1000 'node_get_fsm_objsize_100'=0;0:100;0:1000      'search_index_fail_one'=0;0:100;0:1000 'pbc_active'=0;0:100;0:1000 'pbc_connects'=0;0:100;0:1000 'read_repairs'=0;0:100;0:1000 'list_fsm_active'=0;0:100;0:1000 'node_get_fsm_rejected'=0;0:100;0:1000 'node_put_fsm_rejected'=0;0:100;0:1000
+```

makefile

@@ -0,0 +1,9 @@
+.PHONY: lint test coverage
+
+lint:
+	python3 -m pylint check_http_json.py
+test:
+	python3 -m unittest discover
+coverage:
+	python3 -m coverage run -m unittest discover
+	python3 -m coverage report -m --include check_http_json.py

test/requirements.txt

@@ -0,0 +1,2 @@
+coverage==5.0.3
+pylint==2.4.4

test/test_args.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+
+
+import unittest
+import sys
+
+sys.path.append('..')
+
+from check_http_json import *
+
+
+class ArgsTest(unittest.TestCase):
+    """
+    Tests for argsparse
+    """
+
+    def test_parser_defaults(self):
+        parser = parseArgs(['-H', 'foobar'])
+        self.assertFalse(parser.debug)
+        self.assertFalse(parser.ssl)
+        self.assertFalse(parser.insecure)
+
+    def test_parser_with_debug(self):
+        parser = parseArgs(['-H', 'foobar', '-d'])
+        self.assertTrue(parser.debug)
+
+    def test_parser_with_port(self):
+        parser = parseArgs(['-H', 'foobar', '-P', '8888'])
+        self.assertEqual(parser.port, '8888')
+
+    def test_parser_with_separator(self):
+        parser = parseArgs(['-H', 'foobar', '-f', '_', '-F', '_'])
+        self.assertEqual(parser.separator, '_')
+        self.assertEqual(parser.value_separator, '_')

test/test_check_http_json.py

@@ -0,0 +1,296 @@
+#!/usr/bin/env python3
+
+
+import json
+import unittest
+from unittest.mock import patch
+import sys
+
+sys.path.append('..')
+
+from check_http_json import *
+
+
+OK_CODE = 0
+WARNING_CODE = 1
+CRITICAL_CODE = 2
+UNKNOWN_CODE = 3
+
+
+class RulesHelper:
+    separator = '.'
+    value_separator = ':'
+    debug = False
+    key_threshold_warning = None
+    key_value_list = None
+    key_value_list_not = None
+    key_list = None
+    key_threshold_critical = None
+    key_value_list_critical = None
+    key_value_list_not_critical = None
+    key_value_list_unknown = None
+    key_list_critical = None
+    metric_list = None
+
+    def dash_m(self, data):
+        self.metric_list = data
+        return self
+
+    def dash_e(self, data):
+        self.key_list = data
+        return self
+
+    def dash_E(self, data):
+        self.key_list_critical = data
+        return self
+
+    def dash_q(self, data):
+        self.key_value_list = data
+        return self
+
+    def dash_Q(self, data):
+        self.key_value_list_critical = data
+        return self
+
+    def dash_y(self, data):
+        self.key_value_list_not = data
+        return self
+
+    def dash_Y(self, data):
+        self.key_value_list_not_critical = data
+        return self
+
+    def dash_U(self, data):
+        self.key_value_list_unknown = data
+        return self
+
+    def dash_w(self, data):
+        self.key_threshold_warning = data
+        return self
+
+    def dash_c(self, data):
+        self.key_threshold_critical = data
+        return self
+
+
+class UtilTest(unittest.TestCase):
+    """
+    Tests for the util fucntions
+    """
+
+    rules = RulesHelper()
+
+    def check_data(self, args, jsondata, code):
+        data = json.loads(jsondata)
+        nagios = NagiosHelper()
+        processor = JsonRuleProcessor(data, args)
+        nagios.append_warning(processor.checkWarning())
+        nagios.append_critical(processor.checkCritical())
+        nagios.append_metrics(processor.checkMetrics())
+        nagios.append_unknown(processor.checkUnknown())
+        self.assertEqual(code, nagios.getCode())
+
+    def test_metrics(self):
+        self.check_data(RulesHelper().dash_m(['metric,,1:4,1:5']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_m(['metric,,1:5,1:4']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,6,10']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,1,4']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_m(['metric,s,@1:4,@6:10,1,10']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_m(['(*).value,s,1:5,1:5']),
+                        '[{"value": 5},{"value": 100}]', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_m(['metric>foobar,,1:4,1:5']),
+                        '{"metric": 5}', WARNING_CODE)
+
+    def test_unknown(self):
+        self.check_data(RulesHelper().dash_U(['metric,0']),
+                        '{"metric": 3}', UNKNOWN_CODE)
+
+    def test_exists(self):
+        self.check_data(RulesHelper().dash_e(['nothere']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_E(['nothere']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_e(['metric']),
+                        '{"metric": 5}', OK_CODE)
+
+    def test_equality(self):
+        self.check_data(RulesHelper().dash_q(['metric,6']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_Q(['metric,6']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_q(['metric,5']),
+                        '{"metric": 5}', OK_CODE)
+
+    def test_equality_colon(self):
+        """
+        See https://github.com/drewkerrigan/nagios-http-json/issues/43
+        """
+        rules = RulesHelper()
+        rules.value_separator = '_'
+
+        # This should not fail
+        self.check_data(rules.dash_q(['metric,foo:bar']),
+                        '{"metric": "foo:bar"}', OK_CODE)
+
+    def test_non_equality(self):
+        self.check_data(RulesHelper().dash_y(['metric,6']),
+                        '{"metric": 6}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_Y(['metric,6']),
+                        '{"metric": 6}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_y(['metric,5']),
+                        '{"metric": 6}', OK_CODE)
+
+    def test_warning_thresholds(self):
+        self.check_data(RulesHelper().dash_w(['metric,5']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,5:']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,~:5']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,1:5']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@5']),
+                        '{"metric": 6}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@5:']),
+                        '{"metric": 4}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@~:5']),
+                        '{"metric": 6}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@1:5']),
+                        '{"metric": 6}', OK_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,5']),
+                        '{"metric": 6}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,5:']),
+                        '{"metric": 4}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,~:5']),
+                        '{"metric": 6}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,1:5']),
+                        '{"metric": 6}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@5']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@5:']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@~:5']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['metric,@1:5']),
+                        '{"metric": 5}', WARNING_CODE)
+        self.check_data(RulesHelper().dash_w(['(*).value,@1:5']),
+                        '[{"value": 5},{"value": 1000}]', WARNING_CODE)
+
+    def test_critical_thresholds(self):
+        self.check_data(RulesHelper().dash_c(['metric,5']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,5:']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,~:5']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,1:5']),
+                        '{"metric": 5}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@5']),
+                        '{"metric": 6}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@5:']),
+                        '{"metric": 4}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@~:5']),
+                        '{"metric": 6}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@1:5']),
+                        '{"metric": 6}', OK_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,5']),
+                        '{"metric": 6}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,5:']),
+                        '{"metric": 4}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,~:5']),
+                        '{"metric": 6}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,1:5']),
+                        '{"metric": 6}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@5']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@5:']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@~:5']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['metric,@1:5']),
+                        '{"metric": 5}', CRITICAL_CODE)
+        self.check_data(RulesHelper().dash_c(['(*).value,@1:5']),
+                        '[{"value": 5},{"value": 1000}]', CRITICAL_CODE)
+
+    def test_separator(self):
+        rules = RulesHelper()
+        rules.separator = '_'
+        self.check_data(
+            rules.dash_q(
+                ['(0)_gauges_jvm.buffers.direct.capacity(1)_value,1234']),
+            '''[{ "gauges": { "jvm.buffers.direct.capacity": [
+            {"value": 215415},{"value": 1234}]}}]''',
+            OK_CODE)
+        self.check_data(
+            rules.dash_q(
+                ['(*)_gauges_jvm.buffers.direct.capacity(1)_value,1234']),
+            '''[{ "gauges": { "jvm.buffers.direct.capacity": [
+            {"value": 215415},{"value": 1234}]}},
+            { "gauges": { "jvm.buffers.direct.capacity": [
+            {"value": 215415},{"value": 1235}]}}]''',
+            WARNING_CODE)
+
+    def test_array_with_missing_element(self):
+        """
+        See https://github.com/drewkerrigan/nagios-http-json/issues/34
+        """
+        rules = RulesHelper()
+
+        # This should simply work
+        data = '[{"Node": "there"}]'
+        self.check_data(rules.dash_q(['(0).Node,there']), data, OK_CODE)
+
+        # This should warn us
+        data = '[{"Node": "othervalue"}]'
+        self.check_data(rules.dash_q(['(0).Node,there']), data, WARNING_CODE)
+
+        # # This should not throw an IndexError
+        data = '[{"Node": "foobar"}]'
+        self.check_data(rules.dash_q(['(0).Node,foobar', '(1).Node,missing']), data, WARNING_CODE)
+        self.check_data(rules.dash_q(['(0).Node,foobar', '(1).Node,missing', '(2).Node,alsomissing']), data, WARNING_CODE)
+
+        # This should not throw a KeyError
+        data = '{}'
+        self.check_data(rules.dash_q(['(0).Node,foobar', '(1).Node,missing']), data, CRITICAL_CODE)
+
+    def test_subelem(self):
+
+        rules = RulesHelper()
+        data = '{"foo": {"foo": {"foo": "bar"}}}'
+
+        self.check_data(rules.dash_E(['foo.foo.foo.foo.foo']), data, CRITICAL_CODE)
+
+    def test_subarrayelem_missing_elem(self):
+
+        rules = RulesHelper()
+        data = '[{"capacity": {"value": 1000}},{"capacity": {"value": 2200}}]'
+
+        self.check_data(rules.dash_E(['(*).capacity.value']), data, OK_CODE)
+        self.check_data(rules.dash_E(['(*).capacity.value.too_deep']), data, CRITICAL_CODE)
+        # Should not throw keyerror
+        self.check_data(rules.dash_E(['foo']), data, CRITICAL_CODE)
+
+
+    def test_empty_key_value_array(self):
+        """
+        https://github.com/drewkerrigan/nagios-http-json/issues/61
+        """
+
+        rules = RulesHelper()
+
+        # This should simply work
+        data = '[{"update_status": "finished"},{"update_status": "finished"}]'
+        self.check_data(rules.dash_q(['(*).update_status,finished']), data, OK_CODE)
+
+        # This should warn us
+        data = '[{"update_status": "finished"},{"update_status": "failure"}]'
+        self.check_data(rules.dash_q(['(*).update_status,finished']), data, WARNING_CODE)
+
+        # This should throw an error
+        data = '[]'
+        self.check_data(rules.dash_q(['(*).update_status,warn_me']), data, CRITICAL_CODE)

test/test_cli.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+
+
+import unittest
+import unittest.mock as mock
+import sys
+import os
+
+sys.path.append('..')
+
+from check_http_json import debugPrint
+
+
+class CLITest(unittest.TestCase):
+    """
+    Tests for CLI
+    """
+
+    def setUp(self):
+        """
+        Defining the exitcodes
+        """
+
+        self.exit_0 = 0 << 8
+        self.exit_1 = 1 << 8
+        self.exit_2 = 2 << 8
+        self.exit_3 = 3 << 8
+
+    def test_debugprint(self):
+        with mock.patch('builtins.print') as mock_print:
+            debugPrint(True, 'debug')
+            mock_print.assert_called_once_with('debug')
+
+    def test_debugprint_pprint(self):
+        with mock.patch('check_http_json.pprint') as mock_pprint:
+            debugPrint(True, 'debug', True)
+            mock_pprint.assert_called_once_with('debug')
+
+    def test_cli_without_params(self):
+
+        command = '/usr/bin/env python3 check_http_json.py > /dev/null 2>&1'
+        status = os.system(command)
+
+        self.assertEqual(status, self.exit_2)

test/test_main.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python3
+
+
+import unittest
+import unittest.mock as mock
+import sys
+import os
+
+sys.path.append('..')
+
+from check_http_json import main
+
+
+class MockResponse():
+    def __init__(self, status_code=200, content='{"foo": "bar"}'):
+        self.status_code = status_code
+        self.content = content
+
+    def read(self):
+        return self.content
+
+
+class MainTest(unittest.TestCase):
+    """
+    Tests for Main
+    """
+
+    @mock.patch('builtins.print')
+    def test_main_version(self, mock_print):
+        args = ['--version']
+
+        with self.assertRaises(SystemExit) as test:
+            main(args)
+
+        mock_print.assert_called_once()
+        self.assertEqual(test.exception.code, 0)
+
+    @mock.patch('builtins.print')
+    @mock.patch('urllib.request.urlopen')
+    def test_main_with_ssl(self, mock_request, mock_print):
+        args = '-H localhost --ssl'.split(' ')
+
+        mock_request.return_value = MockResponse()
+
+        with self.assertRaises(SystemExit) as test:
+            main(args)
+
+        self.assertEqual(test.exception.code, 0)
+
+
+    @mock.patch('builtins.print')
+    @mock.patch('urllib.request.urlopen')
+    def test_main_with_parse_error(self, mock_request, mock_print):
+        args = '-H localhost'.split(' ')
+
+        mock_request.return_value = MockResponse(content='not JSON')
+
+        with self.assertRaises(SystemExit) as test:
+            main(args)
+
+        self.assertTrue('Parser error' in str(mock_print.call_args))
+        self.assertEqual(test.exception.code, 3)
+
+    @mock.patch('builtins.print')
+    def test_main_with_url_error(self, mock_print):
+        args = '-H localhost'.split(' ')
+
+        with self.assertRaises(SystemExit) as test:
+            main(args)
+
+        self.assertTrue('URLError' in str(mock_print.call_args))
+        self.assertEqual(test.exception.code, 3)
+
+    @mock.patch('builtins.print')
+    @mock.patch('urllib.request.urlopen')
+    def test_main_with_http_error_no_json(self, mock_request, mock_print):
+        args = '-H localhost'.split(' ')
+
+        mock_request.return_value = MockResponse(content='not JSON', status_code=503)
+
+        with self.assertRaises(SystemExit) as test:
+            main(args)
+
+        self.assertTrue('Parser error' in str(mock_print.call_args))
+        self.assertEqual(test.exception.code, 3)
+
+    @mock.patch('builtins.print')
+    @mock.patch('urllib.request.urlopen')
+    def test_main_with_http_error_valid_json(self, mock_request, mock_print):
+        args = '-H localhost'.split(' ')
+
+        mock_request.return_value = MockResponse(status_code=503)
+
+        with self.assertRaises(SystemExit) as test:
+            main(args)
+
+        self.assertEqual(test.exception.code, 0)

test/test_nagioshelper.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+
+
+import json
+import unittest
+from unittest.mock import patch
+import sys
+
+sys.path.append('..')
+
+from check_http_json import *
+
+
+class NagiosHelperTest(unittest.TestCase):
+    """
+    Tests for the NagiosHelper
+    """
+
+    def test_getcode_default(self):
+
+        helper = NagiosHelper()
+        self.assertEqual(0, helper.getCode())
+
+    def test_getcode_warning(self):
+
+        helper = NagiosHelper()
+        helper.warning_message = 'foobar'
+        self.assertEqual(1, helper.getCode())
+
+    def test_getcode_critical(self):
+
+        helper = NagiosHelper()
+        helper.critical_message = 'foobar'
+        self.assertEqual(2, helper.getCode())
+
+    def test_getcode_unknown(self):
+
+        helper = NagiosHelper()
+        helper.unknown_message = 'foobar'
+        self.assertEqual(3, helper.getCode())
+
+    def test_getmessage_default(self):
+
+        helper = NagiosHelper()
+        self.assertEqual('OK: Status OK.', helper.getMessage())
+
+    def test_getmessage_perfomance_data(self):
+
+        helper = NagiosHelper()
+        helper.performance_data = 'foobar'
+        self.assertEqual('OK: foobar Status OK. |foobar', helper.getMessage())