From c669cb06eba3034e2a8414d6c334839c7e014539 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Sat, 2 Sep 2017 00:28:01 +0000 Subject: [PATCH] Sync docs from 1.1.x to gh-pages --- .../multi__stub_runner_for_messaging.html | 15 +++++++---- 1.1.x/multi/multi_spring-cloud-contract.html | 2 +- 1.1.x/single/spring-cloud-contract.html | 17 ++++++++----- .../checkstyle.html | 6 ++--- .../complex.html | 6 ++--- .../configs.html | 6 ++--- .../convert-mojo.html | 6 ++--- .../generateStubs-mojo.html | 6 ++--- .../generateTests-mojo.html | 6 ++--- .../help-mojo.html | 6 ++--- .../index.html | 6 ++--- .../integration.html | 6 ++--- .../issue-tracking.html | 6 ++--- .../junit.html | 6 ++--- .../license.html | 6 ++--- .../plugin-info.html | 6 ++--- .../plugin-management.html | 6 ++--- .../plugins.html | 6 ++--- .../project-info.html | 6 ++--- .../project-reports.html | 6 ++--- .../project-summary.html | 6 ++--- .../run-mojo.html | 6 ++--- .../sitemap.html | 6 ++--- .../source-repository.html | 6 ++--- .../spock.html | 6 ++--- .../team-list.html | 6 ++--- .../usage.html | 6 ++--- 1.1.x/spring-cloud-contract.xml | 25 ++++++++++++++++++- 28 files changed, 118 insertions(+), 85 deletions(-) diff --git a/1.1.x/multi/multi__stub_runner_for_messaging.html b/1.1.x/multi/multi__stub_runner_for_messaging.html index b1dcccaeb4..e41cb611d0 100644 --- a/1.1.x/multi/multi__stub_runner_for_messaging.html +++ b/1.1.x/multi/multi__stub_runner_for_messaging.html @@ -1,6 +1,9 @@ - 6. Stub Runner for Messaging
6. Stub Runner for Messaging
Prev   Next

6. Stub Runner for Messaging

Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box

  • Spring Integration
  • Spring Cloud Stream
  • Apache Camel
  • Spring AMQP

It also provides points of entry to integrate with any other solution on the market.

6.1 Stub triggering

To trigger a message it’s enough to use the StubTrigger interface:

package org.springframework.cloud.contract.stubrunner;
+   6. Stub Runner for Messaging
6. Stub Runner for Messaging
Prev   Next
6. Stub Runner for Messaging
Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box
  • Spring Integration
  • Spring Cloud Stream
  • Apache Camel
  • Spring AMQP
It also provides points of entry to integrate with any other solution on the market.
[Important]Important
If you have multiple frameworks on the classpath Stub Runner will need to
+define which one should be used. Let’s assume that you have both AMQP, Spring Cloud Stream and Spring Integration
+on the classpath. Then you need to set stubrunner.stream.enabled=false and stubrunner.integration.enabled=false.
+That way the only remaining framework is Spring AMQP.
6.1 Stub triggering
To trigger a message it’s enough to use the StubTrigger interface:
package org.springframework.cloud.contract.stubrunner;
 
 import java.util.Collection;
 import java.util.Map;
@@ -43,7 +46,7 @@
 }
For convenience the StubFinder interface extends StubTrigger so it’s enough to use only one in your tests.
StubTrigger gives you the following options to trigger a message:
6.1.1 Trigger by label
stubFinder.trigger('return_book_1')
6.1.2 Trigger by group and artifact ids
stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:camelService', 'return_book_1')
6.1.3 Trigger by artifact ids
stubFinder.trigger('camelService', 'return_book_1')
6.1.4 Trigger all messages
stubFinder.trigger()
6.2 Stub Runner Camel
Spring Cloud Contract Verifier Stub Runner’s messaging module gives you an easy way to integrate with Apache Camel.
 For the provided artifacts it will automatically download the stubs and register the required
 routes.
6.2.1 Adding it to the project
It’s enough to have both Apache Camel and Spring Cloud Contract Stub Runner on classpath.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.2.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
6.2.2 Disabling the functionality
If you need to disable this functionality just pass stubrunner.camel.enabled=false property.
6.2.3 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 camelService application.
└── .m2
     └── repository
         └── io
@@ -101,7 +104,7 @@ assertThatBodyContainsBookNameFoo(receivedMessage.in.body)
 receivedMessage.in.headers.get('BOOK-NAME') == 'foo'
Scenario 3 (input with no output)
Since the route is set for you it’s enough to just send a message to the jms:output destination.
camelContext.createProducerTemplate().sendBodyAndHeaders('jms:delete', new BookReturned('foo'), [sample: 'header'])
6.3 Stub Runner Integration
Spring Cloud Contract Verifier Stub Runner’s messaging module gives you an easy way to integrate with Spring Integration.
 For the provided artifacts it will automatically download the stubs and register the required
 routes.
