diff --git a/docs/pom.xml b/docs/pom.xml index 7a8307fd52..d02e481089 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -41,7 +41,7 @@ io.spring.asciidoctor spring-asciidoctor-extensions - 0.1.0.BUILD-SNAPSHOT + 0.1.0.RELEASE diff --git a/docs/src/main/asciidoc/images/sts_exception.png b/docs/src/main/asciidoc/images/sts_exception.png new file mode 100644 index 0000000000..8607c38a52 Binary files /dev/null and b/docs/src/main/asciidoc/images/sts_exception.png differ diff --git a/docs/src/main/asciidoc/verifier/rest.adoc b/docs/src/main/asciidoc/verifier/rest.adoc index cf27b41b4e..8779c14e84 100644 --- a/docs/src/main/asciidoc/verifier/rest.adoc +++ b/docs/src/main/asciidoc/verifier/rest.adoc @@ -51,48 +51,6 @@ include::{standalone_samples_path}/http-server/build.gradle[tags=repos,indent=0] } ---- -====== Add maven plugin with dependencies - -[source,xml,indent=0] ----- - - - - - org.springframework.cloud - spring-cloud-contract-dependencies - ${spring-cloud-contract.version} - pom - import - - - - - - - org.springframework.cloud - spring-cloud-starter-contract-verifier - test - - - - - org.springframework.cloud - spring-cloud-contract-maven-plugin - - - - convert - generateStubs - generateTests - - - - ----- - -Read more: https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract-maven-plugin/[spring-cloud-contract-maven-plugin] - ====== Add stubs By default Spring Cloud Contract Verifier is looking for stubs in `src/test/resources/contracts` directory. @@ -501,6 +459,65 @@ For Groovy Spock code use: To ensure that provider side is complaint with defined contracts, you need to invoke `mvn generateTest test` +===== FAQ with Maven Plugin + +====== Maven Plugin and STS + +In case you see the following exception while using STS + +image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-contract/1.0.x/docs/src/main/asciidoc/images/sts_exception.png[STS Exception] + +when you click on the marker you should see sth 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 just 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 + + + + + + + + + + + + + +---- + ===== Spring Cloud Contract Verifier on consumer side You can actually use the Spring Cloud Contract Verifier also for the consumer side!