X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=tests%2Fcoverage_dungeon.py;h=9d01c849f85fb6586c4d8f353749b3118ad7232d;hb=25230068fe3afb9d1faa9c606413784294700cef;hp=182930cb878511ea881a3473fb28ff71e119f80e;hpb=8b8a3a73c4812af90bdd755c35f6c4e001553872;p=open-adventure.git diff --git a/tests/coverage_dungeon.py b/tests/coverage_dungeon.py index 182930c..9d01c84 100755 --- a/tests/coverage_dungeon.py +++ b/tests/coverage_dungeon.py @@ -1,26 +1,33 @@ #!/usr/bin/env python3 +# SPDX-FileCopyrightText: Eric S. Raymond +# 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 +various strings contained are present within the test check files. -# This is the open-adventure dungeon text coverage report generator. It -# consumes a YAML description of the dungeon and determines whether the -# various strings contained are present within the test check files. -# -# 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 default HTML output is appropriate for use with Gitlab CI. +You can override it with a command-line argument. + +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 yaml import re +import yaml TEST_DIR = "." 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" @@ -63,11 +70,11 @@ def search(needle, haystack): # Search for needle in haystack, first escaping needle for regex, then # replacing %s, %d, etc. with regex wildcards, so the variable messages # within the dungeon definition will actually match - - if needle == None or needle == "" or needle == "NO_MESSAGE": + + if needle is None or needle == "" or needle == "NO_MESSAGE": # if needle is empty, assume we're going to find an empty string return True - + needle_san = re.escape(needle) \ .replace("\\n", "\n") \ .replace("\\t", "\t") \ @@ -80,7 +87,7 @@ def search(needle, haystack): def obj_coverage(objects, text, report): # objects have multiple descriptions based on state - for i, objouter in enumerate(objects): + for _, objouter in enumerate(objects): (obj_name, obj) = objouter if obj["descriptions"]: for j, desc in enumerate(obj["descriptions"]): @@ -88,38 +95,38 @@ def obj_coverage(objects, text, report): if name not in report["messages"]: report["messages"][name] = {"covered" : False} report["total"] += 1 - if report["messages"][name]["covered"] != True and search(desc, text): + if not report["messages"][name]["covered"] and search(desc, text): report["messages"][name]["covered"] = True report["covered"] += 1 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"]: report["messages"][name] = {"long" : False, "short": False} report["total"] += 2 - if report["messages"][name]["long"] != True and search(desc["long"], text): + if not report["messages"][name]["long"] and search(desc["long"], text): report["messages"][name]["long"] = True report["covered"] += 1 - if report["messages"][name]["short"] != True and search(desc["short"], text): + if not report["messages"][name]["short"] and search(desc["short"], text): report["messages"][name]["short"] = True report["covered"] += 1 def hint_coverage(obituaries, text, report): # hints have a "question" where the hint is offered, followed # by the actual hint if the player requests it - for i, hintouter in enumerate(obituaries): + for _, hintouter in enumerate(obituaries): hint = hintouter["hint"] name = hint["name"] if name not in report["messages"]: report["messages"][name] = {"question" : False, "hint": False} report["total"] += 2 - if report["messages"][name]["question"] != True and search(hint["question"], text): + if not report["messages"][name]["question"] and search(hint["question"], text): report["messages"][name]["question"] = True report["covered"] += 1 - if report["messages"][name]["hint"] != True and search(hint["hint"], text): + if not report["messages"][name]["hint"] and search(hint["hint"], text): report["messages"][name]["hint"] = True report["covered"] += 1 @@ -130,10 +137,10 @@ def obit_coverage(obituaries, text, report): if name not in report["messages"]: report["messages"][name] = {"query" : False, "yes_response": False} report["total"] += 2 - if report["messages"][name]["query"] != True and search(obit["query"], text): + if not report["messages"][name]["query"] and search(obit["query"], text): report["messages"][name]["query"] = True report["covered"] += 1 - if report["messages"][name]["yes_response"] != True and search(obit["yes_response"], text): + if not report["messages"][name]["yes_response"] and search(obit["yes_response"], text): report["messages"][name]["yes_response"] = True report["covered"] += 1 @@ -142,9 +149,9 @@ def threshold_coverage(classes, text, report): # 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 report["messages"][name]["covered"] != True and search(item["message"], text): + if not report["messages"][name]["covered"] and search(item["message"], text): report["messages"][name]["covered"] = True report["covered"] += 1 @@ -153,7 +160,7 @@ def arb_coverage(arb_msgs, text, report): if name not in report["messages"]: report["messages"][name] = {"covered" : False} report["total"] += 1 - if report["messages"][name]["covered"] != True 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 @@ -163,12 +170,12 @@ def actions_coverage(items, text, report): if name not in report["messages"]: report["messages"][name] = {"covered" : False} report["total"] += 1 - if report["messages"][name]["covered"] != True 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(): @@ -196,17 +203,17 @@ def coverage_report(db, check_file_contents): 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 {} ({}})'.format(YAML_PATH, e.strerror)) - exit(-1) + print('ERROR: could not load %s (%s)' % (YAML_PATH, e.strerror)) + sys.exit(-1) # get contents of all the check files 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 @@ -235,7 +242,7 @@ if __name__ == "__main__": for message_id, covered in cat_messages: category_html_row = "" for key, value in covered.items(): - category_html_row += HTML_CATEGORY_COVERAGE_CELL.format("uncovered" if value != True else "covered") + category_html_row += HTML_CATEGORY_COVERAGE_CELL.format("uncovered" if not value else "covered") category_html += HTML_CATEGORY_ROW.format(id=message_id,colspan=colspan, cells=category_html_row) categories_html += HTML_CATEGORY_SECTION.format(id=name, rows=category_html) @@ -253,16 +260,16 @@ if __name__ == "__main__": # 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: print('ERROR: reading HTML report template failed ({})'.format(e.strerror)) - exit(-1) + sys.exit(-1) # 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))