Merge pull request NETWAYS#16 from NETWAYS/feature/envflags

Add option to set flags via env variables

README.md

@@ -27,9 +27,9 @@ optional arguments:
   -h, --help            show this help message and exit
   --api API, -A API     VMware NSX-T URL without any sub-path (e.g. https://vmware-nsx.local)
   --username USERNAME, -u USERNAME
-                        Username for Basic Auth
+                        Username for Basic Auth (CHECK_VMWARE_NSXT_API_USER)
   --password PASSWORD, -p PASSWORD
-                        Password for Basic Auth
+                        Password for Basic Auth (CHECK_VMWARE_NSXT_API_PASSWORD)
   --mode MODE, -m MODE  Check mode
   --exclude [EXCLUDE ...]
                         Exclude alarms or usage from the check results.
@@ -45,6 +45,8 @@ The `--exclude` parameter will match against alarms and capacity-usage. It uses
 * alarms: `severity` `node_display_name` `feature_display_name` `event_type_display_name`
 * capacity-usage: `severity` `display_name`
 
+Various flags can be set with environment variables, refer to the help to see which flags.
+
 ## Examples
 
 Mode: cluster-status

check_vmware_nsxt.py

@@ -436,14 +436,24 @@ def worst_state(*states):
 
 
 def commandline(args):
+    """
+    Parse commandline arguments.
+    """
+    def environ_or_required(key):
+        return ({'default': os.environ.get(key)} if os.environ.get(key) else {'required': True})
+
     parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawTextHelpFormatter)
 
-    parser.add_argument('--api', '-A', required=True,
-        help='VMware NSX-T URL without any sub-path (e.g. https://vmware-nsx.local)')
+    parser.add_argument('--api', '-A',
+                        **environ_or_required('CHECK_VMWARE_NSXT_API_URL'),
+                        help='VMware NSX-T URL without any sub-path (e.g. https://vmware-nsx.local)')
     parser.add_argument('--username', '-u',
-                        help='Username for Basic Auth', required=True)
+                        **environ_or_required('CHECK_VMWARE_NSXT_API_USER'),
+                        help='Username for Basic Auth')
     parser.add_argument('--password', '-p',
-                        help='Password for Basic Auth', required=True)
+                        **environ_or_required('CHECK_VMWARE_NSXT_API_PASSWORD'),
+                        help='Password for Basic Auth')
+
     parser.add_argument('--mode', '-m', choices=['cluster-status', 'alarms', 'capacity-usage'],
                         help='Check mode to exectue. Hint: alarms will only include open alarms.', required=True)
     parser.add_argument('--exclude', nargs='*', action='extend', type=str,

requirements-dev.txt

@@ -1,2 +1,2 @@
-pylint==2.15.0
-coverage==7.0.5
+pylint==3.0.2
+coverage==7.3.2

test_check_vmware_nsxt.py

@@ -3,7 +3,6 @@
 import unittest
 import unittest.mock as mock
 import sys
-
 import os
 import datetime
 import json
@@ -42,6 +41,17 @@ def test_commandline(self):
         self.assertFalse(actual.insecure)
         self.assertEqual(actual.max_age, 5)
 
+    def test_commandline_fromenv(self):
+        os.environ['CHECK_VMWARE_NSXT_API_USER'] = 'GEH'
+        os.environ['CHECK_VMWARE_NSXT_API_PASSWORD'] = 'HEIM'
+
+        actual = commandline(['-A', 'api', '-m', 'alarms'])
+        self.assertEqual(actual.username, 'GEH')
+        self.assertEqual(actual.password, 'HEIM')
+
+        os.unsetenv('CHECK_VMWARE_NSXT_API_USER')
+        os.unsetenv('CHECK_VMWARE_NSXT_API_PASSWORD')
+
 class UtilTesting(unittest.TestCase):
 
     def test_worst_state(self):