/ 
TestRail-API-0.012
River stage zero No dependents
/ testrail-report

NAME

testrail-report - Upload your TAP results to TestRail after they've finished

VERSION

version 0.012

SYNOPSIS

testrail-report [OPTIONS] tapfile
prove -v sometest.t > results.tap && testrail-report [OPTIONS] results.tap

prove -v sometest.t | testrail-report [OPTIONS]

prove -PTestRail='http://some.testlink.install/,someUser,somePassword,someProject,someRun,0,step_results' sometest.t

DESCRIPTION

testrail-report - report raw TAP results to a TestRail install

USAGE: =head2 PARAMETERS:

MANDATORY PARAMETERS

--project [someproject] : associate results (if any) with theprovided project name.

--run [somerun] : associates results (if any) with the provided run name.

IF none of these options are provided, you will be asked to type these in as needed, supposing you are not redirecting input (such as piping into this command).

CONFIG OVERRIDES

In your \$HOME, put a file called .testrailrc with key=value syntax separated by newlines. Valid Keys are: apiurl,user,password

CONFIG OPTIONS

These override the config, if present. If neither are used, you will be prompted.

--apiurl   [url] : full URL to get to TestRail index document

--password [key] : Your TestRail Password.

--user    [name] : Your TestRail User Name.

BEHAVIOR

--case-ok      : Whether to consider each OK to correspond to a test in TestRail

--step-results [name] : 'System Name' of a 'step_results' type field to set for your tests.

These options are mutually exclusive. If neither is set, the overall result of the test will be used as the pass/fail for the test.

PROVE PLUGIN:

passing -PTestRail=apiurl,user,pass,project,run to prove will automatically upload your test results while the test is running if real-time results are desired.

See App::Prove::Plugin::TestRail for more information.

REQUIREMENTS:

Your TestRail install must have 3 custom statuses with the internal names 'skip', 'todo_pass', and 'todo_fail', to represent those states which TAP can have.

SEE ALSO

TestRail::API

App::Prove::Plugin::TestRail

TAP::Parser

SPECIAL THANKS

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

AUTHOR

George S. Baugh <teodesian@cpan.org>

SOURCE

The development version is on github at http://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) 2014 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.