#!/usr/bin/env python3
+# SPDX-FileCopyrightText: Eric S. Raymond <esr@thyrsus.com>
+# SPDX-License-Identifier: BSD-2-Clause
"""
This is the open-adventure dungeon text coverage report generator. It
consumes a YAML description of the dungeon and determines whether the
The default HTML output is appropriate for use with Gitlab CI.
You can override it with a command-line argument.
-The DANGLING list is for actions that should be considered always found
-even if the checkfile search doesn't find them. Typically this will because
-they emit a templated message that can't be regression-tested by equality.
+The DANGLING lists are for actions and messages that should be
+considered always found even if the checkfile search doesn't find them.
+Typically this will because an action emit a templated message that
+can't be regression-tested by equality.
"""
+# pylint: disable=consider-using-f-string,line-too-long,invalid-name,missing-function-docstring,redefined-outer-name
+
import os
import sys
import re
YAML_PATH = "../adventure.yaml"
HTML_TEMPLATE_PATH = "../templates/coverage_dungeon.html.tpl"
DEFAULT_HTML_OUTPUT_PATH = "../coverage/adventure.yaml.html"
-DANGLING = ["ACT_VERSION"]
+DANGLING_ACTIONS = ["ACT_VERSION"]
+DANGLING_MESSAGES = ["SAVERESUME_DISABLED"]
STDOUT_REPORT_CATEGORY = " {name:.<19}: {percent:5.1f}% covered ({covered} of {total})\n"
def loc_coverage(locations, text, report):
# locations have a long and a short description, that each have to
- # be checked seperately
+ # be checked separately
for name, loc in locations:
desc = loc["description"]
if name not in report["messages"]:
# property
for name, item in enumerate(classes):
if name not in report["messages"]:
- report["messages"][name] = {"covered" : "False"}
+ report["messages"][name] = {"covered" : False}
report["total"] += 1
if not report["messages"][name]["covered"] and search(item["message"], text):
report["messages"][name]["covered"] = True
if name not in report["messages"]:
report["messages"][name] = {"covered" : False}
report["total"] += 1
- if not report["messages"][name]["covered"] and search(message, text):
+ if not report["messages"][name]["covered"] and (search(message, text) or name in DANGLING_MESSAGES):
report["messages"][name]["covered"] = True
report["covered"] += 1
if name not in report["messages"]:
report["messages"][name] = {"covered" : False}
report["total"] += 1
- if not report["messages"][name]["covered"] and (search(item["message"], text) or name in DANGLING):
+ if not report["messages"][name]["covered"] and (search(item["message"], text) or name in DANGLING_ACTIONS):
report["messages"][name]["covered"] = True
report["covered"] += 1
def coverage_report(db, check_file_contents):
- # Create report for each catagory, including total items, number of items
+ # Create report for each category, including total items, number of items
# covered, and a list of the covered messages
report = {}
for name in db.keys():
if __name__ == "__main__":
# load DB
try:
- with open(YAML_PATH, "r") as f:
+ with open(YAML_PATH, "r", encoding='ascii', errors='surrogateescape') as f:
db = yaml.safe_load(f)
except IOError as e:
print('ERROR: could not load %s (%s)' % (YAML_PATH, e.strerror))
check_file_contents = []
for filename in os.listdir(TEST_DIR):
if filename.endswith(".chk"):
- with open(filename, "r") as f:
+ with open(filename, "r", encoding='ascii', errors='surrogateescape') as f:
check_file_contents.append(f.read())
# run coverage analysis report on dungeon database
# render HTML report
try:
- with open(HTML_TEMPLATE_PATH, "r") as f:
+ with open(HTML_TEMPLATE_PATH, "r", encoding='ascii', errors='surrogateescape') as f:
# read in HTML template
html_template = f.read()
except IOError as e:
# parse template with report and write it out
try:
- with open(html_output_path, "w") as f:
+ with open(html_output_path, "w", encoding='ascii', errors='surrogateescape') as f:
f.write(html_template.format(categories=categories_html, summary=summary_html))
except IOError as e:
print('ERROR: writing HTML report failed ({})'.format(e.strerror))