6.3.1 Adding it to the project
It’s enough to have both Spring Integration and Spring Cloud Contract Stub Runner on classpath.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.3.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
6.3.2 Disabling the functionality
If you need to disable this functionality just pass stubrunner.integration.enabled=false property.
6.3.3 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 integrationService application.
└── .m2
     └── repository
         └── io
@@ -188,7 +191,7 @@ channel name.
Gradle. 
 
testCompile "org.springframework.cloud:spring-cloud-stream-test-support"

 
6.4.1 Adding it to the project
It’s enough to have both Spring Cloud Stream and Spring Cloud Contract Stub Runner on classpath.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.4.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
6.4.2 Disabling the functionality
If you need to disable this functionality just pass stubrunner.stream.enabled=false property.
6.4.3 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 streamService application.
└── .m2
     └── repository
         └── io
@@ -259,7 +262,9 @@ Message listeners on the other side are bound to queues. Bindings connect an exc
 If message contracts are triggered the Spring AMQP stub runner integration will look for bindings on the application context that match this exchange.
 Then it collects the queues from the Spring exchanges and tries to find messages listeners bound to these queues.
 The message is triggered to all matching message listeners.
6.5.1 Adding it to the project
It’s enough to have both Spring AMQP and Spring Cloud Contract Stub Runner on the classpath and set the property stubrunner.amqp.enabled=true.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.5.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
[Important]Important
If you already have Stream and Integration on the classpath you need
+to disable them explicitly via stubrunner.stream.enabled=false and stubrunner.integration.enabled=false
+properties
6.5.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 spring-cloud-contract-amqp-test application.
└── .m2
     └── repository
         └── com
diff --git a/1.1.x/multi/multi_spring-cloud-contract.html b/1.1.x/multi/multi_spring-cloud-contract.html
index 2613e09b83..a5c2d64f29 100644
--- a/1.1.x/multi/multi_spring-cloud-contract.html
+++ b/1.1.x/multi/multi_spring-cloud-contract.html
@@ -1,3 +1,3 @@
 
       
-   Spring Cloud Contract
Spring Cloud Contract
   Next
