#!/usr/lib64/linuxfabrik-monitoring-plugins/venv/bin/python
# -*- coding: utf-8; py-indent-offset: 4 -*-
#
# Author:  Linuxfabrik GmbH, Zurich, Switzerland
# Contact: info (at) linuxfabrik (dot) ch
#          https://www.linuxfabrik.ch/
# License: The Unlicense, see LICENSE file.

# https://github.com/Linuxfabrik/monitoring-plugins/blob/main/CONTRIBUTING.md

"""See the check's README for more details."""

import argparse
import json
import re
import sys

import lib.args
import lib.base
import lib.huawei_dorado
import lib.lftest
import lib.txt
from lib.globals import STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN

__author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
__version__ = '2026081102'

DESCRIPTION = """Checks the health and running status of all power modules on a Huawei OceanStor Dorado
storage system via the REST API (/power endpoint). Alerts when any module reports a
non-normal state.
Supports extended reporting via --lengthy."""

DEFAULT_CACHE_EXPIRE = 15  # minutes; default session timeout period is 20 minutes
DEFAULT_CRIT_TEMPERATURE = ''
DEFAULT_DEVICE_ID = ''  # the appliance reports its own at login
DEFAULT_INSECURE = True
DEFAULT_NO_MATCH_SEVERITY = 'ok'
DEFAULT_NO_PROXY = False
DEFAULT_SCOPE = '0'
DEFAULT_TIMEOUT = 3
DEFAULT_WARN_TEMPERATURE = ''

# Highest `HEALTHSTATUS` code the REST Interface References document (offline). It
# bounds the metric so a graph scales to the whole enumeration; the thresholds stay
# out of the performance data, because whether a code is a fault depends on the
# object and is decided in `lib.huawei_dorado.get_health_status_state()`.
HEALTH_STATUS_MAX = 18

# Fields `--match` is applied to.
MATCH_FIELDS = ('UUID', 'LOCATION')

# RUNNINGSTATUS codes a healthy power module reports: normal (1), running (2) and
# online (27).
OK_RUNNING_STATUS = (1, 2, 27)


