From 4446c61d5fcde70839a8cf3bc88b8463af0e5242 Mon Sep 17 00:00:00 2001 From: Aaron Traas Date: Fri, 7 Jul 2017 22:37:12 -0400 Subject: [PATCH] Now YAML coverage test generates a nice HTML template --- .gitlab-ci.yml | 8 +-- tests/Makefile | 3 +- tests/coverage_dungeon.html.tpl | 112 ++++++++++++++++++++++++++++++++ tests/coverage_dungeon.py | 78 ++++++++++++++++++++-- 4 files changed, 192 insertions(+), 9 deletions(-) create mode 100644 tests/coverage_dungeon.html.tpl diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index e6d8543..fdf2bb7 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -12,7 +12,7 @@ binary:debug: - apk update - apk add make gcc musl-dev python3 libedit-dev - pip3 install PyYAML - script: + script: - make debug artifacts: paths: @@ -31,7 +31,7 @@ binary:release: - apk update - apk add make gcc musl-dev python3 libedit-dev - pip3 install PyYAML - script: + script: - make advent cheat artifacts: paths: @@ -81,7 +81,8 @@ test:debug: stage: test before_script: - apk update - - apk add make gcc libedit-dev + - apk add make gcc python3 libedit-dev + - pip3 install PyYAML - apk add lcov --update-cache --repository http://dl-3.alpinelinux.org/alpine/edge/testing/ --allow-untrusted script: - cd tests @@ -118,4 +119,3 @@ pages: - master dependencies: - test:debug - diff --git a/tests/Makefile b/tests/Makefile index db49d9d..b364432 100644 --- a/tests/Makefile +++ b/tests/Makefile @@ -1,6 +1,6 @@ # Test-suite makefile for reposurgeon -# Use absolute path so tests that change working directory still use +# Use absolute path so tests that change working directory still use # scripts from parent directory. Note that using $PWD seems to fail # here under Gitlab's CI environment. PATH := $(realpath ..):$(realpath .):${PATH} @@ -26,6 +26,7 @@ check: savecheck regress coverage: check lcov -t "advent" -o ../advent.info -c -d .. --gcov-tool=$(GCOV) genhtml -o ../coverage/ ../advent.info + python3 coverage_dungeon.py .SUFFIXES: .chk diff --git a/tests/coverage_dungeon.html.tpl b/tests/coverage_dungeon.html.tpl new file mode 100644 index 0000000..f5c5ec9 --- /dev/null +++ b/tests/coverage_dungeon.html.tpl @@ -0,0 +1,112 @@ + + + + + LCOV - advent.info + + + + + + + + + + + + +
adventure.yaml Coverage report
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TotalCovered% Coverage
Test:adventure.yamlLocations:{}{}{}%
Date:2017-07-07 21:47:56Arbitrary Messages:{}{}{}%
Objects:{}{}{}%
+
+
+ +
+ + + + + + + {} +
Locationlongshort
+
+ + + + + + + {} +
Arbitrary MessageCovered?
+
+ + + + + + + {} +
ObjectsCovered?
+
+
+ + + + +
Generated by: Open Adventure Dungeon Coverage Generator
+
+ + diff --git a/tests/coverage_dungeon.py b/tests/coverage_dungeon.py index 0362710..b65094a 100644 --- a/tests/coverage_dungeon.py +++ b/tests/coverage_dungeon.py @@ -7,6 +7,30 @@ import pprint test_dir = "." yaml_name = "../adventure.yaml" +html_template_path = "coverage_dungeon.html.tpl" +html_output_path = "../coverage/adventure.yaml.html" + +location_row = """ + + {} +   +   + +""" + +arb_msg_row = """ + + {} +   + +""" + +object_row = """ + + {} +   + +""" def loc_coverage(locations, text): for locname, loc in locations: @@ -47,6 +71,9 @@ if __name__ == "__main__": with open(yaml_name, "r") as f: db = yaml.load(f) + with open(html_template_path, "r") as f: + html_template = f.read() + locations = db["locations"] arb_msgs = db["arbitrary_messages"] objects = db["objects"] @@ -60,20 +87,63 @@ if __name__ == "__main__": arb_coverage(arb_msgs, text) obj_coverage(objects, text) + print("\nadventure.yaml coverage rate:") + + location_html = "" + location_total = len(locations) * 2 + location_covered = 0 for locouter in locations: locname = locouter[0] loc = locouter[1] + long_success = "covered" + short_success = "covered" if loc["description"]["long"] != True: - print("%s long description not covered!" % locname) + long_success = "uncovered" + else: + location_covered += 1 + if loc["description"]["short"] != True: - print("location: %s short description not covered!" % locname) + short_success = "uncovered" + else: + location_covered += 1 + location_html += location_row.format(locname, long_success, short_success) + location_percent = round((location_covered / location_total) * 100, 1) + print(" locations..........: {}% covered ({} of {})".format(location_percent, location_covered, location_total)) + + arb_msg_html = "" + arb_total = len(arb_msgs) + arb_covered = 0 for name, msg in arb_msgs: + success = "covered" if msg != True: - print("arbitrary message: %s not covered!" % name) + success = "uncovered" + else: + arb_covered += 1 + arb_msg_html += arb_msg_row.format(name, success) + arb_percent = round((arb_covered / arb_total) * 100, 1) + print(" arbitrary_messages.: {}% covered ({} of {})".format(arb_percent, arb_covered, arb_total)) + object_html = "" + objects_total = 0 + objects_covered = 0 for (obj_name, obj) in objects: if obj["descriptions"]: for j, desc in enumerate(obj["descriptions"]): + objects_total += 1 + success = "covered" if desc != True: - print("object: %s desctiption #%d not covered!" % (obj_name, j)) + success = "uncovered" + else: + objects_covered += 1 + object_html += object_row.format("%s[%d]" % (obj_name, j), success) + objects_percent = round((objects_covered / objects_total) * 100, 1) + print(" objects............: {}% covered ({} of {})".format(objects_percent, objects_covered, objects_total)) + + with open(html_output_path, "w") as f: + f.write(html_template.format( + location_total, location_covered, location_percent, + arb_total, arb_covered, arb_percent, + objects_total, objects_covered, objects_percent, + location_html, arb_msg_html, object_html + )) -- 2.31.1