diff --git a/2.1.x/multi/multi__using_the_pluggable_architecture.html b/2.1.x/multi/multi__using_the_pluggable_architecture.html index 1fa8e36bbf..f0e253e96d 100644 --- a/2.1.x/multi/multi__using_the_pluggable_architecture.html +++ b/2.1.x/multi/multi__using_the_pluggable_architecture.html @@ -462,10 +462,10 @@ to clone the repository and use it as a source of contracts to generate tests or stubs.

Either via environment variables, system properties, properties set inside the plugin or contracts repository configuration you can tweak the downloader’s behaviour. Below you can find the list of -properties

Table 11.1. SCM Stub Downloader properties

Type of a property

Name of the property

Description

* git.branch (plugin prop)

* stubrunner.properties.git.branch (system prop)

* STUBRUNNER_PROPERTIES_GIT_BRANCH (env prop)

master

Which branch to checkout

* git.username (plugin prop)

* stubrunner.properties.git.username (system prop)

* STUBRUNNER_PROPERTIES_GIT_USERNAME (env prop)

 

Git clone username

* git.password (plugin prop)

* stubrunner.properties.git.password (system prop)

* STUBRUNNER_PROPERTIES_GIT_PASSWORD (env prop)

 

Git clone password

* git.no-of-attempts (plugin prop)

* stubrunner.properties.git.no-of-attempts (system prop)

* STUBRUNNER_PROPERTIES_GIT_NO_OF_ATTEMPTS (env prop)

10

Number of attempts to push the commits to origin

* git.wait-between-attempts (Plugin prop)

* stubrunner.properties.git.wait-between-attempts (system prop)

* STUBRUNNER_PROPERTIES_GIT_WAIT_BETWEEN_ATTEMPTS (env prop)

1000

Number of millis to wait between attempts to push the commits to origin


11.7 Using the Pact Stub Downloader

Whenever the repositoryRoot starts with a Pact protocol +properties

Table 11.1. SCM Stub Downloader properties

Type of a property

Name of the property

Description

* git.branch (plugin prop)

* stubrunner.properties.git.branch (system prop)

* STUBRUNNER_PROPERTIES_GIT_BRANCH (env prop)

master

Which branch to checkout

* git.username (plugin prop)

* stubrunner.properties.git.username (system prop)

* STUBRUNNER_PROPERTIES_GIT_USERNAME (env prop)

 

Git clone username

* git.password (plugin prop)

* stubrunner.properties.git.password (system prop)

* STUBRUNNER_PROPERTIES_GIT_PASSWORD (env prop)

 

Git clone password

* git.no-of-attempts (plugin prop)

* stubrunner.properties.git.no-of-attempts (system prop)

* STUBRUNNER_PROPERTIES_GIT_NO_OF_ATTEMPTS (env prop)

10

Number of attempts to push the commits to origin

* git.wait-between-attempts (Plugin prop)

* stubrunner.properties.git.wait-between-attempts (system prop)

* STUBRUNNER_PROPERTIES_GIT_WAIT_BETWEEN_ATTEMPTS (env prop)

1000

Number of millis to wait between attempts to push the commits to origin


11.7 Using the Pact Stub Downloader