def parse_args():
    """Parse command line arguments using argparse."""
    parser = argparse.ArgumentParser(
        description=DESCRIPTION,
        epilog=lib.args.epilog(__file__),
        formatter_class=lib.args.HelpFormatter,
    )

    parser.add_argument(
        '-V',
        '--version',
        action='version',
        version=f'%(prog)s: v{__version__} by {__author__}',
    )

    parser.add_argument(
        '--always-ok',
        help=lib.args.help('--always-ok'),
        dest='ALWAYS_OK',
        action='store_true',
        default=False,
    )

    parser.add_argument(
        '--cache-expire',
        help=lib.args.help('--cache-expire') + ' Default: %(default)s',
        dest='CACHE_EXPIRE',
        type=int,
        default=DEFAULT_CACHE_EXPIRE,
    )

    parser.add_argument(
        '--critical-temperature',
        help=lib.args.help('--critical-temperature')
        + ' Off by default, because a healthy operating temperature depends on the '
        'power module model and on where the array stands. '
        'Example: `--critical-temperature=55`',
        dest='CRIT_TEMPERATURE',
        default=DEFAULT_CRIT_TEMPERATURE,
    )

    parser.add_argument(
        '--device-id',
        help='Huawei OceanStor Dorado API device ID. '
        'Optional: the appliance reports its own at login, so this is only '
        'needed to override that answer.',
        dest='DEVICE_ID',
        default=DEFAULT_DEVICE_ID,
    )

    parser.add_argument(
        '--ignore',
        help='Skip power modules. '
        + lib.args.help('--ignore-regex')
        + ' The regex is anchored at the start of the string (Python `re.match`) and is '
        'matched against `UUID`, `LOCATION`, so prefix with `.*` to match anywhere.',
        dest='IGNORE',
        action='append',
        default=None,
    )

    parser.add_argument(
        '--insecure',
        help=lib.args.help('--insecure'),
        dest='INSECURE',
        action='store_true',
        default=DEFAULT_INSECURE,
    )

    parser.add_argument(
        '--lengthy',
        help=lib.args.help('--lengthy'),
        dest='LENGTHY',
        action='store_true',
        default=False,
    )

    parser.add_argument(
        '--no-insecure',
        help=lib.args.help('--no-insecure'),
        dest='INSECURE',
        action='store_false',
        default=DEFAULT_INSECURE,
    )

    parser.add_argument(
        '--match',
        help='Limit to power modules. '
        + lib.args.help('--match')
        + ' The regex is anchored at the start of the string (Python `re.match`) and is '
        'matched against `UUID`, `LOCATION`, so prefix with `.*` to match anywhere.',
        dest='MATCH',
        action='append',
        default=None,
    )

    parser.add_argument(
        '--no-match-severity',
        help=lib.args.help('--no-match-severity') + ' Default: %(default)s',
        dest='NO_MATCH_SEVERITY',
        choices=['ok', 'warn', 'crit', 'unknown'],
        default=DEFAULT_NO_MATCH_SEVERITY,
    )

    parser.add_argument(
        '--no-perfdata',
        help=lib.args.help('--no-perfdata'),
        dest='NO_PERFDATA',
        action='store_true',
        default=False,
    )

    parser.add_argument(
        '--no-proxy',
        help=lib.args.help('--no-proxy'),
        dest='NO_PROXY',
        action='store_true',
        default=DEFAULT_NO_PROXY,
    )

    parser.add_argument(
        '--password',
        help='Huawei OceanStor Dorado API password.',
        dest='PASSWORD',
    )

    parser.add_argument(
        '--password-file',
        help=lib.args.help('--password-file'),
        dest='PASSWORD_FILE',
    )

    parser.add_argument(
        '--scope',
        help='Huawei OceanStor Dorado API scope.',
        dest='SCOPE',
        default=DEFAULT_SCOPE,
    )

    parser.add_argument(
        '--test',
        help=lib.args.help('--test'),
        dest='TEST',
        type=lib.args.csv,
    )

    parser.add_argument(
        '--timeout',
        help=lib.args.help('--timeout') + ' Default: %(default)s (seconds)',
        dest='TIMEOUT',
        type=int,
        default=DEFAULT_TIMEOUT,
    )

    parser.add_argument(
        '-u',
        '--url',
        help='Huawei OceanStor Dorado API URL.',
        dest='URL',
        required=True,
    )

    parser.add_argument(
        '--username',
        help='Huawei OceanStor Dorado API username.',
        dest='USERNAME',
        required=True,
    )

    parser.add_argument(
        '--warning-temperature',
        help=lib.args.help('--warning-temperature')
        + ' Off by default, because a healthy operating temperature depends on the '
        'power module model and on where the array stands. '
        'Example: `--warning-temperature=45`',
        dest='WARN_TEMPERATURE',
        default=DEFAULT_WARN_TEMPERATURE,
    )

    parser.add_argument(
        '-v',
        '--verbose',
        help=lib.args.help('--verbose')
        + ' Appends what every API request returned, so the appliance\'s own answers '
        'can be read while working out how it reports something. Session tokens are '
        'redacted. The output is as long as those answers are, so this is a debugging '
        'aid rather than something to leave switched on.',
        dest='VERBOSE',
        action='store_true',
        default=False,
    )

    args, _ = parser.parse_known_args()
    return args


def millivolts2volts(millivolts):
    """
    Convert a voltage the API reports in millivolts into volts.

    ### Parameters
    - **millivolts** (`int`, `str` or `None`): The voltage as the API reported it.

    ### Returns
    - **float** or **None**: The voltage in volts, or `None` for a value that cannot be
      used.

    ### Notes
    - A power supply that is not powered reports `0`, which is a reading rather than a
      missing value and stays as it is.

    ### Example
    >>> millivolts2volts('230000')
    230.0
    """
    value = lib.huawei_dorado.as_code(millivolts)
    if value is None or value < 0:
        return None
    return round(value / 1000, 2)


