blob: 91086cf515c555153b7d93155aee0b298dbc05ac [file] [log] [blame]
<!DOCTYPE html>
<head>
<title>RCPTT Documentation Center</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://www.eclipse.org/rcptt/shared/css/bootstrap.min.css">
<link rel="stylesheet" href="https://www.eclipse.org/rcptt/shared/css/main.css">
<link rel="stylesheet" href="https://www.eclipse.org/rcptt/shared/css/prism.css">
<link rel="icon" href="https://www.eclipse.org/rcptt/shared/img/favicon.ico">
<script src="https://www.eclipse.org/rcptt/shared/js/jquery.min.js"></script>
<script src="https://www.eclipse.org/rcptt/shared/js/bootstrap.min.js"></script>
<script src="https://www.eclipse.org/rcptt/shared/js/prism.js"></script>
<script src="https://www.eclipse.org/rcptt/shared/js/ecl.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-39589807-5', 'eclipse.org');
ga('send', 'pageview');
</script>
</head>
<body>
<div id="before-footer">
<header>
<nav class="navbar navbar-default navbar-static-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">RCPTT Documentation Center</span>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li class="active" >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/getstarted">User Guide</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/faq/">FAQ</a>
</li>
<li>
<a href="http://eclipse.org/rcptt">Back to RCPTT Main Site</a>
</li>
<li>
<a href="http://eclipse.org">Eclipse.org</a>
</li>
</ul>
</div>
</nav>
</header>
<section class="content">
<div class="container">
<div class="row">
<div class="col-sm-3">
<div class="rcptt-sidebar">
<ul class="nav">
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/getstarted/">Get Started</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/testeditor/">Test Case Editor</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/controlpanel">Control Panel</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/assertions/">Assertions</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/">Eclipse Command Language</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/new-command-guide/">New ECL Command Guide</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/excel-import-export/">ECL commands for Excel import and export</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/ecl/xml-import-export/">ECL commands for XML import and export</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/">Contexts</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/workspace/">Workspace</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/workbench/">Workbench</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/launch/">Launch</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/preferences/">Preferences</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/parameters/">Parameters</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/group/">Group</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/folder/">Folder</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/default/">Default</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/super/">Super</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/contexts/ecl/">ECL Script</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/">Verifications</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/text/">Text</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/treetable/">Table/Tree</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/errorlog/">Error Log</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/verifications/time/">Time</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/procedures/">Procedures and Variables</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/runner/">Test Runner</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/runner/arguments/">Arguments</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/maven/">Maven plugin</a>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/">RAP</a>
<ul class="nav">
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/install/">Install instructions</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/recordReplay/">Record and Replay</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/capability/">Capability Contexts</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/rap-commands/">ECL commands</a>
</li>
<li >
<a href="https://www.eclipse.org/rcptt/documentation/userguide/rap/rap-maven/">Maven plugin</a>
</li>
</ul>
</li>
<li ><a href="https://www.eclipse.org/rcptt/documentation/userguide/integration/test-rail-integration/">Integration with TestRail</a>
</li>
</ul>
</div>
</div>
<div class="col-sm-9">
<h1>Integration with TestRail</h1>
<p></p>
<h2>Configuration</h2>
<hr>
<p>To configure connection to TestRail, you need to know the following parameters:</p>
<ul>
<li><b>host</b> — TestRail Host. Should be valid URL and end with slash "/".</li>
<li><b>username</b> — Username.</li>
<li><b>password</b> — Password or API Key.</li>
<li><b>projectId</b> — Project ID. Should start with "P" and end with positive number.</li>
<li><b>testRunId</b> (optional) — Test Run ID. Should start with "R" and end with positive number.</li>
<li><b>useUnicode</b> (optional) — Is Unicode used to encode requests to TestRail.</li>
</ul>
<h3>Configure RCPTT IDE</h3>
<p>To configure connection in RCPTT IDE, go to Window -> Preferences -> RCP Testing Tool -> Integrations -> TestRail, activate 'Enable integration with TestRail' checkbox and provide all parameters.<br>
You can test connection by using 'Test connection' button.</p>
<p><img src="https://www.eclipse.org/rcptt/shared/img/test-rail-1.png"></img><br><br></p>
<p>Note that the password is stored in the Secure Storage, so you will be asked to type your master password.<br><br></p>
<p>If you want to send Test Run results to TestRail for specific Test Suite, you should enable 'TestRail' engine in Run Configuration.
To enable the engine, go to Run -> Run Configurations..., choose the Test Suite and activate 'TestRail' checkbox on 'Test Engines' tab.
By default, 'TestRail' engine is disabled for Test Suite and Test Run results are not sent to TestRail. Also, you can specify ID of the existing Test Run on this tab.</p>
<p><img src="https://www.eclipse.org/rcptt/shared/img/test-rail-2.png"></img><br><br></p>
<h3>Configure RCPTT Test Runner</h3>
<p>To configure connection in RCPTT Test Runner, add 'testEngine' command-line option value with 'testrail:' prefix and semicolon-separated list of parameters.<br></p>
<p>Example:</p>
<pre>
-testEngine
'testrail:host=https://example.testrail.net/;username=username@example.com;password=1234567890;projectId=P1;testRunId=R10'
</pre>
<p><br></p>
<h3>Configure RCPTT Maven Plugin</h3>
<p>To configure connection in RCPTT Test Runner, add 'testEngines/testEngine' to the configuration section in your pom.xml.
For TestRail engine specify 'testrail' ID value and list of parameters.
<br>
Example:</p>
<pre>
&lt;configuration&gt;
...
&lt;testEngines&gt;
...
&lt;testEngine&gt;
&lt;id&gt;testrail&lt;/id&gt;
&lt;parameters&gt;
&lt;host&gt;https://example.testrail.net/&lt;/host&gt;
&lt;username&gt;username@example.com&lt;/username&gt;
&lt;password&gt;1234567890&lt;/password&gt;
&lt;projectId&gt;P1&lt;/projectId&gt;
&lt;testRunId&gt;R10&lt;/testRunId&gt;
&lt;/parameters&gt;
&lt;/testEngine&gt;
&lt;/testEngines&gt;
&lt;/configuration&gt;
</pre>
<p><br></p>
<h2>Using TestRail features in RCPTT Test Case</h2>
<hr>
<h3>Provide TestRail ID</h3>
<p>To bind RCPTT Test Case with TestRail Test Case, add a new Test Case property called 'testrail-id' and provide ID from TestRail.</p>
<p><img src="https://www.eclipse.org/rcptt/shared/img/test-rail-3.png"></img><br><br></p>
<p>Property name field has the suggestions list. So you can choose 'testrail-id' property from it.</p>
<p><img src="https://www.eclipse.org/rcptt/shared/img/test-rail-4.png"></img><br><br></p>
<p>Value field has the suggestions for 'testrail-id' too. All available Test Case IDs from TestRail are shown in this list.<br>
When one of IDs is chosen (1), its description is shown (2). You can copy it all with 'Copy to the clipboard' button (3).</p>
<p><img src="https://www.eclipse.org/rcptt/shared/img/test-rail-5.png"></img><br><br></p>
<h3>Use TestRail Step ECL Command</h3>
<p>To send Step Results to TestRail, you can use test-rail-step ECL command.<br>
If you use test-rail-step command, make sure that 'Test Case (Steps)' template is chosen for your Test Case on TestRail side.<br><br></p>
<p>Command arguments:</p>
<ul>
<li><b>-content</b> — Step description.</li>
<li><b>-expected</b> — Expected result.</li>
<li><b>-actual</b> — Actual result.</li>
<li><b>-status</b> — Step status. One of TestRail statuses: passed, blocked, retest, failed.</li>
</ul>
<p><br>
Example:</p>
<pre>
test-rail-step -content "step one" -expected "success" -actual "success" -status passed
test-rail-step -content "step two" -expected "success" -actual "failure" -status failed
</pre>
<p><img src="https://www.eclipse.org/rcptt/shared/img/test-rail-6.png"></img><br><br></p>
</div>
</div>
</div>
</section>
<script src="https://www.eclipse.org/rcptt/shared/js/main.js"></script>
</body>