Spring Cloud Contract
Table of Contents
1. Spring Cloud Contract
2. Spring Cloud Contract Verifier Introduction
2.1. Why?
2.1.1. Testing issues
2.2. Purposes
2.3. How
2.3.1. Define the contract
2.3.2. Client Side
2.3.3. Server Side
2.4. Step by step guide to CDC
2.4.1. Technical note
2.4.2. Consumer side (Loan Issuance)
2.4.3. Producer side (Fraud Detection server)
2.4.4. Consumer side (Loan Issuance) final step
2.5. Dependencies
2.6. Additional links
2.6.1. Spring Cloud Contract video
2.6.2. Readings
2.7. Samples
3. Spring Cloud Contract Verifier Setup
3.1. Gradle Project
3.1.1. Prerequisites
3.1.2. Add gradle plugin with dependencies
3.1.3. Gradle and Rest Assured 3.0
3.1.4. Snapshot versions for Gradle
3.1.5. Add stubs
3.1.6. Run plugin
3.1.7. Default setup
3.1.8. Configure plugin
3.1.9. Configuration options
3.1.10. Single base class for all tests
3.1.11. Different base classes for contracts
3.1.12. Invoking generated tests
3.1.13. Spring Cloud Contract Verifier on consumer side
3.2. Using in your Maven project
3.2.1. Add maven plugin
3.2.2. Maven and Rest Assured 3.0
3.2.3. Snapshot versions for Maven
3.2.4. Add stubs
3.2.5. Run plugin
3.2.6. Configure plugin
3.2.7. Important configuration options
3.2.8. Single base class for all tests
3.2.9. Different base classes for contracts
3.2.10. Invoking generated tests
3.2.11. FAQ with Maven Plugin
3.2.12. Maven Plugin and STS
3.2.13. Spring Cloud Contract Verifier on consumer side
3.3. Scenarios
3.4. Stubs and transitive dependencies
4. Spring Cloud Contract Verifier Messaging
4.1. Integrations
4.2. Manual Integration Testing
4.3. Publisher side test generation
4.3.1. Scenario 1 (no input message)
4.3.2. Scenario 2 (output triggered by input)
4.3.3. Scenario 3 (no output message)
4.4. Consumer Stub Side generation
5. Spring Cloud Contract Stub Runner
5.1. Snapshot versions
5.2. Publishing stubs as JARs
5.3. Stub Runner Core
5.3.1. Retrieving stubs
Stub downloading
Classpath scanning
5.3.2. Running stubs
Limitations
Running using main app
HTTP Stubs
Viewing registered mappings
Messaging Stubs
5.4. Stub Runner JUnit Rule
5.4.1. Maven settings
5.4.2. Providing fixed ports
5.4.3. Fluent API
5.4.4. Stub Runner with Spring
5.5. Stub Runner Spring Cloud
5.5.1. Stubbing Service Discovery
Test profiles and service discovery
5.5.2. Additional Configuration
5.6. Stub Runner Boot Application
5.6.1. How to use it?
Stub Runner Server
Spring Cloud CLI
5.6.2. Endpoints
HTTP
Messaging
5.6.3. Example
5.6.4. Stub Runner Boot with Service Discovery
5.7. Stubs Per Consumer
5.8. Common
5.8.1. Common properties for JUnit and Spring
5.8.2. Stub runner stubs ids
6. Stub Runner for Messaging
6.1. Stub triggering
6.1.1. Trigger by label
6.1.2. Trigger by group and artifact ids
6.1.3. Trigger by artifact ids
6.1.4. Trigger all messages
6.2. Stub Runner Camel
6.2.1. Adding it to the project
6.2.2. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.3. Stub Runner Integration
6.3.1. Adding it to the project
6.3.2. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.4. Stub Runner Stream
6.4.1. Adding it to the project
6.4.2. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.5. Stub Runner Spring AMQP
6.5.1. Adding it to the project
6.5.2. Examples
Stubs structure
Triggering the message
Spring AMQP Test Configuration
7. Contract DSL
7.1. Limitations
7.2. Common Top-Level elements
7.2.1. Description
7.2.2. Name
7.2.3. Ignoring contracts
7.3. HTTP Top-Level Elements
7.4. Request
7.5. Response
7.6. Dynamic properties
7.6.1. Dynamic properties inside the body
7.6.2. Regular expressions
7.6.3. Passing optional parameters
7.6.4. Executing custom methods on server side
7.6.5. Referencing request from response
7.6.6. Dynamic properties in matchers sections
7.7. JAX-RS support
7.8. Async support
7.9. Working with Context Paths
7.10. Messaging Top-Level Elements
7.10.1. Output triggered by a method
7.10.2. Output triggered by a message
7.10.3. Consumer / Producer
7.11. Multiple contracts in one file
8. Customization
8.1. Extending the DSL
8.1.1. Common JAR
8.1.2. Adding the dependency to project
8.1.3. Test dependency in project’s dependencies
8.1.4. Test dependency in plugin’s dependencies
8.1.5. Referencing classes in DSLs
9. Pluggable architecture
9.1. Custom contract converter
9.1.1. Pact converter
9.1.2. Pact contract
9.1.3. Pact for producers
9.1.4. Pact for consumers
9.2. Custom test generator
9.3. Custom stub generator
9.4. Custom Stub Runner
9.5. Custom Stub Downloader
10. Spring Cloud Contract WireMock
10.1. Registering Stubs Automatically
10.2. Using Files to Specify the Stub Bodies
10.3. Alternative: Using JUnit Rules
10.4. Relaxed SSL Validation for Rest Template
10.5. WireMock and Spring MVC Mocks
10.6. Generating Stubs using RestDocs
10.7. Generating Contracts using RestDocs
11. Links
   Next
   

\ No newline at end of file
+   Spring Cloud Contract
Spring Cloud Contract
   Next
