Bump version to 2.1.2

Add CLI Flag to change HTTP method

.github/workflows/unittest.yml

@@ -7,21 +7,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: [3.8, 3,9]
     name: GitHub Action
     steps:
     - name: Checkout
       uses: actions/checkout@v2
+    - name: Install dependencies
+      run: |
+        python -m pip install -r requirements-dev.txt
     - name: Lint
       run: |
-        pip3 install --upgrade pip wheel setuptools
+        make lint
-        pip3 install pylint
-        python3 -m pylint check_http_json.py
     - name: Unit Test
       run: |
-        python3 -m unittest discover
+        make test
     - name: Coverage
       run: |
-        pip3 install coverage
+        make coverage
-        python3 -m coverage run -m unittest discover
-        python3 -m coverage report -m --include check_http_json.py

.pylintrc

@@ -1,5 +1,21 @@
 # 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.*
+
+[MESSAGES CONTROL]
+disable=fixme,
+        consider-using-f-string,
+        invalid-name,
+        line-too-long,
+        missing-function-docstring,
+        missing-module-docstring,
+        multiple-imports,
+        no-else-return,
+        redefined-outer-name,
+        superfluous-parens,
+        too-many-locals,
+        too-many-arguments,
+        too-many-branches,
+        too-many-instance-attributes,
+        too-many-return-statements,
+        too-many-statements

Makefile

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

README.md

@@ -38,7 +38,7 @@ 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)
+Version: 2.1.2 (2022-09-15)
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -46,6 +46,8 @@ optional arguments:
   -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
+  -X {GET,POST}, --request {GET,POST}
+                        Specifies a custom request method to use when communicating with the HTTP server
   -V, --version         print version of this plugin
   --cacert CACERT       SSL CA certificate
   --cert CERT           SSL client certificate
@@ -210,7 +212,7 @@ More info about Nagios Range format and Units of Measure can be found at [https:
 
 ### Requirements
 
-* Python 3
+* Python 3.6+
 
 ### Configuration
 

check_http_json.py

@@ -24,8 +24,8 @@ WARNING_CODE = 1
 CRITICAL_CODE = 2
 UNKNOWN_CODE = 3
 
-__version__ = '2.0.0'
+__version__ = '2.1.2'
-__version_date__ = '2020-03-22'
+__version_date__ = '2022-09-15'
 
 class NagiosHelper:
     """
@@ -152,7 +152,7 @@ class JsonHelper:
         (Element.Key.NestedKey). Returns (None, 'not_found') if not found
         """
 
-        if temp_data:
+        if temp_data != '':
             data = temp_data
         else:
             data = self.data
@@ -430,6 +430,8 @@ def parseArgs(args):
                         help='remote host to query')
     parser.add_argument('-k', '--insecure', action='store_true',
                         help='do not check server SSL certificate')
+    parser.add_argument('-X', '--request', dest='method', default='GET', choices=['GET', 'POST'],
+                        help='Specifies a custom request method to use when communicating  with  the HTTP server')
     parser.add_argument('-V', '--version', action='store_true',
                         help='print version of this plugin')
     parser.add_argument('--cacert',
@@ -542,7 +544,7 @@ def main(cliargs):
     if args.ssl:
         url = "https://%s" % args.host
 
-        context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
+        context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
         context.options |= ssl.OP_NO_SSLv2
         context.options |= ssl.OP_NO_SSLv3
 
@@ -550,6 +552,7 @@ def main(cliargs):
             context.verify_mode = ssl.CERT_NONE
         else:
             context.verify_mode = ssl.CERT_OPTIONAL
+            context.load_default_certs()
             if args.cacert:
                 try:
                     context.load_verify_locations(args.cacert)
@@ -586,7 +589,7 @@ def main(cliargs):
     json_data = ''
 
     try:
-        req = urllib.request.Request(url)
+        req = urllib.request.Request(url, method=args.method)
         req.add_header("User-Agent", "check_http_json")
         if args.auth:
             authbytes = str(args.auth).encode()
@@ -598,14 +601,17 @@ def main(cliargs):
             for header in headers:
                 req.add_header(header, headers[header])
         if args.timeout and args.data:
+            databytes = str(args.data).encode()
             response = urllib.request.urlopen(req, timeout=args.timeout,
-                                              data=args.data, context=context)
+                                              data=databytes, context=context)
         elif args.timeout:
             response = urllib.request.urlopen(req, timeout=args.timeout,
                                               context=context)
         elif args.data:
-            response = urllib.request.urlopen(req, data=args.data, context=context)
+            databytes = str(args.data).encode()
+            response = urllib.request.urlopen(req, data=databytes, context=context)
         else:
+            # pylint: disable=consider-using-with
             response = urllib.request.urlopen(req, context=context)
 
         json_data = response.read()

contrib/icinga2_check_command_definition.conf

@@ -97,8 +97,8 @@ object CheckCommand "http_json" {
 			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_metrics" = {
+		"--key_metric" = {
-			value = "$http_json_key_metrics$"
+			value = "$http_json_key_metric$"
 			description = "Gathers the values of these keys"
 		}
 	}

makefile

@@ -1,9 +0,0 @@
-.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

requirements-dev.txt

@@ -0,0 +1,2 @@
+coverage==6.4.4
+pylint==2.15.2