X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=tests%2Fcoverage_dungeon.py;h=97e642daa9f154e5853cf96e3776519c7043b9ca;hb=HEAD;hp=b5afa08ce399f2f89fadef98c67f6e517d51bd6d;hpb=b47d95853b86f28a6da918473ade06f801daaed5;p=open-adventure.git diff --git a/tests/coverage_dungeon.py b/tests/coverage_dungeon.py index b5afa08..d193b27 100755 --- a/tests/coverage_dungeon.py +++ b/tests/coverage_dungeon.py @@ -1,23 +1,37 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 +# SPDX-FileCopyrightText: Copyright 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. + +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. +""" -# 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. +# 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 = "coverage_dungeon.html.tpl" +HTML_TEMPLATE_PATH = "../templates/coverage_dungeon.html.tpl" DEFAULT_HTML_OUTPUT_PATH = "../coverage/adventure.yaml.html" +DANGLING_ACTIONS = ["ACT_VERSION"] +DANGLING_MESSAGES = ["SAVERESUME_DISABLED"] -STDOUT_REPORT_CATEGORY = " {name:.<19}: {percent:5.1f}% covered ({covered} of {total})\n" +STDOUT_REPORT_CATEGORY = ( + " {name:.<19}: {percent:5.1f}% covered ({covered} of {total})\n" +) HTML_SUMMARY_ROW = """ @@ -54,155 +68,172 @@ HTML_CATEGORY_ROW = """ """ + 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 - needle = re.escape(needle) \ - .replace("\\n", "\n") \ - .replace("\\t", "\t") \ - .replace("\%S", ".*") \ - .replace("\%s", ".*") \ - .replace("\%d", ".*") \ - .replace("\%V", ".*") - return re.search(needle, haystack) + 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") + .replace("%S", ".*") + .replace("%s", ".*") + .replace("%d", ".*") + .replace("%V", ".*") + ) + + return re.search(needle_san, 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"]): name = "{}[{}]".format(obj_name, j) 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: - if desc == None or desc == '' or search(desc, text): - report["messages"][name]["covered"] = True - report["covered"] += 1 + 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["messages"][name] = {"long": False, "short": False} report["total"] += 2 - if report["messages"][name]["long"] != True: - if loc["description"]["long"] == None or loc["description"]["long"] == '' or search(loc["description"]["long"], text): - report["messages"][name]["long"] = True - report["covered"] += 1 - if report["messages"][name]["short"] != True: - if loc["description"]["short"] == None or loc["description"]["short"] == '' or search(loc["description"]["short"], text): - report["messages"][name]["short"] = True - report["covered"] += 1 + if not report["messages"][name]["long"] and search(desc["long"], text): + report["messages"][name]["long"] = True + report["covered"] += 1 + 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["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 + def obit_coverage(obituaries, text, report): # obituaries have a "query" where it asks the player for a resurrection, # followed by a snarky comment if the player says yes for name, obit in enumerate(obituaries): if name not in report["messages"]: - report["messages"][name] = {"query" : False, "yes_response": False} + 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 + def threshold_coverage(classes, text, report): # works for class thresholds and turn threshold, which have a "message" # 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: - if item["message"] == None or item["message"] == "NO_MESSAGE" or search(item["message"], text): - report["messages"][name]["covered"] = True - report["covered"] += 1 + if not report["messages"][name]["covered"] and search(item["message"], text): + report["messages"][name]["covered"] = True + report["covered"] += 1 + def arb_coverage(arb_msgs, text, report): for name, message in arb_msgs: 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: - if message == None or search(message, text): - report["messages"][name]["covered"] = True - report["covered"] += 1 + if not report["messages"][name]["covered"] and ( + search(message, text) or name in DANGLING_MESSAGES + ): + report["messages"][name]["covered"] = True + report["covered"] += 1 + -def specials_actions_coverage(items, text, report): - # works for actions or specials +def actions_coverage(items, text, report): + # works for actions for name, item in items: 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: - if item["message"] == None or item["message"] == "NO_MESSAGE" or search(item["message"], text): - report["messages"][name]["covered"] = True - report["covered"] += 1 + 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(): # initialize each catagory report[name] = { - "name" : name, # convenience for string formatting - "total" : 0, - "covered" : 0, - "messages" : {} + "name": name, # convenience for string formatting + "total": 0, + "covered": 0, + "messages": {}, } - # search for each message in ever test check file + # search for each message in every test check file for chk in check_file_contents: arb_coverage(db["arbitrary_messages"], chk, report["arbitrary_messages"]) hint_coverage(db["hints"], chk, report["hints"]) loc_coverage(db["locations"], chk, report["locations"]) obit_coverage(db["obituaries"], chk, report["obituaries"]) obj_coverage(db["objects"], chk, report["objects"]) - specials_actions_coverage(db["actions"], chk, report["actions"]) - specials_actions_coverage(db["specials"], chk, report["specials"]) + actions_coverage(db["actions"], chk, report["actions"]) threshold_coverage(db["classes"], chk, report["classes"]) threshold_coverage(db["turn_thresholds"], chk, report["turn_thresholds"]) return report + if __name__ == "__main__": # load DB try: - with open(YAML_PATH, "r") as f: - db = yaml.load(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 @@ -219,19 +250,26 @@ if __name__ == "__main__": category["percent"] = (category["covered"] / float(category["total"])) * 100 # render section header - cat_keys = list(category["messages"].items())[0][1].keys() + cat_messages = list(category["messages"].items()) + cat_keys = cat_messages[0][1].keys() headers_html = "" colspan = 10 - len(cat_keys) for key in cat_keys: headers_html += HTML_CATEGORY_HEADER_CELL.format(key) - category_html = HTML_CATEGORY_HEADER.format(colspan=colspan, label=category["name"], cells=headers_html) + category_html = HTML_CATEGORY_HEADER.format( + colspan=colspan, label=category["name"], cells=headers_html + ) # render message coverage row - for message_id, covered in sorted(category["messages"].items()): + 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 += HTML_CATEGORY_ROW.format(id=message_id,colspan=colspan, cells=category_html_row) + 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) # render category summaries @@ -248,16 +286,22 @@ 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) + print("ERROR: reading HTML report template failed ({})".format(e.strerror)) + sys.exit(-1) # parse template with report and write it out try: - with open(html_output_path, "w") as f: - f.write(html_template.format(categories=categories_html, summary=summary_html)) + 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)) + print("ERROR: writing HTML report failed ({})".format(e.strerror))