Command Line Interfaces

When installed via PIP, the command line program pyedaa-reports is registered in the Python installation’s Scripts directory. Usually this path is listed in PATH, thus this program is globally available after installation.

The program is self-describing. Use pyedaa-reports without parameters or pyedaa-reports help to see all available common options and commands. Each command has then it’s own help page for command specific options, which can be listed by calling pyedaa-reports <cmd> -h or pyedaa-reports help <cmd>. The version and license information of pyedaa-reports is shown by calling pyedaa-reports version.

pyedaa-reports

‘pyEDAA.Reports Service Program’ to query and transform data to/from any other format.

usage: pyedaa-reports {unittest,coverage,help,version} ...

Currently the following inpu/output formats are supported:

JUnit XML (unit test reports - Java oriented format)
Cobertura XML (branch/statement coverage - Java oriented format)

pyedaa-reports coverage

Read a code coverage report and convert it to Cobertura XML.

usage: pyedaa-reports coverage [-h] [--input [Format:]File]
                               [--output [Format:]File]

-h, --help: show this help message and exit

--input <[format:]file>: Code coverage report to read, e.g. ‘Gcov-JSON:main.gcov.json.gz’; without format: Any-Cobertura.

--output <[format:]file>: Code coverage report to write, e.g. ‘Cobertura:coverage.xml’; without format: Cobertura.

pyedaa-reports help

Display help page(s) for the given command name.

usage: pyedaa-reports help [-h] [Command]

command: Print help page(s) for a command.

-h, --help: show this help message and exit

pyedaa-reports unittest

Merge and/or transform unit testing results.

usage: pyedaa-reports unittest [-h] [--name Name] [--input [Format:]File]
                               [--merge [Format:]FilePattern]
                               [--pytest cleanup;cleanup] [--render format]
                               [--output [Format:]File]

-h, --help: show this help message and exit

--name <name>: Top-level unit testing summary name.

--input <[format:]file>: Unit testing summary file (XML), e.g. ‘pyTest-JUnit:report.xml’; without format: Any-JUnit.

--merge <[format:]filepattern>: Unit testing summary files (XML) to merge, e.g. ‘pyTest-JUnit:report/*.xml’; without format: Any-JUnit.

--pytest <cleanup;cleanup>: Remove pytest overhead.

--render <format>: Render unit testing results to <format>.

--output <[format:]file>: Processed unit testing summary file (XML), e.g. ‘Ant-JUnit:summary.xml’; without format: pyTest-JUnit.

pyedaa-reports version

Display version information.

usage: pyedaa-reports version [-h]

-h, --help: show this help message and exit