/**
*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -284,7 +348,7 @@
/**
*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -318,7 +382,7 @@
/**
*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -369,6 +433,13 @@ org.springframework.cloud.contract.spec.Contract.make {
Define a package in which base classes are placed. In this case we define
+a package called hello. If there’s a contract under /contracts/hello/V1/Contract.groovy` then
+we’ll search for a HelloV1Base base class. We’re taking two last folders
+from the path and combine them into a class name.
A setup of a repo that contains all common contracts. It can exclude the target / build
+folder that gets created when you’re installing stubs locally as a consumer.
+
+
+
+
<properties>
+ <!-- We don't want the tests to be executed cause we're just build stubs -->
+ <skipTests>true</skipTests>
+ <!-- The target / build folder needs to be excluded - we don't want to check its contents -->
+ <excludeBuildFolders>true</excludeBuildFolders>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.springframework.cloud</groupId>
+ <artifactId>spring-cloud-contract-maven-plugin</artifactId>
+ <configuration>
+ <!-- By default it would search under src/test/resources/ -->
+ <contractsDirectory>${project.basedir}</contractsDirectory>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
The path in the JAR with all the contracts where contracts for this
+particular service lay. If not provided will be resolved to
+groupid/artifactid. Example:
+
+ If groupid is com.example and
+artifactid is service then the resolved
+path will be /com/example/artifactid User property is: contractsPath.
The URL from which a JAR containing the contracts should get
+downloaded. If not provided but artifactid / coordinates notation
+was provided then the current Maven's build repositories will be
+taken into consideration User property is: contractsRepositoryUrl.
If true then any file laying in a path that contains
+build or target will get excluded in
+further processing. Default value is: false. User property is: excludeBuildFolders.
Directory where the generated WireMock stubs from Groovy DSL should
+be placed. You can then mention them in your packaging task to
+create jar with stubs Default value is: ${project.build.directory}/stubs/.
The path in the JAR with all the contracts where contracts for this
+particular service lay. If not provided will be resolved to
+groupid/artifactid. Example:
+
+ If groupid is com.example and
+artifactid is service then the resolved
+path will be /com/example/artifactid
The URL from which a JAR containing the contracts should get
+downloaded. If not provided but artifactid / coordinates notation
+was provided then the current Maven's build repositories will be
+taken into consideration
Directory where the generated WireMock stubs from Groovy DSL should
+be placed. You can then mention them in your packaging task to
+create jar with stubs
Incubating feature. You can check the size of JSON arrays. If not
+turned on explicitly will be disabled. Default value is: false. User property is: spring.cloud.contract.verifier.assert.size.
A way to override any base class mappings. The keys are regular
+expressions on the package name of the contract and the values FQN
+to a base class for that given expression.
+
+ Example of a mapping
+
+ .*.com.example.v1..* ->
+com.example.SomeBaseClass
+
+ When a contract's package matches the provided regular expression
+then extending class will be the one provided in the map - in this
+case com.example.SomeBaseClass User property is: baseClassMappings.
(no description) Default value is: ${project.basedir}/src/test/resources/contracts. User property is: spring.cloud.contract.verifier.contractsDirectory.
The path in the JAR with all the contracts where contracts for this
+particular service lay. If not provided will be resolved to
+groupid/artifactid. Example:
+
+ If groupid is com.example and
+artifactid is service then the resolved
+path will be /com/example/artifactid User property is: contractsPath.
The URL from which a JAR containing the contracts should get
+downloaded. If not provided but artifactid / coordinates notation
+was provided then the current Maven's build repositories will be
+taken into consideration User property is: contractsRepositoryUrl.
A package that contains all the base clases for generated tests. If
+your contract resides in a location
+src/test/resources/contracts/com/example/v1/ and you
+provide the packageWithBaseClasses value to
+com.example.contracts.base then we will search for a
+test source file that will have the package
+com.example.contracts.base and name
+ExampleV1Base. As you can see it will take the two
+last folders to and attach Base to its name. User property is: packageWithBaseClasses.
A way to override any base class mappings. The keys are regular
+expressions on the package name of the contract and the values FQN
+to a base class for that given expression.
+
+ Example of a mapping
+
+ .*.com.example.v1..* ->
+com.example.SomeBaseClass
+
+ When a contract's package matches the provided regular expression
+then extending class will be the one provided in the map - in this
+case com.example.SomeBaseClass
The path in the JAR with all the contracts where contracts for this
+particular service lay. If not provided will be resolved to
+groupid/artifactid. Example:
+
+ If groupid is com.example and
+artifactid is service then the resolved
+path will be /com/example/artifactid
The URL from which a JAR containing the contracts should get
+downloaded. If not provided but artifactid / coordinates notation
+was provided then the current Maven's build repositories will be
+taken into consideration
A package that contains all the base clases for generated tests. If
+your contract resides in a location
+src/test/resources/contracts/com/example/v1/ and you
+provide the packageWithBaseClasses value to
+com.example.contracts.base then we will search for a
+test source file that will have the package
+com.example.contracts.base and name
+ExampleV1Base. As you can see it will take the two
+last folders to and attach Base to its name.
Display help information on
+spring-cloud-contract-maven-plugin.
+Call mvn spring-cloud-contract:help -Ddetail=true
+-Dgoal=<goal-name> to display parameter details.
+
+
Attributes:
+
+
+
+
The goal is thread-safe and supports parallel builds.
Just to make long story short - Spring Cloud Contract Verifier is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications.
@@ -206,6 +335,40 @@
Spring Cloud Contract Verifier moves TDD to the level of software architecture.
/**
*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/1.0.x/spring-cloud-contract-maven-plugin/license.html b/1.0.x/spring-cloud-contract-maven-plugin/license.html
new file mode 100644
index 0000000000..d349e00069
--- /dev/null
+++ b/1.0.x/spring-cloud-contract-maven-plugin/license.html
@@ -0,0 +1,735 @@
+
+
+
+
+
+
+
+
+ Spring Cloud Contract Maven Plugin – Project Licenses
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Typically the licenses listed for the project are that of the project itself, and not of dependencies.
+
+
Project Licenses
+
+
Apache License, Version 2.0
+
Copyright 2014-2015 the original author or authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.
+
+See the License for the specific language governing permissions and
+limitations under the License.
"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty
+percent (50%) or more of the outstanding shares, or (iii) beneficial
+ownership of such entity.
+
"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source,
+and configuration files.
+
"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled
+object code, generated documentation, and conversions to other media types.
+
"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that
+is included in or attached to the work (an example is provided in the
+Appendix below).
+
"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as
+a whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its
+representatives, including but not limited to communication on electronic
+mailing lists, source code control systems, and issue tracking systems that
+are managed by, or on behalf of, the Licensor for the purpose of discussing
+and improving the Work, but excluding communication that is conspicuously
+marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
2. Grant of Copyright License. Subject to the
+terms and conditions of this License, each Contributor hereby grants to You
+a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of, publicly
+display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
3. Grant of Patent License. Subject to the terms
+and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made, use,
+offer to sell, sell, import, and otherwise transfer the Work, where such
+license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by
+combination of their Contribution(s) with the Work to which such
+Contribution(s) was submitted. If You institute patent litigation against
+any entity (including a cross-claim or counterclaim in a lawsuit) alleging
+that the Work or a Contribution incorporated within the Work constitutes
+direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the
+date such litigation is filed.
+
4. Redistribution. You may reproduce and
+distribute copies of the Work or Derivative Works thereof in any medium,
+with or without modifications, and in Source or Object form, provided that
+You meet the following conditions:
+
+
You must give any other recipients of the Work or Derivative Works a
+copy of this License; and
+
+
You must cause any modified files to carry prominent notices stating
+that You changed the files; and
+
+
You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to
+any part of the Derivative Works; and
+
+
If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy
+of the attribution notices contained within such NOTICE file, excluding
+those notices that do not pertain to any part of the Derivative Works, in
+at least one of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or documentation,
+if provided along with the Derivative Works; or, within a display generated
+by the Derivative Works, if and wherever such third-party notices normally
+appear. The contents of the NOTICE file are for informational purposes only
+and do not modify the License. You may add Your own attribution notices
+within Derivative Works that You distribute, alongside or as an addendum to
+the NOTICE text from the Work, provided that such additional attribution
+notices cannot be construed as modifying the License.
+
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+
+
+
+
+
5. Submission of Contributions. Unless You
+explicitly state otherwise, any Contribution intentionally submitted for
+inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the
+terms of any separate license agreement you may have executed with Licensor
+regarding such Contributions.
+
6. Trademarks. This License does not grant
+permission to use the trade names, trademarks, service marks, or product
+names of the Licensor, except as required for reasonable and customary use
+in describing the origin of the Work and reproducing the content of the
+NOTICE file.
+
7. Disclaimer of Warranty. Unless required by
+applicable law or agreed to in writing, Licensor provides the Work (and
+each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including,
+without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You
+are solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise
+of permissions under this License.
+
8. Limitation of Liability. In no event and
+under no legal theory, whether in tort (including negligence), contract, or
+otherwise, unless required by applicable law (such as deliberate and
+grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a result
+of this License or out of the use or inability to use the Work (including
+but not limited to damages for loss of goodwill, work stoppage, computer
+failure or malfunction, or any and all other commercial damages or losses),
+even if such Contributor has been advised of the possibility of such
+damages.
+
9. Accepting Warranty or Additional Liability.
+While redistributing the Work or Derivative Works thereof, You may choose
+to offer, and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this License.
+However, in accepting such obligations, You may act only on Your own behalf
+and on Your sole responsibility, not on behalf of any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor
+harmless for any liability incurred by, or claims asserted against, such
+Contributor by reason of your accepting any such warranty or additional
+liability.
+
END OF TERMS AND CONDITIONS
+
APPENDIX: How to apply the Apache License to your work¶
+
To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included
+on the same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
Display help information on
+spring-cloud-contract-maven-plugin.
+Call mvn spring-cloud-contract:help -Ddetail=true
+-Dgoal=<goal-name> to display parameter details.
This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.
This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.
/**
*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
diff --git a/1.0.x/spring-cloud-contract-maven-plugin/team-list.html b/1.0.x/spring-cloud-contract-maven-plugin/team-list.html
new file mode 100644
index 0000000000..3ed5018c3a
--- /dev/null
+++ b/1.0.x/spring-cloud-contract-maven-plugin/team-list.html
@@ -0,0 +1,372 @@
+
+
+
+
+
+
+
+
+ Spring Cloud Contract Maven Plugin – Project Team
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.
+
The project team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.
+
+
Members
+
The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.
-1. Additional configuration inside ~/.m2/settings.xml is required: <pluginGroups><pluginGroup>io.codearte.Spring Cloud Contract</pluginGroup></pluginGroups>.
+1. Additional configuration inside ~/.m2/settings.xml is required: <pluginGroups><pluginGroup> org.springramework.cloud:spring-cloud-contract-maven-plugin</pluginGroup></pluginGroups>.
diff --git a/1.0.x/spring-cloud-contract.html b/1.0.x/spring-cloud-contract.html
index 5be567ea73..8f6bee031f 100644
--- a/1.0.x/spring-cloud-contract.html
+++ b/1.0.x/spring-cloud-contract.html
@@ -2631,7 +2631,7 @@ one to one to the contents of the repo.
-
As you can see there are no dependencies other than the Spring Cloud Contract Verifier Maven plugin.
+
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.
@@ -3503,7 +3503,7 @@ Let’s take a look at the following example:
<baseClassMapping>
<contractPackageRegex>.*com.*</contractPackageRegex>
<baseClassFQN>com.example.TestBase</baseClassFQN>
- </baseClassMapping >
+ </baseClassMapping>
</baseClassMappings>
</configuration>
</plugin>
@@ -3524,7 +3524,7 @@ will be extending the com.example.ComBase whereas the rest of tests
Invoking generated tests
-
Spring Cloud Contract Verifier Maven Plugin generates verification code into directory /generated-test-sources/contractVerifier and attach this directory to testCompile goal.
+
Spring Cloud Contract Maven Plugin generates verification code into directory /generated-test-sources/contractVerifier and attach this directory to testCompile goal.
For Groovy Spock code use:
@@ -4456,7 +4456,7 @@ Check their docs for more informat
/*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -5136,7 +5136,7 @@ the Stub Runner Boot.
/*
- * Copyright 2013-2016 the original author or authors.
+ * Copyright 2013-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -5515,7 +5515,7 @@ Remember to annotate your test class with @AutoConfigureMessageVerifier
<?xml version="1.0" encoding="UTF-8"?>
<!--
- ~ Copyright 2013-2016 the original author or authors.
+ ~ Copyright 2013-2017 the original author or authors.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.