Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

executable file 202 lines (159 sloc) 7.641 kb
#!/usr/bin/env python
import json, sys, os, codecs
from time import gmtime, strftime, time
from syslog import *
from cStringIO import StringIO
def log_result_to_syslog(exitcode, message):
if exitcode == 3:
log_priority = LOG_ERR
elif exitcode == 2:
log_priority = LOG_CRIT
elif exitcode == 1:
log_priority = LOG_WARN
else:
log_priority = LOG_NOTICE
syslog(log_priority, "CHCK | %s@%s | %s" % (sys.argv[1], sys.argv[2], message))
def log_result_and_exit(exitcode, message):
log_result_to_syslog(exitcode, message)
# nagios reads the printed msg for status (http://nagios.sourceforge.net/docs/3_0/pluginapi.html)
print message
sys.exit(exitcode)
class FeatureTestRun(object):
def __init__(self, feature_name, json_data, priority, logfile):
self.feature_found = False
self.passed = 0
self.skipped = 0
self.failed = 0
self.log = ""
self.set_status_for_feature(feature_name, json_data, priority)
self.write_pretty_log(logfile)
def increment_status_and_capture_failure_message(self, step):
failure_message = ""
if step['result']['status'] == 'passed':
self.passed += 1
elif step['result']['status'] == 'skipped':
self.skipped += 1
else:
self.failed += 1
failure_message = step['result']['error_message']
return failure_message
def ascii_step_name(self, step):
return step['name'].encode("ascii", "ignore")
def feature_name(self, feature):
return feature['uri'].split('/')[1].split('.')[0]
def step_status(self, step):
return step['result']['status'].upper()[:4]
def write_step_description_and_status(self, result_details, feature, priority, scenario, step):
result_details.add(" Step: [%s] %s%s\n" % ((self.step_status(step)), step['keyword'], step['name']))
syslog(LOG_NOTICE, "%s | %s%s | %s | %s%s" % (
(self.step_status(step)), (self.feature_name(feature)), priority, scenario['name'],
step['keyword'], self.ascii_step_name(step)))
def write_row_data(self, result_details, step):
if 'rows' in step:
for row in step['rows']:
row_data = " "
for cell in row['cells']:
row_data += " " + cell
row_data += "\n"
result_details.add(row_data)
def write_failure_message(self, result_details, failure_message, feature, priority, scenario, step):
result_details.add(" Error: %s\n" % (failure_message.partition('\n')[0]))
syslog(LOG_NOTICE, "%s | %s%s | %s | %s%s | Error - %s" %
(self.step_status(step), self.feature_name(feature), priority, scenario['name'],
step['keyword'], self.ascii_step_name(step), failure_message.partition('\n')[0]))
def log_details_and_set_status_for_scenario(self, result_details, feature, priority, scenario):
result_details.add(" Scenario: %s (%s/%s)\n" % (scenario['name'], feature['uri'], priority))
for step in scenario['steps']:
failure_message = self.increment_status_and_capture_failure_message(step)
self.write_step_description_and_status(result_details, feature, priority, scenario, step)
self.write_row_data(result_details, step)
if failure_message != "":
self.write_failure_message(result_details, failure_message, feature, priority, scenario, step)
# To make our log pretty
result_details.add("\n")
def set_status_for_scenarios_in_feature(self, feature, priority, result_details):
if 'elements' not in feature:
log_result_and_exit(0, "OK: Feature %s has no steps at any priority" % feature['id'])
for scenario in feature['elements']:
if 'tags' in scenario:
for tag in scenario['tags']:
if tag['name'] == priority:
self.log_details_and_set_status_for_scenario(result_details, feature, priority, scenario)
def set_status_for_feature(self, feature_name, json_data, priority):
feature_uri = 'features/' + feature_name + '.feature'
result_details = ResultBuffer()
for feature in json_data:
if feature['uri'] == feature_uri:
self.feature_found = True
self.passed = 0
self.skipped = 0
self.failed = 0
self.set_status_for_scenarios_in_feature(feature, priority, result_details)
self.log = result_details.getvalue()
def write_pretty_log(self, logfile):
pplog = codecs.open(logfile, "a", "utf-8-sig")
pplog.write(self.log)
pplog.close()
class ResultBuffer(object):
def __init__(self):
self.buffer = StringIO()
def add(self, message):
self.buffer.write("%s:%s" % (runtime, message.encode('ascii', 'ignore')))
def getvalue(self):
return self.buffer.getvalue()
def argument_check():
if len(sys.argv) != 4:
log_result_and_exit(3, "UNKNOWN: Usage: nagios_check_cache.py feature priority jsonfile")
def argument_sanity_checks(json_file):
# Check whether the json file exists and issue UNKNOWN if not
if os.path.exists(json_file) == False:
log_result_and_exit(3, "UNKNOWN: %s does not exist" % json_file)
# Check the age of the json file is less than 30m and issue UNKNOWN if not
json_age = time() - os.stat(json_file).st_mtime
if json_age > 1800:
log_result_and_exit(3, "UNKNOWN: %s is older than 30m" % json_file)
def ensure_log_directory_exists(log_dir):
if not os.path.exists(log_dir):
os.makedirs(log_dir)
def main():
argument_check()
feature_name = sys.argv[1]
priority = "@" + sys.argv[2]
json_file = sys.argv[3]
argument_sanity_checks(json_file)
smokey_log_dir = os.path.dirname(os.path.abspath(sys.argv[0])) + '/log/'
openlog("smokey", 0, LOG_DAEMON)
# set some variables
smokey_json = json.loads(open(json_file).read())
logfile = smokey_log_dir + feature_name + '_' + sys.argv[2] + '.log'
ensure_log_directory_exists(smokey_log_dir)
# Parse the json into valuble information
feature_test_run = FeatureTestRun(feature_name, smokey_json, priority, logfile);
# We didn't even find this feature in the steps!
if not feature_test_run.feature_found:
log_result_and_exit(0, "OK: But feature %s was not found" % feature_name)
# Check the output of our tests
if feature_test_run.failed > 0:
status = "CRITICAL"
exitcode = 2
elif feature_test_run.skipped > 0:
status = "WARNING"
exitcode = 1
elif feature_test_run.passed > 0:
status = "OK"
exitcode = 0
else:
# We use this exitcode later
exitcode = 99
# Assuming we had a non-zero number of checks, lets spit out Nagios output
if exitcode != 99:
log_result_and_exit(exitcode, "%s: %s failed, %s skipped, %s passed; \n\n%s" % (
status, feature_test_run.failed, feature_test_run.skipped, feature_test_run.passed, feature_test_run.log))
# We had no steps, but did the feature at least exist?
if feature_test_run.feature_found:
log_result_and_exit(0, "OK: But no %s tests for %s found" % (priority, feature_name))
else:
log_result_and_exit(3, "UNKNOWN: Something went very wrong")
if __name__ == '__main__':
runtime = strftime("%Y-%m-%d %H:%M:%S", gmtime())
main()
Jump to Line
Something went wrong with that request. Please try again.