#!/usr/bin/python
# -*- encoding: utf-8; py-indent-offset: 4 -*-
# +------------------------------------------------------------------+
# |             ____ _               _        __  __ _  __           |
# |            / ___| |__   ___  ___| | __   |  \/  | |/ /           |
# |           | |   | '_ \ / _ \/ __| |/ /   | |\/| | ' /            |
# |           | |___| | | |  __/ (__|   <    | |  | | . \            |
# |            \____|_| |_|\___|\___|_|\_\___|_|  |_|_|\_\           |
# |                                                                  |
# | Copyright Mathias Kettner 2014             mk@mathias-kettner.de |
# +------------------------------------------------------------------+
#
# This file is part of Check_MK.
# The official homepage is at http://mathias-kettner.de/check_mk.
#
# check_mk is free software;  you can redistribute it and/or modify it
# under the  terms of the  GNU General Public License  as published by
# the Free Software Foundation in version 2.  check_mk is  distributed
# in the hope that it will be useful, but WITHOUT ANY WARRANTY;  with-
# out even the implied warranty of  MERCHANTABILITY  or  FITNESS FOR A
# PARTICULAR PURPOSE. See the  GNU General Public License for more de-
# ails.  You should have  received  a copy of the  GNU  General Public
# License along with GNU Make; see the file  COPYING.  If  not,  write
# to the Free Software Foundation, Inc., 51 Franklin St,  Fifth Floor,
# Boston, MA 02110-1301 USA.

# Description of OIDs used from RFC 1628
# OID: 1.3.6.1.2.1.33.1.7.3
# upsTestResultsSummary OBJECT-TYPE
# SYNTAX INTEGER {
#     donePass(1),
#     doneWarning(2),
#     doneError(3),
#     aborted(4),
#     inProgress(5),
#     noTestsInitiated(6)
# }
# MAX-ACCESS read-only
# STATUS current
# DESCRIPTION
# "The results of the current or last UPS diagnostics
# test performed. The values for donePass(1),
# doneWarning(2), and doneError(3) indicate that the
# test completed either successfully, with a warning, or
# with an error, respectively. The value aborted(4) is
# returned for tests which are aborted by setting the
# value of upsTestId to upsTestAbortTestInProgress.
# Tests which have not yet concluded are indicated by
# inProgress(5). The value noTestsInitiated(6)
# indicates that no previous test results are available,
# such as is the case when no tests have been run since
# the last reinitialization of the network management
# subsystem and the system has no provision for non-
# volatile storage of test results."

# OID: 1.3.6.1.2.1.33.1.7.4
# upsTestResultsDetail OBJECT-TYPE
# SYNTAX DisplayString (SIZE (0..255))
# MAX-ACCESS read-only
# STATUS current
# DESCRIPTION
# "Additional information about upsTestResultsSummary.
# If no additional information available, a zero length
# string is returned."

# OID: 1.3.6.1.2.1.33.1.7.5
# Description:
# upsTestStartTime OBJECT-TYPE
# SYNTAX TimeStamp
# MAX-ACCESS read-only
# STATUS current
# DESCRIPTION
# "The value of sysUpTime at the time the test in
# progress was initiated, or, if no test is in progress,
# the time the previous test was initiated. If the
# value of upsTestResultsSummary is noTestsInitiated(6),
# upsTestStartTime has the value 0."

ups_test_default = (0, 0)

def inventory_ups_test(info):
    if info[1]:
        return [ (None, "ups_test_default") ]

def check_ups_test(_no_item, params, info):
    warn, crit = params

    uptime_info, bat_info = info
    ResultsSummary, StartTime, upsTestResultsDetail = bat_info[0]
    uptime = parse_snmp_uptime(uptime_info[0][0])
    start_time = parse_snmp_uptime(StartTime)

    # State of test
    state = 0
    if ResultsSummary in [ '3', '4' ]:
        state = 2
    elif ResultsSummary in [ '2' ]:
        state = 1
    if upsTestResultsDetail or state:
        yield state, upsTestResultsDetail

    # Elapsed time since last start of test
    elapsed = uptime - start_time
    state = 0
    if crit and elapsed >= crit * 86400:
        state = 2
    elif warn and elapsed >= warn * 86400:
        state = 1
    if start_time:
        yield state, "time elapsed since start of last test: %s" % get_age_human_readable(elapsed)
    else:
        yield state, "no battery test since start of device (%s ago)" % get_age_human_readable(uptime)


check_info['ups_test'] = {
    "inventory_function"    : inventory_ups_test,
    "check_function"        : check_ups_test,
    "service_description"   : "Self Test",
    "has_perfdata"          : False,
    "group"                 : "ups_test",
    "snmp_info"             : [
                                 ('.1.3.6.1.2.1.1',       ['3.0']),    # sysUptime
                                 ( ".1.3.6.1.2.1.33.1.7", [ 3, 5, 4 ] ),
                              ],
    "snmp_scan_function"    : lambda oid: oid(".1.3.6.1.2.1.1.2.0") in [ ".1.3.6.1.4.1.534.1", ".1.3.6.1.4.1.818.1.100.1.2" ],
    "includes"              : [ 'uptime.include' ],
}