Whenever the repositoryRoot starts with a Pact protocol (starts with pact://), the stub downloader will try to fetch the Pact contract definitions from the Pact Broker. Whatever is set after pact:// will be parsed as the Pact Broker URL.

Either via environment variables, system properties, properties set inside the plugin or contracts repository configuration you can tweak the downloader’s behaviour. Below you can find the list of -properties

Table 11.2. SCM Stub Downloader properties

Name of a property

Default

Description

* pactbroker.host (plugin prop)

* stubrunner.properties.pactbroker.host (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_HOST (env prop)

Host from URL passed to repositoryRoot

What is the URL of Pact Broker

* pactbroker.port (plugin prop)

* stubrunner.properties.pactbroker.port (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_PORT (env prop)

Port from URL passed to repositoryRoot

What is the port of Pact Broker

* pactbroker.protocol (plugin prop)

* stubrunner.properties.pactbroker.protocol (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_PROTOCOL (env prop)

Protocol from URL passed to repositoryRoot

What is the protocol of Pact Broker

* pactbroker.tags (plugin prop)

* stubrunner.properties.pactbroker.tags (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_TAGS (env prop)

Version of the stub, or latest if version is +

What tags should be used to fetch the stub

* pactbroker.auth.scheme (plugin prop)

* stubrunner.properties.pactbroker.auth.scheme (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_SCHEME (env prop)

Basic

What kind of authentication should be used to connect to the Pact Broker

* pactbroker.auth.username (plugin prop)

* stubrunner.properties.pactbroker.auth.username (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_USERNAME (env prop)

The username passed to contractsRepositoryUsername (maven) or contractRepository.username (gradle)

Username used to connect to the Pact Broker

* pactbroker.auth.password (plugin prop)

* stubrunner.properties.pactbroker.auth.password (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_PASSWORD (env prop)

The password passed to contractsRepositoryPassword (maven) or contractRepository.password (gradle)

Password used to connect to the Pact Broker

* pactbroker.provider-name-with-group-id (plugin prop)

* stubrunner.properties.pactbroker.provider-name-with-group-id (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_PROVIDER_NAME_WITH_GROUP_ID (env prop)

false

When true, the provider name will be a combination of groupId:artifactId. If false, just artifactId is used


Prev   Next
10. Customization Home 12. Spring Cloud Contract WireMock
\ No newline at end of file +properties

Table 11.2. SCM Stub Downloader properties

Name of a property

Default

Description

* pactbroker.host (plugin prop)

* stubrunner.properties.pactbroker.host (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_HOST (env prop)

Host from URL passed to repositoryRoot

What is the URL of Pact Broker

* pactbroker.port (plugin prop)

* stubrunner.properties.pactbroker.port (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_PORT (env prop)

Port from URL passed to repositoryRoot

What is the port of Pact Broker

* pactbroker.protocol (plugin prop)

* stubrunner.properties.pactbroker.protocol (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_PROTOCOL (env prop)

Protocol from URL passed to repositoryRoot

What is the protocol of Pact Broker

* pactbroker.tags (plugin prop)

* stubrunner.properties.pactbroker.tags (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_TAGS (env prop)

Version of the stub, or latest if version is +

What tags should be used to fetch the stub

* pactbroker.auth.scheme (plugin prop)

* stubrunner.properties.pactbroker.auth.scheme (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_SCHEME (env prop)

Basic

What kind of authentication should be used to connect to the Pact Broker

* pactbroker.auth.username (plugin prop)

* stubrunner.properties.pactbroker.auth.username (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_USERNAME (env prop)

The username passed to contractsRepositoryUsername (maven) or contractRepository.username (gradle)

Username used to connect to the Pact Broker

* pactbroker.auth.password (plugin prop)

* stubrunner.properties.pactbroker.auth.password (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_PASSWORD (env prop)

The password passed to contractsRepositoryPassword (maven) or contractRepository.password (gradle)

Password used to connect to the Pact Broker

* pactbroker.provider-name-with-group-id (plugin prop)

* stubrunner.properties.pactbroker.provider-name-with-group-id (system prop)

* STUBRUNNER_PROPERTIES_PACTBROKER_PROVIDER_NAME_WITH_GROUP_ID (env prop)

false

When true, the provider name will be a combination of groupId:artifactId. If false, just artifactId is used


Prev   Next
10. Customization Home 12. Spring Cloud Contract WireMock
\ No newline at end of file diff --git a/2.1.x/multi/multi_gradle-add-gradle-plugin.html b/2.1.x/multi/multi_gradle-add-gradle-plugin.html index 88c7cbdbd0..fd1a320e05 100644 --- a/2.1.x/multi/multi_gradle-add-gradle-plugin.html +++ b/2.1.x/multi/multi_gradle-add-gradle-plugin.html @@ -666,7 +666,46 @@ verification tests with both Maven and Gradle plugin. However, whereas with Grad in Maven you will require some additional setup in order to make the tests compile and execute properly.

First of all, you will have to use a plugin, such as GMavenPlus plugin, to add Groovy to your project. In GMavenPlus plugin, you will need to explicitly set test sources, including both the path where your base test classes are defined and the path were the generated contract tests are added. -Please refer to the example below:

If you uphold to the Spock convention of ending the test class names with Spec, you will also need to adjust your Maven
+Please refer to the example below:
<plugin>
+	<groupId>org.codehaus.gmavenplus</groupId>
+	<artifactId>gmavenplus-plugin</artifactId>
+	<version>1.6.1</version>
+	<executions>
+		<execution>
+			<goals>
+				<goal>compileTests</goal>
+				<goal>addTestSources</goal>
+			</goals>
+		</execution>
+	</executions>
+	<configuration>
+		<testSources>
+			<testSource>
+				<directory>${project.basedir}/src/test/groovy</directory>
+				<includes>
+					<include>**/*.groovy</include>
+				</includes>
+			</testSource>
+			<testSource>
+				<directory>
+					${project.basedir}/target/generated-test-sources/contracts/com/example/beer
+				</directory>
+				<includes>
+					<include>**/*.groovy</include>
+					<include>**/*.gvy</include>
+				</includes>
+			</testSource>
+		</testSources>
+	</configuration>
+	<dependencies>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-all</artifactId>
+			<version>2.4.15</version>
+			<scope>runtime</scope>
+			<type>pom</type>
+		</dependency>
+	</dependencies>
If you uphold to the Spock convention of ending the test class names with Spec, you will also need to adjust your Maven
 Surefire plugin setup, like in the following example:
5.14 Stubs and Transitive Dependencies
The Maven and Gradle plugin that add the tasks that create the stubs jar for you. One
 problem that arises is that, when reusing the stubs, you can mistakenly import all of
 that stub’s dependencies. When building a Maven artifact, even though you have a couple
diff --git a/2.1.x/single/spring-cloud-contract.html b/2.1.x/single/spring-cloud-contract.html
index 930a37d2cc..b0e941ad51 100644
--- a/2.1.x/single/spring-cloud-contract.html
+++ b/2.1.x/single/spring-cloud-contract.html
@@ -2214,7 +2214,46 @@ verification tests with both Maven and Gradle plugin. However, whereas with Grad
 in Maven you will require some additional setup in order to make the tests compile and execute properly.
First of all, you will have to use a plugin, such as GMavenPlus plugin,
 to add Groovy to your project. In GMavenPlus plugin, you will need to explicitly set test sources, including both the
 path where your base test classes are defined and the path were the generated contract tests are added.
-Please refer to the example below:
If you uphold to the Spock convention of ending the test class names with Spec, you will also need to adjust your Maven
+Please refer to the example below:
<plugin>
+	<groupId>org.codehaus.gmavenplus</groupId>
+	<artifactId>gmavenplus-plugin</artifactId>
+	<version>1.6.1</version>
+	<executions>
+		<execution>
+			<goals>
+				<goal>compileTests</goal>
+				<goal>addTestSources</goal>
+			</goals>
+		</execution>
+	</executions>
+	<configuration>
+		<testSources>
+			<testSource>
+				<directory>${project.basedir}/src/test/groovy</directory>
+				<includes>
+					<include>**/*.groovy</include>
+				</includes>
+			</testSource>
+			<testSource>
+				<directory>
+					${project.basedir}/target/generated-test-sources/contracts/com/example/beer
+				</directory>
+				<includes>
+					<include>**/*.groovy</include>
+					<include>**/*.gvy</include>
+				</includes>
+			</testSource>
+		</testSources>
+	</configuration>
+	<dependencies>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-all</artifactId>
+			<version>2.4.15</version>
+			<scope>runtime</scope>
+			<type>pom</type>
+		</dependency>
+	</dependencies>
If you uphold to the Spock convention of ending the test class names with Spec, you will also need to adjust your Maven
 Surefire plugin setup, like in the following example:
5.14 Stubs and Transitive Dependencies
The Maven and Gradle plugin that add the tasks that create the stubs jar for you. One
 problem that arises is that, when reusing the stubs, you can mistakenly import all of
 that stub’s dependencies. When building a Maven artifact, even though you have a couple
@@ -6706,13 +6745,13 @@ to clone the repository and use it as a source of contracts
 to generate tests or stubs.
Either via environment variables, system properties, properties set
 inside the plugin or contracts repository configuration you can
 tweak the downloader’s behaviour. Below you can find the list of
-properties
Table 11.1. SCM Stub Downloader properties
Type of a property
Name of the property
Description
* git.branch (plugin prop)
* stubrunner.properties.git.branch (system prop)
* STUBRUNNER_PROPERTIES_GIT_BRANCH (env prop)
master
Which branch to checkout
* git.username (plugin prop)
* stubrunner.properties.git.username (system prop)
* STUBRUNNER_PROPERTIES_GIT_USERNAME (env prop)
 
Git clone username
* git.password (plugin prop)
* stubrunner.properties.git.password (system prop)
* STUBRUNNER_PROPERTIES_GIT_PASSWORD (env prop)
 
Git clone password
* git.no-of-attempts (plugin prop)
* stubrunner.properties.git.no-of-attempts (system prop)
* STUBRUNNER_PROPERTIES_GIT_NO_OF_ATTEMPTS (env prop)
10
Number of attempts to push the commits to origin
* git.wait-between-attempts (Plugin prop)
* stubrunner.properties.git.wait-between-attempts  (system prop)
* STUBRUNNER_PROPERTIES_GIT_WAIT_BETWEEN_ATTEMPTS  (env prop)
1000
Number of millis to wait between attempts to push the commits to origin

11.7 Using the Pact Stub Downloader
Whenever the repositoryRoot starts with a Pact protocol
+properties
Table 11.1. SCM Stub Downloader properties
Type of a property
Name of the property
Description
* git.branch (plugin prop)
* stubrunner.properties.git.branch (system prop)
* STUBRUNNER_PROPERTIES_GIT_BRANCH (env prop)
master
Which branch to checkout
* git.username (plugin prop)
* stubrunner.properties.git.username (system prop)
* STUBRUNNER_PROPERTIES_GIT_USERNAME (env prop)
 
Git clone username
* git.password (plugin prop)
* stubrunner.properties.git.password (system prop)
* STUBRUNNER_PROPERTIES_GIT_PASSWORD (env prop)
 
Git clone password
* git.no-of-attempts (plugin prop)
* stubrunner.properties.git.no-of-attempts (system prop)
* STUBRUNNER_PROPERTIES_GIT_NO_OF_ATTEMPTS (env prop)
10
Number of attempts to push the commits to origin
* git.wait-between-attempts (Plugin prop)
* stubrunner.properties.git.wait-between-attempts  (system prop)
* STUBRUNNER_PROPERTIES_GIT_WAIT_BETWEEN_ATTEMPTS  (env prop)
1000
Number of millis to wait between attempts to push the commits to origin

11.7 Using the Pact Stub Downloader
Whenever the repositoryRoot starts with a Pact protocol
 (starts with pact://), the stub downloader will try
 to fetch the Pact contract definitions from the Pact Broker.
 Whatever is set after pact:// will be parsed as the Pact Broker URL.
Either via environment variables, system properties, properties set
 inside the plugin or contracts repository configuration you can
 tweak the downloader’s behaviour. Below you can find the list of
-properties
Table 11.2. SCM Stub Downloader properties
Name of a property
Default
Description
* pactbroker.host (plugin prop)
* stubrunner.properties.pactbroker.host (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_HOST (env prop)
Host from URL passed to repositoryRoot
What is the URL of Pact Broker
* pactbroker.port (plugin prop)
* stubrunner.properties.pactbroker.port (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_PORT (env prop)
Port from URL passed to repositoryRoot
What is the port of Pact Broker
* pactbroker.protocol (plugin prop)
* stubrunner.properties.pactbroker.protocol (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_PROTOCOL (env prop)
Protocol from URL passed to repositoryRoot
What is the protocol of Pact Broker
* pactbroker.tags (plugin prop)
* stubrunner.properties.pactbroker.tags (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_TAGS (env prop)
Version of the stub, or latest if version is +
What tags should be used to fetch the stub
* pactbroker.auth.scheme (plugin prop)
* stubrunner.properties.pactbroker.auth.scheme (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_SCHEME (env prop)
Basic
What kind of authentication should be used to connect to the Pact Broker
* pactbroker.auth.username (plugin prop)
* stubrunner.properties.pactbroker.auth.username (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_USERNAME (env prop)
The username passed to contractsRepositoryUsername (maven) or contractRepository.username (gradle)
Username used to connect to the Pact Broker
* pactbroker.auth.password (plugin prop)
* stubrunner.properties.pactbroker.auth.password (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_PASSWORD (env prop)
The password passed to contractsRepositoryPassword (maven) or contractRepository.password (gradle)
Password used to connect to the Pact Broker
* pactbroker.provider-name-with-group-id (plugin prop)
* stubrunner.properties.pactbroker.provider-name-with-group-id (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_PROVIDER_NAME_WITH_GROUP_ID (env prop)
false
When true, the provider name will be a combination of groupId:artifactId. If false, just artifactId is used

12. Spring Cloud Contract WireMock
The Spring Cloud Contract WireMock modules let you use WireMock in a
+properties
Table 11.2. SCM Stub Downloader properties
Name of a property
Default
Description
* pactbroker.host (plugin prop)
* stubrunner.properties.pactbroker.host (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_HOST (env prop)
Host from URL passed to repositoryRoot
What is the URL of Pact Broker
* pactbroker.port (plugin prop)
* stubrunner.properties.pactbroker.port (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_PORT (env prop)
Port from URL passed to repositoryRoot
What is the port of Pact Broker
* pactbroker.protocol (plugin prop)
* stubrunner.properties.pactbroker.protocol (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_PROTOCOL (env prop)
Protocol from URL passed to repositoryRoot
What is the protocol of Pact Broker
* pactbroker.tags (plugin prop)
* stubrunner.properties.pactbroker.tags (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_TAGS (env prop)
Version of the stub, or latest if version is +
What tags should be used to fetch the stub
* pactbroker.auth.scheme (plugin prop)
* stubrunner.properties.pactbroker.auth.scheme (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_SCHEME (env prop)
Basic
What kind of authentication should be used to connect to the Pact Broker
* pactbroker.auth.username (plugin prop)
* stubrunner.properties.pactbroker.auth.username (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_USERNAME (env prop)
The username passed to contractsRepositoryUsername (maven) or contractRepository.username (gradle)
Username used to connect to the Pact Broker
* pactbroker.auth.password (plugin prop)
* stubrunner.properties.pactbroker.auth.password (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_PASSWORD (env prop)
The password passed to contractsRepositoryPassword (maven) or contractRepository.password (gradle)
Password used to connect to the Pact Broker
* pactbroker.provider-name-with-group-id (plugin prop)
* stubrunner.properties.pactbroker.provider-name-with-group-id (system prop)
* STUBRUNNER_PROPERTIES_PACTBROKER_PROVIDER_NAME_WITH_GROUP_ID (env prop)
false
When true, the provider name will be a combination of groupId:artifactId. If false, just artifactId is used

12. Spring Cloud Contract WireMock
The Spring Cloud Contract WireMock modules let you use WireMock in a
 Spring Boot application. Check out the
 samples
 for more details.
If you have a Spring Boot application that uses Tomcat as an embedded server (which is
diff --git a/2.1.x/spring-cloud-contract.xml b/2.1.x/spring-cloud-contract.xml
index 652ac87208..bff11ecc85 100644
--- a/2.1.x/spring-cloud-contract.xml
+++ b/2.1.x/spring-cloud-contract.xml
@@ -3674,7 +3674,46 @@ in Maven you will require some additional setup in order to make the tests compi
 to add Groovy to your project. In GMavenPlus plugin, you will need to explicitly set test sources, including both the
 path where your base test classes are defined and the path were the generated contract tests are added.
 Please refer to the example below:
-
+<plugin>
+	<groupId>org.codehaus.gmavenplus</groupId>
+	<artifactId>gmavenplus-plugin</artifactId>
+	<version>1.6.1</version>
+	<executions>
+		<execution>
+			<goals>
+				<goal>compileTests</goal>
+				<goal>addTestSources</goal>
+			</goals>
+		</execution>
+	</executions>
+	<configuration>
+		<testSources>
+			<testSource>
+				<directory>${project.basedir}/src/test/groovy</directory>
+				<includes>
+					<include>**/*.groovy</include>
+				</includes>
+			</testSource>
+			<testSource>
+				<directory>
+					${project.basedir}/target/generated-test-sources/contracts/com/example/beer
+				</directory>
+				<includes>
+					<include>**/*.groovy</include>
+					<include>**/*.gvy</include>
+				</includes>
+			</testSource>
+		</testSources>
+	</configuration>
+	<dependencies>
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy-all</artifactId>
+			<version>2.4.15</version>
+			<scope>runtime</scope>
+			<type>pom</type>
+		</dependency>
+	</dependencies>
 If you uphold to the Spock convention of ending the test class names with Spec, you will also need to adjust your Maven
 Surefire plugin setup, like in the following example: