1186 lines
37 KiB
HTML
1186 lines
37 KiB
HTML
<!DOCTYPE html>
|
|
<!--
|
|
| Generated by Apache Maven Doxia Site Renderer 1.9.1 at 2020-05-19
|
|
| 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="20200519" />
|
|
<meta http-equiv="Content-Language" content="en" />
|
|
<title>Spring Cloud Contract Maven Plugin – spring-cloud-contract:generateTests</title>
|
|
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
|
|
<link rel="stylesheet" href="./css/site.css" />
|
|
<link rel="stylesheet" href="./css/print.css" media="print" />
|
|
|
|
|
|
<script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
|
|
|
|
</head>
|
|
<body class="topBarEnabled">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/spring-cloud/spring-cloud-contract">
|
|
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
|
|
src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
|
|
alt="Fork me on GitHub">
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
<div id="topbar" class="navbar navbar-fixed-top ">
|
|
<div class="navbar-inner">
|
|
<div class="container-fluid">
|
|
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</a>
|
|
|
|
<ul class="nav">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li> <a href="index.html" title="Introduction">Introduction</a>
|
|
</li>
|
|
|
|
<li> <a href="usage.html" title="Usage">Usage</a>
|
|
</li>
|
|
|
|
<li> <a href="plugin-info.html" title="Goals">Goals</a>
|
|
</li>
|
|
|
|
<li> <a href="junit.html" title="JUnit Configuration">JUnit Configuration</a>
|
|
</li>
|
|
|
|
<li> <a href="spock.html" title="Spock Configuration">Spock Configuration</a>
|
|
</li>
|
|
|
|
<li> <a href="complex.html" title="Complex Configuration">Complex Configuration</a>
|
|
</li>
|
|
|
|
<li> <a href="configs.html" title="Configuration snippets">Configuration snippets</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Related Projects <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li> <a href="https://github.com/spring-cloud/spring-cloud-contract" title="Spring Cloud Contract">Spring Cloud Contract</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
<li class="dropdown-submenu">
|
|
<a href="project-info.html" title="Project Information">Project Information</a>
|
|
<ul class="dropdown-menu">
|
|
<li> <a href="ci-management.html" title="CI Management">CI Management</a>
|
|
</li>
|
|
<li> <a href="index.html" title="About">About</a>
|
|
</li>
|
|
<li> <a href="issue-management.html" title="Issue Management">Issue Management</a>
|
|
</li>
|
|
<li> <a href="licenses.html" title="Licenses">Licenses</a>
|
|
</li>
|
|
<li> <a href="plugin-management.html" title="Plugin Management">Plugin Management</a>
|
|
</li>
|
|
<li> <a href="plugins.html" title="Plugins">Plugins</a>
|
|
</li>
|
|
<li> <a href="team.html" title="Team">Team</a>
|
|
</li>
|
|
<li> <a href="scm.html" title="Source Code Management">Source Code Management</a>
|
|
</li>
|
|
<li> <a href="summary.html" title="Summary">Summary</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="dropdown-submenu">
|
|
<a href="project-reports.html" title="Project Reports">Project Reports</a>
|
|
<ul class="dropdown-menu">
|
|
<li> <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
|
|
</li>
|
|
<li> <a href="checkstyle.html" title="Checkstyle">Checkstyle</a>
|
|
</li>
|
|
<li> <a href="plugin-info.html" title="Plugin Documentation">Plugin Documentation</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="container-fluid">
|
|
<div id="banner">
|
|
<div class="pull-left">
|
|
<div id="bannerLeft">
|
|
<h2>Spring Cloud Contract Maven Plugin</h2>
|
|
</div>
|
|
</div>
|
|
<div class="pull-right"> <div id="bannerRight">
|
|
<img src="" />
|
|
</div>
|
|
</div>
|
|
<div class="clear"><hr/></div>
|
|
</div>
|
|
|
|
<div id="breadcrumbs">
|
|
<ul class="breadcrumb">
|
|
|
|
<li id="publishDate">Last Published: 2020-05-19
|
|
<span class="divider">|</span>
|
|
</li>
|
|
<li id="projectVersion">Version: 3.0.0-SNAPSHOT
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="row-fluid">
|
|
<div id="leftColumn" class="span2">
|
|
<div class="well sidebar-nav">
|
|
|
|
<ul class="nav nav-list">
|
|
<li class="nav-header">Overview</li>
|
|
|
|
<li>
|
|
|
|
<a href="index.html" title="Introduction">
|
|
<span class="none"></span>
|
|
Introduction</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="usage.html" title="Usage">
|
|
<span class="none"></span>
|
|
Usage</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="plugin-info.html" title="Goals">
|
|
<span class="none"></span>
|
|
Goals</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="junit.html" title="JUnit Configuration">
|
|
<span class="none"></span>
|
|
JUnit Configuration</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="spock.html" title="Spock Configuration">
|
|
<span class="none"></span>
|
|
Spock Configuration</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="complex.html" title="Complex Configuration">
|
|
<span class="none"></span>
|
|
Complex Configuration</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="configs.html" title="Configuration snippets">
|
|
<span class="none"></span>
|
|
Configuration snippets</a>
|
|
</li>
|
|
<li class="nav-header">Related Projects</li>
|
|
|
|
<li>
|
|
|
|
<a href="https://github.com/spring-cloud/spring-cloud-contract" class="externalLink" title="Spring Cloud Contract">
|
|
<span class="none"></span>
|
|
Spring Cloud Contract</a>
|
|
</li>
|
|
<li class="nav-header">Project Documentation</li>
|
|
|
|
<li>
|
|
|
|
<a href="project-info.html" title="Project Information">
|
|
<span class="icon-chevron-right"></span>
|
|
Project Information</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="project-reports.html" title="Project Reports">
|
|
<span class="icon-chevron-right"></span>
|
|
Project Reports</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
<hr />
|
|
|
|
<div id="poweredBy">
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
|
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div id="bodyColumn" class="span10" >
|
|
|
|
|
|
|
|
<section>
|
|
<h2><a name="spring-cloud-contract:generateTests"></a>spring-cloud-contract:generateTests</h2>
|
|
|
|
<p><b>Full name</b>:</p>
|
|
|
|
<p>org.springframework.cloud:spring-cloud-contract-maven-plugin:3.0.0-SNAPSHOT:generateTests</p>
|
|
|
|
<p><b>Description</b>:</p>
|
|
|
|
<div>From the provided directory with contracts generates the acceptance
|
|
tests on the producer side.</div>
|
|
|
|
<p><b>Attributes</b>:</p>
|
|
|
|
<ul>
|
|
|
|
<li>Requires a Maven project to be executed.</li>
|
|
|
|
<li>Requires dependency resolution of artifacts in scope: test.</li>
|
|
|
|
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: generate-test-sources.</li>
|
|
</ul>
|
|
<section>
|
|
<h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
|
|
|
|
<table class="table table-striped" border="0">
|
|
|
|
<tr class="a">
|
|
|
|
<th>Name</th>
|
|
|
|
<th>Type</th>
|
|
|
|
<th>Since</th>
|
|
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#assertJsonSize"><assertJsonSize></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Incubating feature. You can check the size of JSON arrays. If not
|
|
turned on explicitly will be disabled.<br /><b>Default value is</b>: false.<br /><b>User property is</b>: spring.cloud.contract.verifier.assert.size.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#baseClassForTests"><baseClassForTests></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#baseClassMappings"><baseClassMappings></a></td>
|
|
|
|
<td>List</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>A way to override any base class mappings. The keys are regular
|
|
expressions on the package name of the contract and the values FQN
|
|
to a base class for that given expression. Example of a mapping
|
|
.*.com.example.v1..* ->
|
|
com.example.SomeBaseClass When a contract's package
|
|
matches the provided regular expression then extending class will
|
|
be the one provided in the map - in this case
|
|
com.example.SomeBaseClass.<br /><b>User property is</b>: baseClassMappings.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#basePackageForTests"><basePackageForTests></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#contractDependency"><contractDependency></a></td>
|
|
|
|
<td>Dependency</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>User property is</b>: contractDependency.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#contractsDirectory"><contractsDirectory></a></td>
|
|
|
|
<td>File</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: ${project.basedir}/src/test/resources/contracts.<br /><b>User property is</b>: spring.cloud.contract.verifier.contractsDirectory.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#contractsMode"><contractsMode></a></td>
|
|
|
|
<td>StubRunnerProperties$StubsMode</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Picks the mode in which stubs will be found and registered.<br /><b>Default value is</b>: CLASSPATH.<br /><b>User property is</b>: contractsMode.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#contractsPath"><contractsPath></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>The path in the JAR with all the contracts where contracts for this
|
|
particular service lay. If not provided will be resolved to
|
|
groupid/artifactid. Example: If groupid
|
|
is com.example and artifactid is
|
|
service then the resolved path will be
|
|
/com/example/artifactid<br /><b>User property is</b>: contractsPath.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#contractsProperties"><contractsProperties></a></td>
|
|
|
|
<td>Map</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Map of properties that can be passed to custom
|
|
StubDownloaderBuilder.<br /><b>User property is</b>: contractsProperties.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#contractsRepositoryPassword"><contractsRepositoryPassword></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>The password to be used to connect to the repo with contracts.<br /><b>User property is</b>: contractsRepositoryPassword.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#contractsRepositoryProxyHost"><contractsRepositoryProxyHost></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>The proxy host to be used to connect to the repo with contracts.<br /><b>User property is</b>: contractsRepositoryProxyHost.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#contractsRepositoryProxyPort"><contractsRepositoryProxyPort></a></td>
|
|
|
|
<td>Integer</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>The proxy port to be used to connect to the repo with contracts.<br /><b>User property is</b>: contractsRepositoryProxyPort.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#contractsRepositoryUrl"><contractsRepositoryUrl></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>The URL from which a contracts should get downloaded. If not
|
|
provided but artifactid / coordinates notation was provided then
|
|
the current Maven's build repositories will be taken into
|
|
consideration.<br /><b>User property is</b>: contractsRepositoryUrl.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#contractsRepositoryUsername"><contractsRepositoryUsername></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>The user name to be used to connect to the repo with contracts.<br /><b>User property is</b>: contractsRepositoryUsername.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#contractsSnapshotCheckSkip"><contractsSnapshotCheckSkip></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td><b>Deprecated.</b> - with 2.1.0 this option is redundant<br /><b>Default value is</b>: false.<br /><b>User property is</b>: contractsSnapshotCheckSkip.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#deleteStubsAfterTest"><deleteStubsAfterTest></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>If set to false will NOT delete stubs from a temporary
|
|
folder after running tests.<br /><b>Default value is</b>: true.<br /><b>User property is</b>: deleteStubsAfterTest.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#excludedFiles"><excludedFiles></a></td>
|
|
|
|
<td>List</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Patterns that should not be taken into account for processing.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#failOnInProgress"><failOnInProgress></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</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>: true.<br /><b>User property is</b>: failOnInProgress.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#failOnNoContracts"><failOnNoContracts></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</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>: true.<br /><b>User property is</b>: failOnNoContracts.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#generatedTestResourcesDir"><generatedTestResourcesDir></a></td>
|
|
|
|
<td>File</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: ${project.build.directory}/generated-test-resources/contracts.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#generatedTestSourcesDir"><generatedTestSourcesDir></a></td>
|
|
|
|
<td>File</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: ${project.build.directory}/generated-test-sources/contracts.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#ignoredFiles"><ignoredFiles></a></td>
|
|
|
|
<td>List</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Patterns for which Spring Cloud Contract Verifier should generate
|
|
@Ignored tests.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#imports"><imports></a></td>
|
|
|
|
<td>String[]</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Imports that should be added to generated tests.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#includedFiles"><includedFiles></a></td>
|
|
|
|
<td>List</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Patterns that should be taken into account for processing.<br /><b>User property is</b>: includedFiles.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#incrementalContractTests"><incrementalContractTests></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>If set to true then tests are created only when contracts have
|
|
changed since last build.<br /><b>Default value is</b>: true.<br /><b>User property is</b>: incrementalContractTests.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#mavenTestSkip"><mavenTestSkip></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: false.<br /><b>User property is</b>: maven.test.skip.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#nameSuffixForTests"><nameSuffixForTests></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#packageWithBaseClasses"><packageWithBaseClasses></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>A package that contains all the base clases for generated tests. If
|
|
your contract resides in a location
|
|
src/test/resources/contracts/com/example/v1/ and you
|
|
provide the packageWithBaseClasses value to
|
|
com.example.contracts.base then we will search for a
|
|
test source file that will have the package
|
|
com.example.contracts.base and name
|
|
ExampleV1Base. As you can see it will take the two
|
|
last folders to and attach Base to its name.<br /><b>User property is</b>: packageWithBaseClasses.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#ruleClassForTests"><ruleClassForTests></a></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#skip"><skip></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: false.<br /><b>User property is</b>: spring.cloud.contract.verifier.skip.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#skipTests"><skipTests></a></td>
|
|
|
|
<td>boolean</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: false.<br /><b>User property is</b>: skipTests.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#staticImports"><staticImports></a></td>
|
|
|
|
<td>String[]</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>Static imports that should be added to generated tests.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><a href="#testFramework"><testFramework></a></td>
|
|
|
|
<td>TestFramework</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: JUNIT5.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><a href="#testMode"><testMode></a></td>
|
|
|
|
<td>TestMode</td>
|
|
|
|
<td>-</td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: MOCKMVC.<br /></td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section>
|
|
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
|
|
<section>
|
|
<h4><a name="a.3CassertJsonSize.3E"></a><b><a name="assertJsonSize"><assertJsonSize></a></b></h4>
|
|
|
|
<div>Incubating feature. You can check the size of JSON arrays. If not
|
|
turned on explicitly will be disabled.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: spring.cloud.contract.verifier.assert.size</li>
|
|
|
|
<li><b>Default</b>: false</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CbaseClassForTests.3E"></a><b><a name="baseClassForTests"><baseClassForTests></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CbaseClassMappings.3E"></a><b><a name="baseClassMappings"><baseClassMappings></a></b></h4>
|
|
|
|
<div>A way to override any base class mappings. The keys are regular
|
|
expressions on the package name of the contract and the values FQN
|
|
to a base class for that given expression. Example of a mapping
|
|
.*.com.example.v1..* ->
|
|
com.example.SomeBaseClass When a contract's package
|
|
matches the provided regular expression then extending class will
|
|
be the one provided in the map - in this case
|
|
com.example.SomeBaseClass.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.util.List</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: baseClassMappings</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CbasePackageForTests.3E"></a><b><a name="basePackageForTests"><basePackageForTests></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractDependency.3E"></a><b><a name="contractDependency"><contractDependency></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: org.apache.maven.model.Dependency</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractDependency</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsDirectory.3E"></a><b><a name="contractsDirectory"><contractsDirectory></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.io.File</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: spring.cloud.contract.verifier.contractsDirectory</li>
|
|
|
|
<li><b>Default</b>: ${project.basedir}/src/test/resources/contracts</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsMode.3E"></a><b><a name="contractsMode"><contractsMode></a></b></h4>
|
|
|
|
<div>Picks the mode in which stubs will be found and registered.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: org.springframework.cloud.contract.stubrunner.spring.StubRunnerProperties$StubsMode</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsMode</li>
|
|
|
|
<li><b>Default</b>: CLASSPATH</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsPath.3E"></a><b><a name="contractsPath"><contractsPath></a></b></h4>
|
|
|
|
<div>The path in the JAR with all the contracts where contracts for this
|
|
particular service lay. If not provided will be resolved to
|
|
groupid/artifactid. Example: If groupid
|
|
is com.example and artifactid is
|
|
service then the resolved path will be
|
|
/com/example/artifactid</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsPath</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsProperties.3E"></a><b><a name="contractsProperties"><contractsProperties></a></b></h4>
|
|
|
|
<div>Map of properties that can be passed to custom
|
|
StubDownloaderBuilder.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.util.Map</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsProperties</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsRepositoryPassword.3E"></a><b><a name="contractsRepositoryPassword"><contractsRepositoryPassword></a></b></h4>
|
|
|
|
<div>The password to be used to connect to the repo with contracts.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsRepositoryPassword</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsRepositoryProxyHost.3E"></a><b><a name="contractsRepositoryProxyHost"><contractsRepositoryProxyHost></a></b></h4>
|
|
|
|
<div>The proxy host to be used to connect to the repo with contracts.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsRepositoryProxyHost</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsRepositoryProxyPort.3E"></a><b><a name="contractsRepositoryProxyPort"><contractsRepositoryProxyPort></a></b></h4>
|
|
|
|
<div>The proxy port to be used to connect to the repo with contracts.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.Integer</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsRepositoryProxyPort</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsRepositoryUrl.3E"></a><b><a name="contractsRepositoryUrl"><contractsRepositoryUrl></a></b></h4>
|
|
|
|
<div>The URL from which a contracts should get downloaded. If not
|
|
provided but artifactid / coordinates notation was provided then
|
|
the current Maven's build repositories will be taken into
|
|
consideration.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsRepositoryUrl</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsRepositoryUsername.3E"></a><b><a name="contractsRepositoryUsername"><contractsRepositoryUsername></a></b></h4>
|
|
|
|
<div>The user name to be used to connect to the repo with contracts.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsRepositoryUsername</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CcontractsSnapshotCheckSkip.3E"></a><b><a name="contractsSnapshotCheckSkip"><contractsSnapshotCheckSkip></a></b></h4>
|
|
|
|
<div><b>Deprecated.</b> - with 2.1.0 this option is redundant</div>
|
|
|
|
<div>If true then will not assert whether a stub / contract
|
|
JAR was downloaded from local or remote location.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: contractsSnapshotCheckSkip</li>
|
|
|
|
<li><b>Default</b>: false</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CdeleteStubsAfterTest.3E"></a><b><a name="deleteStubsAfterTest"><deleteStubsAfterTest></a></b></h4>
|
|
|
|
<div>If set to false will NOT delete stubs from a temporary
|
|
folder after running tests.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: deleteStubsAfterTest</li>
|
|
|
|
<li><b>Default</b>: true</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CexcludedFiles.3E"></a><b><a name="excludedFiles"><excludedFiles></a></b></h4>
|
|
|
|
<div>Patterns that should not be taken into account for processing.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.util.List</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CfailOnInProgress.3E"></a><b><a name="failOnInProgress"><failOnInProgress></a></b></h4>
|
|
|
|
<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>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: failOnInProgress</li>
|
|
|
|
<li><b>Default</b>: true</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CfailOnNoContracts.3E"></a><b><a name="failOnNoContracts"><failOnNoContracts></a></b></h4>
|
|
|
|
<div>When enabled, this flag will tell stub runner to throw an exception
|
|
when no stubs / contracts were found.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: failOnNoContracts</li>
|
|
|
|
<li><b>Default</b>: true</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CgeneratedTestResourcesDir.3E"></a><b><a name="generatedTestResourcesDir"><generatedTestResourcesDir></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.io.File</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>Default</b>: ${project.build.directory}/generated-test-resources/contracts</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CgeneratedTestSourcesDir.3E"></a><b><a name="generatedTestSourcesDir"><generatedTestSourcesDir></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.io.File</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>Default</b>: ${project.build.directory}/generated-test-sources/contracts</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CignoredFiles.3E"></a><b><a name="ignoredFiles"><ignoredFiles></a></b></h4>
|
|
|
|
<div>Patterns for which Spring Cloud Contract Verifier should generate
|
|
@Ignored tests.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.util.List</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3Cimports.3E"></a><b><a name="imports"><imports></a></b></h4>
|
|
|
|
<div>Imports that should be added to generated tests.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String[]</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CincludedFiles.3E"></a><b><a name="includedFiles"><includedFiles></a></b></h4>
|
|
|
|
<div>Patterns that should be taken into account for processing.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.util.List</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: includedFiles</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CincrementalContractTests.3E"></a><b><a name="incrementalContractTests"><incrementalContractTests></a></b></h4>
|
|
|
|
<div>If set to true then tests are created only when contracts have
|
|
changed since last build.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: incrementalContractTests</li>
|
|
|
|
<li><b>Default</b>: true</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CmavenTestSkip.3E"></a><b><a name="mavenTestSkip"><mavenTestSkip></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: maven.test.skip</li>
|
|
|
|
<li><b>Default</b>: false</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CnameSuffixForTests.3E"></a><b><a name="nameSuffixForTests"><nameSuffixForTests></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CpackageWithBaseClasses.3E"></a><b><a name="packageWithBaseClasses"><packageWithBaseClasses></a></b></h4>
|
|
|
|
<div>A package that contains all the base clases for generated tests. If
|
|
your contract resides in a location
|
|
src/test/resources/contracts/com/example/v1/ and you
|
|
provide the packageWithBaseClasses value to
|
|
com.example.contracts.base then we will search for a
|
|
test source file that will have the package
|
|
com.example.contracts.base and name
|
|
ExampleV1Base. As you can see it will take the two
|
|
last folders to and attach Base to its name.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: packageWithBaseClasses</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CruleClassForTests.3E"></a><b><a name="ruleClassForTests"><ruleClassForTests></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: spring.cloud.contract.verifier.skip</li>
|
|
|
|
<li><b>Default</b>: false</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CskipTests.3E"></a><b><a name="skipTests"><skipTests></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: boolean</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>User Property</b>: skipTests</li>
|
|
|
|
<li><b>Default</b>: false</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CstaticImports.3E"></a><b><a name="staticImports"><staticImports></a></b></h4>
|
|
|
|
<div>Static imports that should be added to generated tests.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: java.lang.String[]</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CtestFramework.3E"></a><b><a name="testFramework"><testFramework></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: org.springframework.cloud.contract.verifier.config.TestFramework</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>Default</b>: JUNIT5</li>
|
|
</ul><hr /></section><section>
|
|
<h4><a name="a.3CtestMode.3E"></a><b><a name="testMode"><testMode></a></b></h4>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: org.springframework.cloud.contract.verifier.config.TestMode</li>
|
|
|
|
<li><b>Required</b>: No</li>
|
|
|
|
<li><b>Default</b>: MOCKMVC</li>
|
|
</ul>
|
|
</section></section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<footer>
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
<p >Copyright © 2016–2020
|
|
<a href="https://spring.io/">Spring</a>.
|
|
All rights reserved.
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|