Merge ~aieri/charm-hw-health:bug/1838457-HPArgumentParser into ~aieri/charm-hw-health:bug/1838457

[Drew Freiberger]

Unmerged commits

5956c9b... by Andrea Ieri on 2020-03-24

[cron_ilorest] switch parse_args to use the default behavior of reading sys.argv[1:] when args=None

ef5c96d... by Andrea Ieri on 2020-03-24

Use the ArgumentDefaultsHelpFormatter formatter class by default

a8bc9e5... by Andrea Ieri on 2020-03-23

convert hp cron tools to use the HPArgumentParser subclass

diff --git a/src/files/common/hw_health_lib.py b/src/files/common/hw_health_lib.py
index 3c48d8d..c3b45a3 100644
--- a/src/files/common/hw_health_lib.py
+++ b/src/files/common/hw_health_lib.py
@@ -9,7 +9,6 @@ import argparse
 import os
 import re
 import subprocess
-import sys
 import tempfile
 import yaml
 
@@ -165,76 +164,6 @@ def get_hp_controller_slots():
     return slots
 
 
-def parse_args_wrapper(desc=None, write_filepath=None, exclude_filepath=None):
-    """
-    decorator that wraps parse_args for hw-health tools in a common set of
-    arguments and allows each module to add additional command-line arguments
-    """
-    def decorator(func, *args, **kwargs):
-        def wrapped_func(*args, **kwargs):
-            if kwargs.get('argv') is None:
-                argv = sys.argv
-                kwargs['argv'] = argv
-            else:
-                argv = kwargs['argv']
-
-            parser = argparse.ArgumentParser(
-                description=desc,
-                formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            )
-
-            parser.add_argument(
-                '--debug', dest='debug', action='store_true',
-                help='Extra debugging',
-            )
-
-            parser.add_argument(
-                '--exclude', dest='exclude', type=str, action='append',
-                help='Errors to ignore (multiple)',
-            )
-
-            exclude_file = '/etc/nagios/{}.exclude.yaml'.format(desc)
-            if exclude_filepath:
-                exclude_file = exclude_filepath
-
-            parser.add_argument(
-                '--exclude-file', dest='exclude_file', type=str,
-                default=exclude_file,
-                help='YAML file with errors to ignore',
-            )
-
-            default_file = '/var/lib/nagios/{}.out'.format(desc)
-            if write_filepath:
-                default_file = write_filepath
-
-            parser.add_argument(
-                '-w', '--write', dest='write', type=str,
-                default=default_file,
-                help='Write nagios status lines to file',
-            )
-
-            # allow the wrapped function to extend parser with add_argument calls
-            parser = func(parser, *args, **kwargs)
-
-            parsed_args = parser.parse_args(args=argv[1:])
-
-            if parsed_args.exclude is None:
-                parsed_args.exclude = []
-            if parsed_args.exclude_file and os.path.exists(parsed_args.exclude_file):
-                with open(parsed_args.exclude_file) as f:
-                    y = yaml.safe_load(f)
-                for i in y:
-                    if (
-                        'expires' in i and  # noqa:W504
-                        i['expires'] < datetime.datetime.now()
-                    ):
-                        continue
-                    parsed_args.exclude.append(i['error'])
-            return parsed_args
-        return wrapped_func
-    return decorator
-
-
 class HPArgumentParser(argparse.ArgumentParser):
     def __init__(
         self,
@@ -243,7 +172,12 @@ class HPArgumentParser(argparse.ArgumentParser):
         *args,
         **kwargs
     ):
-        super().__init__(*args, **kwargs)
+        super().__init__(
+            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+            *args,
+            **kwargs
+        )
+
         # self.prog is populated by ArgumentParser
         self._def_write_file = \
             def_write_file or '/var/lib/nagios/{}.out'.format(self.prog)
diff --git a/src/files/hplog/cron_hplog.py b/src/files/hplog/cron_hplog.py
index 5e0cf73..d2b21cf 100755
--- a/src/files/hplog/cron_hplog.py
+++ b/src/files/hplog/cron_hplog.py
@@ -20,7 +20,7 @@ try:
         read_ignore_file,
         write_ignore_file,
         ignore,
-        parse_args_wrapper,
+        HPArgumentParser,
     )
 except ImportError:
     # shared lib will be under $CHARM_SOURCE_DIR/files/common during unit tests
@@ -33,7 +33,7 @@ except ImportError:
         read_ignore_file,
         write_ignore_file,
         ignore,
