diff --git a/tester.py b/tester.py
index b14a77fc9e66fa21f6070ff49d4260dc8c701d8a..84d639b6f8890e9ffaccbe4c8778cc2f4a4dd5bf 100755
--- a/tester.py
+++ b/tester.py
@@ -34,6 +34,10 @@ sys.stdout = Logger(sys.stdout, log_buffer)
sys.stderr = sys.stdout
+def strip_colors(text):
+ return re.sub(r'\033\[[\d;]+m', '', text)
+
+
class Tester():
USAGE = '''%s [-e] [-f] [-b] [-d] [-h]
-e: send email with report.
@@ -88,7 +92,7 @@ class Tester():
exit_code = self.run_tests(tests, email, email_if_fail)
sys.exit(exit_code)
- def get_file_description(self, path):
+ def parse_file_header(self, path):
with open(path, 'r') as fo:
content = fo.read()
description = ''
@@ -107,7 +111,14 @@ class Tester():
description += line[1:].strip() + '\n'
else:
break
- return description.strip()
+ description = description.strip()
+ if description.startswith('Criticality:'):
+ criticality, *description = description.split('\n')
+ criticality = criticality[len('Criticality:'):].strip()
+ description = '\n'.join(description)
+ else:
+ criticality = 'not specified'
+ return criticality, description
def discover_tests(self, basic_only=False):
tests = list()
@@ -124,8 +135,8 @@ class Tester():
for name in names:
test_path = os.path.join(path, name)
if os.path.isfile(test_path):
- description = self.get_file_description(test_path)
- tests.append((name, description, [test_path]))
+ criticality, description = self.parse_file_header(test_path)
+ tests.append((name, criticality, description, [test_path]))
if basic_only:
return tests
# Get MS instances
@@ -156,17 +167,18 @@ class Tester():
ms_tests.append('ms_live_tester.py')
for name in ms_tests:
test_path = os.path.join(ms_path, name)
- description = self.get_file_description(test_path)
- tests.append(('%s (%s)' % (name, user), description, [test_path, user]))
+ criticality, description = self.parse_file_header(test_path)
+ tests.append(('%s (%s)' % (name, user), criticality, description, [test_path, user]))
return tests
def run_tests(self, tests, email=False, email_if_fail=False):
# Run all tests
- results = list()
successes = 0
failures = 0
total_duration = None
- for name, description, command in tests:
+ report_rows = [('Test', 'Criticality', 'Result', 'Duration', 'Description')]
+ report_rows_length = [len(t) for t in report_rows[0]]
+ for name, criticality, description, command in tests:
log('\033[1;95m-- Test "%s" --\033[0;0m' % name)
start_date = datetime.datetime.utcnow()
log('Test start: %s UTC.' % start_date.strftime('%Y-%m-%d %H:%M:%S'))
@@ -178,14 +190,15 @@ class Tester():
if err:
log(err.decode('utf-8').strip())
if p.returncode == 0:
- success = True
+ status = '\033[92msuccess\033[0m'
successes += 1
elif p.returncode == 2:
- success = None
+ status = '\033[94mnot testable\033[0m'
else:
- success = False
+ status = '\033[91mfailure\033[0m'
failures += 1
log('Command exited with code %s.' % p.returncode)
+ # Get duration
end_date = datetime.datetime.utcnow()
duration = end_date - start_date
if total_duration:
@@ -193,26 +206,35 @@ class Tester():
else:
total_duration = duration
log('Test end: %s UTC (duration: %s).' % (end_date.strftime('%Y-%m-%d %H:%M:%S'), duration))
- results.append((name, description, command, success, duration))
+ # Prepare report
+ report_rows.append((name, criticality, status, str(duration), description))
+ report_rows_length = [max(len(strip_colors(t)), report_rows_length[i]) for i, t in enumerate(report_rows[-1])]
exit_code = 1 if failures > 0 else 0
# Display results
log('\nTests results:')
html_report = '<table border="1">'
- html_report += '\n<tr><th>Test</th><th>Result</th><th>Duration</th><th>Description</th></tr>'
- for name, description, command, success, duration in results:
- if success is None:
- html_result = '<span style="color: blue;">not testable</span>'
- term_result = '\033[94mnot testable\033[0m'
- elif success:
- html_result = '<span style="color: green;">success</span>'
- term_result = '\033[92msuccess\033[0m'
- else:
- html_result = '<span style="color: red;">failure</span>'
- term_result = '\033[91mfailure\033[0m'
- log(' %s: %s (%s)' % (name, term_result, duration))
- html_report += '\n<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>' % (name, html_result, duration, description.replace('\n', '<br/>\n'))
+ log_report = ''
+ for row in report_rows:
+ is_header = not log_report
+ html_cell = 'th' if is_header else 'td'
+ html_report += '\n <tr>'
+ log_report += '\n|'
+ for i, val in enumerate(row):
+ html_report += ' <%s>%s</%s>' % (html_cell, val, html_cell)
+ nb_sp = len(strip_colors(val).center(report_rows_length[i])) - len(strip_colors(val))
+ log_report += ' %s%s |' % (val, ' ' * nb_sp)
+ html_report += ' </tr>'
+ if is_header:
+ log_report += '\n|'
+ for i, val in enumerate(row):
+ log_report += '%s|' % ('-' * (report_rows_length[i] + 2))
+ log(log_report.strip())
log('Total tests duration: %s.\n' % total_duration)
html_report += '\n</table>'
+ html_report = html_report.replace('\033[91m', '<span style="color: red;">')
+ html_report = html_report.replace('\033[92m', '<span style="color: green;">')
+ html_report = html_report.replace('\033[94m', '<span style="color: blue;">')
+ html_report = html_report.replace('\033[0m', '</span>')
# Store locally results
now = datetime.datetime.utcnow()
log_dir = os.path.join(self.root_dir, 'log')
@@ -244,7 +266,7 @@ class Tester():
else:
log('Failed to get hostname (required to send email).')
log_name = 'results_%s_%s.txt' % (hostname or 'noname', now.strftime('%Y-%m-%d_%H-%M-%S'))
- log_content = re.sub(r'\033\[[\d;]+m', '', log_buffer.getvalue())
+ log_content = strip_colors(log_buffer.getvalue())
with open(os.path.join(log_dir, log_name), 'w') as fo:
fo.write(log_content)
# Send email
diff --git a/tests/test_apt.sh b/tests/test_apt.sh
index 43e6626ec05b68d552351edb780809f3ff9320fb..f8fdfe4f83e460fae1e2c24c129e16588857579f 100755
--- a/tests/test_apt.sh
+++ b/tests/test_apt.sh
@@ -1,4 +1,5 @@
#!/bin/bash
+# Criticality: Normal
# Check that updates can be installed.
set -e
diff --git a/tests/test_dns_records.py b/tests/test_dns_records.py
index 938f2a8060d605e3427b08736948e580993c1446..68dc9d59ce8375d637f8b4ff6c5b0cf5fbd58ece 100755
--- a/tests/test_dns_records.py
+++ b/tests/test_dns_records.py
@@ -2,6 +2,7 @@
# -*- coding: utf-8 -*-
# Copyright 2017, Florent Thiery
'''
+Criticality: Normal
Checks that DNS records are provided by the customer servers are correctly set
'''
import subprocess
diff --git a/tests/test_nginx_conf_valid.sh b/tests/test_nginx_conf_valid.sh
index 2a735552333129934012d7ad3aa8a839d0102606..79998b0bd23654d0cc7ff1ba062e8ace3b85c6e9 100755
--- a/tests/test_nginx_conf_valid.sh
+++ b/tests/test_nginx_conf_valid.sh
@@ -1,4 +1,5 @@
#!/bin/bash
+# Criticality: High
# Checks that the webserver configuration has no errors.
set -e
diff --git a/tests/test_nginx_status.py b/tests/test_nginx_status.py
index 61260da376d13901c0b58f23af1cbfd1089acca9..ef677b940951493204293f04566e8855625d31df 100755
--- a/tests/test_nginx_status.py
+++ b/tests/test_nginx_status.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
'''
+Criticality: Normal
Checks that the webserver is running.
'''
import os
diff --git a/tests/test_nginx_vhosts.py b/tests/test_nginx_vhosts.py
index f9dc59cbece36f56d30f5890593c84242224c2d3..f916eab2c09f40ed80f6d18dedc539279cc7bfe8 100755
--- a/tests/test_nginx_vhosts.py
+++ b/tests/test_nginx_vhosts.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
'''
+Criticality: High
Tests that all webserver services (vhosts) are available and reachable.
'''
import os
diff --git a/tests/test_ntp.py b/tests/test_ntp.py
index f35d6cb6f175505bfce708ab73bba71296cabced..a23ceda52000c6ff7c4d50a05ecc43ee8f0cc63d 100755
--- a/tests/test_ntp.py
+++ b/tests/test_ntp.py
@@ -2,6 +2,7 @@
# -*- coding: utf-8 -*-
# Copyright 2017, Florent Thiery
'''
+Criticality: Low
Checks that the server is synchronized with the configured NTP server.
'''
import os
diff --git a/tests/test_postfix.py b/tests/test_postfix.py
index 0e343931e35db4fdebbf7560b528386528780b5b..b7feb842eb34cfd7026ed1d1698e462ebb3f8cdb 100755
--- a/tests/test_postfix.py
+++ b/tests/test_postfix.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
'''
+Criticality: High
Check that emails can be sent.
'''
import os
diff --git a/tests/test_ubicast_packages_access.py b/tests/test_ubicast_packages_access.py
index 5cf3b4486ef04fb79dcf767c6ce72f8689c817e7..8bd3440fc59a0e8bf111e9f70a26c727a2f09e3c 100755
--- a/tests/test_ubicast_packages_access.py
+++ b/tests/test_ubicast_packages_access.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
'''
+Criticality: Normal
Check that updates server is reachable.
'''
import os