KYUA-REPORT-HTML(1)

💅 kyua-report-html — the General Commands Manual page, but make it cute

okay bestie, buckle up, because kyua-report-html(1) is genuinely one of the most satisfying little commands in the whole kyua family and I need you to know about it 🎀

---

✨ NAME ✨

kyua report-html — generates an HTML report with the results of a test suite run 🦋

---

📜 SYNOPSIS 📜

kyua report-html [--force] [--output path] [--results-file file]
     [--results-filter types]

---

💖 DESCRIPTION 💖

so like, the kyua report-html command is your girl for turning test results into a whole vibe. it gives you a simple mechanism to generate HTML reports of the execution of a test suite 🌸

here's the tea: the command processes a results file, and then it populates a directory with multiple HTML and supporting files to describe the results recorded in that results file. it's giving scrapbook but make it test data, fr fr 📸

the HTML output is static and self-contained, so it can easily be served by any simple web server — no cap, no build step, no nonsense ✨

⚠️ but listen, the command expects the target directory to not exist, because it would overwrite any contents if not careful. she is not playing around. 😭

the following subcommand options are recognized 👑

• --force — forces the deletion of the output directory if it exists. use care, bestie, because this effectively means a rm -rf. yes, that rm -rf. 💀
• --output directory — specifies the target directory into which to generate the HTML files. the directory must not exist unless the --force option is provided. the default is ./html. 🎀
• --results-file path, -s path — specifies the results file to operate on. defaults to LATEST, which causes kyua report-html to automatically load the latest results file from the current test suite. iykyk ✨

the following values are accepted:

• LATEST — requests the load of the latest results file available for the test suite rooted at the current directory. 🦋
• Directory — requests the load of the latest results file available for the test suite rooted at the given directory. 📁
• Test suite name — requests the load of the latest results file available for the given test suite. 💜
• Results identifier — requests the load of a specific results file. 🔍
• Explicit file name (aka everything else) — load the specified results file. 🙈

see “Results files” for more details.

• --results-filter types — comma-separated list of the test result types to include in the report. the ordering of the values is respected, so you can determine how you want the list of tests to be shown. she's an ordered queen 👑

the valid values are: broken, failed, passed, skipped and xfail.

if the parameter supplied to the option is empty, filtering is suppressed and all result types are shown in the report. the full spectrum, the whole rainbow 🌈

the default value for this flag includes all the test results except the passed tests. showing the passed tests by default clutters the report with too much information, so only abnormal conditions are included. lowkey a mood, honestly. 💅

---

🗂️ Results files 🗂️

results files contain, as their name implies, the results of the execution of a test suite. each test suite executed by kyua-test(1) generates a new results file, and such results files can be loaded later on by inspection commands such as kyua-report(1) to analyze their contents. it's a whole archive situation 🫶

results files support identifier-based lookups and also path name lookups. the differences between the two are described below.

the default naming scheme for the results files provides simple support for identifier-based lookups and historical recording of test suite runs. each results file is given an identifier derived from the test suite that generated it and the time the test suite was run. kyua can later look up results files by these fields. so organized of her ⭐

the identifier follows this pattern:

<test_suite>.<YYYYMMDD>-<HHMMSS>-<uuuuuu>

where test_suite is the path to the root of the test suite that was run with all slashes replaced by underscores, and YYYYMMDD-HHMMSS-uuuuuu is a timestamp with microsecond resolution. precise. iconic. 😌

when using the default naming scheme, results files are stored in the ~/.kyua/store/ subdirectory and each file holds a name of the form:

~/.kyua/store/results.<identifier>.db

results files are simple SQLite databases with the schema described in the /usr/share/kyua/store/schema_v?.sql files. for details on the schema, please refer to the heavily commented SQL file. she left notes for you, bestie 💜

---

🚪 EXIT STATUS 🚪

the kyua report-html command always returns 0. always. unbothered. moisturized. in her lane. 💅

additional exit codes may be returned as described in kyua(1).

---

🌟 EXAMPLES 🌟

🧚 Workflow with results files 🧚

if one runs the following command twice in a row:

kyua test -k /usr/tests/Kyuafile

the two executions will generate two different files with names like:

~/.kyua/store/results.usr_tests.20140731-150500-196784.db
~/.kyua/store/results.usr_tests.20140731-151730-997451.db

taking advantage of the default naming scheme, the following commands would all generate a report for the results of the latest execution of the test suite:

cd /usr/tests && kyua report-html
cd /usr/tests && kyua report-html --results-file=LATEST
kyua report-html --results-file=/usr/tests
kyua report-html --results-file=usr_tests
kyua report-html --results-file=usr_tests.20140731-151730-997451

but it is also possible to explicitly load data for older runs or from explicitly-named files:

kyua report-html \
    --results-file=usr_tests.20140731-150500-196784
kyua report-html \
    --results-file=~/.kyua/store/results.usr_tests.20140731-150500-196784.db

see? flexible. versatile. she contains multitudes 🦋✨

---

👀 SEE ALSO 👀

kyua(1), kyua-report(1), kyua-report-junit(1)

---

and that's the whole page, bestie!! this one came from the Debian crew, dated October 13, 2014 — shoutout to them for shipping a command this clean 🫶 go make some gorgeous static HTML reports, you absolute main character 👑💖