diff --git a/README.adoc b/README.adoc index bedf31a989..d8f382be32 100644 --- a/README.adoc +++ b/README.adoc @@ -4,18 +4,11 @@ Manual changes to this file will be lost when it is generated again. Edit the files in the src/main/asciidoc/ directory instead. //// -:branch: master -image::https://badges.gitter.im/Join%20Chat.svg[Gitter, link="https://gitter.im/spring-cloud/spring-cloud-contract?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"] -image::https://codecov.io/gh/spring-cloud/spring-cloud-contract/branch/{branch}/graph/badge.svg["codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-contract"] -image::https://circleci.com/gh/spring-cloud/spring-cloud-contract.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-contract"] -:introduction_url: ../../../.. -:verifier_core_path: {introduction_url}/spring-cloud-contract-verifier - == Spring Cloud Contract You always need confidence when pushing new features into a new application or service in -a distributed system. To that end, this project provides support for Consumer-driven -Contracts and service schemas in Spring applications, covering a range of options for +a distributed system. To that end, 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, and asserting that a contract is kept by producers and consumers -- for both HTTP and message-based interactions. @@ -25,10 +18,9 @@ If you prefer to learn about the project by doing some tutorials, you can check workshops under https://cloud-samples.spring.io/spring-cloud-contract-samples/workshops.html[this link]. -== Documentation +== Project page -You can read more about Spring Cloud Contract Verifier by reading the -{documentation_url}[docs] +You can read more about Spring Cloud Contract by going to https://spring.io/projects/spring-cloud-contract[the project page] == Contributing @@ -212,21 +204,21 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. -== How to build it +== How to Build Spring Cloud Contract IMPORTANT: You need to have all the necessary Groovy plugins - installed for your IDE to properly resolve the sources. For example in - Intellij IDEA having both Eclipse Groovy Compiler Plugin & GMavenPlus Intellij Plugin - results in properly imported project. +installed for your IDE to properly resolve the sources. For example, in +Intellij IDEA, having both the Eclipse Groovy Compiler Plugin and the GMavenPlus Intellij +Plugin results in properly imported project. IMPORTANT: Spring Cloud Contract builds Docker images. Remember to have Docker installed. -IMPORTANT: If you want to run the build in offline mode, you have to have Maven 3.5.2+ installed. +IMPORTANT: If you want to run the build in offline mode, you must have Maven 3.5.2+ installed. === Project structure -Here you can find the Spring Cloud Contract folder structure +The following listing shows the Spring Cloud Contract folder structure: ``` ├── config @@ -245,34 +237,38 @@ Here you can find the Spring Cloud Contract folder structure └── tests ``` - - `config` - folder contains setup for Spring Cloud Release Tools automated release process - - `docker` - folder contains docker images - - `samples` - folder contains test samples together with standalone ones used also to build documentation - - `scripts` - contains scripts to build and test `Spring Cloud Contract` with Maven, Gradle and standalone projects - - `specs` - contains specifications for the Contract DSL. - - `spring-cloud-contract-dependencies` - contains Spring Cloud Contract BOM - - `spring-cloud-contract-shade` - shaded dependencies used by the plugins - - `spring-cloud-contract-starters` - contains Spring Cloud Contract Starters - - `spring-cloud-contract-spec` - contains specification modules (contains concept of a Contract) - - `spring-cloud-contract-stub-runner` - contains Stub Runner related modules - - `spring-cloud-contract-stub-runner-boot` - contains Stub Runner Boot app - - `spring-cloud-contract-tools` - Gradle and Maven plugin for `Spring Cloud Contract Verifier` - - `spring-cloud-contract-verifier` - core of the `Spring Cloud Contract Verifier` functionality - - `spring-cloud-contract-wiremock` - all WireMock related functionality - - `tests` - integration tests for different messaging technologies +The following list describes each of the top-level folders in the project structure: + +- `config`: Folder contains setup for Spring Cloud Release Tools automated release process +- `docker`: Folder contains docker images +- `samples`: Folder contains test samples together with standalone ones used also to build documentation +- `scripts`: Contains scripts to build and test `Spring Cloud Contract` with Maven, Gradle and standalone projects +- `specs`: Contains specifications for the Contract DSL. +- `spring-cloud-contract-dependencies`: Contains Spring Cloud Contract BOM +- `spring-cloud-contract-shade`: Shaded dependencies used by the plugins +- `spring-cloud-contract-starters`: Contains Spring Cloud Contract Starters +- `spring-cloud-contract-spec`: Contains specification modules (contains concept of a Contract) +- `spring-cloud-contract-stub-runner`: Contains Stub Runner related modules +- `spring-cloud-contract-stub-runner-boot`: Contains Stub Runner Boot app +- `spring-cloud-contract-tools`: Gradle and Maven plugin for `Spring Cloud Contract Verifier` +- `spring-cloud-contract-verifier`: Core of the `Spring Cloud Contract Verifier` functionality +- `spring-cloud-contract-wiremock`: All WireMock related functionality +- `tests`: Integration tests for different messaging technologies === Commands -To build the core functionality together with Maven Plugin you can run +To build the core functionality together with the Maven Plugin, you can run the following +command: ``` ./mvnw clean install -P integration ``` -Calling that function will build core, Maven plugin, Gradle plugin and run end to end tests on the -standalone samples in proper order (both for Maven and Gradle). +Calling that function builds the core, the Maven plugin, and the Gradle plugin and runs +end-to_end tests on the +standalone samples in the proper order (both for Maven and Gradle). -To build the Gradle Plugin only +To build only the Gradle Plugin, you can run the following commands: ``` cd spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin @@ -281,34 +277,37 @@ cd spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin === Helpful scripts -We're providing a couple of helpful scripts to build the project. +We provide a couple of helpful scripts to build the project. -To build the project in parallel (by default uses 4 cores but you can change it) +To build the project in parallel (by default, it uses four cores, but you can change it), +run the following command: ``` ./scripts/parallelBuild.sh ``` -and with 8 cores +To use eight 8 cores, run thke following command: ``` CORES=8 ./scripts/parallelBuild.sh ``` -To build the project without any integration tests (by default uses 1 core) +To build the project without any integration tests (by default, this uses one core), run +the following command: ``` ./scripts/noIntegration.sh ``` -and with 8 cores +To use eight cores, run the following command: ``` CORES=8 ./scripts/noIntegration.sh ``` -To generate the documentation (both the root one and the maven plugin one) +To generate the documentation (for both the root project and the maven plugin), run the +following command: ``` ./scripts/generateDocs.sh -``` +``` \ No newline at end of file diff --git a/docs/src/main/asciidoc/README.adoc b/docs/src/main/asciidoc/README.adoc index cde64a13e5..aaf76dd536 100644 --- a/docs/src/main/asciidoc/README.adoc +++ b/docs/src/main/asciidoc/README.adoc @@ -1,15 +1,8 @@ -:branch: master -image::https://badges.gitter.im/Join%20Chat.svg[Gitter, link="https://gitter.im/spring-cloud/spring-cloud-contract?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"] -image::https://codecov.io/gh/spring-cloud/spring-cloud-contract/branch/{branch}/graph/badge.svg["codecov", link="https://codecov.io/gh/spring-cloud/spring-cloud-contract"] -image::https://circleci.com/gh/spring-cloud/spring-cloud-contract.svg?style=svg["CircleCI", link="https://circleci.com/gh/spring-cloud/spring-cloud-contract"] -:introduction_url: ../../../.. -:verifier_core_path: {introduction_url}/spring-cloud-contract-verifier - == Spring Cloud Contract You always need confidence when pushing new features into a new application or service in -a distributed system. To that end, this project provides support for Consumer-driven -Contracts and service schemas in Spring applications, covering a range of options for +a distributed system. To that end, 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, and asserting that a contract is kept by producers and consumers -- for both HTTP and message-based interactions. @@ -19,13 +12,12 @@ If you prefer to learn about the project by doing some tutorials, you can check workshops under https://cloud-samples.spring.io/spring-cloud-contract-samples/workshops.html[this link]. -== Documentation +== Project page -You can read more about Spring Cloud Contract Verifier by reading the -{documentation_url}[docs] +You can read more about Spring Cloud Contract by going to https://spring.io/projects/spring-cloud-contract[the project page] == Contributing include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] -include::building.adoc[] +include::_building.adoc[] diff --git a/docs/src/main/asciidoc/spring-cloud-contract-verifier.adoc b/docs/src/main/asciidoc/_attributes.adoc similarity index 56% rename from docs/src/main/asciidoc/spring-cloud-contract-verifier.adoc rename to docs/src/main/asciidoc/_attributes.adoc index 1dd900ca53..99a2353223 100644 --- a/docs/src/main/asciidoc/spring-cloud-contract-verifier.adoc +++ b/docs/src/main/asciidoc/_attributes.adoc @@ -1,5 +1,22 @@ -:core_path: ../../.. -:plugins_path: ../../../spring-cloud-contract-tools +:doctype: book +:idprefix: +:idseparator: - +:toc: left +:toclevels: 4 +:tabsize: 4 +:numbered: +:sectanchors: +:sectnums: +:icons: font +:hide-uri-scheme: +:docinfo: shared,private + +:sc-ext: java +:project-full-name: Spring Cloud Contract + +// project-specific attributes +:core_path: {project-root} +:plugins_path: {project-root}/spring-cloud-contract-tools :converters_path: {plugins_path}/spring-cloud-contract-converters :verifier_root_path: {core_path}/spring-cloud-contract-verifier :contract_spec_path: {core_path}/specs/spring-cloud-contract-spec-java @@ -12,20 +29,9 @@ :standalone_pact_path: {samples_path}/standalone/pact :standalone_restdocs_path: {samples_path}/standalone/restdocs :tests_path: {core_path}/tests -:samples_branch: 2.1.x +:samples_branch: 2.2.x :samples_url: https://raw.githubusercontent.com/spring-cloud-samples/spring-cloud-contract-samples/{samples_branch} -:introduction_url: ${core_path}/../../ - -include::verifier_introduction.adoc[] - -include::verifier_faq.adoc[] - -include::verifier_setup.adoc[] - -include::verifier_messaging.adoc[] - -include::verifier_stubrunner.adoc[] - -include::verifier_stubrunner_msg.adoc[] - -include::verifier_contract.adoc[] \ No newline at end of file +:samples_code: https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/ +:doc_samples: {core_path}/samples/wiremock-jetty +:wiremock_tests: {core_path}/spring-cloud-contract-wiremock +:introduction_url: {core_path} \ No newline at end of file diff --git a/docs/src/main/asciidoc/_building.adoc b/docs/src/main/asciidoc/_building.adoc new file mode 100644 index 0000000000..57c00a928d --- /dev/null +++ b/docs/src/main/asciidoc/_building.adoc @@ -0,0 +1,107 @@ +== How to Build Spring Cloud Contract + +IMPORTANT: You need to have all the necessary Groovy plugins +installed for your IDE to properly resolve the sources. For example, in +Intellij IDEA, having both the Eclipse Groovy Compiler Plugin and the GMavenPlus Intellij +Plugin results in properly imported project. + +IMPORTANT: Spring Cloud Contract builds Docker images. Remember to +have Docker installed. + +IMPORTANT: If you want to run the build in offline mode, you must have Maven 3.5.2+ installed. + +=== Project structure + +The following listing shows the Spring Cloud Contract folder structure: + +``` +├── config +├── docker +├── samples +├── scripts +├── specs +├── spring-cloud-contract-dependencies +├── spring-cloud-contract-shade +├── spring-cloud-contract-starters +├── spring-cloud-contract-stub-runner +├── spring-cloud-contract-stub-runner-boot +├── spring-cloud-contract-tools +├── spring-cloud-contract-verifier +├── spring-cloud-contract-wiremock +└── tests +``` + +The following list describes each of the top-level folders in the project structure: + +- `config`: Folder contains setup for Spring Cloud Release Tools automated release process +- `docker`: Folder contains docker images +- `samples`: Folder contains test samples together with standalone ones used also to build documentation +- `scripts`: Contains scripts to build and test `Spring Cloud Contract` with Maven, Gradle and standalone projects +- `specs`: Contains specifications for the Contract DSL. +- `spring-cloud-contract-dependencies`: Contains Spring Cloud Contract BOM +- `spring-cloud-contract-shade`: Shaded dependencies used by the plugins +- `spring-cloud-contract-starters`: Contains Spring Cloud Contract Starters +- `spring-cloud-contract-spec`: Contains specification modules (contains concept of a Contract) +- `spring-cloud-contract-stub-runner`: Contains Stub Runner related modules +- `spring-cloud-contract-stub-runner-boot`: Contains Stub Runner Boot app +- `spring-cloud-contract-tools`: Gradle and Maven plugin for `Spring Cloud Contract Verifier` +- `spring-cloud-contract-verifier`: Core of the `Spring Cloud Contract Verifier` functionality +- `spring-cloud-contract-wiremock`: All WireMock related functionality +- `tests`: Integration tests for different messaging technologies + +=== Commands + +To build the core functionality together with the Maven Plugin, you can run the following +command: + +``` +./mvnw clean install -P integration +``` + +Calling that function builds the core, the Maven plugin, and the Gradle plugin and runs +end-to_end tests on the +standalone samples in the proper order (both for Maven and Gradle). + +To build only the Gradle Plugin, you can run the following commands: + +``` +cd spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin +./gradlew clean build +``` + +=== Helpful scripts + +We provide a couple of helpful scripts to build the project. + +To build the project in parallel (by default, it uses four cores, but you can change it), +run the following command: + +``` +./scripts/parallelBuild.sh +``` + +To use eight 8 cores, run thke following command: + +``` +CORES=8 ./scripts/parallelBuild.sh +``` + +To build the project without any integration tests (by default, this uses one core), run +the following command: + +``` +./scripts/noIntegration.sh +``` + +To use eight cores, run the following command: + +``` +CORES=8 ./scripts/noIntegration.sh +``` + +To generate the documentation (for both the root project and the maven plugin), run the +following command: + +``` +./scripts/generateDocs.sh +``` diff --git a/docs/src/main/asciidoc/_project-features-contract.adoc b/docs/src/main/asciidoc/_project-features-contract.adoc new file mode 100644 index 0000000000..45a90de82f --- /dev/null +++ b/docs/src/main/asciidoc/_project-features-contract.adoc @@ -0,0 +1,1376 @@ +[[contract-dsl]] +== Contract DSL +include::_attributes.adoc[] + +Spring Cloud Contract supports the DSLs written in the following languages: + +* Groovy +* YAML + +TIP: If you are not familiar with Groovy, do not worry - you can use Java syntax in the +Groovy DSL files as well. + +If you decide to write the contract in Groovy, do not be alarmed if you have not used Groovy +before. Knowledge of the language is not really needed, as the Contract DSL uses only a +tiny subset of it (only literals, method calls, and closures). Also, the DSL is statically +typed, to make it programmer-readable without any knowledge of the DSL itself. + +IMPORTANT: Remember that, inside the Groovy contract file, you have to provide the fully +qualified name to the `Contract` class and `make` static imports, such as +`org.springframework.cloud.spec.Contract.make { ... }`. You can also provide an import to +the `Contract` class (`import org.springframework.cloud.spec.Contract`) and then call +`Contract.make { ... }`. + +TIP: Spring Cloud Contract supports defining multiple contracts in a single file. + +The following example shows a contract definition: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=dsl_example,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_rest.yml[indent=0] +---- +==== + + +[TIP] +==== +You can compile contracts to stubs mapping by using the following standalone Maven command: + +---- +mvn org.springframework.cloud:spring-cloud-contract-maven-plugin:convert +---- +==== + +[[contract-limitations]] +=== Limitations + +WARNING: The support for verifying the size of JSON arrays is experimental. If you want +to turn it on, set the value of the following system property to `true`: +`spring.cloud.contract.verifier.assert.size`. By default, this feature is set to `false`. +You can also set the `assertJsonSize` property in the plugin configuration. + +WARNING: Because JSON structure can have any form, it can be impossible to parse it +properly when using the Groovy DSL and the `value(consumer(...), producer(...))` notation in `GString`. That +is why you should use the Groovy Map notation. + +[[contract-common-top-elements]] +=== Common Top-Level Elements + +The following sections describe the most common top-level elements: + +* <> +* <> +* <> +* <> + +[[contract-dsl-description]] +==== Description + +You can add a `description` to your contract. The description is arbitrary text. The +following code shows an example: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{contract_spec_tests_path}/src/test/groovy/org/springframework/cloud/contract/spec/internal/ContractSpec.groovy[tags=description,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_rest.yml[indent=0] +---- +==== + +[[contract-dsl-name]] +==== Name + +You can provide a name for your contract. Assume that you provided the following name: +`should register a user`. If you do so, the name of the autogenerated test is +`validate_should_register_a_user`. Also, the name of the stub in a WireMock stub is +`should_register_a_user.json`. + +IMPORTANT: You must ensure that the name does not contain any characters that make the +generated test not compile. Also, remember that, if you provide the same name for +multiple contracts, your autogenerated tests fail to compile and your generated stubs +override each other. + +The following example shows how to add a name to a contract: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{contract_spec_tests_path}/src/test/groovy/org/springframework/cloud/contract/spec/internal/ContractSpec.groovy[tags=name,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=name,indent=0] +---- +==== + +[[contract-dsl-ignoring-contracts]] +==== Ignoring Contracts + +If you want to ignore a contract, you can either set a value for ignored contracts in the +plugin configuration or set the `ignored` property on the contract itself. The following +example shows how to do so: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{contract_spec_tests_path}/src/test/groovy/org/springframework/cloud/contract/spec/internal/ContractSpec.groovy[tags=ignored,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=ignored,indent=0] +---- +==== + +[[contract-dsl-passing-values-from-files]] +==== Passing Values from Files + +Starting with version `1.2.0`, you can pass values from files. Assume that you have the +following resources in your project: + +[source,bash,indent=0] +---- +└── src +    └── test +       └── resources +          └── contracts +    ├── readFromFile.groovy +    ├── request.json +    └── response.json +---- + +Further assume that your contract is as follows: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/resources/classpath/readFromFile.groovy[indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_from_file.yml[indent=0] +---- +==== + +Further assume that the JSON files is as follows: + +==== +[source,json,indent=0,subs="verbatim,attributes",role="primary"] +.request.json +---- +include::{verifier_core_path}/src/test/resources/classpath/request.json[indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.response.json +---- +include::{verifier_core_path}/src/test/resources/classpath/response.json[indent=0] +---- +==== + +When test or stub generation takes place, the contents of the `request.json` and `response.json` files are passed to the body +of a request or a response. The name of the file needs to be a file with location +relative to the folder in which the contract lays. + +If you need to pass the contents of a file in binary form, +you can use the `fileAsBytes` method in Groovy DSL or a `bodyFromFileAsBytes` field in YAML. + +The following example shows how to pass the contents of binary files: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/resources/body_builder/worksWithPdf.groovy[indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_pdf.yml[indent=0] +---- +==== + +IMPORTANT: You should use this approach whenever you want to work with binary payloads, + both for HTTP and messaging. + +[[features-http]] +== Contracts for HTTP + +Spring Cloud Contract lets you verify applications that use REST or HTTP as a +means of communication. Spring Cloud Contract verifies that, for a request that matches the +criteria from the `request` part of the contract, the server provides a response that is in +keeping with the `response` part of the contract. Subsequently, the contracts are used to +generate WireMock stubs that, for any request matching the provided criteria, provide a +suitable response. + +[[contract-dsl-http-top-level-elements]] +=== HTTP Top-Level Elements + +You can call the following methods in the top-level closure of a contract definition: + +* `request`: Mandatory +* `response` : Mandatory +* `priority`: Optional + +The following example shows how to define an HTTP request contract: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=http_dsl,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=priority,indent=0] +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] +... +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=response,indent=0] +... +---- +==== + +IMPORTANT: If you want to make your contract have a higher priority, +you need to pass a lower number to the `priority` tag or method. For example, a `priority` with +a value of `5` has higher priority than a `priority` with a value of `10`. + +[[contract-dsl-request]] +=== HTTP Request + +The HTTP protocol requires only the method and the URL to be specified in a request. The +same information is mandatory in request definition of the contract. + +The following example shows a contract for a request: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=request,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request_obligatory,indent=0] +---- +==== + +You can specify an absolute rather than a relative `url`, but using `urlPath` is +the recommended way, as doing so makes the tests be host-independent. + +The following example uses `url`: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=url,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_rest_with_path.yml[tags=url_path,indent=0] +---- +==== + +`request` may contain query parameters, as the following example (which uses `urlPath`) shows: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=urlpath,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] +... +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=query_params,indent=0] +---- +==== + +`request` can contain additional request headers, as the following example shows: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=headers,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] +... +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=headers,indent=0] +---- +==== + +`request` may contain additional request cookies, as the following example shows: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=cookies,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] +... +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=cookies,indent=0] +---- +==== + +`request` may contain a request body, as the following example shows: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=body,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] +... +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=body,indent=0] +---- +==== + +`request` can contain multipart elements. To include multipart elements, use the +`multipart` method/section, as the following examples show: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=multipartdsl,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_multipart.yml[indent=0] +---- +==== + +In the preceding example, we define parameters in either of two ways: + +.Groovy DSL +* Directly, by using the map notation, where the value can be a dynamic property (such as +`formParameter: $(consumer(...), producer(...))`). +* By using the `named(...)` method that lets you set a named parameter. A named parameter +can set a `name` and `content`. You can call it either by using a method with two arguments, +such as `named("fileName", "fileContent")`, or by using a map notation, such as +`named(name: "fileName", content: "fileContent")`. + +.YAML +* The multipart parameters are set in the `multipart.params` section. +* The named parameters (the `fileName` and `fileContent` for a given parameter name) +can be set in the `multipart.named` section. That section contains +the `paramName` (the name of the parameter), `fileName` (the name of the file), +`fileContent` (the content of the file) fields. +* The dynamic bits can be set via the `matchers.multipart` section. +** For parameters, use the `params` section, which can accept +`regex` or a `predefined` regular expression. +** for named params, use the `named` section where first you +define the parameter name with `paramName`. Then you can pass the +parametrization of either `fileName` or `fileContent` in a +`regex` or in a `predefined` regular expression. + +From the contract in the preceding example, the generated test and stubs look as follows: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.Test +---- +// given: + MockMvcRequestSpecification request = given() + .header("Content-Type", "multipart/form-data;boundary=AaB03x") + .param("formParameter", "\"formParameterValue\"") + .param("someBooleanParameter", "true") + .multiPart("file", "filename.csv", "file content".getBytes()); + + // when: + ResponseOptions response = given().spec(request) + .put("/multipart"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); +---- + +[source,json,indent=0,subs="verbatim,attributes",role="secondary"] +.Stub +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockGroovyDslSpec.groovy[tags=multipartwiremock,indent=0] +---- +==== + +[[contract-dsl-response]] +=== HTTP Response + +The response must contain an HTTP status code and may contain other information. The +following code shows an example: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=response,indent=0] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=response,indent=0] +... +include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=response_obligatory,indent=0] +---- +==== + +Besides status, the response may contain headers, cookies, and a body, which are +specified the same way as in the request (see <>). + +TIP: In the Groovy DSL, you can reference the `org.springframework.cloud.contract.spec.internal.HttpStatus` +methods to provide a meaningful status instead of a digit. For example, you can call +`OK()` for a status `200` or `BAD_REQUEST()` for `400`. + +[[contract-dsl-dynamic-properties]] +=== Dynamic properties + +The contract can contain some dynamic properties: timestamps, IDs, and so on. You do not +want to force the consumers to stub their clocks to always return the same value of time +so that it gets matched by the stub. + +For the Groovy DSL, you can provide the dynamic parts in your contracts +in two ways: pass them directly in the body or set them in a separate section called +`bodyMatchers`. + +NOTE: Before 2.0.0, these were set by using `testMatchers` and `stubMatchers`. +See the https://github.com/spring-cloud/spring-cloud-contract/wiki/Spring-Cloud-Contract-2.0-Migration-Guide[migration guide] for more information. + +For YAML, you can use only the `matchers` section. + +[[contract-dsl-dynamic-properties-in-body]] +==== Dynamic Properties inside the Body + +IMPORTANT: This section is valid only for the Groovy DSL. Check out the +<> section for YAML examples of a similar feature. + +You can set the properties inside the body either with the `value` method or, if you use +the Groovy map notation, with `$()`. The following example shows how to set dynamic +properties with the value method: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.value +---- +value(consumer(...), producer(...)) +value(c(...), p(...)) +value(stub(...), test(...)) +value(client(...), server(...)) +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.$ +---- +$(consumer(...), producer(...)) +$(c(...), p(...)) +$(stub(...), test(...)) +$(client(...), server(...)) +---- +==== + +Both approaches work equally well. The `stub` and `client` methods are aliases over the `consumer` +method. Subsequent sections take a closer look at what you can do with those values. + +[[contract-dsl-regex]] +==== Regular Expressions + +IMPORTANT: This section is valid only for Groovy DSL. Check out the +<> section for YAML examples of a similar feature. + +You can use regular expressions to write your requests in the contract DSL. Doing so is +particularly useful when you want to indicate that a given response should be provided +for requests that follow a given pattern. Also, you can use regular expressions when you +need to use patterns and not exact values both for your tests and your server-side tests. + +Make sure that regex matches a whole region of a sequence, as, internally, a call to +https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#matches[`Pattern.matches()`] +is called. For instance, `abc` does not match `aabc`, but `.abc` does. +There are several additional <> as well. + +The following example shows how to use regular expressions to write a request: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=regex,indent=0] +---- + +You can also provide only one side of the communication with a regular expression. If you +do so, then the contract engine automatically provides the generated string that matches +the provided regular expression. The following code shows an example: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=dsl_one_side_data_generation_example,indent=0] +---- + +In the preceding example, the opposite side of the communication has the respective data +generated for request and response. + +Spring Cloud Contract comes with a series of predefined regular expressions that you can +use in your contracts, as the following example shows: + +[source,java,indent=0] +---- +include::{contract_spec_path}/src/main/java/org/springframework/cloud/contract/spec/internal/RegexPatterns.java[tags=regexps,indent=0] +---- + +In your contract, you can use it as follows: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=contract_with_regex,indent=0] +---- + +To make matters even simpler, you can use a set of predefined objects that automatically +assume that you want a regular expression to be passed. +All of those methods start with the `any` prefix, as follows: + +[source,java,indent=0] +---- +include::{contract_spec_path}/src/main/java/org/springframework/cloud/contract/spec/internal/RegexCreatingProperty.java[tags=regex_creating_props,indent=0] +---- + +The following example shows how you can reference those methods: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=regex_creating_props,indent=0] +---- + +[[contract-dsl-regex-limitations]] +===== Limitations + +WARNING: Due to certain limitations of the `Xeger` library that generates a string out of +a regex, do not use the `$` and `^` signs in your regex if you rely on automatic +generation. See https://github.com/spring-cloud/spring-cloud-contract/issues/899[Issue 899]. + +WARNING: Do not use a `LocalDate` instance as a value for `$` (for example, `$(consumer(LocalDate.now()))`). +It causes a `java.lang.StackOverflowError`. Use `$(consumer(LocalDate.now().toString()))` instead. +See https://github.com/spring-cloud/spring-cloud-contract/issues/900[Issue 900]. + +[[contract-dsl-optional-params]] +==== Passing Optional Parameters + +IMPORTANT: This section is valid only for Groovy DSL. Check out the +<> section for YAML examples of a similar feature. + +You can provide optional parameters in your contract. However, you can provide +optional parameters only for the following: + +* The STUB side of the Request +* The TEST side of the Response + +The following example shows how to provide optional parameters: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=optionals,indent=0] +---- + +By wrapping a part of the body with the `optional()` method, you create a regular +expression that must be present 0 or more times. + +If you use Spock, the following test would be generated from the previous example: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=optionals_test,indent=0] +---- + +The following stub would also be generated: + +[source,groovy,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy[tags=wiremock,indent=0] +---- + +[[contract-dsl-custom-methods]] +==== Executing Custom Methods on the Server Side + +IMPORTANT: This section is valid only for Groovy DSL. Check out the +<> section for YAML examples of a similar feature. + +You can define a method call that runs on the server side during the test. Such a +method can be added to the class defined as `baseClassForTests` in the configuration. The +following code shows an example of the contract portion of the test case: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=method,indent=0] +---- + +The following code shows the base class portion of the test case: + +[source,groovy,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0] +---- + +IMPORTANT: You cannot use both a `String` and `execute` to perform concatenation. For +example, calling `header('Authorization', 'Bearer ' + execute('authToken()'))` leads to +improper results. Instead, call `header('Authorization', execute('authToken()'))` and +ensure that the `authToken()` method returns everything you need. + +The type of the object read from the JSON can be one of the following, depending on the +JSON path: + +* `String`: If you point to a `String` value in the JSON. +* `JSONArray`: If you point to a `List` in the JSON. +* `Map`: If you point to a `Map` in the JSON. +* `Number`: If you point to `Integer`, `Double`, and other numeric type in the JSON. +* `Boolean`: If you point to a `Boolean` in the JSON. + +In the request part of the contract, you can specify that the `body` should be taken from +a method. + +IMPORTANT: You must provide both the consumer and the producer side. The `execute` part +is applied for the whole body, not for parts of it. + +The following example shows how to read an object from JSON: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilderSpec.groovy[tags=body_execute,indent=0] +---- + +The preceding example results in calling the `hashCode()` method in the request body. +It should resemble the following code: + +[source,java,indent=0] +---- + // given: + MockMvcRequestSpecification request = given() + .body(hashCode()); + + // when: + ResponseOptions response = given().spec(request) + .get("/something"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); +---- + +[[contract-dsl-referencing-request-from-response]] +==== Referencing the Request from the Response + +The best situation is to provide fixed values, but sometimes you need to reference a +request in your response. + +If you write contracts in the Groovy DSL, you can use the `fromRequest()` method, which lets +you reference a bunch of elements from the HTTP request. You can use the following +options: + +* `fromRequest().url()`: Returns the request URL and query parameters. +* `fromRequest().query(String key)`: Returns the first query parameter with a given name. +* `fromRequest().query(String key, int index)`: Returns the nth query parameter with a +given name. +* `fromRequest().path()`: Returns the full path. +* `fromRequest().path(int index)`: Returns the nth path element. +* `fromRequest().header(String key)`: Returns the first header with a given name. +* `fromRequest().header(String key, int index)`: Returns the nth header with a given name. +* `fromRequest().body()`: Returns the full request body. +* `fromRequest().body(String jsonPath)`: Returns the element from the request that +matches the JSON Path. + +If you use the YAML contract definition, you have to use the +https://handlebarsjs.com/[Handlebars] `{{{ }}}` notation with custom Spring Cloud Contract +functions to achieve this. In that case, you can use the following options: + +* `{{{ request.url }}}`: Returns the request URL and query parameters. +* `{{{ request.query.key.[index] }}}`: Returns the nth query parameter with a given name. +For example, for a key of `thing`, the first entry is `{{{ request.query.thing.[0] }}}` +* `{{{ request.path }}}`: Returns the full path. +* `{{{ request.path.[index] }}}`: Returns the nth path element. For example, +the first entry is ```{{{ request.path.[0] }}} +* `{{{ request.headers.key }}}`: Returns the first header with a given name. +* `{{{ request.headers.key.[index] }}}`: Returns the nth header with a given name. +* `{{{ request.body }}}`: Returns the full request body. +* `{{{ jsonpath this 'your.json.path' }}}`: Returns the element from the request that +matches the JSON Path. For example, for a JSON path of `$.here`, use `{{{ jsonpath this '$.here' }}}` + +Consider the following contract: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=template_contract,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_reference_request.yml[indent=0] +---- +==== + +Running a JUnit test generation leads to a test that resembles the following example: + +[source,java,indent=0] +---- + // given: + MockMvcRequestSpecification request = given() + .header("Authorization", "secret") + .header("Authorization", "secret2") + .body("{\"foo\":\"bar\",\"baz\":5}"); + + // when: + ResponseOptions response = given().spec(request) + .queryParam("foo","bar") + .queryParam("foo","bar2") + .get("/api/v1/xxxx"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); + assertThat(response.header("Authorization")).isEqualTo("foo secret bar"); + // and: + DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); + assertThatJson(parsedJson).field("['fullBody']").isEqualTo("{\"foo\":\"bar\",\"baz\":5}"); + assertThatJson(parsedJson).field("['authorization']").isEqualTo("secret"); + assertThatJson(parsedJson).field("['authorization2']").isEqualTo("secret2"); + assertThatJson(parsedJson).field("['path']").isEqualTo("/api/v1/xxxx"); + assertThatJson(parsedJson).field("['param']").isEqualTo("bar"); + assertThatJson(parsedJson).field("['paramIndex']").isEqualTo("bar2"); + assertThatJson(parsedJson).field("['pathIndex']").isEqualTo("v1"); + assertThatJson(parsedJson).field("['responseBaz']").isEqualTo(5); + assertThatJson(parsedJson).field("['responseFoo']").isEqualTo("bar"); + assertThatJson(parsedJson).field("['url']").isEqualTo("/api/v1/xxxx?foo=bar&foo=bar2"); + assertThatJson(parsedJson).field("['responseBaz2']").isEqualTo("Bla bla bar bla bla"); +---- + +As you can see, elements from the request have been properly referenced in the response. + +The generated WireMock stub should resemble the following example: + +[source,json,indent=0] +---- +{ + "request" : { + "urlPath" : "/api/v1/xxxx", + "method" : "POST", + "headers" : { + "Authorization" : { + "equalTo" : "secret2" + } + }, + "queryParameters" : { + "foo" : { + "equalTo" : "bar2" + } + }, + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.['baz'] == 5)]" + }, { + "matchesJsonPath" : "$[?(@.['foo'] == 'bar')]" + } ] + }, + "response" : { + "status" : 200, + "body" : "{\"authorization\":\"{{{request.headers.Authorization.[0]}}}\",\"path\":\"{{{request.path}}}\",\"responseBaz\":{{{jsonpath this '$.baz'}}} ,\"param\":\"{{{request.query.foo.[0]}}}\",\"pathIndex\":\"{{{request.path.[1]}}}\",\"responseBaz2\":\"Bla bla {{{jsonpath this '$.foo'}}} bla bla\",\"responseFoo\":\"{{{jsonpath this '$.foo'}}}\",\"authorization2\":\"{{{request.headers.Authorization.[1]}}}\",\"fullBody\":\"{{{escapejsonbody}}}\",\"url\":\"{{{request.url}}}\",\"paramIndex\":\"{{{request.query.foo.[1]}}}\"}", + "headers" : { + "Authorization" : "{{{request.headers.Authorization.[0]}}};foo" + }, + "transformers" : [ "response-template" ] + } +} +---- + +Sending a request such as the one presented in the `request` part of the contract results +in sending the following response body: + +[source,json,indent=0] +---- +{ + "url" : "/api/v1/xxxx?foo=bar&foo=bar2", + "path" : "/api/v1/xxxx", + "pathIndex" : "v1", + "param" : "bar", + "paramIndex" : "bar2", + "authorization" : "secret", + "authorization2" : "secret2", + "fullBody" : "{\"foo\":\"bar\",\"baz\":5}", + "responseFoo" : "bar", + "responseBaz" : 5, + "responseBaz2" : "Bla bla bar bla bla" +} +---- + +IMPORTANT: This feature works only with WireMock versions greater than or equal +to 2.5.1. The Spring Cloud Contract Verifier uses WireMock's +`response-template` response transformer. It uses Handlebars to convert the Mustache `{{{ }}}` templates into +proper values. Additionally, it registers two helper functions: + +* `escapejsonbody`: Escapes the request body in a format that can be embedded in a JSON. +* `jsonpath`: For a given parameter, find an object in the request body. + +[[contract-dsl-matchers]] +==== Dynamic Properties in the Matchers Sections + +If you work with https://docs.pact.io/[Pact], the following discussion may seem familiar. +Quite a few users are used to having a separation between the body and setting the +dynamic parts of a contract. + +You can use the `bodyMatchers` section for two reasons: + +* Define the dynamic values that should end up in a stub. +You can set it in the `request` or `inputMessage` part of your contract. +* Verify the result of your test. +This section is present in the `response` or `outputMessage` side of the +contract. + +Currently, Spring Cloud Contract Verifier supports only JSON path-based matchers with the +following matching possibilities: + +===== Groovy DSL + +* For the stubs (in tests on the consumer's side): +** `byEquality()`: The value taken from the consumer's request in the provided JSON path must be +equal to the value provided in the contract. +** `byRegex(...)`: The value taken from the consumer's request in the provided JSON path must +match the regex. You can also pass the type of the expected matched value (for example, `asString()`, `asLong()`, and so on). +** `byDate()`: The value taken from the consumer's request in the provided JSON path must +match the regex for an ISO Date value. +** `byTimestamp()`: The value taken from the consumer's request in the provided JSON path must +match the regex for an ISO DateTime value. +** `byTime()`: The value taken from the consumer's request in the provided JSON path must +match the regex for an ISO Time value. +* For the verification (in generated tests on the Producer's side): +** `byEquality()`: The value taken from the producer's response in the provided JSON path must be +equal to the provided value in the contract. +** `byRegex(...)`: The value taken from the producer's response in the provided JSON path must +match the regex. +** `byDate()`: The value taken from the producer's response in the provided JSON path must match +the regex for an ISO Date value. +** `byTimestamp()`: The value taken from the producer's response in the provided JSON path must +match the regex for an ISO DateTime value. +** `byTime()`: The value taken from the producer's response in the provided JSON path must match +the regex for an ISO Time value. +** `byType()`: The value taken from the producer's response in the provided JSON path needs to be +of the same type as the type defined in the body of the response in the contract. +`byType` can take a closure, in which you can set `minOccurrence` and `maxOccurrence`. For the +request side, you should use the closure to assert size of the collection. +That way, you can assert the size of the flattened collection. To check the size of an +unflattened collection, use a custom method with the `byCommand(...)` `testMatcher`. +** `byCommand(...)`: The value taken from the producer's response in the provided JSON path is +passed as an input to the custom method that you provide. For example, +`byCommand('thing($it)')` results in calling a `thing` method to which the value matching the +JSON Path gets passed. The type of the object read from the JSON can be one of the +following, depending on the JSON path: +*** `String`: If you point to a `String` value. +*** `JSONArray`: If you point to a `List`. +*** `Map`: If you point to a `Map`. +*** `Number`: If you point to `Integer`, `Double`, or another kind of number. +*** `Boolean`: If you point to a `Boolean`. +** `byNull()`: The value taken from the response in the provided JSON path must be null. + +===== YAML + +NOTE: See the Groovy section for detailed explanation of +what the types mean. + +For YAML, the structure of a matcher resembles the following example: + +[source,yml,indent=0] +---- +- path: $.thing1 + type: by_regex + value: thing2 + regexType: as_string +---- + +Alternatively, if you want to use one of the predefined regular expressions +`[only_alpha_unicode, number, any_boolean, ip_address, hostname, +email, url, uuid, iso_date, iso_date_time, iso_time, iso_8601_with_offset, non_empty, +non_blank]`, you can use something similar to the following example: + +[source,yml,indent=0] +---- +- path: $.thing1 + type: by_regex + predefined: only_alpha_unicode +---- + +The following list shows the allowed list of `type` values: + +* For `stubMatchers`: +** `by_equality` +** `by_regex` +** `by_date` +** `by_timestamp` +** `by_time` +** `by_type` +*** Two additional fields (`minOccurrence` and `maxOccurrence`) are accepted. +* For `testMatchers`: +** `by_equality` +** `by_regex` +** `by_date` +** `by_timestamp` +** `by_time` +** `by_type` +*** Two additional fields (`minOccurrence` and `maxOccurrence`) are accepted. +** `by_command` +** `by_null` + +You can also define which type the regular expression corresponds to in the `regexType` +field. The following list shows the allowed regular expression types: + +* `as_integer` +* `as_double` +* `as_float` +* `as_long` +* `as_short` +* `as_boolean` +* `as_string` + +Consider the following example: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcMethodBodyBuilderWithMatchersSpec.groovy[tags=matchers,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_matchers.yml[indent=0] +---- +==== + +In the preceding example, you can see the dynamic portions of the contract in the +`matchers` sections. For the request part, you can see that, for all fields but +`valueWithoutAMatcher`, the values of the regular expressions that the stub should +contain are explicitly set. For the `valueWithoutAMatcher`, the verification takes place +in the same way as without the use of matchers. In that case, the test performs an +equality check. + +For the response side in the `bodyMatchers` section, we define the dynamic parts in a +similar manner. The only difference is that the `byType` matchers are also present. The +verifier engine checks four fields to verify whether the response from the test +has a value for which the JSON path matches the given field, is of the same type as the one +defined in the response body, and passes the following check (based on the method being called): + +* For `$.valueWithTypeMatch`, the engine checks whether the type is the same. +* For `$.valueWithMin`, the engine checks the type and asserts whether the size is greater +than or equal to the minimum occurrence. +* For `$.valueWithMax`, the engine checks the type and asserts whether the size is +smaller than or equal to the maximum occurrence. +* For `$.valueWithMinMax`, the engine checks the type and asserts whether the size is +between the minimum and maximum occurrence. + +The resulting test resembles the following example (note that an `and` section +separates the autogenerated assertions and the assertion from matchers): + +[source,java,indent=0] +---- + // given: + MockMvcRequestSpecification request = given() + .header("Content-Type", "application/json") + .body("{\"duck\":123,\"alpha\":\"abc\",\"number\":123,\"aBoolean\":true,\"date\":\"2017-01-01\",\"dateTime\":\"2017-01-01T01:23:45\",\"time\":\"01:02:34\",\"valueWithoutAMatcher\":\"foo\",\"valueWithTypeMatch\":\"string\",\"key\":{\"complex.key\":\"foo\"}}"); + + // when: + ResponseOptions response = given().spec(request) + .get("/get"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); + assertThat(response.header("Content-Type")).matches("application/json.*"); + // and: + DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); + assertThatJson(parsedJson).field("['valueWithoutAMatcher']").isEqualTo("foo"); + // and: + assertThat(parsedJson.read("$.duck", String.class)).matches("[0-9]{3}"); + assertThat(parsedJson.read("$.duck", Integer.class)).isEqualTo(123); + assertThat(parsedJson.read("$.alpha", String.class)).matches("[\\p{L}]*"); + assertThat(parsedJson.read("$.alpha", String.class)).isEqualTo("abc"); + assertThat(parsedJson.read("$.number", String.class)).matches("-?(\\d*\\.\\d+|\\d+)"); + assertThat(parsedJson.read("$.aBoolean", String.class)).matches("(true|false)"); + assertThat(parsedJson.read("$.date", String.class)).matches("(\\d\\d\\d\\d)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"); + assertThat(parsedJson.read("$.dateTime", String.class)).matches("([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])"); + assertThat(parsedJson.read("$.time", String.class)).matches("(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])"); + assertThat((Object) parsedJson.read("$.valueWithTypeMatch")).isInstanceOf(java.lang.String.class); + assertThat((Object) parsedJson.read("$.valueWithMin")).isInstanceOf(java.util.List.class); + assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMin", java.util.Collection.class)).as("$.valueWithMin").hasSizeGreaterThanOrEqualTo(1); + assertThat((Object) parsedJson.read("$.valueWithMax")).isInstanceOf(java.util.List.class); + assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMax", java.util.Collection.class)).as("$.valueWithMax").hasSizeLessThanOrEqualTo(3); + assertThat((Object) parsedJson.read("$.valueWithMinMax")).isInstanceOf(java.util.List.class); + assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMinMax", java.util.Collection.class)).as("$.valueWithMinMax").hasSizeBetween(1, 3); + assertThat((Object) parsedJson.read("$.valueWithMinEmpty")).isInstanceOf(java.util.List.class); + assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMinEmpty", java.util.Collection.class)).as("$.valueWithMinEmpty").hasSizeGreaterThanOrEqualTo(0); + assertThat((Object) parsedJson.read("$.valueWithMaxEmpty")).isInstanceOf(java.util.List.class); + assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMaxEmpty", java.util.Collection.class)).as("$.valueWithMaxEmpty").hasSizeLessThanOrEqualTo(0); + assertThatValueIsANumber(parsedJson.read("$.duck")); + assertThat(parsedJson.read("$.['key'].['complex.key']", String.class)).isEqualTo("foo"); +---- + +IMPORTANT: Notice that, for the `byCommand` method, the example calls the +`assertThatValueIsANumber`. This method must be defined in the test base class or be +statically imported to your tests. Notice that the `byCommand` call was converted to +`assertThatValueIsANumber(parsedJson.read("$.duck"));`. That means that the engine took +the method name and passed the proper JSON path as a parameter to it. + +The resulting WireMock stub is in the following example: + +[source,json,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy[tags=matchers,indent=0] +---- + +IMPORTANT: If you use a `matcher`, the part of the request and response that the +`matcher` addresses with the JSON Path gets removed from the assertion. In the case of +verifying a collection, you must create matchers for *all* the elements of the +collection. + +Consider the following example: + +[source,groovy,indent=0] +---- +Contract.make { + request { + method 'GET' + url("/foo") + } + response { + status OK() + body(events: [[ + operation : 'EXPORT', + eventId : '16f1ed75-0bcc-4f0d-a04d-3121798faf99', + status : 'OK' + ], [ + operation : 'INPUT_PROCESSING', + eventId : '3bb4ac82-6652-462f-b6d1-75e424a0024a', + status : 'OK' + ] + ] + ) + bodyMatchers { + jsonPath('$.events[0].operation', byRegex('.+')) + jsonPath('$.events[0].eventId', byRegex('^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$')) + jsonPath('$.events[0].status', byRegex('.+')) + } + } +} +---- + +The preceding code leads to creating the following test (the code block shows only the assertion section): + +[source,java,indent=0] +---- + and: + DocumentContext parsedJson = JsonPath.parse(response.body.asString()) + assertThatJson(parsedJson).array("['events']").contains("['eventId']").isEqualTo("16f1ed75-0bcc-4f0d-a04d-3121798faf99") + assertThatJson(parsedJson).array("['events']").contains("['operation']").isEqualTo("EXPORT") + assertThatJson(parsedJson).array("['events']").contains("['operation']").isEqualTo("INPUT_PROCESSING") + assertThatJson(parsedJson).array("['events']").contains("['eventId']").isEqualTo("3bb4ac82-6652-462f-b6d1-75e424a0024a") + assertThatJson(parsedJson).array("['events']").contains("['status']").isEqualTo("OK") + and: + assertThat(parsedJson.read("\$.events[0].operation", String.class)).matches(".+") + assertThat(parsedJson.read("\$.events[0].eventId", String.class)).matches("^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})\$") + assertThat(parsedJson.read("\$.events[0].status", String.class)).matches(".+") +---- + +As you can see, the assertion is malformed. Only the first element of the array got +asserted. In order to fix this, you should apply the assertion to the whole `$.events` +collection and assert it with the `byCommand(...)` method. + + + +[[contract-dsl-async]] +=== Asynchronous Support + +If you use asynchronous communication on the server side (your controllers are +returning `Callable`, `DeferredResult`, and so on), then, inside your contract, you must +provide an `async()` method in the `response` section. The following code shows an example: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +org.springframework.cloud.contract.spec.Contract.make { + request { + method GET() + url '/get' + } + response { + status OK() + body 'Passed' + async() + } +} +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +response: + async: true +---- +==== + +You can also use the `fixedDelayMilliseconds` method or property to add delay to your stubs. +The following example shows how to do so: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +org.springframework.cloud.contract.spec.Contract.make { + request { + method GET() + url '/get' + } + response { + status 200 + body 'Passed' + fixedDelayMilliseconds 1000 + } +} +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +response: + fixedDelayMilliseconds: 1000 +---- +==== + +[[contract-dsl-xml]] +=== XML Support for HTTP + +For HTTP contracts, we also support using XML in the request and response body. +The XML body has to be passed within the `body` element +as a `String` or `GString`. Also, body matchers can be provided for +both the request and the response. In place of the `jsonPath(...)` method, the `org.springframework.cloud.contract.spec.internal.BodyMatchers.xPath` +method should be used, with the desired `xPath` provided as the first argument +and the appropriate `MatchingType` as second. All the body matchers apart from `byType()` are supported. + +The following example shows a Groovy DSL contract with XML in the response body: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/XmlMethodBodyBuilderSpec.groovy[tags=xmlgroovy] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_rest_xml.yml +---- +==== + +The following example shows an automatically generated test for XML in the response body: + +[source,java,indent=0] +---- +@Test +public void validate_xmlMatches() throws Exception { + // given: + MockMvcRequestSpecification request = given() + .header("Content-Type", "application/xml"); + + // when: + ResponseOptions response = given().spec(request).get("/get"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); + // and: + DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance() + .newDocumentBuilder(); + Document parsedXml = documentBuilder.parse(new InputSource( + new StringReader(response.getBody().asString()))); + // and: + assertThat(valueFromXPath(parsedXml, "/test/list/elem/text()")).isEqualTo("abc"); + assertThat(valueFromXPath(parsedXml,"/test/list/elem[2]/text()")).isEqualTo("def"); + assertThat(valueFromXPath(parsedXml, "/test/duck/text()")).matches("[0-9]{3}"); + assertThat(nodeFromXPath(parsedXml, "/test/duck/xxx")).isNull(); + assertThat(valueFromXPath(parsedXml, "/test/alpha/text()")).matches("[\\p{L}]*"); + assertThat(valueFromXPath(parsedXml, "/test/*/complex/text()")).isEqualTo("foo"); + assertThat(valueFromXPath(parsedXml, "/test/duck/@type")).isEqualTo("xtype"); + } +---- + +[[contract-dsl-multiple]] +=== Multiple Contracts in One File + +You can define multiple contracts in one file. Such a contract might resemble the +following example: + +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{plugins_path}/spring-cloud-contract-maven-plugin/src/test/projects/multiple-contracts/src/test/resources/contracts/com/hello/v1/WithList.groovy[lines=18..-1,indent=0] +---- + +[source,yaml,indent=0,role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/multiple_contracts.yml[indent=0] +---- +==== + +In the preceding example, one contract has the `name` field and the other does not. This +leads to generation of two tests that look more or less like the following: + +[source,java,indent=0] +---- +package org.springframework.cloud.contract.verifier.tests.com.hello; + +import com.example.TestBase; +import com.jayway.jsonpath.DocumentContext; +import com.jayway.jsonpath.JsonPath; +import com.jayway.restassured.module.mockmvc.specification.MockMvcRequestSpecification; +import com.jayway.restassured.response.ResponseOptions; +import org.junit.Test; + +import static com.jayway.restassured.module.mockmvc.RestAssuredMockMvc.*; +import static com.toomuchcoding.jsonassert.JsonAssertion.assertThatJson; +import static org.assertj.core.api.Assertions.assertThat; + +public class V1Test extends TestBase { + + @Test + public void validate_should_post_a_user() throws Exception { + // given: + MockMvcRequestSpecification request = given(); + + // when: + ResponseOptions response = given().spec(request) + .post("/users/1"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); + } + + @Test + public void validate_withList_1() throws Exception { + // given: + MockMvcRequestSpecification request = given(); + + // when: + ResponseOptions response = given().spec(request) + .post("/users/2"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); + } + +} +---- + +Notice that, for the contract that has the `name` field, the generated test method is named +`validate_should_post_a_user`. The one that does not have the `name` field is called +`validate_withList_1`. It corresponds to the name of the file `WithList.groovy` and the +index of the contract in the list. + +The generated stubs are shown in the following example: + +==== +[source] +---- +should post a user.json +1_WithList.json +---- +==== + +The first file got the `name` parameter from the contract. The second +got the name of the contract file (`WithList.groovy`) prefixed with the index (in this +case, the contract had an index of `1` in the list of contracts in the file). + +TIP: It is much better to name your contracts, because doing so makes +your tests far more meaningful. + +[[contract-stateful-contracts]] +=== Stateful Contracts + +Stateful contracts (known also as scenarios) are contract definitions that should be read +in order. This might be useful in the following situations: + +* You want to execute the contract in a precisely defined order, since you use Spring +Cloud Contract to test your stateful application + +TIP: We really discourage you from doing that, since contract tests should be stateless. + +* You want the same endpoint to return different results for the same request. + +To create stateful contracts (or scenarios), you need to +use the proper naming convention while creating your contracts. The convention +requires including an order number followed by an underscore. This works regardless +of whether you work with YAML or Groovy. The following listing shows an example: + +==== +[source,indent=0] +---- +my_contracts_dir\ + scenario1\ + 1_login.groovy + 2_showCart.groovy + 3_logout.groovy +---- +==== + +Such a tree causes Spring Cloud Contract Verifier to generate WireMock's scenario with a +name of `scenario1` and the three following steps: + +. login, marked as `Started` pointing to... +. showCart, marked as `Step1` pointing to... +. logout, marked as `Step2` (which closes the scenario). + +You can find nore details about WireMock scenarios at +https://wiremock.org/docs/stateful-behaviour/[https://wiremock.org/docs/stateful-behaviour/]. + +Spring Cloud Contract also generates tests with a guaranteed order of execution. +// TODO: How can someone specify the order of execution in SC Contract? +// That sentence is a great lead-in to more content, which then does not appear. diff --git a/docs/src/main/asciidoc/_project-features-flows.adoc b/docs/src/main/asciidoc/_project-features-flows.adoc new file mode 100644 index 0000000000..1f146abc60 --- /dev/null +++ b/docs/src/main/asciidoc/_project-features-flows.adoc @@ -0,0 +1,425 @@ +[[feature-integrations]] +== Integrations +include::_attributes.adoc[] + +[[features-jax-rs]] +=== JAX-RS + +The Spring Cloud Contract supports the JAX-RS 2 Client API. The base class needs +to define `protected WebTarget webTarget` and server initialization. The only option for +testing JAX-RS API is to start a web server. Also, a request with a body needs to have a +content type be set. Otherwise, the default of `application/octet-stream` gets used. + +In order to use JAX-RS mode, use the following settings: + +[source,groovy,indent=0] +---- +testMode == 'JAXRSCLIENT' +---- + +The following example shows a generated test API: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientMethodBuilderSpec.groovy[tags=jaxrs,indent=0] +---- + +[[feature-webflux]] +=== WebFlux with WebTestClient + +You can work with WebFlux by using WebTestClient. The following listing shows how to +configure WebTestClient as the test mode: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + WEBTESTCLIENT + + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +contracts { + testMode = 'WEBTESTCLIENT' +} +---- +==== + +The following example shows how to set up a WebTestClient base class and RestAssured +for WebFlux: + +[source,groovy,indent=0] +---- +import io.restassured.module.webtestclient.RestAssuredWebTestClient; +import org.junit.Before; + +public abstract class BeerRestBase { + + @Before + public void setup() { + RestAssuredWebTestClient.standaloneSetup( + new ProducerController(personToCheck -> personToCheck.age >= 20)); + } +} +} +---- + +TIP: The `WebTestClient` mode is faster than the `EXPLICIT` mode. + +[[feature-webflux-explicit]] +=== WebFlux with Explicit Mode + +You can also use WebFlux with the explicit mode in your generated tests +to work with WebFlux. The following example shows how to configure using explicit mode: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + EXPLICIT + + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +contracts { + testMode = 'EXPLICIT' +} +---- +==== + +The following example shows how to set up a base class and RestAssured for Web Flux: + +[source,groovy,indent=0] +---- +include::{samples_url}/producer_webflux/src/test/java/com/example/BeerRestBase.java[tags=annotations,indent=0] + + // your tests go here + + // in this config class you define all controllers and mocked services +include::{samples_url}/producer_webflux/src/test/java/com/example/BeerRestBase.java[tags=config,indent=0] + +} +---- + +[[features-context-paths]] +=== Working with Context Paths + +Spring Cloud Contract supports context paths. + +[IMPORTANT] +===== +The only change needed to fully support context paths is the switch on the +producer side. Also, the autogenerated tests must use explicit mode. The consumer +side remains untouched. In order for the generated test to pass, you must use explicit +mode. The following example shows how to set the test mode to `EXPLICIT`: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + EXPLICIT + + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +contracts { + testMode = 'EXPLICIT' +} +---- +==== +===== + +That way, you generate a test that does not use MockMvc. It means that you generate +real requests and you need to set up your generated test's base class to work on a real +socket. + +Consider the following contract: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy[tags=context_path_contract,indent=0] +---- + +The following example shows how to set up a base class and RestAssured: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy[tags=context_path_baseclass,indent=0] +---- + +If you do it this way: + +* All of your requests in the autogenerated tests are sent to the real endpoint with your +context path included (for example, `/my-context-path/url`). +* Your contracts reflect that you have a context path. Your generated stubs also have +that information (for example, in the stubs, you have to call `/my-context-path/url`). + +[[features-rest-docs]] +=== Working with REST Docs + +You can use https://projects.spring.io/spring-restdocs[Spring REST Docs] to generate +documentation (for example, in Asciidoc format) for an HTTP API with Spring MockMvc, +`WebTestClient`, or RestAssured. At the same time that you generate documentation for your API, you can also +generate WireMock stubs by using Spring Cloud Contract WireMock. To do so, write your +normal REST Docs test cases and use `@AutoConfigureRestDocs` to have stubs be +automatically generated in the REST Docs output directory. + +[plantuml, rest-docs, png] +---- +"API Producer"->"API Producer": Add Spring Cloud Contract (SCC) \nStub Runner dependency +"API Producer"->"API Producer": Set up stub jar assembly +"API Producer"->"API Producer": Write and set up REST Docs tests +"API Producer"->"Build": Run build +"Build"->"REST Docs": Generate API \ndocumentation +"REST Docs"->"SCC": Generate stubs from the \nREST Docs tests +"REST Docs"->"SCC": Generate contracts from the \nREST Docs tests +"Build"->"Build": Assemble stubs jar with \nstubs and contracts +"Build"->"Nexus / Artifactory": Upload contracts \nand stubs and the project arifact +"Build"->"API Producer": Build successful +"API Consumer"->"API Consumer": Add SCC Stub Runner \ndependency +"API Consumer"->"API Consumer": Write a SCC Stub Runner \nbased contract test +"SCC Stub Runner"->"Nexus / Artifactory": Test asks for [API Producer] stubs +"Nexus / Artifactory"->"SCC Stub Runner": Fetch the [API Producer] stubs +"SCC Stub Runner"->"SCC Stub Runner": Run in memory\n HTTP server stubs +"API Consumer"->"SCC Stub Runner": Send a request \nto the HTTP server stub +"SCC Stub Runner"->"API Consumer": Communication is correct +---- + +The following example uses `MockMvc`: + +[source,java,indent=0] +---- +@RunWith(SpringRunner.class) +@SpringBootTest +@AutoConfigureRestDocs(outputDir = "target/snippets") +@AutoConfigureMockMvc +public class ApplicationTests { + + @Autowired + private MockMvc mockMvc; + + @Test + public void contextLoads() throws Exception { + mockMvc.perform(get("/resource")) + .andExpect(content().string("Hello World")) + .andDo(document("resource")); + } +} +---- + +This test generates a WireMock stub at `target/snippets/stubs/resource.json`. It matches +all `GET` requests to the `/resource` path. The same example with `WebTestClient` (used +for testing Spring WebFlux applications) would be as follows: + +[source,java,indent=0] +---- +@RunWith(SpringRunner.class) +@SpringBootTest +@AutoConfigureRestDocs(outputDir = "target/snippets") +@AutoConfigureWebTestClient +public class ApplicationTests { + + @Autowired + private WebTestClient client; + + @Test + public void contextLoads() throws Exception { + client.get().uri("/resource").exchange() + .expectBody(String.class).isEqualTo("Hello World") + .consumeWith(document("resource")); + } +} +---- + +Without any additional configuration, these tests create a stub with a request matcher +for the HTTP method and all headers except `host` and `content-length`. To match the +request more precisely (for example, to match the body of a POST or PUT), we need to +explicitly create a request matcher. Doing so has two effects: + +* Creating a stub that matches only in the way you specify. +* Asserting that the request in the test case also matches the same conditions. + +The main entry point for this feature is `WireMockRestDocs.verify()`, which can be used +as a substitute for the `document()` convenience method, as the following +example shows: + +==== +[source,java,indent=0] +---- +import static org.springframework.cloud.contract.wiremock.restdocs.WireMockRestDocs.verify; + +@RunWith(SpringRunner.class) +@SpringBootTest +@AutoConfigureRestDocs(outputDir = "target/snippets") +@AutoConfigureMockMvc +public class ApplicationTests { + + @Autowired + private MockMvc mockMvc; + + @Test + public void contextLoads() throws Exception { + mockMvc.perform(post("/resource") + .content("{\"id\":\"123456\",\"message\":\"Hello World\"}")) + .andExpect(status().isOk()) + .andDo(verify().jsonPath("$.id") + .stub("resource")); + } +} +---- +==== + +The preceding contract specifies that any valid POST with an `id` field receives the response +defined in this test. You can chain together calls to `.jsonPath()` to add additional +matchers. If JSON Path is unfamiliar, the https://github.com/jayway/JsonPath[JayWay +documentation] can help you get up to speed. The `WebTestClient` version of this test +has a similar `verify()` static helper that you insert in the same place. + +Instead of the `jsonPath` and `contentType` convenience methods, you can also use the +WireMock APIs to verify that the request matches the created stub, as the +following example shows: + +[source,java,indent=0] +---- + @Test + public void contextLoads() throws Exception { + mockMvc.perform(post("/resource") + .content("{\"id\":\"123456\",\"message\":\"Hello World\"}")) + .andExpect(status().isOk()) + .andDo(verify() + .wiremock(WireMock.post( + urlPathEquals("/resource")) + .withRequestBody(matchingJsonPath("$.id")) + .stub("post-resource")); + } +---- + +The WireMock API is rich. You can match headers, query parameters, and the request body by +regex as well as by JSON path. You can use these features to create stubs with a wider +range of parameters. The preceding example generates a stub resembling the following example: + +.post-resource.json +[source,json] +---- +{ + "request" : { + "url" : "/resource", + "method" : "POST", + "bodyPatterns" : [ { + "matchesJsonPath" : "$.id" + }] + }, + "response" : { + "status" : 200, + "body" : "Hello World", + "headers" : { + "X-Application-Context" : "application:-1", + "Content-Type" : "text/plain" + } + } +} +---- + +NOTE: You can use either the `wiremock()` method or the `jsonPath()` and `contentType()` +methods to create request matchers, but you cannot use both approaches. + +On the consumer side, you can make the `resource.json` generated earlier in this section +available on the classpath (by +<>, for example). After that, you can create a stub that uses WireMock in a +number of different ways, including by using +`@AutoConfigureWireMock(stubs="classpath:resource.json")`, as described earlier in this +document. + +[[features-rest-docs-contracts]] +==== Generating Contracts with REST Docs + +You can also generate Spring Cloud Contract DSL files and documentation with Spring REST +Docs. If you do so in combination with Spring Cloud WireMock, you get both the contracts +and the stubs. + +Why would you want to use this feature? Some people in the community asked questions +about a situation in which they would like to move to DSL-based contract definition, +but they already have a lot of Spring MVC tests. Using this feature lets you generate +the contract files that you can later modify and move to folders (defined in your +configuration) so that the plugin finds them. + +NOTE: You might wonder why this functionality is in the WireMock module. The functionality +is there because it makes sense to generate both the contracts and the stubs. + +Consider the following test: + +==== +[source,java] +---- +include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/restdocs/ContractDslSnippetTests.java[tags=contract_snippet] +---- +==== + +The preceding test creates the stub presented in the previous section, generating both +the contract and a documentation file. + +The contract is called `index.groovy` and might resemble the following example: + +==== +[source,groovy] +---- +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method 'POST' + url '/foo' + body(''' + {"foo": 23 } + ''') + headers { + header('''Accept''', '''application/json''') + header('''Content-Type''', '''application/json''') + } + } + response { + status OK() + body(''' + bar + ''') + headers { + header('''Content-Type''', '''application/json;charset=UTF-8''') + header('''Content-Length''', '''3''') + } + testMatchers { + jsonPath('$[?(@.foo >= 20)]', byType()) + } + } +} +---- +==== + +The generated document (formatted in Asciidoc in this case) contains a formatted +contract. The location of this file would be `index/dsl-contract.adoc`. diff --git a/docs/src/main/asciidoc/_project-features-messaging.adoc b/docs/src/main/asciidoc/_project-features-messaging.adoc new file mode 100644 index 0000000000..29df58dcee --- /dev/null +++ b/docs/src/main/asciidoc/_project-features-messaging.adoc @@ -0,0 +1,1015 @@ +[[features-messaging]] +== Messaging +include::_attributes.adoc[] + +Spring Cloud Contract lets you verify applications that use messaging as a +means of communication. All of the integrations shown in this document work with Spring, +but you can also create one of your own and use that. + +[[contract-dsl-messaging-top-level]] +=== Messaging DSL Top-Level Elements + +The DSL for messaging looks a little bit different than the one that focuses on HTTP. The +following sections explain the differences: + +* <> +* <> +* <> +* <> + +[[contract-dsl-output-triggered-method]] +==== Output Triggered by a Method + +The output message can be triggered by calling a method (such as a `Scheduler` when a contract was +started and a message was sent), as shown in the following example: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{tests_path}/samples-messaging-integration/src/test/groovy/com/example/IntegrationMessagingApplicationSpec.groovy[tags=method_trigger,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_message_method.yml[indent=0] +---- +==== + +In the previous example case, the output message is sent to `output` if a method called +`bookReturnedTriggered` is executed. On the message publisher's side, we generate a +test that calls that method to trigger the message. On the consumer side, you can use +the `some_label` to trigger the message. + +[[contract-dsl-output-triggered-message]] +==== Output Triggered by a Message + +The output message can be triggered by receiving a message, as shown in the following +example: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{tests_path}/samples-messaging-integration/src/test/groovy/com/example/IntegrationMessagingApplicationSpec.groovy[tags=message_trigger,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_message_input_message.yml[indent=0] +---- +==== + +In the preceding example, the output message is sent to `output` if a proper message is +received on the `input` destination. On the message publisher's side, the engine +generates a test that sends the input message to the defined destination. On the +consumer side, you can either send a message to the input destination or use a label +(`some_label` in the example) to trigger the message. + +[[contract-dsl-consumer-producer]] +==== Consumer/Producer + +IMPORTANT: This section is valid only for Groovy DSL. + +In HTTP, you have a notion of `client`/`stub and `server`/`test` notation. You can also +use those paradigms in messaging. In addition, Spring Cloud Contract Verifier also +provides the `consumer` and `producer` methods, as presented in the following example +(note that you can use either `$` or `value` methods to provide `consumer` and `producer` +parts): + +[source,groovy] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=consumer_producer] +---- + +[[contract-dsl-messaging-common]] +==== Common + +In the `input` or `outputMessage` section, you can call `assertThat` with the name +of a `method` (for example, `assertThatMessageIsOnTheQueue()`) that you have defined in the +base class or in a static import. Spring Cloud Contract runs that method +in the generated test. + +[[features-messaging-integrations]] +=== Integrations + +You can use one of the following four integration configurations: + +* Apache Camel +* Spring Integration +* Spring Cloud Stream +* Spring AMQP + +Since we use Spring Boot, if you have added one of these libraries to the classpath, all +the messaging configuration is automatically set up. + +IMPORTANT: Remember to put `@AutoConfigureMessageVerifier` on the base class of your +generated tests. Otherwise, the messaging part of Spring Cloud Contract does not +work. + +[IMPORTANT] +===== +If you want to use Spring Cloud Stream, remember to add a dependency on +`org.springframework.cloud:spring-cloud-stream-test-support`, as follows: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-stream-test-support + test + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +testCompile "org.springframework.cloud:spring-cloud-stream-test-support" +---- +==== +===== + +[[features-messaging-manual]] +==== Manual Integration Testing + +The main interface used by the tests is +`org.springframework.cloud.contract.verifier.messaging.MessageVerifier`. +It defines how to send and receive messages. You can create your own implementation to +achieve the same goal. + +In a test, you can inject a `ContractVerifierMessageExchange` to send and receive +messages that follow the contract. Then add `@AutoConfigureMessageVerifier` to your test. +The following example shows how to do so: + +==== +[source,java,indent=0] +---- +@RunWith(SpringTestRunner.class) +@SpringBootTest +@AutoConfigureMessageVerifier +public static class MessagingContractTests { + + @Autowired + private MessageVerifier verifier; + ... +} +---- +==== + +NOTE: If your tests require stubs as well, then `@AutoConfigureStubRunner` includes the +messaging configuration, so you only need the one annotation. + +[[features-messaging-test-generation]] +=== Producer Side Messaging Test Generation + +Having the `input` or `outputMessage` sections in your DSL results in creation of tests +on the publisher's side. By default, JUnit 4 tests are created. However, there is also a +possibility to create JUnit 5, TestNG, or Spock tests. + +There are three main scenarios that we should take into consideration: + +* Scenario 1: There is no input message that produces an output message. The output +message is triggered by a component inside the application (for example, a scheduler). +* Scenario 2: The input message triggers an output message. +* Scenario 3: The input message is consumed, and there is no output message. + +IMPORTANT: The destination passed to `messageFrom` or `sentTo` can have different +meanings for different messaging implementations. For Stream and Integration, it is +first resolved as a `destination` of a channel. Then, if there is no such `destination` +it is resolved as a channel name. For Camel, that's a certain component (for example, +`jms`). + +[[features-messaging-scenario1]] +==== Scenario 1: No Input Message + +Consider the following contract: + +===== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_dsl] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +[source,yml,indent=0] +---- +include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario1.yml[indent=0] +---- +===== + +For the preceding example, the following test would be created: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.JUnit +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_junit_test] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Spock +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_test] +---- +==== + +[[features-messaging-scenario2]] +==== Scenario 2: Output Triggered by Input + +Consider the following contract: + +===== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_dsl] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario2.yml[indent=0] +---- +===== + +For the preceding contract, the following test would be created: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.JUnit +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_junit] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Spock +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_spock] +---- +==== + +[[features-messaging-scenario3]] +==== Scenario 3: No Output Message + +Consider the following contract: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.groovy +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_dsl] +---- + +[source,yml,indent=0,subs="verbatim,attributes",role="secondary"] +.yml +---- +include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario3.yml[indent=0] +---- +==== + +For the preceding contract, the following test would be created: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.JUnit +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_junit] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Spock +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_spock] +---- +==== + +[[features-messaging-consumer]] +=== Consumer Stub Generation + +Unlike in the HTTP part, in messaging, we need to publish the contract definition inside the JAR with +a stub. Then it is parsed on the consumer side, and proper stubbed routes are created. + +IMPORTANT: If you have multiple frameworks on the classpath, Stub Runner needs to +define which one should be used. Assume that you have AMQP, Spring Cloud Stream, and Spring Integration +on the classpath and that you want to use Spring AMQP. Then you need to set +`stubrunner.stream.enabled=false` and `stubrunner.integration.enabled=false`. +That way, the only remaining framework is Spring AMQP. + +[[features-messaging-stub-triggering]] +==== Stub triggering + +To trigger a message, use the `StubTrigger` interface, as the following example shows: + +[source,groovy] +---- +include::{stubrunner_core_path}/src/main/java/org/springframework/cloud/contract/stubrunner/StubTrigger.java[lines=16..-1] +---- + +For convenience, the `StubFinder` interface extends `StubTrigger`, so you only need one +or the other in your tests. + +`StubTrigger` gives you the following options to trigger a message: + +* <> +* <> +* <> +* <> + +[[features-messaging-trigger-label]] +==== Trigger by Label + +The following example shows how to trigger a message with a label: + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger,indent=0] +---- +[[features-messaging-trigger-group-artifact-ids]] +==== Trigger by Group and Artifact Ids + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_group_artifact,indent=0] +---- + +[[features-messaging-trigger-artifact-ids]] +==== Trigger by Artifact IDs + +The following example shows how to trigger a message from artifact IDs: + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_artifact,indent=0] +---- + +[[features-messaging-trigger-all-messages]] +==== Trigger All Messages + +The following example shows how to trigger all messages: + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_all,indent=0] +---- + +:input_name: jms:input +:output_name: jms:output + +[[features-messaging-stub-runner-camel]] +=== Consumer Side Messaging With Apache Camel + +Spring Cloud Contract Stub Runner's messaging module gives you an easy way to integrate with Apache Camel. +For the provided artifacts, it automatically downloads the stubs and registers the required +routes. + +[[features-messaging-stub-runner-camel-adding]] +==== Adding Apache Camel to the Project + +You can have both Apache Camel and Spring Cloud Contract Stub Runner on the classpath. +Remember to annotate your test class with `@AutoConfigureStubRunner`. + +[[features-messaging-stub-runner-camel-disabling]] +==== Disabling the Functionality + +If you need to disable this functionality, set the `stubrunner.camel.enabled=false` property. + +[[features-messaging-stub-runner-camel-example]] +==== Examples + +Assume that we have the following Maven repository with deployed stubs for the +`camelService` application. + +==== +[source,bash,indent=0] +---- +└── .m2 + └── repository + └── io + └── codearte + └── accurest + └── stubs + └── camelService + ├── 0.0.1-SNAPSHOT + │   ├── camelService-0.0.1-SNAPSHOT.pom + │   ├── camelService-0.0.1-SNAPSHOT-stubs.jar + │   └── maven-metadata-local.xml + └── maven-metadata-local.xml +---- +==== + +Further assume that the stubs contain the following structure: + +==== +[source,bash,indent=0] +---- +├── META-INF +│   └── MANIFEST.MF +└── repository + ├── accurest + │   ├── bookDeleted.groovy + │   ├── bookReturned1.groovy + │   └── bookReturned2.groovy + └── mappings +---- +==== + +Now consider the following contracts (we number them 1 and 2): + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=sample_dsl,indent=0] +---- + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] +---- +==== + +[[features-messaging-stub-runner-camel-scenario1]] +===== Scenario 1 (No Input Message) + +To trigger a message from the `return_book_1` label, we use the `StubTigger` interface, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger,indent=0] +---- +==== + +Next, we want to listen to the output of the message sent to `{output_name}`: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger_receive,indent=0] +---- +==== + +The received message would then pass the following assertions: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger_message,indent=0] +---- +==== + +[[features-messaging-stub-runner-camel-scenario2]] +===== Scenario 2 (Output Triggered by Input) + +Since the route is set for you, you can send a message to the `{output_name}` destination. + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_send,indent=0] +---- +==== + +Next, we want to listen to the output of the message sent to `{output_name}`, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_receive,indent=0] +---- +==== + +The received message would pass the following assertions: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_receive_message,indent=0] +---- +==== + +[[features-messaging-stub-runner-camel-scenario3]] +===== Scenario 3 (Input with No Output) + +Since the route is set for you, you can send a message to the `{output_name}` destination, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] +---- + +:input_name: input +:output_name: output +==== + +[[features-messaging-stub-runner-integration]] +=== Consumer Side Messaging with Spring Integration + +Spring Cloud Contract Stub Runner's messaging module gives you an easy way to +integrate with Spring Integration. For the provided artifacts, it automatically downloads +the stubs and registers the required routes. + +[[features-messaging-stub-runner-integration-adding]] +==== Adding the Runner to the Project + +You can have both Spring Integration and Spring Cloud Contract Stub Runner on the +classpath. Remember to annotate your test class with `@AutoConfigureStubRunner`. + +[[features-messaging-stub-runner-integration-disabling]] +==== Disabling the Functionality + +If you need to disable this functionality, set the +`stubrunner.integration.enabled=false` property. + +[[features-messaging-stub-runner-integration-example]] +==== Examples + +Assume that you have the following Maven repository with deployed stubs for the +`integrationService` application: + +==== +[source,bash,indent=0] +---- +└── .m2 + └── repository + └── io + └── codearte + └── accurest + └── stubs + └── integrationService + ├── 0.0.1-SNAPSHOT + │   ├── integrationService-0.0.1-SNAPSHOT.pom + │   ├── integrationService-0.0.1-SNAPSHOT-stubs.jar + │   └── maven-metadata-local.xml + └── maven-metadata-local.xml +---- +==== + +Further assume the stubs contain the following structure: + +==== +[source,bash,indent=0] +---- +├── META-INF +│   └── MANIFEST.MF +└── repository + ├── accurest + │   ├── bookDeleted.groovy + │   ├── bookReturned1.groovy + │   └── bookReturned2.groovy + └── mappings +---- +==== + +Consider the following contracts (numbered 1 and 2): + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=sample_dsl,indent=0] +---- + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] +---- +==== + +Now consider the following Spring Integration Route: + +==== +[source,xml] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/resources/integration-context.xml[lines=1;18..-1] +---- +==== + +These examples lend themselves to three scenarios: + +. <> +. <> +. <> + +[[features-messaging-stub-runner-integration-scenario1]] +===== Scenario 1 (No Input Message) + +To trigger a message from the `return_book_1` label, use the `StubTigger` interface, as +follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_trigger,indent=0] +---- +==== + +The following listing shows how to listen to the output of the message sent to `{output_name}`: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_trigger_receive,indent=0] +---- +==== + +The received message would pass the following assertions: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_trigger_message,indent=0] +---- +==== + +[[features-messaging-stub-runner-integration-scenario2]] +===== Scenario 2 (Output Triggered by Input) + +Since the route is set for you, you can send a message to the `{output_name}` +destination, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_send,indent=0] +---- +==== + +The following listing shows how to listen to the output of the message sent to `{output_name}`: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_receive,indent=0] +---- +==== + +The received message passes the following assertions: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_receive_message,indent=0] +---- +==== + +[[features-messaging-stub-runner-integration-scenario3]] +===== Scenario 3 (Input with No Output) + +Since the route is set for you, you can send a message to the `{input_name}` destination, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] +---- +==== + +[[features-messaging-stub-runner-stream]] +=== Consumer Side Messaging With Spring Cloud Stream + +Spring Cloud Contract Stub Runner's messaging module gives you an easy way to +integrate with Spring Stream. For the provided artifacts, it automatically downloads the +stubs and registers the required routes. + +WARNING: If Stub Runner's integration with the Stream `messageFrom` or `sentTo` strings +are resolved first as the `destination` of a channel and no such `destination` exists, the +destination is resolved as a channel name. + +[IMPORTANT] +===== +If you want to use Spring Cloud Stream, remember to add a dependency on +`org.springframework.cloud:spring-cloud-stream-test-support`, as follows: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-stream-test-support + test + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +testCompile "org.springframework.cloud:spring-cloud-stream-test-support" +---- +==== +===== + +[[features-messaging-stub-runner-stream-adding]] +==== Adding the Runner to the Project + +You can have both Spring Cloud Stream and Spring Cloud Contract Stub Runner on the +classpath. Remember to annotate your test class with `@AutoConfigureStubRunner`. + +[[features-messaging-stub-runner-stream-disabling]] +==== Disabling the Functionality + +If you need to disable this functionality, set the `stubrunner.stream.enabled=false` +property. + +[[features-messaging-stub-runner-stream-example]] +==== Examples + +Assume that you have the following Maven repository with deployed stubs for the +`streamService` application: + +==== +[source,bash,indent=0] +---- +└── .m2 + └── repository + └── io + └── codearte + └── accurest + └── stubs + └── streamService + ├── 0.0.1-SNAPSHOT + │   ├── streamService-0.0.1-SNAPSHOT.pom + │   ├── streamService-0.0.1-SNAPSHOT-stubs.jar + │   └── maven-metadata-local.xml + └── maven-metadata-local.xml +---- +==== + +Further assume the stubs contain the following structure: + +==== +[source,bash,indent=0] +---- +├── META-INF +│   └── MANIFEST.MF +└── repository + ├── accurest + │   ├── bookDeleted.groovy + │   ├── bookReturned1.groovy + │   └── bookReturned2.groovy + └── mappings +---- +==== + +Consider the following contracts (numbered 1 and 2): + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=sample_dsl,indent=0] +---- + +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] +---- +==== + +Now consider the following Spring configuration: + +==== +[source,yaml] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/resources/application.yml[] +---- +==== + +These examples lend themselves to three scenarios: + +* <> +* <> +* <> + +[[features-messaging-stub-runner-stream-scenario1]] +===== Scenario 1 (No Input Message) + +To trigger a message from the `return_book_1` label, use the `StubTrigger` interface as +follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger,indent=0] +---- +==== + +The following example shows how to listen to the output of the message sent to a channel whose `destination` is +`returnBook`: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger_receive,indent=0] +---- +==== + +The received message passes the following assertions: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger_message,indent=0] +---- +==== + +[[features-messaging-stub-runner-stream-scenario2]] +===== Scenario 2 (Output Triggered by Input) + +Since the route is set for you, you can send a message to the `bookStorage` +`destination`, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_send,indent=0] +---- +==== + +The following example shows how to listen to the output of the message sent to `returnBook`: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_receive,indent=0] +---- +==== + +The received message passes the following assertions: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_receive_message,indent=0] +---- +==== + +[[features-messaging-stub-runner-stream-scenario3]] +===== Scenario 3 (Input with No Output) + +Since the route is set for you, you can send a message to the `{output_name}` +destination, as follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] +---- +==== + +[[features-messaging-stub-runner-amqp]] +=== Consumer Side Messaging With Spring AMQP + +Spring Cloud Contract Stub Runner's messaging module provides an easy way to +integrate with Spring AMQP's Rabbit Template. For the provided artifacts, it +automatically downloads the stubs and registers the required routes. + +The integration tries to work standalone (that is, without interaction with a running +RabbitMQ message broker). It expects a `RabbitTemplate` on the application context and +uses it as a spring boot test named `@SpyBean`. As a result, it can use the Mockito spy +functionality to verify and inspect messages sent by the application. + +On the message consumer side, the stub runner considers all `@RabbitListener` annotated +endpoints and all `SimpleMessageListenerContainer` objects on the application context. + +As messages are usually sent to exchanges in AMQP, the message contract contains the +exchange name as the destination. Message listeners on the other side are bound to +queues. Bindings connect an exchange to a queue. If message contracts are triggered, the +Spring AMQP stub runner integration looks for bindings on the application context that +matches this exchange. Then it collects the queues from the Spring exchanges and tries to +find message listeners bound to these queues. The message is triggered for all matching +message listeners. + +If you need to work with routing keys, you can pass them by using the `amqp_receivedRoutingKey` +messaging header. + +[[features-messaging-stub-runner-amqp-adding]] +==== Adding the Runner to the Project + +You can 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`. + +IMPORTANT: If you already have Stream and Integration on the classpath, you need +to disable them explicitly by setting the `stubrunner.stream.enabled=false` and +`stubrunner.integration.enabled=false` properties. + +[[features-messaging-stub-runner-amqp-example]] +==== Examples + +Assume that you have the following Maven repository with a deployed stubs for the +`spring-cloud-contract-amqp-test` application: + +==== +[source,bash,indent=0] +---- +└── .m2 + └── repository + └── com + └── example + └── spring-cloud-contract-amqp-test + ├── 0.4.0-SNAPSHOT + │   ├── spring-cloud-contract-amqp-test-0.4.0-SNAPSHOT.pom + │   ├── spring-cloud-contract-amqp-test-0.4.0-SNAPSHOT-stubs.jar + │   └── maven-metadata-local.xml + └── maven-metadata-local.xml +---- +==== + +Further assume that the stubs contain the following structure: + +==== +[source,bash,indent=0] +---- +├── META-INF +│   └── MANIFEST.MF +└── contracts + └── shouldProduceValidPersonData.groovy +---- +==== + +Then consider the following contract: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-amqp/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpStubRunnerSpec.groovy[tags=amqp_contract,indent=0] +---- +==== + +Now consider the following Spring configuration: + +==== +[source,yaml] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-amqp/src/test/resources/application.yml[] +---- +==== + +[[features-messaging-stub-runner-amqp-triggering]] +===== Triggering the Message + +To trigger a message using the contract in the preceding section, use the `StubTrigger` interface as +follows: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-amqp/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpStubRunnerSpec.groovy[tags=client_trigger,indent=0] +---- +==== + +The message has a destination of `contract-test.exchange`, so the Spring AMQP stub runner +integration looks for bindings related to this exchange, as the following example shows: + +==== +[source,java] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-amqp/src/main/java/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpMessagingApplication.java[tags=amqp_binding,indent=0] +---- +==== + +The binding definition binds the queue called `test.queue`. As a result, the following listener +definition is matched and invoked with the contract message: + +==== +[source,java] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-amqp/src/main/java/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpMessagingApplication.java[tags=amqp_listener,indent=0] +---- +==== + +Also, the following annotated listener matches and is invoked: + +==== +[source,java] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-amqp/src/main/java/org/springframework/cloud/contract/stubrunner/messaging/amqp/MessageSubscriberRabbitListener.java[tags=amqp_annotated_listener,indent=0] +---- +==== + +NOTE: The message is directly handed over to the `onMessage` method of the +`MessageListener` associated with the matching `SimpleMessageListenerContainer`. + +[[features-messaging-stub-runner-amqp-configuration]] +===== Spring AMQP Test Configuration + +In order to avoid Spring AMQP trying to connect to a running broker during our tests, we +configure a mock `ConnectionFactory`. + +To disable the mocked `ConnectionFactory`, set the following property: +`stubrunner.amqp.mockConnection=false`, as follows: + +==== +[source,yaml] +---- +stubrunner: + amqp: + mockConnection: false +---- +==== diff --git a/docs/src/main/asciidoc/_project-features-stubrunner.adoc b/docs/src/main/asciidoc/_project-features-stubrunner.adoc new file mode 100644 index 0000000000..35d9f47b55 --- /dev/null +++ b/docs/src/main/asciidoc/_project-features-stubrunner.adoc @@ -0,0 +1,916 @@ +[[features-stub-runner]] +== Spring Cloud Contract Stub Runner + +One of the issues that you might encounter while using Spring Cloud Contract Verifier is +passing the generated WireMock JSON stubs from the server side to the client side (or to +various clients). The same takes place in terms of client-side generation for messaging. + +Copying the JSON files and setting the client side for messaging manually is out of the +question. That is why we introduced Spring Cloud Contract Stub Runner. It can +automatically download and run the stubs for you. + +[[features-stub-runner-snapshot-versions]] +=== Snapshot Versions + +You can add the additional snapshot repository to your `build.gradle` file to use snapshot +versions, which are automatically uploaded after every successful build, as follows: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- +include::{standalone_samples_path}/http-server/pom.xml[tags=repos,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +include::{standalone_samples_path}/http-server/build.gradle[tags=repos,indent=0] +---- +==== + +[[features-stub-runner-publishing-stubs-as-jars]] +=== Publishing Stubs as JARs + +The easiest approach to publishing stubs as jars is to centralize the way stubs are kept. +For example, you can keep them as jars in a Maven repository. + +TIP: For both Maven and Gradle, the setup comes ready to work. However, you can customize +it if you want to. + +The following example shows how to publish stubs as jars: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + +include::{samples_url}/producer_with_restdocs/pom.xml[tags=skip_jar,indent=0] + + +include::{samples_url}/producer_with_restdocs/pom.xml[tags=assembly,indent=0] + + +include::{samples_url}/producer_with_restdocs/src/assembly/stub.xml[indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0] +---- +==== + +[[features-stub-runner-core]] +=== Stub Runner Core + +The stub runner core runs stubs for service collaborators. Treating stubs as contracts of +services lets you use stub-runner as an implementation of +https://martinfowler.com/articles/consumerDrivenContracts.html[Consumer-driven Contracts]. + +Stub Runner lets you automatically download the stubs of the provided dependencies (or +pick those from the classpath), start WireMock servers for them, and feed them with proper +stub definitions. For messaging, special stub routes are defined. + +[[features-stub-runner-retrieving]] +==== Retrieving stubs + +You can pick from the following options of acquiring stubs: + +- Aether-based solution that downloads JARs with stubs from Artifactory or Nexus +- Classpath-scanning solution that searches the classpath with a pattern to retrieve stubs +- Writing your own implementation of the `org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder` for full customization + +The latter example is described in the <> section. + +[[features-stub-runner-downloading-stub]] +===== Downloading Stubs + +You can control the downloading of stubs with the `stubsMode` switch. It picks value from the +`StubRunnerProperties.StubsMode` enumeration. You can use the following options: + +- `StubRunnerProperties.StubsMode.CLASSPATH` (default value): Picks stubs from the classpath +- `StubRunnerProperties.StubsMode.LOCAL`: Picks stubs from a local storage (for example, `.m2`) +- `StubRunnerProperties.StubsMode.REMOTE`: Picks stubs from a remote location + +The following example picks stubs from a local location: + +==== +[source,java] +---- +@AutoConfigureStubRunner(repositoryRoot="https://foo.bar", ids = "com.example:beer-api-producer:+:stubs:8095", stubsMode = StubRunnerProperties.StubsMode.LOCAL) +---- +==== + +[[features-stub-runner-classpath-scanning]] +===== Classpath scanning + +If you set the `stubsMode` property to `StubRunnerProperties.StubsMode.CLASSPATH` +(or set nothing since `CLASSPATH` is the default value), the classpath is scanned. +Consider the following example: + +==== +[source,java] +---- +@AutoConfigureStubRunner(ids = { + "com.example:beer-api-producer:+:stubs:8095", + "com.example.foo:bar:1.0.0:superstubs:8096" +}) +---- +==== + +You can add the dependencies to your classpath, as follows: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + com.example + beer-api-producer-restdocs + stubs + 0.0.1-SNAPSHOT + test + + + * + * + + + + + com.example.thing1 + thing2 + superstubs + 1.0.0 + test + + + * + * + + + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +testCompile("com.example:beer-api-producer-restdocs:0.0.1-SNAPSHOT:stubs") { + transitive = false +} +testCompile("com.example.thing1:thing2:1.0.0:superstubs") { + transitive = false +} +---- +==== + +Then the specified locations on your classpath get scanned. For `com.example:beer-api-producer-restdocs`, +the following locations are scanned: + +- /META-INF/com.example/beer-api-producer-restdocs/**/*.* +- /contracts/com.example/beer-api-producer-restdocs/**/*.* +- /mappings/com.example/beer-api-producer-restdocs/**/*.* + +For `com.example.thing1:thing2`, the following locations are scanned: + +- /META-INF/com.example.thing1/thing2/**/*.* +- /contracts/com.example.thing1/thing2/**/*.* +- /mappings/com.example.thing1/thing2/**/*.* + +TIP: You have to explicitly provide the group and artifact IDs when you package the +producer stubs. + +To achieve proper stub packaging, the producer would set up the contracts as follows: + +==== +[source,bash] +---- +└── src + └── test + └── resources + └── contracts +    └── com.example +       └── beer-api-producer-restdocs +       └── nested +       └── contract3.groovy + +---- +==== + +By using the https://github.com/spring-cloud-samples/spring-cloud-contract-samples/blob/{samples_branch}/producer_with_restdocs/pom.xml[Maven `assembly` plugin] or +https://github.com/spring-cloud-samples/spring-cloud-contract-samples/blob/{samples_branch}/producer_with_restdocs/build.gradle[Gradle Jar] task, you have to create the following +structure in your stubs jar: + +==== +[source,bash] +---- +└── META-INF + └── com.example + └── beer-api-producer-restdocs + └── 2.0.0 + ├── contracts + │   └── nested +    │ └── contract2.groovy +    └── mappings +    └── mapping.json + +---- +==== + +By maintaining this structure, the classpath gets scanned and you can profit from the messaging or +HTTP stubs without the need to download artifacts. + +[[features-stub-runner-configuring-http-server-stubs]] +===== Configuring HTTP Server Stubs + +Stub Runner has a notion of a `HttpServerStub` that abstracts the underlying +concrete implementation of the HTTP server (for example, WireMock is one of the implementations). +Sometimes, you need to perform some additional tuning (which is concrete for the given implementation) of the stub servers. +To do that, Stub Runner gives you +the `httpServerStubConfigurer` property that is available in the annotation and the +JUnit rule and is accessible through system properties, where you can provide +your implementation of the `org.springframework.cloud.contract.stubrunner.HttpServerStubConfigurer` +interface. The implementations can alter +the configuration files for the given HTTP server stub. + +Spring Cloud Contract Stub Runner comes with an implementation that you +can extend for WireMock: +`org.springframework.cloud.contract.stubrunner.provider.wiremock.WireMockHttpServerStubConfigurer`. +In the `configure` method, +you can provide your own custom configuration for the given stub. The use +case might be starting WireMock for the given artifact ID, on an HTTPS port. The following +example shows how to do so: + +.WireMockHttpServerStubConfigurer implementation +==== +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy[tags=wireMockHttpServerStubConfigurer] +---- +==== + +You can then reuse it with the `@AutoConfigureStubRunner` annotation, as follows: + +==== +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy[tags=annotation] +---- +==== + +Whenever an HTTPS port is found, it takes precedence over the HTTP port. + +[[features-stub-runner-running-stubs]] +==== Running stubs + +This section describes how to run stubs. It contains the following topics: + +* <> +* <> +* <> + +[[features-stub-runner-http-stubs]] +===== HTTP Stubs + +Stubs are defined in JSON documents, whose syntax is defined in http://wiremock.org/stubbing.html[WireMock documentation] + +The following example defines a stub in JSON: + +==== +[source,javascript,indent=0] +---- +{ + "request": { + "method": "GET", + "url": "/ping" + }, + "response": { + "status": 200, + "body": "pong", + "headers": { + "Content-Type": "text/plain" + } + } +} +---- +==== + +[[features-stub-runner-viewing]] +===== Viewing Registered Mappings + +Every stubbed collaborator exposes a list of defined mappings under the `__/admin/` endpoint. + +You can also use the `mappingsOutputFolder` property to dump the mappings to files. +For the annotation-based approach, it would resembling the following example: + +==== +[source,java] +---- +@AutoConfigureStubRunner(ids="a.b.c:loanIssuance,a.b.c:fraudDetectionServer", +mappingsOutputFolder = "target/outputmappings/") +---- +==== + +For the JUnit approach, it resembles the following example: + +==== +[source,java] +---- +@ClassRule @Shared StubRunnerRule rule = new StubRunnerRule() + .repoRoot("https://some_url") + .downloadStub("a.b.c", "loanIssuance") + .downloadStub("a.b.c:fraudDetectionServer") + .withMappingsOutputFolder("target/outputmappings") +---- +==== + +Then, if you check out the `target/outputmappings` folder, you would see the following structure; + +==== +[source,bash] +---- +. +├── fraudDetectionServer_13705 +└── loanIssuance_12255 +---- +==== + +That means that there were two stubs registered. `fraudDetectionServer` was registered at port `13705` +and `loanIssuance` at port `12255`. If we take a look at one of the files, we would see (for WireMock) +the mappings available for the given server: + +==== +[source,json] +---- +[{ + "id" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7", + "request" : { + "url" : "/name", + "method" : "GET" + }, + "response" : { + "status" : 200, + "body" : "fraudDetectionServer" + }, + "uuid" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7" +}, +... +] +---- +==== + +[[features-stub-runner-messaging]] +===== Messaging Stubs + +Depending on the provided Stub Runner dependency and the DSL, the messaging routes are automatically set up. + +[[features-stub-runner-junit]] +=== Stub Runner JUnit Rule and Stub Runner JUnit5 Extension + +Stub Runner comes with a JUnit rule that lets you can download and run stubs for a given +group and artifact ID, as the following example shows: + +==== +[source,java,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java[tags=classrule] +---- +==== + +A `StubRunnerExtension` is also available for JUnit 5. `StubRunnerRule` and +`StubRunnerExtension` work in a very similar fashion. After the rule or extension is +executed, Stub Runner connects to your Maven repository and, for the given list of +dependencies, tries to: + +- Download them +- Cache them locally +- Unzip them to a temporary folder +- Start a WireMock server for each Maven dependency on a random port from the provided +range of ports or the provided port +- Feed the WireMock server with all JSON files that are valid WireMock definitions +- Send messages (remember to pass an implementation of `MessageVerifier` interface) + +Stub Runner uses the https://wiki.eclipse.org/Aether[Eclipse Aether] mechanism to download the Maven dependencies. +Check their https://wiki.eclipse.org/Aether[docs] for more information. + +Since the `StubRunnerRule` and `StubRunnerExtension` implement the `StubFinder` they let +you find the started stubs, as the following example shows: + +==== +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/main/java/org/springframework/cloud/contract/stubrunner/StubFinder.java[lines=16..-1] +---- +==== + +The following examples provide more detail about using Stub Runner: + +==== +[source,groovy,indent=0,subs="verbatim,attributes",role="primary"] +.spock +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleSpec.groovy[tags=classrule] +---- + +[source,java,indent=0,subs="verbatim,attributes",role="secondary"] +.junit 4 +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java[tags=test] +---- + +[source,java,indent=0,subs="verbatim,attributes",role="secondary"] +.junit 5 +---- +include::{stubrunner_core_path}/src/test/java/org/springframework/cloud/contract/stubrunner/junit/StubRunnerJUnit5ExtensionTests.java[tags=extension] +---- +==== + +See the <> for more information on +how to apply global configuration of Stub Runner. + +IMPORTANT: To use the JUnit rule or JUnit 5 extension together with messaging, you have to provide an implementation of the +`MessageVerifier` interface to the rule builder (for example, `rule.messageVerifier(new MyMessageVerifier())`). +If you do not do this, then, whenever you try to send a message, an exception is thrown. + +[[features-stub-runner-rule-maven-settings]] +==== Maven Settings + +The stub downloader honors Maven settings for a different local repository folder. +Authentication details for repositories and profiles are currently not taken into account, +so you need to specify it by using the properties mentioned above. + +[[features-stub-runner-rule-fixed-ports]] +==== Providing Fixed Ports + +You can also run your stubs on fixed ports. You can do it in two different ways. +One is to pass it in the properties, and the other is to use the fluent API of +JUnit rule. + +[[features-stub-runner-rule-fluent-api]] +==== Fluent API + +When using the `StubRunnerRule` or `StubRunnerExtension`, you can add a stub to download +and then pass the port for the last downloaded stub. The following example shows how to do so: + +==== +[source,java,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java[tags=classrule_with_port] +---- +==== + +For the preceding example, the following test is valid: + +==== +[source,java,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java[tags=test_with_port] +---- +==== + +[[features-stub-runner-rule-spring]] +==== Stub Runner with Spring + +Stub Runner with Spring sets up Spring configuration of the Stub Runner project. + +By providing a list of stubs inside your configuration file, Stub Runner automatically downloads +and registers in WireMock the selected stubs. + +If you want to find the URL of your stubbed dependency, you can autowire the `StubFinder` interface and use +its methods, as follows: + +==== +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy[tags=test] +---- +==== + +Doing so depends on the following configuration file: + +==== +[source,yml,indent=0] +---- +include::{stubrunner_core_path}/src/test/resources/application-test.yml[tags=test] +---- +==== + +Instead of using the properties, you can also use the properties inside the `@AutoConfigureStubRunner`. +The following example achieves the same result by setting values on the annotation: + +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy[tags=autoconfigure] +---- + +Stub Runner Spring registers environment variables in the following manner +for every registered WireMock server. The following example shows Stub Runner IDs for +`com.example:thing1` and `com.example:thing2`: + +- `stubrunner.runningstubs.thing1.port` +- `stubrunner.runningstubs.com.example.thing1.port` +- `stubrunner.runningstubs.thing2.port` +- `stubrunner.runningstubs.com.example.thing2.port` + +You can reference these values in your code. + +You can also use the `@StubRunnerPort` annotation to inject the port of a running stub. +The value of the annotation can be the `groupid:artifactid` or just the `artifactid`. +The following example works shows Stub Runner IDs for +`com.example:thing1` and `com.example:thing2`. + +==== +[source,java,indent=0] +---- +@StubRunnerPort("thing1") +int thing1Port; +@StubRunnerPort("com.example:thing2") +int thing2Port; +---- +==== + +[[features-stub-runner-cloud]] +=== Stub Runner Spring Cloud + +Stub Runner can integrate with Spring Cloud. + +For real life examples, see: + +- https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/producer[The producer app sample] +- https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/consumer_with_discovery[The consumer app sample] + +[[features-stub-runner-cloud-stubbing-discovery]] +==== Stubbing Service Discovery + +The most important feature of `Stub Runner Spring Cloud` is the fact that it stubs: + +- `DiscoveryClient` +- `Ribbon` `ServerList` + +That means that, regardless of whether you use Zookeeper, Consul, Eureka, or anything +else, you do not need that in your tests. We are starting WireMock instances of your +dependencies and we are telling your application, whenever you use `Feign`, to load a +balanced `RestTemplate` or `DiscoveryClient` directly, to call those stubbed servers +instead of calling the real Service Discovery tool. + +For example, the following test passes: + +==== +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy[tags=test] +---- +==== + +Note that the preceding example requires the following configuration file: + +==== +[source,yml,indent=0] +---- +include::{stubrunner_core_path}/src/test/resources/application.yml[tags=ids] +---- +==== + +[[features-stub-runner-cloud-stubbing-profiles]] +===== Test Profiles and Service Discovery + +In your integration tests, you typically do not want to call either a discovery service (such as Eureka) +or Config Server. That is why you create an additional test configuration in which you want to disable +these features. + +Due to certain limitations of https://github.com/spring-cloud/spring-cloud-commons/issues/156[`spring-cloud-commons`], +to achieve this, you have to disable these properties +in a static block such as the following example (for Eureka): + +==== +[source,java] +---- + //Hack to work around https://github.com/spring-cloud/spring-cloud-commons/issues/156 + static { + System.setProperty("eureka.client.enabled", "false"); + System.setProperty("spring.cloud.config.failFast", "false"); + } +---- +==== + +[[features-stub-runner-additional-config]] +==== Additional Configuration + +You can match the `artifactId` of the stub with the name of your application by using the `stubrunner.idsToServiceIds:` map. +You can disable Stub Runner Ribbon support by setting `stubrunner.cloud.ribbon.enabled` to `false` +You can disable Stub Runner support by setting `stubrunner.cloud.enabled` to `false` + +TIP: By default, all service discovery is stubbed. This means that, regardless of whether you have +an existing `DiscoveryClient`, its results are ignored. However, if you want to reuse it, you can set + `stubrunner.cloud.delegate.enabled` to `true`, and then your existing `DiscoveryClient` results are + merged with the stubbed ones. + +The default Maven configuration used by Stub Runner can be tweaked either +by setting the following system properties or by setting the corresponding environment variables: + +- `maven.repo.local`: Path to the custom maven local repository location +- `org.apache.maven.user-settings`: Path to custom maven user settings location +- `org.apache.maven.global-settings`: Path to maven global settings location + +[[features-stub-runner-boot]] +=== Using the Stub Runner Boot Application + +Spring Cloud Contract Stub Runner Boot is a Spring Boot application that exposes REST endpoints to +trigger the messaging labels and to access WireMock servers. + +One of the use cases is to run some smoke (end-to-end) tests on a deployed application. +You can check out the https://github.com/spring-cloud/spring-cloud-pipelines[Spring Cloud Pipelines] +project for more information. + +[[features-stub-runner-boot-server]] +===== Stub Runner Server + +To use the Stub Runner Server, add the following dependency: + +==== +[source,groovy,indent=0] +---- +compile "org.springframework.cloud:spring-cloud-starter-stub-runner" +---- +==== + +Then annotate a class with `@EnableStubRunnerServer`, build a fat jar, and it is ready to work. + +For the properties, see the <> section. + +[[features-stub-runner-boot-how-fat-jar]] +===== Stub Runner Server Fat Jar + +You can download a standalone JAR from Maven (for example, for version 2.0.1.RELEASE) +by running the following commands: + +==== +[source,bash,indent=0] +---- +$ wget -O stub-runner.jar 'https://search.maven.org/remotecontent?filepath=org/springframework/cloud/spring-cloud-contract-stub-runner-boot/2.0.1.RELEASE/spring-cloud-contract-stub-runner-boot-2.0.1.RELEASE.jar' +$ java -jar stub-runner.jar --stubrunner.ids=... --stubrunner.repositoryRoot=... +---- +==== + +[[features-stub-runner-boot-how-cli]] +===== Spring Cloud CLI + +Starting from the `1.4.0.RELEASE` version of the https://cloud.spring.io/spring-cloud-cli[Spring Cloud CLI] +project, you can start Stub Runner Boot by running `spring cloud stubrunner`. + +In order to pass the configuration, you can create a `stubrunner.yml` file in the current working directory, +in a subdirectory called `config`, or in `~/.spring-cloud`. The file could resemble the following +example for running stubs installed locally: + + +.stubrunner.yml +==== +[source,yml,indent=0] +---- +stubrunner: + stubsMode: LOCAL + ids: + - com.example:beer-api-producer:+:9876 +---- +==== + +Then you can call `spring cloud stubrunner` from your terminal window to start +the Stub Runner server. It is available at port `8750`. + +[[features-stub-runner-boot-endpoints]] +==== Endpoints + +Stub Runner Boot offers two endpoints: + +* <> +* <> + +[[features-stub-runner-boot-endpoints-http]] +===== HTTP + +For HTTP, Stub Runner Boot makes the following endpoints available: + +- GET `/stubs`: Returns a list of all running stubs in `ivy:integer` notation +- GET `/stubs/{ivy}`: Returns a port for the given `ivy` notation (when calling the endpoint `ivy` can also be `artifactId` only) + +[[features-stub-runner-boot-endpoints-messaging]] +===== Messaging + +For Messaging, Stub Runner Boot makes the following endpoints available: + +- GET `/triggers`: Returns a list of all running labels in `ivy : [ label1, label2 ...]` notation +- POST `/triggers/{label}`: Runs a trigger with `label` +- POST `/triggers/{ivy}/{label}`: Runs a trigger with a `label` for the given `ivy` notation +(when calling the endpoint, `ivy` can also be `artifactId` only) + +[[features-stub-runner-boot-endpoints-example]] +==== Example + +The following example shows typical usage of Stub Runner Boot: + +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/server/StubRunnerBootSpec.groovy[tags=boot_usage] +---- + +[[features-stub-runner-boot-service-discovery]] +==== Stub Runner Boot with Service Discovery + +One way to use Stub Runner Boot is to use it as a feed of stubs for "`smoke tests`". What does that mean? +Assume that you do not want to deploy 50 microservices to a test environment in order +to see whether your application works. You have already executed a suite of tests during the build process, +but you would also like to ensure that the packaging of your application works. You can +deploy your application to an environment, start it, and run a couple of tests on it to see whether +it works. We can call those tests "`smoke tests`", because their purpose is to check only a handful +of testing scenarios. + +The problem with this approach is thatm if you use microservices, you most likely also +use a service discovery tool. Stub Runner Boot lets you solve this issue by starting the +required stubs and registering them in a service discovery tool. Consider the following example of +such a setup with Eureka (assume that Eureka is already running): + +==== +[source,java,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/serverexamples/StubRunnerBootEurekaExample.java[tags=stubrunnereureka] +---- +==== + +We want to start a Stub Runner Boot server (`@EnableStubRunnerServer`), enable the Eureka client (`@EnableEurekaClient`), +and have the stub runner feature turned on (`@AutoConfigureStubRunner`). + +Now assume that we want to start this application so that the stubs get automatically registered. +We can do so by running the application with `java -jar ${SYSTEM_PROPS} stub-runner-boot-eureka-example.jar`, where +`${SYSTEM_PROPS}` contains the following list of properties: + +==== +[source,bash,indent=0] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/serverexamples/StubRunnerBootEurekaExample.java[tags=stubrunnereureka_args] +---- +==== + +That way, your deployed application can send requests to started WireMock servers through service +discovery. Most likely, points 1 through 3 could be set by default in `application.yml`, because they are not +likely to change. That way, you can provide only the list of stubs to download whenever you start +the Stub Runner Boot. + +[[features-stub-runner-stubs-per-consumer]] +=== Consumer-Driven Contracts: Stubs Per Consumer + +There are cases in which two consumers of the same endpoint want to have two different responses. + +TIP: This approach also lets you immediately know which consumer uses which part of your API. +You can remove part of a response that your API produces and see which of your autogenerated tests +fails. If none fails, you can safely delete that part of the response, because nobody uses it. + +Consider the following example of a contract defined for the producer called `producer`, +which has two consumers (`foo-consumer` and `bar-consumer`): + +==== +.Consumer `foo-service` +[source,groovy] +---- +request { + url '/foo' + method GET() +} +response { + status OK() + body( + foo: "foo" + } +} +---- + +.Consumer `bar-service` +[source,groovy] +---- +request { + url '/bar' + method GET() +} +response { + status OK() + body( + bar: "bar" + } +} +---- +==== + +You cannot produce two different responses for the same request. That is why you can properly package the +contracts and then profit from the `stubsPerConsumer` feature. + +On the producer side, the consumers can have a folder that contains contracts related only to them. +By setting the `stubrunner.stubs-per-consumer` flag to `true`, we no longer register all stubs but only those that +correspond to the consumer application's name. In other words, we scan the path of every stub and, +if it contains a subfolder with name of the consumer in the path, only then is it registered. + +On the `foo` producer side the contracts would look like this + +[source,bash] +---- +. +└── contracts + ├── bar-consumer + │   ├── bookReturnedForBar.groovy + │   └── shouldCallBar.groovy + └── foo-consumer + ├── bookReturnedForFoo.groovy + └── shouldCallFoo.groovy +---- + +The `bar-consumer` consumer can either set the `spring.application.name` or the `stubrunner.consumer-name` to `bar-consumer` +Alternatively, you can set the test as follows: + +==== +[source,groovy] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerStubsPerConsumerSpec.groovy[tags=test] +... +} +---- +==== + +Then only the stubs registered under a path that contains `bar-consumer` in its name (that is, those from the +`src/test/resources/contracts/bar-consumer/some/contracts/...` folder) are allowed to be referenced. + +You can also set the consumer name explicitly, as follows: + +==== +[source,groovy] +---- +include::{stubrunner_core_path}/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerStubsPerConsumerWithConsumerNameSpec.groovy[tags=test] +... +} +---- +==== + +Then only the stubs registered under a path that contains the `foo-consumer` in its name (that is, those from the +`src/test/resources/contracts/foo-consumer/some/contracts/...` folder) are allowed to be referenced. + +See https://github.com/spring-cloud/spring-cloud-contract/issues/224[issue 224] for more +information about the reasons behind this change. + +[[features-stub-runner-common]] +=== Common Properties + +This section briefly describes common properties, including: + +* <> +* <> + +[[features-stub-runner-common-properties-junit-spring]] +==== Common Properties for JUnit and Spring + +You can set repetitive properties by using system properties or Spring configuration +properties. The following table shows their names with their default values: + +[frame="topbot",options="header"] +|=============== +| Property name | Default value | Description +|stubrunner.minPort|10000| Minimum value of a port for a started WireMock with stubs. +|stubrunner.maxPort|15000| Maximum value of a port for a started WireMock with stubs. +|stubrunner.repositoryRoot|| Maven repo URL. If blank, then call the local Maven repo. +|stubrunner.classifier|stubs| Default classifier for the stub artifacts. +|stubrunner.stubsMode|CLASSPATH| The way you want to fetch and register the stubs +|stubrunner.ids|| Array of Ivy notation stubs to download. +|stubrunner.username|| Optional username to access the tool that stores the JARs with +stubs. +|stubrunner.password|| Optional password to access the tool that stores the JARs with +stubs. +|stubrunner.stubsPerConsumer|`false`| Set to `true` if you want to use different stubs for +each consumer instead of registering all stubs for every consumer. +|stubrunner.consumerName|| If you want to use a stub for each consumer and want to +override the consumer name, change this value. +|=============== + +[[features-stub-runner-stub-runner-stub-ids]] +==== Stub Runner Stubs IDs + +You can set the stubs to download in the `stubrunner.ids` system property. They +use the following pattern: + +==== +[source,java,indent=0] +---- +groupId:artifactId:version:classifier:port +---- +==== + +Note that `version`, `classifier`, and `port` are optional. + +* If you do not provide the `port`, a random one is picked. +* If you do not provide the `classifier`, the default is used. (Note that you can +pass an empty classifier this way: `groupId:artifactId:version:`). +* If you do not provide the `version`, then `+` is passed, and the latest one is +downloaded. + +`port` means the port of the WireMock server. + +IMPORTANT: Starting with version 1.0.4, you can provide a range of versions that you +would like the Stub Runner to take into consideration. You can read more about the +https://wiki.eclipse.org/Aether/New_and_Noteworthy#Version_Ranges[Aether versioning +ranges here]. diff --git a/docs/src/main/asciidoc/_project-features-wiremock.adoc b/docs/src/main/asciidoc/_project-features-wiremock.adoc new file mode 100644 index 0000000000..c2813dbfc6 --- /dev/null +++ b/docs/src/main/asciidoc/_project-features-wiremock.adoc @@ -0,0 +1,192 @@ +[[features-wiremock]] +== Spring Cloud Contract WireMock +include::_attributes.adoc[] + +The Spring Cloud Contract WireMock modules let you use https://github.com/tomakehurst/wiremock[WireMock] in a +Spring Boot application. Check out the +https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples[samples] +for more details. + +If you have a Spring Boot application that uses Tomcat as an embedded server (which is +the default with `spring-boot-starter-web`), you can add +`spring-cloud-starter-contract-stub-runner` to your classpath and add `@AutoConfigureWireMock` +to use Wiremock in your tests. Wiremock runs as a stub server, and you +can register stub behavior by using a Java API or by using static JSON declarations as part of +your test. The following code shows an example: + +==== +[source,java,indent=0] +---- +include::{doc_samples}/src/test/java/com/example/WiremockForDocsTests.java[tags=wiremock_test1] +include::{doc_samples}/src/test/java/com/example/WiremockForDocsTests.java[tags=wiremock_test2] +---- +==== + +To start the stub server on a different port, use (for example), +`@AutoConfigureWireMock(port=9999)`. For a random port, use a value of `0`. The stub +server port can be bound in the test application context with the "wiremock.server.port" +property. Using `@AutoConfigureWireMock` adds a bean of type `WiremockConfiguration` to +your test application context, where it is cached between methods and classes +having the same context. The same is true for Spring integration tests. Also, you can +inject a bean of type `WireMockServer` into your test. + +[[features-wiremock-registering-stubs]] +=== Registering Stubs Automatically + +If you use `@AutoConfigureWireMock`, it registers WireMock JSON stubs from the file +system or classpath (by default, from `file:src/test/resources/mappings`). You can +customize the locations byusing the `stubs` attribute in the annotation, which can be an +Ant-style resource pattern or a directory. In the case of a directory, `**/*.json` is +appended. The following code shows an example: + +==== +---- +@RunWith(SpringRunner.class) +@SpringBootTest +@AutoConfigureWireMock(stubs="classpath:/stubs") +public class WiremockImportApplicationTests { + + @Autowired + private Service service; + + @Test + public void contextLoads() throws Exception { + assertThat(this.service.go()).isEqualTo("Hello World!"); + } + +} +---- +==== + +NOTE: Actually, WireMock always loads mappings from `src/test/resources/mappings` *as +well as* the custom locations in the `stubs` attribute. To change this behavior, you can +also specify a files root, as described in the next section of this document. + +If you use Spring Cloud Contract's default stub jars, your +stubs are stored in the `/META-INF/group-id/artifact-id/versions/mappings/` folder. +If you want to register all stubs from that location, from all embedded JARs, you can use +the following syntax: + +==== +[source,java,indent=0] +---- +include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMockFilesApplicationWithUrlResourceTests.java[tags=load_all_stubs] +---- +==== + +[[features-wiremock-using-files]] +=== Using Files to Specify the Stub Bodies + +WireMock can read response bodies from files on the classpath or the file system. In the +case of the file system, you can see in the JSON DSL that the response has a `bodyFileName` instead of a +(literal) `body`. The files are resolved relative to a root directory (by default, +`src/test/resources/\__files`). To customize this location, you can set the `files` +attribute in the `@AutoConfigureWireMock` annotation to the location of the parent +directory (in other words, `__files` is a subdirectory). You can use Spring resource +notation to refer to `file:...` or `classpath:...` locations. Generic URLs are not +supported. A list of values can be given -- in which case, WireMock resolves the first file +that exists when it needs to find a response body. + +NOTE: When you configure the `files` root, it also affects the +automatic loading of stubs, because they come from the root location +in a subdirectory called `mappings`. The value of `files` has no +effect on the stubs loaded explicitly from the `stubs` attribute. + +[[features-wiremock-junit-rule]] +=== Alternative: Using JUnit Rules + +For a more conventional WireMock experience, you can use JUnit `@Rules` to start and stop +the server. To do so, use the `WireMockSpring` convenience class to obtain an `Options` +instance, as the following example shows: + +==== +[source,java,indent=0] +---- +include::{doc_samples}/src/test/java/com/example/WiremockForDocsClassRuleTests.java[tags=wiremock_test1] +include::{doc_samples}/src/test/java/com/example/WiremockForDocsClassRuleTests.java[tags=wiremock_test2] +---- +==== + +The `@ClassRule` means that the server shuts down after all the methods in this class +have been run. + +[[features-wiremock-relaxed-ssl]] +=== Relaxed SSL Validation for Rest Template + +WireMock lets you stub a "`secure`" server with an `https` URL protocol. If your +application wants to contact that stub server in an integration test, it will find that +the SSL certificates are not valid (the usual problem with self-installed certificates). +The best option is often to re-configure the client to use `http`. If that is not an +option, you can ask Spring to configure an HTTP client that ignores SSL validation errors +(do so only for tests, of course). + +To make this work with minimum fuss, you need to use the Spring Boot +`RestTemplateBuilder` in your application, as the following example shows: + +==== +[source,java,indent=0] +---- + @Bean + public RestTemplate restTemplate(RestTemplateBuilder builder) { + return builder.build(); + } +---- +==== + +You need `RestTemplateBuilder` because the builder is passed through callbacks to +initialize it, so the SSL validation can be set up in the client at that point. This +happens automatically in your test if you use the `@AutoConfigureWireMock` +annotation or the stub runner. If you use the JUnit `@Rule` approach, you need to add the +`@AutoConfigureHttpClient` annotation as well, as the following example shows: + +==== +[source,java,indent=0] +---- +@RunWith(SpringRunner.class) +@SpringBootTest("app.baseUrl=https://localhost:6443") +@AutoConfigureHttpClient +public class WiremockHttpsServerApplicationTests { + + @ClassRule + public static WireMockClassRule wiremock = new WireMockClassRule( + WireMockSpring.options().httpsPort(6443)); +... +} +---- +==== + +If you use `spring-boot-starter-test`, you have the Apache HTTP client on the +classpath, and it is selected by the `RestTemplateBuilder` and configured to ignore SSL +errors. If you use the default `java.net` client, you do not need the annotation (but it +does no harm). There is currently no support for other clients, but it may be added +in future releases. + +To disable the custom `RestTemplateBuilder`, set the `wiremock.rest-template-ssl-enabled` +property to `false`. + +[[features-wiremock-spring-mvc-mocks]] +=== WireMock and Spring MVC Mocks + +Spring Cloud Contract provides a convenience class that can load JSON WireMock stubs into +a Spring `MockRestServiceServer`. The following code shows an example: + +==== +[source,java,indent=0] +---- +include::{doc_samples}/src/test/java/com/example/WiremockForDocsMockServerApplicationTests.java[tags=wiremock_test] +---- +==== + +The `baseUrl` value is prepended to all mock calls, and the `stubs()` method takes a stub +path resource pattern as an argument. In the preceding example, the stub defined at +`/stubs/resource.json` is loaded into the mock server. If the `RestTemplate` is asked to +visit `https://example.org/`, it gets the responses as being declared at that URL. More +than one stub pattern can be specified, and each one can be a directory (for a recursive +list of all `.json`), a fixed filename (as in the preceding example), or an Ant-style +pattern. The JSON format is the normal WireMock format, which you can read about at the +https://wiremock.org/docs/stubbing/[WireMock website]. + +Currently, the Spring Cloud Contract Verifier supports Tomcat, Jetty, and Undertow as +Spring Boot embedded servers, and Wiremock itself has "`native`" support for a particular +version of Jetty (currently 9.2). To use the native Jetty, you need to add the native +Wiremock dependencies and exclude the Spring Boot container (if there is one). diff --git a/docs/src/main/asciidoc/advanced.adoc b/docs/src/main/asciidoc/advanced.adoc new file mode 100644 index 0000000000..e480634eac --- /dev/null +++ b/docs/src/main/asciidoc/advanced.adoc @@ -0,0 +1,413 @@ +[[contract-customization]] += Spring Cloud Contract customization +include::_attributes.adoc[] + +In this section, we describe how to customize various parts of Spring Cloud Contract. + +[[customization-customization]] +== DSL Customization + +IMPORTANT: This section is valid only for the Groovy DSL + +You can customize the Spring Cloud Contract Verifier by extending the DSL, as shown in +the remainder of this section. + +[[customization-extending]] +=== Extending the DSL + +You can provide your own functions to the DSL. The key requirement for this feature is to +maintain the static compatibility. Later in this document, you can see examples of: + +* Creating a JAR with reusable classes. +* Referencing of these classes in the DSLs. + +You can find the full example +https://github.com/spring-cloud-samples/spring-cloud-contract-samples[here]. + +[[customization-extending-common-jar]] +=== Common JAR + +The following examples show three classes that can be reused in the DSLs. + +`PatternUtils` contains functions used by both the consumer and the producer. +The following listing shows the `PatternUtils` class: + +==== +[source,java] +---- +include::{samples_url}/common/src/main/java/com/example/PatternUtils.java[] +---- +==== + +`ConsumerUtils` contains functions used by the consumer. +The following listing shows the `ConsumerUtils` class: + +==== +[source,java] +---- +include::{samples_url}/common/src/main/java/com/example/ConsumerUtils.java[] +---- +==== + +`ProducerUtils` contains functions used by the producer. +The following listing shows the `ProducerUtils` class: + +==== +[source,java] +---- +include::{samples_url}/common/src/main/java/com/example/ProducerUtils.java[] +---- +==== + +[[customization-test-dep]] +=== Adding a Test Dependency in the Project's Dependencies + +To add a test dependency in the project's dependencies, you must first add the common jar +dependency as a test dependency. Because your contracts files +are available on the test resources path, the common jar classes automatically become +visible in your Groovy files. The following examples show how to test the dependency: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- +include::{samples_url}/producer/pom.xml[tags=test_dep,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +include::{samples_url}/producer/build.gradle[tags=test_dep,indent=0] +---- +==== + +[[customization-plugin-dep]] +=== Adding a Test Dependency in the Plugin's Dependencies + +Now, you must add the dependency for the plugin to reuse at runtime, as the +following example shows: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- +include::{samples_url}/producer/pom.xml[tags=test_dep_in_plugin,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +include::{samples_url}/producer/build.gradle[tags=test_dep_in_plugin,indent=0] +---- +==== + +[[customization-referencing]] +=== Referencing Classes in DSLs + +You can now reference your classes in your DSL, as the following example shows: + +==== +[source,groovy] +---- +include::{samples_url}/producer/src/test/resources/contracts/beer/rest/shouldGrantABeerIfOldEnough.groovy[indent=0] +---- +==== + +IMPORTANT: You can set the Spring Cloud Contract plugin up by setting `convertToYaml` to +`true`. That way, you do NOT have to add the dependency with the extended functionality +to the consumer side, since the consumer side uses YAML contracts instead of Groovy contracts. + +[[customization-wiremock]] +== WireMock Customization + +In this section, we show how to customize the way you work with https://wiremock.org[WireMock]. + +[[customization-wiremock-extension]] +=== Registering Your Own WireMock Extension + +WireMock lets you register custom extensions. By default, Spring Cloud Contract registers +the transformer, which lets you reference a request from a response. If you want to +provide your own extensions, you can register an implementation of the +`org.springframework.cloud.contract.verifier.dsl.wiremock.WireMockExtensions` interface. +Since we use the `spring.factories` extension approach, you can create an entry in +`META-INF/spring.factories` file similar to the following: + +==== +[source,groovy,indent=0] +---- +include::{stubrunner_core_path}/src/test/resources/META-INF/spring.factories[indent=0] +---- +==== + +The following example shows a custom extension: + +.TestWireMockExtensions.groovy +==== +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/TestWireMockExtensions.groovy[indent=0] +---- +==== + +IMPORTANT: Remember to override the `applyGlobally()` method and set it to `false` if you +want the transformation to be applied only for a mapping that explicitly requires it. + +[[customization-wiremock-configuration]] +=== Customization of WireMock Configuration + +You can register a bean of type `org.springframework.cloud.contract.wiremock.WireMockConfigurationCustomizer` +to customize the WireMock configuration (for example, to add custom transformers). +The following example shows how to do so: + +==== +[source,java,indent=0] +---- +include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMockConfigurationCustomizerTests.java[tags=customizer_1] +// perform your customization here +include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMockConfigurationCustomizerTests.java[tags=customizer_2] +---- +==== + +[[customization-pluggable-architecture]] +== Using the Pluggable Architecture + +You may encounter cases where your contracts have been defined in other formats, +such as YAML, RAML, or PACT. In those cases, you still want to benefit from the automatic +generation of tests and stubs. You can add your own implementation for generating both +tests and stubs. Also, you can customize the way tests are generated (for example, you +can generate tests for other languages) and the way stubs are generated (for example, you +can generate stubs for other HTTP server implementations). + +[[customization-custom-contract-converter]] +=== Custom Contract Converter + +The `ContractConverter` interface lets you register your own implementation of a contract +structure converter. The following code listing shows the `ContractConverter` interface: + +==== +[source,java] +---- +include::{contract_spec_path}/src/main/java/org/springframework/cloud/contract/spec/ContractConverter.java[indent=0,lines=17..-1] +---- +==== + +Your implementation must define the condition on which it should start the +conversion. Also, you must define how to perform that conversion in both directions. + +IMPORTANT: Once you create your implementation, you must create a +`/META-INF/spring.factories` file in which you provide the fully qualified name of your +implementation. + +The following example shows a typical `spring.factories` file: + +==== +[source] +---- +org.springframework.cloud.contract.spec.ContractConverter=\ +org.springframework.cloud.contract.verifier.converter.YamlContractConverter +---- +==== + +[[customization-custom-test-generator]] +=== Using the Custom Test Generator + +If you want to generate tests for languages other than Java or you are not happy with the +way the verifier builds Java tests, you can register your own implementation. + +The `SingleTestGenerator` interface lets you register your own implementation. The +following code listing shows the `SingleTestGenerator` interface: + +==== +[source,groovy] +---- +include::{verifier_core_path}/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGenerator.java[indent=0,lines=17..-1] +---- +==== + +Again, you must provide a `spring.factories` file, such as the one shown in the following +example: + +==== +[source] +---- +org.springframework.cloud.contract.verifier.builder.SingleTestGenerator=/ +com.example.MyGenerator +---- +==== + +[[customization-custom-stub-generator]] +=== Using the Custom Stub Generator + +If you want to generate stubs for stub servers other than WireMock, you can plug in your +own implementation of the `StubGenerator` interface. The following code listing shows the +`StubGenerator` interface: + +==== +[source,groovy] +---- +include::{converters_path}/src/main/groovy/org/springframework/cloud/contract/verifier/converter/StubGenerator.java[indent=0,lines=16..-1] +---- +==== + +Again, you must provide a `spring.factories` file, such as the one shown in the following +example: + +==== +[source] +---- +include::{converters_path}/src/main/resources/META-INF/spring.factories[indent=0] +---- +==== + +The default implementation is the WireMock stub generation. + +TIP: You can provide multiple stub generator implementations. For example, from a single +DSL, you can produce both WireMock stubs and Pact files. + +[[customization-custom-stub-runner]] +=== Using the Custom Stub Runner + +If you decide to use a custom stub generation, you also need a custom way of running +stubs with your different stub provider. + +Assume that you use https://github.com/dreamhead/moco[Moco] to build your stubs and that +you have written a stub generator and placed your stubs in a JAR file. + +In order for Stub Runner to know how to run your stubs, you have to define a custom +HTTP Stub server implementation, which might resemble the following example: + +==== +[source,groovy] +---- +include::{tests_path}/spring-cloud-contract-stub-runner-moco/src/test/groovy/org/springframework/cloud/contract/stubrunner/provider/moco/MocoHttpServerStub.groovy[indent=0,lines=16..-1] +---- +==== + +Then you can register it in your `spring.factories` file, as the following +example shows: + +==== +[source] +---- +org.springframework.cloud.contract.stubrunner.HttpServerStub=\ +org.springframework.cloud.contract.stubrunner.provider.moco.MocoHttpServerStub +---- +==== + +Now you can run stubs with Moco. + +IMPORTANT: If you do not provide any implementation, the default (WireMock) +implementation is used. If you provide more than one, the first one on the list is used. + +[[customization-custom-stub-downloader]] +=== Using the Custom Stub Downloader + +You can customize the way your stubs are downloaded by creating an implementation of the +`StubDownloaderBuilder` interface, as the following example shows: + +==== +[source,java] +---- +package com.example; + +class CustomStubDownloaderBuilder implements StubDownloaderBuilder { + + @Override + public StubDownloader build(final StubRunnerOptions stubRunnerOptions) { + return new StubDownloader() { + @Override + public Map.Entry downloadAndUnpackStubJar( + StubConfiguration config) { + File unpackedStubs = retrieveStubs(); + return new AbstractMap.SimpleEntry<>( + new StubConfiguration(config.getGroupId(), config.getArtifactId(), version, + config.getClassifier()), unpackedStubs); + } + + File retrieveStubs() { + // here goes your custom logic to provide a folder where all the stubs reside + } +} +---- +==== + +Then you can register it in your `spring.factories` file, as the following +example shows: + +==== +[source] +---- +# Example of a custom Stub Downloader Provider +org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder=\ +com.example.CustomStubDownloaderBuilder +---- +==== + +Now you can pick a folder with the source of your stubs. + +IMPORTANT: If you do not provide any implementation, the default (scanning the classpath) is used. +If you provide the `stubsMode = StubRunnerProperties.StubsMode.LOCAL` or +`stubsMode = StubRunnerProperties.StubsMode.REMOTE`, the Aether implementation is used +If you provide more than one, the first one on the list is used. + +[[scm-stub-downloader]] +=== Using the SCM Stub Downloader + +Whenever the `repositoryRoot` starts with a SCM protocol +(currently, we support only `git://`), the stub downloader tries +to clone the repository and use it as a source of contracts +to generate tests or stubs. + +Through environment variables, system properties, or properties set +inside the plugin or the contracts repository configuration, you can +tweak the downloader's behavior. The following table describes the available +properties: + +.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 milliseconds to wait between attempts to push the commits to `origin` +|==== diff --git a/docs/src/main/asciidoc/building.adoc b/docs/src/main/asciidoc/building.adoc deleted file mode 100644 index 79fe0f349a..0000000000 --- a/docs/src/main/asciidoc/building.adoc +++ /dev/null @@ -1,101 +0,0 @@ -== How to build it - -IMPORTANT: You need to have all the necessary Groovy plugins - installed for your IDE to properly resolve the sources. For example in - Intellij IDEA having both Eclipse Groovy Compiler Plugin & GMavenPlus Intellij Plugin - results in properly imported project. - -IMPORTANT: Spring Cloud Contract builds Docker images. Remember to -have Docker installed. - -IMPORTANT: If you want to run the build in offline mode, you have to have Maven 3.5.2+ installed. - -=== Project structure - -Here you can find the Spring Cloud Contract folder structure - -``` -├── config -├── docker -├── samples -├── scripts -├── specs -├── spring-cloud-contract-dependencies -├── spring-cloud-contract-shade -├── spring-cloud-contract-starters -├── spring-cloud-contract-stub-runner -├── spring-cloud-contract-stub-runner-boot -├── spring-cloud-contract-tools -├── spring-cloud-contract-verifier -├── spring-cloud-contract-wiremock -└── tests -``` - - - `config` - folder contains setup for Spring Cloud Release Tools automated release process - - `docker` - folder contains docker images - - `samples` - folder contains test samples together with standalone ones used also to build documentation - - `scripts` - contains scripts to build and test `Spring Cloud Contract` with Maven, Gradle and standalone projects - - `specs` - contains specifications for the Contract DSL. - - `spring-cloud-contract-dependencies` - contains Spring Cloud Contract BOM - - `spring-cloud-contract-shade` - shaded dependencies used by the plugins - - `spring-cloud-contract-starters` - contains Spring Cloud Contract Starters - - `spring-cloud-contract-spec` - contains specification modules (contains concept of a Contract) - - `spring-cloud-contract-stub-runner` - contains Stub Runner related modules - - `spring-cloud-contract-stub-runner-boot` - contains Stub Runner Boot app - - `spring-cloud-contract-tools` - Gradle and Maven plugin for `Spring Cloud Contract Verifier` - - `spring-cloud-contract-verifier` - core of the `Spring Cloud Contract Verifier` functionality - - `spring-cloud-contract-wiremock` - all WireMock related functionality - - `tests` - integration tests for different messaging technologies - -=== Commands - -To build the core functionality together with Maven Plugin you can run - -``` -./mvnw clean install -P integration -``` - -Calling that function will build core, Maven plugin, Gradle plugin and run end to end tests on the -standalone samples in proper order (both for Maven and Gradle). - -To build the Gradle Plugin only - -``` -cd spring-cloud-contract-tools/spring-cloud-contract-gradle-plugin -./gradlew clean build -``` - -=== Helpful scripts - -We're providing a couple of helpful scripts to build the project. - -To build the project in parallel (by default uses 4 cores but you can change it) - -``` -./scripts/parallelBuild.sh -``` - -and with 8 cores - -``` -CORES=8 ./scripts/parallelBuild.sh -``` - -To build the project without any integration tests (by default uses 1 core) - -``` -./scripts/noIntegration.sh -``` - -and with 8 cores - -``` -CORES=8 ./scripts/noIntegration.sh -``` - -To generate the documentation (both the root one and the maven plugin one) - -``` -./scripts/generateDocs.sh -``` - diff --git a/docs/src/main/asciidoc/docker-project.adoc b/docs/src/main/asciidoc/docker-project.adoc new file mode 100644 index 0000000000..55c3a899c9 --- /dev/null +++ b/docs/src/main/asciidoc/docker-project.adoc @@ -0,0 +1,275 @@ +[[docker]] += Docker Project +include::_attributes.adoc[] + +In this section, we publish a `springcloud/spring-cloud-contract` Docker image +that contains a project that generates tests and runs them in `EXPLICIT` mode +against a running application. + +TIP: The `EXPLICIT` mode means that the tests generated from contracts send +real requests and not the mocked ones. + +We also publish a `spring-cloud/spring-cloud-contract-stub-runner` Docker image +that starts the standalone version of Stub Runner. + +[[docker-intro]] +== A Short Introduction to Maven, JARs and Binary storage + +Since non-JVM projects can use the Docker image, it is good to +explain the basic terms behind Spring Cloud Contract packaging defaults. + +Parts of the following definitions were taken from the https://maven.apache.org/glossary.html[Maven Glossary]: + +- `Project`: Maven thinks in terms of projects. Projects +are all you build. Those projects follow a well defined +“Project Object Model”. Projects can depend on other projects, +in which case the latter are called “dependencies”. A project may +consistent of several subprojects. However, these subprojects are still +treated equally as projects. +- `Artifact`: An artifact is something that is either produced or used +by a project. Examples of artifacts produced by Maven for a project +include JAR files and source and binary distributions. Each artifact +is uniquely identified by a group ID and an artifact ID that is +unique within a group. +- `JAR`: JAR stands for Java ARchive. Its format is based on +the ZIP file format. Spring Cloud Contract packages the contracts and generated +stubs in a JAR file. +- `GroupId`: A group ID is a universally unique identifier for a project. +While this is often just the project name (for example, `commons-collections`), +it is helpful to use a fully-qualified package name to distinguish it +from other projects with a similar name (for example, `org.apache.maven`). +Typically, when published to the Artifact Manager, the `GroupId` gets +slash separated and forms part of the URL. For example, for a group ID of `com.example` +and an artifact ID of `application`, the result would be `/com/example/application/`. +- `Classifier`: The Maven dependency notation looks as follows: +`groupId:artifactId:version:classifier`. The classifier is an additional suffix +passed to the dependency -- for example, `stubs` or `sources`. The same dependency +(for example, `com.example:application`) can produce multiple artifacts that +differ from each other with the classifier. +- `Artifact manager`: When you generate binaries, sources, or packages, you would +like them to be available for others to download, reference, or reuse. In the case +of the JVM world, those artifacts are generally JARs. For Ruby, those artifacts are gems. +For Docker, those artifacts are Docker images. You can store those artifacts +in a manager. Examples of such managers include https://jfrog.com/artifactory/[Artifactory] +or https://www.sonatype.org/nexus/[Nexus]. + +[[docker-how-it-works]] +== Generating Tests on the Producer Side + +The image searches for contracts under the `/contracts` folder. +The output from running the tests is available in the +`/spring-cloud-contract/build` folder (useful for debugging +purposes). + +You can mount your contracts and pass the environment variables. +The image then: + +- Generates the contract tests +- Runs the tests against the provided URL +- Generates the https://github.com/tomakehurst/wiremock[WireMock] stubs +- Publishes the stubs to a Artifact Manager (optional - turned on by default) + +[[docker-env-vars]] +=== Environment Variables + +The Docker image requires some environment variables to point to +your running application, to the Artifact manager instance, and so on. +The following list describes the environment variables: + +- `PROJECT_GROUP`: Your project's group ID. Defaults to `com.example`. +- `PROJECT_VERSION`: Your project's version. Defaults to `0.0.1-SNAPSHOT`. +- `PROJECT_NAME`: Your project's artifact id. Defaults to `example`. +- `PRODUCER_STUBS_CLASSIFIER`: Archive classifier used for generated producer stubs. Defaults to `stubs`. +- `REPO_WITH_BINARIES_URL`: URL of your Artifact Manager. Defaults to `http://localhost:8081/artifactory/libs-release-local`, +which is the default URL of https://jfrog.com/artifactory/[Artifactory] running locally. +- `REPO_WITH_BINARIES_USERNAME`: (optional) Username when the Artifact Manager is secured. Defaults to `admin`. +- `REPO_WITH_BINARIES_PASSWORD`: (optional) Password when the Artifact Manager is secured. Defaults to `password`. +- `PUBLISH_ARTIFACTS`: If set to `true`, publishes the artifact to binary storage. Defaults to `true`. + +These environment variables are used when contracts lay in an external repository. To enable +this feature, you must set the `EXTERNAL_CONTRACTS_ARTIFACT_ID` environment variable. + +- `EXTERNAL_CONTRACTS_GROUP_ID`: Group ID of the project with contracts. Defaults to `com.example` +- `EXTERNAL_CONTRACTS_ARTIFACT_ID`: Artifact ID of the project with contracts. +- `EXTERNAL_CONTRACTS_CLASSIFIER`: Classifier of the project with contracts. Empty by default. +- `EXTERNAL_CONTRACTS_VERSION`: Version of the project with contracts. Defaults to `+`, equivalent to picking the latest. +- `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL`: URL of your Artifact Manager. It defaults to +the value of `REPO_WITH_BINARIES_URL` environment variable. +If that is not set, it defaults to `http://localhost:8081/artifactory/libs-release-local`, +which is the default URL of https://jfrog.com/artifactory/[Artifactory] running locally. +- `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_USERNAME`: (optional) Username if the `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL` +requires authentication. It defaults to `REPO_WITH_BINARIES_USERNAME`. If that is not set, it defaults to `admin`. +- `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_PASSWORD`: (optional) Password if the `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL` +requires authentication. It defaults to `REPO_WITH_BINARIES_PASSWORD`. If that is not set, it defaults to `password`. +- `EXTERNAL_CONTRACTS_PATH`: Path to contracts for the given project, inside the project with contracts. +Defaults to slash-separated `EXTERNAL_CONTRACTS_GROUP_ID` concatenated with `/` and `EXTERNAL_CONTRACTS_ARTIFACT_ID`. For example, +for group id `cat-server-side.dog` and artifact id `fish`, would result in `cat/dog/fish` for the contracts path. +- `EXTERNAL_CONTRACTS_WORK_OFFLINE`; If set to `true`, retrieves the artifact with contracts +from the container's `.m2`. Mount your local `.m2` as a volume available at the container's `/root/.m2` path. + +WARNING: You must not set both `EXTERNAL_CONTRACTS_WORK_OFFLINE` and `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL`. + +The following environment variables are used when tests are executed: + +- `APPLICATION_BASE_URL`: URL against which tests should be run. +Remember that it has to be accessible from the Docker container (for example, `localhost` +does not work) +- `APPLICATION_USERNAME`: (optional) Username for basic authentication to your application. +- `APPLICATION_PASSWORD`: (optional) Password for basic authentication to your application. + +[[docker-example-of-usage]] +=== Example of Usage + +In this section, we explore a simple MVC application. To get started, clone the following +git repository and cd to the resulting directory, by running the following commands: + +==== +[source,bash] +---- +$ git clone https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs +$ cd bookstore +---- +==== + +The contracts are available in the `/contracts` folder. + +Since we want to run tests, we can run the following command: + +==== +[source,bash] +---- +$ npm test +---- +==== + +However, for learning purposes, we split it into pieces, as follows: + +==== +[source,bash] +---- +# Stop docker infra (nodejs, artifactory) +$ ./stop_infra.sh +# Start docker infra (nodejs, artifactory) +$ ./setup_infra.sh + +# Kill & Run app +$ pkill -f "node app" +$ nohup node app & + +# Prepare environment variables +$ SC_CONTRACT_DOCKER_VERSION="..." +$ APP_IP="192.168.0.100" +$ APP_PORT="3000" +$ ARTIFACTORY_PORT="8081" +$ APPLICATION_BASE_URL="http://${APP_IP}:${APP_PORT}" +$ ARTIFACTORY_URL="http://${APP_IP}:${ARTIFACTORY_PORT}/artifactory/libs-release-local" +$ CURRENT_DIR="$( pwd )" +$ CURRENT_FOLDER_NAME=${PWD##*/} +$ PROJECT_VERSION="0.0.1.RELEASE" + +# Execute contract tests +$ docker run --rm -e "APPLICATION_BASE_URL=${APPLICATION_BASE_URL}" -e "PUBLISH_ARTIFACTS=true" -e "PROJECT_NAME=${CURRENT_FOLDER_NAME}" -e "REPO_WITH_BINARIES_URL=${ARTIFACTORY_URL}" -e "PROJECT_VERSION=${PROJECT_VERSION}" -v "${CURRENT_DIR}/contracts/:/contracts:ro" -v "${CURRENT_DIR}/node_modules/spring-cloud-contract/output:/spring-cloud-contract-output/" springcloud/spring-cloud-contract:"${SC_CONTRACT_DOCKER_VERSION}" + +# Kill app +$ pkill -f "node app" +---- +==== + +Through bash scripts, the following happens: + +- The infrastructure (MongoDb and Artifactory) is set up. +In a real-life scenario, you would run the NodeJS application +with a mocked database. In this example, we want to show how we can +benefit from Spring Cloud Contract in very little time. +- Due to those constraints, the contracts also represent the +stateful situation. +** The first request is a `POST` that causes data to get inserted to the database. +** The second request is a `GET` that returns a list of data with 1 previously inserted element. +- The NodeJS application is started (on port `3000`). +- The contract tests are generated through Docker, and tests +are run against the running application. +** The contracts are taken from `/contracts` folder. +** The output of the test execution is available under +`node_modules/spring-cloud-contract/output`. +- The stubs are uploaded to Artifactory. You can find them in +http://localhost:8081/artifactory/libs-release-local/com/example/bookstore/0.0.1.RELEASE/ . +The stubs are at http://localhost:8081/artifactory/libs-release-local/com/example/bookstore/0.0.1.RELEASE/bookstore-0.0.1.RELEASE-stubs.jar. + +[[docker-stubrunner]] +== Running Stubs on the Consumer Side + +This section describes how to use Docker on the consumer side to fetch and run stubs. + +We publish a `spring-cloud/spring-cloud-contract-stub-runner` Docker image +that starts the standalone version of Stub Runner. + +[[docker-stubrunner-env-vars]] +=== Environment Variables + +You can run the docker image and pass any of the <> +as environment variables. The convention is that all the +letters should be upper case. +The dot (`.`) should be replaced with underscore (`_`) characters. For example, +the `stubrunner.repositoryRoot` property should be represented +as a `STUBRUNNER_REPOSITORY_ROOT` environment variable. + +[[docker-stubrunner-example]] +=== Example of Usage + +We want to use the stubs created in this <> step. +Assume that we want to run the stubs on port `9876`. You can see the NodeJS code +by cloning the repository and changing to the directory indicated in the following commands: + +==== +[source,bash] +---- +$ git clone https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs +$ cd bookstore +---- +==== + +Now we can run the Stub Runner Boot application with the stubs, by running the following +commands: + +==== +[source,bash] +---- +# Provide the Spring Cloud Contract Docker version +$ SC_CONTRACT_DOCKER_VERSION="..." +# The IP at which the app is running and Docker container can reach it +$ APP_IP="192.168.0.100" +# Spring Cloud Contract Stub Runner properties +$ STUBRUNNER_PORT="8083" +# Stub coordinates 'groupId:artifactId:version:classifier:port' +$ STUBRUNNER_IDS="com.example:bookstore:0.0.1.RELEASE:stubs:9876" +$ STUBRUNNER_REPOSITORY_ROOT="http://${APP_IP}:8081/artifactory/libs-release-local" +# Run the docker with Stub Runner Boot +$ docker run --rm -e "STUBRUNNER_IDS=${STUBRUNNER_IDS}" -e "STUBRUNNER_REPOSITORY_ROOT=${STUBRUNNER_REPOSITORY_ROOT}" -e "STUBRUNNER_STUBS_MODE=REMOTE" -p "${STUBRUNNER_PORT}:${STUBRUNNER_PORT}" -p "9876:9876" springcloud/spring-cloud-contract-stub-runner:"${SC_CONTRACT_DOCKER_VERSION}" +---- +==== + +When the preceding commands run, + +- A standalone Stub Runner application gets started. +- It downloads the stub with coordinates `com.example:bookstore:0.0.1.RELEASE:stubs` on port `9876`. +- It gets downloads from Artifactory running at `http://192.168.0.100:8081/artifactory/libs-release-local`. +- After a whil, Stub Runner is running on port `8083`. +- The stubs are running at port `9876`. + +On the server side, we built a stateful stub. We can use curl to assert +that the stubs are setup properly. To do so, run the following commands: + +==== +[source,bash] +---- +# let's execute the first request (no response is returned) +$ curl -H "Content-Type:application/json" -X POST --data '{ "title" : "Title", "genre" : "Genre", "description" : "Description", "author" : "Author", "publisher" : "Publisher", "pages" : 100, "image_url" : "https://d213dhlpdb53mu.cloudfront.net/assets/pivotal-square-logo-41418bd391196c3022f3cd9f3959b3f6d7764c47873d858583384e759c7db435.svg", "buy_url" : "https://pivotal.io" }' http://localhost:9876/api/books +# Now time for the second request +$ curl -X GET http://localhost:9876/api/books +# You will receive contents of the JSON +---- +==== + +IMPORTANT: If you want use the stubs that you have built locally, on your host, +you should set the `-e STUBRUNNER_STUBS_MODE=LOCAL` environment variable and mount +the volume of your local m2 (`-v "${HOME}/.m2/:/root/.m2:ro"`). diff --git a/docs/src/main/asciidoc/documentation-overview.adoc b/docs/src/main/asciidoc/documentation-overview.adoc new file mode 100644 index 0000000000..397b3b9628 --- /dev/null +++ b/docs/src/main/asciidoc/documentation-overview.adoc @@ -0,0 +1,128 @@ +[[documentation]] += Spring Cloud Contract Documentation +include::_attributes.adoc[] + +This section provides a brief overview of {project-full-name} reference documentation. It serves +as a map for the rest of the document. + + + +[[contract-documentation-about]] +== About the Documentation + +The {project-full-name} reference guide is available as + +* {docs-url}/html[Multi-page HTML] +* {docs-url}/htmlsingle[Single-page HTML] +* {docs-url}/pdf/{project-name}.pdf[PDF] + +Copies of this document may be made for your own use and for distribution to others, +provided that you do not charge any fee for such copies and further provided that each +copy contains this Copyright Notice, whether distributed in print or electronically. + + + +[[documentation-getting-help]] +== Getting Help +If you have trouble with {project-full-name}, we would like to help. + +* Try the <>. They provide solutions to the most +common questions. +* Learn the {project-full-name} basics. If you are +starting out with {project-full-name}, try one of the https://spring.io/guides[guides]. +* Ask a question. We monitor https://stackoverflow.com[stackoverflow.com] for questions +tagged with https://stackoverflow.com/tags/{project-name}[`{project-name}`]. +* Report bugs with {project-full-name} at https://github.com/spring-cloud/{project-name}/issues. +* Chat with us at http://https://gitter.im/spring-cloud/{project-name}[{project-full-name} Gitter] + +NOTE: All of {project-full-name} is open source, including the documentation. If you find +problems with the docs or if you want to improve them, please {github-code}[get +involved]. + + +[[contract-documentation-first-steps]] +== First Steps +If you are getting started with {project-full-name} or 'Spring' in general, start with +<>: + +* *From scratch:* +<> | +<> | +<> +* *Tutorial:* +<> | +<> | +<> | +<> + + + +== Working with {project-full-name} +Ready to actually start using {project-full-name}? <>: + +* *Provider contract testing:* + +** <> +** <> +** <> +** <> +** <> + +* *Consumer-Driven contract testing:* +** <> +** <> +** <> + +TIP: We talk about *Provider Contracts* when it is the producer of the API that defines the contracts and +publishes it for all its consumers to use. This approach is useful for producers that cannot +directly collaborate with their consumers -- for example, when there are too many consumers or +the consumers are external (do not work within the same company). + +TIP: We use the term, *Consumer-Driven Contracts*, to refer to workflows where the consumers of an API +play a vital role in the process of creating the contracts. We recommended this approach, because it is easy +to implement when both producer and consumer teams work for the same organizations and the number +of consumers is not extremely large. + +== Learning about {project-full-name} Features +Need more details about {project-full-name}'s core features? +<>: + +* *Core Features:* +<> | +<> | +<> +* *Integrations:* +<> | +<> | +<> +<> +* *Modules:* +<> | +<> +// TODO: links don't work in "build Tools" section +* *Build Tools:* +link:maven-project.html[Contract Verifier - Maven] | +link:gradle-project.html[Contract Verifier - Gradle] | +link:docker-project.html[Docker] + + +== Advanced Topics +Finally, we have a few topics for more advanced users: + +* *Customizing the DSL:* +<> | +<> | +<> | +<> | +<> +* *Customizing WireMock:* +<> | +<> +* *Customizing {project-full-name}:* +<> | +<> | +<> | +<> | +<> | +<> diff --git a/docs/src/main/asciidoc/verifier_introduction.adoc b/docs/src/main/asciidoc/getting-started.adoc similarity index 56% rename from docs/src/main/asciidoc/verifier_introduction.adoc rename to docs/src/main/asciidoc/getting-started.adoc index 38de8a003f..10959c3aab 100644 --- a/docs/src/main/asciidoc/verifier_introduction.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -1,42 +1,45 @@ -== Spring Cloud Contract Verifier Introduction +[[getting-started]] += Getting Started +include::_attributes.adoc[] -Spring Cloud Contract Verifier enables Consumer Driven Contract (CDC) development of -JVM-based applications. It moves TDD to the level of software architecture. +If you are getting started with {project-full-name}, or Spring in general, start by reading +this section. It answers the basic "`what?`", "`how?`" and "`why?`" questions. It +includes an introduction to {project-full-name}, along with installation instructions. We then +walk you through building your first {project-full-name} application, discussing some core +principles as we go. -Spring Cloud Contract Verifier ships with _Contract Definition Language_ (CDL). Contract -definitions are used to produce the following resources: +[[getting-started-introducing-spring-cloud-contract]] +== Introducing Spring Cloud Contract -* JSON stub definitions to be used by WireMock when doing integration testing on the -client code (_client tests_). Test code must still be written by hand, and test data is -produced by Spring Cloud Contract Verifier. -* Messaging routes, if you're using a messaging service. We integrate with Spring -Integration, Spring Cloud Stream, Spring AMQP, and Apache Camel. You can also set your -own integrations. -* Acceptance tests (in JUnit 4, JUnit 5, TestNG or Spock) are used to verify if server-side implementation -of the API is compliant with the contract (__server tests__). A full test is generated by -Spring Cloud Contract Verifier. +Spring Cloud Contract moves TDD to the level of software architecture. +It lets you perform consumer-driven and producer-driven contract testing. +[[getting-started-introducing-spring-cloud-contract-history]] === History Before becoming Spring Cloud Contract, this project was called https://github.com/Codearte/accurest[Accurest]. It was created by https://twitter.com/mgrzejszczak[Marcin Grzejszczak] and https://twitter.com/jkubrynski[Jakub Kubrynski] -from (https://github.com/Codearte[Codearte]. +from (https://github.com/Codearte[Codearte]). The `0.1.0` release took place on 26 Jan 2015 and it became stable with `1.0.0` release on 29 Feb 2016. -=== Why a Contract Verifier? +[[getting-started-introducing-spring-cloud-contract-why]] +==== Why Do You Need It? -Assume that we have a system consisting of multiple microservices: +Assume that we have a system that consists of multiple microservices, as the following +image shows: -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/docs/src/main/asciidoc/images/Deps.png[Microservices Architecture] +image::Deps.png[Microservices Architecture] -==== Testing issues +[[getting-started-introducing-spring-cloud-contract-testing-issues]] +==== Testing Issues -If we wanted to test the application in top left corner to determine whether it can -communicate with other services, we could do one of two things: +If we want to test the application in the top left corner of the image in the preceding +section to determine whether it can communicate with other services, we could do one of +two things: - Deploy all microservices and perform end-to-end tests. -- Mock other microservices in unit/integration tests. +- Mock other microservices in unit and integration tests. Both have their advantages but also a lot of disadvantages. @@ -49,15 +52,15 @@ Advantages: Disadvantages: -- To test one microservice, we have to deploy 6 microservices, a couple of databases, -etc. +- To test one microservice, we have to deploy six microservices, a couple of databases, +and other items. - The environment where the tests run is locked for a single suite of tests (nobody else would be able to run the tests in the meantime). - They take a long time to run. - The feedback comes very late in the process. - They are extremely hard to debug. -*Mock other microservices in unit/integration tests* +*Mock other microservices in unit and integration tests* Advantages: @@ -70,67 +73,116 @@ Disadvantages: reality. - You can go to production with passing tests and failing production. -To solve the aforementioned issues, Spring Cloud Contract Verifier with Stub Runner was -created. The main idea is to give you very fast feedback, without the need to set up the +To solve the aforementioned issues, Spring Cloud Contract was created. The main idea is to +give you very fast feedback, without the need to set up the whole world of microservices. If you work on stubs, then the only applications you need -are those that your application directly uses. +are those that your application directly uses. The following image shows the relationship +of stubs to an application: -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/docs/src/main/asciidoc/images/Stubs2.png[Stubbed Services] +image::Stubs2.png[Stubbed Services] -Spring Cloud Contract Verifier gives you the certainty that the stubs that you use were -created by the service that you're calling. Also, if you can use them, it means that they +Spring Cloud Contract gives you the certainty that the stubs that you use were +created by the service that you call. Also, if you can use them, it means that they were tested against the producer's side. In short, you can trust those stubs. +[[getting-started-introducing-spring-cloud-contract-purposes]] === Purposes -The main purposes of Spring Cloud Contract Verifier with Stub Runner are: +The main purposes of Spring Cloud Contract are: -- To ensure that WireMock/Messaging stubs (used when developing the client) do exactly +- To ensure that HTTP and Messaging stubs (used when developing the client) do exactly what the actual server-side implementation does. -- To promote ATDD method and Microservices architectural style. -- To provide a way to publish changes in contracts that are immediately visible on both -sides. +- To promote the ATDD (acceptance test-driven developement) method and the microservices architectural style. +- To provide a way to publish changes in contracts that are immediately visible on both sides. - To generate boilerplate test code to be used on the server side. -IMPORTANT: Spring Cloud Contract Verifier's purpose is NOT to start writing business +By default, Spring Cloud Contract integrates with http://wiremock.org[Wiremock] as the HTTP server stub. + +IMPORTANT: Spring Cloud Contract's purpose is NOT to start writing business features in the contracts. Assume that we have a business use case of fraud check. If a -user can be a fraud for 100 different reasons, we would assume that you would create 2 +user can be a fraud for 100 different reasons, we would assume that you would create two contracts, one for the positive case and one for the negative case. Contract tests are used to test contracts between applications and not to simulate full behavior. -=== How It Works +[[getting-started-what-is-a-contract]] +=== What Is a Contract? -This section explores how Spring Cloud Contract Verifier with Stub Runner works. +As consumers of services, we need to define what exactly we want to achieve. We need to +formulate our expectations. That is why we write contracts. In other words, a contract is +an agreement on how the API or message communication should look. Consider the following example: -[[spring-cloud-contract-verifier-intro-three-second-tour]] -==== A Three-second Tour +Assume that you want to send a request that contains the ID of a client company and the +amount it wants to borrow from us. You also want to send it to the `/fraudcheck` URL via +the `PUT` method. The following listing shows a contract to check whether a client should +be marked as a fraud in both Groovy and YAML: -This very brief tour walks through using Spring Cloud Contract: +==== +[source,groovy,indent=0,role="primary"] +.groovy +---- +include::{introduction_url}/samples/standalone/dsl/http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.groovy[] +---- -* <> -* <> +[source,yaml,indent=0,role="secondary"] +.yaml +---- +include::{introduction_url}/samples/standalone/yml/http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.yml[] +---- +==== + +[[getting-started-three-second-tour]] +== A Three-second Tour + +This very brief tour walks through using Spring Cloud Contract. It consists of the +following topics: + +* <> +* <> You can find a somewhat longer tour -<>. +<>. -[[spring-cloud-contract-verifier-intro-three-second-tour-producer]] -===== On the Producer Side +The following UML diagram shows the relationship of the parts within Spring Cloud Contract: -To start working with Spring Cloud Contract, add files with `REST/` messaging contracts +[plantuml, getting-started-three-second, png] +---- +"API Producer"->"API Producer": add Spring Cloud \nContract (SCC) plugin +"API Producer"->"API Producer": add SCC Verifier dependency +"API Producer"->"API Producer": define contracts +"API Producer"->"Build": run build +"Build"->"SCC Plugin": generate \ntests, stubs and stubs \nartifact (e.g. stubs-jar) +"Build"->"Stub Storage": upload contracts \nand stubs and the project arifact +"Build"->"API Producer": Build successful +"API Consumer"->"API Consumer": add SCC Stub Runner \ndependency +"API Consumer"->"API Consumer": write a SCC Stub Runner \nbased contract test +"SCC Stub Runner"->"Stub Storage": test asks for [API Producer] stubs +"Stub Storage"->"SCC Stub Runner": fetch the [API Producer] stubs +"SCC Stub Runner"->"SCC Stub Runner": run in memory\n HTTP server stubs +"API Consumer"->"SCC Stub Runner": send a request \nto the HTTP server stub +"SCC Stub Runner"->"API Consumer": communication is correct +---- + +[[getting-started-three-second-tour-producer]] +=== On the Producer Side + +To start working with Spring Cloud Contract, you can add files with REST or messaging contracts expressed in either Groovy DSL or YAML to the contracts directory, which is set by the `contractsDslDir` property. By default, it is `$rootDir/src/test/resources/contracts`. -Then add the Spring Cloud Contract Verifier dependency and plugin to your build file, as -shown in the following example: +Then you can add the Spring Cloud Contract Verifier dependency and plugin to your build file, as +the following example shows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=verifier_test_dependencies,indent=0] ---- +==== The following listing shows how to add the plugin, which should go in the build/plugins portion of the file: +==== [source,xml,indent=0] ---- @@ -140,6 +192,7 @@ portion of the file: true ---- +==== Running `./mvnw clean install` automatically generates tests that verify the application compliance with the added contracts. By default, the tests get generated under @@ -151,27 +204,29 @@ present, the tests fail. To make them pass, you must add the correct implementation of either handling HTTP requests or messages. Also, you must add a correct base test class for auto-generated tests to the project. This class is extended by all the auto-generated tests, and it -should contain all the setup necessary to run them (for example `RestAssuredMockMvc` +should contain all the setup information necessary to run them (for example `RestAssuredMockMvc` controller setup or messaging test setup). Once the implementation and the test base class are in place, the tests pass, and both the application and the stub artifacts are built and installed in the local Maven repository. -The changes can now be merged, and both the application and the stub artifacts may be -published in an online repository. +You can now merge the changes, and you can publish both the application and the stub artifacts +in an online repository. -[[spring-cloud-contract-verifier-intro-three-second-tour-consumer]] -===== On the Consumer Side +[[getting-started-three-second-tour-consumer]] +=== On the Consumer Side -`Spring Cloud Contract Stub Runner` can be used in the integration tests to get a running +You can use `Spring Cloud Contract Stub Runner` in the integration tests to get a running WireMock instance or messaging route that simulates the actual service. -To do so, add the dependency to `Spring Cloud Contract Stub Runner`, as shown in the -following example: +To do so, add the dependency to `Spring Cloud Contract Stub Runner`, as the +following example shows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/pom.xml[tags=stub_runner,indent=0] ---- +==== You can get the Producer-side stubs installed in your Maven repository in either of two ways: @@ -179,26 +234,31 @@ ways: * By checking out the Producer side repository and adding contracts and generating the stubs by running the following commands: + +==== [source,bash,indent=0] ---- $ cd local-http-server-repo $ ./mvnw clean install -DskipTests ---- -TIP: The tests are being skipped because the Producer-side contract implementation is not +==== +TIP: The tests are being skipped because the producer-side contract implementation is not in place yet, so the automatically-generated contract tests fail. * By getting already-existing producer service stubs from a remote repository. To do so, pass the stub artifact IDs and artifact repository URL as `Spring Cloud Contract -Stub Runner` properties, as shown in the following example: +Stub Runner` properties, as the following example shows: + +==== [source,yaml,indent=0] ---- -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] +include::{introduction_url}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] ---- +==== Now you can annotate your test class with `@AutoConfigureStubRunner`. In the annotation, provide the `group-id` and `artifact-id` values for `Spring Cloud Contract Stub Runner` to -run the collaborators' stubs for you, as shown in the following example: +run the collaborators' stubs for you, as the following example shows: +==== [source,java, indent=0] ---- @RunWith(SpringRunner.class) @@ -207,6 +267,7 @@ run the collaborators' stubs for you, as shown in the following example: stubsMode = StubRunnerProperties.StubsMode.LOCAL) public class LoanApplicationServiceTests { ---- +==== TIP: Use the `REMOTE` `stubsMode` when downloading stubs from an online repository and `LOCAL` for offline work. @@ -214,29 +275,62 @@ TIP: Use the `REMOTE` `stubsMode` when downloading stubs from an online reposito Now, in your integration test, you can receive stubbed versions of HTTP responses or messages that are expected to be emitted by the collaborator service. -[[spring-cloud-contract-verifier-intro-three-minute-tour]] -==== A Three-minute Tour +[[getting-started-first-application]] +== Developing Your First Spring Cloud Contract-based Application -This brief tour walks through using Spring Cloud Contract: +This brief tour walks through using Spring Cloud Contract. It consists of the following topics: -* <> -* <> +* <> +* <> You can find an even more brief tour -<>. +<>. -[[spring-cloud-contract-verifier-intro-three-minute-tour-producer]] -===== On the Producer Side +For the sake of this example, the `Stub Storage` is Nexus/Artifactory. -To start working with `Spring Cloud Contract`, add files with `REST/` messaging contracts +The following UML diagram shows the relationship of the parts of Spring Cloud Contract: + +image::getting-started-three-second.png[Getting started first application] + +[[getting-started-first-application-producer]] +=== On the Producer Side + +To start working with `Spring Cloud Contract`, you can add Spring Cloud Contract Verifier +dependency and plugin to your build file, as the following example shows: + +==== +[source,xml,indent=0] +---- +include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=verifier_test_dependencies,indent=0] +---- +==== + +The following listing shows how to add the plugin, which should go in the build/plugins +portion of the file: + +==== +[source,xml,indent=0] +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + +---- +==== + +Now you can add files with `REST/` messaging contracts expressed in either Groovy DSL or YAML to the contracts directory, which is set by the `contractsDslDir` property. By default, it is `$rootDir/src/test/resources/contracts`. For the HTTP stubs, a contract defines what kind of response should be returned for a given request (taking into account the HTTP methods, URLs, headers, status codes, and so -on). The following example shows how an HTTP stub contract in Groovy DSL: +on). The following example shows an HTTP stub contract in both Groovy and YAML: -[source,groovy,indent=0] +==== +[source,groovy,indent=0,role="primary"] +.groovy ---- package contracts @@ -265,9 +359,8 @@ org.springframework.cloud.contract.spec.Contract.make { } ---- -The same contract expressed in YAML would look like the following example: - -[source,yaml,indent=0] +[source,yaml,indent=0,role="secondary"] +.yaml ---- request: method: PUT @@ -290,56 +383,50 @@ response: headers: Content-Type: application/json;charset=UTF-8 ---- +==== In the case of messaging, you can define: -* The input and the output messages can be defined (taking into account from and where it +* The input and output messages (taking into account from and where it was sent, the message body, and the header). * The methods that should be called after the message is received. * The methods that, when called, should trigger a message. -The following example shows a Camel messaging contract expressed in Groovy DSL: +The following example shows a Camel messaging contract: -[source,groovy] +==== +[source,groovy,indent=0,role="primary"] +.groovy ---- include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_dsl] ---- -The following example shows the same contract expressed in YAML: - -[source,yml,indent=0] +[source,yaml,indent=0,role="secondary"] +.yaml ---- include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario3.yml[indent=0] ---- - -Then you can add Spring Cloud Contract Verifier dependency and plugin to your build file, -as shown in the following example: - -[source,xml,indent=0] ----- -include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=verifier_test_dependencies,indent=0] ----- - -The following listing shows how to add the plugin, which should go in the build/plugins -portion of the file: - -[source,xml,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - ----- +==== Running `./mvnw clean install` automatically generates tests that verify the application compliance with the added contracts. By default, the generated tests are under `org.springframework.cloud.contract.verifier.tests.`. -The following example shows a sample auto-generated test for an HTTP contract: +The generated tests may differ, depending on which framework and test type you have setup in your plugin. -[source,java,indent=0] +In the next listing, you can find: + +- The default test mode for HTTP contracts in `MockMvc` +- A JAX-RS client with the `JAXRS` test mode +- A `WebTestClient`-based test (this is particularly recommended while working with +Reactive, `Web-Flux`-based applications) set with the `WEBTESTCLIENT` test mode +- A Spock-based test with the `testFramework` property set to `SPOCK` + +The following listing shows all these samples: + +==== +[source,java,indent=0,role="primary"] +.mockmvc ---- @Test public void validate_shouldMarkClientAsFraud() throws Exception { @@ -362,18 +449,45 @@ public void validate_shouldMarkClientAsFraud() throws Exception { } ---- -The preceding example uses Spring's `MockMvc` to run the tests. This is the default test -mode for HTTP contracts. However, JAX-RS client and explicit HTTP invocations can also be -used. (To do so, change the `testMode` property of the plugin to `JAX-RS` or `EXPLICIT`, -respectively.) +[source,java,indent=0,role="secondary"] +.jaxrs +---- +@SuppressWarnings("rawtypes") +public class FooTest { + WebTarget webTarget; -Since 2.1.0, it is also possible to use `RestAssuredWebTestClient`with Spring's reactive `WebTestClient` -run under the hood. This is particularly recommended while working with Reactive, `Web-Flux`-based applications. -In order to use `WebTestClient` set `testMode` to `WEBTESTCLIENT`. + @Test + public void validate_() throws Exception { -Here is an example of a test generated in `WEBTESTCLIENT` test mode: + // when: + Response response = webTarget + .path("/users") + .queryParam("limit", "10") + .queryParam("offset", "20") + .queryParam("filter", "email") + .queryParam("sort", "name") + .queryParam("search", "55") + .queryParam("age", "99") + .queryParam("name", "Denis.Stepanov") + .queryParam("email", "bob@email.com") + .request() + .build("GET") + .invoke(); + String responseAsString = response.readEntity(String.class); - [source,java,indent=0] + // then: + assertThat(response.getStatus()).isEqualTo(200); + + // and: + DocumentContext parsedJson = JsonPath.parse(responseAsString); + assertThatJson(parsedJson).field("['property1']").isEqualTo("a"); + } + +} +---- + +[source,java,indent=0,role="secondary"] +.webtestclient ---- @Test public void validate_shouldRejectABeerIfTooYoung() throws Exception { @@ -395,15 +509,8 @@ Here is an example of a test generated in `WEBTESTCLIENT` test mode: } ---- -Apart from the default JUnit 4, you can instead use JUnit 5, TestNG or Spock tests, by setting the plugin -`testFramework` property to either `JUNIT5`, `TESTNG` or `Spock`. - -TIP: 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. - -The following example shows an auto-generated test in Spock for a messaging stub contract: - - [source,groovy,indent=0] +[source,groovy,indent=0,role="secondary"] +.spock ---- given: ContractVerifierMessage inputMessage = contractVerifierMessaging.create( @@ -418,6 +525,7 @@ then: noExceptionThrown() bookWasDeleted() ---- +==== As the implementation of the functionalities described by the contracts is not yet present, the tests fail. @@ -425,14 +533,15 @@ present, the tests fail. To make them pass, you must add the correct implementation of handling either HTTP requests or messages. Also, you must add a correct base test class for auto-generated tests to the project. This class is extended by all the auto-generated tests and should -contain all the setup necessary to run them (for example, `RestAssuredMockMvc` controller -setup or messaging test setup). +contain all the setup necessary information needed to run them (for example, +`RestAssuredMockMvc` controller setup or messaging test setup). Once the implementation and the test base class are in place, the tests pass, and both the application and the stub artifacts are built and installed in the local Maven repository. Information about installing the stubs jar to the local repository appears in the logs, as -shown in the following example: +the following example shows: +==== [source,bash,indent=0] ---- [INFO] --- spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:generateStubs (default-generateStubs) @ http-server --- @@ -448,32 +557,25 @@ shown in the following example: [INFO] Installing /some/path/http-server/pom.xml to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT.pom [INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar ---- +==== You can now merge the changes and publish both the application and the stub artifacts in an online repository. -*Docker Project* +[[getting-started-first-application-consumer]] +=== On the Consumer Side -In order to enable working with contracts while creating applications in non-JVM -technologies, the `springcloud/spring-cloud-contract` Docker image has been created. It -contains a project that automatically generates tests for HTTP contracts and executes them -in `EXPLICIT` test mode. Then, if the tests pass, it generates Wiremock stubs and, -optionally, publishes them to an artifact manager. In order to use the image, you can -mount the contracts into the `/contracts` directory and set a few environment variables. -// TODO: We should answer the obvious question: Which environment variables? - -[[spring-cloud-contract-verifier-intro-three-minute-tour-consumer]] -===== On the Consumer Side - -`Spring Cloud Contract Stub Runner` can be used in the integration tests to get a running +You can use Spring Cloud Contract Stub Runner in the integration tests to get a running WireMock instance or messaging route that simulates the actual service. -To get started, add the dependency to `Spring Cloud Contract Stub Runner`: +To get started, add the dependency to `Spring Cloud Contract Stub Runner`, as follows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/pom.xml[tags=stub_runner,indent=0] ---- +==== You can get the Producer-side stubs installed in your Maven repository in either of two ways: @@ -481,26 +583,31 @@ ways: * By checking out the Producer side repository and adding contracts and generating the stubs by running the following commands: + +==== [source,bash,indent=0] ---- $ cd local-http-server-repo $ ./mvnw clean install -DskipTests ---- +==== NOTE: The tests are skipped because the Producer-side contract implementation is not yet in place, so the automatically-generated contract tests fail. * Getting already existing producer service stubs from a remote repository. To do so, pass the stub artifact IDs and artifact repository URl as `Spring Cloud Contract Stub -Runner` properties, as shown in the following example: +Runner` properties, as the following example shows: + +==== [source,yaml,indent=0] ---- -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] +include::{introduction_url}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] ---- +==== Now you can annotate your test class with `@AutoConfigureStubRunner`. In the annotation, provide the `group-id` and `artifact-id` for `Spring Cloud Contract Stub Runner` to run -the collaborators' stubs for you, as shown in the following example: +the collaborators' stubs for you, as the following example shows: +==== [source,java, indent=0] ---- @RunWith(SpringRunner.class) @@ -509,6 +616,7 @@ the collaborators' stubs for you, as shown in the following example: stubsMode = StubRunnerProperties.StubsMode.LOCAL) public class LoanApplicationServiceTests { ---- +==== TIP: Use the `REMOTE` `stubsMode` when downloading stubs from an online repository and `LOCAL` for offline work. @@ -517,6 +625,7 @@ In your integration test, you can receive stubbed versions of HTTP responses or that are expected to be emitted by the collaborator service. You can see entries similar to the following in the build logs: +==== [source,bash,indent=0] ---- 2016-07-19 14:22:25.403 INFO 41050 --- [ main] o.s.c.c.stubrunner.AetherStubDownloader : Desired version is + - will try to resolve the latest version @@ -527,114 +636,45 @@ to the following in the build logs: 2016-07-19 14:22:25.475 INFO 41050 --- [ main] o.s.c.c.stubrunner.AetherStubDownloader : Unpacked file to [/var/folders/0p/xwq47sq106x1_g3dtv6qfm940000gq/T/contracts100276532569594265] 2016-07-19 14:22:27.737 INFO 41050 --- [ main] o.s.c.c.stubrunner.StubRunnerExecutor : All stubs are now running RunningStubs [namesAndPorts={com.example:http-server:0.0.1-SNAPSHOT:stubs=8080}] ---- +==== -==== Defining the Contract +[[getting-started-cdc]] +== Step-by-step Guide to Consumer Driven Contracts (CDC) with Contracts on the Producer Side -As consumers of services, we need to define what exactly we want to achieve. We need to -formulate our expectations. That is why we write contracts. - -Assume that you want to send a request containing the ID of a client company and the -amount it wants to borrow from us. You also want to send it to the /fraudcheck url via -the PUT method. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{introduction_url}/samples/standalone/dsl/http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.groovy[] ----- - -.YAML -[source,yml,indent=0] ----- -include::{introduction_url}/samples/standalone/yml/http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.yml[] ----- - -==== Client Side - -Spring Cloud Contract generates stubs, which you can use during client-side testing. -You get a running WireMock instance/Messaging route that simulates the service. -You would like to feed that instance with a proper stub definition. - -At some point in time, you need to send a request to the Fraud Detection service. - -[source,groovy,indent=0] ----- -include::{introduction_url}/samples/standalone/dsl/http-client/src/main/java/com/example/loan/LoanApplicationService.java[tags=client_call_server,indent=0] ----- - -Annotate your test class with `@AutoConfigureStubRunner`. In the annotation provide the group id and artifact id for the Stub Runner to download stubs of your collaborators. - -[source,groovy,indent=0] ----- -include::{introduction_url}/samples/standalone/dsl/http-client/src/test/java/com/example/loan/LoanApplicationServiceTests.java[tags=autoconfigure_stubrunner,indent=0] ----- - -After that, during the tests, Spring Cloud Contract automatically finds the stubs -(simulating the real service) in the Maven repository and exposes them on a configured -(or random) port. - -==== Server Side - -Since you are developing your stub, you need to be sure that it actually resembles your -concrete implementation. You cannot have a situation where your stub acts in one way and -your application behaves in a different way, especially in production. - -To ensure that your application behaves the way you define in your stub, tests are -generated from the stub you provide. - -The autogenerated test looks, more or less, like this: - -[source,java,indent=0] ----- -@Test -public void validate_shouldMarkClientAsFraud() throws Exception { - // given: - MockMvcRequestSpecification request = given() - .header("Content-Type", "application/vnd.fraud.v1+json") - .body("{\"client.id\":\"1234567890\",\"loanAmount\":99999}"); - - // when: - ResponseOptions response = given().spec(request) - .put("/fraudcheck"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - assertThat(response.header("Content-Type")).matches("application/vnd.fraud.v1.json.*"); - // and: - DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); - assertThatJson(parsedJson).field("['fraudCheckStatus']").matches("[A-Z]{5}"); - assertThatJson(parsedJson).field("['rejection.reason']").isEqualTo("Amount too high"); -} ----- - -=== Step-by-step Guide to Consumer Driven Contracts (CDC) - -Consider an example of Fraud Detection and the Loan Issuance process. The business +Consider an example of fraud detection and the loan issuance process. The business scenario is such that we want to issue loans to people but do not want them to steal from us. The current implementation of our system grants loans to everybody. Assume that `Loan Issuance` is a client to the `Fraud Detection` server. In the current -sprint, we must develop a new feature: if a client wants to borrow too much money, then +sprint, we must develop a new feature: if a client wants to borrow too much money, we mark the client as a fraud. -Technical remark - Fraud Detection has an `artifact-id` of `http-server`, while Loan -Issuance has an artifact-id of `http-client`, and both have a `group-id` of `com.example`. +Technical remarks -Social remark - both client and server development teams need to communicate directly and -discuss changes while going through the process. CDC is all about communication. +* Fraud Detection has an `artifact-id` of `http-server` +* Loan Issuance has an artifact-id of `http-client` +* Both have a `group-id` of `com.example` +* For the sake of this example the `Stub Storage` is Nexus/Artifactory -The https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples/standalone/dsl/http-server[server -side code is available here] and https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples/standalone/dsl/http-client[the -client code here]. +Social remarks -TIP: In this case, the producer owns the contracts. Physically, all the contract are +* Both the client and the server development teams need to communicate directly and +discuss changes while going through the process +* CDC is all about communication + +The https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples/standalone/dsl/http-server[server-side +code is available here] and https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples/standalone/dsl/http-client[the client code is available here]. + +TIP: In this case, the producer owns the contracts. Physically, all of the contracts are in the producer's repository. -==== Technical note +[[getting-started-cdc-technical-note]] +=== Technical Note -If using the *SNAPSHOT* / *Milestone* / *Release Candidate* versions please add the +If you use the SNAPSHOT, Milestone, or Release Candidate versions you need to add the following section to your build: +==== [source,xml,indent=0,subs="verbatim,attributes",role="primary"] .Maven ---- @@ -646,16 +686,24 @@ include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=repo ---- include::{introduction_url}/samples/standalone/dsl/http-server/build.gradle[tags=deps_repos,indent=0] ---- +==== -==== Consumer side (Loan Issuance) +For simplicity, we use the following acronyms: + +- Loan Issuance (LI): The HTTP client +- Fraud Detection (FD): The HTTP server +- Spring Cloud Contract (SCC) + +[[getting-started-cdc-consumer]] +=== The Consumer Side (Loan Issuance) As a developer of the Loan Issuance service (a consumer of the Fraud Detection server), you might do the following steps: . Start doing TDD by writing a test for your feature. . Write the missing implementation. . Clone the Fraud Detection service repository locally. -. Define the contract locally in the repo of Fraud Detection service. -. Add the Spring Cloud Contract Verifier plugin. +. Define the contract locally in the repo of the fraud detection service. +. Add the Spring Cloud Contract (SCC) plugin. . Run the integration tests. . File a pull request. . Create an initial implementation. @@ -664,126 +712,181 @@ As a developer of the Loan Issuance service (a consumer of the Fraud Detection s . Deploy your app. . Work online. -*Start doing TDD by writing a test for your feature.* +We start with the loan issuance flow, which the following UML diagram shows: +[plantuml, getting-started-cdc-client, png] +---- +"Loan\nIssuance"->"Loan\nIssuance": start doing TDD\nby writing a test\nfor your feature +"Loan\nIssuance"->"Loan\nIssuance": write the \nmissing implementation +"Loan\nIssuance"->"Loan\nIssuance": run a test - it fails\ndue to no server running +"Loan\nIssuance"->"Fraud\nDetection\nClone": clone the repository +"Fraud\nDetection\nClone"->"Fraud\nDetection\nClone": add missing dependencies\n& define contracts +"Fraud\nDetection\nClone"->"Fraud\nDetection\nClone": add the SCC plugin +"Fraud\nDetection\nClone"->"FD \nClone Build": install the stubs locally +"FD \nClone Build"->"SCC Plugin \nin FD Clone": generate stubs \nand stubs \nartifact (e.g. stubs-jar) +"SCC Plugin \nin FD Clone"->"FD \nClone Build": stubs and artifacts\ngenerated +"FD \nClone Build"->"Local storage": install the stubs locally +"Local storage"->"FD \nClone Build": stub sucessfully installed +"FD \nClone Build"->"Fraud\nDetection\nClone": build successful +"Loan\nIssuance"->"Loan\nIssuance": add a SCC\nStub Runner\ndependency\nand setup +"Loan\nIssuance"->"LI\nSCC\nStub Runner": start stubs\nof FD from\nlocal storage +"LI\nSCC\nStub Runner"->"Local storage": find stubs of [FD] +"Local storage"->"LI\nSCC\nStub Runner": stubs of [FD] found +"LI\nSCC\nStub Runner"->"FD stub": run stubs of [FD] +"FD stub"->"LI\nSCC\nStub Runner": [FD] stub is running +"LI\nSCC\nStub Runner"->"Loan\nIssuance": stubs running and ready for the test +"Loan\nIssuance"->"Loan\nIssuance": run a test +"Loan\nIssuance"->"FD stub": the test\nsends a request\nto the running stub +"FD stub"->"Loan\nIssuance": stub responds successfuly +"Loan\nIssuance"->"Loan\nIssuance": the test passes successfully +"Loan\nIssuance"->"Fraud\nDetection": send a pull request\nwith the\nsuggested contracts +---- + +[[getting-started-cdc-consumer-start]] +==== Start Doing TDD by Writing a Test for Your Feature + +The following listing shows a test that we might use to check whether a loan amount is too +large: + +==== [source,groovy,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/src/test/java/com/example/loan/LoanApplicationServiceTests.java[tags=client_tdd,indent=0] ---- +==== Assume that you have written a test of your new feature. If a loan application for a big amount is received, the system should reject that loan application with some description. -*Write the missing implementation.* +[[getting-started-cdc-consumer-write]] +==== Write the Missing Implementation At some point in time, you need to send a request to the Fraud Detection service. Assume that you need to send the request containing the ID of the client and the amount the -client wants to borrow. You want to send it to the `/fraudcheck` url via the `PUT` method. +client wants to borrow. You want to send it to the `/fraudcheck` URL by using the `PUT` method. +To do so, you might use code similar to the following: +==== [source,groovy,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/src/main/java/com/example/loan/LoanApplicationService.java[tags=client_call_server,indent=0] ---- +==== For simplicity, the port of the Fraud Detection service is set to `8080`, and the application runs on `8090`. -If you start the test at this point, it breaks, because no service currently runs on port +NOTE: If you start the test at this point, it breaks, because no service currently runs on port `8080`. -*Clone the Fraud Detection service repository locally.* +[[getting-started-cdc-consumer-clone]] +==== Clone the Fraud Detection service repository locally You can start by playing around with the server side contract. To do so, you must first -clone it. +clone it, by running the following command: +==== [source,bash,indent=0] ---- $ git clone https://your-git-server.com/server-side.git local-http-server-repo ---- +==== -*Define the contract locally in the repo of Fraud Detection service.* +[[getting-started-cdc-consumer-define]] +==== Define the Contract Locally in the Repository of the Fraud Detection Service As a consumer, you need to define what exactly you want to achieve. You need to formulate your expectations. To do so, write the following contract: -IMPORTANT: Place the contract under `src/test/resources/contracts/fraud` folder. The `fraud` folder +IMPORTANT: Place the contract in the `src/test/resources/contracts/fraud` folder. The `fraud` folder is important because the producer's test base class name references that folder. -.Groovy DSL -[source,groovy,indent=0] +The following example shows our contract, in both Groovy and YAML: + +==== +[source,groovy,indent=0,role="primary"] +.groovy ---- include::{introduction_url}/samples/standalone/dsl/http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.groovy[] ---- -.YAML -[source,yml,indent=0] +[source,yaml,indent=0,role="secondary"] +.yaml ---- include::{introduction_url}/samples/standalone/yml/http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.yml[] ---- +==== -The YML contract is quite straight-forward. However when you take a look at the Contract -written using a statically typed Groovy DSL - you might wonder what the +The YML contract is quite straightforward. However, when you take a look at the Contract +written with a statically typed Groovy DSL, you might wonder what the `value(client(...), server(...))` parts are. By using this notation, Spring Cloud -Contract lets you define parts of a JSON block, a URL, etc., which are dynamic. In case +Contract lets you define parts of a JSON block, a URL, or other structure that is dynamic. In case of an identifier or a timestamp, you need not hardcode a value. You want to allow some different ranges of values. To enable ranges of values, you can set regular expressions -matching those values for the consumer side. You can provide the body by means of either -a map notation or String with interpolations. -Consult the <> section for more information. We highly recommend using the map notation! +that match those values for the consumer side. You can provide the body by means of either +a map notation or String with interpolations. We highly recommend using the map notation. -TIP: You must understand the map notation in order to set up contracts. Please read the +TIP: You must understand the map notation in order to set up contracts. See the https://groovy-lang.org/json.html[Groovy docs regarding JSON]. The previously shown contract is an agreement between two sides that: -- if an HTTP request is sent with all of -** a `PUT` method on the `/fraudcheck` endpoint, -** a JSON body with a `client.id` that matches the regular expression `[0-9]{10}` and +- If an HTTP request is sent with all of +** A `PUT` method on the `/fraudcheck` endpoint +** A JSON body with a `client.id` that matches the regular expression `[0-9]{10}` and `loanAmount` equal to `99999`, -** and a `Content-Type` header with a value of `application/vnd.fraud.v1+json`, -- then an HTTP response is sent to the consumer that -** has status `200`, -** contains a JSON body with the `fraudCheckStatus` field containing a value `FRAUD` and -the `rejectionReason` field having value `Amount too high`, -** and a `Content-Type` header with a value of `application/vnd.fraud.v1+json`. +** A `Content-Type` header with a value of `application/vnd.fraud.v1+json` +- Then an HTTP response is sent to the consumer that +** Has status `200` +** Contains a JSON body with the `fraudCheckStatus` field containing a value of `FRAUD` and +the `rejectionReason` field having a value of `Amount too high` +** Has a `Content-Type` header with a value of `application/vnd.fraud.v1+json` Once you are ready to check the API in practice in the integration tests, you need to install the stubs locally. -*Add the Spring Cloud Contract Verifier plugin.* +[[getting-started-cdc-consumer-add]] +==== Add the Spring Cloud Contract Verifier Plugin -We can add either a Maven or a Gradle plugin. In this example, you see how to add Maven. -First, add the `Spring Cloud Contract` BOM. +We can add either a Maven or a Gradle plugin. In this example, we show how to add Maven. +First, we add the `Spring Cloud Contract` BOM, as the following example shows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=contract_bom,indent=0] ---- +==== -Next, add the `Spring Cloud Contract Verifier` Maven plugin +Next, add the `Spring Cloud Contract Verifier` Maven plugin, as the following example shows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=contract_maven_plugin,indent=0] ---- +==== -Since the plugin was added, you get the `Spring Cloud Contract Verifier` features which, +Since the plugin was added, you get the `Spring Cloud Contract Verifier` features, which, from the provided contracts: -- generate and run tests -- produce and install stubs +- Generate and run tests +- Produce and install stubs -You do not want to generate tests since you, as the consumer, want only to play with the -stubs. You need to skip the test generation and execution. When you execute: +You do not want to generate tests, since you, as the consumer, want only to play with the +stubs. You need to skip the test generation and execution. To do so, run the following commands: +==== [source,bash,indent=0] ---- $ cd local-http-server-repo $ ./mvnw clean install -DskipTests ---- +==== -In the logs, you see something like this: +Once you run those commands, you should you see something like the following content in the logs: +==== [source,bash,indent=0] ---- [INFO] --- spring-cloud-contract-maven-plugin:1.0.0.BUILD-SNAPSHOT:generateStubs (default-generateStubs) @ http-server --- @@ -799,49 +902,60 @@ In the logs, you see something like this: [INFO] Installing /some/path/http-server/pom.xml to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT.pom [INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar ---- +==== The following line is extremely important: +==== [source,bash,indent=0] ---- [INFO] Installing /some/path/http-server/target/http-server-0.0.1-SNAPSHOT-stubs.jar to /path/to/your/.m2/repository/com/example/http-server/0.0.1-SNAPSHOT/http-server-0.0.1-SNAPSHOT-stubs.jar ---- +==== It confirms that the stubs of the `http-server` have been installed in the local repository. -*Run the integration tests.* +[[getting-started-cdc-consumer-run]] +==== Running the Integration Tests In order to profit from the Spring Cloud Contract Stub Runner functionality of automatic stub downloading, you must do the following in your consumer side project (`Loan Application service`): -Add the `Spring Cloud Contract` BOM: - +. Add the `Spring Cloud Contract` BOM, as follows: ++ +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/pom.xml[tags=contract_bom,indent=0] ---- +==== -Add the dependency to `Spring Cloud Contract Stub Runner`: - +. Add the dependency to `Spring Cloud Contract Stub Runner`, as follows: ++ +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/pom.xml[tags=stub_runner,indent=0] ---- +==== -Annotate your test class with `@AutoConfigureStubRunner`. In the annotation, provide the +. Annotate your test class with `@AutoConfigureStubRunner`. In the annotation, provide the `group-id` and `artifact-id` for the Stub Runner to download the stubs of your -collaborators. (Optional step) Because you're playing with the collaborators offline, you +collaborators. (Optional step) Because you are playing with the collaborators offline, you can also provide the offline work switch (`StubRunnerProperties.StubsMode.LOCAL`). - ++ +==== [source,groovy,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-client/src/test/java/com/example/loan/LoanApplicationServiceTests.java[tags=autoconfigure_stubrunner,indent=0] ---- +==== -Now, when you run your tests, you see something like this: +Now, when you run your tests, you see something like the following output in the logs: +==== [source,bash,indent=0] ---- 2016-07-19 14:22:25.403 INFO 41050 --- [ main] o.s.c.c.stubrunner.AetherStubDownloader : Desired version is + - will try to resolve the latest version @@ -852,58 +966,97 @@ Now, when you run your tests, you see something like this: 2016-07-19 14:22:25.475 INFO 41050 --- [ main] o.s.c.c.stubrunner.AetherStubDownloader : Unpacked file to [/var/folders/0p/xwq47sq106x1_g3dtv6qfm940000gq/T/contracts100276532569594265] 2016-07-19 14:22:27.737 INFO 41050 --- [ main] o.s.c.c.stubrunner.StubRunnerExecutor : All stubs are now running RunningStubs [namesAndPorts={com.example:http-server:0.0.1-SNAPSHOT:stubs=8080}] ---- +==== -This output means that Stub Runner has found your stubs and started a server for your app -with group id `com.example`, artifact id `http-server` with version `0.0.1-SNAPSHOT` of -the stubs and with `stubs` classifier on port `8080`. +This output means that Stub Runner has found your stubs and started a server for your application +with a group ID of `com.example` and an artifact ID of `http-server` with version `0.0.1-SNAPSHOT` of +the stubs and with the `stubs` classifier on port `8080`. -*File a pull request.* +[[getting-started-cdc-consumer-file]] +==== Filing a Pull Request What you have done until now is an iterative process. You can play around with the contract, install it locally, and work on the consumer side until the contract works as you wish. -Once you are satisfied with the results and the test passes, publish a pull request to +Once you are satisfied with the results and the test passes, you can publish a pull request to the server side. Currently, the consumer side work is done. -==== Producer side (Fraud Detection server) +[[getting-started-cdc-producer]] +=== The Producer Side (Fraud Detection server) -As a developer of the Fraud Detection server (a server to the Loan Issuance service): +As a developer of the Fraud Detection server (a server to the Loan Issuance service), you +might want to do the following -*Create an initial implementation.* +- Take over the pull request +- Write the missing implementation +- Deploy the application -As a reminder, you can see the initial implementation here: +The following UML diagram shows the fraud detection flow: +[plantuml, getting-started-cdc-server, png] +---- +"Fraud\nDetection"->"Fraud\nDetection": take over the\n pull request +"Fraud\nDetection"->"Fraud\nDetection": setup\nSpring Cloud\nContract plugin +"Fraud\nDetection"->"Fraud\nDetection\nBuild": run the build +"Fraud\nDetection\nBuild"->"SCC Plugin": generate tests\nstubs \nand stubs artifact \n(e.g. stubs-jar) +"SCC Plugin"->"Fraud\nDetection\nBuild": tests and stubs generated +"Fraud\nDetection\nBuild"->"Fraud\nDetection\nBuild": run tests +"Fraud\nDetection\nBuild"->"Fraud\nDetection": generated tests failed! +"Fraud\nDetection"->"Fraud\nDetection": setup\nbase classes\nfor contract tests +"Fraud\nDetection"->"Fraud\nDetection\nBuild": run the build +"Fraud\nDetection\nBuild"->"SCC Plugin": generate tests\nstubs \nand stubs artifact \n(e.g. stubs-jar) +"SCC Plugin"->"Fraud\nDetection\nBuild": tests and stubs generated +"Fraud\nDetection\nBuild"->"Fraud\nDetection\nBuild": run tests +"Fraud\nDetection\nBuild"->"Fraud\nDetection": all the tests passed! +"Fraud\nDetection"->"Fraud\nDetection": commit and push changes +"Fraud\nDetection"->"CI": commit pushed!\nTriggers the build +"CI"->"Stub Storage": build successful,\nupload artifacts +---- + +[[getting-started-cdc-producer-pr]] +==== Taking over the Pull Request + +As a reminder, the following listing shows the initial implementation: + +==== [source,java,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/src/main/java/com/example/fraud/FraudDetectionController.java[tags=server_api,indent=0] include::{introduction_url}/samples/standalone/dsl/http-server/src/main/java/com/example/fraud/FraudDetectionController.java[tags=initial_impl,indent=0] } ---- +==== -*Take over the pull request.* +Then you can run the following commands: +==== [source,bash,indent=0] ---- $ git checkout -b contract-change-pr master $ git pull https://your-git-server.com/server-side-fork.git contract-change-pr ---- +==== -You must add the dependencies needed by the autogenerated tests: +You must add the dependencies needed by the autogenerated tests, as follows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=verifier_test_dependencies,indent=0] ---- +==== -In the configuration of the Maven plugin, pass the `packageWithBaseClasses` property +In the configuration of the Maven plugin, you must pass the `packageWithBaseClasses` property, as follows: +==== [source,xml,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/pom.xml[tags=contract_maven_plugin,indent=0] ---- +==== -IMPORTANT: This example uses "convention based" naming by setting the +IMPORTANT: This example uses "`convention-based`" naming by setting the `packageWithBaseClasses` property. Doing so means that the two last packages combine to make the name of the base test class. In our case, the contracts were placed under `src/test/resources/contracts/fraud`. Since you do not have two packages starting from @@ -911,16 +1064,20 @@ the `contracts` folder, pick only one, which should be `fraud`. Add the `Base` s capitalize `fraud`. That gives you the `FraudBase` test class name. All the generated tests extend that class. Over there, you can set up your Spring Context -or whatever is necessary. In this case, use https://github.com/rest-assured/rest-assured[Rest Assured MVC] to -start the server side `FraudDetectionController`. +or whatever is necessary. In this case, you should use https://github.com/rest-assured/rest-assured[Rest Assured MVC] to +start the server side `FraudDetectionController`. The following listing shows the +`FraudBase` class: +==== [source,java,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/src/test/java/com/example/fraud/FraudBase.java[] ---- +==== -Now, if you run the `./mvnw clean install`, you get something like this: +Now, if you run the `./mvnw clean install`, you get something like the following output: +==== [source,bash,indent=0] ---- Results : @@ -928,11 +1085,13 @@ Results : Tests in error: ContractVerifierTest.validate_shouldMarkClientAsFraud:32 » IllegalState Parsed... ---- +==== This error occurs because you have a new contract from which a test was generated and it failed since you have not implemented the feature. The auto-generated test would look -like this: +like the following test method: +==== [source,java,indent=0] ---- @Test @@ -955,22 +1114,25 @@ public void validate_shouldMarkClientAsFraud() throws Exception { assertThatJson(parsedJson).field("['rejection.reason']").isEqualTo("Amount too high"); } ---- +==== -If you used the Groovy DSL, you can see, all the `producer()` parts of the Contract that were present in the +If you used the Groovy DSL, you can see that all of the `producer()` parts of the Contract that were present in the `value(consumer(...), producer(...))` blocks got injected into the test. In case of using YAML, the same applied for the `matchers` sections of the `response`. Note that, on the producer side, you are also doing TDD. The expectations are expressed in the form of a test. This test sends a request to our own application with the URL, -headers, and body defined in the contract. It also is expecting precisely defined values +headers, and body defined in the contract. It is also expecting precisely defined values in the response. In other words, you have the `red` part of `red`, `green`, and `refactor`. It is time to convert the `red` into the `green`. -*Write the missing implementation.* +[[getting-started-cdc-producer-impl]] +==== Write the Missing Implementation Because you know the expected input and expected output, you can write the missing -implementation: +implementation as follows: +==== [source,java,indent=0] ---- include::{introduction_url}/samples/standalone/dsl/http-server/src/main/java/com/example/fraud/FraudDetectionController.java[tags=server_api,indent=0] @@ -978,79 +1140,116 @@ include::{introduction_url}/samples/standalone/dsl/http-server/src/main/java/com include::{introduction_url}/samples/standalone/dsl/http-server/src/main/java/com/example/fraud/FraudDetectionController.java[tags=initial_impl,indent=0] } ---- +==== -When you execute `./mvnw clean install` again, the tests pass. Since the `Spring Cloud +When you run `./mvnw clean install` again, the tests pass. Since the `Spring Cloud Contract Verifier` plugin adds the tests to the `generated-test-sources`, you can actually run those tests from your IDE. -*Deploy your app.* +[[getting-started-cdc-producer-deploy]] +==== Deploying Your Application -Once you finish your work, you can deploy your change. First, merge the branch: +Once you finish your work, you can deploy your changes. To do so, you must first merge the +branch by running the following commands: +==== [source,bash,indent=0] ---- $ git checkout master $ git merge --no-ff contract-change-pr $ git push origin master ---- +==== -Your CI might run something like `./mvnw clean deploy`, which would publish both the +Your CI might run something a command such as `./mvnw clean deploy`, which would publish both the application and the stub artifacts. -==== Consumer Side (Loan Issuance) Final Step +[[getting-started-cdc-consumer-final]] +=== Consumer Side (Loan Issuance), Final Step -As a developer of the Loan Issuance service (a consumer of the Fraud Detection server): +As a developer of the loan issuance service (a consumer of the Fraud Detection server), I want to: -*Merge branch to master.* +- Merge our feature branch to `master` +- Switch to online mode of working +The following UML diagram shows the final state of the process: + +[plantuml, getting-started-cdc-client-final, png] +---- +"Loan\nIssuance"->"Loan\nIssuance": merge the\nfeature branch\nto master branch +"Loan\nIssuance"->"Loan\nIssuance": setup SCC Stub Runner\nto fetch stubs\nfrom Stub Storage +"Loan\nIssuance"->"LI\nSCC\nStub Runner": start stubs\nof FD from\nStub Storage +"LI\nSCC\nStub Runner"->"Stub Storage": find stubs of [FD] +"Stub Storage"->"LI\nSCC\nStub Runner": stubs of [FD] found +"LI\nSCC\nStub Runner"->"FD stub": run stubs of [FD] +"FD stub"->"LI\nSCC\nStub Runner": [FD] stub is running +"LI\nSCC\nStub Runner"->"Loan\nIssuance": stubs running and ready for the test +"Loan\nIssuance"->"Loan\nIssuance": run a test +"Loan\nIssuance"->"FD stub": the test\nsends a request\nto the running stub +"FD stub"->"Loan\nIssuance": stub responds successfuly +"Loan\nIssuance"->"Loan\nIssuance": the test passes successfully +---- + +[[getting-started-cdc-consumer-final-merge]] +==== Merging a Branch to Master + +The following commands show one way to merge a branch into master with Git: + +==== [source,bash,indent=0] ---- $ git checkout master $ git merge --no-ff contract-change-pr ---- +==== -*Work online.* +[[getting-started-cdc-consumer-final-online]] +==== Working Online Now you can disable the offline work for Spring Cloud Contract Stub Runner and indicate -where the repository with your stubs is located. At this moment the stubs of the server +where the repository with your stubs is located. At this moment, the stubs of the server side are automatically downloaded from Nexus/Artifactory. You can set the value of `stubsMode` to `REMOTE`. The following code shows an example of -achieving the same thing by changing the properties. +achieving the same thing by changing the properties: +==== [source,yaml,indent=0] ---- -include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] +include::{introduction_url}/samples/standalone/dsl/http-client/src/test/resources/application-test-repo.yaml[] ---- +==== -That's it! +That's it. You have finished the tutorial. -=== Dependencies +[[getting-started-whats-next]] +== Next Steps -The best way to add dependencies is to use the proper `starter` dependency. +Hopefully, this section provided some of the {project-full-name} basics and got you on your way +to writing your own applications. If you are a task-oriented type of developer, you might +want to jump over to https://spring.io and check out some of the +https://spring.io/guides/[getting started] guides that solve specific "`How do I do that +with Spring?`" problems. We also have {project-full-name}-specific +"`<>`" reference documentation. -For `stub-runner`, use `spring-cloud-starter-stub-runner`. When you use a plugin, add -`spring-cloud-starter-contract-verifier`. +Otherwise, the next logical step is to read <>. If +you are really impatient, you could also jump ahead and read about +<>. -=== Additional Links +In addition to that you can check out the following videos: -Here are some resources related to Spring Cloud Contract Verifier and Stub Runner. Note -that some may be outdated, because the Spring Cloud Contract Verifier project is under -constant development. +- "Consumer Driven Contracts and Your Microservice Architecture" by Olga Maciaszek-Sharma and Marcin Grzejszczak -==== Spring Cloud Contract video +video::pDkC_00hhvA[youtube,width=640,height=480] -You can check out the video from the Warsaw JUG about Spring Cloud Contract: +- "Contract Tests in the Enterprise" by Marcin Grzejszczak -video::sAAklvxmPmk[youtube,start=538,width=640,height=480] +video::ZyHG-VOzPZg[youtube,width=640,height=480] -==== Readings +- "Why Contract Tests Matter?" by Marcin Grzejszczak -- https://www.slideshare.net/MarcinGrzejszczak/stick-to-the-rules-consumer-driven-contracts-201507-confitura[Slides from Marcin Grzejszczak's talk about Accurest] -- https://toomuchcoding.com/blog/categories/accurest/[Accurest related articles from Marcin Grzejszczak's blog] -- https://toomuchcoding.com/blog/categories/spring-cloud-contract/[Spring Cloud Contract related articles from Marcin Grzejszczak's blog] -- https://groovy-lang.org/json.html[Groovy docs regarding JSON] +video::TvpkZu1e2Dc[youtube,start=6262,width=640,height=480] -=== Samples - -You can find some samples at +You can find the default project samples at https://github.com/spring-cloud-samples/spring-cloud-contract-samples[samples]. + +You can find the Spring Cloud Contract workshops https://cloud-samples.spring.io/spring-cloud-contract-samples/[here]. diff --git a/docs/src/main/asciidoc/gradle-project.adoc b/docs/src/main/asciidoc/gradle-project.adoc new file mode 100644 index 0000000000..e12a4b8e1d --- /dev/null +++ b/docs/src/main/asciidoc/gradle-project.adoc @@ -0,0 +1,435 @@ += Gradle Project +include::_attributes.adoc[] + +To learn how to set up the Gradle project for Spring Cloud Contract Verifier, read the +following sections: + +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + +[[gradle-prerequisites]] +== Prerequisites + +In order to use Spring Cloud Contract Verifier with WireMock, you must use either a +Gradle or a Maven plugin. + +WARNING: If you want to use Spock in your projects, you must separately add the +`spock-core` and `spock-spring` modules. See https://spockframework.github.io/[Spock's +documnetation for more information] + +[[gradle-add-gradle-plugin]] +== Add Gradle Plugin with Dependencies + +To add a Gradle plugin with dependencies, you can use code similar to the following: + +==== +[source,groovy,indent=0] +---- +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}" + classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}" + } +} + +apply plugin: 'groovy' +apply plugin: 'spring-cloud-contract' + +dependencyManagement { + imports { + mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${verifier_version}" + } +} + +dependencies { + testCompile "org.codehaus.groovy:groovy-all:${groovyVersion}" + // example with adding Spock core and Spock Spring + testCompile "org.spockframework:spock-core:${spockVersion}" + testCompile "org.spockframework:spock-spring:${spockVersion}" + testCompile 'org.springframework.cloud:spring-cloud-starter-contract-verifier' +} +---- +==== + +[[gradle-and-rest-assured]] +== Gradle and Rest Assured 2.0 + +By default, Rest Assured 3.x is added to the classpath. However, to use Rest Assured 2.x +you can add it to the plugins classpath, as the following listing shows: + +==== +[source,groovy,indent=0] +---- +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}" + classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}" + classpath "com.jayway.restassured:rest-assured:2.5.0" + classpath "com.jayway.restassured:spring-mock-mvc:2.5.0" + } +} + +depenendencies { + // all dependencies + // you can exclude rest-assured from spring-cloud-contract-verifier + testCompile "com.jayway.restassured:rest-assured:2.5.0" + testCompile "com.jayway.restassured:spring-mock-mvc:2.5.0" +} +---- +==== + +That way, the plugin automatically sees that Rest Assured 2.x is present on the classpath +and modifies the imports accordingly. + +[[gradle-snapshot-versions]] +== Snapshot Versions for Gradle + +You can add the additional snapshot repository to your `build.gradle` to use snapshot versions, +which are automatically uploaded after every successful build, as the following listing shows: + +==== +[source,groovy,indent=0] +---- +include::{standalone_samples_path}/http-server/build.gradle[tags=repos,indent=0] +} +---- +==== + +[[gradle-add-stubs]] +== Add stubs + +By default, Spring Cloud Contract Verifier looks for stubs in the +`src/test/resources/contracts` directory. + +The directory that contains stub definitions is treated as a class name, and each stub +definition is treated as a single test. Spring Cloud Contract Verifier assumes that it +contains at least one level of directories that are to be used as the test class name. +If more than one level of nested directories is present, all except the last one is used +as the package name. Consider the following structure: + +==== +[source,groovy,indent=0] +---- +src/test/resources/contracts/myservice/shouldCreateUser.groovy +src/test/resources/contracts/myservice/shouldReturnUser.groovy +---- +==== + +Given the preceding structure, Spring Cloud Contract Verifier creates a test class named +`defaultBasePackage.MyService` with two methods: + +- `shouldCreateUser()` +- `shouldReturnUser()` + +[[gradle-run-plugin]] +== Running the Plugin + +The plugin registers itself to be invoked before a `check` task. If you want it to be +part of your build process, you need do nothing more. If you just want to generate +tests, invoke the `generateContractTests` task. + +[[gradle-default-setup]] +== Default Setup + +The default Gradle Plugin setup creates the following Gradle part of the build (in +pseudocode): + +==== +[source,groovy,indent=0] +---- +contracts { + testFramework ='JUNIT' + testMode = 'MockMvc' + generatedTestSourcesDir = project.file("${project.buildDir}/generated-test-sources/contracts") + generatedTestResourcesDir = project.file("${project.buildDir}/generated-test-resources/contracts") + contractsDslDir = "${project.rootDir}/src/test/resources/contracts" + basePackageForTests = 'org.springframework.cloud.verifier.tests' + stubsOutputDir = project.file("${project.buildDir}/stubs") + + // the following properties are used when you want to provide where the JAR with contract lays + contractDependency { + stringNotation = '' + } + contractsPath = '' + contractsWorkOffline = false + contractRepository { + cacheDownloadedContracts(true) + } +} + +tasks.create(type: Jar, name: 'verifierStubsJar', dependsOn: 'generateClientStubs') { + baseName = project.name + classifier = contracts.stubsSuffix + from contractVerifier.stubsOutputDir +} + +project.artifacts { + archives task +} + +tasks.create(type: Copy, name: 'copyContracts') { + from contracts.contractsDslDir + into contracts.stubsOutputDir +} + +verifierStubsJar.dependsOn 'copyContracts' + +publishing { + publications { + stubs(MavenPublication) { + artifactId project.name + artifact verifierStubsJar + } + } +} +---- +==== + +[[gradle-configure-plugin]] +== Configuring the Plugin + +To change the default configuration, you can add a `contracts` snippet to your Gradle +configuration, as the following listing shows: + +==== +[source,groovy,indent=0] +---- +contracts { + testMode = 'MockMvc' + baseClassForTests = 'org.mycompany.tests' + generatedTestSourcesDir = project.file('src/generatedContract') +} +---- +==== + +[[gradle-configuration-options]] +== Configuration Options + +* `testMode`: Defines the mode for acceptance tests. By default, the mode is MockMvc, +which is based on Spring's MockMvc. It can also be changed to WebTestClient, JaxRsClient, or +Explicit (for real HTTP calls). +* `imports`: Creates an array with imports that should be included in the generated tests +(for example, `['org.myorg.Matchers']`). By default, it creates an empty array. +* `staticImports`: Creates an array with static imports that should be included in +generated tests(for example, `['org.myorg.Matchers.*']`). By default, it creates an empty +array. +* `basePackageForTests`: Specifies the base package for all generated tests. If not set, +the value is picked from the package of `baseClassForTests` and from `packageWithBaseClasses`. +If neither of these values are set, the value is set to +`org.springframework.cloud.contract.verifier.tests`. +* `baseClassForTests`: Creates a base class for all generated tests. By default, if you +use Spock classes, the class is `spock.lang.Specification`. +* `packageWithBaseClasses`: Defines a package where all the base classes reside. This +setting takes precedence over `baseClassForTests`. +* `baseClassMappings`: Explicitly maps a contract package to a FQN of a base class. This +setting takes precedence over `packageWithBaseClasses` and `baseClassForTests`. +* `ruleClassForTests`: Specifies a rule that should be added to the generated test +classes. +* `ignoredFiles`: Uses an `Antmatcher` to allow defining stub files for which processing +should be skipped. By default, it is an empty array. +* `contractsDslDir`: Specifies the directory that contains contracts written by using the +GroovyDSL. By default, its value is `$rootDir/src/test/resources/contracts`. +* `generatedTestSourcesDir`: Specifies the test source directory where tests generated +from the Groovy DSL should be placed. By default, its value is +`$buildDir/generated-test-sources/contracts`. +* `generatedTestResourcesDir`: Specifies the test resource directory where resources used by the tests generated +from the Groovy DSL should be placed. By default, its value is +`$buildDir/generated-test-resources/contracts`. +* `stubsOutputDir`: Specifies the directory where the generated WireMock stubs from +the Groovy DSL should be placed. +* `testFramework`: 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 that contains properties to be passed to Spring Cloud Contract +components. Those properties might be used by (for example) built-in or custom Stub Downloaders. + +You can use the following properties when you want to specify the location of the JAR +that contains 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 for downloading contracts (whether the +JAR is available offline, remotely, and so on). +* `deleteStubsAfterTest`: If set to `false`, do not remove any downloaded +contracts from temporary directories. + +You can also turn on the following experimental features in the plugin: + +* `convertToYaml`: Converts all DSLs to the declarative YAML format. This can be extremely +useful when you use external libraries in your Groovy DSLs. By turning this feature on +(by setting it to `true`) you need not add the library dependency on the consumer side. +* `assertJsonSize`: You can check the size of JSON arrays in the generated tests. This +feature is disabled by default. + +[[gradle-single-base-class]] +== 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. The following example shows how to do so: + +==== +[source,groovy,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0] +---- +==== + +If you use `Explicit` mode, you can use a base class to initialize the whole tested application, +as you might see in regular integration tests. If you use the `JAXRSCLIENT` mode, this +base class should also contain a `protected WebTarget webTarget` field. Right now, the +only option to test the JAX-RS API is to start a web server. + +[[gradle-different-base-classes]] +== Different Base Classes for Contracts + +If your base classes differ between contracts, you can tell the Spring Cloud Contract +plugin which class should get extended by the autogenerated tests. You have two options: + +* Follow a convention by providing the `packageWithBaseClasses` +* Provide explicit mapping by using `baseClassMappings` + +=== By Convention + +The convention is such that if you have a contract in (for example) +`src/test/resources/contract/foo/bar/baz/` and set the value of the +`packageWithBaseClasses` property to `com.example.base`, then Spring Cloud Contract +Verifier assumes that there is a `BarBazBase` class under the `com.example.base` package. +In other words, the system takes the last two parts of the package, if they exist, and +forms a class with a `Base` suffix. This rule takes precedence over `baseClassForTests`. +The following example shows how it works in the `contracts` closure: + +==== +[source,groovy,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierSpec.groovy[tags=package_with_base_classes,indent=0] +---- +==== + +=== By Mapping + +You can manually map a regular expression of the contract's package to the fully qualified +name of the base class for the matched contract. You have to provide a list called +`baseClassMappings` that consists of `baseClassMapping` objects that take a +`contractPackageRegex` to `baseClassFQN` mapping. Consider the following example: + +==== +[source,groovy,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierSpec.groovy[tags=base_class_mappings,indent=0] +---- +==== + +Let's assume that you have contracts in the following directories: + - `src/test/resources/contract/com/` + - `src/test/resources/contract/foo/` + +By providing `baseClassForTests`, we have a fallback in case mapping did not succeed. +(You could also provide the `packageWithBaseClasses` as a fallback.) That way, the tests +generated from `src/test/resources/contract/com/` contracts extend the +`com.example.ComBase`, whereas the rest of the tests extend `com.example.FooBase`. + +[[gradle-invoking-generated-tests]] +== Invoking Generated Tests + +To ensure that the provider side is compliant with your defined contracts, you need to run +the following command: + +==== +[source,bash,indent=0] +---- +./gradlew generateContractTests test +---- +==== + +[[gradle-pushing-stubs-to-scm]] +== Pushing Stubs to SCM + +If you use the SCM repository to keep the contracts and +stubs, you might want to automate the step of pushing stubs to +the repository. To do that, you can call the `pushStubsToScm` +task by running the following command: + +==== +[source,bash,indent=0] +---- +$ ./gradlew pushStubsToScm +---- +==== + +Under <> you can find all possible +configuration options that you can pass either through +the `contractsProperties` field (for example, `contracts { contractsProperties = [foo:"bar"] }`), +through the `contractsProperties` method (for example, `contracts { contractsProperties([foo:"bar"]) }`), +or through a system property or an environment variable. + +[[gradle-consumer]] +== Spring Cloud Contract Verifier on the Consumer Side + +In a consuming service, you need to configure the Spring Cloud Contract Verifier plugin +in exactly the same way as in the case of a provider. If you do not want to use Stub Runner, +you need to copy the contracts stored in `src/test/resources/contracts` and generate +WireMock JSON stubs by using the following command: + +==== +[source,bash,indent=0] +---- +./gradlew generateClientStubs +---- +==== + +NOTE: The `stubsOutputDir` option has to be set for stub generation to work. + +When present, JSON stubs can be used in automated tests to consume a service. The +following example shows how to do so: + +==== +[source,groovy,indent=0] +---- +@ContextConfiguration(loader == SpringApplicationContextLoader, classes == Application) +class LoanApplicationServiceSpec extends Specification { + + @ClassRule + @Shared + WireMockClassRule wireMockRule == new WireMockClassRule() + + @Autowired + LoanApplicationService sut + + def 'should successfully apply for loan'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(clientPesel: '12345678901'), amount: 123.123) + when: + LoanApplicationResult loanApplication == sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLIED + loanApplication.rejectionReason == null + } +} +---- +==== + +In the preceding example, `LoanApplication` makes a call to the `FraudDetection` service. +This request is handled by a WireMock server configured with stubs that were generated by +Spring Cloud Contract Verifier. diff --git a/docs/src/main/asciidoc/howto.adoc b/docs/src/main/asciidoc/howto.adoc new file mode 100644 index 0000000000..059a55a9c7 --- /dev/null +++ b/docs/src/main/asciidoc/howto.adoc @@ -0,0 +1,1434 @@ +[[howto]] += "`How-to`" Guides +include::_attributes.adoc[] + +This section provides answers to some common "`how do I do that...`" questions +that often arise when using {project-full-name}. Its coverage is not exhaustive, but it +does cover quite a lot. + +If you have a specific problem that we do not cover here, you might want to check out +https://stackoverflow.com/tags/{project-name}[stackoverflow.com] to see if someone has +already provided an answer. Stack Overflow is also a great place to ask new questions (please use +the `{project-name}` tag). + +We are also more than happy to extend this section. If you want to add a "`how-to`", +send us a {github-code}[pull request]. + +[[why-spring-cloud-contract]] +== Why use Spring Cloud Contract? + +Spring Cloud Contract works great in a polyglot environment. This project has a lot of +really interesting features. Quite a few of these features definitely make +Spring Cloud Contract Verifier stand out on the market of Consumer Driven Contract +(CDC) tooling. The most interesting features include the following: + +- Ability to do CDC with messaging. +- Clear and easy to use, statically typed DSL. +- Ability to copy-paste your current JSON file to the contract and only edit its elements. +- Automatic generation of tests from the defined Contract. +- Stub Runner functionality: The stubs are automatically downloaded at runtime from Nexus/Artifactory. +- Spring Cloud integration: No discovery service is needed for integration tests. +- Spring Cloud Contract integrates with Pact and provides easy hooks to extend its functionality. +- Ability to add support for any language & framework through Docker. + +[[how-to-not-write-contracts-in-groovy]] +== How Can I Write Contracts in a Language Other than Groovy? + +You can write a contract in YAML. See <> for more information. + +We are working on allowing more ways of describing the contracts. You can check the {github-issues}[github-issues] for more information. + +[[how-to-provide-dynamic-values]] +== How Can I Provide Dynamic Values to a Contract? + +One of the biggest challenges related to stubs is their reusability. Only if they can be widely used can they serve their purpose. +The hard-coded values (such as dates and IDs) of request and response elements generally make that difficult. +Consider the following JSON request: + +==== +[source,json,indent=0] +---- +{ + "time" : "2016-10-10 20:10:15", + "id" : "9febab1c-6f36-4a0b-88d6-3b6a6d81cd4a", + "body" : "foo" +} +---- +==== + +Now consider the following JSON response: + +==== +[source,json,indent=0] +---- +{ + "time" : "2016-10-10 21:10:15", + "id" : "c4231e1f-3ca9-48d3-b7e7-567d55f0d051", + "body" : "bar" +} +---- +==== + +Imagine the pain required to set the proper value of the `time` field (assume that this content is generated by the +database) by changing the clock in the system or by providing stub implementations of data providers. The same is related +to the field called `id`. You could create a stubbed implementation of UUID generator, but doing so makes little sense. + +So, as a consumer, you want to send a request that matches any form of a time or any UUID. That way, your system +works as usual, generating data without you having to stub out anything. Assume that, in case of the aforementioned +JSON, the most important part is the `body` field. You can focus on that and provide matching for other fields. In other words, +you would like the stub to work as follows: + +==== +[source,json,indent=0] +---- +{ + "time" : "SOMETHING THAT MATCHES TIME", + "id" : "SOMETHING THAT MATCHES UUID", + "body" : "foo" +} +---- +==== + +As far as the response goes, as a consumer, you need a concrete value on which you can operate. +Consequently, the following JSON is valid: + +==== +[source,json,indent=0] +---- +{ + "time" : "2016-10-10 21:10:15", + "id" : "c4231e1f-3ca9-48d3-b7e7-567d55f0d051", + "body" : "bar" +} +---- +==== + +In the previous sections, we generated tests from contracts. So, from the producer's side, the situation looks +much different. We parse the provided contract, and, in the test, we want to send a real request to your endpoints. +So, for the case of a producer for the request, we cannot have any sort of matching. We need concrete values on which the +producer's backend can work. Consequently, the following JSON would be valid: + +==== +[source,json,indent=0] +---- +{ + "time" : "2016-10-10 20:10:15", + "id" : "9febab1c-6f36-4a0b-88d6-3b6a6d81cd4a", + "body" : "foo" +} +---- +==== + +On the other hand, from the point of view of the validity of the contract, the response does not necessarily have to +contain concrete values for `time` or `id`. Suppose you generate those on the producer side. Again, you +have to do a lot of stubbing to ensure that you always return the same values. That is why, from the producer's side +you might want the following response: + +==== +[source,json,indent=0] +---- +{ + "time" : "SOMETHING THAT MATCHES TIME", + "id" : "SOMETHING THAT MATCHES UUID", + "body" : "bar" +} +---- +==== + +How can you then provide a matcher for the consumer and a concrete value for the producer (and the opposite at some other time)? +Spring Cloud Contract lets you provide a dynamic value. That means that it can differ for both +sides of the communication. + +You can read more about this in the <> section. + +IMPORTANT: Read the https://groovy-lang.org/json.html[Groovy docs related to JSON] to understand how to +properly structure the request and response bodies. + +[[how-to-do-stubs-versioning]] +== How to Do Stubs versioning? + +This section covers version of the stubs, which you can handle in a number of different ways: + +* <> +* <> +* <> + +[[how-to-api-versioning]] +=== API Versioning + +What does versioning really mean? If you refer to the API version, there are +different approaches: + +- Use hypermedia links and do not version your API by any means +- Pass the version through headers and URLs + +We do not try to answer the question of which approach is better. You should pick whatever +suits your needs and lets you generate business value. + +Assume that you do version your API. In that case, you should provide as many contracts with as many versions as you support. +You can create a subfolder for every version or append it to the contract name -- whatever suits you best. + +[[how-to-jar-versioning]] +=== JAR versioning + +If, by versioning, you mean the version of the JAR that contains the stubs, then there are essentially two main approaches. + +Assume that you do continuous delivery and deployment, which means that you generate a new version of +the jar each time you go through the pipeline and that the jar can go to production at any time. For example, your jar version +looks like the following (because it got built on the 20.10.2016 at 20:15:21) : + +==== +[source,groovy,indent=0] +---- +1.0.0.20161020-201521-RELEASE +---- +==== + +In that case your, generated stub jar should look like the following: + +==== +[source,groovy,indent=0] +---- +1.0.0.20161020-201521-RELEASE-stubs.jar +---- +==== + +In this case, you should, inside your `application.yml` or `@AutoConfigureStubRunner` when +referencing stubs, provide the latest version of the stubs. You can do that by passing the +`+` sign. the following example shows how to do so: + +==== +[source,java,indent=0] +---- +@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:stubs:8080"}) +---- +==== + +If the versioning, however, is fixed (for example, `1.0.4.RELEASE` or `2.1.1`), you have to set the concrete value of the jar +version. The following example shows how to do so for version 2.1.1: + +==== +[source,java,indent=0] +---- +@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:2.1.1:stubs:8080"}) +---- +==== + +[[how-to-dev-or-prod-stubs]] +=== Development or Production Stubs + +You can manipulate the classifier to run the tests against current the development version +of the stubs of other services or the ones that were deployed to production. If you alter +your build to deploy the stubs with the `prod-stubs` classifier once you reach production +deployment, you can run tests in one case with development stubs and one with production stubs. + +The following example works for tests that use the development version of the stubs: + +==== +[source,java,indent=0] +---- +@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:stubs:8080"}) +---- +==== + +The following example works for tests that use the production version of stubs: + +==== +[source,java,indent=0] +---- +@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:prod-stubs:8080"}) +---- +==== + +You can also pass those values also in properties from your deployment pipeline. + +[[how-to-common-repo-with-contracts]] +== How Can I use a Common Repository with Contracts Instead of Storing Them with the Producer? + +Another way of storing contracts, rather than having them with the producer, is to keep +them in a common place. This situation can be related to security issues (where the +consumers cannot clone the producer's code). Also if you keep contracts in a single place, +then you, as a producer, know how many consumers you have and which consumer you may break +with your local changes. + +[[how-to-repo-structure]] +=== Repo Structure + +Assume that we have a producer with coordinates of `com.example:server` and three +consumers: `client1`, `client2`, and `client3`. Then, in the repository with common +contracts, you could have the following setup (which you can check out +https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples/standalone/contracts[here]). +The following listing shows such a structure: + +==== +[source,bash,indent=0] +---- +├── com +│   └── example +│   └── server +│   ├── client1 +│   │   └── expectation.groovy +│   ├── client2 +│   │   └── expectation.groovy +│   ├── client3 +│   │   └── expectation.groovy +│   └── pom.xml +├── mvnw +├── mvnw.cmd +├── pom.xml +└── src + └── assembly + └── contracts.xml +---- +==== + +As you can see under the slash-delimited `groupid/artifact id` folder (`com/example/server`) you have +expectations of the three consumers (`client1`, `client2`, and `client3`). Expectations are the standard Groovy DSL +contract files, as described throughout this documentation. This repository has to produce a JAR file that maps +one-to-one to the contents of the repository. + +The following example shows a `pom.xml` inside the `server` folder: + +==== +[source,xml,indent=0] +---- +include::{introduction_url}/samples/standalone/contracts/com/example/server/pom.xml[indent=0] +---- +==== + +There are no dependencies other than the Spring Cloud Contract Maven Plugin. +Those pom files are necessary for the consumer side to run `mvn clean install -DskipTests` to locally install +the stubs of the producer project. + +The `pom.xml` in the root folder can look like the following: + +==== +[source,xml,indent=0] +---- +include::{introduction_url}/samples/standalone/contracts/pom.xml[indent=0] +---- +==== + +It uses the assembly plugin to build the JAR with all the contracts. The following example +shows such a setup: + +==== +[source,xml,indent=0] +---- +include::{introduction_url}/samples/standalone/contracts/src/assembly/contracts.xml[indent=0] +---- +==== + +[[how-to-workflow]] +=== Workflow + +The workflow assumes that Spring Cloud Contract is set up both on the consumer and on the +producer side. There is also the proper plugin setup in the common repository with +contracts. The CI jobs are set for a common repository to build an artifact of all +contracts and upload it to Nexus/Artifactory. The following image shows the UML for this +workflow: + +[plantuml, how-to-common-repo, png] +---- +"API Consumer"->"Common repo": create a folder \nfor producer [API Producer] +"API Consumer"->"Common repo": under [API Producer] create a folder \nfor consumer \n[API Consumer] +"API Consumer"->"Common repo": define contracts under \n[API Consumer] folder +"API Consumer"->"Common repo": install stubs of [API Producer]\nin local storage +"Common repo"->"Common Repo\nSCC Plugin": install stubs \nin local storage. \nDon't generate tests. +"Common Repo\nSCC Plugin"->"Local storage": install stubs +"Local storage"->"Common Repo\nSCC Plugin": stubs installed +"API Consumer"->"API Consumer": write a SCC Stub Runner \nbased contract test +"API Consumer"->"API Consumer\nSCC Stub Runner": fetch the stubs\n of [API Producer] \nfrom local storage +"API Consumer\nSCC Stub Runner"->"Local storage": test asks for [API Producer] stubs +"Local storage"->"API Consumer\nSCC Stub Runner": [API Producer] stubs found +"API Consumer\nSCC Stub Runner"->"API Consumer\nSCC Stub Runner": run in memory\n HTTP server stubs +"API Consumer\nSCC Stub Runner"->"API Consumer": HTTP server stubs running,\n ready for tests +"API Consumer"->"API Consumer\nSCC Stub Runner": send a request \nto the HTTP server stub +"API Consumer\nSCC Stub Runner"->"API Consumer": communication is correct. \nTests are passing +"API Consumer"->"Common repo": file pull request \nwith contracts +"API Producer"->"Common repo": take over \nthe pull request +"API Producer"->"Common repo": install the JAR \nwith all contracts\n in local storage +"Common repo"->"Local storage": install the JAR +"Local storage"->"Common repo": contracts JAR installed +"API Producer"->"Producer Build": run the build \nand fetch contracts from \nlocal storage +"Producer Build"->"Producer\nSCC Plugin": generate \ntests, stubs and stubs \nartifact (e.g. stubs-jar) +"Producer\nSCC Plugin"->"Local storage": fetch contract definitions for [API Prodcer] +"Local storage"->"Producer\nSCC Plugin": contracts fetched +"Producer\nSCC Plugin"->"Producer Build": tests and stubs created +"Producer Build"->"Nexus / Artifactory": upload contracts \nand stubs and the project arifact +"Producer Build"->"API Producer": Build successful +"API Producer"->"Common repo": merge the pull request +"Common repo"->"Nexus / Artifactory": upload the fresh JAR \nwith contract definitions +"API Producer"->"API Producer": start fetching contract definitions \nfrom Nexus / Artifactory +---- + +[[how-to-workflow-consumer]] +=== Consumer + +When the consumer wants to work on the contracts offline, instead of cloning the producer +code, the consumer team clones the common repository, goes to the required producer's +folder (for example, `com/example/server`) and runs `mvn clean install -DskipTests` to +locally install the stubs converted from the contracts. + +TIP: You need to have https://maven.apache.org/download.cgi[Maven installed locally] + +[[how-to-workflow-producer]] +=== Producer + +As a producer, you can to alter the Spring Cloud Contract Verifier to provide the URL and +the dependency of the JAR that contains the contracts, as follows: + +==== +[source,xml,indent=0] +---- +include::{introduction_url}/spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/test/projects/basic-remote-contracts/pom-with-repo.xml[tags=remote_config,indent=0] +---- +==== + +With this setup, the JAR with a groupid of `com.example.standalone` and artifactid +`contracts` is downloaded from `https://link/to/your/nexus/or/artifactory/or/sth`. It is +then unpacked in a local temporary folder, and the contracts present in +`com/example/server` are picked as the ones used to generate the tests and the stubs. Due +to this convention, the producer team can know which consumer teams will be broken when +some incompatible changes are made. + +The rest of the flow looks the same. + +[[how-to-define-messaging-contracts-per-topic]] +=== How Can I Define Messaging Contracts per Topic Rather than per Producer? + +To avoid messaging contracts duplication in the common repository, when a few producers write messages to one topic, +we could create a structure in which the REST contracts are placed in a folder per producer and messaging +contracts are placed in the folder per topic. + +[[how-to-define-messaging-contracts-per-topic-maven]] +==== For Maven Projects + +To make it possible to work on the producer side, we should specify an inclusion pattern for +filtering common repository jar files by messaging topics we are interested in. The +`includedFiles` property of the Maven Spring Cloud Contract plugin +lets us do so. Also, `contractsPath` need to be specified, since the default path would be +the common repository `groupid/artifactid`. The following example shows a Maven +plugin for Spring Cloud Contract: + +==== +[source,xml,indent=0] +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + + REMOTE + https://link/to/your/nexus/or/artifactory/or/sth + + com.example + common-repo-with-contracts + + + + / + + + .*messaging.* + com.example.services.MessagingBase + + + .*rest.* + com.example.services.TestBase + + + + **/${project.artifactId}/** + **/${first-topic}/** + **/${second-topic}/** + + + +---- +==== + +NOTE: Many of the values in the preceding Maven plugin can be changed. We included it for +illustration purposes rather than trying to provide a "`typical`" example. + +[[how-to-define-messaging-contracts-per-topic-gradle]] +==== For Gradle Projects + +To work with a Gradle project: + +. Add a custom configuration for the common repository dependency, as follows: ++ +==== +[source,groovy,indent=0] +---- +ext { + conractsGroupId = "com.example" + contractsArtifactId = "common-repo" + contractsVersion = "1.2.3" +} + +configurations { + contracts { + transitive = false + } +} +---- +==== + +. Add the common repository dependency to your classpath, as follows: ++ +==== +[source,groovy,indent=0] +---- +dependencies { + contracts "${conractsGroupId}:${contractsArtifactId}:${contractsVersion}" + testCompile "${conractsGroupId}:${contractsArtifactId}:${contractsVersion}" +} +---- +==== + +. Download the dependency to an appropriate folder, as follows: ++ +==== +[source,groovy,indent=0] +---- +task getContracts(type: Copy) { + from configurations.contracts + into new File(project.buildDir, "downloadedContracts") +} +---- +==== + +. Unzip the JAR, as follows: ++ +==== +[source,groovy,indent=0] +---- +task unzipContracts(type: Copy) { + def zipFile = new File(project.buildDir, "downloadedContracts/${contractsArtifactId}-${contractsVersion}.jar") + def outputDir = file("${buildDir}/unpackedContracts") + + from zipTree(zipFile) + into outputDir +} +---- +==== + +. Cleanup unused contracts, as follows: ++ +==== +[source,groovy,indent=0] +---- +task deleteUnwantedContracts(type: Delete) { + delete fileTree(dir: "${buildDir}/unpackedContracts", + include: "**/*", + excludes: [ + "**/${project.name}/**"", + "**/${first-topic}/**", + "**/${second-topic}/**"]) +} +---- +==== + +. Create task dependencies, as follows: ++ +==== +[source,groovy,indent=0] +---- +unzipContracts.dependsOn("getContracts") +deleteUnwantedContracts.dependsOn("unzipContracts") +build.dependsOn("deleteUnwantedContracts") +---- +==== + +. Configure the plugin by specifying the directory that contains the contracts, by setting +the `contractsDslDir` property, as follows: ++ +==== +[source,groovy,indent=0] +---- +contracts { + contractsDslDir = new File("${buildDir}/unpackedContracts") +} +---- +==== + +[[how-to-use-git-as-storage]] +== How Can I Use Git as the Storage for Contracts and Stubs? + +In the polyglot world, there are languages that do not use binary storages, as +Artifactory or Nexus do. Starting from Spring Cloud Contract version 2.0.0, we provide +mechanisms to store contracts and stubs in a SCM (Source Control Management) repository. Currently, the +only supported SCM is Git. + +The repository would have to have the following setup +(which you can checkout from https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/contracts_git/[here]): + +==== +[source,indent=0] +---- +. +└── META-INF + └── com.example + └── beer-api-producer-git + └── 0.0.1-SNAPSHOT + ├── contracts + │   └── beer-api-consumer + │   ├── messaging + │   │   ├── shouldSendAcceptedVerification.groovy + │   │   └── shouldSendRejectedVerification.groovy + │   └── rest + │   ├── shouldGrantABeerIfOldEnough.groovy + │   └── shouldRejectABeerIfTooYoung.groovy + └── mappings + └── beer-api-consumer + └── rest + ├── shouldGrantABeerIfOldEnough.json + └── shouldRejectABeerIfTooYoung.json +---- +==== + +Under the `META-INF` folder: + +* We group applications by `groupId` (such as `com.example`). +* Each application is represented by its `artifactId` (for example, `beer-api-producer-git`). +* Next, each application is organized by its version (such as `0.0.1-SNAPSHOT`). Starting +from Spring Cloud Contract version `2.1.0`, you can specify the versions as follows +(assuming that your versions follow semantic versioning): +** `+` or `latest`: To find the latest version of your stubs (assuming that the snapshots +are always the latest artifact for a given revision number). That means: +*** If you have `1.0.0.RELEASE`, `2.0.0.BUILD-SNAPSHOT`, and `2.0.0.RELEASE`, we assume +that the latest is `2.0.0.BUILD-SNAPSHOT`. +*** If you have `1.0.0.RELEASE` and `2.0.0.RELEASE`, we assume that the latest is `2.0.0.RELEASE`. +*** If you have a version called `latest` or `+`, we will pick that folder. +** `release`: To find the latest release version of your stubs. That means: +*** If you have `1.0.0.RELEASE`, `2.0.0.BUILD-SNAPSHOT`, and `2.0.0.RELEASE` we assume +that the latest is `2.0.0.RELEASE`. +*** If you have a version called `release`, we pick that folder. + +Finally, there are two folders: + +* `contracts`: The good practice is to store the contracts required by each +consumer in the folder with the consumer name (such as `beer-api-consumer`). That way, you +can use the `stubs-per-consumer` feature. Further directory structure is arbitrary. +* `mappings`: The Maven or Gradle Spring Cloud Contract plugins push +the stub server mappings in this folder. On the consumer side, Stub Runner scans this folder +to start stub servers with stub definitions. The folder structure is a copy +of the one created in the `contracts` subfolder. + +[[how-to-protocol-convention]] +=== Protocol Convention + +To control the type and location of the source of contracts (whether +binary storage or an SCM repository), you can use the protocol in the URL of +the repository. Spring Cloud Contract iterates over registered protocol resolvers +and tries to fetch the contracts (by using a plugin) or stubs (from Stub Runner). + +For the SCM functionality, currently, we support the Git repository. To use it, +in the property where the repository URL needs to be placed, you have to prefix +the connection URL with `git://`. The following listing shows some examples: + +==== +[source,indent=0] +---- +git://file:///foo/bar +git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git +git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git +---- +==== + +[[how-to-protocol-convention-producer]] +=== Producer + +For the producer, to use the SCM (Source Control Management) approach, we can reuse the +same mechanism we use for external contracts. We route Spring Cloud Contract +to use the SCM implementation from the URL that starts with +the `git://` protocol. + +IMPORTANT: You have to manually add the `pushStubsToScm` +goal in Maven or execute (bind) the `pushStubsToScm` task in +Gradle. We do not push stubs to the `origin` of your git +repository. + +The following listing includes the relevant parts both Maven and Gradle build files: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + + + + git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git + + + + ${project.groupId} + ${project.artifactId} + ${project.version} + + + + REMOTE + + + + package + + + pushStubsToScm + + + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +contracts { + // We want to pick contracts from a Git repository + contractDependency { + stringNotation = "${project.group}:${project.name}:${project.version}" + } + /* + We reuse the contract dependency section to set up the path + to the folder that contains the contract definitions. In our case the + path will be /groupId/artifactId/version/contracts + */ + contractRepository { + repositoryUrl = "git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git" + } + // The mode can't be classpath + contractsMode = "REMOTE" + // Base class mappings etc. +} + +/* +In this scenario we want to publish stubs to SCM whenever +the `publish` task is executed +*/ +publish.dependsOn("publishStubsToScm") +---- +==== + +With such a setup: + +* A git project is cloned to a temporary directory +* The SCM stub downloader goes to `META-INF/groupId/artifactId/version/contracts` folder +to find contracts. For example, for `com.example:foo:1.0.0`, the path would be +`META-INF/com.example/foo/1.0.0/contracts`. +* Tests are generated from the contracts. +* Stubs are created from the contracts. +* Once the tests pass, the stubs are committed in the cloned repository. +* Finally, a push is sent to that repo's `origin`. + +[[how-to-protocol-convention-producer-with-contracts-stored-locally]] +=== Producer with Contracts Stored Locally + +Another option to use the SCM as the destination for stubs and contracts is to store the +contracts locally, with the producer, and only push the contracts and the stubs to SCM. +The following listing shows the setup required to achieve this with Maven and Gradle: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- +include::{samples_url}/producer_with_empty_git/pom.xml[tags=plugin,indent=0] +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +include::{samples_url}/producer_with_empty_git/build.gradle[tags=plugin,indent=0] +---- +==== + +With such a setup: + +* Contracts from the default `src/test/resources/contracts` directory are picked. +* Tests are generated from the contracts. +* Stubs are created from the contracts. +* Once the tests pass: +** The git project is cloned to a temporary directory. +** The stubs and contracts are committed in the cloned repository. +* Finally, a push is done to that repository's `origin`. + +[[how-to-protocol-convention-contracts-producer-stubs-external]] +=== Keeping Contracts with the Producer and Stubs in an External Repository + +You can also keep the contracts in the producer repository but keep the stubs in an external git repository. +This is most useful when you want to use the base consumer-producer collaboration flow but cannot +use an artifact repository to store the stubs. + +To do so, use the usual producer setup and then add the `pushStubsToScm` goal and set +`contractsRepositoryUrl` to the repository where you want to keep the stubs. + +[[how-to-protocol-convention-contracts-producer-stubs-external-consumer]] +=== Consumer + +On the consumer side, when passing the `repositoryRoot` parameter, +either from the `@AutoConfigureStubRunner` annotation, the +JUnit rule, JUnit 5 extension, or properties, you can pass the URL of the +SCM repository, prefixed with the `git://` protocol. The following example shows how to do so: + +==== +[source,java,indent=0] +---- +@AutoConfigureStubRunner( + stubsMode="REMOTE", + repositoryRoot="git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git", + ids="com.example:bookstore:0.0.1.RELEASE" +) +---- +==== + +With such a setup: + +* The git project is cloned to a temporary directory. +* The SCM stub downloader goes to thje `META-INF/groupId/artifactId/version/` folder +to find stub definitions and contracts. For example, for `com.example:foo:1.0.0`, the path would be +`META-INF/com.example/foo/1.0.0/`. +* Stub servers are started and fed with mappings. +* Messaging definitions are read and used in the messaging tests. + +[[how-to-use-pact-broker]] +== How Can I Use the Pact Broker? + +When using https://pact.io/[Pact], you can use the https://github.com/pact-foundation/pact_broker[Pact Broker] +to store and share Pact definitions. Starting from Spring Cloud Contract +2.0.0, you can fetch Pact files from the Pact Broker to generate +tests and stubs. + +IMPORTANT: Pact follows the consumer contract convention. That means +that the consumer creates the Pact definitions first and then +shares the files with the Producer. Those expectations are generated +from the Consumer's code and can break the Producer if the expectations +are not met. + +[[how-to-use-pact-broker-pact]] +=== How to Work with Pact + +Spring Cloud Contract includes support for the https://docs.pact.io/[Pact] representation of +contracts up until version 4. Instead of using the DSL, you can use Pact files. In this section, we +show how to add Pact support for your project. Note, however, that not all functionality is supported. +Starting with version 3, you can combine multiple matchers for the same element; +you can use matchers for the body, headers, request and path; and you can use value generators. +Spring Cloud Contract currently only supports multiple matchers that are combined by using the `AND` rule logic. +Next to that, the request and path matchers are skipped during the conversion. +When using a date, time, or datetime value generator with a given format, +the given format is skipped and the ISO format is used. + +[[how-to-use-pact-broker-pact-converter]] +=== Pact Converter + +In order to properly support the Spring Cloud Contract way of doing messaging +with Pact, you have to provide some additional meta data entries. + +To define the destination to which a message gets sent, you have to +set a `metaData` entry in the Pact file with the `sentTo` key equal to the destination to + which a message is to be sent (for example, `"metaData": { "sentTo": "activemq:output" }`). + +[[how-to-use-pact-broker-pact-contract]] +=== Pact Contract + +Spring Cloud Contract can read the Pact JSON definition. You can place the file in the +`src/test/resources/contracts` folder. The following example shows such a Pact contract: + +==== +[source,javascript,indent=0] +---- +include::{standalone_pact_path}/pact-http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.json[indent=0] +---- +==== + +[[how-to-use-pact-broker-pact-for-producers]] +=== Pact for Producers + +On the producer side, you must add two additional dependencies to your plugin +configuration. One is the Spring Cloud Contract Pact support, and the other represents +the current Pact version that you use. The following listing shows how to do so for both +Maven and Gradle: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- +include::{standalone_pact_path}/pact-http-server/pom.xml[tags=pact_dependency,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +include::{standalone_pact_path}/pact-http-server/build.gradle[tags=pact_dependency,indent=0] +---- +==== + +When you execute the build of your application, a test and stub is generated. The following +example shows a test and stub that came from this process: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.test +---- +@Test + public void validate_shouldMarkClientAsFraud() throws Exception { + // given: + MockMvcRequestSpecification request = given() + .header("Content-Type", "application/vnd.fraud.v1+json") + .body("{\"clientId\":\"1234567890\",\"loanAmount\":99999}"); + + // when: + ResponseOptions response = given().spec(request) + .put("/fraudcheck"); + + // then: + assertThat(response.statusCode()).isEqualTo(200); + assertThat(response.header("Content-Type")).matches("application/vnd\\.fraud\\.v1\\+json.*"); + // and: + DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); + assertThatJson(parsedJson).field("['rejectionReason']").isEqualTo("Amount too high"); + // and: + assertThat(parsedJson.read("$.fraudCheckStatus", String.class)).matches("FRAUD"); + } +---- + +[source,json,indent=0,subs="verbatim,attributes",role="secondary"] +.stub +---- +{ + "id" : "996ae5ae-6834-4db6-8fac-358ca187ab62", + "uuid" : "996ae5ae-6834-4db6-8fac-358ca187ab62", + "request" : { + "url" : "/fraudcheck", + "method" : "PUT", + "headers" : { + "Content-Type" : { + "matches" : "application/vnd\\.fraud\\.v1\\+json.*" + } + }, + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.['loanAmount'] = 99999)]" + }, { + "matchesJsonPath" : "$[?(@.clientId =~ /([0-9]{10})/)]" + } ] + }, + "response" : { + "status" : 200, + "body" : "{\"fraudCheckStatus\":\"FRAUD\",\"rejectionReason\":\"Amount too high\"}", + "headers" : { + "Content-Type" : "application/vnd.fraud.v1+json;charset=UTF-8" + }, + "transformers" : [ "response-template" ] + }, +} +---- +==== + +[[how-to-use-pact-broker-pact-consumers]] +=== Pact for Consumers + +On the producer side, you must add two additional dependencies to your project +dependencies. One is the Spring Cloud Contract Pact support, and the other represents the +current Pact version that you use. The following listing shows how to do so for both +Maven and Gradle: + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- +include::{standalone_pact_path}/pact-http-client/pom.xml[tags=pact_dependency,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +include::{standalone_pact_path}/pact-http-client/build.gradle[tags=pact_dependency,indent=0] +---- +==== + +[[pact-stub-downloader]] +=== Communicating with the Pact Broker + +Whenever the `repositoryRoot` property starts with a Pact protocol +(starts with `pact://`), the stub downloader tries +to fetch the Pact contract definitions from the Pact Broker. +Whatever is set after `pact://` is parsed as the Pact Broker URL. + +By setting environment variables, system properties, or properties set +inside the plugin or contracts repository configuration, you can +tweak the downloader's behavior. The following table describes the +properties: + +.Pact 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` +|The URL of the Pact Broker. + +| +* `pactbroker.port` (plugin prop) + +* `stubrunner.properties.pactbroker.port` (system prop) + +* `STUBRUNNER_PROPERTIES_PACTBROKER_PORT` (env prop) +|Port from URL passed to `repositoryRoot` +|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` +|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 `+` +|The tags that 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` +|The kind of authentication that 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) +|The username to use when connecting 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) +|The password to use when connecting 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 is a combination of `groupId:artifactId`. If `false`, only `artifactId` is used. +|==== + +[[how-to-pact-consumer]] +=== Flow: Consumer Contract approach with Pact Broker | Consumer Side + +The consumer uses the Pact framework to generate Pact files. The +Pact files are sent to the Pact Broker. You can find an example of such a setup +https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/consumer_pact[here]. + +[[how-to-pact-producer]] +=== Flow: Consumer Contract Approach with Pact Broker on the Producer Side + +For the producer to use the Pact files from the Pact Broker, we can reuse the +same mechanism we use for external contracts. We route Spring Cloud Contract +to use the Pact implementation with the URL that contains +the `pact://` protocol. You can pass the URL to the +Pact Broker. You can find an example of such a setup +https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/producer_pact[here]. +The following listing shows the configuration details for both Maven and Gradle: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + + + + pact://http://localhost:8085 + + + + ${project.groupId} + ${project.artifactId} + + + + + + + REMOTE + + + + + org.springframework.cloud + spring-cloud-contract-pact + ${spring-cloud-contract.version} + + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +buildscript { + repositories { + //... + } + + dependencies { + // ... + // Don't forget to add spring-cloud-contract-pact to the classpath! + classpath "org.springframework.cloud:spring-cloud-contract-pact:${contractVersion}" + } +} + +contracts { + // When + is passed, a latest tag will be applied when fetching pacts + contractDependency { + stringNotation = "${project.group}:${project.name}:+" + } + contractRepository { + repositoryUrl = "pact://http://localhost:8085" + } + // The mode can't be classpath + contractsMode = "REMOTE" + // Base class mappings etc. +} +---- +==== + +With such a setup: + +* Pact files are downloaded from the Pact Broker. +* Spring Cloud Contract converts the Pact files into tests and stubs. +* The JAR with the stubs gets automatically created, as usual. + +[[how-to-pact-consumer-producer-contract]] +=== Flow: Producer Contract approach with Pact on the Consumer Side + +In the scenario where you do not want to do the consumer contract approach +(for every single consumer, define the expectations) but you prefer +to do producer contracts (the producer provides the contracts and +publishes stubs), you can use Spring Cloud Contract with the +Stub Runner option. You can find an example of such a setup +https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/consumer_pact_stubrunner[here]. + +Remember to add the Stub Runner and Spring Cloud Contract Pact modules +as test dependencies. + +The following listing shows the configuration details for both Maven and Gradle: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + + + org.springframework.cloud + spring-cloud-dependencies + ${spring-cloud.version} + pom + import + + + + + + + + + org.springframework.cloud + spring-cloud-starter-contract-stub-runner + test + + + org.springframework.cloud + spring-cloud-contract-pact + test + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +dependencyManagement { + imports { + mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" + } +} + +dependencies { + //... + testCompile("org.springframework.cloud:spring-cloud-starter-contract-stub-runner") + // Don't forget to add spring-cloud-contract-pact to the classpath! + testCompile("org.springframework.cloud:spring-cloud-contract-pact") +} +---- +==== + +Next, you can pass the URL of the Pact Broker to `repositoryRoot`, prefixed +with `pact://` protocol (for example, `pact://http://localhost:8085`), as the following +example shows: + +==== +[source,java,indent=0] +---- +@RunWith(SpringRunner.class) +@SpringBootTest +@AutoConfigureStubRunner(stubsMode = StubRunnerProperties.StubsMode.REMOTE, + ids = "com.example:beer-api-producer-pact", + repositoryRoot = "pact://http://localhost:8085") +public class BeerControllerTest { + //Inject the port of the running stub + @StubRunnerPort("beer-api-producer-pact") int producerPort; + //... +} +---- +==== + +With such a setup: + +* Pact files are downloaded from the Pact Broker. +* Spring Cloud Contract converts the Pact files into stub definitions. +* The stub servers are started and fed with stubs. + +[[how-to-debug]] +== How Can I Debug the Request/Response Being Sent by the Generated Tests Client? + +The generated tests all boil down to RestAssured in some form or fashion. RestAssured +relies on the https://hc.apache.org/httpcomponents-client-ga/[Apache HttpClient]. +HttpClient has a facility called +https://hc.apache.org/httpcomponents-client-ga/logging.html#Wire_Logging[wire logging], +which logs the entire request and response to HttpClient. Spring Boot has a logging +https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html[common application property] +for doing this sort of thing. To use it, add this to your application properties, as follows: + +==== +[source,properties,indent=0] +---- +logging.level.org.apache.http.wire=DEBUG +---- +==== + +[[how-to-debug-wiremock]] +== How Can I Debug the Mapping, Request, or Response Being Sent by WireMock? + +Starting from version `1.2.0`, we turn on WireMock logging to +`info` and set the WireMock notifier to being verbose. Now you can +exactly know what request was received by the WireMock server and which +matching response definition was picked. + +To turn off this feature, set WireMock logging to `ERROR`, as follows: + +==== +[source,properties,indent=0] +---- +logging.level.com.github.tomakehurst.wiremock=ERROR +---- +==== + +[[how-to-see-registered-stubs]] +== How Can I See What Got Registered in the HTTP Server Stub? + +You can use the `mappingsOutputFolder` property on `@AutoConfigureStubRunner`, `StubRunnerRule`, or +`StubRunnerExtension`to dump all mappings per artifact ID. Also the port at which the given stub server +was started is attached. + +[[how-to-reference-text-from-file]] +== How Can I Reference Text from File? + +In version 1.2.0, we added this ability. You can call a `file(...)` method in the +DSL and provide a path relative to where the contract lies. +If you use YAML, you can use the `bodyFromFile` property. + +[[how-to-generate-pact-from-scc]] +== How Can I Generate Pact, YAML, or X files from Spring Cloud Contract Contracts? + +Spring Cloud Contract comes with a `ToFileContractsTransformer` class that lets you dump +contracts as files for the given `ContractConverter`. It contains a `static void main` +method that lets you execute the transformer as an executable. It takes the following +arguments: + +- argument 1 : `FQN`: Fully qualified name of the `ContractConverter` (for example, `PactContractConverter`). *REQUIRED*. +- argument 2 : `path`: Path where the dumped files should be stored. *OPTIONAL* -- defaults to `target/converted-contracts`. +- argument 3 : `path`: Path were the contracts should be searched for. *OPTIONAL* -- defaults to `src/test/resources/contracts`. + +After executing the transformer, the Spring Cloud Contract files are processed and, +depending on the provided FQN of the `ContractTransformer`, the contracts are transformed +to the required format and dumped to the provided folder. + +The following example shows how to configure Pact integration for both Maven and Gradle: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + org.codehaus.mojo + exec-maven-plugin + 1.6.0 + + + convert-dsl-to-pact + process-test-classes + + test + + org.springframework.cloud.contract.verifier.util.ToFileContractsTransformer + + + + org.springframework.cloud.contract.verifier.spec.pact.PactContractConverter + + ${project.basedir}/target/pacts + + ${project.basedir}/src/test/resources/contracts + + + + + java + + + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +task convertContracts(type: JavaExec) { + main = "org.springframework.cloud.contract.verifier.util.ToFileContractsTransformer" + classpath = sourceSets.test.compileClasspath + args("org.springframework.cloud.contract.verifier.spec.pact.PactContractConverter", + "${project.rootDir}/build/pacts", "${project.rootDir}/src/test/resources/contracts") +} + +test.dependsOn("convertContracts") +---- +==== + +[[how-to-work-with-transitivie]] +== How Can I Work with Transitive Dependencies? + +The Spring Cloud Contract plugins 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 +of different jars, all of them share one pom, as the following listing shows: + +==== +[source,bash,indent=0] +---- +├── producer-0.0.1.BUILD-20160903.075506-1-stubs.jar +├── producer-0.0.1.BUILD-20160903.075506-1-stubs.jar.sha1 +├── producer-0.0.1.BUILD-20160903.075655-2-stubs.jar +├── producer-0.0.1.BUILD-20160903.075655-2-stubs.jar.sha1 +├── producer-0.0.1.BUILD-SNAPSHOT.jar +├── producer-0.0.1.BUILD-SNAPSHOT.pom +├── producer-0.0.1.BUILD-SNAPSHOT-stubs.jar +├── ... +└── ... +---- +==== + +There are three possibilities of working with those dependencies so as not to have any +issues with transitive dependencies: + +* Mark all application dependencies as optional +* Create a separate artifactid for the stubs +* Exclude dependencies on the consumer side + +[[how-to-work-with-transitivie-optional]] +=== How Can I Mark All Application Dependencies as Optional? + +If, in the `producer` application, you mark all of your dependencies as optional, +when you include the `producer` stubs in another application (or when that +dependency gets downloaded by Stub Runner) then, since all of the dependencies are +optional, they do not get downloaded. + +[[how-to-work-with-transitivie-separate]] +=== How can I Create a Separate `artifactid` for the Stubs? + +If you create a separate `artifactid`, you can set it up in whatever way you wish. +For example, you might decide to have no dependencies at all. + +[[how-to-work-with-transitivie-exclude]] +=== How can I Exclude Dependencies on the Consumer Side? + +As a consumer, if you add the stub dependency to your classpath, you can explicitly exclude the unwanted dependencies. + +[[contract-dsl-rest-docs]] +== How can I Generate Spring REST Docs Snippets from the Contracts? + +When you want to include the requests and responses of your API by using Spring REST Docs, +you only need to make some minor changes to your setup if you are using MockMvc and RestAssuredMockMvc. +To do so, include the following dependencies (if you have not already done so): + +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.maven +---- +include::{standalone_restdocs_path}/http-server/pom.xml[tags=dependencies,indent=0] +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.gradle +---- +include::{standalone_restdocs_path}/http-server/build.gradle[tags=dependencies,indent=0] +---- +==== + +Next, you need to make some changes to your base class. The following examples use +`WebAppContext` and the standalone option with RestAssured: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.WebAppContext +---- +include::{standalone_restdocs_path}/http-server/src/test/java/com/example/fraud/FraudBaseWithWebAppSetup.java[tags=base_class,indent=0] +---- + +[source,java,indent=0,subs="verbatim,attributes",role="secondary"] +.Standalone +---- +include::{standalone_restdocs_path}/http-server/src/test/java/com/example/fraud/FraudBaseWithStandaloneSetup.java[tags=base_class,indent=0] +---- +==== + +TIP: You need not specify the output directory for the generated snippets (since version 1.2.0.RELEASE of Spring REST Docs). diff --git a/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc deleted file mode 120000 index 3abe7caccd..0000000000 --- a/docs/src/main/asciidoc/index.adoc +++ /dev/null @@ -1 +0,0 @@ -spring-cloud-contract.adoc \ No newline at end of file diff --git a/docs/src/main/asciidoc/index.htmladoc b/docs/src/main/asciidoc/index.htmladoc new file mode 100644 index 0000000000..21d7b4ffb7 --- /dev/null +++ b/docs/src/main/asciidoc/index.htmladoc @@ -0,0 +1,16 @@ +[[spring-cloud-contract-reference-documentation]] += Spring Cloud Contract Reference Documentation +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 +:docinfo: shared +include::_attributes.adoc[] + +The reference documentation consists of the following sections: + +[horizontal] +<> :: Legal information. +<> :: About the Documentation, Getting Help, First Steps, and more. +<> :: Introducing {project-full-name}, Developing Your First {project-full-name}-based Application +<> :: {project-full-name} usage examples and workflows +<> :: Contract DSL, Messaging, Spring Cloud Contract Stub Runner, and Spring Cloud Contract WireMock. +<> :: Maven Plugin, Gradle Plugin, and Docker. +<> :: Stubs versioning, Pact integration, Debugging, and more. diff --git a/docs/src/main/asciidoc/index.htmlpdfadoc b/docs/src/main/asciidoc/index.htmlpdfadoc new file mode 100644 index 0000000000..7beef6b1ef --- /dev/null +++ b/docs/src/main/asciidoc/index.htmlpdfadoc @@ -0,0 +1,11 @@ +[[spring-cloud-contract-reference-documentation]] += Spring Cloud Contract Reference Documentation +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 +include::_attributes.adoc[] + +include::legal.adoc[leveloffset=+1] +include::documentation-overview.adoc[leveloffset=+1] +include::getting-started.adoc[leveloffset=+1] +include::using.adoc[leveloffset=+1] +include::project-features.adoc[leveloffset=+1] +include::howto.adoc[leveloffset=+1] diff --git a/docs/src/main/asciidoc/index.htmlsingleadoc b/docs/src/main/asciidoc/index.htmlsingleadoc new file mode 100644 index 0000000000..46603b6857 --- /dev/null +++ b/docs/src/main/asciidoc/index.htmlsingleadoc @@ -0,0 +1,12 @@ +[[spring-cloud-contract-reference-documentation]] += Spring Cloud Contract Reference Documentation +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 +:docinfo: shared +include::_attributes.adoc[] + +include::legal.adoc[leveloffset=+1] +include::documentation-overview.adoc[leveloffset=+1] +include::getting-started.adoc[leveloffset=+1] +include::using.adoc[leveloffset=+1] +include::project-features.adoc[leveloffset=+1] +include::howto.adoc[leveloffset=+1] \ No newline at end of file diff --git a/docs/src/main/asciidoc/legal.adoc b/docs/src/main/asciidoc/legal.adoc new file mode 100644 index 0000000000..27a8a3c7f4 --- /dev/null +++ b/docs/src/main/asciidoc/legal.adoc @@ -0,0 +1,11 @@ +[legal] += Legal + +{project-version} + +Copyright © 2012-2019 + +Copies of this document may be made for your own use and for distribution to +others, provided that you do not charge any fee for such copies and further +provided that each copy contains this Copyright Notice, whether distributed in +print or electronically. \ No newline at end of file diff --git a/docs/src/main/asciidoc/links.adoc b/docs/src/main/asciidoc/links.adoc deleted file mode 100644 index e6104db048..0000000000 --- a/docs/src/main/asciidoc/links.adoc +++ /dev/null @@ -1,11 +0,0 @@ -== Links - -The following links may be helpful when working with Spring Cloud Contract: - -* https://github.com/spring-cloud/spring-cloud-contract/[Spring Cloud Contract Github -Repository] -* https://github.com/spring-cloud-samples/spring-cloud-contract-samples/[Spring Cloud -Contract Samples] -* https://gitter.im/spring-cloud/spring-cloud-contract[Spring Cloud Contract Gitter] -* https://www.youtube.com/watch?v=sAAklvxmPmk[Spring Cloud Contract WJUG Presentation by -Marcin Grzejszczak] diff --git a/docs/src/main/asciidoc/maven-project.adoc b/docs/src/main/asciidoc/maven-project.adoc new file mode 100644 index 0000000000..dce7ec1c6e --- /dev/null +++ b/docs/src/main/asciidoc/maven-project.adoc @@ -0,0 +1,564 @@ += Maven Project +include::_attributes.adoc[] + +To learn how to set up the Maven project for Spring Cloud Contract Verifier, read the +following sections: + +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + +[[maven-add-plugin]] +== Adding the Maven Plugin + +Add the Spring Cloud Contract BOM in a fashion similar to the following: + +==== +[source,xml,indent=0] +---- +include::{standalone_samples_path}/http-server/pom.xml[tags=contract_bom,indent=0] +---- +==== + +Next, add the `Spring Cloud Contract Verifier` Maven plugin, as follows: + +==== +[source,xml,indent=0] +---- +include::{standalone_samples_path}/http-server/pom.xml[tags=contract_maven_plugin,indent=0] +---- +==== + +You can read more in the +spring-cloud-contract-maven-plugin/index.html[Spring +Cloud Contract Maven Plugin Documentation]. + +[[maven-rest-assured]] +== Maven and Rest Assured 2.0 + +By default, Rest Assured 3.x is added to the classpath. However, you can use Rest +Assured 2.x by adding it to the plugins classpath, as follows: + +==== +[source,groovy,indent=0] +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + com.example + + + + org.springframework.cloud + spring-cloud-contract-verifier + ${spring-cloud-contract.version} + + + com.jayway.restassured + rest-assured + 2.5.0 + compile + + + com.jayway.restassured + spring-mock-mvc + 2.5.0 + compile + + + + + + + + + com.jayway.restassured + rest-assured + 2.5.0 + test + + + com.jayway.restassured + spring-mock-mvc + 2.5.0 + test + + +---- +==== + +That way, the plugin automatically sees that Rest Assured 2.x is present on the classpath +and modifies the imports accordingly. + +[[maven-snapshot-versions]] +== Using Snapshot and Milestone Versions for Maven + +To use Snapshot and Milestone versions, you have to add the following section to your +`pom.xml`: + +==== +[source,xml,indent=0] +---- +include::{standalone_samples_path}/http-server/pom.xml[tags=repos,indent=0] +---- +==== + +[[maven-add-stubs]] +== Adding stubs + +By default, Spring Cloud Contract Verifier looks for stubs in the +`src/test/resources/contracts` directory. The directory containing stub definitions is +treated as a class name, and each stub definition is treated as a single test. We assume +that it contains at least one directory to be used as the test class name. If there is more +than one level of nested directories, all except the last one is used as the package name. +Consider the following structure: + +==== +[source,groovy,indent=0] +---- +src/test/resources/contracts/myservice/shouldCreateUser.groovy +src/test/resources/contracts/myservice/shouldReturnUser.groovy +---- +==== + +Given that structure, Spring Cloud Contract Verifier creates a test class named +`defaultBasePackage.MyService` with two methods: + +* `shouldCreateUser()` +* `shouldReturnUser()` + +[[maven-run-plugin]] +== Run plugin + +The `generateTests` plugin goal is assigned to be invoked in the phase called +`generate-test-sources`. If you want it to be part of your build process, you need not do +anything. If you want only to generate tests, invoke the `generateTests` goal. + +[[maven-configure-plugin]] +== Configure plugin + +To change the default configuration, you can add a `configuration` section to the plugin +definition or the `execution` definition, as follows: + +==== +[source,xml,indent=0] +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + + + + convert + generateStubs + generateTests + + + + + org.springframework.cloud.verifier.twitter.place + org.springframework.cloud.verifier.twitter.place.BaseMockMvcSpec + + +---- +==== + +[[maven-configuration-options]] +== Configuration Options + +* `testMode`: Defines the mode for acceptance tests. By default, the mode is `MockMvc`, +which is based on Spring's MockMvc. You can also change it to `WebTestClient`, `JaxRsClient`, or +`Explicit` (for real HTTP calls). +* `basePackageForTests`: Specifies the base package for all generated tests. If not set, +the value is picked from the package of `baseClassForTests` and from `packageWithBaseClasses`. +If neither of these values are set, the value is set to +`org.springframework.cloud.contract.verifier.tests`. +* `ruleClassForTests`: Specifies a rule that should be added to the generated test +classes. +* `baseClassForTests`: Creates a base class for all generated tests. By default, if you +use Spock classes, the class is `spock.lang.Specification`. +* contractsDirectory: Specifies a directory that contains contracts written with the +Groovyn DSL. The default directory is `/src/test/resources/contracts`. +* `generatedTestSourcesDir`: Specifies the test source directory where tests generated +from the Groovy DSL should be placed. By default, its value is +`$buildDir/generated-test-sources/contracts`. +* `generatedTestResourcesDir`: Specifies the test resource directory for resources used by the generated tests. +* `testFramework`: 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. +* `packageWithBaseClasses`: Defines a package where all the base classes reside. This +setting takes precedence over `baseClassForTests`. The convention is such that, if you +have a contract under (for example) `src/test/resources/contract/foo/bar/baz/` and set +the value of the `packageWithBaseClasses` property to `com.example.base`, Spring +Cloud Contract Verifier assumes that there is a `BarBazBase` class under the +`com.example.base` package. In other words, the system takes the last two parts of the +package, if they exist, and forms a class with `Base` as a suffix. +* `baseClassMappings`: Specifies a list of base class mappings that provide +`contractPackageRegex` (which is checked against the package where the contract is +located) and `baseClassFQN`( which maps to the fully qualified name of the base class for +the matched contract). For example, if you have a contract under +`src/test/resources/contract/foo/bar/baz/` and map the +`.* -> com.example.base.BaseClass` property, the test class generated from these contracts +extends `com.example.base.BaseClass`. This setting takes precedence over +`packageWithBaseClasses` and `baseClassForTests`. +* `contractsProperties`: A map that contains properties to be passed to Spring Cloud Contract +components. Those properties might be used by (for example) built-in or custom Stub Downloaders. + +If you want to download your contract definitions from a Maven repository, you can use +the following options: + +* `contractDependency`: The contract dependency that contains all the packaged contracts. +* `contractsPath`: The path to the concrete contracts in the JAR with packaged contracts. +Defaults to `groupid/artifactid` where `gropuid` is slash separated. +* `contractsMode`: Picks the mode in which stubs are found and registered. +* `deleteStubsAfterTest`: If set to `false` will not remove any downloaded +contracts from temporary directories. +* `contractsRepositoryUrl`: URL to a repository with the artifacts that have contracts. If it is not provided, +use the current Maven ones. +* `contractsRepositoryUsername`: The user name to be used to connect to the repo with contracts. +* `contractsRepositoryPassword`: The password to be used to connect to the repo with contracts. +* `contractsRepositoryProxyHost`: The proxy host to be used to connect to the repo with contracts. +* `contractsRepositoryProxyPort`: The proxy port to be used to connect to the repo with contracts. + +We cache only non-snapshot, explicitly provided versions (for example +`+` or `1.0.0.BUILD-SNAPSHOT` do not get cached). By default, this feature is turned on. + +The following list describes experimental features that you can turn on in the plugin: + +* `convertToYaml`: Converts all DSLs to the declarative YAML format. This can be extremely useful when you use external libraries in your Groovy DSLs. By turning this feature on (by setting it to `true`) you need not add the library dependency on the consumer side. +* `assertJsonSize`: You can check the size of JSON arrays in the generated tests. This feature is disabled by default. + +[[maven-single-base]] +== Single Base Class for All Tests + +When using Spring Cloud Contract Verifier in the 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. The following example shows how to do so: + +==== +[source,groovy,indent=0] +---- +package org.mycompany.tests + +import org.mycompany.ExampleSpringController +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc +import spock.lang.Specification + +class MvcSpec extends Specification { + def setup() { + RestAssuredMockMvc.standaloneSetup(new ExampleSpringController()) + } +} +---- +==== + +You can also setup the whole context if necessary, as the following example shows: + +==== +[source,java,indent=0] +---- +import io.restassured.module.mockmvc.RestAssuredMockMvc; +import org.junit.Before; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.web.context.WebApplicationContext; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, classes = SomeConfig.class, properties="some=property") +public abstract class BaseTestClass { + + @Autowired + WebApplicationContext context; + + @Before + public void setup() { + RestAssuredMockMvc.webAppContextSetup(this.context); + } +} +---- +==== + +If you use `EXPLICIT` mode, you can use a base class to initialize the whole tested app, +similar to what you might do in regular integration tests. The following example shows +how to do so: + +==== +[source,java,indent=0] +---- +import io.restassured.RestAssured; +import org.junit.Before; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.web.server.LocalServerPort +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.web.context.WebApplicationContext; + +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, classes = SomeConfig.class, properties="some=property") +public abstract class BaseTestClass { + + @LocalServerPort + int port; + + @Before + public void setup() { + RestAssured.baseURI = "http://localhost:" + this.port; + } +} +---- +==== + +If you use the `JAXRSCLIENT` mode, this base class should also contain a `protected WebTarget webTarget` field. Right +now, the only way to test the JAX-RS API is to start a web server. + +[[maven-different-base]] +== Using Different Base Classes for Contracts + +If your base classes differ between contracts, you can tell the Spring Cloud Contract +plugin which class should get extended by the autogenerated tests. You have two options: + +* Follow a convention by providing a value for `packageWithBaseClasses` +* Provide explicit mapping with `baseClassMappings` + +=== By Convention + +The convention is such that if you have a contract under (for example) +`src/test/resources/contract/foo/bar/baz/` and set the value of the +`packageWithBaseClasses` property to `com.example.base`, then Spring Cloud Contract +Verifier assumes that there is a `BarBazBase` class under the `com.example.base` package. +In other words, the system takes the last two parts of the package, if they exist, and +forms a class with a `Base` suffix. This rule takes precedence over `baseClassForTests`. +The following example shows how it works in the `contracts` closure: + +==== +[source,xml,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-maven-plugin/src/test/projects/basic-generated-baseclass/pom.xml[tags=convention,indent=0] +---- +==== + +=== By Mapping + +You can manually map a regular expression of the contract's package to the fully qualified +name of the base class for the matched contract. You have to provide a list called +`baseClassMappings` that consists of `baseClassMapping` objects that each take a +`contractPackageRegex` to `baseClassFQN` mapping. Consider the following example: + +==== +[source,xml,indent=0] +---- +include::{plugins_path}/spring-cloud-contract-maven-plugin/src/test/projects/basic-baseclass-from-mappings/pom.xml[tags=mapping,indent=0] +---- +==== + +Assume that you have contracts under these two locations: +* `src/test/resources/contract/com/` +* `src/test/resources/contract/foo/` + +By providing the `baseClassForTests`, we have a fallback in case mapping did not succeed. +(You can also provide the `packageWithBaseClasses` as a fallback.) That way, the tests +generated from `src/test/resources/contract/com/` contracts extend the +`com.example.ComBase`, whereas the rest of the tests extend `com.example.FooBase`. + +[[maven-invoking-generated-tests]] +== Invoking Generated Tests + +The Spring Cloud Contract Maven Plugin generates verification code in a directory called +`/generated-test-sources/contractVerifier` and attaches this directory to `testCompile` +goal. + +For Groovy Spock code, you can use the following: + +==== +[source,xml,indent=0] +---- + + org.codehaus.gmavenplus + gmavenplus-plugin + 1.5 + + + + testCompile + + + + + + + ${project.basedir}/src/test/groovy + + **/*.groovy + + + + ${project.build.directory}/generated-test-sources/contractVerifier + + **/*.groovy + + + + + +---- +==== + +To ensure that the provider side is compliant with defined contracts, you need to invoke +`mvn generateTest test`. + +[[maven-pushing-stubs-to-scm]] +== Pushing Stubs to SCM + +If you use the SCM (Source Control Management) repository to keep the contracts and +stubs, you might want to automate the step of pushing stubs to +the repository. To do that, you can add the `pushStubsToScm` +goal. The following example shows how to do so: + +==== +[source,xml,indent=0] +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + + + + git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git + + + + ${project.groupId} + ${project.artifactId} + ${project.version} + + + + REMOTE + + + + package + + + pushStubsToScm + + + + +---- +==== + +Under <>, you can find all possible +configuration options that you can pass through +the `` map, a system property, +or an environment variable. + +[[maven-sts]] +== Maven Plugin and STS + +The following image shows an exception that you may see when you use STS: + +image::{github-raw}/docs/src/main/asciidoc/images/sts_exception.png[STS Exception] + +When you click on the error marker you should see something like the following: + +==== +[source,bash] +---- + plugin:1.1.0.M1:convert:default-convert:process-test-resources) org.apache.maven.plugin.PluginExecutionException: Execution default-convert of goal org.springframework.cloud:spring- + cloud-contract-maven-plugin:1.1.0.M1:convert failed. at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:145) at + org.eclipse.m2e.core.internal.embedder.MavenImpl.execute(MavenImpl.java:331) at org.eclipse.m2e.core.internal.embedder.MavenImpl$11.call(MavenImpl.java:1362) at +... + org.eclipse.core.internal.jobs.Worker.run(Worker.java:55) Caused by: java.lang.NullPointerException at + org.eclipse.m2e.core.internal.builder.plexusbuildapi.EclipseIncrementalBuildContext.hasDelta(EclipseIncrementalBuildContext.java:53) at + org.sonatype.plexus.build.incremental.ThreadBuildContext.hasDelta(ThreadBuildContext.java:59) at +---- +==== + +In order to fix this issue, provide the following section in your `pom.xml`: + +==== +[source,xml] +---- + + + + + + org.eclipse.m2e + lifecycle-mapping + 1.0.0 + + + + + + org.springframework.cloud + spring-cloud-contract-maven-plugin + [1.0,) + + convert + + + + + + + + + + + + + +---- +==== + +== Maven Plugin with Spock Tests + +You can select the http://spockframework.org/[Spock Framework] for creating and running the auto-generated contract +verification tests with both Maven and Gradle. However, whereas using Gradle is straightforward, +in Maven, you will require some additional setup in order to make the tests compile and execute properly. + +First of all, you must use a plugin, such as the https://github.com/groovy/GMavenPlus[GMavenPlus] plugin, +to add Groovy to your project. In GMavenPlus plugin, you 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. +The following example shows how to do so: + +==== +[source,xml,indent=0] +---- +include::{samples_url}/producer_with_spock/pom.xml[tags=gmavenplus-setup,indent=0] +---- +==== + +If you uphold the Spock convention of ending the test class names with `Spec`, you also need to adjust your Maven +Surefire plugin setup, as the following example shows: + +==== +[source,xml,indent=0] +---- +include::{samples_url}/producer_with_spock/pom.xml[tags=spock-surefire-setup,indent=0] +---- +==== diff --git a/docs/src/main/asciidoc/migrations.adoc b/docs/src/main/asciidoc/migrations.adoc deleted file mode 100644 index b4c8954058..0000000000 --- a/docs/src/main/asciidoc/migrations.adoc +++ /dev/null @@ -1,180 +0,0 @@ -:core_path: ../../../.. -:doc_samples: {core_path}/samples/wiremock-jetty -:wiremock_tests: {core_path}/spring-cloud-contract-wiremock - -== Migrations - -TIP: For up to date migration guides please visit -the project's https://github.com/spring-cloud/spring-cloud-contract/wiki/[wiki page]. - -This section covers migrating from one version of Spring Cloud Contract Verifier to the -next version. It covers the following versions upgrade paths: - -[[cloud-verifier-1.0-1.1]] -=== 1.0.x -> 1.1.x - -This section covers upgrading from version 1.0 to version 1.1. - -==== New structure of generated stubs - -In `1.1.x` we have introduced a change to the structure of generated stubs. If you have -been using the `@AutoConfigureWireMock` notation to use the stubs from the classpath, -it no longer works. The following example shows how the `@AutoConfigureWireMock` notation -used to work: - -[source,java] ----- -@AutoConfigureWireMock(stubs = "classpath:/customer-stubs/mappings", port = 8084) ----- - -You must either change the location of the stubs to: -`classpath:.../META-INF/groupId/artifactId/version/mappings` or use the new -classpath-based `@AutoConfigureStubRunner`, as shown in the following example: - -[source,java] ----- -@AutoConfigureWireMock(stubs = "classpath:customer-stubs/META-INF/travel.components/customer-contract/1.0.2-SNAPSHOT/mappings/", port = 8084) ----- - -If you do not want to use `@AutoConfigureStubRunner` and you want to remain with the old -structure, set your plugin tasks accordingly. The following example would work for the -structure presented in the previous snippet. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - - - - true - - - - - - - - - org.apache.maven.plugins - maven-assembly-plugin - - - stub - prepare-package - - single - - false - - true - ${basedir}/src/assembly/stub.xml - - - - - - - - - - - - stubs - - jar - - false - - - ${project.build.directory}/snippets/stubs - customer-stubs/mappings - - **/* - - - - ${basedir}/src/test/resources/contracts - customer-stubs/contracts - - **/*.groovy - - - - - - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -task copyStubs(type: Copy, dependsOn: 'generateWireMockClientStubs') { -// Preserve directory structure from 1.0.X of spring-cloud-contract - from "${project.buildDir}/resources/main/customer-stubs/META-INF/${project.group}/${project.name}/${project.version}" - into "${project.buildDir}/resources/main/customer-stubs" -} ----- - -[[cloud-verifier-1.1-1.2]] -=== 1.1.x -> 1.2.x - -This section covers upgrading from version 1.1 to version 1.2. - -==== Custom `HttpServerStub` - -`HttpServerStub` includes a method that was not in version 1.1. The method is -`String registeredMappings()` If you have classes that implement `HttpServerStub`, you -now have to implement the `registeredMappings()` method. It should return a `String` -representing all mappings available in a single `HttpServerStub`. - -See https://github.com/spring-cloud/spring-cloud-contract/issues/355[issue 355] for more -detail. - -==== New packages for generated tests - -The flow for setting the generated tests package name will look like this: - -* Set `basePackageForTests` -* If `basePackageForTests` was not set, pick the package from `baseClassForTests` -* If `baseClassForTests` was not set, pick `packageWithBaseClasses` -* If nothing got set, pick the default value: -`org.springframework.cloud.contract.verifier.tests` - -See https://github.com/spring-cloud/spring-cloud-contract/issues/260[issue 260] for more -detail. - -==== New Methods in TemplateProcessor - -In order to add support for `fromRequest.path`, the following methods had to be added to the -`TemplateProcessor` interface: - -* `path()` -* `path(int index)` - -See https://github.com/spring-cloud/spring-cloud-contract/issues/388[issue 388] for more -detail. - -==== RestAssured 3.0 - -Rest Assured, used in the generated test classes, got bumped to `3.0`. If -you manually set versions of Spring Cloud Contract and the release train -you might see the following exception: - -[source,bash] ----- -Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.1:testCompile (default-testCompile) on project some-project: Compilation failure: Compilation failure: -[ERROR] /some/path/SomeClass.java:[4,39] package com.jayway.restassured.response does not exist ----- - -This exception will occur due to the fact that the tests got generated with -an old version of plugin and at test execution time you have an incompatible -version of the release train (and vice versa). - -Done via https://github.com/spring-cloud/spring-cloud-contract/issues/267[issue 267] - -[[cloud-verifier-1.2-2.0]] -=== 1.2.x -> 2.0.x \ No newline at end of file diff --git a/docs/src/main/asciidoc/project-features.adoc b/docs/src/main/asciidoc/project-features.adoc new file mode 100644 index 0000000000..6b30c36718 --- /dev/null +++ b/docs/src/main/asciidoc/project-features.adoc @@ -0,0 +1,40 @@ +[[features]] += Spring Cloud Contract Features +include::_attributes.adoc[] + +This section dives into the details of {project-full-name}. Here you can learn about the key +features that you may want to use and customize. If you have not already done so, you +might want to read the "<>" and +"<>" sections, so that you have a good grounding of the +basics. + +include::_project-features-contract.adoc[] + +include::_project-features-flows.adoc[] + +include::_project-features-messaging.adoc[] + +include::_project-features-stubrunner.adoc[] + +include::_project-features-wiremock.adoc[] + +[[features-build-tools]] +== Build Tools Integration + +You can run test generation and stub execution in various ways. The most common ones are +as follows: + +* link:maven-project.html[Maven] +* link:gradle-project.html[Gradle] +* link:docker-project.html[Docker] + +[[features-whats-next]] +== What to Read Next + +If you want to learn more about any of the classes discussed in this section, you can browse the +{github-code}[source code directly]. If you have specific questions, see the +<> section. + +If you are comfortable with {project-full-name}'s core features, you can continue on and read +about +<>. diff --git a/docs/src/main/asciidoc/sagan-boot.adoc b/docs/src/main/asciidoc/sagan-boot.adoc index b1f37c3c30..98fc275c51 100644 --- a/docs/src/main/asciidoc/sagan-boot.adoc +++ b/docs/src/main/asciidoc/sagan-boot.adoc @@ -1,8 +1,15 @@ -Add Sleuth to your classpath: +== Adding Sleuth to Your Classpath: -Maven +This section details how to add Sleuth to your class path for both Maven and Gradle -```xml +=== Maven + +To add Sleuth to your classpath with Maven, add the following elements +to your `pom.xml` file: + +==== +[source,xml] +---- @@ -20,11 +27,17 @@ Maven spring-cloud-starter-sleuth -``` +---- +==== -Gradle +=== Gradle -```groovy +To add Sleuth to your classpath with Gradle, add the following +to your `build.gradle` file: + +==== +[src,groovy] +---- buildscript { dependencies { classpath "io.spring.gradle:dependency-management-plugin:0.5.2.RELEASE" @@ -41,11 +54,15 @@ dependencyManagement { dependencies { compile 'org.springframework.cloud:spring-cloud-starter-sleuth' } -``` +---- +==== -As long as Spring Cloud Sleuth is on the classpath any Spring Boot application will generate trace data: +As long as Spring Cloud Sleuth is on the classpath, any Spring Boot application can +generate trace data. The following example shows how to do so: -```java +==== +[src,java] +---- @SpringBootApplication @RestController public class Application { @@ -63,12 +80,21 @@ public class Application { } } -``` +---- +==== -Run this app and then hit the home page. You will see traceId and spanId populated in the logs. If this app calls out to another one (e.g. with `RestTemplate`) it will send the trace data in headers and if the receiver is another Sleuth app you will see the trace continue there. +Now you can run this application and visit the home page. In the logs, you can see +`traceId` and `spanId` populated. If this application calls out to another one (for +example, with `RestTemplate`), it sends the trace data in headers, and, if the receiver is +another Sleuth application, you can see the trace continue there. -IMPORTANT: instead of logging the request in the handler explicitly, you could set `logging.level.org.springframework.web.servlet.DispatcherServlet=DEBUG` +IMPORTANT: instead of logging the request in the handler explicitly, you could set +`logging.level.org.springframework.web.servlet.DispatcherServlet=DEBUG` -IMPORTANT: If you use Zipkin, configure the probability of spans exported by setting (for `2.0.x`) `spring.sleuth.sampler.probability` or (up till `2.0.x`)`spring.sleuth.sampler.percentage` (default: 0.1, which is 10 percent). Otherwise, you might think that Sleuth is not working because it omits some spans. +IMPORTANT: If you use Zipkin, you can configure the probability of spans being exported by +setting (for `2.0.x`) `spring.sleuth.sampler.probability` or (up till `2.0.x`) +`spring.sleuth.sampler.percentage` (default: 0.1, which is 10 percent). Otherwise, you +might think that Sleuth is not working because it omits some spans. -IMPORTANT: Set `spring.application.name=bar` (for instance) to see the service name as well as the trace and span ids. \ No newline at end of file +IMPORTANT: Set `spring.application.name=bar` (for instance) to see the service name as +well as the trace and span IDs. diff --git a/docs/src/main/asciidoc/sagan-index.adoc b/docs/src/main/asciidoc/sagan-index.adoc index 2c4b64d55e..73f429223c 100644 --- a/docs/src/main/asciidoc/sagan-index.adoc +++ b/docs/src/main/asciidoc/sagan-index.adoc @@ -1,12 +1,30 @@ -Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud, borrowing heavily from https://research.google.com/pubs/pub36356.html[Dapper], https://github.com/openzipkin/zipkin[Zipkin] and HTrace. For most users Sleuth should be invisible, and all your interactions with external systems should be instrumented automatically. You can capture data simply in logs, or by sending it to a remote collector service. +Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud, borrowing +heavily from https://research.google.com/pubs/pub36356.html[Dapper], +https://github.com/openzipkin/zipkin[Zipkin], and HTrace. For most users, Sleuth should be +invisible, and all your interactions with external systems should be instrumented +automatically. You can capture data in logs or by sending it to a remote collector service. ## Features -A Span is the basic unit of work. For example, sending an RPC is a new span, as is sending a response to an RPC. Span’s are identified by a unique 64-bit ID for the span and another 64-bit ID for the trace the span is a part of. Spans also have other data, such as descriptions, key-value annotations, the ID of the span that caused them, and process ID’s (normally IP address). Spans are started and stopped, and they keep track of their timing information. Once you create a span, you must stop it at some point in the future. A set of spans forming a tree-like structure called a Trace. For example, if you are running a distributed big-data store, a trace might be formed by a put request. +A span is the basic unit of work. For example, sending an RPC is a new span, as is sending +a response to an RPC. Spans are identified by a unique 64-bit ID for the span and another +64-bit ID for the trace of which the span is a part. Spans also have other data, such as +descriptions, key-value annotations, the ID of the span that caused them, and process IDs +(normally IP addresses). Spans are started and stopped, and they keep track of their +timing information. Once you create a span, you must stop it at some point in the future. +A set of spans (which form a tree-like structure) is called a trace. For example, if you +run a distributed big-data store, a trace might be formed by a `PUT` request. -Spring Cloud Sleuth features: +Spring Cloud Sleuth: -* Adds trace and span ids to the Slf4J MDC, so you can extract all the logs from a given trace or span in a log aggregator. -* Provides an abstraction over common distributed tracing data models: traces, spans (forming a DAG), annotations, key-value annotations. Loosely based on HTrace, but Zipkin (Dapper) compatible. -* Instruments common ingress and egress points from Spring applications (servlet filter, rest template, scheduled actions, message channels, zuul filters, feign client). -* If `spring-cloud-sleuth-zipkin` is available then the app will generate and collect Zipkin-compatible traces via HTTP. By default it sends them to a Zipkin collector service on localhost (port 9411). Configure the location of the service using `spring.zipkin.baseUrl`. \ No newline at end of file +* Adds trace and span IDs to the Slf4J MDC so that you can extract all the logs from a +given trace or span in a log aggregator. +* Provides an abstraction over common distributed tracing data models: traces, spans +(forming a DAG), annotations, and key-value annotations. This is loosely based on HTrace +but is Zipkin (Dapper) compatible. +* Instruments common ingress and egress points from Spring applications (servlet filter, +rest template, scheduled actions, message channels, zuul filters, and the feign client). +* If `spring-cloud-sleuth-zipkin` is available, the app generates and collects +Zipkin-compatible traces over HTTP. By default, it sends them to a Zipkin collector +service on localhost (port 9411). You can configure the location of the service using +`spring.zipkin.baseUrl`. diff --git a/docs/src/main/asciidoc/spring-cloud-contract.adoc b/docs/src/main/asciidoc/spring-cloud-contract.adoc deleted file mode 100644 index a0b79b8813..0000000000 --- a/docs/src/main/asciidoc/spring-cloud-contract.adoc +++ /dev/null @@ -1,31 +0,0 @@ -:toc: left -:toclevels: 3 -:nofooter: -:source-highlighter: prettify -:numbered: -:icons: font -:sectlinks: true -:branch: master - -= Spring Cloud Contract - -_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_ - -{spring-cloud-version} - -== Spring Cloud Contract - -You need confidence when pushing new features to a new application or service in a -distributed system. This project provides support for Consumer Driven Contracts and -service schemas in Spring applications (for both HTTP and message-based interactions), -covering a range of options for writing tests, publishing them as assets, and asserting -that a contract is kept by producers and consumers. - -include::spring-cloud-contract-verifier.adoc[] - -include::spring-cloud-wiremock.adoc[] - -include::migrations.adoc[] - -include::links.adoc[] diff --git a/docs/src/main/asciidoc/spring-cloud-wiremock.adoc b/docs/src/main/asciidoc/spring-cloud-wiremock.adoc deleted file mode 100644 index 9ad7e9b200..0000000000 --- a/docs/src/main/asciidoc/spring-cloud-wiremock.adoc +++ /dev/null @@ -1,399 +0,0 @@ -:core_path: ../../.. -:doc_samples: {core_path}/samples/wiremock-jetty -:wiremock_tests: {core_path}/spring-cloud-contract-wiremock - -== Spring Cloud Contract WireMock - -The Spring Cloud Contract WireMock modules let you use https://github.com/tomakehurst/wiremock[WireMock] in a -Spring Boot application. Check out the -https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples[samples] -for more details. - -If you have a Spring Boot application that uses Tomcat as an embedded server (which is -the default with `spring-boot-starter-web`), you can add -`spring-cloud-starter-contract-stub-runner` to your classpath and add `@AutoConfigureWireMock` in -order to be able to use Wiremock in your tests. Wiremock runs as a stub server and you -can register stub behavior using a Java API or via static JSON declarations as part of -your test. The following code shows an example: - -[source,java,indent=0] ----- -include::{doc_samples}/src/test/java/com/example/WiremockForDocsTests.java[tags=wiremock_test1] -include::{doc_samples}/src/test/java/com/example/WiremockForDocsTests.java[tags=wiremock_test2] ----- - -To start the stub server on a different port use (for example), -`@AutoConfigureWireMock(port=9999)`. For a random port, use a value of `0`. The stub -server port can be bound in the test application context with the "wiremock.server.port" -property. Using `@AutoConfigureWireMock` adds a bean of type `WiremockConfiguration` to -your test application context, where it will be cached in between methods and classes -having the same context, the same as for Spring integration tests. Also you can inject a bean of type `WireMockServer` into your test. - -=== Registering Stubs Automatically - -If you use `@AutoConfigureWireMock`, it registers WireMock JSON stubs from the file -system or classpath (by default, from `file:src/test/resources/mappings`). You can -customize the locations using the `stubs` attribute in the annotation, which can be an -Ant-style resource pattern or a directory. In the case of a directory, `**/*.json` is -appended. The following code shows an example: - ----- -@RunWith(SpringRunner.class) -@SpringBootTest -@AutoConfigureWireMock(stubs="classpath:/stubs") -public class WiremockImportApplicationTests { - - @Autowired - private Service service; - - @Test - public void contextLoads() throws Exception { - assertThat(this.service.go()).isEqualTo("Hello World!"); - } - -} ----- - -NOTE: Actually, WireMock always loads mappings from `src/test/resources/mappings` *as -well as* the custom locations in the stubs attribute. To change this behavior, you can -also specify a files root as described in the next section of this document. - -If you're using Spring Cloud Contract's default stub jars, then your -stubs are stored under `/META-INF/group-id/artifact-id/versions/mappings/` folder. If you want to register all stubs from that location, from all embedded JARs, then it's enough to use the following syntax. - -[source,java,indent=0] ----- -include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMockFilesApplicationWithUrlResourceTests.java[tags=load_all_stubs] ----- - -=== Using Files to Specify the Stub Bodies - -WireMock can read response bodies from files on the classpath or the file system. In that -case, you can see in the JSON DSL that the response has a `bodyFileName` instead of a -(literal) `body`. The files are resolved relative to a root directory (by default, -`src/test/resources/\__files`). To customize this location you can set the `files` -attribute in the `@AutoConfigureWireMock` annotation to the location of the parent -directory (in other words, `__files` is a subdirectory). You can use Spring resource -notation to refer to `file:...` or `classpath:...` locations. Generic URLs are not -supported. A list of values can be given, in which case WireMock resolves the first file -that exists when it needs to find a response body. - -NOTE: When you configure the `files` root, it also affects the -automatic loading of stubs, because they come from the root location -in a subdirectory called "mappings". The value of `files` has no -effect on the stubs loaded explicitly from the `stubs` attribute. - -=== Alternative: Using JUnit Rules - -For a more conventional WireMock experience, you can use JUnit `@Rules` to start and stop -the server. To do so, use the `WireMockSpring` convenience class to obtain an `Options` -instance, as shown in the following example: - -[source,java,indent=0] ----- -include::{doc_samples}/src/test/java/com/example/WiremockForDocsClassRuleTests.java[tags=wiremock_test1] -include::{doc_samples}/src/test/java/com/example/WiremockForDocsClassRuleTests.java[tags=wiremock_test2] ----- - -The `@ClassRule` means that the server shuts down after all the methods in this class -have been run. - -=== Relaxed SSL Validation for Rest Template - -WireMock lets you stub a "secure" server with an "https" URL protocol. If your -application wants to contact that stub server in an integration test, it will find that -the SSL certificates are not valid (the usual problem with self-installed certificates). -The best option is often to re-configure the client to use "http". If that's not an -option, you can ask Spring to configure an HTTP client that ignores SSL validation errors -(do so only for tests, of course). - -To make this work with minimum fuss, you need to be using the Spring Boot -`RestTemplateBuilder` in your app, as shown in the following example: - -[source,java,indent=0] ----- - @Bean - public RestTemplate restTemplate(RestTemplateBuilder builder) { - return builder.build(); - } ----- - -You need `RestTemplateBuilder` because the builder is passed through callbacks to -initialize it, so the SSL validation can be set up in the client at that point. This -happens automatically in your test if you are using the `@AutoConfigureWireMock` -annotation or the stub runner. If you use the JUnit `@Rule` approach, you need to add the -`@AutoConfigureHttpClient` annotation as well, as shown in the following example: - -[source,java,indent=0] ----- -@RunWith(SpringRunner.class) -@SpringBootTest("app.baseUrl=https://localhost:6443") -@AutoConfigureHttpClient -public class WiremockHttpsServerApplicationTests { - - @ClassRule - public static WireMockClassRule wiremock = new WireMockClassRule( - WireMockSpring.options().httpsPort(6443)); -... -} ----- - -If you are using `spring-boot-starter-test`, you have the Apache HTTP client on the -classpath and it is selected by the `RestTemplateBuilder` and configured to ignore SSL -errors. If you use the default `java.net` client, you do not need the annotation (but it -won't do any harm). There is no support currently for other clients, but it may be added -in future releases. - -To disable the custom `RestTemplateBuilder`, set the `wiremock.rest-template-ssl-enabled` -property to `false`. - -=== WireMock and Spring MVC Mocks - -Spring Cloud Contract provides a convenience class that can load JSON WireMock stubs into -a Spring `MockRestServiceServer`. The following code shows an example: - -[source,java,indent=0] ----- -include::{doc_samples}/src/test/java/com/example/WiremockForDocsMockServerApplicationTests.java[tags=wiremock_test] ----- - -The `baseUrl` value is prepended to all mock calls, and the `stubs()` method takes a stub -path resource pattern as an argument. In the preceding example, the stub defined at -`/stubs/resource.json` is loaded into the mock server. If the `RestTemplate` is asked to -visit `https://example.org/`, it gets the responses as being declared at that URL. More -than one stub pattern can be specified, and each one can be a directory (for a recursive -list of all ".json"), a fixed filename (as in the example above), or an Ant-style -pattern. The JSON format is the normal WireMock format, which you can read about in the -https://wiremock.org/docs/stubbing/[WireMock website]. - -Currently, the Spring Cloud Contract Verifier supports Tomcat, Jetty, and Undertow as -Spring Boot embedded servers, and Wiremock itself has "native" support for a particular -version of Jetty (currently 9.2). To use the native Jetty, you need to add the native -Wiremock dependencies and exclude the Spring Boot container (if there is one). - -=== Customization of WireMock configuration - -You can register a bean of `org.springframework.cloud.contract.wiremock.WireMockConfigurationCustomizer` type -in order to customize the WireMock configuration (e.g. add custom transformers). -Example: - -[source,java,indent=0] ----- -include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMockConfigurationCustomizerTests.java[tags=customizer_1] -// perform your customization here -include::{wiremock_tests}/src/test/java/org/springframework/cloud/contract/wiremock/AutoConfigureWireMockConfigurationCustomizerTests.java[tags=customizer_2] ----- - -=== Generating Stubs using REST Docs - -https://projects.spring.io/spring-restdocs[Spring REST Docs] can be used to generate -documentation (for example in Asciidoctor format) for an HTTP API with Spring MockMvc -or `WebTestClient` or Rest Assured. At the same time that you generate documentation for your API, you can also -generate WireMock stubs by using Spring Cloud Contract WireMock. To do so, write your -normal REST Docs test cases and use `@AutoConfigureRestDocs` to have stubs be -automatically generated in the REST Docs output directory. The following code shows an -example using `MockMvc`: - -[source,java,indent=0] ----- -@RunWith(SpringRunner.class) -@SpringBootTest -@AutoConfigureRestDocs(outputDir = "target/snippets") -@AutoConfigureMockMvc -public class ApplicationTests { - - @Autowired - private MockMvc mockMvc; - - @Test - public void contextLoads() throws Exception { - mockMvc.perform(get("/resource")) - .andExpect(content().string("Hello World")) - .andDo(document("resource")); - } -} ----- - -This test generates a WireMock stub at "target/snippets/stubs/resource.json". It matches -all GET requests to the "/resource" path. The same example with `WebTestClient` (used -for testing Spring WebFlux applications) would look like this: - -[source,java,indent=0] ----- -@RunWith(SpringRunner.class) -@SpringBootTest -@AutoConfigureRestDocs(outputDir = "target/snippets") -@AutoConfigureWebTestClient -public class ApplicationTests { - - @Autowired - private WebTestClient client; - - @Test - public void contextLoads() throws Exception { - client.get().uri("/resource").exchange() - .expectBody(String.class).isEqualTo("Hello World") - .consumeWith(document("resource")); - } -} ----- - -Without any additional configuration, these tests create a stub with a request matcher -for the HTTP method and all headers except "host" and "content-length". To match the -request more precisely (for example, to match the body of a POST or PUT), we need to -explicitly create a request matcher. Doing so has two effects: - -* Creating a stub that matches only in the way you specify. -* Asserting that the request in the test case also matches the same conditions. - -The main entry point for this feature is `WireMockRestDocs.verify()`, which can be used -as a substitute for the `document()` convenience method, as shown in the following -example: - -[source,java,indent=0] - -import static org.springframework.cloud.contract.wiremock.restdocs.WireMockRestDocs.verify; - ----- -@RunWith(SpringRunner.class) -@SpringBootTest -@AutoConfigureRestDocs(outputDir = "target/snippets") -@AutoConfigureMockMvc -public class ApplicationTests { - - @Autowired - private MockMvc mockMvc; - - @Test - public void contextLoads() throws Exception { - mockMvc.perform(post("/resource") - .content("{\"id\":\"123456\",\"message\":\"Hello World\"}")) - .andExpect(status().isOk()) - .andDo(verify().jsonPath("$.id") - .stub("resource")); - } -} ----- - -This contract specifies that any valid POST with an "id" field receives the response -defined in this test. You can chain together calls to `.jsonPath()` to add additional -matchers. If JSON Path is unfamiliar, The https://github.com/jayway/JsonPath[JayWay -documentation] can help you get up to speed. The `WebTestClient` version of this test -has a similar `verify()` static helper that you insert in the same place. - -Instead of the `jsonPath` and `contentType` convenience methods, you can also use the -WireMock APIs to verify that the request matches the created stub, as shown in the -following example: - -[source,java,indent=0] ----- - @Test - public void contextLoads() throws Exception { - mockMvc.perform(post("/resource") - .content("{\"id\":\"123456\",\"message\":\"Hello World\"}")) - .andExpect(status().isOk()) - .andDo(verify() - .wiremock(WireMock.post( - urlPathEquals("/resource")) - .withRequestBody(matchingJsonPath("$.id")) - .stub("post-resource")); - } ----- - -The WireMock API is rich. You can match headers, query parameters, and request body by -regex as well as by JSON path. These features can be used to create stubs with a wider -range of parameters. The above example generates a stub resembling the following example: - -.post-resource.json -[source,json] ----- -{ - "request" : { - "url" : "/resource", - "method" : "POST", - "bodyPatterns" : [ { - "matchesJsonPath" : "$.id" - }] - }, - "response" : { - "status" : 200, - "body" : "Hello World", - "headers" : { - "X-Application-Context" : "application:-1", - "Content-Type" : "text/plain" - } - } -} ----- - -NOTE: You can use either the `wiremock()` method or the `jsonPath()` and `contentType()` -methods to create request matchers, but you can't use both approaches. - -On the consumer side, you can make the `resource.json` generated earlier in this section -available on the classpath (by -<= 20)]', byType()) - } - } -} ----- - -The generated document (formatted in Asciidoc in this case) contains a formatted -contract. The location of this file would be `index/dsl-contract.adoc`. diff --git a/docs/src/main/asciidoc/using.adoc b/docs/src/main/asciidoc/using.adoc new file mode 100644 index 0000000000..a3e6ddeadf --- /dev/null +++ b/docs/src/main/asciidoc/using.adoc @@ -0,0 +1,875 @@ +[[using]] += Using Spring Cloud Contract +include::_attributes.adoc[] + +This section goes into more detail about how you should use {project-full-name}. It covers topics +such as flows of how to work with {project-full-name}. We also +cover some {project-full-name} best practices. + +If you are starting out with {project-full-name}, you should probably read the +<> guide before diving into this +section. + +[[flows-provider-nexus]] +== Provider Contract Testing with Stubs in Nexus or Artifactory + +You can check the <> link to see the provider contract testing with stubs in the Nexus or Artifactory flow. + +You can also check the https://cloud-samples.spring.io/spring-cloud-contract-samples/tutorials/contracts_on_the_producer_side.html[workshop page] for a step-by-step instruction on how to do this flow. + +[[flows-provider-git]] +== Provider Contract Testing with Stubs in Git + +In this flow, we perform the provider contract testing (the producer has no knowledge of how consumers use their API). The stubs are uploaded to a separate repository (they are not uploaded to Artifactory or Nexus). + +=== Prerequisites + +Before testing provider contracts with stubs in git, you must provide a git repository +that contains all the stubs for each producer. For an example of such a project, see +{samples_code}/contract_git[this samples ] or {samples_code}/contract_git[this sample]. +As a result of pushing stubs there, the repository has the following structure: + +==== +[src, bash] +---- +$ tree . +└── META-INF +   └── folder.with.group.id.as.its.name +   └── folder-with-artifact-id +   └── folder-with-version +   ├── contractA.groovy +   ├── contractB.yml +   └── contractC.groovy + +---- +==== + +You must also provide consumer code that has Spring Cloud Contract Stub Runner set up. For +an example of such a project, see {samples_code}/consumer[this sample] and search for a +`BeerControllerGitTest` test. You must also provide producer code that has Spring Cloud +Contract set up, together with a plugin. For an example of such a project, see +{samples_code}/producer_with_empty_git[this sample]. + +[[flows-provider-git-flow]] +=== The Flow + +The flow looks exactly as the one presented in +<>, +but the `Stub Storage` implementation is a git repository. + +You can read more about setting up a git repository and setting consumer and producer side +in the <> of the documentation. + +[[flows-provider-git-consumer]] +=== Consumer setup + +In order to fetch the stubs from a git repository instead of Nexus or Artifactory, you +need to use the `git` protocol in the URL of the `repositoryRoot` property in Stub Runner. +The following example shows how to set it up: + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.Annotation +---- +@AutoConfigureStubRunner( +stubsMode = StubRunnerProperties.StubsMode.REMOTE, + repositoryRoot = "git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git", + ids = "com.example:artifact-id:0.0.1") +---- + +[source,java,indent=0,subs="verbatim,attributes",role="secondary"] +.JUnit 4 Rule +---- +@Rule + public StubRunnerRule rule = new StubRunnerRule() + .downloadStub("com.example","artifact-id", "0.0.1") + .repoRoot("git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git") + .stubsMode(StubRunnerProperties.StubsMode.REMOTE); +---- + +[source,java,indent=0,subs="verbatim,attributes",role="secondary"] +.JUnit 5 Extension +---- +@Rule + public StubRunnerExtension stubRunnerExtension = new StubRunnerExtension() + .downloadStub("com.example","artifact-id", "0.0.1") + .repoRoot("git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git") + .stubsMode(StubRunnerProperties.StubsMode.REMOTE); +---- +==== + +[[flows-provider-git-producer]] +=== Setting up the Producer + +In order to push the stubs to a git repository instead of Nexus or Artifactory, you need +to use the `git` protocol in the URL of the plugin setup. Also you need to explicitly tell +the plugin to push the stubs at the end of the build process. The following example shows +how to do so: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + + + + git://git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git + + + + ${project.groupId} + ${project.artifactId} + ${project.version} + + + + REMOTE + + + + package + + + pushStubsToScm + + + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +contracts { + // We want to pick contracts from a Git repository + contractDependency { + stringNotation = "${project.group}:${project.name}:${project.version}" + } + /* + We reuse the contract dependency section to set up the path + to the folder that contains the contract definitions. In our case the + path will be /groupId/artifactId/version/contracts + */ + contractRepository { + repositoryUrl = "git://git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git" + } + // The mode can't be classpath + contractsMode = "REMOTE" + // Base class mappings etc. +} + +/* +In this scenario we want to publish stubs to SCM whenever +the `publish` task is executed +*/ +publish.dependsOn("publishStubsToScm") +---- +==== + +You can read more about setting up a git repository in the +<> of the documentation. + +[[flows-cdc-contracts-producer]] +== Consumer Driven Contracts with Contracts on the Producer Side + +See <> to see the Consumer Driven Contracts +with contracts on the producer side flow. + +[[flows-cdc-contracts-external]] +== Consumer Driven Contracts with Contracts in an External Repository + +In this flow, we perform Consumer Driven Contract testing. The contract definitions are +stored in a separate repository. + +See the https://cloud-samples.spring.io/spring-cloud-contract-samples/tutorials/contracts_on_the_producer_side.html[workshop page] +for step-by-step instructions on how to do this flow. + +=== Prerequisites + +To use consumer-driven contracts with the contracts held in an external repository, you need to set up a git repository that: + +* Contains all the contract definitions for each producer. +* Can package the contract definitions in a JAR. +* For each contract producer, contains a way (for example, `pom.xml`) to install stubs +locally through the Spring Cloud Contract Plugin (SCC Plugin) + +For more information, see the <>, +where we describe how to set up such a repository +For an example of such a project, see {samples_code}/beer_contracts[this sample]. + +You also need consumer code that has Spring Cloud Contract Stub Runner set up. +For an example of such a project, see {samples_code}/consumer[this sample]. +You also need producer code that has Spring Cloud Contract set up, together with a plugin. +For an example of such a project, see {samples_code}/producer_with_external_contracts[this sample]. +The stub storage is Nexus or Artifactory + +At a high level, the flow looks as follows: + +. The consumer works with the contract definitions from the separate repository +. Once the consumer's work is done, a branch with working code is done on the consumer +side and a pull request is made to the separate repository that holds the contract definitions. +. The producer takes over the pull request to the separate repository with contract +definitions and installs the JAR with all contracts locally. +. The producer generates tests from the locally stored JAR and writes the missing +implementation to make the tests pass. +. Once the producer's work is done, the pull request to the repository that holds the +contract definitions is merged. +. After the CI tool builds the repository with the contract definitions and the JAR with +contract definitions gets uploaded to Nexus or Artifactory, the producer can merge its branch. +. Finally, the consumer can switch to working online to fetch stubs of the producer from a +remote location, and the branch can be merged to master. + +[[flows-cdc-contracts-external-consumer]] +=== Consumer Flow + +The consumer: + +. Writes a test that would send a request to the producer. ++ +The test fails due to no server being present. +. Clones the repository that holds the contract definitions. +. Set up the requirements as contracts under the folder with the consumer name as a subfolder of the producer. ++ +For example, for a producer named `producer` and a consumer named `consumer`, the contracts would be stored under `src/main/resources/contracts/producer/consumer/`) +. Once the contracts are defined, installs the producer stubs to local storage, as the following example shows: ++ +==== +[src,bash] +---- +$ cd src/main/resource/contracts/producer +$ ./mvnw clean install +---- +==== +. Sets up Spring Cloud Contract (SCC) Stub Runner in the consumer tests, to: +* Fetch the producer stubs from local storage. +* Work in the stubs-per-consumer mode (this enables consumer driven contracts mode). ++ +The SCC Stub Runner: +* Fetches the producer stubs. +* Runs an in-memory HTTP server stub with the producer stubs. +* Now your test communicates with the HTTP server stub and your tests pass +* Create a pull request to the repository with contract definitions, with the new contracts for the producer +* Branch your consumer code, until the producer team has merged their code + +The following UML diagram shows the consumer flow: + +[plantuml, flow-overview-consumer-cdc-external-consumer, png] +---- +"Consumer"->"Repo\nwith\ncontracts": clone +"Repo\nwith\ncontracts"->"Repo\nwith\ncontracts\nclone": cloned +"Consumer"->"Repo\nwith\ncontracts\nclone": create contract\ndefinitions of\nthe [Producer] +"Repo\nwith\ncontracts\nclone"->"Local storage": install [Producer]\nstubs locally +"Consumer"->"Consumer\nBuild": run tests +"Consumer\nBuild"->"SCC\nStub Runner": Run [Producer] stubs +"SCC\nStub Runner"->"Local storage": fetch [Producer] stubs +"SCC\nStub Runner"->"Producer stub": stub is running +"Consumer\nBuild"->"Producer stub": send a request\nin the tests +"Producer stub"->"Consumer\nBuild": send a response +"Consumer\nBuild"->"Consumer": the tests are passing +"Consumer"->"Repo\nwith\ncontracts\nclone": send a pull request +"Repo\nwith\ncontracts\nclone"->"Repo\nwith\ncontracts": pull request sent +"Consumer"->"Consumer": branch the code +---- + +[[flows-cdc-contracts-external-producer]] +=== Producer Flow + +The producer: + +. Takes over the pull request to the repository with contract definitions. You can do it +from the command line, as follows ++ +==== +[src,bash] +---- +$ git checkout -b the_branch_with_pull_request master +git pull https://github.com/user_id/project_name.git the_branch_with_pull_request +---- +==== +. Installs the contract definitions, as follows ++ +==== +[src,bash] +---- +$ ./mvnw clean install +---- +==== +. Sets up the plugin to fetch the contract definitions from a JAR instead of from +`src/test/resources/contracts`, as follows: ++ +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + + + com.example + beer-contracts + + + LOCAL + + + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +contracts { + // We want to use the JAR with contracts with the following coordinates + // group id `com.example`, artifact id `beer-contracts`, LATEST version and NO classifier + contractDependency { + stringNotation = 'com.example:beer-contracts:+:' + } + // The JAR with contracts should be taken from Maven local + contractsMode = "LOCAL" + // Additional configuration +} +---- +==== +. Runs the build to generate tests and stubs, as follows: ++ +==== +[source,bash,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- +./mvnw clean install +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +./gradlew clean build +---- +==== +. Writes the missing implementation, to make the tests pass. +. Merges the pull request to the repository with contract definitions, as follows: ++ +==== +[src,bash] +---- +$ git commit -am "Finished the implementation to make the contract tests pass" +$ git checkout master +$ git merge --no-ff the_branch_with_pull_request +$ git push origin master +---- +==== +. The CI system builds the project with the contract definitions and uploads the JAR with +the contract definitions to Nexus or Artifactory. +. Switches to working remotely. +. Sets up the plugin so that the contract definitions are no longer taken from the local +storage but from a remote location, as follows: ++ +==== +[source,xml,indent=0,subs="verbatim,attributes",role="primary"] +.Maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + + + com.example + beer-contracts + + + REMOTE + + + +---- + +[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] +.Gradle +---- +contracts { + // We want to use the JAR with contracts with the following coordinates + // group id `com.example`, artifact id `beer-contracts`, LATEST version and NO classifier + contractDependency { + stringNotation = 'com.example:beer-contracts:+:' + } + // The JAR with contracts should be taken from a remote location + contractsMode = "REMOTE" + // Additional configuration +} +---- +==== +. Merges the producer code with the new implementation. +. The CI system: +* Builds the project +* Generates tests, stubs, and the stub JAR +* Uploads the artifact with the application and the stubs to Nexus or Artifactory. + +The following UML diagram shows the producer process: + +[plantuml, flow-overview-consumer-cdc-external-producer, png] +---- +"Producer"->"Repo\nwith\ncontracts": take over the pull request +"Producer"->"Repo\nwith\ncontracts": install the contract\ndefinitions JAR +"Repo\nwith\ncontracts"->"Local storage": install the\ncontract definitions\nJAR locally +"Local storage"->"Repo\nwith\ncontracts": contract definitions\nJAR installed +"Producer"->"Producer\nBuild": run build +"Producer\nBuild"->"SCC\nPlugin": generate tests,\nstubs\nand stub jar +"SCC\nPlugin"->"Local storage": fetch the contract definitions +"Local storage"->"SCC\nPlugin": contract definitions found +"SCC\nPlugin"->"SCC\nPlugin": generate tests +"Producer\nBuild"->"Producer\nBuild": run the\ngenerated tests +"Producer\nBuild"->"Producer": the tests failed to pass +"Producer"->"Producer": write the missing implementation +"Producer"->"Producer\nBuild": run the build again +"Producer\nBuild"->"Producer\nBuild": fetch the contract definitions\nrun the generated tests +"Producer\nBuild"->"Producer": the tests passed +"Producer"->"Repo\nwith\ncontracts": merge the pull request +"Repo\nwith\ncontracts"->"CI": build and upload the\ncontract definitions artifact +"CI"->"Stub Storage": upload the\ncontract definitions +"Producer"->"Producer": setup the SCC Plugin\nto work remotely +"Producer"->"Producer": merge the code\nwith the implementation +"Producer"->"CI": build and upload\nthe artifacts +"CI"->"Producer\nBuild\non CI": generate tests,\nstubs\nand stub jar +"Producer\nBuild\non CI"->"SCC\nPlugin": generate tests,\nstubs\nand stub jar +"SCC\nPlugin"->"Stub Storage": fetch the contract definitions +"Stub Storage"->"SCC\nPlugin": contract definitions found +"SCC\nPlugin"->"SCC\nPlugin": generate tests +"Producer\nBuild\non CI"->"CI": the build passed +"Producer\nBuild\non CI"->"Stub Storage": upload the application JAR\nand the stubs jar +---- + +[[flows-cdc-contracts-stubs-git]] +== Consumer Driven Contracts with Contracts on the Producer Side, Pushed to Git + +You can check <> to see the consumer driven contracts with contracts on the producer side flow. + +The stub storage implementation is a git repository. We describe its setup in the +<> section. + +You can read more about setting up a git repository for the consumer and producer sides in +the <> of the documentation. + +[[flows-provider-non-spring]] +== Provider Contract Testing with Stubs in Artifactory for a non-Spring Application + +[[flows-provider-non-spring-flow]] +=== The Flow + +You can check <> to see the flow for provider contract testing with stubs in Nexus or Artifactory. + +[[flows-provider-non-spring-consumer]] +=== Setting up the Consumer + +For the consumer side, you can use a JUnit rule. That way, you need not start a Spring context. The follwoing listing shows such a rule (in JUnit4 and JUnit 5); + +==== +[source,java,indent=0,subs="verbatim,attributes",role="primary"] +.JUnit 4 Rule +---- +@Rule + public StubRunnerRule rule = new StubRunnerRule() + .downloadStub("com.example","artifact-id", "0.0.1") + .repoRoot("git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git") + .stubsMode(StubRunnerProperties.StubsMode.REMOTE); +---- + +[source,java,indent=0,subs="verbatim,attributes",role="secondary"] +.JUnit 5 Extension +---- +@Rule + public StubRunnerExtension stubRunnerExtension = new StubRunnerExtension() + .downloadStub("com.example","artifact-id", "0.0.1") + .repoRoot("git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git") + .stubsMode(StubRunnerProperties.StubsMode.REMOTE); +---- +==== + +[[flows-provider-non-spring-producer]] +=== Setting up the Producer + +By default, the Spring Cloud Contract Plugin uses Rest Assured's `MockMvc` setup for the +generated tests. Since non-Spring applications do not use `MockMvc`, you can change the +`testMode` to `EXPLICIT` to send a real request to an application bound at a specific port. + +In this example, we use a framework called https://javalin.io[Javalin] to start a +non-Spring HTTP server. + +Assume that we have the following application: + +==== +[source,java,indent=0] +---- +package com.example.demo; + +import io.javalin.Javalin; + +public class DemoApplication { + + public static void main(String[] args) { + new DemoApplication().run(7000); + } + + public Javalin start(int port) { + return Javalin.create().start(port); + } + + public Javalin registerGet(Javalin app) { + return app.get("/", ctx -> ctx.result("Hello World")); + } + + public Javalin run(int port) { + return registerGet(start(port)); + } + +} +---- +==== + +Given that application, we can set up the plugin to use the `EXPLICIT` mode (that is, to +send out requests to a real port), as follows: + +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + org.springframework.cloud + spring-cloud-contract-maven-plugin + ${spring-cloud-contract.version} + true + + com.example.demo.BaseClass + + EXPLICIT + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +contracts { + // This will setup the EXPLICIT mode for the tests + testMode = "EXPLICIT" + baseClassForTests = "com.example.demo.BaseClass" +} +---- +==== + +The base class might resemble the following: + +==== +[source,java,indent=0] +---- +import io.javalin.Javalin; +import io.restassured.RestAssured; +import org.junit.After; +import org.junit.Before; +import org.springframework.util.SocketUtils; + +public class BaseClass { + + Javalin app; + + @Before + public void setup() { + // pick a random port + int port = SocketUtils.findAvailableTcpPort(); + // start the application at a random port + this.app = start(port); + // tell Rest Assured where the started application is + RestAssured.baseURI = "http://localhost:" + port; + } + + @After + public void close() { + // stop the server after each test + this.app.stop(); + } + + private Javalin start(int port) { + // reuse the production logic to start a server + return new DemoApplication().run(port); + } +} +---- +==== + +With such a setup: + +* We have setup the Spring Cloud Contract plugin to use the `EXPLICIT` mode to send real +requests instead of mocked ones. +* We have defined a base class that: +** Starts the HTTP server on a random port for each test. +** Sets Rest Assured to send requests to that port. +** Closes the HTTP server after each test. + +[[flows-provider-non-jvm]] +== Provider Contract Testing with Stubs in Artifactory in a non-JVM World + +In this flow, we assume that: + +* The API Producer and API Consumer are non-JVM applications. +* The contract definitions are written in YAML. +* The Stub Storage is Artifactory or Nexus. +* Spring Cloud Contract Docker (SCC Docker) and Spring Cloud Contract Stub Runner Docker +(SCC Stub Runner Docker) images are used. + +You can read more about how to use Spring Cloud Contract with Docker +<>. + +https://spring.io/blog/2018/02/13/spring-cloud-contract-in-a-polyglot-world[Here], you can +read a blog post about how to use Spring Cloud Contract in a polyglot world. + +https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs/[Here], you can find +a sample of a NodeJS application that uses Spring Cloud Contract both as a producer and a +consumer. + +[[flows-provider-non-jvm-producer]] +=== Producer Flow + +At a high level, the producer: + +. Writes contract definitions (for example, in YAML). +. Sets up the build tool to: +.. Start the application with mocked services on a given port. ++ +If mocking is not possible, you can setup the infrastructure and define tests in a stateful way. +.. Run the Spring Cloud Contract Docker image and pass the port of a running application as an environment variable. + +The SCC Docker image: +* Generates the tests from the attached volume. +* Runs the tests against the running application. + +Upon test completion, stubs get uploaded to a stub storage site (such as Artifactory or Git). + +The following UML diagram shows the producer flow: + +[plantuml, flows-provider-non-jvm-producer, png] +---- +"API Producer"->"API Producer": write contract definitions +"API Producer"->"API Producer": (preferable) prepare a way\nto run the app\nwith mocked services +"API Producer"->"API Producer\nbuild": run the build +"API Producer\nbuild"->"API Producer\nrunning app": run the app\non port X\nwith mocked services +"API Producer\nbuild"->"SCC Docker": attach contract definitions\nas a volume +"API Producer\nbuild"->"SCC Docker": set environment variables\ne.g. app running on port X +"API Producer\nbuild"->"SCC Docker": run the contract tests +"SCC Docker"->"SCC Docker\nimage": run the contract tests +"SCC Docker\nimage"->"SCC Docker\nimage": pick the contract definitions\nfrom volume +"SCC Docker\nimage"->"SCC Docker\nimage": generate contract tests +"SCC Docker\nimage"->"SCC Docker\nimage": run the tests\nagainst app running\non port X +"SCC Docker\nimage"->"SCC Docker\nimage": the tests are passing! +"SCC Docker\nimage"->"Stub Storage": upload the stubs +"SCC Docker\nimage"->"SCC Docker": build successful +"SCC Docker"->"API Producer\nbuild": build successful +"API Producer\nbuild"->"API Producer": build successful +---- + +[[flows-provider-non-jvm-consumer]] +=== Consumer Flow + +At a high level, the consumer: + +. Sets up the build tool to: +* Start the Spring Cloud Contract Stub Runner Docker image and start the stubs. ++ +The environment variables configure: +* The stubs to fetch. +* The location of the repositories. ++ +Note that: +* To use the local storage, you can also attach it as a volume. +* The ports at which the stubs are running need to be exposed. +. Run the application tests against the running stubs. + +The following UML diagram shows the consumer flow: + +[plantuml, flows-provider-non-jvm-consumer, png] +---- +"API Consumer"->"API Consumer\nbuild": run the build +"API Consumer\nbuild"->"SCC\nStub Runner\nDocker": set environment variables\ne.g. stub X running on port Y +"SCC\nStub Runner\nDocker"->"SCC\nStub Runner\nDocker\nimage": fetch and run\nthe stubs +"SCC\nStub Runner\nDocker\nimage"->"Stub Storage": fetch the stubs of X +"Stub Storage"->"SCC\nStub Runner\nDocker\nimage": stubs found +"SCC\nStub Runner\nDocker\nimage"->"X Stub": run the stub of X +"X Stub"->"SCC\nStub Runner\nDocker\nimage": stub is running\non port Y +"SCC\nStub Runner\nDocker\nimage"->"SCC\nStub Runner\nDocker": stubs running and\nready for tests +"API Consumer\nbuild"->"API Consumer\nbuild": run tests against X stub +"API Consumer\nbuild"->"X Stub": send a request +"X Stub"->"API Consumer\nbuild": response received +"API Consumer\nbuild"->"API Consumer": build successful +---- + +[[flows-provider-rest-docs]] +== Provider Contract Testing with REST Docs and Stubs in Nexus or Artifactory + +In this flow, we do not use a Spring Cloud Contract plugin to generate tests and stubs. We write https://spring.io/projects/spring-restdocs[Spring RESTDocs] and, from them, we automatically generate stubs. Finally, we set up our builds to package the stubs and upload them to the stub storage site -- in our case, Nexus or Artifactory. + +See the https://cloud-samples.spring.io/spring-cloud-contract-samples/tutorials/rest_docs.html[workshop page] for a step-by-step instruction on how to use this flow. + +[[flows-provider-rest-docs-producer]] +=== Producer Flow + +As a producer, we: + +. We write RESTDocs tests of our API. +. We add Spring Cloud Contract Stub Runner starter to our build (`spring-cloud-starter-contract-stub-runner`), as follows ++ +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + + org.springframework.cloud + spring-cloud-starter-contract-stub-runner + test + + + + + + + org.springframework.cloud + spring-cloud-dependencies + ${spring-cloud.version} + pom + import + + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +dependencies { + testImplementation 'org.springframework.cloud:spring-cloud-starter-contract-stub-runner' +} + +dependencyManagement { + imports { + mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" + } +} +---- +==== +. We set up the build tool to package our stubs, as follows: ++ +==== +[source,xml,indent=0,role="primary"] +.maven +---- + + + + org.apache.maven.plugins + maven-assembly-plugin + + + stub + prepare-package + + single + + false + + true + + ${basedir}/src/assembly/stub.xml + + + + + + + + + + stubs + + jar + + false + + + ${project.build.directory}/generated-snippets/stubs + META-INF/${project.groupId}/${project.artifactId}/${project.version}/mappings + + **/* + + + + +---- + +[source,groovy,indent=0,role="secondary"] +.gradle +---- +task stubsJar(type: Jar) { + classifier = "stubs" + into("META-INF/${project.group}/${project.name}/${project.version}/mappings") { + include('**/*.*') + from("${project.buildDir}/generated-snippets/stubs") + } +} +// we need the tests to pass to build the stub jar +stubsJar.dependsOn(test) +bootJar.dependsOn(stubsJar) +---- +==== + +Now, when we run the tests, stubs are automatically published and packaged. + +The following UML diagram shows the producer flow: + +[plantuml, flows-provider-rest-docs-producer, png] +---- +"API Producer"->"API Producer": write RESTDocs tests +"API Producer"->"API Producer": add the stub runner\nstarter dependency +"API Producer"->"API Producer": setup the build tool to package\nthe generated stubs +"API Producer"->"API Producer\nbuild": run the build +"API Producer\nbuild"->"RESTDocs": generate HTTP snippets +"RESTDocs"->"Spring Cloud\nContract": generate HTTP stubs +"RESTDocs"->"Spring Cloud\nContract": (optional) generate\ncontract DSLs +"Spring Cloud\nContract"->"RESTDocs": files generated +"RESTDocs"->"API Producer\nbuild": snippets generated +"API Producer\nbuild"->"API Producer\nbuild": tests passed +"API Producer\nbuild"->"API Producer\nbuild": generate stubs jar +"API Producer\nbuild"->"Stub Storage": upload JAR with the application +"API Producer\nbuild"->"Stub Storage": upload JAR with the stubs +"Stub Storage"->"API Producer\nbuild": JARs uploaded +"API Producer\nbuild"->"API Producer": build successful +---- + +[[flows-provider-rest-docs-consumer]] +=== Consumer Flow + +Since the consumer flow is not affected by the tool used to generate the stubs, you can check <> to see the flow for consumer side of the provider contract testing with stubs in Nexus or Artifactory. + +[[using-whats-next]] +== What to Read Next + +You should now understand how you can use {project-full-name} and some best practices that you +should follow. You can now go on to learn about specific +<>, or you could +skip ahead and read about the link:advanced.html[advanced features of {project-full-name}]. diff --git a/docs/src/main/asciidoc/verifier_contract.adoc b/docs/src/main/asciidoc/verifier_contract.adoc deleted file mode 100644 index f127194d43..0000000000 --- a/docs/src/main/asciidoc/verifier_contract.adoc +++ /dev/null @@ -1,2064 +0,0 @@ -[[contract-dsl]] -== Contract DSL - -Spring Cloud Contract supports out of the box 2 types of DSL. One written in -`Groovy` and one written in `YAML`. - -If you decide to write the contract in Groovy, do not be alarmed if you have not used Groovy -before. Knowledge of the language is not really needed, as the Contract DSL uses only a -tiny subset of it (only literals, method calls and closures). Also, the DSL is statically -typed, to make it programmer-readable without any knowledge of the DSL itself. - -IMPORTANT: Remember that, inside the Groovy contract file, you have to provide the fully -qualified name to the `Contract` class and `make` static imports, such as -`org.springframework.cloud.spec.Contract.make { ... }`. You can also provide an import to -the `Contract` class: `import org.springframework.cloud.spec.Contract` and then call -`Contract.make { ... }`. - -TIP: Spring Cloud Contract supports defining multiple contracts in a single file. - -The following is a complete example of a Groovy contract definition: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilderSpec.groovy[tags=dsl_example,indent=0] ----- - -The following is a complete example of a YAML contract definition: - -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_rest.yml[indent=0] ----- - -TIP: You can compile contracts to stubs mapping using standalone maven command: -`mvn org.springframework.cloud:spring-cloud-contract-maven-plugin:convert` - -=== Limitations - -WARNING: Spring Cloud Contract Verifier does not properly support XML. Please use JSON or -help us implement this feature. - -WARNING: The support for verifying the size of JSON arrays is experimental. If you want -to turn it on, please set the value of the following system property to `true`: -`spring.cloud.contract.verifier.assert.size`. By default, this feature is set to `false`. -You can also provide the `assertJsonSize` property in the plugin configuration. - -WARNING: Because JSON structure can have any form, it can be impossible to parse it -properly when using the Groovy DSL and the `value(consumer(...), producer(...))` notation in `GString`. That -is why you should use the Groovy Map notation. - -=== Common Top-Level elements - -The following sections describe the most common top-level elements: - -* <> -* <> -* <> -* <> -* <> - -[[contract-dsl-description]] -==== Description - -You can add a `description` to your contract. The description is arbitrary text. The -following code shows an example: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{contract_spec_tests_path}/src/test/groovy/org/springframework/cloud/contract/spec/internal/ContractSpec.groovy[tags=description,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_rest.yml[indent=0] ----- - -[[contract-dsl-name]] -==== Name - -You can provide a name for your contract. Assume that you provided the following name: -`should register a user`. If you do so, the name of the autogenerated test is -`validate_should_register_a_user`. Also, the name of the stub in a WireMock stub is -`should_register_a_user.json`. - -IMPORTANT: You must ensure that the name does not contain any characters that make the -generated test not compile. Also, remember that, if you provide the same name for -multiple contracts, your autogenerated tests fail to compile and your generated stubs -override each other. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{contract_spec_tests_path}/src/test/groovy/org/springframework/cloud/contract/spec/internal/ContractSpec.groovy[tags=name,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=name,indent=0] ----- - -[[contract-dsl-ignoring-contracts]] -==== Ignoring Contracts - -If you want to ignore a contract, you can either set a value of ignored contracts in the -plugin configuration or set the `ignored` property on the contract itself: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{contract_spec_tests_path}/src/test/groovy/org/springframework/cloud/contract/spec/internal/ContractSpec.groovy[tags=ignored,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=ignored,indent=0] ----- - -[[contract-dsl-passing-values-from-files]] -==== Passing Values from Files - -Starting with version `1.2.0`, you can pass values from files. Assume that you have the -following resources in our project. - -[source,bash,indent=0] ----- -└── src -    └── test -       └── resources -          └── contracts -    ├── readFromFile.groovy -    ├── request.json -    └── response.json ----- - -Further assume that your contract is as follows: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/resources/classpath/readFromFile.groovy[indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_from_file.yml[indent=0] ----- - -Further assume that the JSON files is as follows: - -*request.json* -[source,json,indent=0] ----- -include::{verifier_core_path}/src/test/resources/classpath/request.json[indent=0] ----- - -*response.json* -[source,json,indent=0] ----- -include::{verifier_core_path}/src/test/resources/classpath/response.json[indent=0] ----- - -When test or stub generation takes place, the contents of the file is passed to the body -of a request or a response. The name of the file needs to be a file with location -relative to the folder in which the contract lays. - -If you need to pass the contents of a file in a binary form -it's enough for you to use the `fileAsBytes` method in Groovy DSL or `bodyFromFileAsBytes` field in YAML. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/resources/body_builder/worksWithPdf.groovy[indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_pdf.yml[indent=0] ----- - -IMPORTANT: You should use this approach whenever you want to work with binary payloads both for HTTP and messaging. - -[[contract-dsl-http-top-level-elements]] -==== HTTP Top-Level Elements - -The following methods can be called in the top-level closure of a contract definition. -`request` and `response` are mandatory. `priority` is optional. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=http_dsl,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=priority,indent=0] -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] -... -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=response,indent=0] -... ----- - -IMPORTANT: If you want to make your contract have a **higher** value of priority -you need to pass a **lower** number to the `priority` tag / method. E.g. `priority` with -value `5` has **higher** priority than `priority` with value `10`. - -=== Request - -The HTTP protocol requires only **method and url** to be specified in a request. The -same information is mandatory in request definition of the Contract. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=request,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request_obligatory,indent=0] ----- - -It is possible to specify an absolute rather than relative `url`, but using `urlPath` is -the recommended way, as doing so makes the tests **host-independent**. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=url,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_rest_with_path.yml[tags=url_path,indent=0] ----- - -`request` may contain **query parameters**. - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=urlpath,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] -... -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=query_params,indent=0] ----- - -`request` may contain additional **request headers**, as shown in the following example: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=headers,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] -... -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=headers,indent=0] ----- - -`request` may contain additional **request cookies**, as shown in the following example: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=cookies,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] -... -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=cookies,indent=0] ----- - -`request` may contain a **request body**: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=body,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=request,indent=0] -... -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=body,indent=0] ----- - -`request` may contain **multipart** elements. To include multipart elements, use the -`multipart` method/section, as shown in the following examples - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilderSpec.groovy[tags=multipartdsl,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_multipart.yml[indent=0] ----- - -In the preceding example, we define parameters in either of two ways: - -.Groovy DSL -* Directly, by using the map notation, where the value can be a dynamic property (such as -`formParameter: $(consumer(...), producer(...))`). -* By using the `named(...)` method that lets you set a named parameter. A named parameter -can set a `name` and `content`. You can call it either via a method with two arguments, -such as `named("fileName", "fileContent")`, or via a map notation, such as -`named(name: "fileName", content: "fileContent")`. - -.YAML -* The multipart parameters are set via `multipart.params` section -* The named parameters (the `fileName` and `fileContent` for a given parameter name) -can be set via the `multipart.named` section. That section contains -the `paramName` (name of the parameter), `fileName` (name of the file), -`fileContent` (content of the file) fields -* The dynamic bits can be set via the `matchers.multipart` section -** for parameters use the `params` section that can accept -`regex` or a `predefined` regular expression -** for named params use the `named` section where first you -define the parameter name via `paramName` and then you can pass the -parametrization of either `fileName` or `fileContent` via -`regex` or a `predefined` regular expression - -From this contract, the generated test is as follows: - -[source,java,indent=0] ----- - // given: - MockMvcRequestSpecification request = given() - .header("Content-Type", "multipart/form-data;boundary=AaB03x") - .param("formParameter", "\"formParameterValue\"") - .param("someBooleanParameter", "true") - .multiPart("file", "filename.csv", "file content".getBytes()); - - // when: - ResponseOptions response = given().spec(request) - .put("/multipart"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); ----- - -The WireMock stub is as follows: - -[source,json,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockGroovyDslSpec.groovy[tags=multipartwiremock,indent=0] ----- - -=== Response - -The response must contain an **HTTP status code** and may contain other information. The -following code shows an example: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=response,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=response,indent=0] -... -include::{verifier_core_path}/src/test/resources/yml/contract.yml[tags=response_obligatory,indent=0] ----- - -Besides status, the response may contain **headers**, **cookies** and a **body**, both of which are -specified the same way as in the request (see the previous paragraph). - -TIP: Via the Groovy DSL you can reference the `org.springframework.cloud.contract.spec.internal.HttpStatus` -methods to provide a meaningful status instead of a digit. E.g. you can call -`OK()` for a status `200` or `BAD_REQUEST()` for `400`. - -=== Dynamic properties - -The contract can contain some dynamic properties: timestamps, IDs, and so on. You do not -want to force the consumers to stub their clocks to always return the same value of time -so that it gets matched by the stub. - -For Groovy DSL you can provide the dynamic parts in your contracts -in two ways: pass them directly in the body or set them in a separate section called -`bodyMatchers`. - -NOTE: Before 2.0.0 these were set using `testMatchers` and `stubMatchers`, -check out the https://github.com/spring-cloud/spring-cloud-contract/wiki/Spring-Cloud-Contract-2.0-Migration-Guide[migration guide] for more information. - -For YAML you can only use the `matchers` section. - -==== Dynamic properties inside the body - -IMPORTANT: This section is valid only for Groovy DSL. Check out the -<> section for YAML examples of a similar feature. - -You can set the properties inside the body either with the `value` method or, if you use -the Groovy map notation, with `$()`. The following example shows how to set dynamic -properties with the value method: - -[source,groovy,indent=0] ----- -value(consumer(...), producer(...)) -value(c(...), p(...)) -value(stub(...), test(...)) -value(client(...), server(...)) ----- - -The following example shows how to set dynamic properties with `$()`: - -[source,groovy,indent=0] ----- -$(consumer(...), producer(...)) -$(c(...), p(...)) -$(stub(...), test(...)) -$(client(...), server(...)) ----- - -Both approaches work equally well. `stub` and `client` methods are aliases over the `consumer` -method. Subsequent sections take a closer look at what you can do with those values. - -==== Regular expressions - -IMPORTANT: This section is valid only for Groovy DSL. Check out the -<> section for YAML examples of a similar feature. - -You can use regular expressions to write your requests in Contract DSL. Doing so is -particularly useful when you want to indicate that a given response should be provided -for requests that follow a given pattern. Also, you can use regular expressions when you -need to use patterns and not exact values both for your test and your server side tests. - -Make sure that regex matches a whole region of a sequence as internally a call to -https://docs.oracle.com/javase/8/docs/api/java/util/regex/Matcher.html#matches--[Pattern.matches()] -is called. For instance, `abc` pattern doesn't match `aabc` string but `.abc` does. -There are several additional <> as well. - -The following example shows how to use regular expressions to write a request: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=regex,indent=0] ----- - -You can also provide only one side of the communication with a regular expression. If you -do so, then the contract engine automatically provides the generated string that matches -the provided regular expression. The following code shows an example: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=dsl_one_side_data_generation_example,indent=0] ----- - -In the preceding example, the opposite side of the communication has the respective data -generated for request and response. - -Spring Cloud Contract comes with a series of predefined regular expressions that you can -use in your contracts, as shown in the following example: - -[source,java,indent=0] ----- -include::{contract_spec_path}/src/main/java/org/springframework/cloud/contract/spec/internal/RegexPatterns.java[tags=regexps,indent=0] ----- - -In your contract, you can use it as shown in the following example: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SpringTestMethodBodyBuildersSpec.groovy[tags=contract_with_regex,indent=0] ----- - -To make matters even simpler you can use a set of predefined objects that will automatically assume that you want a regular expression to be passed. -All of those methods start with `any` prefix: - -[source,java,indent=0] ----- -include::{contract_spec_path}/src/main/java/org/springframework/cloud/contract/spec/internal/RegexCreatingProperty.java[tags=regex_creating_props,indent=0] ----- - -and this is an example of how you can reference those methods: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=regex_creating_props,indent=0] ----- - -[[regex-limitations]] -===== Limitations - -WARNING: Due to certain limitations of `Xeger` library that generates string out of -regex, do not use `$` and `^` signs in your regex if you rely on automatic -generation. https://github.com/spring-cloud/spring-cloud-contract/issues/899[Issue 899] - -WARNING: Do not use `LocalDate` instance as a value for `$` like this `$(consumer(LocalDate.now()))`. -It causes `java.lang.StackOverflowError`. Use `$(consumer(LocalDate.now().toString()))` instead. -https://github.com/spring-cloud/spring-cloud-contract/issues/900[Issue 900] - -==== Passing Optional Parameters - -IMPORTANT: This section is valid only for Groovy DSL. Check out the -<> section for YAML examples of a similar feature. - -It is possible to provide optional parameters in your contract. However, you can provide -optional parameters only for the following: - -* __STUB__ side of the Request -* __TEST__ side of the Response - -The following example shows how to provide optional parameters: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=optionals,indent=0] ----- - -By wrapping a part of the body with the `optional()` method, you create a regular -expression that must be present 0 or more times. - -If you use Spock for, the following test would be generated from the previous example: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=optionals_test,indent=0] ----- - -The following stub would also be generated: - -[source,groovy,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy[tags=wiremock,indent=0] ----- - -==== Executing Custom Methods on the Server Side - -IMPORTANT: This section is valid only for Groovy DSL. Check out the -<> section for YAML examples of a similar feature. - -You can define a method call that executes on the server side during the test. Such a -method can be added to the class defined as "baseClassForTests" in the configuration. The -following code shows an example of the contract portion of the test case: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=method,indent=0] ----- - -The following code shows the base class portion of the test case: - -[source,groovy,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0] ----- - -IMPORTANT: You cannot use both a String and `execute` to perform concatenation. For -example, calling `header('Authorization', 'Bearer ' + execute('authToken()'))` leads to -improper results. Instead, call `header('Authorization', execute('authToken()'))` and -ensure that the `authToken()` method returns everything you need. - -The type of the object read from the JSON can be one of the following, depending on the -JSON path: - -* `String`: If you point to a `String` value in the JSON. -* `JSONArray`: If you point to a `List` in the JSON. -* `Map`: If you point to a `Map` in the JSON. -* `Number`: If you point to `Integer`, `Double` etc. in the JSON. -* `Boolean`: If you point to a `Boolean` in the JSON. - -In the request part of the contract, you can specify that the `body` should be taken from -a method. - -IMPORTANT: You must provide both the consumer and the producer side. The `execute` part -is applied for the whole body - not for parts of it. - -The following example shows how to read an object from JSON: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilderSpec.groovy[tags=body_execute,indent=0] ----- - -The preceding example results in calling the `hashCode()` method in the request body. -It should resemble the following code: - -[source,java,indent=0] ----- - // given: - MockMvcRequestSpecification request = given() - .body(hashCode()); - - // when: - ResponseOptions response = given().spec(request) - .get("/something"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); ----- - -==== Referencing the Request from the Response - -The best situation is to provide fixed values, but sometimes you need to reference a -request in your response. - -If you're writing contracts using Groovy DSL, you can use the `fromRequest()` method, which lets -you reference a bunch of elements from the HTTP request. You can use the following -options: - -* `fromRequest().url()`: Returns the request URL and query parameters. -* `fromRequest().query(String key)`: Returns the first query parameter with a given name. -* `fromRequest().query(String key, int index)`: Returns the nth query parameter with a -given name. -* `fromRequest().path()`: Returns the full path. -* `fromRequest().path(int index)`: Returns the nth path element. -* `fromRequest().header(String key)`: Returns the first header with a given name. -* `fromRequest().header(String key, int index)`: Returns the nth header with a given name. -* `fromRequest().body()`: Returns the full request body. -* `fromRequest().body(String jsonPath)`: Returns the element from the request that -matches the JSON Path. - -If you're using the YAML contract definition you have to use the -https://handlebarsjs.com/[Handlebars] `{{{ }}}` notation with custom, Spring Cloud Contract - functions to achieve this. - -* `{{{ request.url }}}`: Returns the request URL and query parameters. -* `{{{ request.query.key.[index] }}}`: Returns the nth query parameter with a given name. -E.g. for key `foo`, first entry `{{{ request.query.foo.[0] }}}` -* `{{{ request.path }}}`: Returns the full path. -* `{{{ request.path.[index] }}}`: Returns the nth path element. E.g. -for first entry ```{{{ request.path.[0] }}} -* `{{{ request.headers.key }}}`: Returns the first header with a given name. -* `{{{ request.headers.key.[index] }}}`: Returns the nth header with a given name. -* `{{{ request.body }}}`: Returns the full request body. -* `{{{ jsonpath this 'your.json.path' }}}`: Returns the element from the request that -matches the JSON Path. E.g. for json path `$.foo` - `{{{ jsonpath this '$.foo' }}}` - -Consider the following contract: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilderSpec.groovy[tags=template_contract,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_reference_request.yml[indent=0] ----- - -Running a JUnit test generation leads to a test that resembles the following example: - -[source,java,indent=0] ----- - // given: - MockMvcRequestSpecification request = given() - .header("Authorization", "secret") - .header("Authorization", "secret2") - .body("{\"foo\":\"bar\",\"baz\":5}"); - - // when: - ResponseOptions response = given().spec(request) - .queryParam("foo","bar") - .queryParam("foo","bar2") - .get("/api/v1/xxxx"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - assertThat(response.header("Authorization")).isEqualTo("foo secret bar"); - // and: - DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); - assertThatJson(parsedJson).field("['fullBody']").isEqualTo("{\"foo\":\"bar\",\"baz\":5}"); - assertThatJson(parsedJson).field("['authorization']").isEqualTo("secret"); - assertThatJson(parsedJson).field("['authorization2']").isEqualTo("secret2"); - assertThatJson(parsedJson).field("['path']").isEqualTo("/api/v1/xxxx"); - assertThatJson(parsedJson).field("['param']").isEqualTo("bar"); - assertThatJson(parsedJson).field("['paramIndex']").isEqualTo("bar2"); - assertThatJson(parsedJson).field("['pathIndex']").isEqualTo("v1"); - assertThatJson(parsedJson).field("['responseBaz']").isEqualTo(5); - assertThatJson(parsedJson).field("['responseFoo']").isEqualTo("bar"); - assertThatJson(parsedJson).field("['url']").isEqualTo("/api/v1/xxxx?foo=bar&foo=bar2"); - assertThatJson(parsedJson).field("['responseBaz2']").isEqualTo("Bla bla bar bla bla"); ----- - -As you can see, elements from the request have been properly referenced in the response. - -The generated WireMock stub should resemble the following example: - -[source,json,indent=0] ----- -{ - "request" : { - "urlPath" : "/api/v1/xxxx", - "method" : "POST", - "headers" : { - "Authorization" : { - "equalTo" : "secret2" - } - }, - "queryParameters" : { - "foo" : { - "equalTo" : "bar2" - } - }, - "bodyPatterns" : [ { - "matchesJsonPath" : "$[?(@.['baz'] == 5)]" - }, { - "matchesJsonPath" : "$[?(@.['foo'] == 'bar')]" - } ] - }, - "response" : { - "status" : 200, - "body" : "{\"authorization\":\"{{{request.headers.Authorization.[0]}}}\",\"path\":\"{{{request.path}}}\",\"responseBaz\":{{{jsonpath this '$.baz'}}} ,\"param\":\"{{{request.query.foo.[0]}}}\",\"pathIndex\":\"{{{request.path.[1]}}}\",\"responseBaz2\":\"Bla bla {{{jsonpath this '$.foo'}}} bla bla\",\"responseFoo\":\"{{{jsonpath this '$.foo'}}}\",\"authorization2\":\"{{{request.headers.Authorization.[1]}}}\",\"fullBody\":\"{{{escapejsonbody}}}\",\"url\":\"{{{request.url}}}\",\"paramIndex\":\"{{{request.query.foo.[1]}}}\"}", - "headers" : { - "Authorization" : "{{{request.headers.Authorization.[0]}}};foo" - }, - "transformers" : [ "response-template" ] - } -} ----- - -Sending a request such as the one presented in the `request` part of the contract results -in sending the following response body: - -[source,json,indent=0] ----- -{ - "url" : "/api/v1/xxxx?foo=bar&foo=bar2", - "path" : "/api/v1/xxxx", - "pathIndex" : "v1", - "param" : "bar", - "paramIndex" : "bar2", - "authorization" : "secret", - "authorization2" : "secret2", - "fullBody" : "{\"foo\":\"bar\",\"baz\":5}", - "responseFoo" : "bar", - "responseBaz" : 5, - "responseBaz2" : "Bla bla bar bla bla" -} ----- - -IMPORTANT: This feature works only with WireMock having a version greater than or equal -to 2.5.1. The Spring Cloud Contract Verifier uses WireMock's -`response-template` response transformer. It uses Handlebars to convert the Mustache `{{{ }}}` templates into -proper values. Additionally, it registers two helper functions: - -* `escapejsonbody`: Escapes the request body in a format that can be embedded in a JSON. -* `jsonpath`: For a given parameter, find an object in the request body. - -==== Registering Your Own WireMock Extension - -WireMock lets you register custom extensions. By default, Spring Cloud Contract registers -the transformer, which lets you reference a request from a response. If you want to -provide your own extensions, you can register an implementation of the -`org.springframework.cloud.contract.verifier.dsl.wiremock.WireMockExtensions` interface. -Since we use the spring.factories extension approach, you can create an entry in -`META-INF/spring.factories` file similar to the following: - -[source,groovy,indent=0] ----- -include::{stubrunner_core_path}/src/test/resources/META-INF/spring.factories[indent=0] ----- - -The following is an example of a custom extension: - -.TestWireMockExtensions.groovy -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/TestWireMockExtensions.groovy[indent=0] ----- - -IMPORTANT: Remember to override the `applyGlobally()` method and set it to `false` if you -want the transformation to be applied only for a mapping that explicitly requires it. - -[[contract-matchers]] -==== Dynamic Properties in the Matchers Sections - -If you work with https://docs.pact.io/[Pact], the following discussion may seem familiar. -Quite a few users are used to having a separation between the body and setting the -dynamic parts of a contract. - -You can use the `bodyMatchers` section for two reasons: - -* Define the dynamic values that should end up in a stub. -You can set it in the `request` or `inputMessage` part of your contract. -* Verify the result of your test. -This section is present in the `response` or `outputMessage` side of the -contract. - -Currently, Spring Cloud Contract Verifier supports only JSON Path-based matchers with the -following matching possibilities: - -.Groovy DSL - -* For the stubs(in tests on the Consumer's side): -** `byEquality()`: The value taken from the consumer's request via the provided JSON Path must be -equal to the value provided in the contract. -** `byRegex(...)`: The value taken from the consumer's request via the provided JSON Path must -match the regex. You can also pass the type of the expected matched value (e.g. `asString()`, `asLong()` etc.) -** `byDate()`: The value taken from the consumer's request via the provided JSON Path must -match the regex for an ISO Date value. -** `byTimestamp()`: The value taken from the consumer's request via the provided JSON Path must -match the regex for an ISO DateTime value. -** `byTime()`: The value taken from the consumer's request via the provided JSON Path must -match the regex for an ISO Time value. -* For the verification(in generated tests on the Producer's side): -** `byEquality()`: The value taken from the producer's response via the provided JSON Path must be -equal to the provided value in the contract. -** `byRegex(...)`: The value taken from the producer's response via the provided JSON Path must -match the regex. -** `byDate()`: The value taken from the producer's response via the provided JSON Path must match -the regex for an ISO Date value. -** `byTimestamp()`: The value taken from the producer's response via the provided JSON Path must -match the regex for an ISO DateTime value. -** `byTime()`: The value taken from the producer's response via the provided JSON Path must match -the regex for an ISO Time value. -** `byType()`: The value taken from the producer's response via the provided JSON Path needs to be -of the same type as the type defined in the body of the response in the contract. -`byType` can take a closure, in which you can set `minOccurrence` and `maxOccurrence`. For the request side, you should use the closure to assert size of the collection. -That way, you can assert the size of the flattened collection. To check the size of an -unflattened collection, use a custom method with the `byCommand(...)` testMatcher. -** `byCommand(...)`: The value taken from the producer's response via the provided JSON Path is -passed as an input to the custom method that you provide. For example, -`byCommand('foo($it)')` results in calling a `foo` method to which the value matching the -JSON Path gets passed. The type of the object read from the JSON can be one of the -following, depending on the JSON path: -*** `String`: If you point to a `String` value. -*** `JSONArray`: If you point to a `List`. -*** `Map`: If you point to a `Map`. -*** `Number`: If you point to `Integer`, `Double`, or other kind of number. -*** `Boolean`: If you point to a `Boolean`. -** `byNull()`: The value taken from the response via the provided JSON Path must be null - -.YAML - -_Please read the Groovy section for detailed explanation of -what the types mean_ - -For YAML the structure of a matcher looks like this - -[source,yml,indent=0] ----- -- path: $.foo - type: by_regex - value: bar - regexType: as_string ----- - -Or if you want to use one of the predefined regular expressions -`[only_alpha_unicode, number, any_boolean, ip_address, hostname, -email, url, uuid, iso_date, iso_date_time, iso_time, iso_8601_with_offset, non_empty, non_blank]`: - -[source,yml,indent=0] ----- -- path: $.foo - type: by_regex - predefined: only_alpha_unicode ----- - -Below you can find the allowed list of `type`s. - -* For `stubMatchers`: -** `by_equality` -** `by_regex` -** `by_date` -** `by_timestamp` -** `by_time` -** `by_type` -*** there are 2 additional fields accepted: `minOccurrence` and `maxOccurrence`. -* For `testMatchers`: -** `by_equality` -** `by_regex` -** `by_date` -** `by_timestamp` -** `by_time` -** `by_type` -*** there are 2 additional fields accepted: `minOccurrence` and `maxOccurrence`. -** `by_command` -** `by_null` - -You can also define which type the regular expression corresponds to via the `regexType` field. Below you can find the allowed list of regular expression types: - -* as_integer -* as_double -* as_float, -* as_long -* as_short -* as_boolean -* as_string - -Consider the following example: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcMethodBodyBuilderWithMatchersSpec.groovy[tags=matchers,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_matchers.yml[indent=0] ----- - -In the preceding example, you can see the dynamic portions of the contract in the -`matchers` sections. For the request part, you can see that, for all fields but -`valueWithoutAMatcher`, the values of the regular expressions that the stub should -contain are explicitly set. For the `valueWithoutAMatcher`, the verification takes place -in the same way as without the use of matchers. In that case, the test performs an -equality check. - -For the response side in the `bodyMatchers` section, we define the dynamic parts in a -similar manner. The only difference is that the `byType` matchers are also present. The -verifier engine checks four fields to verify whether the response from the test -has a value for which the JSON path matches the given field, is of the same type as the one -defined in the response body, and passes the following check (based on the method being called): - -* For `$.valueWithTypeMatch`, the engine checks whether the type is the same. -* For `$.valueWithMin`, the engine check the type and asserts whether the size is greater -than or equal to the minimum occurrence. -* For `$.valueWithMax`, the engine checks the type and asserts whether the size is -smaller than or equal to the maximum occurrence. -* For `$.valueWithMinMax`, the engine checks the type and asserts whether the size is -between the min and maximum occurrence. - -The resulting test would resemble the following example (note that an `and` section -separates the autogenerated assertions and the assertion from matchers): - -[source,java,indent=0] ----- - // given: - MockMvcRequestSpecification request = given() - .header("Content-Type", "application/json") - .body("{\"duck\":123,\"alpha\":\"abc\",\"number\":123,\"aBoolean\":true,\"date\":\"2017-01-01\",\"dateTime\":\"2017-01-01T01:23:45\",\"time\":\"01:02:34\",\"valueWithoutAMatcher\":\"foo\",\"valueWithTypeMatch\":\"string\",\"key\":{\"complex.key\":\"foo\"}}"); - - // when: - ResponseOptions response = given().spec(request) - .get("/get"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - assertThat(response.header("Content-Type")).matches("application/json.*"); - // and: - DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); - assertThatJson(parsedJson).field("['valueWithoutAMatcher']").isEqualTo("foo"); - // and: - assertThat(parsedJson.read("$.duck", String.class)).matches("[0-9]{3}"); - assertThat(parsedJson.read("$.duck", Integer.class)).isEqualTo(123); - assertThat(parsedJson.read("$.alpha", String.class)).matches("[\\p{L}]*"); - assertThat(parsedJson.read("$.alpha", String.class)).isEqualTo("abc"); - assertThat(parsedJson.read("$.number", String.class)).matches("-?(\\d*\\.\\d+|\\d+)"); - assertThat(parsedJson.read("$.aBoolean", String.class)).matches("(true|false)"); - assertThat(parsedJson.read("$.date", String.class)).matches("(\\d\\d\\d\\d)-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"); - assertThat(parsedJson.read("$.dateTime", String.class)).matches("([0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])"); - assertThat(parsedJson.read("$.time", String.class)).matches("(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])"); - assertThat((Object) parsedJson.read("$.valueWithTypeMatch")).isInstanceOf(java.lang.String.class); - assertThat((Object) parsedJson.read("$.valueWithMin")).isInstanceOf(java.util.List.class); - assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMin", java.util.Collection.class)).as("$.valueWithMin").hasSizeGreaterThanOrEqualTo(1); - assertThat((Object) parsedJson.read("$.valueWithMax")).isInstanceOf(java.util.List.class); - assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMax", java.util.Collection.class)).as("$.valueWithMax").hasSizeLessThanOrEqualTo(3); - assertThat((Object) parsedJson.read("$.valueWithMinMax")).isInstanceOf(java.util.List.class); - assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMinMax", java.util.Collection.class)).as("$.valueWithMinMax").hasSizeBetween(1, 3); - assertThat((Object) parsedJson.read("$.valueWithMinEmpty")).isInstanceOf(java.util.List.class); - assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMinEmpty", java.util.Collection.class)).as("$.valueWithMinEmpty").hasSizeGreaterThanOrEqualTo(0); - assertThat((Object) parsedJson.read("$.valueWithMaxEmpty")).isInstanceOf(java.util.List.class); - assertThat((java.lang.Iterable) parsedJson.read("$.valueWithMaxEmpty", java.util.Collection.class)).as("$.valueWithMaxEmpty").hasSizeLessThanOrEqualTo(0); - assertThatValueIsANumber(parsedJson.read("$.duck")); - assertThat(parsedJson.read("$.['key'].['complex.key']", String.class)).isEqualTo("foo"); ----- - -IMPORTANT: Notice that, for the `byCommand` method, the example calls the -`assertThatValueIsANumber`. This method must be defined in the test base class or be -statically imported to your tests. Notice that the `byCommand` call was converted to -`assertThatValueIsANumber(parsedJson.read("$.duck"));`. That means that the engine took -the method name and passed the proper JSON path as a parameter to it. - -The resulting WireMock stub is in the following example: - -[source,json,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy[tags=matchers,indent=0] ----- - -IMPORTANT: If you use a `matcher`, then the part of the request and response that the -`matcher` addresses with the JSON Path gets removed from the assertion. In the case of -verifying a collection, you must create matchers for *all* the elements of the -collection. - -Consider the following example: - -[source,groovy,indent=0] ----- -Contract.make { - request { - method 'GET' - url("/foo") - } - response { - status OK() - body(events: [[ - operation : 'EXPORT', - eventId : '16f1ed75-0bcc-4f0d-a04d-3121798faf99', - status : 'OK' - ], [ - operation : 'INPUT_PROCESSING', - eventId : '3bb4ac82-6652-462f-b6d1-75e424a0024a', - status : 'OK' - ] - ] - ) - bodyMatchers { - jsonPath('$.events[0].operation', byRegex('.+')) - jsonPath('$.events[0].eventId', byRegex('^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})$')) - jsonPath('$.events[0].status', byRegex('.+')) - } - } -} ----- - -The preceding code leads to creating the following test (the code block shows only the assertion section): - -[source,java,indent=0] ----- - and: - DocumentContext parsedJson = JsonPath.parse(response.body.asString()) - assertThatJson(parsedJson).array("['events']").contains("['eventId']").isEqualTo("16f1ed75-0bcc-4f0d-a04d-3121798faf99") - assertThatJson(parsedJson).array("['events']").contains("['operation']").isEqualTo("EXPORT") - assertThatJson(parsedJson).array("['events']").contains("['operation']").isEqualTo("INPUT_PROCESSING") - assertThatJson(parsedJson).array("['events']").contains("['eventId']").isEqualTo("3bb4ac82-6652-462f-b6d1-75e424a0024a") - assertThatJson(parsedJson).array("['events']").contains("['status']").isEqualTo("OK") - and: - assertThat(parsedJson.read("\$.events[0].operation", String.class)).matches(".+") - assertThat(parsedJson.read("\$.events[0].eventId", String.class)).matches("^([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12})\$") - assertThat(parsedJson.read("\$.events[0].status", String.class)).matches(".+") ----- - -As you can see, the assertion is malformed. Only the first element of the array got -asserted. In order to fix this, you should apply the assertion to the whole `$.events` -collection and assert it with the `byCommand(...)` method. - -=== JAX-RS Support - -The Spring Cloud Contract Verifier supports the JAX-RS 2 Client API. The base class needs -to define `protected WebTarget webTarget` and server initialization. The only option for -testing JAX-RS API is to start a web server. Also, a request with a body needs to have a -content type set. Otherwise, the default of `application/octet-stream` gets used. - -In order to use JAX-RS mode, use the following settings: - -[source,groovy,indent=0] ----- -testMode == 'JAXRSCLIENT' ----- - -The following example shows a generated test API: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientMethodBuilderSpec.groovy[tags=jaxrs,indent=0] ----- - -=== Async Support - -If you're using asynchronous communication on the server side (your controllers are -returning `Callable`, `DeferredResult`, and so on), then, inside your contract, you must -provide an `async()` method in the `response` section. The following code shows an example: - -.Groovy DSL -[source,groovy,indent=0] ----- -org.springframework.cloud.contract.spec.Contract.make { - request { - method GET() - url '/get' - } - response { - status OK() - body 'Passed' - async() - } -} ----- - -.YAML -[source,yml,indent=0] ----- -response: - async: true ----- - -You can also use the `fixedDelayMilliseconds` method / property to add delay to your stubs. - -.Groovy DSL -[source,groovy,indent=0] ----- -org.springframework.cloud.contract.spec.Contract.make { - request { - method GET() - url '/get' - } - response { - status 200 - body 'Passed' - fixedDelayMilliseconds 1000 - } -} ----- - -.YAML -[source,yml,indent=0] ----- -response: - fixedDelayMilliseconds: 1000 ----- - -=== Working with Context Paths - -Spring Cloud Contract supports context paths. - -IMPORTANT: The only change needed to fully support context paths is the switch on the -*PRODUCER* side. Also, the autogenerated tests must use *EXPLICIT* mode. The consumer -side remains untouched. In order for the generated test to pass, you must use *EXPLICIT* -mode. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - EXPLICIT - - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -contracts { - testMode = 'EXPLICIT' -} ----- - -That way, you generate a test that *DOES NOT* use MockMvc. It means that you generate -real requests and you need to setup your generated test's base class to work on a real -socket. - -Consider the following contract: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy[tags=context_path_contract,indent=0] ----- - -The following example shows how to set up a base class and Rest Assured: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy[tags=context_path_baseclass,indent=0] ----- - -If you do it this way: - -* All of your requests in the autogenerated tests are sent to the real endpoint with your -context path included (for example, `/my-context-path/url`). -* Your contracts reflect that you have a context path. Your generated stubs also have -that information (for example, in the stubs, you have to call `/my-context-path/url`). - -=== Working with WebFlux - -Spring Cloud Contract offers two ways of working with WebFlux. - -==== WebFlux with WebTestClient - -One of them is via the `WebTestClient` mode. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - WEBTESTCLIENT - - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -contracts { - testMode = 'WEBTESTCLIENT' -} ----- - -The following example shows how to set up a `WebTestClient` base class and `RestAssured` -for WebFlux: - -[source,groovy,indent=0] ----- -import io.restassured.module.webtestclient.RestAssuredWebTestClient; -import org.junit.Before; - -public abstract class BeerRestBase { - - @Before - public void setup() { - RestAssuredWebTestClient.standaloneSetup( - new ProducerController(personToCheck -> personToCheck.age >= 20)); - } -} -} ----- - -==== WebFlux with Explicit mode - -Another way is with the `EXPLICIT` mode in your generated tests -to work with WebFlux. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - EXPLICIT - - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -contracts { - testMode = 'EXPLICIT' -} ----- - -The following example shows how to set up a base class and Rest Assured for Web Flux: - -[source,groovy,indent=0] ----- -include::{samples_url}/producer_webflux/src/test/java/com/example/BeerRestBase.java[tags=annotations,indent=0] - - // your tests go here - - // in this config class you define all controllers and mocked services -include::{samples_url}/producer_webflux/src/test/java/com/example/BeerRestBase.java[tags=config,indent=0] - -} ----- - -=== XML Support for REST -For REST contracts, we also support XML request and response body. -The XML body has to be passed within the `body` element -as a `String` or `GString`. Also body matchers can be provided for -both request and response. In place of the `jsonPath(...)` method, the `org.springframework.cloud.contract.spec.internal.BodyMatchers.xPath` -method should be used, with the desired `xPath` provided as the first argument -and the appropriate `MatchingType` as second. All the body matchers apart from `byType()` are supported. - -Here is an example of a Groovy DSL contract with XML response body: - -[source,groovy,indent=0] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/XmlMethodBodyBuilderSpec.groovy[tags=xmlgroovy] ----- - -And below is an example of a YAML contract with XML request and response bodies: - -[source,yaml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_rest_xml.yml ----- - -Here is an example of an automatically generated test for XML response body: - -[source,java,indent=0] ----- -@Test -public void validate_xmlMatches() throws Exception { - // given: - MockMvcRequestSpecification request = given() - .header("Content-Type", "application/xml"); - - // when: - ResponseOptions response = given().spec(request).get("/get"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - // and: - DocumentBuilder documentBuilder = DocumentBuilderFactory.newInstance() - .newDocumentBuilder(); - Document parsedXml = documentBuilder.parse(new InputSource( - new StringReader(response.getBody().asString()))); - // and: - assertThat(valueFromXPath(parsedXml, "/test/list/elem/text()")).isEqualTo("abc"); - assertThat(valueFromXPath(parsedXml,"/test/list/elem[2]/text()")).isEqualTo("def"); - assertThat(valueFromXPath(parsedXml, "/test/duck/text()")).matches("[0-9]{3}"); - assertThat(nodeFromXPath(parsedXml, "/test/duck/xxx")).isNull(); - assertThat(valueFromXPath(parsedXml, "/test/alpha/text()")).matches("[\\p{L}]*"); - assertThat(valueFromXPath(parsedXml, "/test/*/complex/text()")).isEqualTo("foo"); - assertThat(valueFromXPath(parsedXml, "/test/duck/@type")).isEqualTo("xtype"); - } ----- - -=== Messaging Top-Level Elements - -The DSL for messaging looks a little bit different than the one that focuses on HTTP. The -following sections explain the differences: - -* <> -* <> -* <> -* <> - -[[contract-dsl-output-triggered-method]] -==== Output Triggered by a Method - -The output message can be triggered by calling a method (such as a `Scheduler` when a was -started and a message was sent), as shown in the following example: - -.Groovy DSL -[source,groovy] ----- -include::{tests_path}/samples-messaging-integration/src/test/groovy/com/example/IntegrationMessagingApplicationSpec.groovy[tags=method_trigger,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_message_method.yml[indent=0] ----- - -In the previous example case, the output message is sent to `output` if a method called -`bookReturnedTriggered` is executed. On the message *publisher's* side, we generate a -test that calls that method to trigger the message. On the *consumer* side, you can use -the `some_label` to trigger the message. - -[[contract-dsl-output-triggered-message]] -==== Output Triggered by a Message - -The output message can be triggered by receiving a message, as shown in the following -example: - -.Groovy DSL -[source,groovy] ----- -include::{tests_path}/samples-messaging-integration/src/test/groovy/com/example/IntegrationMessagingApplicationSpec.groovy[tags=message_trigger,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_message_input_message.yml[indent=0] ----- - -In the preceding example, the output message is sent to `output` if a proper message is -received on the `input` destination. On the message *publisher's* side, the engine -generates a test that sends the input message to the defined destination. On the -*consumer* side, you can either send a message to the input destination or use a label -(`some_label` in the example) to trigger the message. - -[[contract-dsl-consumer-producer]] -==== Consumer/Producer - -IMPORTANT: This section is valid only for Groovy DSL. - -In HTTP, you have a notion of `client`/`stub and `server`/`test` notation. You can also -use those paradigms in messaging. In addition, Spring Cloud Contract Verifier also -provides the `consumer` and `producer` methods, as presented in the following example -(note that you can use either `$` or `value` methods to provide `consumer` and `producer` -parts): - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=consumer_producer] ----- - -[[contract-dsl-common]] -==== Common - -In the `input` or `outputMessage` section you can call `assertThat` with the name -of a `method` (e.g. `assertThatMessageIsOnTheQueue()`) that you have defined in the -base class or in a static import. Spring Cloud Contract will execute that method -in the generated test. - -=== Multiple Contracts in One File - -You can define multiple contracts in one file. Such a contract might resemble the -following example: - -.Groovy DSL -[source,groovy,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-maven-plugin/src/test/projects/multiple-contracts/src/test/resources/contracts/com/hello/v1/WithList.groovy[lines=18..-1,indent=0] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/multiple_contracts.yml[indent=0] ----- - -In the preceding example, one contract has the `name` field and the other does not. This -leads to generation of two tests that look more or less like this: - -[source,java,indent=0] ----- -package org.springframework.cloud.contract.verifier.tests.com.hello; - -import com.example.TestBase; -import com.jayway.jsonpath.DocumentContext; -import com.jayway.jsonpath.JsonPath; -import com.jayway.restassured.module.mockmvc.specification.MockMvcRequestSpecification; -import com.jayway.restassured.response.ResponseOptions; -import org.junit.Test; - -import static com.jayway.restassured.module.mockmvc.RestAssuredMockMvc.*; -import static com.toomuchcoding.jsonassert.JsonAssertion.assertThatJson; -import static org.assertj.core.api.Assertions.assertThat; - -public class V1Test extends TestBase { - - @Test - public void validate_should_post_a_user() throws Exception { - // given: - MockMvcRequestSpecification request = given(); - - // when: - ResponseOptions response = given().spec(request) - .post("/users/1"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - } - - @Test - public void validate_withList_1() throws Exception { - // given: - MockMvcRequestSpecification request = given(); - - // when: - ResponseOptions response = given().spec(request) - .post("/users/2"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - } - -} ----- - -Notice that, for the contract that has the `name` field, the generated test method is named -`validate_should_post_a_user`. For the one that does not have the name, it is called -`validate_withList_1`. It corresponds to the name of the file `WithList.groovy` and the -index of the contract in the list. - -The generated stubs is shown in the following example: - -[source] ----- -should post a user.json -1_WithList.json ----- - -As you can see, the first file got the `name` parameter from the contract. The second -got the name of the contract file (`WithList.groovy`) prefixed with the index (in this -case, the contract had an index of `1` in the list of contracts in the file). - -TIP: As you can see, it is much better if you name your contracts because doing so makes -your tests far more meaningful. - -=== Generating Spring REST Docs snippets from the contracts - -When you want to include the requests and responses of your API using Spring REST Docs, -you only need to make some minor changes to your setup if you are using MockMvc and RestAssuredMockMvc. -Simply include the following dependencies if you haven't already. - -[source,xml,indent=0] -.Maven ----- -include::{standalone_restdocs_path}/http-server/pom.xml[tags=dependencies,indent=0] ----- - -[source,groovy,indent=0] -.Gradle ----- -include::{standalone_restdocs_path}/http-server/build.gradle[tags=dependencies,indent=0] ----- - -Next you need to make some changes to your base class like the following example. - -[source,java,indent=0] ----- -include::{standalone_restdocs_path}/http-server/src/test/java/com/example/fraud/FraudBaseWithWebAppSetup.java[tags=base_class,indent=0] ----- - -In case you are using the standalone setup, you can set up RestAssuredMockMvc like this: - -[source,java,indent=0] ----- -include::{standalone_restdocs_path}/http-server/src/test/java/com/example/fraud/FraudBaseWithStandaloneSetup.java[tags=base_class,indent=0] ----- - -TIP: You don't need to specify the output directory for the generated snippets since version 1.2.0.RELEASE of Spring REST Docs. - -== Customization - -IMPORTANT: This section is valid only for Groovy DSL - -You can customize the Spring Cloud Contract Verifier by extending the DSL, as shown in -the remainder of this section. - -=== Extending the DSL - -You can provide your own functions to the DSL. The key requirement for this feature is to -maintain the static compatibility. Later in this document, you can see examples of: - -* Creating a JAR with reusable classes. -* Referencing of these classes in the DSLs. - -You can find the full example -https://github.com/spring-cloud-samples/spring-cloud-contract-samples[here]. - -==== Common JAR - -The following examples show three classes that can be reused in the DSLs. - -*PatternUtils* contains functions used by both the **consumer** and the **producer**. - -[source,java] ----- -include::{samples_url}/common/src/main/java/com/example/PatternUtils.java[] ----- - -*ConsumerUtils* contains functions used by the **consumer**. - -[source,java] ----- -include::{samples_url}/common/src/main/java/com/example/ConsumerUtils.java[] ----- - -*ProducerUtils* contains functions used by the **producer**. - -[source,java] ----- -include::{samples_url}/common/src/main/java/com/example/ProducerUtils.java[] ----- - -==== Adding the Dependency to the Project - -In order for the plugins and IDE to be able to reference the common JAR classes, you need -to pass the dependency to your project. - -// TODO missing code block here - we should show an example adding a dependency - -==== Test the Dependency in the Project's Dependencies - -First, add the common jar dependency as a test dependency. Because your contracts files -are available on the test resources path, the common jar classes automatically become -visible in your Groovy files. The following examples show how to test the dependency: - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- -include::{samples_url}/producer/pom.xml[tags=test_dep,indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{samples_url}/producer/build.gradle[tags=test_dep,indent=0] ----- - -==== Test a Dependency in the Plugin's Dependencies - -Now, you must add the dependency for the plugin to reuse at runtime, as shown in the -following example: - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- -include::{samples_url}/producer/pom.xml[tags=test_dep_in_plugin,indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{samples_url}/producer/build.gradle[tags=test_dep_in_plugin,indent=0] ----- - -==== Referencing classes in DSLs - -You can now reference your classes in your DSL, as shown in the following example: - -[source,groovy] ----- -include::{samples_url}/producer/src/test/resources/contracts/beer/rest/shouldGrantABeerIfOldEnough.groovy[indent=0] ----- - -IMPORTANT: You can set the Spring Cloud Contract plugin up by setting `convertToYaml` to `true`. That way you will NOT have to add the dependency with the extended functionality to the consumer side, since the consumer side will be using YAML contracts instead of Groovy ones. - -== Using the Pluggable Architecture - -You may encounter cases where you have your contracts have been defined in other formats, -such as YAML, RAML or PACT. In those cases, you still want to benefit from the automatic -generation of tests and stubs. You can add your own implementation for generating both -tests and stubs. Also, you can customize the way tests are generated (for example, you -can generate tests for other languages) and the way stubs are generated (for example, you -can generate stubs for other HTTP server implementations). - -=== Custom Contract Converter - -The `ContractConverter` interface lets you register your own implementation of a contract -structure converter. The following code listing shows the `ContractConverter` interface: - -[source,java] ----- -include::{contract_spec_path}/src/main/java/org/springframework/cloud/contract/spec/ContractConverter.java[indent=0,lines=17..-1] ----- - -Your implementation must define the condition on which it should start the -conversion. Also, you must define how to perform that conversion in both directions. - -IMPORTANT: Once you create your implementation, you must create a -`/META-INF/spring.factories` file in which you provide the fully qualified name of your -implementation. - -The following example shows a typical `spring.factories` file: - -[source] ----- -org.springframework.cloud.contract.spec.ContractConverter=\ -org.springframework.cloud.contract.verifier.converter.YamlContractConverter ----- - -[[pact-converter]] -==== Pact Converter - -Spring Cloud Contract includes support for https://docs.pact.io/[Pact] representation of -contracts up until v4. Instead of using the Groovy DSL, you can use Pact files. In this section, we -present how to add Pact support for your project. Note however that not all functionality is supported. -Starting with v3 you can combine multiple matcher for the same element; -you can use matchers for the body, headers, request and path; and you can use value generators. -Spring Cloud Contract currently only supports multiple matchers that are combined using the AND rule logic. -Next to that the request and path matchers are skipped during the conversion. -When using a date, time or datetime value generator with a given format, -the given format will be skipped and the ISO format will be used. - -In order to properly support the Spring Cloud Contract way of doing messaging -with Pact you'll have to provide some additional meta data entries. Below you can find a list of such entries: - -- to define the destination to which a message gets sent, you have to -set a `metaData` entry in the Pact file, with key `sentTo` equal to the destination to which a message is to be sent. E.g. `"metaData": { "sentTo": "activemq:output" }` - -==== Pact Contract - -Consider following example of a Pact contract, which is a file under the -`src/test/resources/contracts` folder. - -[source,javascript,indent=0] ----- -include::{standalone_pact_path}/pact-http-server/src/test/resources/contracts/fraud/shouldMarkClientAsFraud.json[indent=0] ----- - -The remainder of this section about using Pact refers to the preceding file. - -==== Pact for Producers - -On the producer side, you must add two additional dependencies to your plugin -configuration. One is the Spring Cloud Contract Pact support, and the other represents -the current Pact version that you use. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- -include::{standalone_pact_path}/pact-http-server/pom.xml[tags=pact_dependency,indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{standalone_pact_path}/pact-http-server/build.gradle[tags=pact_dependency,indent=0] ----- - -When you execute the build of your application, a test will be generated. The generated -test might be as follows: - -[source,java,indent=0] ----- - @Test - public void validate_shouldMarkClientAsFraud() throws Exception { - // given: - MockMvcRequestSpecification request = given() - .header("Content-Type", "application/vnd.fraud.v1+json") - .body("{\"clientId\":\"1234567890\",\"loanAmount\":99999}"); - - // when: - ResponseOptions response = given().spec(request) - .put("/fraudcheck"); - - // then: - assertThat(response.statusCode()).isEqualTo(200); - assertThat(response.header("Content-Type")).matches("application/vnd\\.fraud\\.v1\\+json.*"); - // and: - DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); - assertThatJson(parsedJson).field("['rejectionReason']").isEqualTo("Amount too high"); - // and: - assertThat(parsedJson.read("$.fraudCheckStatus", String.class)).matches("FRAUD"); - } ----- - -The corresponding generated stub might be as follows: - -[source,javascript,indent=0] ----- -{ - "id" : "996ae5ae-6834-4db6-8fac-358ca187ab62", - "uuid" : "996ae5ae-6834-4db6-8fac-358ca187ab62", - "request" : { - "url" : "/fraudcheck", - "method" : "PUT", - "headers" : { - "Content-Type" : { - "matches" : "application/vnd\\.fraud\\.v1\\+json.*" - } - }, - "bodyPatterns" : [ { - "matchesJsonPath" : "$[?(@.['loanAmount'] == 99999)]" - }, { - "matchesJsonPath" : "$[?(@.clientId =~ /([0-9]{10})/)]" - } ] - }, - "response" : { - "status" : 200, - "body" : "{\"fraudCheckStatus\":\"FRAUD\",\"rejectionReason\":\"Amount too high\"}", - "headers" : { - "Content-Type" : "application/vnd.fraud.v1+json;charset=UTF-8" - }, - "transformers" : [ "response-template" ] - }, -} ----- - -==== Pact for Consumers - -On the producer side, you must add two additional dependencies to your project -dependencies. One is the Spring Cloud Contract Pact support, and the other represents the -current Pact version that you use. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- -include::{standalone_pact_path}/pact-http-client/pom.xml[tags=pact_dependency,indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{standalone_pact_path}/pact-http-client/build.gradle[tags=pact_dependency,indent=0] ----- - -=== Using the Custom Test Generator - -If you want to generate tests for languages other than Java or you are not happy with the -way the verifier builds Java tests, you can register your own implementation. - -The `SingleTestGenerator` interface lets you register your own implementation. The -following code listing shows the `SingleTestGenerator` interface: - -[source,groovy] ----- -include::{verifier_core_path}/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGenerator.java[indent=0,lines=17..-1] ----- - -Again, you must provide a `spring.factories` file, such as the one shown in the following -example: - -[source] ----- -org.springframework.cloud.contract.verifier.builder.SingleTestGenerator=/ -com.example.MyGenerator ----- - -=== Using the Custom Stub Generator - -If you want to generate stubs for stub servers other than WireMock, you can plug in your -own implementation of the `StubGenerator` interface. The following code listing shows the -`StubGenerator` interface: - -[source,groovy] ----- -include::{converters_path}/src/main/groovy/org/springframework/cloud/contract/verifier/converter/StubGenerator.java[indent=0,lines=16..-1] ----- - -Again, you must provide a `spring.factories` file, such as the one shown in the following -example: - -[source] ----- -include::{converters_path}/src/main/resources/META-INF/spring.factories[indent=0] ----- - -The default implementation is the WireMock stub generation. - -TIP: You can provide multiple stub generator implementations. For example, from a single -DSL, you can produce both WireMock stubs and Pact files. - -=== Using the Custom Stub Runner - -If you decide to use a custom stub generation, you also need a custom way of running -stubs with your different stub provider. - -Assume that you use https://github.com/dreamhead/moco[Moco] to build your stubs and that -you have written a stub generator and placed your stubs in a JAR file. - -In order for Stub Runner to know how to run your stubs, you have to define a custom -HTTP Stub server implementation, which might resemble the following example: - -[source,groovy] ----- -include::{tests_path}/spring-cloud-contract-stub-runner-moco/src/test/groovy/org/springframework/cloud/contract/stubrunner/provider/moco/MocoHttpServerStub.groovy[indent=0,lines=16..-1] ----- - -Then, you can register it in your `spring.factories` file, as shown in the following -example: - -[source] ----- -org.springframework.cloud.contract.stubrunner.HttpServerStub=\ -org.springframework.cloud.contract.stubrunner.provider.moco.MocoHttpServerStub ----- - -Now you can run stubs with Moco. - -IMPORTANT: If you do not provide any implementation, then the default (WireMock) -implementation is used. If you provide more than one, the first one on the list is used. - -=== Using the Custom Stub Downloader - -You can customize the way your stubs are downloaded by creating an implementation of the -`StubDownloaderBuilder` interface, as shown in the following example: - -[source,java] ----- -package com.example; - -class CustomStubDownloaderBuilder implements StubDownloaderBuilder { - - @Override - public StubDownloader build(final StubRunnerOptions stubRunnerOptions) { - return new StubDownloader() { - @Override - public Map.Entry downloadAndUnpackStubJar( - StubConfiguration config) { - File unpackedStubs = retrieveStubs(); - return new AbstractMap.SimpleEntry<>( - new StubConfiguration(config.getGroupId(), config.getArtifactId(), version, - config.getClassifier()), unpackedStubs); - } - - File retrieveStubs() { - // here goes your custom logic to provide a folder where all the stubs reside - } -} ----- - -Then you can register it in your `spring.factories` file, as shown in the following -example: - -[source] ----- -# Example of a custom Stub Downloader Provider -org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder=\ -com.example.CustomStubDownloaderBuilder ----- - -Now you can pick a folder with the source of your stubs. - -IMPORTANT: If you do not provide any implementation, then the default is used (scan classpath). -If you provide the `stubsMode = StubRunnerProperties.StubsMode.LOCAL` or -`, stubsMode = StubRunnerProperties.StubsMode.REMOTE` then the Aether implementation will be used -If you provide more than one, then the first one on the list is used. - -[[scm-stub-downloader]] -=== Using the SCM Stub Downloader - -Whenever the `repositoryRoot` starts with a SCM protocol -(currently we support only `git://`), the stub downloader will try -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 - -.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` -|=== - -[[pact-stub-downloader]] -=== 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 - -.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 -|=== diff --git a/docs/src/main/asciidoc/verifier_faq.adoc b/docs/src/main/asciidoc/verifier_faq.adoc deleted file mode 100644 index f379e662ed..0000000000 --- a/docs/src/main/asciidoc/verifier_faq.adoc +++ /dev/null @@ -1,913 +0,0 @@ -:branch: master -:introduction_url: https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch} -:samples_branch: 2.2.x - -== Spring Cloud Contract FAQ - -=== Why use Spring Cloud Contract Verifier and not X ? - -For the time being Spring Cloud Contract is a JVM based tool. So it could be your first pick when you're already creating -software for the JVM. This project has a lot of really interesting features but especially quite a few of them definitely make -Spring Cloud Contract Verifier stand out on the "market" of Consumer Driven Contract (CDC) tooling. Out of many the most interesting are: - -- Possibility to do CDC with messaging -- Clear and easy to use, statically typed DSL -- Possibility to copy paste your current JSON file to the contract and only edit its elements -- Automatic generation of tests from the defined Contract -- Stub Runner functionality - the stubs are automatically downloaded at runtime from Nexus / Artifactory -- Spring Cloud integration - no discovery service is needed for integration tests -- Spring Cloud Contract integrates with Pact out of the box and provides easy hooks to extend its functionality -- Via Docker adds support for any language & framework used - -=== I don't want to write a contract in Groovy! - -No problem. You can write a contract in YAML! - -=== What is this value(consumer(), producer()) ? - -One of the biggest challenges related to stubs is their reusability. Only if they can be vastly used, will they serve their purpose. -What typically makes that difficult are the hard-coded values of request / response elements. For example dates or ids. -Imagine the following JSON request - -[source,json,indent=0] ----- -{ - "time" : "2016-10-10 20:10:15", - "id" : "9febab1c-6f36-4a0b-88d6-3b6a6d81cd4a", - "body" : "foo" -} ----- - -and JSON response - -[source,json,indent=0] ----- -{ - "time" : "2016-10-10 21:10:15", - "id" : "c4231e1f-3ca9-48d3-b7e7-567d55f0d051", - "body" : "bar" -} ----- - -Imagine the pain required to set proper value of the `time` field (let's assume that this content is generated by the -database) by changing the clock in the system or providing stub implementations of data providers. The same is related -to the field called `id`. Will you create a stubbed implementation of UUID generator? Makes little sense... - -So as a consumer you would like to send a request that matches any form of a time or any UUID. That way your system -will work as usual - will generate data and you won't have to stub anything out. Let's assume that in case of the aforementioned -JSON the most important part is the `body` field. You can focus on that and provide matching for other fields. In other words -you would like the stub to work like this: - -[source,json,indent=0] ----- -{ - "time" : "SOMETHING THAT MATCHES TIME", - "id" : "SOMETHING THAT MATCHES UUID", - "body" : "foo" -} ----- - -As far as the response goes as a consumer you need a concrete value that you can operate on. So such a JSON is valid - -[source,json,indent=0] ----- -{ - "time" : "2016-10-10 21:10:15", - "id" : "c4231e1f-3ca9-48d3-b7e7-567d55f0d051", - "body" : "bar" -} ----- - -As you could see in the previous sections we generate tests from contracts. So from the producer's side the situation looks -much different. We're parsing the provided contract and in the test we want to send a real request to your endpoints. -So for the case of a producer for the request we can't have any sort of matching. We need concrete values that the -producer's backend can work on. Such a JSON would be a valid one: - -[source,json,indent=0] ----- -{ - "time" : "2016-10-10 20:10:15", - "id" : "9febab1c-6f36-4a0b-88d6-3b6a6d81cd4a", - "body" : "foo" -} ----- - -On the other hand from the point of view of the validity of the contract the response doesn't necessarily have to -contain concrete values of `time` or `id`. Let's say that you generate those on the producer side - again, you'd -have to do a lot of stubbing to ensure that you always return the same values. That's why from the producer's side -what you might want is the following response: - -[source,json,indent=0] ----- -{ - "time" : "SOMETHING THAT MATCHES TIME", - "id" : "SOMETHING THAT MATCHES UUID", - "body" : "bar" -} ----- - -How can you then provide one time a matcher for the consumer and a concrete value for the producer and vice versa? -In Spring Cloud Contract we're allowing you to provide a *dynamic value*. That means that it can differ for both -sides of the communication. You can pass the values: - -Either via the `value` method - -[source,groovy,indent=0] ----- -value(consumer(...), producer(...)) -value(stub(...), test(...)) -value(client(...), server(...)) ----- - -or using the `$()` method - -[source,groovy,indent=0] ----- -$(consumer(...), producer(...)) -$(stub(...), test(...)) -$(client(...), server(...)) ----- - -You can read more about this in the <> section. - -Calling `value()` or `$()` tells Spring Cloud Contract that you will be passing a dynamic value. -Inside the `consumer()` method you pass the value that should be used on the consumer side (in the generated stub). -Inside the `producer()` method you pass the value that should be used on the producer side (in the generated test). - -TIP: If on one side you have passed the regular expression and you haven't passed the other, then the -other side will get auto-generated. - -Most often you will use that method together with the `regex` helper method. E.g. `consumer(regex('[0-9]{10}'))`. - -To sum it up the contract for the aforementioned scenario would look more or less like this (the regular expression -for time and UUID are simplified and most likely invalid but we want to keep things very simple in this example): - -[source,groovy,indent=0] ----- -org.springframework.cloud.contract.spec.Contract.make { - request { - method 'GET' - url '/someUrl' - body([ - time : value(consumer(regex('[0-9]{4}-[0-9]{2}-[0-9]{2} [0-2][0-9]-[0-5][0-9]-[0-5][0-9]')), - id: value(consumer(regex('[0-9a-zA-z]{8}-[0-9a-zA-z]{4}-[0-9a-zA-z]{4}-[0-9a-zA-z]{12}')) - body: "foo" - ]) - } - response { - status OK() - body([ - time : value(producer(regex('[0-9]{4}-[0-9]{2}-[0-9]{2} [0-2][0-9]-[0-5][0-9]-[0-5][0-9]')), - id: value([producer(regex('[0-9a-zA-z]{8}-[0-9a-zA-z]{4}-[0-9a-zA-z]{4}-[0-9a-zA-z]{12}')) - body: "bar" - ]) - } -} ----- - -IMPORTANT: Please read the https://groovy-lang.org/json.html[Groovy docs related to JSON] to understand how to -properly structure the request / response bodies. - -=== How to do Stubs versioning? - -==== API Versioning - -Let's try to answer a question what versioning really means. If you're referring to the API version then there are -different approaches. - -- use Hypermedia, links and do not version your API by any means -- pass versions through headers / urls - -I will not try to answer a question which approach is better. Whatever suits your needs and allows you to generate -business value should be picked. - -Let's assume that you do version your API. In that case you should provide as many contracts as many versions you support. -You can create a subfolder for every version or append it to the contract name - whatever suits you more. - -==== JAR versioning - -If by versioning you mean the version of the JAR that contains the stubs then there are essentially two main approaches. - -Let's assume that you're doing Continuous Delivery / Deployment which means that you're generating a new version of -the jar each time you go through the pipeline and that jar can go to production at any time. For example your jar version -looks like this (it got built on the 20.10.2016 at 20:15:21) : - -[source,groovy,indent=0] ----- -1.0.0.20161020-201521-RELEASE ----- - -In that case your generated stub jar will look like this. - -[source,groovy,indent=0] ----- -1.0.0.20161020-201521-RELEASE-stubs.jar ----- - -In this case you should inside your `application.yml` or `@AutoConfigureStubRunner` when referencing stubs provide the - latest version of the stubs. You can do that by passing the `+` sign. Example - -[source,java,indent=0] ----- -@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:stubs:8080"}) ----- - -If the versioning however is fixed (e.g. `1.0.4.RELEASE` or `2.1.1`) then you have to set the concrete value of the jar -version. Example for 2.1.1. - -[source,java,indent=0] ----- -@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:2.1.1:stubs:8080"}) ----- - -==== Dev or prod stubs - -You can manipulate the classifier to run the tests against current development version of the stubs of other services - or the ones that were deployed to production. If you alter your build to deploy the stubs with the `prod-stubs` classifier - once you reach production deployment then you can run tests in one case with dev stubs and one with prod stubs. - -Example of tests using development version of stubs - -[source,java,indent=0] ----- -@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:stubs:8080"}) ----- - -Example of tests using production version of stubs - -[source,java,indent=0] ----- -@AutoConfigureStubRunner(ids = {"com.example:http-server-dsl:+:prod-stubs:8080"}) ----- - -You can pass those values also via properties from your deployment pipeline. - -=== Common repo with contracts - -Another way of storing contracts other than having them with the producer is keeping them in a common place. -It can be related to security issues where the consumers can't clone the producer's code. Also if you keep -contracts in a single place then you, as a producer, will know how many consumers you have and which -consumer you will break with your local changes. - -==== Repo structure - -Let's assume that we have a producer with coordinates `com.example:server` and 3 consumers: `client1`, -`client2`, `client3`. Then in the repository with common contracts you would have the following setup -(which you can checkout https://github.com/spring-cloud/spring-cloud-contract/tree/{branch}/samples/standalone/contracts[here]): - -[source,bash,indent=0] ----- -├── com -│   └── example -│   └── server -│   ├── client1 -│   │   └── expectation.groovy -│   ├── client2 -│   │   └── expectation.groovy -│   ├── client3 -│   │   └── expectation.groovy -│   └── pom.xml -├── mvnw -├── mvnw.cmd -├── pom.xml -└── src - └── assembly - └── contracts.xml ----- - -As you can see under the slash-delimited groupid `/` artifact id folder (`com/example/server`) you have -expectations of the 3 consumers (`client1`, `client2` and `client3`). Expectations are the standard Groovy DSL -contract files as described throughout this documentation. This repository has to produce a JAR file that maps -one to one to the contents of the repo. - -Example of a `pom.xml` inside the `server` folder. - -[source,xml,indent=0] ----- -include::{introduction_url}/samples/standalone/contracts/com/example/server/pom.xml[indent=0] ----- - -As you can see there are no dependencies other than the Spring Cloud Contract Maven Plugin. -Those poms are necessary for the consumer side to run `mvn clean install -DskipTests` to locally install - stubs of the producer project. - -The `pom.xml` in the root folder can look like this: - -[source,xml,indent=0] ----- -include::{introduction_url}/samples/standalone/contracts/pom.xml[indent=0] ----- - -It's using the assembly plugin in order to build the JAR with all the contracts. Example of such setup is here: - -[source,xml,indent=0] ----- -include::{introduction_url}/samples/standalone/contracts/src/assembly/contracts.xml[indent=0] ----- - -==== Workflow - -The workflow would look similar to the one presented in the `Step by step guide to CDC`. The only difference - is that the producer doesn't own the contracts anymore. So the consumer and the producer have to work on - common contracts in a common repository. - -==== Consumer - -When the *consumer* wants to work on the contracts offline, instead of cloning the producer code, the -consumer team clones the common repository, goes to the required producer's folder (e.g. `com/example/server`) -and runs `mvn clean install -DskipTests` to install locally the stubs converted from the contracts. - -TIP: You need to have https://maven.apache.org/download.cgi[Maven installed locally] - -==== Producer - -As a *producer* it's enough to alter the Spring Cloud Contract Verifier to provide the URL and the dependency -of the JAR containing the contracts: - -[source,xml,indent=0] ----- -include::{introduction_url}/spring-cloud-contract-tools/spring-cloud-contract-maven-plugin/src/test/projects/basic-remote-contracts/pom-with-repo.xml[tags=remote_config,indent=0] ----- - -With this setup the JAR with groupid `com.example.standalone` and artifactid `contracts` will be downloaded -from `https://link/to/your/nexus/or/artifactory/or/sth`. It will be then unpacked in a local temporary folder -and contracts present under the `com/example/server` will be picked as the ones used to generate the -tests and the stubs. Due to this convention the producer team will know which consumer teams will be broken -when some incompatible changes are done. - -The rest of the flow looks the same. - -==== How can I define messaging contracts per topic not per producer? - -To avoid messaging contracts duplication in the common repo, when few producers writing messages to one topic, -we could create the structure when the rest contracts would be placed in a folder per producer and messaging -contracts in the folder per topic. - -===== For Maven Project - -To make it possible to work on the producer side we should specify an inclusion pattern for -filtering common repository jar by messaging topics we are interested in. ```includedFiles``` property of ```Maven Spring Cloud Contract plugin``` -allows us to do that. Also ```contractsPath``` need to be specified since the default path would be the common repository ```groupid/artifactid```. - - -[source,xml,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - - REMOTE - https://link/to/your/nexus/or/artifactory/or/sth - - com.example - common-repo-with-contracts - + - - / - - - .*messaging.* - com.example.services.MessagingBase - - - .*rest.* - com.example.services.TestBase - - - - **/${project.artifactId}/** - **/${first-topic}/** - **/${second-topic}/** - - - ----- - -===== For Gradle Project - -- Add a custom configuration for the common-repo dependency: - -[source,groovy,indent=0] ----- -ext { - conractsGroupId = "com.example" - contractsArtifactId = "common-repo" - contractsVersion = "1.2.3" -} - -configurations { - contracts { - transitive = false - } -} ----- - -- Add the common-repo dependency to your classpath: - -[source,groovy,indent=0] ----- -dependencies { - contracts "${conractsGroupId}:${contractsArtifactId}:${contractsVersion}" - testCompile "${conractsGroupId}:${contractsArtifactId}:${contractsVersion}" -} ----- - -- Download the dependency to an appropriate folder: - -[source,groovy,indent=0] ----- -task getContracts(type: Copy) { - from configurations.contracts - into new File(project.buildDir, "downloadedContracts") -} ----- - -- Unzip JAR: - -[source,groovy,indent=0] ----- -task unzipContracts(type: Copy) { - def zipFile = new File(project.buildDir, "downloadedContracts/${contractsArtifactId}-${contractsVersion}.jar") - def outputDir = file("${buildDir}/unpackedContracts") - - from zipTree(zipFile) - into outputDir -} ----- - -- Cleanup unused contracts: - -[source,groovy,indent=0] ----- -task deleteUnwantedContracts(type: Delete) { - delete fileTree(dir: "${buildDir}/unpackedContracts", - include: "**/*", - excludes: [ - "**/${project.name}/**"", - "**/${first-topic}/**", - "**/${second-topic}/**"]) -} ----- - -- Create task dependencies: - -[source,groovy,indent=0] ----- -unzipContracts.dependsOn("getContracts") -deleteUnwantedContracts.dependsOn("unzipContracts") -build.dependsOn("deleteUnwantedContracts") ----- - -- Configure plugin by specifying the directory containing contracts using `contractsDslDir` property - -[source,groovy,indent=0] ----- -contracts { - contractsDslDir = new File("${buildDir}/unpackedContracts") -} ----- - -=== Do I need a Binary Storage? Can't I use Git? - -In the polyglot world, there are languages that don't use binary storages like -Artifactory or Nexus. Starting from Spring Cloud Contract version 2.0.0 we provide -mechanisms to store contracts and stubs in a SCM repository. Currently the -only supported SCM is Git. - -The repository would have to the following setup -(which you can checkout https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/contracts_git/[here]): - -[source,indent=0] ----- -. -└── META-INF - └── com.example - └── beer-api-producer-git - └── 0.0.1-SNAPSHOT - ├── contracts - │   └── beer-api-consumer - │   ├── messaging - │   │   ├── shouldSendAcceptedVerification.groovy - │   │   └── shouldSendRejectedVerification.groovy - │   └── rest - │   ├── shouldGrantABeerIfOldEnough.groovy - │   └── shouldRejectABeerIfTooYoung.groovy - └── mappings - └── beer-api-consumer - └── rest - ├── shouldGrantABeerIfOldEnough.json - └── shouldRejectABeerIfTooYoung.json ----- - -Under `META-INF` folder: - -* we group applications via `groupId` (e.g. `com.example`) -* then each application is represented via the `artifactId` (e.g. `beer-api-producer-git`) -* next, the version of the application (e.g. `0.0.1-SNAPSHOT`). Starting from Spring Cloud Contract version `2.1.0`, you can specify the versions as follows (assuming that your versions follow the semantic versioning) -** `+` or `latest` - to find the latest version of your stubs (assuming that the snapshots are always the latest artifact for a given revision number). That means: -*** if you have a version `1.0.0.RELEASE`, `2.0.0.BUILD-SNAPSHOT` and `2.0.0.RELEASE` we will assume that the latest is `2.0.0.BUILD-SNAPSHOT` -*** if you have a version `1.0.0.RELEASE` and `2.0.0.RELEASE` we will assume that the latest is `2.0.0.RELEASE` -*** if you have a version called `latest` or `+` we will pick that folder -** `release` - to find the latest release version of your stubs. That means: -*** if you have a version `1.0.0.RELEASE`, `2.0.0.BUILD-SNAPSHOT` and `2.0.0.RELEASE` we will assume that the latest is `2.0.0.RELEASE` -*** if you have a version called `release` we will pick that folder -* finally, there are two folders: -** `contracts` - the good practice is to store the contracts required by each -consumer in the folder with the consumer name (e.g. `beer-api-consumer`). That way you -can use the `stubs-per-consumer` feature. Further directory structure is arbitrary. -** `mappings` - in this folder the Maven / Gradle Spring Cloud Contract plugins will push -the stub server mappings. On the consumer side, Stub Runner will scan this folder -to start stub servers with stub definitions. The folder structure will be a copy -of the one created in the `contracts` subfolder. - -==== Protocol convention - -In order to control the type and location of the source of contracts (whether it's -a binary storage or an SCM repository), you can use the protocol in the URL of -the repository. Spring Cloud Contract iterates over registered protocol resolvers -and tries to fetch the contracts (via a plugin) or stubs (via Stub Runner). - -For the SCM functionality, currently, we support the Git repository. To use it, -in the property, where the repository URL needs to be placed you just have to prefix -the connection URL with `git://`. Here you can find a couple of examples: - -[source,indent=0] ----- -git://file:///foo/bar -git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git -git://git@github.com:spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git ----- - -==== Producer - -For the producer, to use the SCM approach, we can reuse the -same mechanism we use for external contracts. We route Spring Cloud Contract -to use the SCM implementation via the URL that contains -the `git://` protocol. - -IMPORTANT: You have to manually add the `pushStubsToScm` -goal in Maven or execute (bind) the `pushStubsToScm` task in -Gradle. We don't push stubs to `origin` of your git -repository out of the box. - -.Maven -[source,xml,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - - - - git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git - - - - ${project.groupId} - ${project.artifactId} - ${project.version} - - - - REMOTE - - - - package - - - pushStubsToScm - - - - ----- - -.Gradle -[source,gradle,indent=0] ----- -contracts { - // We want to pick contracts from a Git repository - contractDependency { - stringNotation = "${project.group}:${project.name}:${project.version}" - } - /* - We reuse the contract dependency section to set up the path - to the folder that contains the contract definitions. In our case the - path will be /groupId/artifactId/version/contracts - */ - contractRepository { - repositoryUrl = "git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git" - } - // The mode can't be classpath - contractsMode = "REMOTE" - // Base class mappings etc. -} - -/* -In this scenario we want to publish stubs to SCM whenever -the `publish` task is executed -*/ -publish.dependsOn("publishStubsToScm") ----- - -With such a setup: - -* Git project will be cloned to a temporary directory -* The SCM stub downloader will go to `META-INF/groupId/artifactId/version/contracts` folder -to find contracts. E.g. for `com.example:foo:1.0.0` the path would be -`META-INF/com.example/foo/1.0.0/contracts` -* Tests will be generated from the contracts -* Stubs will be created from the contracts -* Once the tests pass, the stubs will be committed in the cloned repository -* Finally, a push will be done to that repo's `origin` - -==== Producer with contracts stored locally - -Another option to use the SCM as the destination for stubs and contracts is to store the contracts locally, with the producer, and only push the contracts and the stubs to SCM. Below, you can find the setup required to achieve this using Maven and Gradle. - -.Maven -[source,xml,indent=0] ----- -include::{samples_url}/producer_with_empty_git/pom.xml[tags=plugin,indent=0] ----- - -.Gradle -[source,xml,indent=0] ----- -include::{samples_url}/producer_with_empty_git/build.gradle[tags=plugin,indent=0] ----- - -With such a setup: - -* Contracts from the default `src/test/resources/contracts` directory will be picked -* Tests will be generated from the contracts -* Stubs will be created from the contracts -* Once the tests pass -** Git project will be cloned to a temporary directory -** The stubs and contracts will be committed in the cloned repository -* Finally, a push will be done to that repo's `origin` - -===== Keeping contracts with the producer and stubs in an external repository - -It is also possible to keep the contracts in the producer repository, but keep the stubs in an external git repo. -This is most useful when you want to use the base consumer-producer collaboration flow, but do not have a possibility to -use an artifact repository for storing the stubs. - -In order to do that, use the usual producer setup, and then add the `pushStubsToScm` goal and set -`contractsRepositoryUrl` to the repository where you want to keep the stubs. - -==== Consumer - -On the consumer side when passing the `repositoryRoot` parameter, -either from the `@AutoConfigureStubRunner` annotation, the -JUnit rule, JUnit 5 extension or properties, it's enough to pass the URL of the -SCM repository, prefixed with the protocol. For example - -[source,java,indent=0] ----- -@AutoConfigureStubRunner( - stubsMode="REMOTE", - repositoryRoot="git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git", - ids="com.example:bookstore:0.0.1.RELEASE" -) ----- - -With such a setup: - -* Git project will be cloned to a temporary directory -* The SCM stub downloader will go to `META-INF/groupId/artifactId/version/` folder -to find stub definitions and contracts. E.g. for `com.example:foo:1.0.0` the path would be -`META-INF/com.example/foo/1.0.0/` -* Stub servers will be started and fed with mappings -* Messaging definitions will be read and used in the messaging tests - -=== Can I use the Pact Broker? - -When using https://pact.io/[Pact] you can use the https://github.com/pact-foundation/pact_broker[Pact Broker] -to store and share Pact definitions. Starting from Spring Cloud Contract -2.0.0 one can fetch Pact files from the Pact Broker to generate -tests and stubs. - -As a prerequisite the Pact Converter and Pact Stub Downloader -are required. You have to add them via the `spring-cloud-contract-pact` dependency. -You can read more about it in the <> section. - -IMPORTANT: Pact follows the Consumer Contract convention. That means -that the Consumer creates the Pact definitions first, then -shares the files with the Producer. Those expectations are generated -from the Consumer's code and can break the Producer if the expectations -are not met. - -==== Pact Consumer - -The consumer uses Pact framework to generate Pact files. The -Pact files are sent to the Pact Broker. An example of such -setup can be found https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/consumer_pact[here]. - -==== Producer - -For the producer, to use the Pact files from the Pact Broker, we can reuse the -same mechanism we use for external contracts. We route Spring Cloud Contract -to use the Pact implementation via the URL that contains -the `pact://` protocol. It's enough to pass the URL to the -Pact Broker. An example of such setup can be found https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/producer_pact[here]. - -.Maven -[source,xml,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - - - - pact://http://localhost:8085 - - - - ${project.groupId} - ${project.artifactId} - - + - - - - REMOTE - - - - - org.springframework.cloud - spring-cloud-contract-pact - ${spring-cloud-contract.version} - - - ----- - -.Gradle -[source,gradle,indent=0] ----- -buildscript { - repositories { - //... - } - - dependencies { - // ... - // Don't forget to add spring-cloud-contract-pact to the classpath! - classpath "org.springframework.cloud:spring-cloud-contract-pact:${contractVersion}" - } -} - -contracts { - // When + is passed, a latest tag will be applied when fetching pacts - contractDependency { - stringNotation = "${project.group}:${project.name}:+" - } - contractRepository { - repositoryUrl = "pact://http://localhost:8085" - } - // The mode can't be classpath - contractsMode = "REMOTE" - // Base class mappings etc. -} ----- - -With such a setup: - -* Pact files will be downloaded from the Pact Broker -* Spring Cloud Contract will convert the Pact files into tests and stubs -* The JAR with the stubs gets automatically created as usual - -==== Pact Consumer (Producer Contract approach) - -In the scenario where you don't want to do Consumer Contract approach -(for every single consumer define the expectations) but you'd prefer -to do Producer Contracts (the producer provides the contracts and -publishes stubs), it's enough to use Spring Cloud Contract with -Stub Runner option. An example of such setup can be found https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/consumer_pact_stubrunner[here]. - -First, remember to add Stub Runner and Spring Cloud Contract Pact module -as test dependencies. - -.Maven -[source,xml,indent=0] ----- - - - - org.springframework.cloud - spring-cloud-dependencies - ${spring-cloud.version} - pom - import - - - - - - - - - org.springframework.cloud - spring-cloud-starter-contract-stub-runner - test - - - org.springframework.cloud - spring-cloud-contract-pact - test - - ----- - -.Gradle -[source,gradle,indent=0] ----- -dependencyManagement { - imports { - mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}" - } -} - -dependencies { - //... - testCompile("org.springframework.cloud:spring-cloud-starter-contract-stub-runner") - // Don't forget to add spring-cloud-contract-pact to the classpath! - testCompile("org.springframework.cloud:spring-cloud-contract-pact") -} ----- - -Next, just pass the URL of the Pact Broker to `repositoryRoot`, prefixed -with `pact://` protocol. E.g. `pact://http://localhost:8085` - -[source,java,indent=0] ----- -@RunWith(SpringRunner.class) -@SpringBootTest -@AutoConfigureStubRunner(stubsMode = StubRunnerProperties.StubsMode.REMOTE, - ids = "com.example:beer-api-producer-pact", - repositoryRoot = "pact://http://localhost:8085") -public class BeerControllerTest { - //Inject the port of the running stub - @StubRunnerPort("beer-api-producer-pact") int producerPort; - //... -} ----- - -With such a setup: - -* Pact files will be downloaded from the Pact Broker -* Spring Cloud Contract will convert the Pact files into stub definitions -* The stub servers will be started and fed with stubs - -For more information about Pact support you can go to -the <> section. - -=== How can I debug the request/response being sent by the generated tests client? - -The generated tests all boil down to RestAssured in some form or fashion which relies on https://hc.apache.org/httpcomponents-client-ga/[Apache HttpClient]. HttpClient has a facility called https://hc.apache.org/httpcomponents-client-ga/logging.html#Wire_Logging[wire logging] which logs the entire request and response to HttpClient. Spring Boot has a logging https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html[common application property] for doing this sort of thing, just add this to your application properties -[source,properties,indent=0] ----- -logging.level.org.apache.http.wire=DEBUG ----- - -==== How can I debug the mapping/request/response being sent by WireMock? - -Starting from version `1.2.0` we turn on WireMock logging to -info and the WireMock notifier to being verbose. Now you will -exactly know what request was received by WireMock server and which -matching response definition was picked. - -To turn off this feature just bump WireMock logging to `ERROR` - -[source,properties,indent=0] ----- -logging.level.com.github.tomakehurst.wiremock=ERROR ----- - -==== How can I see what got registered in the HTTP server stub? - -You can use the `mappingsOutputFolder` property on `@AutoConfigureStubRunner`, `StubRunnerRule` or -`StubRunnerExtension`to dump all mappings per artifact id. Also the port at which the given stub server -was started will be attached. - -==== Can I reference text from file? - -Yes! With version 1.2.0 we've added such a possibility. It's enough to call `file(...)` method in the -DSL and provide a path relative to where the contract lays. -If you're using YAML just use the `bodyFromFile` property. \ No newline at end of file diff --git a/docs/src/main/asciidoc/verifier_messaging.adoc b/docs/src/main/asciidoc/verifier_messaging.adoc deleted file mode 100644 index 7e3a419100..0000000000 --- a/docs/src/main/asciidoc/verifier_messaging.adoc +++ /dev/null @@ -1,195 +0,0 @@ -== Spring Cloud Contract Verifier Messaging - -Spring Cloud Contract Verifier lets you verify applications that use messaging as a -means of communication. All of the integrations shown in this document work with Spring, -but you can also create one of your own and use that. - -=== Integrations - -You can use one of the following four integration configurations: - -* Apache Camel -* Spring Integration -* Spring Cloud Stream -* Spring AMQP - -Since we use Spring Boot, if you have added one of these libraries to the classpath, all -the messaging configuration is automatically set up. - -IMPORTANT: Remember to put `@AutoConfigureMessageVerifier` on the base class of your -generated tests. Otherwise, messaging part of Spring Cloud Contract Verifier does not -work. - -IMPORTANT: If you want to use Spring Cloud Stream, remember to add a dependency on -`org.springframework.cloud:spring-cloud-stream-test-support`, as shown here: - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - org.springframework.cloud - spring-cloud-stream-test-support - test - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -testCompile "org.springframework.cloud:spring-cloud-stream-test-support" ----- - -=== Manual Integration Testing - -The main interface used by the tests is -`org.springframework.cloud.contract.verifier.messaging.MessageVerifier`. -It defines how to send and receive messages. You can create your own implementation to -achieve the same goal. - -In a test, you can inject a `ContractVerifierMessageExchange` to send and receive -messages that follow the contract. Then add `@AutoConfigureMessageVerifier` to your test. -Here's an example: - -[source,java,indent=0] ----- -@RunWith(SpringTestRunner.class) -@SpringBootTest -@AutoConfigureMessageVerifier -public static class MessagingContractTests { - - @Autowired - private MessageVerifier verifier; - ... -} ----- - -NOTE: If your tests require stubs as well, then `@AutoConfigureStubRunner` includes the -messaging configuration, so you only need the one annotation. - -=== Publisher-Side Test Generation - -Having the `input` or `outputMessage` sections in your DSL results in creation of tests -on the publisher's side. By default, JUnit 4 tests are created. However, there is also a -possibility to create JUnit 5, TestNG or Spock tests. - -There are 3 main scenarios that we should take into consideration: - -* Scenario 1: There is no input message that produces an output message. The output -message is triggered by a component inside the application (for example, scheduler). -* Scenario 2: The input message triggers an output message. -* Scenario 3: The input message is consumed and there is no output message. - -IMPORTANT: The destination passed to `messageFrom` or `sentTo` can have different -meanings for different messaging implementations. For *Stream* and *Integration* it is -first resolved as a `destination` of a channel. Then, if there is no such `destination` -it is resolved as a channel name. For *Camel*, that's a certain component (for example, -`jms`). - -==== Scenario 1: No Input Message - -For the given contract: - -.Groovy DSL -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_dsl] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario1.yml[indent=0] ----- - -The following JUnit test is created: - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_junit_test] ----- - -And the following Spock test would be created: - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_test] ----- - -==== Scenario 2: Output Triggered by Input - -For the given contract: - -.Groovy DSL -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_dsl] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario2.yml[indent=0] ----- - -The following JUnit test is created: - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_junit] ----- - -And the following Spock test would be created: - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_spock] ----- - -==== Scenario 3: No Output Message - -For the given contract: - -.Groovy DSL -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_dsl] ----- - -.YAML -[source,yml,indent=0] ----- -include::{verifier_core_path}/src/test/resources/yml/contract_message_scenario3.yml[indent=0] ----- - -The following JUnit test is created: - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_junit] ----- - -And the following Spock test would be created: - -[source,groovy] ----- -include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_spock] ----- - -=== Consumer Stub Generation - -Unlike the HTTP part, in messaging, we need to publish the Groovy DSL inside the JAR with -a stub. Then it is parsed on the consumer side and proper stubbed routes are created. - -For more information, see <> section. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- -include::{standalone_messaging_samples_path}/stream-sink/pom.xml[tags=jars,indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0] ----- diff --git a/docs/src/main/asciidoc/verifier_setup.adoc b/docs/src/main/asciidoc/verifier_setup.adoc deleted file mode 100644 index f5126d6ef1..0000000000 --- a/docs/src/main/asciidoc/verifier_setup.adoc +++ /dev/null @@ -1,1194 +0,0 @@ -== Spring Cloud Contract Verifier Setup - -You can set up Spring Cloud Contract Verifier in the following ways: - -* <> -* <> -* <> - -[[gradle-project]] -=== Gradle Project - -To learn how to set up the Gradle project for Spring Cloud Contract Verifier, read the -following sections: - -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> - -[[gradle-prerequisites]] -==== Prerequisites - -In order to use Spring Cloud Contract Verifier with WireMock, you muse use either a -Gradle or a Maven plugin. - -WARNING: If you want to use Spock in your projects, you must add separately the -`spock-core` and `spock-spring` modules. Check https://spockframework.github.io/[Spock -docs for more information] - -[[gradle-add-gradle-plugin]] -==== Add Gradle Plugin with Dependencies - -To add a Gradle plugin with dependencies, use code similar to this: - -[source,groovy,indent=0] ----- -buildscript { - repositories { - mavenCentral() - } - dependencies { - classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}" - classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}" - } -} - -apply plugin: 'groovy' -apply plugin: 'spring-cloud-contract' - -dependencyManagement { - imports { - mavenBom "org.springframework.cloud:spring-cloud-contract-dependencies:${verifier_version}" - } -} - -dependencies { - testCompile 'org.codehaus.groovy:groovy-all:2.4.6' - // example with adding Spock core and Spock Spring - testCompile 'org.spockframework:spock-core:1.0-groovy-2.4' - testCompile 'org.spockframework:spock-spring:1.0-groovy-2.4' - testCompile 'org.springframework.cloud:spring-cloud-starter-contract-verifier' -} ----- - -[[gradle-and-rest-assured]] -==== Gradle and Rest Assured 2.0 - -By default, Rest Assured 3.x is added to the classpath. However, to use Rest Assured 2.x -you can add it to the plugins classpath, as shown here: - -[source,groovy,indent=0] ----- -buildscript { - repositories { - mavenCentral() - } - dependencies { - classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}" - classpath "org.springframework.cloud:spring-cloud-contract-gradle-plugin:${verifier_version}" - classpath "com.jayway.restassured:rest-assured:2.5.0" - classpath "com.jayway.restassured:spring-mock-mvc:2.5.0" - } -} - -depenendencies { - // all dependencies - // you can exclude rest-assured from spring-cloud-contract-verifier - testCompile "com.jayway.restassured:rest-assured:2.5.0" - testCompile "com.jayway.restassured:spring-mock-mvc:2.5.0" -} ----- - -That way, the plugin automatically sees that Rest Assured 2.x is present on the classpath -and modifies the imports accordingly. - -[[gradle-snapshot-versions]] -==== Snapshot Versions for Gradle - -Add the additional snapshot repository to your build.gradle to use snapshot versions, -which are automatically uploaded after every successful build, as shown here: - -[source,groovy,indent=0] ----- -include::{standalone_samples_path}/http-server/build.gradle[tags=repos,indent=0] -} ----- -[[gradle-add-stubs]] -==== Add stubs - -By default, Spring Cloud Contract Verifier is looking for stubs in the -`src/test/resources/contracts` directory. - -The directory containing stub definitions is treated as a class name, and each stub -definition is treated as a single test. Spring Cloud Contract Verifier assumes that it -contains at least one level of directories that are to be used as the test class name. -If more than one level of nested directories is present, all except the last one is used -as the package name. For example, with following structure: - -[source,groovy,indent=0] ----- -src/test/resources/contracts/myservice/shouldCreateUser.groovy -src/test/resources/contracts/myservice/shouldReturnUser.groovy ----- - -Spring Cloud Contract Verifier creates a test class named `defaultBasePackage.MyService` -with two methods: - - - `shouldCreateUser()` - - `shouldReturnUser()` - -[[gradle-run-plugin]] -==== Run the Plugin - -The plugin registers itself to be invoked before a `check` task. If you want it to be -part of your build process, you need to do nothing more. If you just want to generate -tests, invoke the `generateContractTests` task. - -[[gradle-default-setup]] -==== Default Setup - -The default Gradle Plugin setup creates the following Gradle part of the build (in -pseudocode): - -[source,groovy,indent=0] ----- -contracts { - testFramework ='JUNIT' - testMode = 'MockMvc' - generatedTestSourcesDir = project.file("${project.buildDir}/generated-test-sources/contracts") - generatedTestResourcesDir = project.file("${project.buildDir}/generated-test-resources/contracts") - contractsDslDir = "${project.rootDir}/src/test/resources/contracts" - basePackageForTests = 'org.springframework.cloud.verifier.tests' - stubsOutputDir = project.file("${project.buildDir}/stubs") - - // the following properties are used when you want to provide where the JAR with contract lays - contractDependency { - stringNotation = '' - } - contractsPath = '' - contractsWorkOffline = false - contractRepository { - cacheDownloadedContracts(true) - } -} - -tasks.create(type: Jar, name: 'verifierStubsJar', dependsOn: 'generateClientStubs') { - baseName = project.name - classifier = contracts.stubsSuffix - from contractVerifier.stubsOutputDir -} - -project.artifacts { - archives task -} - -tasks.create(type: Copy, name: 'copyContracts') { - from contracts.contractsDslDir - into contracts.stubsOutputDir -} - -verifierStubsJar.dependsOn 'copyContracts' - -publishing { - publications { - stubs(MavenPublication) { - artifactId project.name - artifact verifierStubsJar - } - } -} ----- - -[[gradle-configure-plugin]] -==== Configure Plugin - -To change the default configuration, add a `contracts` snippet to your Gradle config, as -shown here: - -[source,groovy,indent=0] ----- -contracts { - testMode = 'MockMvc' - baseClassForTests = 'org.mycompany.tests' - generatedTestSourcesDir = project.file('src/generatedContract') -} ----- - -[[gradle-configuration-options]] -==== Configuration Options - -* *testMode*: Defines the mode for acceptance tests. By default, the mode is MockMvc, -which is based on Spring's MockMvc. It can also be changed to *WebTestClient*, *JaxRsClient* or to -*Explicit* for real HTTP calls. -* *imports*: Creates an array with imports that should be included in generated tests -(for example ['org.myorg.Matchers']). By default, it creates an empty array. -* *staticImports*: Creates an array with static imports that should be included in -generated tests(for example ['org.myorg.Matchers.*']). By default, it creates an empty -array. -* *basePackageForTests*: Specifies the base package for all generated tests. If not set, -the value is picked from `baseClassForTests`'s package and from `packageWithBaseClasses`. -If neither of these values are set, then the value is set to -`org.springframework.cloud.contract.verifier.tests`. -* *baseClassForTests*: Creates a base class for all generated tests. By default, if you -use Spock classes, the class is `spock.lang.Specification`. -* *packageWithBaseClasses*: Defines a package where all the base classes reside. This -setting takes precedence over *baseClassForTests*. -* *baseClassMappings*: Explicitly maps a contract package to a FQN of a base class. This -setting takes precedence over *packageWithBaseClasses* and *baseClassForTests*. -* *ruleClassForTests*: Specifies a rule that should be added to the generated test -classes. -* *ignoredFiles*: Uses an `Antmatcher` to allow defining stub files for which processing -should be skipped. By default, it is an empty array. -* *contractsDslDir*: Specifies the directory containing contracts written using the -GroovyDSL. By default, its value is `$rootDir/src/test/resources/contracts`. -* *generatedTestSourcesDir*: Specifies the test source directory where tests generated -from the Groovy DSL should be placed. By default its value is -`$buildDir/generated-test-sources/contracts`. -* *generatedTestResourcesDir*: Specifies the test resource directory where resources used by the tests generated -from the Groovy DSL should be placed. By default its value is -`$buildDir/generated-test-resources/contracts`. -* *stubsOutputDir*: Specifies the directory where the generated WireMock stubs from -the Groovy DSL should be placed. -* *testFramework*: Specifies the target test framework to be used. Currently, Spock, JUnit 4 (`TestFramework.JUNIT`), TestNG 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 -`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.) -* *deleteStubsAfterTest*: If set to `false` will not remove any downloaded -contracts from temporary directories - -Below you can find a list of experimental features you can turn on via the plugin: - -* *convertToYaml*: converts all DSLs to the declarative, YAML format. This can be extremely useful when you're using external libraries in your Groovy DSLs. By turning this feature on (by setting it to `true`) you will not need to add the library dependency on the consumer side. -* *assertJsonSize*: You can check the size of JSON arrays in the generated tests. This feature is disabled by default. - -[[gradle-single-base-class]] -==== 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. - -[source,groovy,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0] ----- - -If you use `Explicit` mode, you can use a base class to initialize the whole tested app -as you might see in regular integration tests. If you use the `JAXRSCLIENT` mode, this -base class should also contain a `protected WebTarget webTarget` field. Right now, the -only option to test the JAX-RS API is to start a web server. - -[[gradle-different-base-classes]] -==== Different Base Classes for Contracts - -If your base classes differ between contracts, you can tell the Spring Cloud Contract -plugin which class should get extended by the autogenerated tests. You have two options: - -* Follow a convention by providing the `packageWithBaseClasses` -* Provide explicit mapping via `baseClassMappings` - -*By Convention* - -The convention is such that if you have a contract under (for example) -`src/test/resources/contract/foo/bar/baz/` and set the value of the -`packageWithBaseClasses` property to `com.example.base`, then Spring Cloud Contract -Verifier assumes that there is a `BarBazBase` class under the `com.example.base` package. -In other words, the system takes the last two parts of the package, if they exist, and -forms a class with a `Base` suffix. This rule takes precedence over *baseClassForTests*. -Here is an example of how it works in the `contracts` closure: - -[source,groovy,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierSpec.groovy[tags=package_with_base_classes,indent=0] ----- - -*By Mapping* - -You can manually map a regular expression of the contract's package to fully qualified -name of the base class for the matched contract. You have to provide a list called -`baseClassMappings` that consists `baseClassMapping` objects that takes a -`contractPackageRegex` to `baseClassFQN` mapping. Consider the following example: - -[source,groovy,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierSpec.groovy[tags=base_class_mappings,indent=0] ----- - -Let's assume that you have contracts under - - `src/test/resources/contract/com/` - - `src/test/resources/contract/foo/` - -By providing the `baseClassForTests`, we have a fallback in case mapping did not succeed. -(You could also provide the `packageWithBaseClasses` as a fallback.) That way, the tests -generated from `src/test/resources/contract/com/` contracts extend the -`com.example.ComBase`, whereas the rest of the tests extend `com.example.FooBase`. - -[[gradle-invoking-generated-tests]] -==== Invoking Generated Tests - -To ensure that the provider side is compliant with defined contracts, you need to invoke: - -[source,bash,indent=0] ----- -./gradlew generateContractTests test ----- - -[[gradle-pushing-stubs-to-scm]] -==== Pushing stubs to SCM - -If you're using the SCM repository to keep the contracts and -stubs, you might want to automate the step of pushing stubs to -the repository. To do that, it's enough to call the `pushStubsToScm` -task. Example: - -[source,bash,indent=0] ----- -$ ./gradlew pushStubsToScm ----- - -Under <> you can find all possible -configuration options that you can pass either via -the `contractsProperties` field e.g. `contracts { contractsProperties = [foo:"bar"] }`, -via `contractsProperties` method e.g. `contracts { contractsProperties([foo:"bar"]) }`, -a system property or an environment variable. - -[[gradle-consumer]] -==== Spring Cloud Contract Verifier on the Consumer Side - -In a consuming service, you need to configure the Spring Cloud Contract Verifier plugin -in exactly the same way as in case of provider. If you do not want to use Stub Runner -then you need to copy contracts stored in `src/test/resources/contracts` and generate -WireMock JSON stubs using: - -[source,bash,indent=0] ----- -./gradlew generateClientStubs ----- - -NOTE: The `stubsOutputDir` option has to be set for stub generation to work. - -When present, JSON stubs can be used in automated tests of consuming a service. - -[source,groovy,indent=0] ----- -@ContextConfiguration(loader == SpringApplicationContextLoader, classes == Application) -class LoanApplicationServiceSpec extends Specification { - - @ClassRule - @Shared - WireMockClassRule wireMockRule == new WireMockClassRule() - - @Autowired - LoanApplicationService sut - - def 'should successfully apply for loan'() { - given: - LoanApplication application = - new LoanApplication(client: new Client(clientPesel: '12345678901'), amount: 123.123) - when: - LoanApplicationResult loanApplication == sut.loanApplication(application) - then: - loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLIED - loanApplication.rejectionReason == null - } -} ----- - -`LoanApplication` makes a call to `FraudDetection` service. This request is handled by a -WireMock server configured with stubs generated by Spring Cloud Contract Verifier. - -[[maven-project]] -=== Maven Project - -To learn how to set up the Maven project for Spring Cloud Contract Verifier, read the -following sections: - -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> - -[[maven-add-plugin]] -==== Add maven plugin - -Add the Spring Cloud Contract BOM in a fashion similar to this: - -[source,xml,indent=0] ----- -include::{standalone_samples_path}/http-server/pom.xml[tags=contract_bom,indent=0] ----- - -Next, add the `Spring Cloud Contract Verifier` Maven plugin: - -[source,xml,indent=0] ----- -include::{standalone_samples_path}/http-server/pom.xml[tags=contract_maven_plugin,indent=0] ----- - -You can read more in the -https://cloud.spring.io/spring-cloud-static/spring-cloud-contract/2.0.0.RELEASE/spring-cloud-contract-maven-plugin/[Spring -Cloud Contract Maven Plugin Documentation (example for `2.0.0.RELEASE` version)]. - -[[maven-rest-assured]] -==== Maven and Rest Assured 2.0 - -By default, Rest Assured 3.x is added to the classpath. However, you can use Rest -Assured 2.x by adding it to the plugins classpath, as shown here: - -[source,groovy,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - com.example - - - - org.springframework.cloud - spring-cloud-contract-verifier - ${spring-cloud-contract.version} - - - com.jayway.restassured - rest-assured - 2.5.0 - compile - - - com.jayway.restassured - spring-mock-mvc - 2.5.0 - compile - - - - - - - - - com.jayway.restassured - rest-assured - 2.5.0 - test - - - com.jayway.restassured - spring-mock-mvc - 2.5.0 - test - - ----- - -That way, the plugin automatically sees that Rest Assured 3.x is present on the classpath -and modifies the imports accordingly. - -[[maven-snapshot-versions]] -==== Snapshot versions for Maven - -For Snapshot and Milestone versions, you have to add the following section to your -`pom.xml`, as shown here: - -[source,xml,indent=0] ----- -include::{standalone_samples_path}/http-server/pom.xml[tags=repos,indent=0] ----- - -[[maven-add-stubs]] -==== Add stubs - -By default, Spring Cloud Contract Verifier is looking for stubs in the -`src/test/resources/contracts` directory. The directory containing stub definitions is -treated as a class name, and each stub definition is treated as a single test. We assume -that it contains at least one directory to be used as test class name. If there is more -than one level of nested directories, all except the last one is used as package name. -For example, with following structure: - -[source,groovy,indent=0] ----- -src/test/resources/contracts/myservice/shouldCreateUser.groovy -src/test/resources/contracts/myservice/shouldReturnUser.groovy ----- - -Spring Cloud Contract Verifier creates a test class named `defaultBasePackage.MyService` -with two methods - -* `shouldCreateUser()` -* `shouldReturnUser()` - -[[maven-run-plugin]] -==== Run plugin - -The plugin goal `generateTests` is assigned to be invoked in the phase called -`generate-test-sources`. If you want it to be part of your build process, you need not do -anything. If you just want to generate tests, invoke the `generateTests` goal. - -[[maven-configure-plugin]] -==== Configure plugin - -To change the default configuration, just add a `configuration` section to the plugin -definition or the `execution` definition, as shown here: - -[source,xml,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - - - - convert - generateStubs - generateTests - - - - - org.springframework.cloud.verifier.twitter.place - org.springframework.cloud.verifier.twitter.place.BaseMockMvcSpec - - ----- - -[[maven-configuration-options]] -==== Configuration Options - -* *testMode*: Defines the mode for acceptance tests. By default, the mode is MockMvc, -which is based on Spring's MockMvc. It can also be changed to *WebTestClient*, *JaxRsClient* or to -*Explicit* for real HTTP calls. -* *basePackageForTests*: Specifies the base package for all generated tests. If not set, -the value is picked from `baseClassForTests`'s package and from `packageWithBaseClasses`. -If neither of these values are set, then the value is set to -`org.springframework.cloud.contract.verifier.tests`. -* *ruleClassForTests*: Specifies a rule that should be added to the generated test -classes. -* *baseClassForTests*: Creates a base class for all generated tests. By default, if you -use Spock classes, the class is `spock.lang.Specification`. -* *contractsDirectory*: Specifies a directory containing contracts written with the -GroovyDSL. The default directory is `/src/test/resources/contracts`. -* *generatedTestSourcesDir*: Specifies the test source directory where tests generated -from the Groovy DSL should be placed. By default its value is -`$buildDir/generated-test-sources/contracts`. -* *generatedTestResourcesDir*: Specifies the test resource directory where resources used by the tests generated -* *testFramework*: 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. -* *packageWithBaseClasses*: Defines a package where all the base classes reside. This -setting takes precedence over *baseClassForTests*. The convention is such that, if you -have a contract under (for example) `src/test/resources/contract/foo/bar/baz/` and set -the value of the `packageWithBaseClasses` property to `com.example.base`, then Spring -Cloud Contract Verifier assumes that there is a `BarBazBase` class under the -`com.example.base` package. In other words, the system takes the last two parts of the -package, if they exist, and forms a class with a `Base` suffix. -* *baseClassMappings*: Specifies a list of base class mappings that provide -`contractPackageRegex`, which is checked against the package where the contract is -located, and `baseClassFQN`, which maps to the fully qualified name of the base class for -the matched contract. For example, if you have a contract under -`src/test/resources/contract/foo/bar/baz/` and map the property -`.* -> com.example.base.BaseClass`, then the test class generated from these contracts -extends `com.example.base.BaseClass`. This setting takes precedence over -*packageWithBaseClasses* and *baseClassForTests*. -* *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. - -If you want to download your contract definitions from a Maven repository, you can use -the following options: - -* *contractDependency*: The contract dependency that contains all the packaged contracts. -* *contractsPath*: The path to the concrete contracts in the JAR with packaged contracts. -Defaults to `groupid/artifactid` where `gropuid` is slash separated. -* *contractsMode*: Picks the mode in which stubs will be found and registered -* *deleteStubsAfterTest*: If set to `false` will not remove any downloaded -contracts from temporary directories -* *contractsRepositoryUrl*: URL to a repo with the artifacts that have contracts. If it is not provided, -use the current Maven ones. -* *contractsRepositoryUsername*: The user name to be used to connect to the repo with contracts. -* *contractsRepositoryPassword*: The password to be used to connect to the repo with contracts. -* *contractsRepositoryProxyHost*: The proxy host to be used to connect to the repo with contracts. -* *contractsRepositoryProxyPort*: The proxy port to be used to connect to the repo with contracts. - -We cache only non-snapshot, explicitly provided versions (for example -`+` or `1.0.0.BUILD-SNAPSHOT` won't get cached). By default, this feature is turned on. - -Below you can find a list of experimental features you can turn on via the plugin: - -* *convertToYaml*: converts all DSLs to the declarative, YAML format. This can be extremely useful when you're using external libraries in your Groovy DSLs. By turning this feature on (by setting it to `true`) you will not need to add the library dependency on the consumer side. -* *assertJsonSize*: You can check the size of JSON arrays in the generated tests. This feature is disabled by default. - -[[maven-single-base]] -==== 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. - -[source,groovy,indent=0] ----- -package org.mycompany.tests - -import org.mycompany.ExampleSpringController -import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc -import spock.lang.Specification - -class MvcSpec extends Specification { - def setup() { - RestAssuredMockMvc.standaloneSetup(new ExampleSpringController()) - } -} ----- - -You can also setup the whole context if necessary. - -[source,java,indent=0] ----- -import io.restassured.module.mockmvc.RestAssuredMockMvc; -import org.junit.Before; -import org.junit.runner.RunWith; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.test.context.junit4.SpringRunner; -import org.springframework.web.context.WebApplicationContext; - -@RunWith(SpringRunner.class) -@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, classes = SomeConfig.class, properties="some=property") -public abstract class BaseTestClass { - - @Autowired - WebApplicationContext context; - - @Before - public void setup() { - RestAssuredMockMvc.webAppContextSetup(this.context); - } -} ----- - -If you use `EXPLICIT` mode, you can use a base class to initialize the whole tested app -similarly, as you might find in regular integration tests. - -[source,java,indent=0] ----- -import io.restassured.RestAssured; -import org.junit.Before; -import org.junit.runner.RunWith; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.test.context.SpringBootTest; -import org.springframework.boot.web.server.LocalServerPort -import org.springframework.test.context.junit4.SpringRunner; -import org.springframework.web.context.WebApplicationContext; - -@RunWith(SpringRunner.class) -@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, classes = SomeConfig.class, properties="some=property") -public abstract class BaseTestClass { - - @LocalServerPort - int port; - - @Before - public void setup() { - RestAssured.baseURI = "http://localhost:" + this.port; - } -} ----- - -If you use the `JAXRSCLIENT` mode, this base class should also contain a `protected WebTarget webTarget` field. Right -now, the only option to test the JAX-RS API is to start a web server. - -[[maven-different-base]] -==== Different base classes for contracts - -If your base classes differ between contracts, you can tell the Spring Cloud Contract -plugin which class should get extended by the autogenerated tests. You have two options: - -* Follow a convention by providing the `packageWithBaseClasses` -* provide explicit mapping via `baseClassMappings` - -*By Convention* - -The convention is such that if you have a contract under (for example) -`src/test/resources/contract/foo/bar/baz/` and set the value of the -`packageWithBaseClasses` property to `com.example.base`, then Spring Cloud Contract -Verifier assumes that there is a `BarBazBase` class under the `com.example.base` package. -In other words, the system takes the last two parts of the package, if they exist, and -forms a class with a `Base` suffix. This rule takes precedence over *baseClassForTests*. -Here is an example of how it works in the `contracts` closure: - -[source,xml,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-maven-plugin/src/test/projects/basic-generated-baseclass/pom.xml[tags=convention,indent=0] ----- - -*By Mapping* - -You can manually map a regular expression of the contract's package to fully qualified -name of the base class for the matched contract. You have to provide a list called -`baseClassMappings` that consists `baseClassMapping` objects that takes a -`contractPackageRegex` to `baseClassFQN` mapping. Consider the following example: - -[source,xml,indent=0] ----- -include::{plugins_path}/spring-cloud-contract-maven-plugin/src/test/projects/basic-baseclass-from-mappings/pom.xml[tags=mapping,indent=0] ----- - -Assume that you have contracts under these two locations: -* `src/test/resources/contract/com/` -* `src/test/resources/contract/foo/` - -By providing the `baseClassForTests`, we have a fallback in case mapping did not succeed. -(You can also provide the `packageWithBaseClasses` as a fallback.) That way, the tests -generated from `src/test/resources/contract/com/` contracts extend the -`com.example.ComBase`, whereas the rest of the tests extend `com.example.FooBase`. - -[[maven-invoking-generated-tests]] -==== Invoking generated tests - -The Spring Cloud Contract Maven Plugin generates verification code in a directory called -`/generated-test-sources/contractVerifier` and attaches this directory to `testCompile` -goal. - -For Groovy Spock code, use the following: - -[source,xml,indent=0] ----- - - org.codehaus.gmavenplus - gmavenplus-plugin - 1.5 - - - - testCompile - - - - - - - ${project.basedir}/src/test/groovy - - **/*.groovy - - - - ${project.build.directory}/generated-test-sources/contractVerifier - - **/*.groovy - - - - - ----- - -To ensure that provider side is compliant with defined contracts, you need to invoke -`mvn generateTest test`. - -[[maven-pushing-stubs-to-scm]] -==== Pushing stubs to SCM - -If you're using the SCM repository to keep the contracts and -stubs, you might want to automate the step of pushing stubs to -the repository. To do that, it's enough to add the `pushStubsToScm` -goal. Example: - -[source,xml,indent=0] ----- - - org.springframework.cloud - spring-cloud-contract-maven-plugin - ${spring-cloud-contract.version} - true - - - - - git://https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs-contracts-git.git - - - - ${project.groupId} - ${project.artifactId} - ${project.version} - - - - REMOTE - - - - package - - - pushStubsToScm - - - - ----- - -Under <> you can find all possible -configuration options that you can pass either via -the `` map, a system property -or an environment variable. - -[[maven-sts]] -==== Maven Plugin and STS - -If you see the following exception while using STS: - -image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/{branch}/docs/src/main/asciidoc/images/sts_exception.png[STS Exception] - -When you click on the error marker you should see something like this: - -[source,bash] ----- - plugin:1.1.0.M1:convert:default-convert:process-test-resources) org.apache.maven.plugin.PluginExecutionException: Execution default-convert of goal org.springframework.cloud:spring- - cloud-contract-maven-plugin:1.1.0.M1:convert failed. at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:145) at - org.eclipse.m2e.core.internal.embedder.MavenImpl.execute(MavenImpl.java:331) at org.eclipse.m2e.core.internal.embedder.MavenImpl$11.call(MavenImpl.java:1362) at -... - org.eclipse.core.internal.jobs.Worker.run(Worker.java:55) Caused by: java.lang.NullPointerException at - org.eclipse.m2e.core.internal.builder.plexusbuildapi.EclipseIncrementalBuildContext.hasDelta(EclipseIncrementalBuildContext.java:53) at - org.sonatype.plexus.build.incremental.ThreadBuildContext.hasDelta(ThreadBuildContext.java:59) at ----- - -In order to fix this issue, provide the following section in your `pom.xml`: - -[source,xml] ----- - - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - org.springframework.cloud - spring-cloud-contract-maven-plugin - [1.0,) - - convert - - - - - - - - - - - - - ----- - -==== Maven Plugin with Spock Tests - -You can select the http://spockframework.org/[Spock Framework] for creating and executing the auto-generated contract -verification tests with both Maven and Gradle plugin. However, whereas with Gradle its really straightforward, -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 https://github.com/groovy/GMavenPlus[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: - -[source,xml,indent=0] ----- -include::{samples_url}/producer_with_spock/pom.xml[tags=gmavenplus-setup,indent=0] ----- - -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: - -[source,xml,indent=0] ----- -include::{samples_url}/producer_with_spock/pom.xml[tags=pock-surefire-setup,indent=0] ----- - -=== 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 -of different jars, all of them share one pom: - -[source,bash,indent=0] ----- -├── github-webhook-0.0.1.BUILD-20160903.075506-1-stubs.jar -├── github-webhook-0.0.1.BUILD-20160903.075506-1-stubs.jar.sha1 -├── github-webhook-0.0.1.BUILD-20160903.075655-2-stubs.jar -├── github-webhook-0.0.1.BUILD-20160903.075655-2-stubs.jar.sha1 -├── github-webhook-0.0.1.BUILD-SNAPSHOT.jar -├── github-webhook-0.0.1.BUILD-SNAPSHOT.pom -├── github-webhook-0.0.1.BUILD-SNAPSHOT-stubs.jar -├── ... -└── ... ----- - -There are three possibilities of working with those dependencies so as not to have any -issues with transitive dependencies: - -* Mark all application dependencies as optional -* Create a separate artifactid for the stubs -* Exclude dependencies on the consumer side - -*Mark all application dependencies as optional* - -If, in the `github-webhook` application, you mark all of your dependencies as optional, -when you include the `github-webhook` stubs in another application (or when that -dependency gets downloaded by Stub Runner) then, since all of the dependencies are -optional, they will not get downloaded. - -*Create a separate `artifactid` for the stubs* - -If you create a separate `artifactid`, then you can set it up in whatever way you wish. -For example, you might decide to have no dependencies at all. - -*Exclude dependencies on the consumer side* - -As a consumer, if you add the stub dependency to your classpath, you can explicitly -exclude the unwanted dependencies. - -=== Scenarios - -You can handle scenarios with Spring Cloud Contract Verifier. All you need to do is to -stick to the proper naming convention while creating your contracts. The convention -requires including an order number followed by an underscore. This will work regardles - of whether you're working with YAML or Groovy. Example: - -[source,indent=0] ----- -my_contracts_dir\ - scenario1\ - 1_login.groovy - 2_showCart.groovy - 3_logout.groovy ----- - -Such a tree causes Spring Cloud Contract Verifier to generate WireMock's scenario with a -name of `scenario1` and the three following steps: - -. login marked as `Started` pointing to... -. showCart marked as `Step1` pointing to... -. logout marked as `Step2` which will close the scenario. - -More details about WireMock scenarios can be found at -https://wiremock.org/docs/stateful-behaviour/[https://wiremock.org/docs/stateful-behaviour/] - -Spring Cloud Contract Verifier also generates tests with a guaranteed order of execution. - -[[docker-project]] -=== Docker Project - -We're publishing a `springcloud/spring-cloud-contract` Docker image -that contains a project that will generate tests and execute them in `EXPLICIT` mode -against a running application. - -TIP: The `EXPLICIT` mode means that the tests generated from contracts will send -real requests and not the mocked ones. - -==== Short intro to Maven, JARs and Binary storage - -Since the Docker image can be used by non JVM projects, it's good to -explain the basic terms behind Spring Cloud Contract packaging defaults. - -Part of the following definitions were taken from the https://maven.apache.org/glossary.html[Maven Glossary] - -- `Project`: Maven thinks in terms of projects. Everything that you -will build are projects. Those projects follow a well defined -“Project Object Model”. Projects can depend on other projects, -in which case the latter are called “dependencies”. A project may -consistent of several subprojects, however these subprojects are still -treated equally as projects. -- `Artifact`: An artifact is something that is either produced or used -by a project. Examples of artifacts produced by Maven for a project -include: JARs, source and binary distributions. Each artifact -is uniquely identified by a group id and an artifact ID which is -unique within a group. -- `JAR`: JAR stands for Java ARchive. It's a format based on -the ZIP file format. Spring Cloud Contract packages the contracts and generated -stubs in a JAR file. -- `GroupId`: A group ID is a universally unique identifier for a project. -While this is often just the project name (eg. commons-collections), -it is helpful to use a fully-qualified package name to distinguish it -from other projects with a similar name (eg. org.apache.maven). -Typically, when published to the Artifact Manager, the `GroupId` will get -slash separated and form part of the URL. E.g. for group id `com.example` -and artifact id `application` would be `/com/example/application/`. -- `Classifier`: The Maven dependency notation looks as follows: -`groupId:artifactId:version:classifier`. The classifier is additional suffix -passed to the dependency. E.g. `stubs`, `sources`. The same dependency -e.g. `com.example:application` can produce multiple artifacts that -differ from each other with the classifier. -- `Artifact manager`: When you generate binaries / sources / packages, you would -like them to be available for others to download / reference or reuse. In case -of the JVM world those artifacts would be JARs, for Ruby these are gems -and for Docker those would be Docker images. You can store those artifacts -in a manager. Examples of such managers can be https://jfrog.com/artifactory/[Artifactory] -or https://www.sonatype.org/nexus/[Nexus]. - -==== How it works - -The image searches for contracts under the `/contracts` folder. -The output from running the tests will be available under -`/spring-cloud-contract/build` folder (it's useful for debugging -purposes). - -It's enough for you to mount your contracts, pass the environment variables - and the image will: - -- generate the contract tests -- execute the tests against the provided URL -- generate the https://github.com/tomakehurst/wiremock[WireMock] stubs -- (optional - turned on by default) publish the stubs to a Artifact Manager - -===== Environment Variables - -The Docker image requires some environment variables to point to -your running application, to the Artifact manager instance etc. - -- `PROJECT_GROUP` - your project's group id. Defaults to `com.example` -- `PROJECT_VERSION` - your project's version. Defaults to `0.0.1-SNAPSHOT` -- `PROJECT_NAME` - artifact id. Defaults to `example` -- `PRODUCER_STUBS_CLASSIFIER` - archive classifier used for generated producer stubs, defaults to `stubs`. -- `REPO_WITH_BINARIES_URL` - URL of your Artifact Manager. Defaults to `http://localhost:8081/artifactory/libs-release-local` -which is the default URL of https://jfrog.com/artifactory/[Artifactory] running locally -- `REPO_WITH_BINARIES_USERNAME` - (optional) username when the Artifact Manager is secured, defaults to `admin`. -- `REPO_WITH_BINARIES_PASSWORD` - (optional) password when the Artifact Manager is secured, defaults to `password`. -- `PUBLISH_ARTIFACTS` - if set to `true` then will publish artifact to binary storage. Defaults to `true`. - -These environment variables are used when contracts lay in an external repository. To enable -this feature you must set the `EXTERNAL_CONTRACTS_ARTIFACT_ID` environment variable. - -- `EXTERNAL_CONTRACTS_GROUP_ID` - group id of the project with contracts. Defaults to `com.example` -- `EXTERNAL_CONTRACTS_ARTIFACT_ID`- artifact id of the project with contracts. -- `EXTERNAL_CONTRACTS_CLASSIFIER`- classifier of the project with contracts. Empty by default -- `EXTERNAL_CONTRACTS_VERSION` - version of the project with contracts. Defaults to `+`, equivalent to picking the latest -- `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL` - URL of your Artifact Manager. Defaults to value of `REPO_WITH_BINARIES_URL` env var. -If that's not set, defaults to `http://localhost:8081/artifactory/libs-release-local` -which is the default URL of https://jfrog.com/artifactory/[Artifactory] running locally -- `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_USERNAME` - (optional) username if the `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL` -requires authentication, defaults to `REPO_WITH_BINARIES_USERNAME`. If that's not set defaults to `admin`. -- `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_PASSWORD` - (optional) password if the `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL` -requires authentication, defaults to `REPO_WITH_BINARIES_PASSWORD`. If that's not set defaults to `password`. -- `EXTERNAL_CONTRACTS_PATH` - path to contracts for the given project, inside the project with contracts. -Defaults to slash separated `EXTERNAL_CONTRACTS_GROUP_ID` concatenated with `/` and `EXTERNAL_CONTRACTS_ARTIFACT_ID`. E.g. -for group id `foo.bar` and artifact id `baz`, would result in `foo/bar/baz` contracts path. -- `EXTERNAL_CONTRACTS_WORK_OFFLINE` - if set to `true` then will retrieve artifact with contracts -from the container's `.m2`. Mount your local `.m2` as a volume available at the container's `/root/.m2` path. -You must not set both `EXTERNAL_CONTRACTS_WORK_OFFLINE` and `EXTERNAL_CONTRACTS_REPO_WITH_BINARIES_URL`. - - -These environment variables are used when tests are executed: - -- `APPLICATION_BASE_URL` - url against which tests should be executed. -Remember that it has to be accessible from the Docker container (e.g. `localhost` -will not work) -- `APPLICATION_USERNAME` - (optional) username for basic authentication to your application -- `APPLICATION_PASSWORD` - (optional) password for basic authentication to your application - -==== Example of usage - -Let's take a look at a simple MVC application - -```bash -$ git clone https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs -$ cd bookstore -``` - -The contracts are available under `/contracts` folder. - -[[docker-server-side]] -==== Server side (nodejs) - -Since we want to run tests, we could just execute: - -```bash -$ npm test -``` - -however, for learning purposes, let's split it into pieces: - -```bash -# Stop docker infra (nodejs, artifactory) -$ ./stop_infra.sh -# Start docker infra (nodejs, artifactory) -$ ./setup_infra.sh - -# Kill & Run app -$ pkill -f "node app" -$ nohup node app & - -# Prepare environment variables -$ SC_CONTRACT_DOCKER_VERSION="..." -$ APP_IP="192.168.0.100" -$ APP_PORT="3000" -$ ARTIFACTORY_PORT="8081" -$ APPLICATION_BASE_URL="http://${APP_IP}:${APP_PORT}" -$ ARTIFACTORY_URL="http://${APP_IP}:${ARTIFACTORY_PORT}/artifactory/libs-release-local" -$ CURRENT_DIR="$( pwd )" -$ CURRENT_FOLDER_NAME=${PWD##*/} -$ PROJECT_VERSION="0.0.1.RELEASE" - -# Execute contract tests -$ docker run --rm -e "APPLICATION_BASE_URL=${APPLICATION_BASE_URL}" -e "PUBLISH_ARTIFACTS=true" -e "PROJECT_NAME=${CURRENT_FOLDER_NAME}" -e "REPO_WITH_BINARIES_URL=${ARTIFACTORY_URL}" -e "PROJECT_VERSION=${PROJECT_VERSION}" -v "${CURRENT_DIR}/contracts/:/contracts:ro" -v "${CURRENT_DIR}/node_modules/spring-cloud-contract/output:/spring-cloud-contract-output/" springcloud/spring-cloud-contract:"${SC_CONTRACT_DOCKER_VERSION}" - -# Kill app -$ pkill -f "node app" -``` - -What will happen is that via bash scripts: - -- infrastructure will be set up (MongoDb, Artifactory). -In real life scenario you would just run the NodeJS application -with mocked database. In this example we want to show how we can -benefit from Spring Cloud Contract in no time. -- due to those constraints the contracts also represent the -stateful situation -** first request is a `POST` that causes data to get inserted to the database -** second request is a `GET` that returns a list of data with 1 previously inserted element -- the NodeJS application will be started (on port `3000`) -- contract tests will be generated via Docker and tests -will be executed against the running application -** the contracts will be taken from `/contracts` folder. -** the output of the test execution is available under -`node_modules/spring-cloud-contract/output`. -- the stubs will be uploaded to Artifactory. You can check them out -under http://localhost:8081/artifactory/libs-release-local/com/example/bookstore/0.0.1.RELEASE/ . -The stubs will be here http://localhost:8081/artifactory/libs-release-local/com/example/bookstore/0.0.1.RELEASE/bookstore-0.0.1.RELEASE-stubs.jar. - -To see how the client side looks like check out the <> section. diff --git a/docs/src/main/asciidoc/verifier_stubrunner.adoc b/docs/src/main/asciidoc/verifier_stubrunner.adoc deleted file mode 100644 index a29dfc2b69..0000000000 --- a/docs/src/main/asciidoc/verifier_stubrunner.adoc +++ /dev/null @@ -1,182 +0,0 @@ -== Spring Cloud Contract Stub Runner - -One of the issues that you might encounter while using Spring Cloud Contract Verifier is -passing the generated WireMock JSON stubs from the server side to the client side (or to -various clients). The same takes place in terms of client-side generation for messaging. - -Copying the JSON files and setting the client side for messaging manually is out of the -question. That is why we introduced Spring Cloud Contract Stub Runner. It can -automatically download and run the stubs for you. - -=== Snapshot versions - -Add the additional snapshot repository to your `build.gradle` file to use snapshot -versions, which are automatically uploaded after every successful build: - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- -include::{standalone_samples_path}/http-server/pom.xml[tags=repos,indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{standalone_samples_path}/http-server/build.gradle[tags=repos,indent=0] ----- - -[[publishing-stubs-as-jars]] -=== Publishing Stubs as JARs - -The easiest approach would be to centralize the way stubs are kept. For example, you can -keep them as jars in a Maven repository. - -TIP: For both Maven and Gradle, the setup comes ready to work. However, you can customize -it if you want to. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - -include::{samples_url}/producer_with_restdocs/pom.xml[tags=skip_jar,indent=0] - - -include::{samples_url}/producer_with_restdocs/pom.xml[tags=assembly,indent=0] - - -include::{samples_url}/producer_with_restdocs/src/assembly/stub.xml[indent=0] ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -include::{plugins_path}/spring-cloud-contract-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0] ----- - -include::{stubrunner_core_path}/README.adoc[] - -=== Common - -This section briefly describes common properties, including: - -* <> -* <> - -[[common-properties-junit-spring]] -==== Common Properties for JUnit and Spring - -You can set repetitive properties by using system properties or Spring configuration -properties. Here are their names with their default values: - -[frame="topbot",options="header"] -|=============== -| Property name | Default value | Description -|stubrunner.minPort|10000| Minimum value of a port for a started WireMock with stubs. -|stubrunner.maxPort|15000| Maximum value of a port for a started WireMock with stubs. -|stubrunner.repositoryRoot|| Maven repo URL. If blank, then call the local maven repo. -|stubrunner.classifier|stubs| Default classifier for the stub artifacts. -|stubrunner.stubsMode|CLASSPATH| The way you want to fetch and register the stubs -|stubrunner.ids|| Array of Ivy notation stubs to download. -|stubrunner.username|| Optional username to access the tool that stores the JARs with -stubs. -|stubrunner.password|| Optional password to access the tool that stores the JARs with -stubs. -|stubrunner.stubsPerConsumer|false| Set to `true` if you want to use different stubs for -each consumer instead of registering all stubs for every consumer. -|stubrunner.consumerName|| If you want to use a stub for each consumer and want to -override the consumer name just change this value. -|=============== - -[[stub-runner-stub-ids]] -==== Stub Runner Stubs IDs - -You can provide the stubs to download via the `stubrunner.ids` system property. They -follow this pattern: - -[source,java,indent=0] ----- -groupId:artifactId:version:classifier:port ----- - -Note that `version`, `classifier` and `port` are optional. - -* If you do not provide the `port`, a random one will be picked. -* If you do not provide the `classifier`, the default is used. (Note that you can -pass an empty classifier this way: `groupId:artifactId:version:`). -* If you do not provide the `version`, then the `+` will be passed and the latest one is -downloaded. - -`port` means the port of the WireMock server. - -IMPORTANT: Starting with version 1.0.4, you can provide a range of versions that you -would like the Stub Runner to take into consideration. You can read more about the -https://wiki.eclipse.org/Aether/New_and_Noteworthy#Version_Ranges[Aether versioning -ranges here]. - -[[stubrunner-docker]] -=== Stub Runner Docker - -We're publishing a `spring-cloud/spring-cloud-contract-stub-runner` Docker image -that will start the standalone version of Stub Runner. - -If you want to learn more about the basics of Maven, artifact ids, -group ids, classifiers and Artifact Managers, just click here <>. - -==== How to use it - -Just execute the docker image. You can pass any of the <> -as environment variables. The convention is that all the -letters should be upper case. The camel case notation should -and the dot (`.`) should be separated via underscore (`_`). E.g. - the `stubrunner.repositoryRoot` property should be represented - as a `STUBRUNNER_REPOSITORY_ROOT` environment variable. - -==== Example of client side usage in a non JVM project - -We'd like to use the stubs created in this <> step. -Let's assume that we want to run the stubs on port `9876`. The NodeJS code -is available here: - -```bash -$ git clone https://github.com/spring-cloud-samples/spring-cloud-contract-nodejs -$ cd bookstore -``` - -Let's run the Stub Runner Boot application with the stubs. - -```bash -# Provide the Spring Cloud Contract Docker version -$ SC_CONTRACT_DOCKER_VERSION="..." -# The IP at which the app is running and Docker container can reach it -$ APP_IP="192.168.0.100" -# Spring Cloud Contract Stub Runner properties -$ STUBRUNNER_PORT="8083" -# Stub coordinates 'groupId:artifactId:version:classifier:port' -$ STUBRUNNER_IDS="com.example:bookstore:0.0.1.RELEASE:stubs:9876" -$ STUBRUNNER_REPOSITORY_ROOT="http://${APP_IP}:8081/artifactory/libs-release-local" -# Run the docker with Stub Runner Boot -$ docker run --rm -e "STUBRUNNER_IDS=${STUBRUNNER_IDS}" -e "STUBRUNNER_REPOSITORY_ROOT=${STUBRUNNER_REPOSITORY_ROOT}" -e "STUBRUNNER_STUBS_MODE=REMOTE" -p "${STUBRUNNER_PORT}:${STUBRUNNER_PORT}" -p "9876:9876" springcloud/spring-cloud-contract-stub-runner:"${SC_CONTRACT_DOCKER_VERSION}" -``` - -What's happening is that - -- a standalone Stub Runner application got started -- it downloaded the stub with coordinates `com.example:bookstore:0.0.1.RELEASE:stubs` on port `9876` -- it got downloaded from Artifactory running at `http://192.168.0.100:8081/artifactory/libs-release-local` -- after a while Stub Runner will be running on port `8083` -- and the stubs will be running at port `9876` - -On the server side we built a stateful stub. Let's use curl to assert -that the stubs are setup properly. - -```bash -# let's execute the first request (no response is returned) -$ curl -H "Content-Type:application/json" -X POST --data '{ "title" : "Title", "genre" : "Genre", "description" : "Description", "author" : "Author", "publisher" : "Publisher", "pages" : 100, "image_url" : "https://d213dhlpdb53mu.cloudfront.net/assets/pivotal-square-logo-41418bd391196c3022f3cd9f3959b3f6d7764c47873d858583384e759c7db435.svg", "buy_url" : "https://pivotal.io" }' http://localhost:9876/api/books -# Now time for the second request -$ curl -X GET http://localhost:9876/api/books -# You will receive contents of the JSON -``` - -IMPORTANT: If you want use the stubs that you have built locally, on your host, -then you should pass the environment variable `-e STUBRUNNER_STUBS_MODE=LOCAL` and mount -the volume of your local m2 `-v "${HOME}/.m2/:/root/.m2:ro"` \ No newline at end of file diff --git a/docs/src/main/asciidoc/verifier_stubrunner_msg.adoc b/docs/src/main/asciidoc/verifier_stubrunner_msg.adoc deleted file mode 100644 index 1a5a68a96f..0000000000 --- a/docs/src/main/asciidoc/verifier_stubrunner_msg.adoc +++ /dev/null @@ -1,75 +0,0 @@ -[[stub-runner-for-messaging]] -== Stub Runner for Messaging - -Stub Runner can run the published stubs in memory. It can integrate with the following -frameworks: - -* Spring Integration -* Spring Cloud Stream -* Apache Camel -* Spring AMQP - -It also provides entry points to integrate with any other solution on the market. - -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. - -=== Stub triggering - -To trigger a message, use the `StubTrigger` interface: - -[source,groovy] ----- -include::{stubrunner_core_path}/src/main/java/org/springframework/cloud/contract/stubrunner/StubTrigger.java[lines=16..-1] ----- - -For convenience, the `StubFinder` interface extends `StubTrigger`, so you only need one -or the other in your tests. - -`StubTrigger` gives you the following options to trigger a message: - -* <> -* <> -* <> -* <> - -[[trigger-label]] -==== Trigger by Label - -[source,groovy] ----- -include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger,indent=0] ----- -[[trigger-group-artifact-ids]] -==== Trigger by Group and Artifact Ids - -[source,groovy] ----- -include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_group_artifact,indent=0] ----- - -[[trigger-artifact-ids]] -==== Trigger by Artifact Ids - -[source,groovy] ----- -include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_artifact,indent=0] ----- - -[[trigger-all-messages]] -==== Trigger All Messages - -[source,groovy] ----- -include::{tests_path}/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_all,indent=0] ----- - -include::{tests_path}/spring-cloud-contract-stub-runner-camel/README.adoc[] - -include::{tests_path}/spring-cloud-contract-stub-runner-integration/README.adoc[] - -include::{tests_path}/spring-cloud-contract-stub-runner-stream/README.adoc[] - -include::{tests_path}/spring-cloud-contract-stub-runner-amqp/README.adoc[] diff --git a/specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/RegexCreatingProperty.java b/specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/RegexCreatingProperty.java index ad098c697d..4bf7e7e900 100644 --- a/specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/RegexCreatingProperty.java +++ b/specs/spring-cloud-contract-spec-java/src/main/java/org/springframework/cloud/contract/spec/internal/RegexCreatingProperty.java @@ -21,6 +21,7 @@ package org.springframework.cloud.contract.spec.internal; */ interface RegexCreatingProperty { + // tag::regex_creating_props[] T anyAlphaUnicode(); T anyAlphaNumeric(); @@ -62,5 +63,6 @@ interface RegexCreatingProperty { T anyNonEmptyString(); T anyOf(String... values); + // end::regex_creating_props[] } diff --git a/spring-cloud-contract-stub-runner/README.adoc b/spring-cloud-contract-stub-runner/README.adoc deleted file mode 100644 index e973a7caa7..0000000000 --- a/spring-cloud-contract-stub-runner/README.adoc +++ /dev/null @@ -1,711 +0,0 @@ -:branch: master -:samples_branch: 2.2.x - -=== Stub Runner Core - -Runs stubs for service collaborators. Treating stubs as contracts of services allows to use stub-runner as an implementation of -https://martinfowler.com/articles/consumerDrivenContracts.html[Consumer Driven Contracts]. - -Stub Runner allows you to automatically download the stubs of the provided dependencies (or pick those from the classpath), start WireMock servers for them and feed them with proper stub definitions. -For messaging, special stub routes are defined. - -==== Retrieving stubs - -You can pick the following options of acquiring stubs - -- Aether based solution that downloads JARs with stubs from Artifactory / Nexus -- Classpath scanning solution that searches classpath via pattern to retrieve stubs -- Write your own implementation of the `org.springframework.cloud.contract.stubrunner.StubDownloaderBuilder` for full customization - -The latter example is described in the <> section. - -===== Stub downloading - -You can control the stub downloading via the `stubsMode` switch. It picks value from the -`StubRunnerProperties.StubsMode` enum. You can use the following options - -- `StubRunnerProperties.StubsMode.CLASSPATH` (default value) - will pick stubs from the classpath -- `StubRunnerProperties.StubsMode.LOCAL` - will pick stubs from a local storage (e.g. `.m2`) -- `StubRunnerProperties.StubsMode.REMOTE` - will pick stubs from a remote location - -Example: - -[source,java] ----- -@AutoConfigureStubRunner(repositoryRoot="https://foo.bar", ids = "com.example:beer-api-producer:+:stubs:8095", stubsMode = StubRunnerProperties.StubsMode.LOCAL) ----- - -===== Classpath scanning - -If you set the `stubsMode` property to `StubRunnerProperties.StubsMode.CLASSPATH` -(or set nothing since `CLASSPATH` is the default value) then classpath will get scanned. -Let's look at the following example: - -[source,java] ----- -@AutoConfigureStubRunner(ids = { - "com.example:beer-api-producer:+:stubs:8095", - "com.example.foo:bar:1.0.0:superstubs:8096" -}) ----- - -If you've added the dependencies to your classpath - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - com.example - beer-api-producer-restdocs - stubs - 0.0.1-SNAPSHOT - test - - - * - * - - - - - com.example.foo - bar - superstubs - 1.0.0 - test - - - * - * - - - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -testCompile("com.example:beer-api-producer-restdocs:0.0.1-SNAPSHOT:stubs") { - transitive = false -} -testCompile("com.example.foo:bar:1.0.0:superstubs") { - transitive = false -} ----- - -Then the following locations on your classpath will get scanned. For `com.example:beer-api-producer-restdocs` - -- /META-INF/com.example/beer-api-producer-restdocs/**/*.* -- /contracts/com.example/beer-api-producer-restdocs/**/*.* -- /mappings/com.example/beer-api-producer-restdocs/**/*.* - -and `com.example.foo:bar` - -- /META-INF/com.example.foo/bar/**/*.* -- /contracts/com.example.foo/bar/**/*.* -- /mappings/com.example.foo/bar/**/*.* - -TIP: As you can see you have to explicitly provide the group and artifact ids when packaging the -producer stubs. - -The producer would setup the contracts like this: - -[source,bash] ----- -└── src - └── test - └── resources - └── contracts -    └── com.example -       └── beer-api-producer-restdocs -       └── nested -       └── contract3.groovy - ----- - -To achieve proper stub packaging. - -Or using the https://github.com/spring-cloud-samples/spring-cloud-contract-samples/blob/{samples_branch}/producer_with_restdocs/pom.xml[Maven `assembly` plugin] or -https://github.com/spring-cloud-samples/spring-cloud-contract-samples/blob/{samples_branch}/producer_with_restdocs/build.gradle[Gradle Jar] task you have to create the following -structure in your stubs jar. - -[source,bash] ----- -└── META-INF - └── com.example - └── beer-api-producer-restdocs - └── 2.0.0 - ├── contracts - │   └── nested -    │ └── contract2.groovy -    └── mappings -    └── mapping.json - ----- - -By maintaining this structure classpath gets scanned and you can profit from the messaging / -HTTP stubs without the need to download artifacts. - -===== Configuring HTTP Server Stubs - -Stub Runner has a notion of a `HttpServerStub` that abstracts the underlaying -concrete implementation of the HTTP server (e.g. WireMock is one of the implementations). -Sometimes, you need to perform some additional tuning of the stub servers, -that is concrete for the given implementation. To do that, Stub Runner gives you -the `httpServerStubConfigurer` property that is available in the annotation, -JUnit rule, and is accessible via system properties, where you can provide -your implementation of the `org.springframework.cloud.contract.stubrunner.HttpServerStubConfigurer` interface. The implementations can alter -the configuration files for the given HTTP server stub. - -Spring Cloud Contract Stub Runner comes with an implementation that you -can extend, for WireMock - `org.springframework.cloud.contract.stubrunner.provider.wiremock.WireMockHttpServerStubConfigurer`. In the `configure` method -you can provide your own, custom configuration for the given stub. The use -case might be starting WireMock for the given artifact id, on an HTTPs port. Example: - -.WireMockHttpServerStubConfigurer implementation -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy[tags=wireMockHttpServerStubConfigurer] ----- - -You can then reuse it via the annotation - -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy[tags=annotation] ----- - -Whenever an https port is found, it will take precedence over the http one. - -==== Running stubs - -===== Running using main app - -You can set the following options to the main class: - -[source,groovy,indent=0] ----- --c, --classifier Suffix for the jar containing stubs (e. - g. 'stubs' if the stub jar would - have a 'stubs' classifier for stubs: - foobar-stubs ). Defaults to 'stubs' - (default: stubs) ---maxPort, --maxp Maximum port value to be assigned to - the WireMock instance. Defaults to - 15000 (default: 15000) ---minPort, --minp Minimum port value to be assigned to - the WireMock instance. Defaults to - 10000 (default: 10000) --p, --password Password to user when connecting to - repository ---phost, --proxyHost Proxy host to use for repository - requests ---pport, --proxyPort [Integer] Proxy port to use for repository - requests --r, --root Location of a Jar containing server - where you keep your stubs (e.g. http: - //nexus. - net/content/repositories/repository) --s, --stubs Comma separated list of Ivy - representation of jars with stubs. - Eg. groupid:artifactid1,groupid2: - artifactid2:classifier ---sm, --stubsMode Stubs mode to be used. Acceptable values - [CLASSPATH, LOCAL, REMOTE] --u, --username Username to user when connecting to - repository ----- - -===== HTTP Stubs - -Stubs are defined in JSON documents, whose syntax is defined in http://wiremock.org/stubbing.html[WireMock documentation] - -Example: - -[source,javascript,indent=0] ----- -{ - "request": { - "method": "GET", - "url": "/ping" - }, - "response": { - "status": 200, - "body": "pong", - "headers": { - "Content-Type": "text/plain" - } - } -} ----- - -===== Viewing registered mappings - -Every stubbed collaborator exposes list of defined mappings under `__/admin/` endpoint. - -You can also use the `mappingsOutputFolder` property to dump the mappings to files. - For annotation based approach it would look like this - -[source,java] ----- -@AutoConfigureStubRunner(ids="a.b.c:loanIssuance,a.b.c:fraudDetectionServer", -mappingsOutputFolder = "target/outputmappings/") ----- - -and for the JUnit approach like this: - -[source,java] ----- -@ClassRule @Shared StubRunnerRule rule = new StubRunnerRule() - .repoRoot("https://some_url") - .downloadStub("a.b.c", "loanIssuance") - .downloadStub("a.b.c:fraudDetectionServer") - .withMappingsOutputFolder("target/outputmappings") ----- - -Then if you check out the folder `target/outputmappings` you would see the following structure - -[source,bash] ----- -. -├── fraudDetectionServer_13705 -└── loanIssuance_12255 ----- - -That means that there were two stubs registered. `fraudDetectionServer` was registered at port `13705` -and `loanIssuance` at port `12255`. If we take a look at one of the files we would see (for WireMock) -mappings available for the given server: - -[source,json] ----- -[{ - "id" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7", - "request" : { - "url" : "/name", - "method" : "GET" - }, - "response" : { - "status" : 200, - "body" : "fraudDetectionServer" - }, - "uuid" : "f9152eb9-bf77-4c38-8289-90be7d10d0d7" -}, -... -] ----- - -===== Messaging Stubs - -Depending on the provided Stub Runner dependency and the DSL the messaging routes are automatically set up. - -=== Stub Runner JUnit Rule and Stub Runner JUnit5 Extension - -Stub Runner comes with a JUnit rule thanks to which you can very easily download and run stubs for given group and artifact id: - -[source,java,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java[tags=classrule] ----- - -There's also a `StubRunnerExtension` available for JUnit 5. `StubRunnerRule` and `StubRunnerExtension` work in a very -similar fashion. After the rule/ extension is executed, Stub Runner connects to your Maven repository and for the given list of dependencies tries to: - -- download them -- cache them locally -- unzip them to a temporary folder -- start a WireMock server for each Maven dependency on a random port from the provided range of ports / provided port -- feed the WireMock server with all JSON files that are valid WireMock definitions -- can also send messages (remember to pass an implementation of `MessageVerifier` interface) - -Stub Runner uses https://wiki.eclipse.org/Aether[Eclipse Aether] mechanism to download the Maven dependencies. -Check their https://wiki.eclipse.org/Aether[docs] for more information. - -Since the `StubRunnerRule` and `StubRunnerExtension` implement the `StubFinder` they allow you to find the started stubs: - -[source,groovy,indent=0] ----- -include::src/main/java/org/springframework/cloud/contract/stubrunner/StubFinder.java[lines=16..-1] ----- - -Example of usage in Spock tests: - -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleSpec.groovy[tags=classrule] ----- - -Example of usage in JUnit tests: - -[source,java,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java[tags=test] ----- - -JUnit 5 Extension example: - -[source,java,indent=0] ----- -include::src/test/java/org/springframework/cloud/contract/stubrunner/junit/StubRunnerJUnit5ExtensionTests.java[tags=extension] ----- - -Check the *Common properties for JUnit and Spring* for more information on how to apply global configuration of Stub Runner. - -IMPORTANT: To use the JUnit rule or JUnit 5 extension together with messaging, you have to provide an implementation of the -`MessageVerifier` interface to the rule builder (e.g. `rule.messageVerifier(new MyMessageVerifier())`). -If you don't do this, then whenever you try to send a message an exception will be thrown. - -==== Maven settings - -The stub downloader honors Maven settings for a different local repository folder. -Authentication details for repositories and profiles are currently not taken into account, so you need to specify it using the properties mentioned above. - -==== Providing fixed ports - -You can also run your stubs on fixed ports. You can do it in two different ways. One is to pass it in the properties, and the other via fluent API of -JUnit rule. - -==== Fluent API - -When using the `StubRunnerRule` or `StubRunnerExtension` you can add a stub to download and then pass the port for the last downloaded stub. - -[source,java,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java[tags=classrule_with_port] ----- - -You can see that for this example the following test is valid: - -[source,java,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java[tags=test_with_port] ----- - -==== Stub Runner with Spring - -Sets up Spring configuration of the Stub Runner project. - -By providing a list of stubs inside your configuration file the Stub Runner automatically downloads -and registers in WireMock the selected stubs. - -If you want to find the URL of your stubbed dependency you can autowire the `StubFinder` interface and use -its methods as presented below: - -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy[tags=test] ----- - -for the following configuration file: - -[source,yml,indent=0] ----- -include::src/test/resources/application-test.yml[tags=test] ----- - -Instead of using the properties you can also use the properties inside the `@AutoConfigureStubRunner`. -Below you can find an example of achieving the same result by setting values on the annotation. - -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy[tags=autoconfigure] ----- - -Stub Runner Spring registers environment variables in the following manner -for every registered WireMock server. Example for Stub Runner ids - `com.example:foo`, `com.example:bar`. - -- `stubrunner.runningstubs.foo.port` -- `stubrunner.runningstubs.com.example.foo.port` -- `stubrunner.runningstubs.bar.port` -- `stubrunner.runningstubs.com.example.bar.port` - -Which you can reference in your code. - -You can also use the `@StubRunnerPort` annotation to inject the port of a running stub. -Value of the annotation can be the `groupid:artifactid` or just the `artifactid`. Example for Stub Runner ids -`com.example:foo`, `com.example:bar`. - -[source,java,indent=0] ----- -@StubRunnerPort("foo") -int fooPort; -@StubRunnerPort("com.example:bar") -int barPort; ----- - -=== Stub Runner Spring Cloud - -Stub Runner can integrate with Spring Cloud. - -For real life examples you can check the - - - https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/producer[producer app sample] - - https://github.com/spring-cloud-samples/spring-cloud-contract-samples/tree/{samples_branch}/consumer_with_discovery[consumer app sample] - -==== Stubbing Service Discovery - -The most important feature of `Stub Runner Spring Cloud` is the fact that it's stubbing - -- `DiscoveryClient` -- `Ribbon` `ServerList` - -that means that regardless of the fact whether you're using Zookeeper, Consul, Eureka or anything else, you don't need that in your tests. -We're starting WireMock instances of your dependencies and we're telling your application whenever you're using `Feign`, load balanced `RestTemplate` -or `DiscoveryClient` directly, to call those stubbed servers instead of calling the real Service Discovery tool. - -For example this test will pass - -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy[tags=test] ----- - -for the following configuration file - -[source,yml,indent=0] ----- -include::src/test/resources/application.yml[tags=ids] ----- - -===== Test profiles and service discovery - -In your integration tests you typically don't want to call neither a discovery service (e.g. Eureka) -or Config Server. That's why you create an additional test configuration in which you want to disable -these features. - -Due to certain limitations of https://github.com/spring-cloud/spring-cloud-commons/issues/156[`spring-cloud-commons`] to achieve this you have disable these properties -via a static block like presented below (example for Eureka) - -[source,java] ----- - //Hack to work around https://github.com/spring-cloud/spring-cloud-commons/issues/156 - static { - System.setProperty("eureka.client.enabled", "false"); - System.setProperty("spring.cloud.config.failFast", "false"); - } ----- - -==== Additional Configuration - -You can match the artifactId of the stub with the name of your app by using the `stubrunner.idsToServiceIds:` map. -You can disable Stub Runner Ribbon support by providing: `stubrunner.cloud.ribbon.enabled` equal to `false` -You can disable Stub Runner support by providing: `stubrunner.cloud.enabled` equal to `false` - -TIP: By default all service discovery will be stubbed. That means that regardless of the fact if you have -an existing `DiscoveryClient` its results will be ignored. However, if you want to reuse it, just set - `stubrunner.cloud.delegate.enabled` to `true` and then your existing `DiscoveryClient` results will be - merged with the stubbed ones. - -The default Maven configuration used by Stub Runner can be tweaked either -via the following system properties or environment variables - -- `maven.repo.local` - path to the custom maven local repository location -- `org.apache.maven.user-settings` - path to custom maven user settings location -- `org.apache.maven.global-settings` - path to maven global settings location - -=== Stub Runner Boot Application - -Spring Cloud Contract Stub Runner Boot is a Spring Boot application that exposes REST endpoints to -trigger the messaging labels and to access started WireMock servers. - -One of the use-cases is to run some smoke (end to end) tests on a deployed application. -You can check out the https://github.com/spring-cloud/spring-cloud-pipelines[Spring Cloud Pipelines] -project for more information. - -==== How to use it? - -===== Stub Runner Server - -Just add the - -[source,groovy,indent=0] ----- -compile "org.springframework.cloud:spring-cloud-starter-stub-runner" ----- - -Annotate a class with `@EnableStubRunnerServer`, build a fat-jar and you're ready to go! - -For the properties check the *Stub Runner Spring* section. - -===== Stub Runner Server Fat Jar - -You can download a standalone JAR from Maven (e.g. for version 2.0.1.RELEASE), as follows: - -[source,bash,indent=0] ----- -$ wget -O stub-runner.jar 'https://search.maven.org/remotecontent?filepath=org/springframework/cloud/spring-cloud-contract-stub-runner-boot/2.0.1.RELEASE/spring-cloud-contract-stub-runner-boot-2.0.1.RELEASE.jar' -$ java -jar stub-runner.jar --stubrunner.ids=... --stubrunner.repositoryRoot=... ----- - -===== Spring Cloud CLI - -Starting from `1.4.0.RELEASE` version of the https://cloud.spring.io/spring-cloud-cli[Spring Cloud CLI] -project you can start Stub Runner Boot by executing `spring cloud stubrunner`. - -In order to pass the configuration just create a `stubrunner.yml` file in the current working directory -or a subdirectory called `config` or in `~/.spring-cloud`. The file could look like this -(example for running stubs installed locally) - -.stubrunner.yml -[source,yml,indent=0] ----- -stubrunner: - stubsMode: LOCAL - ids: - - com.example:beer-api-producer:+:9876 ----- - -and then just call `spring cloud stubrunner` from your terminal window to start -the Stub Runner server. It will be available at port `8750`. - -==== Endpoints - -===== HTTP - -- GET `/stubs` - returns a list of all running stubs in `ivy:integer` notation -- GET `/stubs/{ivy}` - returns a port for the given `ivy` notation (when calling the endpoint `ivy` can also be `artifactId` only) - -===== Messaging - -For Messaging - -- GET `/triggers` - returns a list of all running labels in `ivy : [ label1, label2 ...]` notation -- POST `/triggers/{label}` - executes a trigger with `label` -- POST `/triggers/{ivy}/{label}` - executes a trigger with `label` for the given `ivy` notation (when calling the endpoint `ivy` can also be `artifactId` only) - -==== Example - -[source,groovy,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/server/StubRunnerBootSpec.groovy[tags=boot_usage] ----- - -==== Stub Runner Boot with Service Discovery - -One of the possibilities of using Stub Runner Boot is to use it as a feed of stubs for "smoke-tests". What does it mean? - Let's assume that you don't want to deploy 50 microservice to a test environment in order - to check if your application is working fine. You've already executed a suite of tests during the build process - but you would also like to ensure that the packaging of your application is fine. What you can do - is to deploy your application to an environment, start it and run a couple of tests on it to see if - it's working fine. We can call those tests smoke-tests since their idea is to check only a handful - of testing scenarios. - -The problem with this approach is such that if you're doing microservices most likely you're - using a service discovery tool. Stub Runner Boot allows you to solve this issue by starting the - required stubs and register them in a service discovery tool. Let's take a look at an example of - such a setup with Eureka. Let's assume that Eureka was already running. - -[source,java,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/serverexamples/StubRunnerBootEurekaExample.java[tags=stubrunnereureka] ----- - -As you can see we want to start a Stub Runner Boot server `@EnableStubRunnerServer`, enable Eureka client `@EnableEurekaClient` -and we want to have the stub runner feature turned on `@AutoConfigureStubRunner`. - -Now let's assume that we want to start this application so that the stubs get automatically registered. - We can do it by running the app `java -jar ${SYSTEM_PROPS} stub-runner-boot-eureka-example.jar` where - `${SYSTEM_PROPS}` would contain the following list of properties - -[source,bash,indent=0] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/serverexamples/StubRunnerBootEurekaExample.java[tags=stubrunnereureka_args] ----- - -That way your deployed application can send requests to started WireMock servers via the service -discovery. Most likely points 1-3 could be set by default in `application.yml` cause they are not -likely to change. That way you can provide only the list of stubs to download whenever you start -the Stub Runner Boot. - -=== Stubs Per Consumer - -There are cases in which 2 consumers of the same endpoint want to have 2 different responses. - -TIP: This approach also allows you to immediately know which consumer is using which part of your API. -You can remove part of a response that your API produces and you can see which of your autogenerated tests -fails. If none fails then you can safely delete that part of the response cause nobody is using it. - -Let's look at the following example for contract defined for the producer called `producer`. -There are 2 consumers: `foo-consumer` and `bar-consumer`. - -*Consumer `foo-service`* - -[source,groovy] ----- -request { - url '/foo' - method GET() -} -response { - status OK() - body( - foo: "foo" - } -} ----- - -*Consumer `bar-service`* - -[source,groovy] ----- -request { - url '/foo' - method GET() -} -response { - status OK() - body( - bar: "bar" - } -} ----- - -You can't produce for the same request 2 different responses. That's why you can properly package the -contracts and then profit from the `stubsPerConsumer` feature. - -On the producer side the consumers can have a folder that contains contracts related only to them. -By setting the `stubrunner.stubs-per-consumer` flag to `true` we no longer register all stubs but only those that -correspond to the consumer application's name. In other words we'll scan the path of every stub and -if it contains the subfolder with name of the consumer in the path only then will it get registered. - -On the `foo` producer side the contracts would look like this - -[source,bash] ----- -. -└── contracts - ├── bar-consumer - │   ├── bookReturnedForBar.groovy - │   └── shouldCallBar.groovy - └── foo-consumer - ├── bookReturnedForFoo.groovy - └── shouldCallFoo.groovy ----- - -Being the `bar-consumer` consumer you can either set the `spring.application.name` or the `stubrunner.consumer-name` to `bar-consumer` -Or set the test as follows: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerStubsPerConsumerSpec.groovy[tags=test] -... -} ----- - -Then only the stubs registered under a path that contains the `bar-consumer` in its name (i.e. those from the -`src/test/resources/contracts/bar-consumer/some/contracts/...` folder) will be allowed to be referenced. - -Or set the consumer name explicitly - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerStubsPerConsumerWithConsumerNameSpec.groovy[tags=test] -... -} ----- - -Then only the stubs registered under a path that contains the `foo-consumer` in its name (i.e. those from the -`src/test/resources/contracts/foo-consumer/some/contracts/...` folder) will be allowed to be referenced. - -You can check out https://github.com/spring-cloud/spring-cloud-contract/issues/224[issue 224] for more -information about the reasons behind this change. \ No newline at end of file diff --git a/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java b/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java index 44fec08967..4c44099a97 100644 --- a/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java +++ b/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java @@ -62,7 +62,6 @@ public class StubRunnerRuleJUnitTest { return ""; } } - // end::test[] // tag::test[] @Test @@ -90,6 +89,7 @@ public class StubRunnerRuleJUnitTest { then(httpGet(rule.findStubUrl("fraudDetectionServer").toString() + "/name")) .isEqualTo("fraudDetectionServer"); } + // end::test[] private String httpGet(String url) throws Exception { try (InputStream stream = URI.create(url).toURL().openStream()) { diff --git a/spring-cloud-contract-verifier/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy b/spring-cloud-contract-verifier/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy index dc09c61c8f..01a5d961bd 100644 --- a/spring-cloud-contract-verifier/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy +++ b/spring-cloud-contract-verifier/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy @@ -101,6 +101,22 @@ class ContractHttpDocsSpec extends Specification { } // end::http_dsl[] + org.springframework.cloud.contract.spec.Contract methodDsl = + org.springframework.cloud.contract.spec.Contract.make { + request { + // tag::method[] + method GET() + // end::method[] + url "/foo" + } + + response { + status 200 + } + + priority 1 + } + org.springframework.cloud.contract.spec.Contract request = // tag::request[] org.springframework.cloud.contract.spec.Contract.make { diff --git a/spring-cloud-contract-verifier/src/test/resources/yml/contract.yml b/spring-cloud-contract-verifier/src/test/resources/yml/contract.yml index 1cf282d093..6f1a02c319 100644 --- a/spring-cloud-contract-verifier/src/test/resources/yml/contract.yml +++ b/spring-cloud-contract-verifier/src/test/resources/yml/contract.yml @@ -21,7 +21,7 @@ request: queryParameters: a: b b: c - #tag::query_params[] + #end::query_params[] #tag::headers[] headers: foo: bar diff --git a/tests/spring-cloud-contract-stub-runner-amqp/README.adoc b/tests/spring-cloud-contract-stub-runner-amqp/README.adoc deleted file mode 100644 index 033e4fa094..0000000000 --- a/tests/spring-cloud-contract-stub-runner-amqp/README.adoc +++ /dev/null @@ -1,125 +0,0 @@ -=== Stub Runner Spring AMQP - -Spring Cloud Contract Verifier Stub Runner's messaging module provides an easy way to -integrate with Spring AMQP's Rabbit Template. For the provided artifacts, it -automatically downloads the stubs and registers the required routes. - -The integration tries to work standalone (that is, without interaction with a running -RabbitMQ message broker). It expects a `RabbitTemplate` on the application context and -uses it as a spring boot test named `@SpyBean`. As a result, it can use the mockito spy -functionality to verify and inspect messages sent by the application. - -On the message consumer side, the stub runner considers all `@RabbitListener` annotated -endpoints and all `SimpleMessageListenerContainer` objects on the application context. - -As messages are usually sent to exchanges in AMQP, the message contract contains the -exchange name as the destination. Message listeners on the other side are bound to -queues. Bindings connect an exchange to a queue. If message contracts are triggered, the -Spring AMQP stub runner integration looks for bindings on the application context that -match this exchange. Then it collects the queues from the Spring exchanges and tries to -find message listeners bound to these queues. The message is triggered for all matching -message listeners. - -If you need to work with routing keys, it's enough to pass them via the `amqp_receivedRoutingKey` -messaging header. - -==== Adding the Runner to the Project - -You can 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`. - -IMPORTANT: If you already have Stream and Integration on the classpath, you need -to disable them explicitly by setting the `stubrunner.stream.enabled=false` and -`stubrunner.integration.enabled=false` properties. - -Assume that you have the following Maven repository with a deployed stubs for the -`spring-cloud-contract-amqp-test` application. - -[source,bash,indent=0] ----- -└── .m2 - └── repository - └── com - └── example - └── spring-cloud-contract-amqp-test - ├── 0.4.0-SNAPSHOT - │   ├── spring-cloud-contract-amqp-test-0.4.0-SNAPSHOT.pom - │   ├── spring-cloud-contract-amqp-test-0.4.0-SNAPSHOT-stubs.jar - │   └── maven-metadata-local.xml - └── maven-metadata-local.xml ----- - -Further assume that the stubs contain the following structure: - -[source,bash,indent=0] ----- -├── META-INF -│   └── MANIFEST.MF -└── contracts - └── shouldProduceValidPersonData.groovy ----- - -Consider the following contract: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpStubRunnerSpec.groovy[tags=amqp_contract,indent=0] ----- - -Now consider the following Spring configuration: - -[source,yaml] ----- -include::src/test/resources/application.yml[] ----- - -===== Triggering the message - -To trigger a message using the contract above, use the `StubTrigger` interface as -follows: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpStubRunnerSpec.groovy[tags=client_trigger,indent=0] ----- - -The message has a destination of `contract-test.exchange`, so the Spring AMQP stub runner -integration looks for bindings related to this exchange. - -[source,java] ----- -include::src/main/java/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpMessagingApplication.java[tags=amqp_binding,indent=0] ----- - -The binding definition binds the queue `test.queue`. As a result, the following listener -definition is matched and invoked with the contract message. - -[source,java] ----- -include::src/main/java/org/springframework/cloud/contract/stubrunner/messaging/amqp/AmqpMessagingApplication.java[tags=amqp_listener,indent=0] ----- - -Also, the following annotated listener matches and is invoked: -[source,java] ----- -include::src/main/java/org/springframework/cloud/contract/stubrunner/messaging/amqp/MessageSubscriberRabbitListener.java[tags=amqp_annotated_listener,indent=0] ----- - -NOTE: The message is directly handed over to the `onMessage` method of the -`MessageListener` associated with the matching `SimpleMessageListenerContainer`. - -===== Spring AMQP Test Configuration - -In order to avoid Spring AMQP trying to connect to a running broker during our tests -configure a mock `ConnectionFactory`. - -To disable the mocked ConnectionFactory, set the following property: -`stubrunner.amqp.mockConnection=false` - -[source,yaml] ----- -stubrunner: - amqp: - mockConnection: false ----- diff --git a/tests/spring-cloud-contract-stub-runner-camel/README.adoc b/tests/spring-cloud-contract-stub-runner-camel/README.adoc deleted file mode 100644 index 30c50c8e55..0000000000 --- a/tests/spring-cloud-contract-stub-runner-camel/README.adoc +++ /dev/null @@ -1,123 +0,0 @@ -:input_name: jms:input -:output_name: jms:output - -=== 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. - -==== 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`. - -==== Disabling the functionality - -If you need to disable this functionality just pass `stubrunner.camel.enabled=false` property. - -==== Examples - -===== Stubs structure - -Let us assume that we have the following Maven repository with a deployed stubs for the -`camelService` application. - -[source,bash,indent=0] ----- -└── .m2 - └── repository - └── io - └── codearte - └── accurest - └── stubs - └── camelService - ├── 0.0.1-SNAPSHOT - │   ├── camelService-0.0.1-SNAPSHOT.pom - │   ├── camelService-0.0.1-SNAPSHOT-stubs.jar - │   └── maven-metadata-local.xml - └── maven-metadata-local.xml ----- - -And the stubs contain the following structure: - -[source,bash,indent=0] ----- -├── META-INF -│   └── MANIFEST.MF -└── repository - ├── accurest - │   ├── bookDeleted.groovy - │   ├── bookReturned1.groovy - │   └── bookReturned2.groovy - └── mappings ----- - -Let's consider the following contracts (let' number it with *1*): - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=sample_dsl,indent=0] ----- - -and number *2* - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] ----- - -===== Scenario 1 (no input message) - -So as to trigger a message via the `return_book_1` label we'll use the `StubTigger` interface as follows - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger,indent=0] ----- - -Next we'll want to listen to the output of the message sent to `{output_name}` - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger_receive,indent=0] ----- - -And the received message would pass the following assertions - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger_message,indent=0] ----- - -===== Scenario 2 (output triggered by input) - -Since the route is set for you it's enough to just send a message to the `{output_name}` destination. - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_send,indent=0] ----- - -Next we'll want to listen to the output of the message sent to `{output_name}` - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_receive,indent=0] ----- - -And the received message would pass the following assertions - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_receive_message,indent=0] ----- - -===== Scenario 3 (input with no output) - -Since the route is set for you it's enough to just send a message to the `{output_name}` destination. - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] ----- diff --git a/tests/spring-cloud-contract-stub-runner-integration/README.adoc b/tests/spring-cloud-contract-stub-runner-integration/README.adoc deleted file mode 100644 index ccae044b9a..0000000000 --- a/tests/spring-cloud-contract-stub-runner-integration/README.adoc +++ /dev/null @@ -1,138 +0,0 @@ -:input_name: input -:output_name: output - -=== 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 automatically downloads -the stubs and registers the required routes. - -==== Adding the Runner to the Project - -You can have both Spring Integration and Spring Cloud Contract Stub Runner on the -classpath. Remember to annotate your test class with `@AutoConfigureStubRunner`. - -==== Disabling the functionality - -If you need to disable this functionality, set the -`stubrunner.integration.enabled=false` property. - -Assume that you have the following Maven repository with deployed stubs for the -`integrationService` application: - -[source,bash,indent=0] ----- -└── .m2 - └── repository - └── io - └── codearte - └── accurest - └── stubs - └── integrationService - ├── 0.0.1-SNAPSHOT - │   ├── integrationService-0.0.1-SNAPSHOT.pom - │   ├── integrationService-0.0.1-SNAPSHOT-stubs.jar - │   └── maven-metadata-local.xml - └── maven-metadata-local.xml ----- - -Further assume the stubs contain the following structure: - -[source,bash,indent=0] ----- -├── META-INF -│   └── MANIFEST.MF -└── repository - ├── accurest - │   ├── bookDeleted.groovy - │   ├── bookReturned1.groovy - │   └── bookReturned2.groovy - └── mappings ----- - -Consider the following contracts (numbered *1*): - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=sample_dsl,indent=0] ----- - -Now consider *2*: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] ----- - -and the following Spring Integration Route: - -[source,xml] ----- -include::src/test/resources/integration-context.xml[lines=1;18..-1] ----- - -These examples lend themselves to three scenarios: - -* <> -* <> -* <> - -[[integration-scenario-1]] -===== Scenario 1 (no input message) - -To trigger a message via the `return_book_1` label, use the `StubTigger` interface, as -follows: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_trigger,indent=0] ----- - -To listen to the output of the message sent to `{output_name}`: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_trigger_receive,indent=0] ----- - -The received message would pass the following assertions: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_trigger_message,indent=0] ----- - -[[integration-scenario-2]] -===== Scenario 2 (output triggered by input) - -Since the route is set for you, you can send a message to the `{output_name}` -destination: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_send,indent=0] ----- - -To listen to the output of the message sent to `{output_name}`: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_receive,indent=0] ----- - -The received message passes the following assertions: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=client_receive_message,indent=0] ----- - -[[integration-scenario-3]] -===== Scenario 3 (input with no output) - -Since the route is set for you, you can send a message to the `{input_name}` destination: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] ----- diff --git a/tests/spring-cloud-contract-stub-runner-stream/README.adoc b/tests/spring-cloud-contract-stub-runner-stream/README.adoc deleted file mode 100644 index fad7b0ad93..0000000000 --- a/tests/spring-cloud-contract-stub-runner-stream/README.adoc +++ /dev/null @@ -1,160 +0,0 @@ -=== Stub Runner Stream - -Spring Cloud Contract Verifier Stub Runner's messaging module gives you an easy way to -integrate with Spring Stream. For the provided artifacts, it automatically downloads the -stubs and registers the required routes. - -WARNING: If Stub Runner's integration with Stream the `messageFrom` or `sentTo` Strings -are resolved first as a `destination` of a channel and no such `destination` exists, the -destination is resolved as a channel name. - -IMPORTANT: If you want to use Spring Cloud Stream remember, to add a dependency on -`org.springframework.cloud:spring-cloud-stream-test-support`. - -[source,xml,indent=0,subs="verbatim,attributes",role="primary"] -.Maven ----- - - org.springframework.cloud - spring-cloud-stream-test-support - test - ----- - -[source,groovy,indent=0,subs="verbatim,attributes",role="secondary"] -.Gradle ----- -testCompile "org.springframework.cloud:spring-cloud-stream-test-support" ----- - -==== Adding the Runner to the Project - -You can have both Spring Cloud Stream and Spring Cloud Contract Stub Runner on the -classpath. Remember to annotate your test class with `@AutoConfigureStubRunner`. - -==== Disabling the functionality - -If you need to disable this functionality, set the `stubrunner.stream.enabled=false` -property. - -Assume that you have the following Maven repository with a deployed stubs for the -`streamService` application: - -[source,bash,indent=0] ----- -└── .m2 - └── repository - └── io - └── codearte - └── accurest - └── stubs - └── streamService - ├── 0.0.1-SNAPSHOT - │   ├── streamService-0.0.1-SNAPSHOT.pom - │   ├── streamService-0.0.1-SNAPSHOT-stubs.jar - │   └── maven-metadata-local.xml - └── maven-metadata-local.xml ----- - -Further assume the stubs contain the following structure: - -[source,bash,indent=0] ----- -├── META-INF -│   └── MANIFEST.MF -└── repository - ├── accurest - │   ├── bookDeleted.groovy - │   ├── bookReturned1.groovy - │   └── bookReturned2.groovy - └── mappings ----- - -Consider the following contracts (numbered *1*): - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=sample_dsl,indent=0] ----- - -Now consider *2*: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] ----- - -Now consider the following Spring configuration: - -[source,yaml] ----- -include::src/test/resources/application.yml[] ----- - -These examples lend themselves to three scenarios: - -* <> -* <> -* <> - -[[stream-scenario-1]] -===== Scenario 1 (no input message) - -To trigger a message via the `return_book_1` label, use the `StubTrigger` interface as -follows: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger,indent=0] ----- - -To listen to the output of the message sent to a channel whose `destination` is -`returnBook`: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger_receive,indent=0] ----- - -The received message passes the following assertions: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_trigger_message,indent=0] ----- - -[[stream-scenario-2]] -===== Scenario 2 (output triggered by input) - -Since the route is set for you, you can send a message to the `bookStorage` -`destination`: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_send,indent=0] ----- - -To listen to the output of the message sent to `returnBook`: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_receive,indent=0] ----- - -The received message passes the following assertions: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_receive_message,indent=0] ----- - -[[stream-scenario-3]] -===== Scenario 3 (input with no output) - -Since the route is set for you, you can send a message to the `{output_name}` -destination: - -[source,groovy] ----- -include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] -----