Spring Cloud Contract
Table of Contents
1. Spring Cloud Contract
2. Spring Cloud Contract Verifier Introduction
2.1. Why?
2.1.1. Testing issues
2.2. Purposes
2.3. How
2.3.1. Define the contract
2.3.2. Client Side
2.3.3. Server Side
2.4. Step by step guide to CDC
2.4.1. Technical note
2.4.2. Consumer side (Loan Issuance)
2.4.3. Producer side (Fraud Detection server)
2.4.4. Consumer side (Loan Issuance) final step
2.5. Dependencies
2.6. Additional links
2.6.1. Spring Cloud Contract video
2.6.2. Readings
2.7. Samples
3. Spring Cloud Contract Verifier Setup
3.1. Gradle Project
3.1.1. Prerequisites
3.1.2. Add gradle plugin with dependencies
3.1.3. Gradle and Rest Assured 3.0
3.1.4. Snapshot versions for Gradle
3.1.5. Add stubs
3.1.6. Run plugin
3.1.7. Default setup
3.1.8. Configure plugin
3.1.9. Configuration options
3.1.10. Single base class for all tests
3.1.11. Different base classes for contracts
3.1.12. Invoking generated tests
3.1.13. Spring Cloud Contract Verifier on consumer side
3.2. Using in your Maven project
3.2.1. Add maven plugin
3.2.2. Maven and Rest Assured 3.0
3.2.3. Snapshot versions for Maven
3.2.4. Add stubs
3.2.5. Run plugin
3.2.6. Configure plugin
3.2.7. Important configuration options
3.2.8. Single base class for all tests
3.2.9. Different base classes for contracts
3.2.10. Invoking generated tests
3.2.11. FAQ with Maven Plugin
3.2.12. Maven Plugin and STS
3.2.13. Spring Cloud Contract Verifier on consumer side
3.3. Scenarios
3.4. Stubs and transitive dependencies
4. Spring Cloud Contract Verifier Messaging
4.1. Integrations
4.2. Manual Integration Testing
4.3. Publisher side test generation
4.3.1. Scenario 1 (no input message)
4.3.2. Scenario 2 (output triggered by input)
4.3.3. Scenario 3 (no output message)
4.4. Consumer Stub Side generation
5. Spring Cloud Contract Stub Runner
5.1. Snapshot versions
5.2. Publishing stubs as JARs
5.3. Stub Runner Core
5.3.1. Retrieving stubs
Stub downloading
Classpath scanning
5.3.2. Running stubs
Limitations
Running using main app
HTTP Stubs
Viewing registered mappings
Messaging Stubs
5.4. Stub Runner JUnit Rule
5.4.1. Maven settings
5.4.2. Providing fixed ports
5.4.3. Fluent API
5.4.4. Stub Runner with Spring
5.5. Stub Runner Spring Cloud
5.5.1. Stubbing Service Discovery
Test profiles and service discovery
5.5.2. Additional Configuration
5.6. Stub Runner Boot Application
5.6.1. How to use it?
Stub Runner Server
Spring Cloud CLI
5.6.2. Endpoints
HTTP
Messaging
5.6.3. Example
5.6.4. Stub Runner Boot with Service Discovery
5.7. Stubs Per Consumer
5.8. Common
5.8.1. Common properties for JUnit and Spring
5.8.2. Stub runner stubs ids
6. Stub Runner for Messaging
6.1. Stub triggering
6.1.1. Trigger by label
6.1.2. Trigger by group and artifact ids
6.1.3. Trigger by artifact ids
6.1.4. Trigger all messages
6.2. Stub Runner Camel
6.2.1. Adding it to the project
6.2.2. Disabling the functionality
6.2.3. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.3. Stub Runner Integration
6.3.1. Adding it to the project
6.3.2. Disabling the functionality
6.3.3. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.4. Stub Runner Stream
6.4.1. Adding it to the project
6.4.2. Disabling the functionality
6.4.3. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.5. Stub Runner Spring AMQP
6.5.1. Adding it to the project
6.5.2. Examples
Stubs structure
Triggering the message
Spring AMQP Test Configuration
7. Contract DSL
7.1. Limitations
7.2. Common Top-Level elements
7.2.1. Description
7.2.2. Name
7.2.3. Ignoring contracts
7.3. HTTP Top-Level Elements
7.4. Request
7.5. Response
7.6. Dynamic properties
7.6.1. Dynamic properties inside the body
7.6.2. Regular expressions
7.6.3. Passing optional parameters
7.6.4. Executing custom methods on server side
7.6.5. Referencing request from response
7.6.6. Dynamic properties in matchers sections
7.7. JAX-RS support
7.8. Async support
7.9. Working with Context Paths
7.10. Messaging Top-Level Elements
7.10.1. Output triggered by a method
7.10.2. Output triggered by a message
7.10.3. Consumer / Producer
7.11. Multiple contracts in one file
8. Customization
8.1. Extending the DSL
8.1.1. Common JAR
8.1.2. Adding the dependency to project
8.1.3. Test dependency in project’s dependencies
8.1.4. Test dependency in plugin’s dependencies
8.1.5. Referencing classes in DSLs
9. Pluggable architecture
9.1. Custom contract converter
9.1.1. Pact converter
9.1.2. Pact contract
9.1.3. Pact for producers
9.1.4. Pact for consumers
9.2. Custom test generator
9.3. Custom stub generator
9.4. Custom Stub Runner
9.5. Custom Stub Downloader
10. Spring Cloud Contract WireMock
10.1. Registering Stubs Automatically
10.2. Using Files to Specify the Stub Bodies
10.3. Alternative: Using JUnit Rules
10.4. Relaxed SSL Validation for Rest Template
10.5. WireMock and Spring MVC Mocks
10.6. Generating Stubs using RestDocs
10.7. Generating Contracts using RestDocs
11. Links
   Next
   

