tpsreport¶

(T)est(P)lan (S)uper (REPORT)

A Testplan tool for report manipulation.

tpsreport [OPTIONS] COMMAND [ARGS]...

convert¶

Parses provided result format and, optionally, writes to another/displays.

tpsreport convert [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

display¶

Serves the result through a local web UI.

param port: port number to use

tpsreport convert display [OPTIONS]

Options

-p, --port <port>¶: the local port the webserver is using

fromcppunit¶

Reads a CppUnit XML result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport convert fromcppunit [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

fromgtest¶

Reads a GoogleTest XML result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport convert fromgtest [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

fromjson¶

Reads a Testplan JSON result.

param source: path to source file

tpsreport convert fromjson [OPTIONS] SOURCE

Arguments

SOURCE¶: Required argument

fromjunit¶

Reads a JUnit result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport convert fromjunit [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

tojson¶

Writer command for exporting JSON format.

param output: path to write output to

tpsreport convert tojson [OPTIONS] OUTPUT

Arguments

OUTPUT¶: Required argument

tojunit¶

Writer command for exporting JUnit format.

param dir_name: directory to write XML files to

return: JUnit writer action to perform

tpsreport convert tojunit [OPTIONS] DIR_NAME

Arguments

DIR_NAME¶: Required argument

topdf¶

Writer command for exporting PDF format.

param filename: filename to write to

param pdf_style:

report style to use

tpsreport convert topdf [OPTIONS] FILENAME

Options

--pdf-style <pdf_style>¶

result - only the result of the run will be shown

summary - test details will be shown

extended - passing tests will include testcase detail, while failing tests will include assertion detail

detailed - passing tests will include assertion detail, while failing tests will include assertion detail

Options:	result\|summary\|extended\|detailed

Arguments

FILENAME¶: Required argument

display¶

Serves the result through a local web UI.

param port: port number to use

tpsreport display [OPTIONS] COMMAND [ARGS]...

Options

-p, --port <port>¶: the local port the webserver is using

fromcppunit¶

Reads a CppUnit XML result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport display fromcppunit [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

fromgtest¶

Reads a GoogleTest XML result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport display fromgtest [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

fromjson¶

Reads a Testplan JSON result.

param source: path to source file

tpsreport display fromjson [OPTIONS] SOURCE

Arguments

SOURCE¶: Required argument

fromjunit¶

Reads a JUnit result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport display fromjunit [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

merge¶

Merges many report files into a single Testplan.

Currently a simple combine strategy is available which put all tests from the sources next to each other in the merged report. The subcommands forms a pipeline, which should start with source commands (from*) defining the inputs, then any write (to*) or a display command.

The inpust can be any supported format they will be converted to Testplan format before the merge

use merge COMMAND –help to get more details of the subcommands.

tpsreport merge [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

display¶

Serves the result through a local web UI.

param port: port number to use

tpsreport merge display [OPTIONS]

Options

-p, --port <port>¶: the local port the webserver is using

from¶

Reads multiple input files in one go.

It takes a list of comma separated URIs. The URI scheme should be a known format similar to from* commands, e.g. fromjson /tmp/a.json translates to json:/tmp/a.json. Globs can be used in the URIs like json:/tmp/report_*.json,cppunit:/tmp/result_*.xml

param uri_list: comma separated string of URIs

tpsreport merge from [OPTIONS] URI_LIST

Arguments

URI_LIST¶: Required argument

fromcppunit¶

Reads a CppUnit XML result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport merge fromcppunit [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

fromgtest¶

Reads a GoogleTest XML result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport merge fromgtest [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

fromjson¶

Reads a Testplan JSON result.

param source: path to source file

tpsreport merge fromjson [OPTIONS] SOURCE

Arguments

SOURCE¶: Required argument

fromjunit¶

Reads a JUnit result.

param source: path to source file

param name: name of the generated in-memory testplan

param description:

description of generated test result

tpsreport merge fromjunit [OPTIONS] SOURCE

Options

-n, --name <name>¶: The name of the generated testplan and test

-d, --description <description>¶: Description of the result

Arguments

SOURCE¶: Required argument

tojson¶

Writer command for exporting JSON format.

param output: path to write output to

tpsreport merge tojson [OPTIONS] OUTPUT

Arguments

OUTPUT¶: Required argument

tojunit¶

Writer command for exporting JUnit format.

param dir_name: directory to write XML files to

return: JUnit writer action to perform

tpsreport merge tojunit [OPTIONS] DIR_NAME

Arguments

DIR_NAME¶: Required argument

topdf¶

Writer command for exporting PDF format.

param filename: filename to write to

param pdf_style:

report style to use

tpsreport merge topdf [OPTIONS] FILENAME

Options

--pdf-style <pdf_style>¶

result - only the result of the run will be shown

summary - test details will be shown

extended - passing tests will include testcase detail, while failing tests will include assertion detail

detailed - passing tests will include assertion detail, while failing tests will include assertion detail

Options:	result\|summary\|extended\|detailed

Arguments

FILENAME¶: Required argument