kyua-results-files man page

results-files — Description of the results files naming scheme

Description

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.

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

Values accepted by --results-file

Every command in Kyua that creates or reads from a results file accepts a --results-file flag to indicate which file to be used.

For commands that create a results file (only 1(kyua-test) at the moment), the following values are accepted:

‘NEW’
Requests the automatic generation of a new results file name based on the test suite being run and the current time.
Explicit file name (aka everything else)
Store the results file where indicated.

For commands that read from an existing results file (notably kyua-report(1)), 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.

Naming scheme

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 fileds.

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.

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

Internals

Results files are simple SQLite databases with the schema described in the /usr/share/kyua-cli/store/schema_v?.sql files. For details on the schema, please refer to the heavily commented SQL file.

Files

~/.kyua/store/
Default location for the results files.
/usr/share/kyua-cli/store/schema_v?.sql
SQL schema to apply to new results files.

Examples

Let's say you run the following command twice in a row:

kyua test -k /usr/tests/Kyuafile

The two executions will generate two files with names like these:

~/.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

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

See Also

kyua(1)

Referenced By

kyua(1), kyua-db-exec(1), kyua-db-migrate(1), kyua-report(1), kyua-report-html(1), kyua-report-junit(1), kyua-test(1).

August 1, 2014