\ No newline at end of file
diff --git a/1.1.x/single/spring-cloud-contract.html b/1.1.x/single/spring-cloud-contract.html
index b07be9dde8..1cd33c8c27 100644
--- a/1.1.x/single/spring-cloud-contract.html
+++ b/1.1.x/single/spring-cloud-contract.html
@@ -1,6 +1,6 @@
 
       
-   Spring Cloud Contract
Spring Cloud Contract
Table of Contents
1. Spring Cloud Contract
2. Spring Cloud Contract Verifier Introduction
2.1. Why?
2.1.1. Testing issues
2.2. Purposes
2.3. How
2.3.1. Define the contract
2.3.2. Client Side
2.3.3. Server Side
2.4. Step by step guide to CDC
2.4.1. Technical note
2.4.2. Consumer side (Loan Issuance)
2.4.3. Producer side (Fraud Detection server)
2.4.4. Consumer side (Loan Issuance) final step
2.5. Dependencies
2.6. Additional links
2.6.1. Spring Cloud Contract video
2.6.2. Readings
2.7. Samples
3. Spring Cloud Contract Verifier Setup
3.1. Gradle Project
3.1.1. Prerequisites
3.1.2. Add gradle plugin with dependencies
3.1.3. Gradle and Rest Assured 3.0
3.1.4. Snapshot versions for Gradle
3.1.5. Add stubs
3.1.6. Run plugin
3.1.7. Default setup
3.1.8. Configure plugin
3.1.9. Configuration options
3.1.10. Single base class for all tests
3.1.11. Different base classes for contracts
3.1.12. Invoking generated tests
3.1.13. Spring Cloud Contract Verifier on consumer side
3.2. Using in your Maven project
3.2.1. Add maven plugin
3.2.2. Maven and Rest Assured 3.0
3.2.3. Snapshot versions for Maven
3.2.4. Add stubs
3.2.5. Run plugin
3.2.6. Configure plugin
3.2.7. Important configuration options
3.2.8. Single base class for all tests
3.2.9. Different base classes for contracts
3.2.10. Invoking generated tests
3.2.11. FAQ with Maven Plugin
3.2.12. Maven Plugin and STS
3.2.13. Spring Cloud Contract Verifier on consumer side
3.3. Scenarios
3.4. Stubs and transitive dependencies
4. Spring Cloud Contract Verifier Messaging
4.1. Integrations
4.2. Manual Integration Testing
4.3. Publisher side test generation
4.3.1. Scenario 1 (no input message)
4.3.2. Scenario 2 (output triggered by input)
4.3.3. Scenario 3 (no output message)
4.4. Consumer Stub Side generation
5. Spring Cloud Contract Stub Runner
5.1. Snapshot versions
5.2. Publishing stubs as JARs
5.3. Stub Runner Core
5.3.1. Retrieving stubs
Stub downloading
Classpath scanning
5.3.2. Running stubs
Limitations
Running using main app
HTTP Stubs
Viewing registered mappings
Messaging Stubs
5.4. Stub Runner JUnit Rule
5.4.1. Maven settings
5.4.2. Providing fixed ports
5.4.3. Fluent API
5.4.4. Stub Runner with Spring
5.5. Stub Runner Spring Cloud
5.5.1. Stubbing Service Discovery
Test profiles and service discovery
5.5.2. Additional Configuration
5.6. Stub Runner Boot Application
5.6.1. How to use it?
Stub Runner Server
Spring Cloud CLI
5.6.2. Endpoints
HTTP
Messaging
5.6.3. Example
5.6.4. Stub Runner Boot with Service Discovery
5.7. Stubs Per Consumer
5.8. Common
5.8.1. Common properties for JUnit and Spring
5.8.2. Stub runner stubs ids
6. Stub Runner for Messaging
6.1. Stub triggering
6.1.1. Trigger by label
6.1.2. Trigger by group and artifact ids
6.1.3. Trigger by artifact ids
6.1.4. Trigger all messages
6.2. Stub Runner Camel
6.2.1. Adding it to the project
6.2.2. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.3. Stub Runner Integration
6.3.1. Adding it to the project
6.3.2. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.4. Stub Runner Stream
6.4.1. Adding it to the project
6.4.2. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.5. Stub Runner Spring AMQP
6.5.1. Adding it to the project
6.5.2. Examples
Stubs structure
Triggering the message
Spring AMQP Test Configuration
7. Contract DSL
7.1. Limitations
7.2. Common Top-Level elements
7.2.1. Description
7.2.2. Name
7.2.3. Ignoring contracts
7.3. HTTP Top-Level Elements
7.4. Request
7.5. Response
7.6. Dynamic properties
7.6.1. Dynamic properties inside the body
7.6.2. Regular expressions
7.6.3. Passing optional parameters
7.6.4. Executing custom methods on server side
7.6.5. Referencing request from response
7.6.6. Dynamic properties in matchers sections
7.7. JAX-RS support
7.8. Async support
7.9. Working with Context Paths
7.10. Messaging Top-Level Elements
7.10.1. Output triggered by a method
7.10.2. Output triggered by a message
7.10.3. Consumer / Producer
7.11. Multiple contracts in one file
8. Customization
8.1. Extending the DSL
8.1.1. Common JAR
8.1.2. Adding the dependency to project
8.1.3. Test dependency in project’s dependencies
8.1.4. Test dependency in plugin’s dependencies
8.1.5. Referencing classes in DSLs
9. Pluggable architecture
9.1. Custom contract converter
9.1.1. Pact converter
9.1.2. Pact contract
9.1.3. Pact for producers
9.1.4. Pact for consumers
9.2. Custom test generator
9.3. Custom stub generator
9.4. Custom Stub Runner
9.5. Custom Stub Downloader
10. Spring Cloud Contract WireMock
10.1. Registering Stubs Automatically
10.2. Using Files to Specify the Stub Bodies
10.3. Alternative: Using JUnit Rules
10.4. Relaxed SSL Validation for Rest Template
10.5. WireMock and Spring MVC Mocks
10.6. Generating Stubs using RestDocs
10.7. Generating Contracts using RestDocs
11. Links
Documentation Authors: Adam Dudczak, Mathias Düsterhöft, Marcin Grzejszczak, Dennis Kieselhorst, Jakub Kubryński, Karol Lassak,
+   Spring Cloud Contract
Spring Cloud Contract
Table of Contents
1. Spring Cloud Contract
2. Spring Cloud Contract Verifier Introduction
2.1. Why?
2.1.1. Testing issues
2.2. Purposes
2.3. How
2.3.1. Define the contract
2.3.2. Client Side
2.3.3. Server Side
2.4. Step by step guide to CDC
2.4.1. Technical note
2.4.2. Consumer side (Loan Issuance)
2.4.3. Producer side (Fraud Detection server)
2.4.4. Consumer side (Loan Issuance) final step
2.5. Dependencies
2.6. Additional links
2.6.1. Spring Cloud Contract video
2.6.2. Readings
2.7. Samples
3. Spring Cloud Contract Verifier Setup
3.1. Gradle Project
3.1.1. Prerequisites
3.1.2. Add gradle plugin with dependencies
3.1.3. Gradle and Rest Assured 3.0
3.1.4. Snapshot versions for Gradle
3.1.5. Add stubs
3.1.6. Run plugin
3.1.7. Default setup
3.1.8. Configure plugin
3.1.9. Configuration options
3.1.10. Single base class for all tests
3.1.11. Different base classes for contracts
3.1.12. Invoking generated tests
3.1.13. Spring Cloud Contract Verifier on consumer side
3.2. Using in your Maven project
3.2.1. Add maven plugin
3.2.2. Maven and Rest Assured 3.0
3.2.3. Snapshot versions for Maven
3.2.4. Add stubs
3.2.5. Run plugin
3.2.6. Configure plugin
3.2.7. Important configuration options
3.2.8. Single base class for all tests
3.2.9. Different base classes for contracts
3.2.10. Invoking generated tests
3.2.11. FAQ with Maven Plugin
3.2.12. Maven Plugin and STS
3.2.13. Spring Cloud Contract Verifier on consumer side
3.3. Scenarios
3.4. Stubs and transitive dependencies
4. Spring Cloud Contract Verifier Messaging
4.1. Integrations
4.2. Manual Integration Testing
4.3. Publisher side test generation
4.3.1. Scenario 1 (no input message)
4.3.2. Scenario 2 (output triggered by input)
4.3.3. Scenario 3 (no output message)
4.4. Consumer Stub Side generation
5. Spring Cloud Contract Stub Runner
5.1. Snapshot versions
5.2. Publishing stubs as JARs
5.3. Stub Runner Core
5.3.1. Retrieving stubs
Stub downloading
Classpath scanning
5.3.2. Running stubs
Limitations
Running using main app
HTTP Stubs
Viewing registered mappings
Messaging Stubs
5.4. Stub Runner JUnit Rule
5.4.1. Maven settings
5.4.2. Providing fixed ports
5.4.3. Fluent API
5.4.4. Stub Runner with Spring
5.5. Stub Runner Spring Cloud
5.5.1. Stubbing Service Discovery
Test profiles and service discovery
5.5.2. Additional Configuration
5.6. Stub Runner Boot Application
5.6.1. How to use it?
Stub Runner Server
Spring Cloud CLI
5.6.2. Endpoints
HTTP
Messaging
5.6.3. Example
5.6.4. Stub Runner Boot with Service Discovery
5.7. Stubs Per Consumer
5.8. Common
5.8.1. Common properties for JUnit and Spring
5.8.2. Stub runner stubs ids
6. Stub Runner for Messaging
6.1. Stub triggering
6.1.1. Trigger by label
6.1.2. Trigger by group and artifact ids
6.1.3. Trigger by artifact ids
6.1.4. Trigger all messages
6.2. Stub Runner Camel
6.2.1. Adding it to the project
6.2.2. Disabling the functionality
6.2.3. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.3. Stub Runner Integration
6.3.1. Adding it to the project
6.3.2. Disabling the functionality
6.3.3. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.4. Stub Runner Stream
6.4.1. Adding it to the project
6.4.2. Disabling the functionality
6.4.3. Examples
Stubs structure
Scenario 1 (no input message)
Scenario 2 (output triggered by input)
Scenario 3 (input with no output)
6.5. Stub Runner Spring AMQP
6.5.1. Adding it to the project
6.5.2. Examples
Stubs structure
Triggering the message
Spring AMQP Test Configuration
7. Contract DSL
7.1. Limitations
7.2. Common Top-Level elements
7.2.1. Description
7.2.2. Name
7.2.3. Ignoring contracts
7.3. HTTP Top-Level Elements
7.4. Request
7.5. Response
7.6. Dynamic properties
7.6.1. Dynamic properties inside the body
7.6.2. Regular expressions
7.6.3. Passing optional parameters
7.6.4. Executing custom methods on server side
7.6.5. Referencing request from response
7.6.6. Dynamic properties in matchers sections
7.7. JAX-RS support
7.8. Async support
7.9. Working with Context Paths
7.10. Messaging Top-Level Elements
7.10.1. Output triggered by a method
7.10.2. Output triggered by a message
7.10.3. Consumer / Producer
7.11. Multiple contracts in one file
8. Customization
8.1. Extending the DSL
8.1.1. Common JAR
8.1.2. Adding the dependency to project
8.1.3. Test dependency in project’s dependencies
8.1.4. Test dependency in plugin’s dependencies
8.1.5. Referencing classes in DSLs
9. Pluggable architecture
9.1. Custom contract converter
9.1.1. Pact converter
9.1.2. Pact contract
9.1.3. Pact for producers
9.1.4. Pact for consumers
9.2. Custom test generator
9.3. Custom stub generator
9.4. Custom Stub Runner
9.5. Custom Stub Downloader
10. Spring Cloud Contract WireMock
10.1. Registering Stubs Automatically
10.2. Using Files to Specify the Stub Bodies
10.3. Alternative: Using JUnit Rules
10.4. Relaxed SSL Validation for Rest Template
10.5. WireMock and Spring MVC Mocks
10.6. Generating Stubs using RestDocs
10.7. Generating Contracts using RestDocs
11. Links
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
1.1.4.BUILD-SNAPSHOT
1. Spring Cloud Contract
What you always need is confidence in pushing new features into a new application or service in a distributed system.
 This project provides support for Consumer Driven Contracts and service schemas in Spring applications, covering a
 range of options for writing tests, publishing them as assets, asserting that a contract is kept by producers