-        parse_args_wrapper,
+        HPArgumentParser,
     )
 
 FLAG_PROCESSOR = {
@@ -42,27 +42,32 @@ FLAG_PROCESSOR = {
     'p': 'parse_power',
     'v': 'save_log',
 }
+OUTPUT_FILE = '/var/lib/nagios/hplog.out'
+EXCLUDE_FILE = '/etc/nagios/hplog.exclude.yaml'
+DEBUG_FILE = '/var/lib/nagios/hplog.debug'
 
 
-@parse_args_wrapper(desc='cron_hplog',
-                    write_filepath='/var/lib/nagios/hplog.out',
-                    exclude_filepath='/etc/nagios/hplog.exclude.yaml')
-def parse_args(parser, *args, **kwargs):
+def parse_args(argv=None):
+    parser = HPArgumentParser(
+        prog='cron_hplog',
+        def_write_file=OUTPUT_FILE,
+        def_exclude_file=EXCLUDE_FILE
+    )
     parser.add_argument(
         '-f', '--hplog_flags', dest='hplog_flags', type=str,
-        default='t,p,f,v',
+        default=','.join(FLAG_PROCESSOR.keys()),
         help='Flags to call hplog with',
     )
     parser.add_argument(
         '-l', '--log_path', dest='log_path', type=str,
-        default='/var/lib/nagios/hplog.debug',
+        default=DEBUG_FILE,
         help='Where to write hplog -v output for troubleshooting',
     )
     parser.add_argument(
         '-s', '--single_psu', dest='single_psu', action='store_true',
         help='Do not alert on lack of PSU redundancy', default=False,
     )
-    return parser
+    return parser.parse_args(args=argv)
 
 
 def call_hplog(flag):
diff --git a/src/files/hpssacli/cron_hpssacli.py b/src/files/hpssacli/cron_hpssacli.py
new file mode 100755
index 0000000..74d7619
--- /dev/null
+++ b/src/files/hpssacli/cron_hpssacli.py
@@ -0,0 +1,202 @@
+<<<<<<< src/files/hpssacli/cron_hpssacli.py
+=======
+#!/usr/bin/env python3
+# -----------------------------------------------
+# This file is juju managed
+# -----------------------------------------------
+
+# Copyright (C) 2008-2013  James Troup <[e-mail]>
+# Copyright (c) 2020 Rewrite: Drew Freiberger <[e-mail]>
+
+# hpssacli lives in either /usr/sbin or /sbin depending on version of the
+# package and cron jobs don't get a sane $PATH
+"""  OLD SCRIPT THAT COLLECTED INFO TO PORT
+export PATH=$PATH:/usr/sbin:/sbin
+
+# Not all HP's have CCISS and iLO (e.g. DL140 G1 (old), RX2600 (!x86), etc.)
+cciss=`find /sys/block | grep -c /cciss`
+array=`egrep -c "storage +Smart Array" /var/lib/nagios/cat-lshw.txt`
+cd /var/lib/nagios/
+
+# Check storage status (assuming we have an array to check)
+if [ -s /etc/cat-cciss-slots.txt ] && [ $cciss -gt 0 -o $array -gt 0 ]; then
+  for slot in $(cat /etc/cat-cciss-slots.txt); do
+    hpssacli ctrl slot=${slot} ld all show status >> cat-hp-array.txt.new ;
+    hpssacli ctrl slot=${slot} pd all show status >> cat-hp-array.txt.new ;
+    hpssacli ctrl slot=${slot} show status >> cat-hp-controller.txt.new ;
+  done
+else
+  # Create a dummy OK line to keep nagios checks happy
+  echo 'Smart Array IS NOT INSTALLED' > cat-hp-controller.txt.new
+  echo '  Status: OK' >> cat-hp-controller.txt.new
+  echo 'physicaldrive (NO ARRAY CONTROLLER INSTALLED): OK' > cat-hp-array.txt.new  # noqa E501
+fi
+"""
+import os
+import re
+import subprocess
+import sys
+
+try:
+    # shared lib will be under $NAGIOS_PLUGIN_DIR at runtime
+    from hw_health_lib import (
+        read_ignore_file,
+        write_ignore_file,
+        ignore,
+        get_hp_controller_slots,
+    )
+except ImportError:
+    # shared lib will be under $CHARM_SOURCE_DIR/files/common during unit tests
+    common_libs_dir = os.path.abspath(
+        os.path.join(os.path.dirname(__file__), '..', 'common')
+    )
+    if common_libs_dir not in sys.path:
+        sys.path.append(common_libs_dir)
+    from hw_health_lib import (
+        read_ignore_file,
+        write_ignore_file,
+        ignore,
+        get_hp_controller_slots,
+        HPArgumentParser,
+    )
+
+OUTPUT_FILE = '/var/lib/nagios/hpssacli.out'
+EXCLUDE_FILE = '/etc/nagios/hpssacli.exclude.yaml'
+
+
+def parse_args(argv=None):
+    parser = HPArgumentParser(
+        prog='cron_hpssacli',
+        def_write_file=OUTPUT_FILE,
+        def_exclude_file=EXCLUDE_FILE
+    )
+    return parser.parse_args(args=argv)
+
+
+def check_array(slot):
+    """
+    RAID arrays [hpacucli]
+
+    logicaldrive 1 (68.3 GB, RAID RAID 1+0):  OK
+    logicaldrive 1 (2.8 TB, RAID RAID 6 (ADG)):  OK
+    physicaldrive 1:1 (box 1:bay 1, 72 GB): OK
+    physicaldrive 1:2 (box 1:bay 2, 72 GB): OK
+    """
+    if os.path.isfile('/etc/nagios/skip-cat-hp-array.txt'):
+        return
+
+    cmd = (
+        'hpssacli ctrl slot={} ld all show status; '
+        'hpssacli ctrl slot={} pd all show status'.format(slot, slot)
+    )
+    try:
+        result = subprocess.check_output(cmd, shell=True).decode('UTF-8')
+        return _parse_array_output(result)
+    except subprocess.CalledProcessError as e:
+        return (
+            'UNKNOWN Call to hpssacli to show ld/pd info failed. '
+            'Array Slot {} - Return Code {} - {}'
+            ''.format(slot, e.returncode, e.output)
+        )
+
+
+def _parse_array_output(output):
+    innocuous_errors = re.compile(r'^Error: The specified (device|controller) '
+                                  'does not have any (logical|physical)')
+    drive_status_line = re.compile(r'^\s*(logicaldrive|physicaldrive)')
+    ignore_file = '/etc/nagios/ignores/ignores-cat-hp-array.txt'
+    ignores = read_ignore_file(ignore_file)
+
+    for line in output.splitlines():
+        line = line.strip()
+        if (not line or innocuous_errors.search(line)
+           or not drive_status_line.search(line)):
+            continue
+        (drivetype, number) = line.split()[:2]
+        status = line.split('):')[1].lstrip().upper()
+        if status != 'OK':
+            err = '{} {} is "{}"'.format(drivetype, number, status)
+            if not ignore(err, ignores):
+                return err
+    write_ignore_file(ignores, ignore_file)
+
+
+def check_controller(slot):
+    """
+    RAID controllers [hpacucli]
+
+    Smart Array 6400 in Slot 1
+      Controller Status: OK
+      Cache Status: OK
+      Battery Status: Failed (Replace Batteries)
+    """
+    if os.path.isfile('/etc/nagios/skip-cat-hp-controller.txt'):
+        return
+
+    cmd = ('hpssacli ctrl slot={} show status'.format(slot))
+    try:
+        result = subprocess.check_output(cmd, shell=True).decode('UTF-8')
+        return _parse_controller_output(result)
+    except subprocess.CalledProcessError as e:
+        return (
+            'UNKNOWN Call to hpssacli to show ld/pd info failed. '
+            'Array Slot {} - Return Code {} - {}'
+            ''.format(slot, e.returncode, e.output)
+        )
+
+
+def _parse_controller_output(output):
+    controller = "Unknown"
+    ignore_file = '/etc/nagios/ignores/ignores-cat-hp-controller.txt'
+    ignores = read_ignore_file(ignore_file)
+    for line in output.splitlines():
+        line = line.strip()
+        if not line:
+            continue
+        if line.startswith("Smart Array") or line.startswith("Smart HBA"):
+            controller = line
+        else:
+            if ":" not in line:
+                err = "UNKNOWN Unrecognised line for controller '%s'" % (line)
+                return err
+            (part, status) = line.split(":")
+            status = status.strip().upper()
+            if status != "OK":
+                err = "%s on %s is '%s'" % (part, controller, status)
+                if not ignore(err, ignores):
+                    return err
+    write_ignore_file(ignores, ignore_file)
+
+
+def main():
+    global ARGS
+    ARGS = parse_args()
+
+    slots = get_hp_controller_slots()
+    if not slots:
+        msg = 'OK: no controller/array found to check'
+        exit = 0
+
+    errors = []
+    for slot in slots:
+        errors += check_controller(slot)
+        errors += check_array(slot)
+
+    if len(errors) > 0:
+        msg = 'CRIT {} error(s): {}'.format(len(errors), ' - '.join(errors))
+        exit = 2
+    else:
+        msg = 'OK No errors found'
+        exit = 0
+
+    if ARGS.write:
+        with open(ARGS.write, 'w') as f:
+            f.write(msg)
+    else:
+        print(msg)
+    sys.exit(exit)
+
+
+if __name__ == '__main__':
+    main()
+>>>>>>> src/files/hpssacli/cron_hpssacli.py
diff --git a/src/files/ilorest/cron_ilorest.py b/src/files/ilorest/cron_ilorest.py
index ce59256..739438d 100755
--- a/src/files/ilorest/cron_ilorest.py
+++ b/src/files/ilorest/cron_ilorest.py
@@ -42,7 +42,7 @@ class CronILOrest:
     def __init__(self, argv=[]):
         self.args = self.parse_args(argv)
 
-    def parse_args(self, argv=[]):
+    def parse_args(self, argv=None):
         parser = HPArgumentParser(
             prog='cron_ilorest',
             description=('Convert the output of ilorest into an appropriate '
@@ -117,7 +117,7 @@ class CronILOrest:
         return errors
 
 
-def main(argv):
+def main(argv=None):
     cronilorest = CronILOrest(argv)
 
     errors = [cronilorest.check_selector(selector)