KYUA-REPORT(1)

✨ KYUA-REPORT ✨

okay so bestie, welcome to kyua-report 💖 — it's a General Commands Manual page (section 1, main character energy only) and it's literally about making reports with the results of a test suite run. slay.

---

🎀 NAME 🎀

kyua report — generates reports with the results of a test suite run. no cap, that's the whole job.

---

🦋 SYNOPSIS 🦋

kyua report [--output path] [--results-file file]
     [--results-filter types] [--verbose] [test_filter1 .. test_filterN]

look at her go 💅

---

🌸 DESCRIPTION 🌸

So the way that kyua report works is: it parses a results file and generates a user-friendly, plaintext report for user consumption on the terminal. fr fr, just for you, on your terminal, where you live.

By default? These reports only display a summary of the execution of the full test suite — to highlight where problems may lie. it's giving ✨overview✨.

But the output of kyua report can be customized to display full details on all executed test cases. And additionally, the optional arguments to kyua report are used to select which test programs or test cases to display. These are called filters and they're described below in "Test filters". iykyk.

🚨 real talk: reports generated by kyua report are not intended to be machine-parseable. humans only, bestie. don't pipe her into your parser and expect the world.

The following subcommand options are recognized:

• --output path — specifies the path to which the report should be written to. and the special values /dev/stdout and /dev/stderr can be used to specify the standard output and the standard error, respectively. so you can absolutely just yeet it straight at stdout 😌
• --results-file path, -s path — specifies the results file to operate on. defaults to LATEST, which causes kyua report to automatically load the latest results file from the current test suite. iconic default behavior honestly

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 — a comma-separated list of the test result types to include in the report. the ordering of the values is respected so that you can determine how you want the list of tests to be shown. (yes, the order you type them is the order you see them, that's the vibe 🫶)

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 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. (not me filtering out the good news 💀)

• --verbose — prints a detailed report of the execution. in addition to all the information printed by default, verbose reports include the runtime context of the test suite run, the metadata of each test case, and the verbatim output of the test cases. it's giving everything, all at once.

---

💾 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. cute little 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. 🕰️

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. fancy ✨

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. (the file is a yapper, we love that for it 📝)

---

🔍 Test filters 🔍

A test filter is a string that is used to match test cases or test programs in a test suite. filters have the following form:

test_program_name[:test_case_name]

Where test_program_name is the name of a test program or a subdirectory in the test suite, and test_case_name is the name of a test case. simple, clean, effective 💅

---

🚪 EXIT STATUS 🚪

The kyua report command returns 0 if no filters were specified or if all filters match one or more test cases. If any filter fails to match any test case, the command returns 1. so like, if you filtered for something that doesn't exist, she WILL tell you.

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
cd /usr/tests && kyua report --results-file=LATEST
kyua report --results-file=/usr/tests
kyua report --results-file=usr_tests
kyua report --results-file=usr_tests.20140731-151730-997451

five ways to get the same report and every single one of them ate 🔥

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

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

throwback to an older run, we love a little archaeology moment 🏺

---

👀 SEE ALSO 👀

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

---

and that's the whole page bestie 🫶 this one came from Debian, dated October 13, 2014 — so yeah, she's been around, she's experienced, she's a whole queen 👑 go forth and generate some reports, you've got this 💖✨