@@ -1694,7 +1694,10 @@ transitions from digit to letter and vice versa delimit the version segments. De
 recognized and treated specially: "alpha" = "a" < "beta" = "b" < "milestone" = "m" < "cr" = "rc" < "snapshot" < "final" = "ga" < "sp". All of those well-known qualifiers
 are considered smaller/older than other strings. An empty segment/string is equivalent to 0.
In addition to the above mentioned qualifiers, the tokens "min" and "max" may be used as final version segment to denote the smallest/greatest version having a given prefix.
 For example, "1.2.min" denotes the smallest version in the 1.2 line, "1.2.max" denotes the greatest version in the 1.2 line. A version range of the form "[M.N.*]" is short for "[M.N.min, M.N.max]".
Numbers and strings are considered incomparable against each other. Where version segments of different kind would collide, comparison will instead assume that the previous
-segments are padded with trailing 0 or "ga" segments, respectively, until the kind mismatch is resolved, e.g. "1-alpha" = "1.0.0-alpha" < "1.0.1-ga" = "1.0.1".
6. Stub Runner for Messaging
Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box
  • Spring Integration
  • Spring Cloud Stream
  • Apache Camel
  • Spring AMQP
It also provides points of entry to integrate with any other solution on the market.
6.1 Stub triggering
To trigger a message it’s enough to use the StubTrigger interface:
package org.springframework.cloud.contract.stubrunner;
+segments are padded with trailing 0 or "ga" segments, respectively, until the kind mismatch is resolved, e.g. "1-alpha" = "1.0.0-alpha" < "1.0.1-ga" = "1.0.1".
6. Stub Runner for Messaging
Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box
  • Spring Integration
  • Spring Cloud Stream
  • Apache Camel
  • Spring AMQP
