/ 
TestRail-API-0.050
River stage zero No dependents
/ TestRail::Bin::Runs

NAME

TestRail::Bin::Runs - List runs in a TestRail project matching the provided filters

VERSION

version 0.050

SYNOPSIS

testrail-runs [OPTIONS] | xargs prove -PTestrail=...

require `which testrail-runs`;
TestRail::Bin::Run::run('args' => \@args);

DESCRIPTION

testrail-runs - list runs in a TestRail project matching the provided filters. Groups by plan for runs which are children of a plan.

Can be used as the modulino TestRail::Bin::Runs. Has a single 'run' function which accepts a hash with the 'args' parameter being the array of arguments.

PARAMETERS:

MANDATORY PARAMETERS

    --apiurl : full URL to get to TestRail index document

    --password : Your TestRail Password, or a valid API key (TestRail 4.2 and above).

    --user : Your TestRail User Name.

    -j --project : desired project name.

All mandatory options not passed with the above switches, or in your ~/.testrailrc will be prompted for.

OPTIONAL PARAMETERS

    -c --config : configuration name to filter runs. Can be passed multiple times.

    -s --status : only list runs with one or more tests having [status] in testrail. Can be passed multiple times.

    -e --encoding : Character encoding of arguments. Defaults to UTF-8. See Encode::Supported for supported encodings.

    -l --lifo : LIFO sorting of results. Defaults to FIFO sort if not passed.

    -m --milesort : Sort by milestone due time. Defaults to sorting by run creation time if not passed.

    Be aware that when sorting by milestone, if a run has no milestone set, it is considered "earlier" than anything else by perl's comparison routines. Ergo if they are the lowest priority, you should consider running LIFO.

CONFIGURATION FILE

In your \$HOME, (or the current directory, if your system has no concept of a home directory) put a file called .testrailrc with key=value syntax separated by newlines. Valid Keys are the same as documented by App::Prove::Plugin::TestRail. All options specified thereby are overridden by passing the command-line switches above.

MISCELLANEOUS OPTIONS:

    --help : show this output

SPECIAL THANKS

Thanks to cPanel Inc, for graciously funding the creation of this distribution.

AUTHOR

George S. Baugh <teodesian@cpan.org>

SOURCE

The development version is on github at https://github.com/teodesian/TestRail-Perl and may be cloned from git://github.com/teodesian/TestRail-Perl.git

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by George S. Baugh.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.