SpringCloud/spring-cloud-contract
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2018-07-19 14:17:46 +00:00
parent 9d4335fcbe
commit 0525798e90
34 changed files with 151 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
spring-cloud-contract.xml
View File

@@ -4,13 +4,13 @@
<book xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en">
<info>
<title>Spring Cloud Contract</title>
<date>2018-07-18</date>
<date>2018-07-19</date>
</info>
<preface>
<title></title>
<simpara><emphasis>Documentation Authors: Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak,
Olga Maciaszek-Sharma, Mariusz Smykuła, Dave Syer, Jay Bryant</emphasis></simpara>
<simpara>2.0.1.BUILD-SNAPSHOT</simpara>
<simpara>2.1.0.BUILD-SNAPSHOT</simpara>
</preface>
<chapter xml:id="_spring_cloud_contract">
<title>Spring Cloud Contract</title>
@@ -42,7 +42,7 @@ Integration, Spring Cloud Stream, Spring AMQP, and Apache Camel. You can also se
own integrations.</simpara>
</listitem>
<listitem>
<simpara>Acceptance tests (in JUnit or Spock) are used to verify if server-side implementation
<simpara>Acceptance tests (in JUnit 4, JUnit 5 or Spock) are used to verify if server-side implementation
of the API is compliant with the contract (<emphasis>server tests</emphasis>). A full test is generated by
Spring Cloud Contract Verifier.</simpara>
</listitem>
@@ -411,8 +411,8 @@ public void validate_shouldMarkClientAsFraud() throws Exception {
mode for HTTP contracts. However, JAX-RX client and explicit HTTP invocations can also be
used. (To do so, change the <literal>testMode</literal> property of the plugin to <literal>JAX-RS</literal> or <literal>EXPLICIT</literal>,
respectively.)</simpara>
<simpara>Apart from the default JUnit, you can instead use Spock tests, by setting the plugin
<literal>testFramework</literal> property to <literal>Spock</literal>.</simpara>
<simpara>Apart from the default JUnit 4, you can instead use JUnit 5 or Spock tests, by setting the plugin
<literal>testFramework</literal> property to either <literal>JUNIT5</literal> or <literal>Spock</literal>.</simpara>
<tip>
<simpara>You can now also generate WireMock scenarios based on the contracts, by including an
order number followed by an underscore at the beginning of the contract file names.</simpara>
@@ -1561,7 +1561,7 @@ one to one to the contents of the repo.</simpara>
&lt;properties&gt;
&lt;project.build.sourceEncoding&gt;UTF-8&lt;/project.build.sourceEncoding&gt;
&lt;java.version&gt;1.8&lt;/java.version&gt;
&lt;spring-cloud-contract.version&gt;2.0.1.BUILD-SNAPSHOT&lt;/spring-cloud-contract.version&gt;
&lt;spring-cloud-contract.version&gt;2.1.0.BUILD-SNAPSHOT&lt;/spring-cloud-contract.version&gt;
&lt;spring-cloud-dependencies.version&gt;Finchley.BUILD-SNAPSHOT&lt;/spring-cloud-dependencies.version&gt;
&lt;excludeBuildFolders&gt;true&lt;/excludeBuildFolders&gt;
&lt;/properties&gt;
@@ -2640,8 +2640,8 @@ from the Groovy DSL should be placed. By default its value is
the Groovy DSL should be placed.</simpara>
</listitem>
<listitem>
<simpara><emphasis role="strong">targetFramework</emphasis>: Specifies the target test framework to be used. Currently, Spock and
JUnit are supported with JUnit being the default framework.</simpara>
<simpara><emphasis role="strong">targetFramework</emphasis>: Specifies the target test framework to be used. Currently, Spock, JUnit 4 (<literal>TestFramework.JUNIT</literal> and
JUnit 5 are supported with JUnit 4 being the default framework.</simpara>
</listitem>
<listitem>
<simpara><emphasis role="strong">contractsProperties</emphasis>: a map containing properties to be passed to Spring Cloud Contract
@@ -3036,8 +3036,8 @@ use Spock classes, the class is <literal>spock.lang.Specification</literal>.</si
GroovyDSL. The default directory is <literal>/src/test/resources/contracts</literal>.</simpara>
</listitem>
<listitem>
<simpara><emphasis role="strong">testFramework</emphasis>: Specifies the target test framework to be used. Currently, Spock and
JUnit are supported with JUnit being the default framework</simpara>
<simpara><emphasis role="strong">testFramework</emphasis>: Specifies the target test framework to be used. Currently, Spock, JUnit 4 (<literal>TestFramework.JUNIT</literal> and
6JUnit 5 are supported with JUnit 4 being the default framework.</simpara>
</listitem>
<listitem>
<simpara><emphasis role="strong">packageWithBaseClasses</emphasis>: Defines a package where all the base classes reside. This
@@ -3416,7 +3416,7 @@ and failed the build.</simpara>
</itemizedlist>
<simpara>if either of these values is set to <literal>true</literal>, then the stub downloader will not
verify the origin of the downloaded JAR.</simpara>
<simpara>For the plugins you need to set the <literal>contractsSnapshotSkipCheck</literal> property
<simpara>For the plugins you need to set the <literal>contractsSnapshotCheckSkip</literal> property
to <literal>true</literal>.</simpara>
</section>
<section xml:id="_scenarios">
@@ -3764,8 +3764,8 @@ messaging configuration, so you only need the one annotation.</simpara>
<section xml:id="_publisher_side_test_generation">
<title>Publisher-Side Test Generation</title>
<simpara>Having the <literal>input</literal> or <literal>outputMessage</literal> sections in your DSL results in creation of tests
on the publisher&#8217;s side. By default, JUnit tests are created. However, there is also a
possibility to create Spock tests.</simpara>
on the publisher&#8217;s side. By default, JUnit 4 tests are created. However, there is also a
possibility to create JUnit 5 or Spock tests.</simpara>
<simpara>There are 3 main scenarios that we should take into consideration:</simpara>
<itemizedlist>
<listitem>