From fe06f80d90c8e518c3223b0fea567795bc735242 Mon Sep 17 00:00:00 2001 From: buildmaster Date: Fri, 27 Jul 2018 12:38:28 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- ..._spring_cloud_contract_verifier_setup.html | 19 ++++------- ...lti__using_the_pluggable_architecture.html | 4 +-- single/spring-cloud-contract.html | 23 +++++-------- spring-cloud-contract.xml | 34 +++++++++++++------ 4 files changed, 41 insertions(+), 39 deletions(-) diff --git a/multi/multi__spring_cloud_contract_verifier_setup.html b/multi/multi__spring_cloud_contract_verifier_setup.html index 50464a6768..3caa543b77 100644 --- a/multi/multi__spring_cloud_contract_verifier_setup.html +++ b/multi/multi__spring_cloud_contract_verifier_setup.html @@ -135,19 +135,14 @@ from the Groovy DSL should be placed. By default its value is the Groovy DSL should be placed.
  • targetFramework: Specifies the target test framework to be used. Currently, Spock, JUnit 4 (TestFramework.JUNIT and JUnit 5 are supported with JUnit 4 being the default framework.
  • contractsProperties: a map containing properties to be passed to Spring Cloud Contract components. Those properties might be used by e.g. inbuilt or custom Stub Downloaders.

    • The following properties are used when you want to specify the location of the JAR -containing the contracts: -* contractDependency: Specifies the Dependency that provides +containing the contracts:

    4.1.10 Single Base Class for All Tests

    When using Spring Cloud Contract Verifier in default MockMvc, you need to create a base +closure to set it up.

  • contractsPath: Specifies the path to the jar. If contract dependencies are +downloaded, the path defaults to groupid/artifactid where groupid is slash +separated. Otherwise, it scans contracts under the provided directory.
  • contractsMode: Specifies the mode of downloading contracts (whether the +JAR is available offline, remotely etc.)
  • contractsSnapshotCheckSkip: If set to true will not assert whether the +downloaded stubs / contract JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact).
  • deleteStubsAfterTest: If set to false will not remove any downloaded +contracts from temporary directories

    • 4.1.10 Single Base Class for All Tests

    When using Spring Cloud Contract Verifier in default MockMvc, you need to create a base specification for all generated acceptance tests. In this class, you need to point to an endpoint, which should be verified.

    abstract class BaseMockMvcSpec extends Specification {
 
diff --git a/multi/multi__using_the_pluggable_architecture.html b/multi/multi__using_the_pluggable_architecture.html
index 50c9050cb5..4b250bde97 100644
--- a/multi/multi__using_the_pluggable_architecture.html
+++ b/multi/multi__using_the_pluggable_architecture.html
@@ -421,7 +421,7 @@ 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 10.1. SCM Stub Downloader properties
    Type of a property
    Name of the property
    Description
    * git.branch (plugin prop)
+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)
@@ -437,7 +437,7 @@ 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
    Name of a property
    Default
    Description
    * pactbroker.host (plugin prop)
+properties
    Table 10.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)
diff --git a/single/spring-cloud-contract.html b/single/spring-cloud-contract.html
index 307bc20818..7e208a7352 100644
--- a/single/spring-cloud-contract.html
+++ b/single/spring-cloud-contract.html
@@ -1518,19 +1518,14 @@ from the Groovy DSL should be placed. By default its value is
 the Groovy DSL should be placed.
  • targetFramework: Specifies the target test framework to be used. Currently, Spock, JUnit 4 (TestFramework.JUNIT and
 JUnit 5 are supported with JUnit 4 being the default framework.
  • contractsProperties: a map containing properties to be passed to Spring Cloud Contract
 components. Those properties might be used by e.g. inbuilt or custom Stub Downloaders.
    • The following properties are used when you want to specify the location of the JAR
-containing the contracts:
-* contractDependency: Specifies the Dependency that provides
+containing the contracts:
    • contractDependency: Specifies the Dependency that provides
 groupid:artifactid:version:classifier coordinates. You can use the contractDependency
-closure to set it up.
-* contractsPath: Specifies the path to the jar. If contract dependencies are
- downloaded, the path defaults to groupid/artifactid where groupid is slash
- separated. Otherwise, it scans contracts under the provided directory.
-* contractsMode: Specifies the mode of downloading contracts (whether the
-JAR is available offline, remotely etc.)
-* contractsSnapshotCheckSkip: If set to true will not assert whether the
-downloaded stubs / contract JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact).
-* deleteStubsAfterTest: If set to false will not remove any downloaded
-contracts from temporary directories
    4.1.10 Single Base Class for All Tests
    When using Spring Cloud Contract Verifier in default MockMvc, you need to create a base
