Skip to content

Commit 04fba92

Browse files
committed
Add a cover page to the test report
The cover page provide a professional document header with an optional logo, title, and key artifact details: name, version and dete of test. Overall improving report presentation for all stakeholders. Signed-off-by: Joachim Wiberg <[email protected]>
1 parent f72f2e5 commit 04fba92

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

9pm.py

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -424,16 +424,31 @@ def write_report(data, config):
424424
with open(os.path.join(LOGDIR, 'report.adoc'), 'a') as file:
425425
current_date = datetime.now().strftime("%Y-%m-%d")
426426
name = config['PROJECT-NAME'] if 'PROJECT-NAME' in config else "9pm"
427+
root = config['PROJECT-ROOT']
427428
topdoc = config['PROJECT-TOPDOC'] + "/" if 'PROJECT-TOPDOC' in config else ""
429+
version = run_git_cmd(root, ["describe", "--tags", "--always"])
428430

429-
file.write(f"= {name} Test Report\n")
430-
file.write("Author: 9pm Test Framework\n")
431-
file.write(f"Date: {current_date}\n")
432-
file.write(":toc: left\n")
433-
file.write(":toc-title: INDEX\n")
431+
file.write(":title-page:\n")
434432
file.write(f":topdoc: {topdoc}\n")
433+
file.write("ifdef::logo[]\n") # Optional -a logo=PATH from asciidoctor-pdf
434+
file.write(":title-logo-image: {logo}\n")
435+
file.write("endif::[]\n")
436+
file.write(":toc:\n")
437+
file.write(":toclevels: 2\n")
435438
file.write(":sectnums:\n")
439+
file.write(":sectnumlevels: 2\n")
440+
file.write(":pdfmark:\n")
436441
file.write(":pdf-page-size: A4\n")
442+
file.write(":pdf-page-layout: portrait\n")
443+
file.write(":pdf-page-margin: [1in, 0.5in]\n")
444+
file.write(f":keywords: regression, test, testing, 9pm, {name}\n")
445+
file.write(":subject: Regression testing\n")
446+
file.write(":autofit-option:\n")
447+
file.write("\n")
448+
449+
file.write(f"= Test Report\n")
450+
file.write(f"{name} {version}\n")
451+
file.write(f"{current_date}\n")
437452

438453
file.write("\n<<<\n")
439454
file.write("\n== Test Summary\n\n")

0 commit comments

Comments
 (0)