Sync docs from master to gh-pages

This commit is contained in:
buildmaster
2019-08-09 21:57:21 +00:00
parent e23a7bf12f
commit 01a2aafb14
70 changed files with 3875 additions and 3450 deletions

View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-08-08
| Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-08-09
| Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20190808" />
<meta name="Date-Revision-yyyymmdd" content="20190809" />
<meta http-equiv="Content-Language" content="en" />
<title>Spring Cloud Contract Maven Plugin &#x2013; spring-cloud-contract:generateTests</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
@@ -148,7 +148,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2019-08-08
<li id="publishDate">Last Published: 2019-08-09
<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 2.2.0.BUILD-SNAPSHOT
@@ -506,17 +506,32 @@ folder after running tests.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b
<tr class="a">
<td><b><a href="#failOnNoStubs">failOnNoStubs</a></b></td>
<td><b><a href="#failOnInProgress">failOnInProgress</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>If set to true then if any contracts that are in progress are
found, will break the build. On the producer side you need to be
explicit about the fact that you have contracts in progress and
take into consideration that you might be causing false positive
test execution results on the consumer side.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>failOnInProgress</tt>.<br /></td>
</tr>
<tr class="b">
<td><b><a href="#failOnNoContracts">failOnNoContracts</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>When enabled, this flag will tell stub runner to throw an exception
when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>failOnNoStubs</tt>.<br /></td>
when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>failOnNoContracts</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#generatedTestResourcesDir">generatedTestResourcesDir</a></b></td>
@@ -527,7 +542,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/generated-test-resources/contracts</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#generatedTestSourcesDir">generatedTestSourcesDir</a></b></td>
@@ -538,7 +553,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/generated-test-sources/contracts</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#ignoredFiles">ignoredFiles</a></b></td>
@@ -550,7 +565,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
@Ignored tests.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#imports">imports</a></b></td>
@@ -561,7 +576,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
<td>Imports that should be added to generated tests.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#includedFiles">includedFiles</a></b></td>
@@ -572,7 +587,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
<td>Patterns that should be taken into account for processing.<br /><b>User property is</b>: <tt>includedFiles</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#mavenTestSkip">mavenTestSkip</a></b></td>
@@ -583,7 +598,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.test.skip</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#nameSuffixForTests">nameSuffixForTests</a></b></td>
@@ -594,7 +609,7 @@ when no stubs / contracts were found.<br /><b>Default value is</b>: <tt>true</tt
<td>(no description)<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#packageWithBaseClasses">packageWithBaseClasses</a></b></td>
@@ -613,7 +628,7 @@ test source file that will have the package
last folders to and attach <tt>Base</tt> to its name.<br /><b>User property is</b>: <tt>packageWithBaseClasses</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#ruleClassForTests">ruleClassForTests</a></b></td>
@@ -624,7 +639,7 @@ last folders to and attach <tt>Base</tt> to its name.<br /><b>User property is</
<td>(no description)<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#skip">skip</a></b></td>
@@ -635,7 +650,7 @@ last folders to and attach <tt>Base</tt> to its name.<br /><b>User property is</
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.skip</tt>.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#skipTests">skipTests</a></b></td>
@@ -646,7 +661,7 @@ last folders to and attach <tt>Base</tt> to its name.<br /><b>User property is</
<td>(no description)<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>skipTests</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#staticImports">staticImports</a></b></td>
@@ -657,7 +672,7 @@ last folders to and attach <tt>Base</tt> to its name.<br /><b>User property is</
<td>Static imports that should be added to generated tests.<br /></td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#testFramework">testFramework</a></b></td>
@@ -668,7 +683,7 @@ last folders to and attach <tt>Base</tt> to its name.<br /><b>User property is</
<td>(no description)<br /><b>Default value is</b>: <tt>JUNIT</tt>.<br /></td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#testMode">testMode</a></b></td>
@@ -913,7 +928,25 @@ folder after running tests.</div>
<li><b>Required</b>: <tt>No</tt></li>
</ul><hr />
<p><b><a name="failOnNoStubs">failOnNoStubs</a>:</b></p>
<p><b><a name="failOnInProgress">failOnInProgress</a>:</b></p>
<div>If set to true then if any contracts that are in progress are
found, will break the build. On the producer side you need to be
explicit about the fact that you have contracts in progress and
take into consideration that you might be causing false positive
test execution results on the consumer side.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>failOnInProgress</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="failOnNoContracts">failOnNoContracts</a>:</b></p>
<div>When enabled, this flag will tell stub runner to throw an exception
when no stubs / contracts were found.</div>
@@ -924,7 +957,7 @@ when no stubs / contracts were found.</div>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>failOnNoStubs</tt></li>
<li><b>User Property</b>: <tt>failOnNoContracts</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />