/ 
TestRail-API-0.046
River stage zero No dependents
/ TestRail::Bin::Tests

NAME

TestRail::Bin::Tests - List tests in a TestRail run matching the provided filters

VERSION

version 0.046

SYNOPSIS

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

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

DESCRIPTION

testrail-tests - list tests in a run matching the provided filters.

Can be used as the modulino TestRail::Bin::Tests. 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.

    -r --run : desired run name.

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

SEMI-OPTIONAL PARAMETERS

    -p --plan : desired plan name. Required if the run passed is a child of a plan.

    -m --match : attempt to find filenames matching the test names in the provided directory.

    --no-match : attempt to find filenames that do not match test names in the provided directory.

    --orphans : attempt to find tests in TestRail which aren't in the provided directory.

    The three above options are mutually exclusive.

    -n --no-recurse : if match (or no-match) passed, do not recurse subdirectories.

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

OPTIONAL PARAMETERS

    -c --config : configuration name to filter plans in run. Can be passed multiple times.

    -s --status : only list tests marked as [status] in testrail. Can be passed multiple times.

    -a --assignedto : only list tests assigned to user. Can be passed multiple times.

    --extension : only list files ending in the provided string (e.g. .pl, .pm, .t, .test)

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) 2020 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.