/ 
TestRail-API-0.052
River stage zero No dependents
/ TestRail::Bin::Cases

NAME

TestRail::Bin::Cases - get information about cases inside various testsuites/sections.

VERSION

version 0.052

SYNOPSIS

testrail-cases [OPTIONS]

require `which testrail-cases`;
TestRail::Bin::Cases::run('args' => @args);

DESCRIPTION

testrail-cases - get information about cases inside various testsuites/sections.

By default will tell you which cases are in both the testsuite and directory passed.

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

    -t --testsuite : desired testsuite name to search for cases within. May be passed multiple times.

    -d --directory : directory to search for tests to correlate with TestRail cases. May be passed multiple times.

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

SEMI-OPTIONAL PARAMETERS

    -m --missing : Only show cases which are in the directory passed, but not TestRail. Mutually exclusive with orphans.

    -o --orphans : Only show cases which are in TestRail, but not the directory passed. Mutually exclusive with missing.

    -n --no-recurse : do not recurse subdirectories when considering what tests need adding/updating/pruning.

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

OPTIONAL PARAMETERS

    --type : Filter cases to make syncing judgements against type(s). May be passed multiple times.

    --section : Filter cases to make syncing judgements against a specific section.

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

    --test : print which tests would be added/updated/removed, but don't actually do anything

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