Partial REUSE cmpliance.

[open-adventure.git] / tests / coverage_dungeon.py

diff --git a/tests/coverage_dungeon.py b/tests/coverage_dungeon.py
index 8bb1c4698157836f92f3fdb692c52abb252aede0..9d01c849f85fb6586c4d8f353749b3118ad7232d 100755 (executable)
--- a/tests/coverage_dungeon.py
+++ b/tests/coverage_dungeon.py
@@ -1,4 +1,6 @@
 #!/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
@@ -7,11 +9,14 @@ 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 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
@@ -21,7 +26,8 @@ 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"
 
@@ -95,7 +101,7 @@ def obj_coverage(objects, text, report):
 
 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"]:
@@ -143,7 +149,7 @@ 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 not report["messages"][name]["covered"] and search(item["message"], text):
             report["messages"][name]["covered"] = True
@@ -154,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 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
 
@@ -164,12 +170,12 @@ def actions_coverage(items, text, report):
         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():
@@ -197,7 +203,7 @@ 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 %s (%s)' % (YAML_PATH, e.strerror))
@@ -207,7 +213,7 @@ if __name__ == "__main__":
     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
@@ -254,7 +260,7 @@ 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:
@@ -263,7 +269,7 @@ if __name__ == "__main__":
 
     # 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))