X-Git-Url: https://jxself.org/git/?a=blobdiff_plain;f=tests%2Fcoverage_dungeon.py;h=0949dbefba786e946caf446e18c62bc417a2b2ba;hb=d1e29319fa20a0d3e9924764f83a8cf2020e84da;hp=a61c6f7ef43573f228e914ca0aa3c25c397e8c7a;hpb=2ec9c7cc1a053e8e0fe1a76447d156828210f3db;p=open-adventure.git
diff --git a/tests/coverage_dungeon.py b/tests/coverage_dungeon.py
index a61c6f7..0949dbe 100755
--- a/tests/coverage_dungeon.py
+++ b/tests/coverage_dungeon.py
@@ -4,11 +4,11 @@
# consumes a YAML description of the dungeon and determines whether the
# various strings contained are present within the test check files.
#
-# Currently, only the location descriptions, arbitrary messages, object
-# descriptions, hints, classes and turn thrusholds are supported. This will
-# be expanded in the future.
+# The default HTML output is appropriate for use with Gitlab CI.
+# You can override it with a command-line argument.
import os
+import sys
import yaml
import re
@@ -17,7 +17,7 @@ yaml_name = "../adventure.yaml"
html_template_path = "coverage_dungeon.html.tpl"
html_output_path = "../coverage/adventure.yaml.html"
-location_row = """
+row_3_fields = """
| {} |
|
@@ -25,14 +25,7 @@ location_row = """
"""
-arb_msg_row = """
-
- | {} |
- |
-
-"""
-
-object_row = """
+row_2_fields = """
| {} |
|
@@ -44,6 +37,8 @@ def search(needle, haystack):
# 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", ".*") \
@@ -52,6 +47,8 @@ def search(needle, haystack):
return re.search(needle, haystack)
def loc_coverage(locations, text):
+ # locations have a long and a short description, that each have to
+ # be checked seperately
for locname, loc in locations:
if loc["description"]["long"] == None or loc["description"]["long"] == '':
loc["description"]["long"] = True
@@ -65,6 +62,7 @@ def loc_coverage(locations, text):
loc["description"]["short"] = True
def arb_coverage(arb_msgs, text):
+ # arbitrary messages are a map to tuples
for i, msg in enumerate(arb_msgs):
(msg_name, msg_text) = msg
if msg_text == None or msg_text == '':
@@ -74,6 +72,7 @@ def arb_coverage(arb_msgs, text):
arb_msgs[i] = (msg_name, True)
def obj_coverage(objects, text):
+ # objects have multiple descriptions based on state
for i, objouter in enumerate(objects):
(obj_name, obj) = objouter
if obj["descriptions"]:
@@ -87,6 +86,8 @@ def obj_coverage(objects, text):
objects[i] = (obj_name, obj)
def hint_coverage(hints, text):
+ # hints have a "question" where the hint is offered, followed
+ # by the actual hint if the player requests it
for name, hint in hints:
if hint["question"] != True:
if search(hint["question"], text):
@@ -95,23 +96,9 @@ def hint_coverage(hints, text):
if search(hint["hint"], text):
hint["hint"] = True
-def special_coverage(specials, text):
- for name, special in specials:
- if special["message"] == None:
- special["message"] = True
- if special["message"] != True:
- if search(special["message"], text):
- special["message"] = True
-
-def threshold_coverage(classes, text):
- for i, msg in enumerate(classes):
- if msg["message"] == None:
- msg["message"] = True
- elif msg["message"] != True:
- if search(msg["message"], text):
- msg["message"] = True
-
def obit_coverage(obituaries, text):
+ # obituaries have a "query" where it asks the player for a resurrection,
+ # followed by a snarky comment if the player says yes
for i, obit in enumerate(obituaries):
if obit["query"] != True:
if search(obit["query"], text):
@@ -120,13 +107,24 @@ def obit_coverage(obituaries, text):
if search(obit["yes_response"], text):
obit["yes_response"] = True
-def actions_coverage(actions, text):
- for name, action in actions:
- if action["message"] == None or action["message"] == "NO_MESSAGE":
- action["message"] = True
- if action["message"] != True:
- if search(action["message"], text):
- action["message"] = True
+def threshold_coverage(classes, text):
+ # works for class thresholds and turn threshold, which have a "message"
+ # property
+ for i, msg in enumerate(classes):
+ if msg["message"] == None:
+ msg["message"] = True
+ elif msg["message"] != True:
+ if search(msg["message"], text):
+ msg["message"] = True
+
+def specials_actions_coverage(items, text):
+ # works for actions or specials
+ for name, item in items:
+ if item["message"] == None or item["message"] == "NO_MESSAGE":
+ item["message"] = True
+ if item["message"] != True:
+ if search(item["message"], text):
+ item["message"] = True
if __name__ == "__main__":
with open(yaml_name, "r") as f:
@@ -162,8 +160,8 @@ if __name__ == "__main__":
threshold_coverage(classes, text)
threshold_coverage(turn_thresholds, text)
obit_coverage(obituaries, text)
- actions_coverage(actions, text)
- special_coverage(specials, text)
+ specials_actions_coverage(actions, text)
+ specials_actions_coverage(specials, text)
location_html = ""
location_total = len(locations) * 2
@@ -184,7 +182,7 @@ if __name__ == "__main__":
short_success = "covered"
location_covered += 1
- location_html += location_row.format(locname, long_success, short_success)
+ location_html += row_3_fields.format(locname, long_success, short_success)
location_percent = round((location_covered / float(location_total)) * 100, 1)
arb_msgs.sort()
@@ -197,7 +195,7 @@ if __name__ == "__main__":
else:
success = "covered"
arb_covered += 1
- arb_msg_html += arb_msg_row.format(name, success)
+ arb_msg_html += row_2_fields.format(name, success)
arb_percent = round((arb_covered / float(arb_total)) * 100, 1)
object_html = ""
@@ -213,7 +211,7 @@ if __name__ == "__main__":
else:
success = "covered"
objects_covered += 1
- object_html += object_row.format("%s[%d]" % (obj_name, j), success)
+ object_html += row_2_fields.format("%s[%d]" % (obj_name, j), success)
objects_percent = round((objects_covered / float(objects_total)) * 100, 1)
hints.sort()
@@ -231,7 +229,7 @@ if __name__ == "__main__":
else:
hint_success = "covered"
hints_covered += 1
- hints_html += location_row.format(name, question_success, hint_success)
+ hints_html += row_3_fields.format(name, question_success, hint_success)
hints_percent = round((hints_covered / float(hints_total)) * 100, 1)
class_html = ""
@@ -243,7 +241,7 @@ if __name__ == "__main__":
else:
success = "covered"
class_covered += 1
- class_html += arb_msg_row.format(msg["threshold"], success)
+ class_html += row_2_fields.format(msg["threshold"], success)
class_percent = round((class_covered / float(class_total)) * 100, 1)
turn_html = ""
@@ -255,7 +253,7 @@ if __name__ == "__main__":
else:
success = "covered"
turn_covered += 1
- turn_html += arb_msg_row.format(msg["threshold"], success)
+ turn_html += row_2_fields.format(msg["threshold"], success)
turn_percent = round((turn_covered / float(turn_total)) * 100, 1)
obituaries_html = "";
@@ -272,7 +270,7 @@ if __name__ == "__main__":
else:
obit_success = "covered"
obituaries_covered += 1
- obituaries_html += location_row.format(i, query_success, obit_success)
+ obituaries_html += row_3_fields.format(i, query_success, obit_success)
obituaries_percent = round((obituaries_covered / float(obituaries_total)) * 100, 1)
actions.sort()
@@ -285,7 +283,7 @@ if __name__ == "__main__":
else:
success = "covered"
actions_covered += 1
- actions_html += arb_msg_row.format(name, success)
+ actions_html += row_2_fields.format(name, success)
actions_percent = round((actions_covered / float(actions_total)) * 100, 1)
special_html = ""
@@ -297,7 +295,7 @@ if __name__ == "__main__":
else:
success = "covered"
special_covered += 1
- special_html += arb_msg_row.format(name, success)
+ special_html += row_2_fields.format(name, success)
special_percent = round((special_covered / float(special_total)) * 100, 1)
# output some quick report stats
@@ -312,6 +310,9 @@ if __name__ == "__main__":
print(" actions............: {}% covered ({} of {})".format(actions_percent, actions_covered, actions_total))
print(" specials...........: {}% covered ({} of {})".format(special_percent, special_covered, special_total))
+ if len(sys.argv) > 1:
+ html_output_path = sys.argv[1]
+
# render HTML report
with open(html_output_path, "w") as f:
f.write(html_template.format(