apache-tuscany/site/trunk/site-publish/plugins/tuscany-itest-plugin/test-mojo.html
2014-11-21 09:30:19 +00:00

255 lines
8.4 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>Apache Tuscany Integration Test Plugin -
tuscany-itest-plugin - tuscany-itest:test</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
</head>
<body class="composite">
<div id="banner">
<span id="bannerLeft">
Apache Tuscany Integration Test Plugin
</span>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
Last Published: 02/15/2007
</div>
<div class="xright">
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>Overview</h5>
<ul>
<li class="none">
<a href="index.html">Introduction</a>
</li>
<li class="none">
<a href="plugin-info.html">Goals</a>
</li>
<li class="none">
<a href="usage.html">Usage</a>
</li>
<li class="none">
<a href="faq.html">FAQ</a>
</li>
</ul>
<h5>Examples</h5>
<ul>
</ul>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<a name="tuscany-itest:test"></a><div class="section"><h2>tuscany-itest:test</h2>
<p>Integration-tests an SCA composite by running it in local copy of Apache Tuscany
and calling JUnit-based test components to exercise it.</p>
<p><b>Mojo Attributes</b>:<ul>
<li>Requires a Maven 2.0 project to execute.</li>
<li>Automatically executes within the lifecycle phase: <code>integration-test</code></li>
</ul>
</p>
<a name="required_parameters"></a><div class="section"><h3>Required Parameters</h3>
<table class="bodyTable">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#testClassesDirectory">testClassesDirectory</a></b></td>
<td><code>File</code></td>
<td>The directory containing generated test classes of the project being tested.</td>
</tr>
<tr class="a">
<td><b><a href="#testComponentName">testComponentName</a></b></td>
<td><code>String</code></td>
<td>The name of the component that will be implemented by the test harness composite.</td>
</tr>
<tr class="b">
<td><b><a href="#testDomain">testDomain</a></b></td>
<td><code>String</code></td>
<td>The SCA domain in which to deploy the test components.</td>
</tr>
</table>
</div>
<a name="optional_parameters"></a><div class="section"><h3>Optional Parameters</h3>
<table class="bodyTable">
<tr class="a">
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
<tr class="b">
<td><b><a href="#reportsDirectory">reportsDirectory</a></b></td>
<td><code>File</code></td>
<td>The directory where reports will be written.</td>
</tr>
<tr class="a">
<td><b><a href="#systemScdl">systemScdl</a></b></td>
<td><code>URL</code></td>
<td>The location of the SCDL that configures the Apache Tuscany runtime.
This allows the default runtime configuration supplied in this plugin
to be overridden.</td>
</tr>
<tr class="b">
<td><b><a href="#testScdl">testScdl</a></b></td>
<td><code>File</code></td>
<td>The location if the SCDL that defines the test harness composite.
The source for this would normally be placed in the test/resources
directory and be copied by the resource plugin; this allows property
substitution if required.</td>
</tr>
<tr class="a">
<td><b><a href="#trimStackTrace">trimStackTrace</a></b></td>
<td><code>boolean</code></td>
<td>Whether to trim the stack trace in the reports to just the lines within
the test, or show the full trace. Default value is <code>true</code>.</td>
</tr>
</table>
</div>
<a name="parameter_details"></a><div class="section"><h3>Parameter Details</h3>
<p><b><a name="reportsdirectory">reportsDirectory</a></b></p>
<p>The directory where reports will be written.</p>
<ul>
<li><b>Type</b>: <code>java.io.File</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>Expression</b>: <code>${project.build.directory}/surefire-reports</code></li>
</ul><hr></hr><p><b><a name="systemscdl">systemScdl</a></b></p>
<p>The location of the SCDL that configures the Apache Tuscany runtime.
This allows the default runtime configuration supplied in this plugin
to be overridden.</p>
<ul>
<li><b>Type</b>: <code>java.net.URL</code></li>
<li><b>Required</b>: <code>No</code></li>
</ul><hr></hr><p><b><a name="testclassesdirectory">testClassesDirectory</a></b></p>
<p>The directory containing generated test classes of the project being tested.</p>
<ul>
<li><b>Type</b>: <code>java.io.File</code></li>
<li><b>Required</b>: <code>Yes</code></li>
<li><b>Expression</b>: <code>${project.build.testOutputDirectory}</code></li>
</ul><hr></hr><p><b><a name="testcomponentname">testComponentName</a></b></p>
<p>The name of the component that will be implemented by the test harness composite.</p>
<ul>
<li><b>Type</b>: <code>java.lang.String</code></li>
<li><b>Required</b>: <code>Yes</code></li>
<li><b>Expression</b>: <code>testHarness</code></li>
</ul><hr></hr><p><b><a name="testdomain">testDomain</a></b></p>
<p>The SCA domain in which to deploy the test components.</p>
<ul>
<li><b>Type</b>: <code>java.lang.String</code></li>
<li><b>Required</b>: <code>Yes</code></li>
<li><b>Expression</b>: <code>itest://localhost/testDomain/</code></li>
</ul><hr></hr><p><b><a name="testscdl">testScdl</a></b></p>
<p>The location if the SCDL that defines the test harness composite.
The source for this would normally be placed in the test/resources
directory and be copied by the resource plugin; this allows property
substitution if required.</p>
<ul>
<li><b>Type</b>: <code>java.io.File</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>Expression</b>: <code>${project.build.testOutputDirectory}/itest.scdl</code></li>
</ul><hr></hr><p><b><a name="trimstacktrace">trimStackTrace</a></b></p>
<p>Whether to trim the stack trace in the reports to just the lines within
the test, or show the full trace.</p>
<ul>
<li><b>Type</b>: <code>boolean</code></li>
<li><b>Required</b>: <code>No</code></li>
<li><b>Expression</b>: <code>${trimStackTrace}</code></li>
<li><b>Default</b>: <code>true</code></li>
</ul>
</div>
</div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">&#169;
2007
Apache Software Foundation
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>