From da84722ed6f7d35706ba4bb754ce1bbfbf9c92ea Mon Sep 17 00:00:00 2001 From: buildmaster Date: Mon, 2 Apr 2018 22:43:23 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- ...lti__using_the_pluggable_architecture.html | 54 +++++++++---------- single/spring-cloud-contract.html | 54 +++++++++---------- spring-cloud-contract.xml | 52 +++++++++--------- 3 files changed, 80 insertions(+), 80 deletions(-) diff --git a/multi/multi__using_the_pluggable_architecture.html b/multi/multi__using_the_pluggable_architecture.html index 9a84bc5884..ebcf1a4ad4 100644 --- a/multi/multi__using_the_pluggable_architecture.html +++ b/multi/multi__using_the_pluggable_architecture.html @@ -422,35 +422,35 @@ to generate tests or stubs.

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

Table 10.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


10.7 Using the Pact Stub Downloader

Whenever the repositoryRoot starts with a Pact protocol +

* 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


10.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 10.2. SCM Stub Downloader properties

Type of a property

Name of the property

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)

 

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)

 

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


\ No newline at end of file +properties

Table 10.2. SCM Stub Downloader properties

Type of a property

Name of the property

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)

 

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)

 

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


\ No newline at end of file diff --git a/single/spring-cloud-contract.html b/single/spring-cloud-contract.html index c20d0f73b5..37b4d63037 100644 --- a/single/spring-cloud-contract.html +++ b/single/spring-cloud-contract.html @@ -5818,38 +5818,38 @@ to generate tests or stubs.

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

Table 10.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


10.7 Using the Pact Stub Downloader

Whenever the repositoryRoot starts with a Pact protocol +

* 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


10.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 10.2. SCM Stub Downloader properties

Type of a property

Name of the property

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)

 

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)

 

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


11. Spring Cloud Contract WireMock

The Spring Cloud Contract WireMock modules let you use WireMock in a +properties

Table 10.2. SCM Stub Downloader properties

Type of a property

Name of the property

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)

 

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)

 

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


11. 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/spring-cloud-contract.xml b/spring-cloud-contract.xml index c68713c47f..d0cdd41d3b 100644 --- a/spring-cloud-contract.xml +++ b/spring-cloud-contract.xml @@ -9186,36 +9186,36 @@ properties * git.branch (plugin prop) -* stubrunner.properties.git.branch (system prop) -* STUBRUNNER_PROPERTIES_GIT_BRANCH (env 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) +* 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) +* 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) +* 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) +* 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 @@ -9247,57 +9247,57 @@ properties * pactbroker.host (plugin prop) -* stubrunner.properties.pactbroker.host (system prop) -* STUBRUNNER_PROPERTIES_PACTBROKER_HOST (env 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) +* 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) +* 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) +* 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) +* 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) +* stubrunner.properties.pactbroker.auth.username (system prop) +* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_USERNAME (env prop) 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) +* stubrunner.properties.pactbroker.auth.password (system prop) +* STUBRUNNER_PROPERTIES_PACTBROKER_AUTH_PASSWORD (env prop) 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) +* 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