It also provides points of entry to integrate with any other solution on the market.
[Important]Important
If you have multiple frameworks on the classpath Stub Runner will need to
+define which one should be used. Let’s assume that you have both AMQP, Spring Cloud Stream and Spring Integration
+on the classpath. Then you need to set stubrunner.stream.enabled=false and stubrunner.integration.enabled=false.
+That way the only remaining framework is Spring AMQP.
6.1 Stub triggering
To trigger a message it’s enough to use the StubTrigger interface:
package org.springframework.cloud.contract.stubrunner;
 
 import java.util.Collection;
 import java.util.Map;
@@ -1737,7 +1740,7 @@ segments are padded with trailing 0 or "ga" segments, respectively, until the ki
 }
For convenience the StubFinder interface extends StubTrigger so it’s enough to use only one in your tests.
StubTrigger gives you the following options to trigger a message:
6.1.1 Trigger by label
stubFinder.trigger('return_book_1')
6.1.2 Trigger by group and artifact ids
stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:camelService', 'return_book_1')
6.1.3 Trigger by artifact ids
stubFinder.trigger('camelService', 'return_book_1')
6.1.4 Trigger all messages
stubFinder.trigger()
6.2 Stub Runner Camel
Spring Cloud Contract Verifier Stub Runner’s messaging module gives you an easy way to integrate with Apache Camel.
 For the provided artifacts it will automatically download the stubs and register the required
 routes.
6.2.1 Adding it to the project
It’s enough to have both Apache Camel and Spring Cloud Contract Stub Runner on classpath.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.2.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
6.2.2 Disabling the functionality
If you need to disable this functionality just pass stubrunner.camel.enabled=false property.
6.2.3 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 camelService application.
└── .m2
     └── repository
         └── io
@@ -1795,7 +1798,7 @@ assertThatBodyContainsBookNameFoo(receivedMessage.in.body)
 receivedMessage.in.headers.get('BOOK-NAME') == 'foo'
Scenario 3 (input with no output)
Since the route is set for you it’s enough to just send a message to the jms:output destination.
camelContext.createProducerTemplate().sendBodyAndHeaders('jms:delete', new BookReturned('foo'), [sample: 'header'])
6.3 Stub Runner Integration
Spring Cloud Contract Verifier Stub Runner’s messaging module gives you an easy way to integrate with Spring Integration.
 For the provided artifacts it will automatically download the stubs and register the required
 routes.
6.3.1 Adding it to the project
It’s enough to have both Spring Integration and Spring Cloud Contract Stub Runner on classpath.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.3.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
6.3.2 Disabling the functionality
If you need to disable this functionality just pass stubrunner.integration.enabled=false property.
6.3.3 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 integrationService application.
└── .m2
     └── repository
         └── io
@@ -1882,7 +1885,7 @@ channel name.
Gradle. 
 
testCompile "org.springframework.cloud:spring-cloud-stream-test-support"

 
6.4.1 Adding it to the project
It’s enough to have both Spring Cloud Stream and Spring Cloud Contract Stub Runner on classpath.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.4.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
6.4.2 Disabling the functionality
If you need to disable this functionality just pass stubrunner.stream.enabled=false property.
6.4.3 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 streamService application.
└── .m2
     └── repository
         └── io
@@ -1953,7 +1956,9 @@ Message listeners on the other side are bound to queues. Bindings connect an exc
 If message contracts are triggered the Spring AMQP stub runner integration will look for bindings on the application context that match this exchange.
 Then it collects the queues from the Spring exchanges and tries to find messages listeners bound to these queues.
 The message is triggered to all matching message listeners.
6.5.1 Adding it to the project
It’s enough to have both Spring AMQP and Spring Cloud Contract Stub Runner on the classpath and set the property stubrunner.amqp.enabled=true.
-Remember to annotate your test class with @AutoConfigureStubRunner.
6.5.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
+Remember to annotate your test class with @AutoConfigureStubRunner.
[Important]Important
If you already have Stream and Integration on the classpath you need
+to disable them explicitly via stubrunner.stream.enabled=false and stubrunner.integration.enabled=false
+properties
6.5.2 Examples
Stubs structure
Let us assume that we have the following Maven repository with a deployed stubs for the
 spring-cloud-contract-amqp-test application.
└── .m2
     └── repository
         └── com
diff --git a/1.1.x/spring-cloud-contract-maven-plugin/checkstyle.html b/1.1.x/spring-cloud-contract-maven-plugin/checkstyle.html
index 74ffe24d2c..97636cc3af 100644
--- a/1.1.x/spring-cloud-contract-maven-plugin/checkstyle.html
+++ b/1.1.x/spring-cloud-contract-maven-plugin/checkstyle.html
@@ -1,13 +1,13 @@
 
 
 
   
     
     
-    
+    
     
     Spring Cloud Contract Maven Plugin – Checkstyle Results
     
@@ -146,7 +146,7 @@