+closure to set it up.
  • contractsPath: Specifies the path to the jar. If contract dependencies are
+downloaded, the path defaults to groupid/artifactid where groupid is slash
+separated. Otherwise, it scans contracts under the provided directory.
  • contractsMode: Specifies the mode of downloading contracts (whether the
+JAR is available offline, remotely etc.)
  • contractsSnapshotCheckSkip: If set to true will not assert whether the
+downloaded stubs / contract JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact).
  • deleteStubsAfterTest: If set to false will not remove any downloaded
+contracts from temporary directories
    • 4.1.10 Single Base Class for All Tests
    When using Spring Cloud Contract Verifier in default MockMvc, you need to create a base
 specification for all generated acceptance tests. In this class, you need to point to an
 endpoint, which should be verified.
    abstract class BaseMockMvcSpec extends Specification {
 
@@ -5932,7 +5927,7 @@ 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 10.1. SCM Stub Downloader properties
    Type of a property
    Name of the property
    Description
    * git.branch (plugin prop)
+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)
@@ -5948,7 +5943,7 @@ 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
    Name of a property
    Default
    Description
    * pactbroker.host (plugin prop)
+properties
    Table 10.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)
diff --git a/spring-cloud-contract.xml b/spring-cloud-contract.xml
index 8687d1ae73..fa5bba2369 100644
--- a/spring-cloud-contract.xml
+++ b/spring-cloud-contract.xml
@@ -2588,19 +2588,31 @@ components. Those properties might be used by e.g. inbuilt or custom Stub Downlo
 
 
 The following properties are used when you want to specify the location of the JAR
-containing the contracts:
-* contractDependency: Specifies the Dependency that provides
+containing the contracts:
+
+
+contractDependency: Specifies the Dependency that provides
 groupid:artifactid:version:classifier coordinates. You can use the contractDependency
-closure to set it up.
-* contractsPath: Specifies the path to the jar. If contract dependencies are
- downloaded, the path defaults to groupid/artifactid where groupid is slash
- separated. Otherwise, it scans contracts under the provided directory.
-* contractsMode: Specifies the mode of downloading contracts (whether the
-JAR is available offline, remotely etc.)
-* contractsSnapshotCheckSkip: If set to true will not assert whether the
-downloaded stubs / contract JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact).
-* deleteStubsAfterTest: If set to false will not remove any downloaded
+closure to set it up.
+
+
+contractsPath: Specifies the path to the jar. If contract dependencies are
+downloaded, the path defaults to groupid/artifactid where groupid is slash
+separated. Otherwise, it scans contracts under the provided directory.
+
+
+contractsMode: Specifies the mode of downloading contracts (whether the
+JAR is available offline, remotely etc.)
+
+
+contractsSnapshotCheckSkip: If set to true will not assert whether the
+downloaded stubs / contract JAR was downloaded from a remote location or a local one(only applicable to Maven repos, not Git or Pact).
+
+
+deleteStubsAfterTest: If set to false will not remove any downloaded
 contracts from temporary directories
+
+
 
 
    
 Single Base Class for All Tests