def main():
    """The main function. This is where the magic happens."""

    # parse the command line
    try:
        args = parse_args()
    except SystemExit:
        sys.exit(STATE_UNKNOWN)

    if args.PASSWORD_FILE:
        args.PASSWORD = lib.args.load_secret(args.PASSWORD_FILE)
    if not args.PASSWORD:
        lib.base.cu('Provide the API password via --password or --password-file.')

    # set default values for append parameters that were not specified
    if args.IGNORE is None:
        args.IGNORE = []
    if args.MATCH is None:
        args.MATCH = []

    if not args.URL.startswith('http'):
        lib.base.cu('--url parameter has to start with "http://" or https://".')

    # fetch data
    if args.TEST is None:
        result = lib.huawei_dorado.get_data('power', args)
    else:
        # do not call the command, put in test data
        stdout, _stderr, _retc = lib.lftest.test(args.TEST)
        result = json.loads(stdout)

    # no valuable result?
    lib.huawei_dorado.assert_ok(result, 'the power modules')

    # An appliance always has power modules, so an empty list is a query that
    # never reached them rather than an inventory that is genuinely empty.
    # Reporting OK here would hide the fault behind a green check.
    if not result.get('data'):
        lib.base.oao(
            f'{args.URL} reported no power modules.'
            ' Verify that the API user is allowed to query them.',
            STATE_UNKNOWN,
        )

    # init some vars
    msg = ''
    state = STATE_OK
    perfdata = ''
    compiled_match_regex = [
        lib.base.coe(item) for item in lib.txt.compile_regex(args.MATCH, '--match')
    ]
    compiled_ignore_regex = [
        lib.base.coe(item)
        for item in lib.txt.compile_regex(args.IGNORE, '--ignore')
    ]

    # analyze data
    table_data = []
    for power in result.get('data') or []:
        power['UUID'] = lib.huawei_dorado.get_uuid(power)
        # Perfdata labels carry the object's own TYPE:ID, which stays the same
        # when hardware is moved between slots, unlike its location.
        label = re.sub(r'\W+', '_', power['UUID'])

        if args.MATCH and not any(
            lib.base.coe(lib.txt.match_regex(pattern, str(power.get(field, ''))))
            for pattern in compiled_match_regex
            for field in MATCH_FIELDS
        ):
            continue

        if args.IGNORE and any(
            lib.base.coe(lib.txt.match_regex(pattern, str(power.get(field, ''))))
            for pattern in compiled_ignore_regex
            for field in MATCH_FIELDS
        ):
            continue

        health_state = lib.huawei_dorado.get_health_status_state(
            power.get('HEALTHSTATUS')
        )
        state = lib.base.get_worst(state, health_state)

        # The temperature thresholds are off unless the operator sets them: what counts as
        # hot depends on the model and on where the array stands. A part without a
        # temperature sensor reports a placeholder rather than a reading, which is neither
        # compared against a threshold nor graphed.
        temperature = lib.huawei_dorado.as_temperature(power.get('TEMPERATURE'))
        if temperature and (args.WARN_TEMPERATURE or args.CRIT_TEMPERATURE):
            state = lib.base.get_worst(
                state,
                lib.base.get_state(
                    temperature,
                    args.WARN_TEMPERATURE or None,
                    args.CRIT_TEMPERATURE or None,
                    _operator='range',
                ),
            )

        running_state = lib.huawei_dorado.get_running_status_state(
            power.get('RUNNINGSTATUS'), OK_RUNNING_STATUS
        )
        state = lib.base.get_worst(state, running_state)

        perfdata += lib.base.get_perfdata(
            f'{label}_health_status',
            power.get('HEALTHSTATUS'),
            uom=None,
            _min=0,
            _max=HEALTH_STATUS_MAX,
        )
        perfdata += lib.base.get_perfdata(
            f'{label}_running_status',
            power.get('RUNNINGSTATUS'),
            _min=0,
        )
        # The API counts both voltages in millivolts. They go out in volts, which is
        # what an operator reads off the label of the power supply and what the backup
        # power modules of the same appliance are reported in.
        power['INPUTVOLTAGE'] = millivolts2volts(power.get('INPUTVOLTAGE'))
        power['OUTPUTVOLTAGE'] = millivolts2volts(power.get('OUTPUTVOLTAGE'))
        perfdata += lib.base.get_perfdata(
            f'{label}_input_voltage',
            power['INPUTVOLTAGE'],
            uom=None,
            _min=0,
        )
        perfdata += lib.base.get_perfdata(
            f'{label}_output_voltage',
            power['OUTPUTVOLTAGE'],
            uom=None,
            _min=0,
        )
        perfdata += lib.base.get_perfdata(
            f'{label}_temperature',
            temperature,
            uom=None,
            warn=args.WARN_TEMPERATURE or None,
            crit=args.CRIT_TEMPERATURE or None,
            _min=0,
        )

        power['health'] = lib.huawei_dorado.get_health_status(
            power.get('HEALTHSTATUS')
        )
        power['running'] = lib.huawei_dorado.get_running_status(
            power.get('RUNNINGSTATUS')
        )
        # One state per row, in the last column. IcingaWeb replaces a state with an
        # icon, which shifts everything to the right of it, so a second one mid-row
        # would break the table. What decided it stays readable in the two columns
        # in front of it.
        power['state'] = lib.base.state2str(
            lib.base.get_worst(health_state, running_state), empty_ok=False
        )
        # The performance data is written above, so what is left here is the display
        # value. A supply that reports neither reading prints the appliance's own
        # placeholder rather than a literal "None".
        power['TEMPERATURE'] = '--' if temperature is None else temperature
        for field in ('INPUTVOLTAGE', 'OUTPUTVOLTAGE'):
            if power[field] is None:
                power[field] = '--'

        table_data.append(power)

    # The appliance listed power modules and the filter selected none of them.
    if not table_data:
        lib.base.oao(
            f'No power modules matched `{", ".join(args.MATCH)}`.',
            lib.base.str2state(args.NO_MATCH_SEVERITY),
            always_ok=args.ALWAYS_OK,
            no_perfdata=args.NO_PERFDATA,
        )

    # build the message
    if state == STATE_CRIT:
        msg += 'There are critical errors.'
    elif state == STATE_WARN:
        msg += 'There are warnings.'
    else:
        msg += 'Everything is ok.'
    msg += '\n\n'

    # build table output
    if table_data:
        if args.LENGTHY:
            keys = [
                'UUID',
                'LOCATION',
                'MANUFACTURER',
                'MODEL',
                'SERIALNUMBER',
                'PRODUCEDATE',
                'INPUTVOLTAGE',
                'OUTPUTVOLTAGE',
                'TEMPERATURE',
                'health',
                'running',
                'state',
            ]
            headers = [
                'UUID',
                'Location',
                'Manufacturer',
                'Model',
                'SerialNumber',
                'Produced',
                'In (V)',
                'Out (V)',
                'Temp',
                'Health',
                'Running',
                'State',
            ]
        else:
            keys = [
                'UUID',
                'LOCATION',
                'INPUTVOLTAGE',
                'OUTPUTVOLTAGE',
                'TEMPERATURE',
                'health',
                'running',
                'state',
            ]
            headers = [
                'UUID',
                'Location',
                'In (V)',
                'Out (V)',
                'Temp',
                'Health',
                'Running',
                'State',
            ]

        msg += lib.base.get_table(
            table_data, keys, header=headers, missing='--', hide_empty=True
        )

    if args.VERBOSE:
        msg += '\n\n' + lib.huawei_dorado.format_responses()

    # over and out
    lib.base.oao(
        msg, state, perfdata, always_ok=args.ALWAYS_OK, no_perfdata=args.NO_PERFDATA
    )


if __name__ == '__main__':
    try:
        main()
    except Exception:
        lib.base.cu()
