572 lines
18 KiB
HTML
572 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<!--
|
|
| Generated by Apache Maven Doxia Site Renderer 1.6 at 2018-10-05
|
|
| 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="20181005" />
|
|
<meta http-equiv="Content-Language" content="en" />
|
|
<title>Spring Cloud Contract Maven Plugin – spring-cloud-contract:run</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="integration.html" title="CI Management">CI Management</a>
|
|
</li>
|
|
<li> <a href="index.html" title="About">About</a>
|
|
</li>
|
|
<li> <a href="issue-tracking.html" title="Issue Management">Issue Management</a>
|
|
</li>
|
|
<li> <a href="license.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-list.html" title="Team">Team</a>
|
|
</li>
|
|
<li> <a href="source-repository.html" title="Source Code Management">Source Code Management</a>
|
|
</li>
|
|
<li> <a href="project-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="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: 2018-10-05
|
|
<span class="divider">|</span>
|
|
</li>
|
|
<li id="projectVersion">Version: 2.1.0.BUILD-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" 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" >
|
|
|
|
|
|
|
|
<div class="section">
|
|
<h2><a name="spring-cloud-contract:run"></a>spring-cloud-contract:run</h2>
|
|
|
|
<p><b>Full name</b>:</p>
|
|
|
|
<p>org.springframework.cloud:spring-cloud-contract-maven-plugin:2.1.0.BUILD-SNAPSHOT:run</p>
|
|
|
|
<p><b>Description</b>:</p>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<p><b>Attributes</b>:</p>
|
|
|
|
<ul>
|
|
|
|
<li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
|
|
</ul>
|
|
|
|
<div class="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><b><a href="#destination">destination</a></b></td>
|
|
|
|
<td><tt>File</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: <tt>${basedir}</tt>.<br /><b>User property is</b>: <tt>stubsDirectory</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><b><a href="#httpPort">httpPort</a></b></td>
|
|
|
|
<td><tt>int</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>HTTP port for the WireMock server that serves stubs<br /><b>Default value is</b>: <tt>8080</tt>.<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.http.port</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><b><a href="#maxPort">maxPort</a></b></td>
|
|
|
|
<td><tt>int</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>Maximal port at which the stub should start<br /><b>Default value is</b>: <tt>15000</tt>.<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.http.maxPort</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><b><a href="#minPort">minPort</a></b></td>
|
|
|
|
<td><tt>int</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>Minimal port at which the stub should start<br /><b>Default value is</b>: <tt>10000</tt>.<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.http.minPort</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><b><a href="#skip">skip</a></b></td>
|
|
|
|
<td><tt>boolean</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>Set this to "true" to bypass verifier execution.<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="a">
|
|
|
|
<td><b><a href="#skipTestOnly">skipTestOnly</a></b></td>
|
|
|
|
<td><tt>boolean</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>Set this to "true" to bypass verifier test generation.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.skipTestOnly</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><b><a href="#stubs">stubs</a></b></td>
|
|
|
|
<td><tt>String</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>List of stubs to be downloaded and ran in a colon separated Ivy
|
|
notation<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.stubs</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><b><a href="#stubsClassifier">stubsClassifier</a></b></td>
|
|
|
|
<td><tt>String</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>Classifier used by stubs artifacts.<br /><b>Default value is</b>: <tt>stubs</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td><b><a href="#stubsDirectory">stubsDirectory</a></b></td>
|
|
|
|
<td><tt>File</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>(no description)<br /><b>Default value is</b>: <tt>${project.build.directory}/stubs/</tt>.<br /></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td><b><a href="#waitForKeyPressed">waitForKeyPressed</a></b></td>
|
|
|
|
<td><tt>boolean</tt></td>
|
|
|
|
<td><tt>-</tt></td>
|
|
|
|
<td>Should the plugin wait for the user to press the key after starting
|
|
the stubs<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>spring.cloud.contract.verifier.wait-for-key-pressed</tt>.<br /></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="section">
|
|
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
|
|
|
|
<p><b><a name="destination">destination</a>:</b></p>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>java.io.File</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>stubsDirectory</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>${basedir}</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="httpPort">httpPort</a>:</b></p>
|
|
|
|
<div>HTTP port for the WireMock server that serves stubs</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>int</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.http.port</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>8080</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="maxPort">maxPort</a>:</b></p>
|
|
|
|
<div>Maximal port at which the stub should start</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>int</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.http.maxPort</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>15000</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="minPort">minPort</a>:</b></p>
|
|
|
|
<div>Minimal port at which the stub should start</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>int</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.http.minPort</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>10000</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="skip">skip</a>:</b></p>
|
|
|
|
<div>Set this to "true" to bypass verifier execution.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>boolean</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.skip</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>false</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="skipTestOnly">skipTestOnly</a>:</b></p>
|
|
|
|
<div>Set this to "true" to bypass verifier test generation.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>boolean</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.skipTestOnly</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>false</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="stubs">stubs</a>:</b></p>
|
|
|
|
<div>List of stubs to be downloaded and ran in a colon separated Ivy
|
|
notation</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>java.lang.String</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.stubs</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="stubsClassifier">stubsClassifier</a>:</b></p>
|
|
|
|
<div>Classifier used by stubs artifacts.</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>java.lang.String</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>stubs</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="stubsDirectory">stubsDirectory</a>:</b></p>
|
|
|
|
<div>(no description)</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>java.io.File</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>${project.build.directory}/stubs/</tt></li>
|
|
</ul><hr />
|
|
<p><b><a name="waitForKeyPressed">waitForKeyPressed</a>:</b></p>
|
|
|
|
<div>Should the plugin wait for the user to press the key after starting
|
|
the stubs</div>
|
|
|
|
<ul>
|
|
|
|
<li><b>Type</b>: <tt>boolean</tt></li>
|
|
|
|
<li><b>Required</b>: <tt>No</tt></li>
|
|
|
|
<li><b>User Property</b>: <tt>spring.cloud.contract.verifier.wait-for-key-pressed</tt></li>
|
|
|
|
<li><b>Default</b>: <tt>true</tt></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<footer>
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
<p >Copyright © 2016–2018
|
|
<a href="https://spring.io/">Spring</a>.
|
|
All rights reserved.
|
|
</p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|