diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.gitignore b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.gitignore new file mode 100644 index 0000000000..2c95b068c5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.gitignore @@ -0,0 +1,13 @@ +.idea/ +*.iml +/target +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +release.properties +dependency-reduced-pom.xml +buildNumber.properties +.mvn/timing.properties + +target \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.mvn/codesigning.asc.enc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.mvn/codesigning.asc.enc new file mode 100644 index 0000000000..da867ac9b1 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.mvn/codesigning.asc.enc differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.mvn/wrapper/maven-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000000..6637cedb28 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1 @@ +distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.3.9/apache-maven-3.3.9-bin.zip \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.travis.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.travis.yml new file mode 100644 index 0000000000..7d7bc617b2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/.travis.yml @@ -0,0 +1,5 @@ +language: java +jdk: +- oraclejdk8 +script: +- ./mvnw clean test jacoco:report coveralls:report -pl spring-cloud-contract-verifier-maven-plugin \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/LICENSE.md b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/LICENSE.md new file mode 100644 index 0000000000..74640422d1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/LICENSE.md @@ -0,0 +1,194 @@ +Apache License +============== + +_Version 2.0, January 2004_ +_<>_ + +### Terms and Conditions for use, reproduction, and distribution + +#### 1. Definitions + +“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: + +* **(a)** You must give any other recipients of the Work or Derivative Works a copy of +this License; and +* **(b)** You must cause any modified files to carry prominent notices stating that You +changed the files; and +* **(c)** 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 +* **(d)** 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 2016 Codearte + + 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. diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/README.adoc new file mode 100644 index 0000000000..ccd77f7328 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/README.adoc @@ -0,0 +1,60 @@ +// Do not edit this file (e.g. go instead to src/main/asciidoc) + +image::https://travis-ci.org/Codearte/accurest-maven-plugin.svg?branch=master[Build Status, link=https://travis-ci.org/Codearte/accurest-maven-plugin] +image::https://img.shields.io/github/issues/Codearte/accurest/maven.svg[Github Issues, link=https://github.com/Codearte/accurest/labels/maven] + +//[![Maven Central](https://img.shields.io/maven-central/v/io.codearte.accurest/accurest-maven-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/io.codearte.accurest/accurest-maven-plugin) + += Spring Cloud Contract Verifier Maven Plugin + +== Documentation + +* http://codearte.github.io/accurest/[Spring Cloud Contract Verifier Documentation] +* http://codearte.github.io/accurest-maven-plugin/plugin-info.html[Spring Cloud Contract Verifier Maven Plugin Documentation Site] + +== Contributing + +Spring Cloud is released under the non-restrictive Apache 2.0 license, +and follows a very standard Github development process, using Github +tracker for issues and merging pull requests into master. If you want +to contribute even something trivial please do not hesitate, but +follow the guidelines below. + +=== Sign the Contributor License Agreement +Before we accept a non-trivial patch or pull request we will need you to sign the +https://support.springsource.com/spring_committer_signup[contributor's agreement]. +Signing the contributor's agreement does not grant anyone commit rights to the main +repository, but it does mean that we can accept your contributions, and you will get an +author credit if we do. Active contributors might be asked to join the core team, and +given the ability to merge pull requests. + +=== Code of Conduct +This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of +conduct]. By participating, you are expected to uphold this code. Please report +unacceptable behavior to spring-code-of-conduct@pivotal.io. + +=== Code Conventions and Housekeeping +None of these is essential for a pull request, but they will all help. They can also be +added after the original pull request but before a merge. + +* Use the Spring Framework code format conventions. If you use Eclipse + you can import formatter settings using the + `eclipse-code-formatter.xml` file from the + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring + Cloud Build] project. If using IntelliJ, you can use the + http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter + Plugin] to import the same file. +* Make sure all new `.java` files to have a simple Javadoc class comment with at least an + `@author` tag identifying you, and preferably at least a paragraph on what the class is + for. +* Add the ASF license header comment to all new `.java` files (copy from existing files + in the project) +* Add yourself as an `@author` to the .java files that you modify substantially (more + than cosmetic changes). +* Add some Javadocs and, if you change the namespace, some XSD doc elements. +* A few unit tests would help a lot as well -- someone has to do it. +* If no-one else is using your branch, please rebase it against the current master (or + other target branch in the main project). +* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], + if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit + message (where XXXX is the issue number). \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/pom.xml new file mode 100644 index 0000000000..1c02de1ddb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/pom.xml @@ -0,0 +1,57 @@ + + + 4.0.0 + + org.springframework.cloud + spring-cloud-build + 1.1.1.RELEASE + + + + spring-cloud-contract-verifier-docs + pom + Spring Cloud Contract Verifier Docs + Spring Contract Verifier Docs + 1.0.0.BUILD-SNAPSHOT + + spring-cloud-contract-verifier-maven-plugin + ${basedir}/.. + + + + docs + + + + org.asciidoctor + asciidoctor-maven-plugin + 1.5.3 + false + + + org.apache.maven.plugins + maven-antrun-plugin + false + + + org.codehaus.mojo + build-helper-maven-plugin + false + + + + + + + + + org.apache.maven.plugins + maven-deploy-plugin + + true + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/asciidoc/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/asciidoc/README.adoc new file mode 100644 index 0000000000..ac49eb468b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/asciidoc/README.adoc @@ -0,0 +1,15 @@ +image::https://travis-ci.org/Codearte/accurest-maven-plugin.svg?branch=master[Build Status, link=https://travis-ci.org/Codearte/accurest-maven-plugin] +image::https://img.shields.io/github/issues/Codearte/accurest/maven.svg[Github Issues, link=https://github.com/Codearte/accurest/labels/maven] + +//[![Maven Central](https://img.shields.io/maven-central/v/io.codearte.accurest/accurest-maven-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/io.codearte.accurest/accurest-maven-plugin) + += Spring Cloud Contract Verifier Maven Plugin + +== Documentation + +* http://codearte.github.io/accurest/[Spring Cloud Contract Verifier Documentation] +* http://codearte.github.io/accurest-maven-plugin/plugin-info.html[Spring Cloud Contract Verifier Maven Plugin Documentation Site] + +== Contributing + +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/asciidoc/spring-cloud-contract-verifier-maven-plugin.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/asciidoc/spring-cloud-contract-verifier-maven-plugin.adoc new file mode 100644 index 0000000000..b2fd89ebfd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/asciidoc/spring-cloud-contract-verifier-maven-plugin.adoc @@ -0,0 +1,3 @@ +:root_folder: ../../../../spring-cloud-contract-verifier-maven-plugin + +include::{root_folder}/src/site/asciidoc/complex-content.adoc[] \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/ruby/generate_readme.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/ruby/generate_readme.sh new file mode 100755 index 0000000000..6d0ce9dc54 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/docs/src/main/ruby/generate_readme.sh @@ -0,0 +1,37 @@ +#!/usr/bin/env ruby + +base_dir = File.join(File.dirname(__FILE__),'../../..') +src_dir = File.join(base_dir, "/src/main/asciidoc") +require 'asciidoctor' +require 'optparse' + +options = {} +file = "#{src_dir}/README.adoc" + +OptionParser.new do |o| + o.on('-o OUTPUT_FILE', 'Output file (default is stdout)') { |file| options[:to_file] = file unless file=='-' } + o.on('-h', '--help') { puts o; exit } + o.parse! +end + +file = ARGV[0] if ARGV.length>0 + +# Copied from https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/scripts/asciidoc-coalescer.rb +doc = Asciidoctor.load_file file, safe: :unsafe, header_only: true, attributes: options[:attributes] +header_attr_names = (doc.instance_variable_get :@attributes_modified).to_a +header_attr_names.each {|k| doc.attributes[%(#{k}!)] = '' unless doc.attr? k } +attrs = doc.attributes +attrs['allow-uri-read'] = true +puts attrs + +out = "// Do not edit this file (e.g. go instead to src/main/asciidoc)\n\n" +doc = Asciidoctor.load_file file, safe: :unsafe, parse: false, attributes: attrs +out << doc.reader.read + +unless options[:to_file] + puts out +else + File.open(options[:to_file],'w+') do |file| + file.write(out) + end +end diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/mvnw b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/mvnw new file mode 100755 index 0000000000..349bef124b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/mvnw @@ -0,0 +1,243 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven2 Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +VERSION=$(awk '/ 0) {$0=$0} 1' `dirname $0`/pom.xml| grep '\(.*\)<.*/\1/') +if echo $VERSION | egrep -q 'M|RC'; then + echo Activating \"milestone\" profile for version=\"$VERSION\" + echo $MAVEN_ARGS | grep -q milestone || MAVEN_ARGS="$MAVEN_ARGS -Pmilestone" +else + echo Deactivating \"milestone\" profile for version=\"$VERSION\" + echo $MAVEN_ARGS | grep -q milestone && MAVEN_ARGS=$(echo $MAVEN_ARGS | sed -e 's/-Pmilestone//') +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # + # Look for the Apple JDKs first to preserve the existing behaviour, and then look + # for the new JDKs provided by Oracle. + # + if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK ] ; then + # + # Apple JDKs + # + export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/CurrentJDK/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -L /System/Library/Java/JavaVirtualMachines/CurrentJDK ] ; then + # + # Apple JDKs + # + export JAVA_HOME=/System/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -L "/Library/Java/JavaVirtualMachines/CurrentJDK" ] ; then + # + # Oracle JDKs + # + export JAVA_HOME=/Library/Java/JavaVirtualMachines/CurrentJDK/Contents/Home + fi + + if [ -z "$JAVA_HOME" ] && [ -x "/usr/libexec/java_home" ]; then + # + # Apple JDKs + # + export JAVA_HOME=`/usr/libexec/java_home` + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Migwn, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" + # TODO classpath? +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="`which java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + local basedir=$(pwd) + local wdir=$(pwd) + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + wdir=$(cd "$wdir/.."; pwd) + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-$(find_maven_basedir)} +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} ${MAVEN_ARGS} "$@" + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/mvnw.cmd b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/mvnw.cmd new file mode 100644 index 0000000000..001048081d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/mvnw.cmd @@ -0,0 +1,145 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Maven2 Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" +if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +set MAVEN_CMD_LINE_ARGS=%MAVEN_CONFIG% %* + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" + +set WRAPPER_JAR=""%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CMD_LINE_ARGS% +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" +if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%" == "on" pause + +if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% + +exit /B %ERROR_CODE% diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/pom.xml new file mode 100644 index 0000000000..2139d3fc35 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/pom.xml @@ -0,0 +1,151 @@ + + + 4.0.0 + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin-parent + pom + 1.0.0.BUILD-SNAPSHOT + + Spring Cloud Contract Verifier Maven Plugin + Spring Cloud Contract Verifier Maven Plugin Parent + https://github.com/Codearte/accurest-maven-plugin + + 2016 + + + docs + spring-cloud-contract-verifier-maven-plugin + + + + [3.2.1,) + + + + Codearte + http://codearte.io/ + + + + + mariuszs + Mariusz Smykula + mariuszs@gmail.com + + + marcingrzejszczak + Marcin Grzejszczak + marcin@grzejszczak.pl + + + + + + Apache 2 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + A business-friendly OSS license + + + + + scm:git:https://github.com/Codearte/accurest-maven-plugin.git + scm:git:git@github.com:Codearte/accurest-maven-plugin.git + https://github.com/Codearte/accurest-maven-plugin + HEAD + + + + GitHub Issues + https://github.com/Codearte/accurest/labels/maven + + + + Travis + https://travis-ci.org/Codearte/accurest-maven-plugin + + + + + + + org.codehaus.gmavenplus + gmavenplus-plugin + 1.5 + + + org.codehaus.plexus + plexus-component-metadata + 1.6 + + + maven-plugin-plugin + ${maven.plugin.plugin.version} + + + io.takari.maven.plugins + takari-lifecycle-plugin + 1.12.0 + + + org.apache.maven.plugins + maven-failsafe-plugin + 2.19.1 + + + com.mycila + license-maven-plugin + 3.0.rc1 + + + org.jacoco + jacoco-maven-plugin + 0.7.6.201602180812 + + + org.eluder.coveralls + coveralls-maven-plugin + 4.1.0 + + + org.apache.maven.plugins + maven-release-plugin + 2.5.3 + + + org.apache.maven.plugins + maven-scm-publish-plugin + 1.1 + + + org.apache.maven.plugins + maven-site-plugin + 3.4 + + + maven-install-plugin + 2.5.2 + + + maven-source-plugin + 3.0.0 + + + maven-javadoc-plugin + 2.10.3 + + + + + + org.apache.maven.plugins + maven-deploy-plugin + + true + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/pom.xml new file mode 100644 index 0000000000..17d3dfe4d6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/pom.xml @@ -0,0 +1,473 @@ + + + 4.0.0 + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + maven-plugin + 1.0.0.BUILD-SNAPSHOT + + Spring Cloud Contract Verifier Maven Plugin + Spring Cloud Contract Verifier Maven Plugin + https://github.com/Codearte/accurest-maven-plugin + + + 3.2.5 + 3.4 + + UTF-8 + UTF-8 + + 1.0.0.BUILD-SNAPSHOT + 1.1.0 + + 1.7 + 1.7 + + + 2016 + + + + repo.spring.io + Spring Release Repository + https://repo.spring.io/plugins-release-local + + + repo.spring.io + Spring Snapshot Repository + https://repo.spring.io/plugins-snapshot-local + + + github + scm:git:ssh://git@github.com:Codearte/accurest-maven-plugin.git + + + + + + + org.codehaus.gmavenplus + gmavenplus-plugin + + + + addSources + generateStubs + compile + removeStubs + + + + + + org.codehaus.plexus + plexus-component-metadata + + + + generate-metadata + generate-test-metadata + + + + + + maven-plugin-plugin + + true + + + + generated-helpmojo + + helpmojo + + + + generate-descriptor + + descriptor + + + + + + io.takari.maven.plugins + takari-lifecycle-plugin + true + + + testProperties + process-test-resources + + testProperties + + + + + + org.apache.maven.plugins + maven-failsafe-plugin + + + + integration-test + verify + + + + + + com.mycila + license-maven-plugin + +
src/etc/header.txt
+ + src/** + + + **/.idea/** + **/*.adoc + + true + true + + ${project.inceptionYear} + Codearte + + UTF-8 + + + + + check + + + + + + org.jacoco + jacoco-maven-plugin + + + **/HelpMojo.class + + + + + prepare-agent + + prepare-agent + + + + + + org.eluder.coveralls + coveralls-maven-plugin + + + org.apache.maven.plugins + maven-release-plugin + + false + true + v@{project.version} + + + + org.apache.maven.plugins + maven-scm-publish-plugin + + ${project.scm.developerConnection} + gh-pages + ${project.reporting.outputDirectory} + + + + scm-publish + site-deploy + + publish-scm + + + + + + org.apache.maven.plugins + maven-site-plugin + + true + + true + true + false + en + UTF-8 + UTF-8 + + + + font + coderay + style + 2 + + + + + + org.asciidoctor + asciidoctor-maven-plugin + 1.5.3 + + + + + + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-core + ${spring.cloud.contract.verifier.version} + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-converters + ${spring.cloud.contract.verifier.version} + + + org.springframework.cloud.contract + spring-cloud-contract-stub-runner + ${spring.cloud.contract.verifier.version} + + + + org.eclipse.aether + aether-api + ${aether.version} + provided + + + + org.apache.maven.shared + maven-filtering + 3.1.0 + + + + ch.qos.logback + logback-core + 1.1.3 + + + org.slf4j + slf4j-simple + 1.7.12 + test + + + + javax.inject + javax.inject + 1 + provided + + + org.apache.maven + maven-core + ${maven.version} + provided + + + + org.apache.maven + maven-plugin-api + ${maven.version} + provided + + + org.apache.maven + maven-model + + + org.apache.maven + maven-artifact + + + org.eclipse.sisu + org.eclipse.sisu.plexus + + + + + org.apache.maven.plugin-tools + maven-plugin-annotations + ${maven.plugin.plugin.version} + provided + + + + org.apache.maven + maven-archiver + 3.0.0 + + + org.codehaus.plexus + plexus-archiver + 3.1 + + + + io.takari.maven.plugins + takari-plugin-testing + 2.9.0 + test + + + io.takari.maven.plugins + takari-plugin-integration-testing + 2.9.0 + pom + test + + + org.apache.maven + maven-compat + ${maven.version} + test + + + junit + junit + 4.12 + test + + + org.assertj + assertj-core + 2.4.0 + test + + + + + + + release + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.6 + + + sign-artifacts + verify + + sign + + + + + + org.apache.maven.plugins + maven-source-plugin + 3.0.0 + + + attach-sources + + jar-no-fork + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.3 + + + attach-javadocs + + jar + + + + + + + + + spring + + true + + + + spring-snapshots + Spring Snapshots + http://repo.spring.io/libs-snapshot-local + + true + + + + spring-milestones + Spring Milestones + http://repo.spring.io/libs-milestone-local + + false + + + + spring-releases + Spring Releases + http://repo.spring.io/release + + false + + + + + + spring-snapshots + Spring Snapshots + http://repo.spring.io/libs-snapshot-local + + true + + + + spring-milestones + Spring Milestones + http://repo.spring.io/libs-milestone-local + + false + + + + spring-plugin-snapshots + Spring Snapshots + http://repo.spring.io/plugins-snapshot-local + + true + + + + spring-plugin-milestones + Spring Milestones + http://repo.spring.io/plugins-milestone-local + + false + + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/etc/header.txt b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/etc/header.txt new file mode 100644 index 0000000000..771f93dfec --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/etc/header.txt @@ -0,0 +1,14 @@ + + Copyright 2013-${year} 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. diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/CopyContracts.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/CopyContracts.groovy new file mode 100644 index 0000000000..25f2014644 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/CopyContracts.groovy @@ -0,0 +1,63 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.apache.maven.execution.MavenSession +import org.apache.maven.model.Resource +import org.apache.maven.plugin.MojoExecutionException +import org.apache.maven.project.MavenProject +import org.apache.maven.shared.filtering.MavenFilteringException +import org.apache.maven.shared.filtering.MavenResourcesExecution +import org.apache.maven.shared.filtering.MavenResourcesFiltering + +@CompileStatic +@Slf4j +class CopyContracts { + + private final MavenProject project + private final MavenSession mavenSession + private final MavenResourcesFiltering mavenResourcesFiltering + + CopyContracts(MavenProject project, MavenSession mavenSession, MavenResourcesFiltering mavenResourcesFiltering) { + this.project = project + this.mavenSession = mavenSession + this.mavenResourcesFiltering = mavenResourcesFiltering + } + + void copy(File contractsDirectory, File outputDirectory) { + log.info('Copying Spring Cloud Contract Verifier contracts') + Resource testResource = new Resource(directory: contractsDirectory.absolutePath) + MavenResourcesExecution mavenResourcesExecution = new MavenResourcesExecution( + resources: [testResource], + outputDirectory: new File(outputDirectory, 'contracts'), + mavenProject: project, + encoding: 'UTF-8', + mavenSession: mavenSession); + mavenResourcesExecution.injectProjectBuildFilters = false + mavenResourcesExecution.overwrite = true + mavenResourcesExecution.includeEmptyDirs = false + mavenResourcesExecution.filterFilenames = false + try { + mavenResourcesFiltering.filterResources(mavenResourcesExecution); + } catch (MavenFilteringException e) { + throw new MojoExecutionException(e.getMessage(), e); + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/ManifestCreator.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/ManifestCreator.groovy new file mode 100644 index 0000000000..e6dd688d85 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/ManifestCreator.groovy @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven + +import org.apache.maven.model.Plugin +import org.apache.maven.project.MavenProject +import org.codehaus.plexus.archiver.jar.Manifest + +class ManifestCreator { + static Manifest createManifest(MavenProject project) { + Manifest manifest = new Manifest(); + Plugin verifierMavenPlugin = project.getBuildPlugins().find { it.artifactId == 'spring-cloud-contract-verifier-maven-plugin' } + manifest.addConfiguredAttribute(new Manifest.Attribute("Spring-Cloud-Contract-Verifier-Maven-Plugin-Version", verifierMavenPlugin.version)); + if (verifierMavenPlugin.getDependencies()) { + String verifierVersion = verifierMavenPlugin.getDependencies().find { + it.artifactId == 'spring-cloud-contract-verifier-core' + }.version + manifest.addConfiguredAttribute(new Manifest.Attribute("Spring-Cloud-Contract-Verifier-Version", verifierVersion)); + } + return manifest + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/AetherStubDownloaderFactory.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/AetherStubDownloaderFactory.groovy new file mode 100644 index 0000000000..f6aa07e085 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/AetherStubDownloaderFactory.groovy @@ -0,0 +1,49 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.apache.maven.project.MavenProject +import org.eclipse.aether.RepositorySystem +import org.eclipse.aether.RepositorySystemSession +import org.springframework.cloud.contract.stubrunner.AetherStubDownloader + +import javax.inject.Inject +import javax.inject.Named +import javax.inject.Singleton + +@Named +@Singleton +@CompileStatic +@Slf4j +class AetherStubDownloaderFactory { + + private final MavenProject project + private final RepositorySystem repoSystem + + @Inject + AetherStubDownloaderFactory(RepositorySystem repoSystem, MavenProject project) { + this.repoSystem = repoSystem + this.project = project + } + + AetherStubDownloader build(RepositorySystemSession repoSession) { + return new AetherStubDownloader(repoSystem, project.remoteProjectRepositories, repoSession) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/LocalStubRunner.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/LocalStubRunner.groovy new file mode 100644 index 0000000000..687c3e1cd0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/LocalStubRunner.groovy @@ -0,0 +1,38 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.stubrunner.StubConfiguration +import org.springframework.cloud.contract.stubrunner.StubRunner +import org.springframework.cloud.contract.stubrunner.StubRunnerOptions + +import javax.inject.Named + +@Named +@CompileStatic +@Slf4j +class LocalStubRunner { + + StubRunner run(String contractsDir, StubRunnerOptions options) { + log.info("Launching StubRunner with contracts from ${contractsDir}") + StubRunner stubRunner = new StubRunner(options, contractsDir, new StubConfiguration(contractsDir)) + stubRunner.runStubs() + return stubRunner + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/RemoteStubRunner.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/RemoteStubRunner.groovy new file mode 100644 index 0000000000..f85e6f80a2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/maven/stubrunner/RemoteStubRunner.groovy @@ -0,0 +1,52 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.eclipse.aether.RepositorySystemSession +import org.springframework.cloud.contract.stubrunner.* + +import javax.inject.Inject +import javax.inject.Named + +@Named +@CompileStatic +@Slf4j +class RemoteStubRunner { + + private final AetherStubDownloaderFactory aetherStubDownloaderFactory + + @Inject + RemoteStubRunner(AetherStubDownloaderFactory aetherStubDownloaderFactory) { + this.aetherStubDownloaderFactory = aetherStubDownloaderFactory + } + + BatchStubRunner run(StubRunnerOptions options, RepositorySystemSession repositorySystemSession) { + AetherStubDownloader stubDownloader = aetherStubDownloaderFactory.build(repositorySystemSession) + try { + log.debug("Launching StubRunner with args: $options") + BatchStubRunner stubRunner = new BatchStubRunnerFactory(options, stubDownloader).buildBatchStubRunner() + RunningStubs runningCollaborators = stubRunner.runStubs() + log.info(runningCollaborators.toString()) + return stubRunner + } catch (Exception e) { + log.error("An exception occurred while trying to execute the stubs: ${e.message}") + throw e + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/ConvertMojo.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/ConvertMojo.java new file mode 100644 index 0000000000..cd8c5063b1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/ConvertMojo.java @@ -0,0 +1,105 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven; + +import java.io.File; + +import org.apache.maven.execution.MavenSession; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Component; +import org.apache.maven.plugins.annotations.LifecyclePhase; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.project.MavenProject; +import org.apache.maven.shared.filtering.MavenResourcesFiltering; +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties; +import org.springframework.cloud.contract.verifier.wiremock.DslToWireMockClientConverter; +import org.springframework.cloud.contract.verifier.wiremock.RecursiveFilesConverter; + +/** + * Convert Spring Cloud Contract Verifier contracts into WireMock stubs mappings. + *

+ * This goal allow to generate `stubs-jar` or execute `spring-cloud-contract-verifier:run` with generated WireMock mappings. + */ +@Mojo(name = "convert", requiresProject = false, defaultPhase = LifecyclePhase.PROCESS_TEST_RESOURCES) +public class ConvertMojo extends AbstractMojo { + + /** + * Directory containing Spring Cloud Contract Verifier contracts written using the GroovyDSL + */ + @Parameter(defaultValue = "${basedir}/src/test/resources/contracts") + private File contractsDirectory; + + /** + * 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 + */ + @Parameter(defaultValue = "${project.build.directory}/stubs") + private File outputDirectory; + + /** + * Directory containing contracts written using the GroovyDSL + *

+ * This parameter is only used when goal is executed outside of maven project. + */ + @Parameter(property = "contractsDirectory", defaultValue = "${basedir}") + private File source; + + @Parameter(property = "stubsDirectory", defaultValue = "${basedir}") + private File destination; + + @Parameter(property = "spring.cloud.contract.verifier.skip", defaultValue = "false") + private boolean skip; + + @Parameter(defaultValue = "${session}", readonly = true) + private MavenSession mavenSession; + + @Parameter(defaultValue = "${project}", readonly = true) + private MavenProject project; + + @Component(role = MavenResourcesFiltering.class, hint = "default") + private MavenResourcesFiltering mavenResourcesFiltering; + + public void execute() throws MojoExecutionException, MojoFailureException { + + if (skip) { + getLog().info(String.format("Skipping Spring Cloud Contract Verifier execution: spring.cloud.contract.verifier.skip=%s", skip)); + return; + } + + new CopyContracts(project, mavenSession, mavenResourcesFiltering).copy(contractsDirectory, outputDirectory); + + final ContractVerifierConfigProperties config = new ContractVerifierConfigProperties(); + config.setContractsDslDir(isInsideProject() ? contractsDirectory : source); + config.setStubsOutputDir(isInsideProject() ? new File(outputDirectory, "mappings") : destination); + + getLog().info("Converting from Spring Cloud Contract Verifier contracts to WireMock stubs mappings"); + getLog().info(String.format(" Spring Cloud Contract Verifier contracts directory: %s", config.getContractsDslDir())); + getLog().info(String.format("WireMock stubs mappings directory: %s", config.getStubsOutputDir())); + + RecursiveFilesConverter converter = new RecursiveFilesConverter(new DslToWireMockClientConverter(), config); + converter.processFiles(); + } + + private boolean isInsideProject() { + return mavenSession.getRequest().isProjectPresent(); + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/GenerateStubsMojo.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/GenerateStubsMojo.java new file mode 100644 index 0000000000..dfb657506a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/GenerateStubsMojo.java @@ -0,0 +1,100 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven; + +import java.io.File; + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Component; +import org.apache.maven.plugins.annotations.LifecyclePhase; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.project.MavenProject; +import org.apache.maven.project.MavenProjectHelper; +import org.codehaus.plexus.archiver.Archiver; +import org.codehaus.plexus.archiver.jar.JarArchiver; + +@Mojo(name = "generateStubs", defaultPhase = LifecyclePhase.PACKAGE, requiresProject = true) +public class GenerateStubsMojo extends AbstractMojo { + + private static final String STUB_MAPPING_FILE_PATTERN = "**/*.json"; + private static final String CONTRACT_FILE_PATTERN = "**/*.groovy"; + + @Parameter(defaultValue = "${project.build.directory}", readonly = true, required = true) + private File projectBuildDirectory; + + @Parameter(property = "stubsDirectory", defaultValue = "${project.build.directory}/stubs") + private File outputDirectory; + + /** + * Set this to "true" to bypass Verifier execution.. + */ + @Parameter(property = "spring.cloud.contract.verifier.skip", defaultValue = "false") + private boolean skip; + + @Component + private MavenProjectHelper projectHelper; + + @Parameter(defaultValue = "${project}", readonly = true) + private MavenProject project; + + @Component(role = Archiver.class, hint = "jar") + private JarArchiver archiver; + + @Parameter(defaultValue = "true") + private boolean attachContracts; + + @Parameter(defaultValue = "stubs") + private String classifier; + + public void execute() throws MojoExecutionException, MojoFailureException { + if (skip) { + getLog().info("Skipping Spring Cloud Contract Verifier execution: spring.cloud.contract.verifier.skip=" + skip); + return; + } + File stubsJarFile = createStubJar(outputDirectory); + projectHelper.attachArtifact(project, "jar", classifier, stubsJarFile); + } + + private File createStubJar(File stubsOutputDir) throws MojoFailureException, MojoExecutionException { + if (!stubsOutputDir.exists()) { + throw new MojoExecutionException("Stubs could not be found: " + stubsOutputDir.getAbsolutePath() + ".\nPlease make sure that spring-cloud-contract-verifier:convert was invoked"); + } + String stubArchiveName = project.getBuild().getFinalName() + "-" + classifier + ".jar"; + File stubsJarFile = new File(projectBuildDirectory, stubArchiveName); + try { + if (attachContracts) { + archiver.addDirectory(stubsOutputDir, new String[]{STUB_MAPPING_FILE_PATTERN, + CONTRACT_FILE_PATTERN }, new String[0]); + } else { + getLog().info("Skipping attaching Spring Cloud Contract Verifier contracts"); + archiver.addDirectory(stubsOutputDir, new String[]{STUB_MAPPING_FILE_PATTERN}, new String[]{ + CONTRACT_FILE_PATTERN }); + } + archiver.setCompress(true); + archiver.setDestFile(stubsJarFile); + archiver.addConfiguredManifest(ManifestCreator.createManifest(project)); + archiver.createArchive(); + } catch (Exception e) { + throw new MojoFailureException("Exception while packaging " + classifier + " jar.", e); + } + return stubsJarFile; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/GenerateTestsMojo.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/GenerateTestsMojo.java new file mode 100644 index 0000000000..ddd78f7c2d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/GenerateTestsMojo.java @@ -0,0 +1,142 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven; + +import java.io.File; +import java.util.List; + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.LifecyclePhase; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.plugins.annotations.ResolutionScope; +import org.apache.maven.project.MavenProject; +import org.springframework.cloud.contract.spec.ContractVerifierException; +import org.springframework.cloud.contract.verifier.TestGenerator; +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties; +import org.springframework.cloud.contract.verifier.config.TestFramework; +import org.springframework.cloud.contract.verifier.config.TestMode; + +@Mojo(name = "generateTests", defaultPhase = LifecyclePhase.GENERATE_TEST_SOURCES, requiresDependencyResolution = ResolutionScope.TEST) +public class GenerateTestsMojo extends AbstractMojo { + + @Parameter(property = "spring.cloud.contract.verifier.contractsDirectory", defaultValue = "${project.basedir}/src/test/resources/contracts") + private File contractsDirectory; + + @Parameter(defaultValue = "${project.build.directory}/generated-test-sources/contracts") + private File generatedTestSourcesDir; + + @Parameter(defaultValue = "org.springframework.cloud.contract.verifier.tests") + private String basePackageForTests; + + @Parameter + private String baseClassForTests; + + @Parameter(defaultValue = "MOCKMVC") + private TestMode testMode; + + @Parameter(defaultValue = "JUNIT") + private TestFramework testFramework; + + @Parameter + private String ruleClassForTests; + + @Parameter + private String nameSuffixForTests; + + /** + * Imports that should be added to generated tests + */ + @Parameter + private String[] imports; + + /** + * Static imports that should be added to generated tests + */ + @Parameter + private String[] staticImports; + + /** + * Patterns that should not be taken into account for processing + */ + @Parameter + private List excludedFiles; + + /** + * Patterns for which Spring Cloud Contract Verifier should generate @Ignored tests + */ + @Parameter + private List ignoredFiles; + + @Parameter(defaultValue = "${project}", readonly = true) + private MavenProject project; + + @Parameter(property = "spring.cloud.contract.verifier.skip", defaultValue = "false") + private boolean skip; + + public void execute() throws MojoExecutionException, MojoFailureException { + if (skip) { + getLog().info("Skipping Spring Cloud Contract Verifier execution: spring.cloud.contract.verifier.skip=" + skip); + return; + } + getLog().info("Generating server tests source code for Spring Cloud Contract Verifier contract verification"); + final ContractVerifierConfigProperties config = new ContractVerifierConfigProperties(); + config.setContractsDslDir(contractsDirectory); + config.setGeneratedTestSourcesDir(generatedTestSourcesDir); + config.setTargetFramework(testFramework); + config.setTestMode(testMode); + config.setBasePackageForTests(basePackageForTests); + config.setBaseClassForTests(baseClassForTests); + config.setRuleClassForTests(ruleClassForTests); + config.setNameSuffixForTests(nameSuffixForTests); + config.setImports(imports); + config.setStaticImports(staticImports); + config.setIgnoredFiles(ignoredFiles); + config.setExcludedFiles(excludedFiles); + project.addTestCompileSourceRoot(generatedTestSourcesDir.getAbsolutePath()); + if (getLog().isInfoEnabled()) { + getLog().info("Test Source directory: " + generatedTestSourcesDir.getAbsolutePath() + " added."); + getLog().info("Using " + config.getBaseClassForTests() + " as base class for test classes"); + } + try { + TestGenerator generator = new TestGenerator(config); + int generatedClasses = generator.generate(); + getLog().info("Generated " + generatedClasses + " test classes."); + } catch (ContractVerifierException e) { + throw new MojoExecutionException(String.format("Spring Cloud Contract Verifier Plugin exception: %s", e.getMessage()), e); + } + } + + public List getExcludedFiles() { + return excludedFiles; + } + + public void setExcludedFiles(List excludedFiles) { + this.excludedFiles = excludedFiles; + } + + public List getIgnoredFiles() { + return ignoredFiles; + } + + public void setIgnoredFiles(List ignoredFiles) { + this.ignoredFiles = ignoredFiles; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/RunMojo.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/RunMojo.java new file mode 100644 index 0000000000..c8b4b42f0f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/java/org/springframework/cloud/contract/verifier/maven/RunMojo.java @@ -0,0 +1,151 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven; + +import javax.inject.Inject; +import java.io.File; +import java.io.IOException; +import java.util.Collections; + +import org.apache.maven.execution.MavenSession; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.plugins.annotations.ResolutionScope; +import org.eclipse.aether.RepositorySystemSession; +import org.springframework.cloud.contract.stubrunner.BatchStubRunner; +import org.springframework.cloud.contract.stubrunner.StubRunner; +import org.springframework.cloud.contract.stubrunner.StubRunnerOptions; +import org.springframework.cloud.contract.stubrunner.StubRunnerOptionsBuilder; +import org.springframework.cloud.contract.verifier.maven.stubrunner.LocalStubRunner; + +import org.springframework.cloud.contract.verifier.maven.stubrunner.RemoteStubRunner; + +import static com.google.common.base.Strings.isNullOrEmpty; + +@Mojo(name = "run", requiresProject = false, requiresDependencyResolution = ResolutionScope.RUNTIME) +public class RunMojo extends AbstractMojo { + + @Parameter(defaultValue = "${repositorySystemSession}", readonly = true) + private RepositorySystemSession repoSession; + + @Parameter(defaultValue = "${project.build.directory}/contracts/mappings") + private File stubsDirectory; + + @Parameter(property = "stubsDirectory", defaultValue = "${basedir}") + private File destination; + + /** + * HTTP port for WireMock server + */ + @Parameter(property = "spring.cloud.contract.verifier.http.port", defaultValue = "8080") + private int httpPort; + + /** + * Set this to "true" to bypass verifier execution. + */ + @Parameter(property = "spring.cloud.contract.verifier.skip", defaultValue = "false") + private boolean skip; + + /** + * Set this to "true" to bypass verifier test generation. + */ + @Parameter(property = "spring.cloud.contract.verifier.skipTestOnly", defaultValue = "false") + private boolean skipTestOnly; + + @Parameter(property = "spring.cloud.contract.verifier.stubs") + private String stubs; + + @Parameter(property = "spring.cloud.contract.verifier.http.minPort", defaultValue = "10000") + private int minPort; + + @Parameter(property = "spring.cloud.contract.verifier.http.maxPort", defaultValue = "15000") + private int maxPort; + + /** + * Classifier used by stubs artifacts. + */ + @Parameter(defaultValue = "stubs") + private String stubsClassifier = "stubs"; + + @Parameter(defaultValue = "${session}", readonly = true) + private MavenSession mavenSession; + + private final LocalStubRunner localStubRunner; + + private final RemoteStubRunner remoteStubRunner; + + @Inject + public RunMojo(LocalStubRunner localStubRunner, RemoteStubRunner remoteStubRunner) { + this.localStubRunner = localStubRunner; + this.remoteStubRunner = remoteStubRunner; + } + + public void execute() throws MojoExecutionException, MojoFailureException { + if (skip || skipTestOnly) { + getLog().info("Skipping verifier execution: spring.cloud.contract.verifier.skip=" + String.valueOf(skip)); + return; + } + BatchStubRunner batchStubRunner = null; + StubRunnerOptionsBuilder optionsBuilder = new StubRunnerOptionsBuilder() + .withStubsClassifier(stubsClassifier); + if (isNullOrEmpty(stubs)) { + StubRunnerOptions options = optionsBuilder + .withPort(httpPort) + .build(); + StubRunner stubRunner = localStubRunner.run(resolveStubsDirectory().getAbsolutePath(), options); + batchStubRunner = new BatchStubRunner(Collections.singleton(stubRunner)); + } else { + StubRunnerOptions options = optionsBuilder + .withStubs(stubs) + .withMinMaxPort(minPort, maxPort) + .build(); + batchStubRunner = remoteStubRunner.run(options, repoSession); + } + pressAnyKeyToContinue(); + if (batchStubRunner != null) { + try { + batchStubRunner.close(); + } catch (IOException e) { + throw new MojoExecutionException("Fail to close batch stub runner", e); + } + } + } + + private File resolveStubsDirectory() { + if (isInsideProject()) { + return stubsDirectory; + } else { + return destination; + } + } + + private void pressAnyKeyToContinue() { + getLog().info("Press ENTER to continue..."); + try { + System.in.read(); + } catch (Exception ignored) { + } + } + + private boolean isInsideProject() { + return mavenSession.getRequest().isProjectPresent(); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/resources/META-INF/plexus/components.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/resources/META-INF/plexus/components.xml new file mode 100644 index 0000000000..19a83714fc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/main/resources/META-INF/plexus/components.xml @@ -0,0 +1,45 @@ + + + + + + org.apache.maven.lifecycle.Lifecycle + org.apache.maven.lifecycle.Lifecycle + spring-cloud-contract-verifier + + spring-cloud-contract-verifier + + spring-cloud-contract-verifier-not-used-phase + + + + org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:${project.version}:convert + + + org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:${project.version}:generateTests + + + org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:${project.version}:generateStubs + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc new file mode 100644 index 0000000000..fad117ee37 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex-content.adoc @@ -0,0 +1,38 @@ +== More Complex Plugin Configuration + +Sample more complex configuration for Java Project with JUnit tests. + + +=== Project configuration for Accurest with JUnit tests and stub publishing + +[source,xml] +---- +include::{root_folder}/src/test/projects/complex-configuration/pom.xml[tags=plugin] +---- + +=== Base Test class + +[source,java] +---- +include::{root_folder}/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/BaseAccurest.java[] +---- + + +=== Sample additional matcher + +[source,java] +---- +include::{root_folder}/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/matchers/CustomMatchers.java[] +---- + +=== Sample contract using matcher + +[source,java] +---- +include::{root_folder}/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsNotFraud.groovy[] +---- + + +=== Project source code + +https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/complex-configuration \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex.adoc new file mode 100644 index 0000000000..e29ea2b549 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/complex.adoc @@ -0,0 +1,3 @@ +:root_folder: ../../.. + +include::complex.adoc[] \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/index.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/index.adoc new file mode 100644 index 0000000000..f73fbb3dc9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/index.adoc @@ -0,0 +1,10 @@ += Spring Cloud Contract Verifier Maven Plugin + +Just to make long story short - Spring Cloud Contract Verifier is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications. + + * Stubs mappings to be used by WireMock when doing integration testing on the client code (client tests). + + * Acceptance tests used to verify if server-side implementation of the API is compliant with the contract (server tests). + +Spring Cloud Contract Verifier moves TDD to the level of software architecture. + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc new file mode 100644 index 0000000000..ad56a34c79 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/junit.adoc @@ -0,0 +1,29 @@ +== Java Project with JUnit Tests + +Sample minimal configuration for Java Project with JUnit tests. + +=== Test dependencies for generated contract verification tests + +[source,xml] +---- +include::../../../src/test/projects/spring-boot-java/pom.xml[tags=dependencies] +---- + +=== Project configuration for Accurest with JUnit tests and stub publishing + +[source,xml] +---- +include::../../../src/test/projects/spring-boot-java/pom.xml[tags=plugin] +---- + +=== Base Test class + +[source,java] +---- +include::../../../src/test/projects/spring-boot-java/src/test/java/hello/BaseAccurest.java[] +---- + + +=== Project source code + +https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/spring-boot-java \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc new file mode 100644 index 0000000000..6e262ede51 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/spock.adoc @@ -0,0 +1,29 @@ +== Groovy Project with Spock Specifications + +Sample minimal configuration for Groovy Project with Spock Specification + +=== Test dependencies for generated contract verification tests + +[source,xml] +---- +include::../../../src/test/projects/spring-boot-groovy/pom.xml[tags=dependencies] +---- + +=== Project configuration for Accurest, Groovy, Spock specifications and stub publishing + + +[source,xml] +---- +include::../../../src/test/projects/spring-boot-groovy/pom.xml[tags=plugin] +---- + +=== Base Specification class + +[source,java] +---- +include::../../../src/test/projects/spring-boot-groovy/src/test/groovy/hello/BaseAccurest.groovy[] +---- + +=== Project source code + +https://github.com/Codearte/accurest-maven-plugin/tree/master/src/test/projects/spring-boot-groovy diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc new file mode 100644 index 0000000000..825f738e45 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/asciidoc/usage.adoc @@ -0,0 +1,35 @@ += Usage + +== Converting Accurest GroovyDSL into WireMock stub mappings + + mvn org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:convert + +or shortly footnoteref:[prefix,Additional configuration inside `~/.m2/settings.xml` is required: `io.codearte.accurest`.] + + mvn spring-cloud-contract-verifier:convert + +For more information please go to the Accurest Wiki or Plugin Documentation Site. + +== Accurest Stub Runner + +Run stubs mappings from current directory: + + mvn org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:run + +or shortly footnoteref:[prefix] + + mvn spring-cloud-contract-verifier:run + +== Running stubs from repository + + mvn spring-cloud-contract-verifier:run -Dstubs="org.springframework:gs-rest-service" + +where `org.springframework:gs-rest-service` is artifact with stubs classifier contains wiremock mappings. + +== Project configuration + +[source,xml] +---- +include::../../../src/test/projects/spring-boot-java/pom.xml[tags=plugin] +---- + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/site.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/site.xml new file mode 100644 index 0000000000..8d23c5f4d2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/site/site.xml @@ -0,0 +1,58 @@ + + + + ${project.name} + + + + + + org.apache.maven.skins + maven-fluido-skin + 1.5 + + + + true + true + + codearte/accurest-maven-plugin + right + orange + + » + + + + +

+ + + + + + + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/java/org/springframework/cloud/contract/verifier/maven/PluginIT.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/java/org/springframework/cloud/contract/verifier/maven/PluginIT.java new file mode 100644 index 0000000000..cc2c878333 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/java/org/springframework/cloud/contract/verifier/maven/PluginIT.java @@ -0,0 +1,113 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven; + +import java.io.File; + +import org.junit.Ignore; +import org.junit.Rule; +import org.junit.Test; +import org.junit.runner.RunWith; + +import io.takari.maven.testing.TestProperties; +import io.takari.maven.testing.TestResources; +import io.takari.maven.testing.executor.MavenRuntime; +import io.takari.maven.testing.executor.MavenVersions; +import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner; + +@RunWith(MavenJUnitTestRunner.class) +@MavenVersions({ "3.3.3" }) +public class PluginIT { + + @Rule + public final TestResources resources = new TestResources(); + + private final TestProperties properties = new TestProperties(); + + private final MavenRuntime maven; + + public PluginIT(MavenRuntime.MavenRuntimeBuilder mavenBuilder) throws Exception { + this.maven = mavenBuilder.withCliOptions("-B", "-U").build(); + } + + @Test + public void should_build_project_Spring_Boot_Groovy_with_Accurest() throws Exception { + File basedir = resources.getBasedir("spring-boot-groovy"); + maven.forProject(basedir) + .execute("package") + .assertErrorFreeLog() + .assertLogText("Generating server tests source code for Spring Cloud Contract Verifier contract verification") + .assertLogText("Generated 1 test classes.") + .assertLogText("Converting from Spring Cloud Contract Verifier contracts to WireMock stubs mappings") + .assertLogText("Creating new json") + .assertLogText("Running org.springframework.cloud.contract.verifier.tests.ContractVerifierSpec") + .assertErrorFreeLog(); + } + + @Test + public void should_build_project_Spring_Boot_Java_with_Accurest() throws Exception { + File basedir = resources.getBasedir("spring-boot-java"); + maven.forProject(basedir) + .execute("package") + .assertErrorFreeLog() + .assertLogText("Generating server tests source code for Spring Cloud Contract Verifier contract verification") + .assertLogText("Generated 1 test classes.") + .assertLogText("Converting from Spring Cloud Contract Verifier contracts to WireMock stubs mappings") + .assertLogText("Creating new json") + .assertLogText("Running org.springframework.cloud.contract.verifier.tests.ContractVerifierTest") + .assertErrorFreeLog(); + } + + @Test + public void should_build_project_with_plugin_extension() throws Exception { + File basedir = resources.getBasedir("plugin-extension"); + maven.forProject(basedir) + .execute("package") + .assertErrorFreeLog() + .assertLogText("Generating server tests source code for Spring Cloud Contract Verifier contract verification") + .assertLogText("Generated 1 test classes.") + .assertLogText("Converting from Spring Cloud Contract Verifier contracts to WireMock stubs mappings") + .assertLogText("Creating new json") + .assertLogText("Running org.springframework.cloud.contract.verifier.tests.ContractVerifierTest") + .assertErrorFreeLog(); + } + + @Test + @Ignore("Ignored, because of bug accurest#245") + public void should_build_project_project_with_complex_configuration() throws Exception { + File basedir = resources.getBasedir("complex-configuration"); + maven.forProject(basedir) + .execute("package") + .assertErrorFreeLog() + .assertLogText("Tests run: 2, Failures: 0, Errors: 0, Skipped: 1") + .assertLogText("Running com.blogspot.toomuchcoding.frauddetection.ContractVerifierTest") + .assertErrorFreeLog(); + } + + @Test + public void should_convert_Accurest_Contracts_to_WireMock_Stubs_mappings() throws Exception { + File basedir = resources.getBasedir("pomless"); + properties.getPluginVersion(); + maven.forProject(basedir) + .withCliOption("-X") + .execute(String.format("org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:%s:convert", + properties.getPluginVersion())) + .assertLogText("Converting from Spring Cloud Contract Verifier contracts to WireMock stubs mappings") + .assertLogText("Creating new json") + .assertErrorFreeLog(); + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/java/org/springframework/cloud/contract/verifier/maven/PluginUnitTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/java/org/springframework/cloud/contract/verifier/maven/PluginUnitTest.java new file mode 100644 index 0000000000..5484243411 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/java/org/springframework/cloud/contract/verifier/maven/PluginUnitTest.java @@ -0,0 +1,115 @@ +/** + * + * Copyright 2013-2016 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. + */ +package org.springframework.cloud.contract.verifier.maven; + +import java.io.File; + +import org.junit.Rule; +import org.junit.Test; + +import io.takari.maven.testing.TestMavenRuntime; +import io.takari.maven.testing.TestResources; + +import static io.takari.maven.testing.TestMavenRuntime.newParameter; +import static io.takari.maven.testing.TestResources.assertFilesNotPresent; +import static io.takari.maven.testing.TestResources.assertFilesPresent; + +public class PluginUnitTest { + + @Rule + public final TestResources resources = new TestResources(); + + @Rule + public final TestMavenRuntime maven = new TestMavenRuntime(); + + @Test + public void shouldGenerateWireMockStubsInDefaultLocation() throws Exception { + File basedir = resources.getBasedir("basic"); + maven.executeMojo(basedir, "convert"); + assertFilesPresent(basedir, "target/stubs/mappings/Sample.json"); + assertFilesNotPresent(basedir, "target/stubs/mappings/Messaging.json"); + } + + @Test + public void shouldGenerateWireMockFromStubsDirectory() throws Exception { + File basedir = resources.getBasedir("withStubs"); + maven.executeMojo(basedir, "convert", newParameter("contractsDirectory", "src/test/resources/stubs")); + assertFilesPresent(basedir, "target/stubs/mappings/Sample.json"); + } + + @Test + public void shouldCopyContracts() throws Exception { + File basedir = resources.getBasedir("basic"); + maven.executeMojo(basedir, "convert"); + assertFilesPresent(basedir, "target/stubs/contracts/Sample.groovy"); + assertFilesPresent(basedir, "target/stubs/contracts/Messaging.groovy"); + } + @Test + public void shouldGenerateWireMockStubsInSelectedLocation() throws Exception { + File basedir = resources.getBasedir("basic"); + maven.executeMojo(basedir, "convert", newParameter("outputDirectory", "target/foo")); + assertFilesPresent(basedir, "target/foo/mappings/Sample.json"); + } + + @Test + public void shouldGenerateContractSpecificationInDefaultLocation() throws Exception { + File basedir = resources.getBasedir("basic"); + maven.executeMojo(basedir, "generateTests", newParameter("testFramework", "SPOCK")); + assertFilesPresent(basedir, + "target/generated-test-sources/contracts/org/springframework/cloud/contract/verifier/tests/ContractVerifierSpec.groovy"); + } + + @Test + public void shouldGenerateContractTestsInDefaultLocation() throws Exception { + File basedir = resources.getBasedir("basic"); + maven.executeMojo(basedir, "generateTests"); + assertFilesPresent(basedir, + "target/generated-test-sources/contracts/org/springframework/cloud/contract/verifier/tests/ContractVerifierTest.java"); + } + + @Test + public void shouldGenerateContractTestsWithCustomImports() throws Exception { + File basedir = resources.getBasedir("basic"); + maven.executeMojo(basedir, "generateTests", newParameter("imports", "")); + assertFilesPresent(basedir, + "target/generated-test-sources/contracts/org/springframework/cloud/contract/verifier/tests/ContractVerifierTest.java"); + } + + @Test + public void shouldGenerateStubs() throws Exception { + File basedir = resources.getBasedir("generatedStubs"); + maven.executeMojo(basedir, "generateStubs"); + assertFilesPresent(basedir, "target/sample-project-0.1-stubs.jar"); + } + + @Test + public void shouldGenerateStubsWithMappingsOnly() throws Exception { + File basedir = resources.getBasedir("generatedStubs"); + maven.executeMojo(basedir, "generateStubs", newParameter("attachContracts", "false")); + assertFilesPresent(basedir, "target/sample-project-0.1-stubs.jar"); + // FIXME: add assertion for jar content + } + + @Test + public void shouldGenerateStubsWithCustomClassifier() throws Exception { + File basedir = resources.getBasedir("generatedStubs"); + maven.executeMojo(basedir, "generateStubs", newParameter("classifier", "foo")); + assertFilesPresent(basedir, "target/sample-project-0.1-foo.jar"); + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/pom.xml new file mode 100644 index 0000000000..e7ee761ca9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/pom.xml @@ -0,0 +1,37 @@ + + + + 4.0.0 + + io.codearte.accurest.sample + sample-project + 0.1 + + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/src/test/resources/contracts/Messaging.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/src/test/resources/contracts/Messaging.groovy new file mode 100644 index 0000000000..b21f448049 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/src/test/resources/contracts/Messaging.groovy @@ -0,0 +1,37 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + label 'some_label' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/src/test/resources/contracts/Sample.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/src/test/resources/contracts/Sample.groovy new file mode 100644 index 0000000000..094820225b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/basic/src/test/resources/contracts/Sample.groovy @@ -0,0 +1,34 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + request { + method 'POST' + url('/users') { + + } + headers { + header 'Content-Type': 'application/json' + } + body '''{ "login" : "john", "name": "John The Contract" }''' + } + response { + status 200 + headers { + header 'Location': '/users/john' + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/.gitignore b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/.gitignore new file mode 100644 index 0000000000..1de565933b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/.gitignore @@ -0,0 +1 @@ +target \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/pom.xml new file mode 100644 index 0000000000..efebefaf10 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/pom.xml @@ -0,0 +1,131 @@ + + + + 4.0.0 + + com.blogspot.toomuchcoding.frauddetection + frauddetection + 0.1.0 + + + org.springframework.boot + spring-boot-starter-parent + 1.3.5.RELEASE + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-test + test + + + ch.qos.logback + logback-classic + + + + + + com.jayway.restassured + rest-assured + 2.9.0 + test + + + com.jayway.restassured + spring-mock-mvc + 2.9.0 + test + + + com.toomuchcoding.jsonassert + jsonassert + 0.4.7 + test + + + org.assertj + assertj-core + 2.4.0 + test + + + + + + 1.8 + ${it-plugin.version} + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + ${accurest-plugin.version} + + + + convert + generateStubs + generateTests + + + src/test/accurest + com.blogspot.toomuchcoding.frauddetection + MOCKMVC + JUNIT + stubs + Test + org.junit.rules.ErrorCollector + + com.blogspot.toomuchcoding.frauddetection.matchers.CustomMatchers.* + + + com.blogspot.toomuchcoding.frauddetection.matchers.CustomMatchers + + + broken** + + + shouldMarkClientAsFraud.groovy + + + + + + com.blogspot.toomuchcoding.frauddetection.BaseAccurest + + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/Application.java new file mode 100644 index 0000000000..bedd785957 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/Application.java @@ -0,0 +1,28 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/FraudDetectionController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/FraudDetectionController.java new file mode 100644 index 0000000000..ce53beb419 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/FraudDetectionController.java @@ -0,0 +1,56 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection; + +import java.math.BigDecimal; + +import com.blogspot.toomuchcoding.frauddetection.model.FraudCheck; +import com.blogspot.toomuchcoding.frauddetection.model.FraudCheckResult; + +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import static com.blogspot.toomuchcoding.frauddetection.model.FraudCheckStatus.FRAUD; +import static com.blogspot.toomuchcoding.frauddetection.model.FraudCheckStatus.OK; +import static org.springframework.web.bind.annotation.RequestMethod.PUT; + +@RestController +public class FraudDetectionController { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = "application/vnd.fraud.v1+json"; + private static final String NO_REASON = null; + private static final String AMOUNT_TOO_HIGH = "Amount too high"; + private static final BigDecimal MAX_AMOUNT = new BigDecimal("5000"); + + @RequestMapping( + value = "/fraudcheck", + method = PUT, + consumes = FRAUD_SERVICE_JSON_VERSION_1, + produces = FRAUD_SERVICE_JSON_VERSION_1) + public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) { + if (amountGreaterThanThreshold(fraudCheck)) { + return new FraudCheckResult(FRAUD, AMOUNT_TOO_HIGH); + } + return new FraudCheckResult(OK, NO_REASON); + } + + private boolean amountGreaterThanThreshold(FraudCheck fraudCheck) { + return MAX_AMOUNT.compareTo(fraudCheck.getLoanAmount()) < 0; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheck.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheck.java new file mode 100644 index 0000000000..67f51b8a39 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheck.java @@ -0,0 +1,45 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudCheck { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudCheck() { + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheckResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheckResult.java new file mode 100644 index 0000000000..a5fba329aa --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheckResult.java @@ -0,0 +1,48 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection.model; + +public class FraudCheckResult { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudCheckResult() { + } + + public FraudCheckResult(FraudCheckStatus fraudCheckStatus, String rejectionReason) { + this.fraudCheckStatus = fraudCheckStatus; + this.rejectionReason = rejectionReason; + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..8ea884adb3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/main/java/com/blogspot/toomuchcoding/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,21 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/brokenContract.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/brokenContract.groovy new file mode 100644 index 0000000000..48435cb1a2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/brokenContract.groovy @@ -0,0 +1,44 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url '/fraudcheck' + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":123.123 + } + """ + ) + headers { + header('Content-Type', 'application/vnd.fraud.v1+json') + } + + } + response { + status 999 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsFraud.groovy new file mode 100644 index 0000000000..9cd6dec8b1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsFraud.groovy @@ -0,0 +1,43 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + request { + method """PUT""" + url """/fraudcheck""" + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":99999} + """ + ) + headers { + header("""Content-Type""", """application/vnd.fraud.v1+json""") + } + + } + response { + status 200 + body( """{ + "fraudCheckStatus": "${value(client('FRAUD'), server(regex('[A-Z]{5}')))}", + "rejectionReason": "Amount too high" +}""") + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsNotFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsNotFraud.groovy new file mode 100644 index 0000000000..92b2646567 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/contracts/shouldMarkClientAsNotFraud.groovy @@ -0,0 +1,44 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url '/fraudcheck' + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":123.123 + } + """ + ) + headers { + header('Content-Type', 'application/vnd.fraud.v1+json') + } + + } + response { + status 200 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/BaseAccurest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/BaseAccurest.java new file mode 100644 index 0000000000..0bc555db19 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/BaseAccurest.java @@ -0,0 +1,30 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection; + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc; + +import org.junit.Before; + +public class BaseAccurest { + + @Before + public void setup() { + RestAssuredMockMvc.standaloneSetup(new FraudDetectionController()); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/matchers/CustomMatchers.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/matchers/CustomMatchers.java new file mode 100644 index 0000000000..44d5331c9e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/complex-configuration/src/test/java/com/blogspot/toomuchcoding/frauddetection/matchers/CustomMatchers.java @@ -0,0 +1,27 @@ +/** + * + * Copyright 2013-2016 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. + */ +package com.blogspot.toomuchcoding.frauddetection.matchers; + +import org.junit.Assert; + +public class CustomMatchers { + + public static void assertThatRejectionReasonIsNull(String rejectionReason) { + Assert.assertNull(rejectionReason); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/generatedStubs/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/generatedStubs/pom.xml new file mode 100644 index 0000000000..e7ee761ca9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/generatedStubs/pom.xml @@ -0,0 +1,37 @@ + + + + 4.0.0 + + io.codearte.accurest.sample + sample-project + 0.1 + + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/pom.xml new file mode 100644 index 0000000000..7d5f62d156 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/pom.xml @@ -0,0 +1,102 @@ + + + + 4.0.0 + + org.springframework + gs-rest-service + 0.1.0 + + + org.springframework.boot + spring-boot-starter-parent + 1.3.5.RELEASE + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-test + test + + + ch.qos.logback + logback-classic + + + + + + com.jayway.restassured + rest-assured + 2.9.0 + test + + + com.jayway.restassured + spring-mock-mvc + 2.9.0 + test + + + com.toomuchcoding.jsonassert + jsonassert + 0.4.7 + test + + + org.assertj + assertj-core + 2.4.1 + test + + + + + + 1.8 + ${it-plugin.version} + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + ${accurest-plugin.version} + true + + hello.BaseAccurest + + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/Application.java new file mode 100644 index 0000000000..bb79fe49da --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/Application.java @@ -0,0 +1,28 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/Greeting.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/Greeting.java new file mode 100644 index 0000000000..f22f746a8f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/Greeting.java @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +public class Greeting { + + private final long id; + private final String content; + + public Greeting(long id, String content) { + this.id = id; + this.content = content; + } + + public long getId() { + return id; + } + + public String getContent() { + return content; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/GreetingController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/GreetingController.java new file mode 100644 index 0000000000..f6db9e06b9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/main/java/hello/GreetingController.java @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import java.util.concurrent.atomic.AtomicLong; + +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class GreetingController { + + private static final String template = "Hello, %s!"; + private final AtomicLong counter = new AtomicLong(); + + @RequestMapping("/greeting") + public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) { + return new Greeting(counter.incrementAndGet(), + String.format(template, name)); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/java/hello/BaseAccurest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/java/hello/BaseAccurest.java new file mode 100644 index 0000000000..5d04fddb2f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/java/hello/BaseAccurest.java @@ -0,0 +1,30 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc; + +import org.junit.Before; + +public class BaseAccurest { + + @Before + public void setup() { + RestAssuredMockMvc.standaloneSetup(new GreetingController()); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/resources/contracts/greetings_ok.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/resources/contracts/greetings_ok.groovy new file mode 100644 index 0000000000..4a5d9a792f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/resources/contracts/greetings_ok.groovy @@ -0,0 +1,37 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + priority 2 + request { + method 'GET' + urlPath('/greeting') { + queryParameters { + parameter 'name': 'Something' + } + } + headers { + header 'Content-Type': 'application/json' + } + } + response { + status 200 + body( + id: 1, + content: "Hello, Something!" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/resources/contracts/greetings_with_default_value.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/resources/contracts/greetings_with_default_value.groovy new file mode 100644 index 0000000000..5b65b65ca7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/plugin-extension/src/test/resources/contracts/greetings_with_default_value.groovy @@ -0,0 +1,33 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + priority 2 + request { + method 'GET' + url('/greeting') + headers { + header 'Content-Type': 'application/json' + } + } + response { + status 200 + body( + id: 1, + content: "Hello, World!" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/pomless/Sample.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/pomless/Sample.groovy new file mode 100644 index 0000000000..094820225b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/pomless/Sample.groovy @@ -0,0 +1,34 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + request { + method 'POST' + url('/users') { + + } + headers { + header 'Content-Type': 'application/json' + } + body '''{ "login" : "john", "name": "John The Contract" }''' + } + response { + status 200 + headers { + header 'Location': '/users/john' + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/pom.xml new file mode 100644 index 0000000000..b925aca3d1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/pom.xml @@ -0,0 +1,145 @@ + + + + 4.0.0 + + org.springframework + gs-rest-service + 0.1.0 + + + org.springframework.boot + spring-boot-starter-parent + 1.3.5.RELEASE + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + org.spockframework + spock-core + test + + + com.jayway.restassured + rest-assured + 2.9.0 + test + + + com.jayway.restassured + spring-mock-mvc + 2.9.0 + test + + + com.toomuchcoding.jsonassert + jsonassert + 0.4.7 + test + + + + + + 1.8 + ${it-plugin.version} + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + ${accurest-plugin.version} + + + + convert + generateStubs + generateTests + + + + + hello.BaseAccurest + SPOCK + + + + + org.codehaus.gmavenplus + gmavenplus-plugin + 1.5 + + + + testCompile + + + + + + + ${project.basedir}/src/test/groovy + + **/*.groovy + + + + ${project.build.directory}/generated-test-sources/contracts + + **/*.groovy + + + + + + + maven-surefire-plugin + 2.19 + + + **/*Spec.java + + + + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/Application.java new file mode 100644 index 0000000000..bb79fe49da --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/Application.java @@ -0,0 +1,28 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/Greeting.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/Greeting.java new file mode 100644 index 0000000000..f22f746a8f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/Greeting.java @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +public class Greeting { + + private final long id; + private final String content; + + public Greeting(long id, String content) { + this.id = id; + this.content = content; + } + + public long getId() { + return id; + } + + public String getContent() { + return content; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/GreetingController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/GreetingController.java new file mode 100644 index 0000000000..f6db9e06b9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/main/java/hello/GreetingController.java @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import java.util.concurrent.atomic.AtomicLong; + +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class GreetingController { + + private static final String template = "Hello, %s!"; + private final AtomicLong counter = new AtomicLong(); + + @RequestMapping("/greeting") + public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) { + return new Greeting(counter.incrementAndGet(), + String.format(template, name)); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/groovy/hello/BaseAccurest.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/groovy/hello/BaseAccurest.groovy new file mode 100644 index 0000000000..82707cf2ef --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/groovy/hello/BaseAccurest.groovy @@ -0,0 +1,28 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc +import spock.lang.Specification + +public class BaseAccurest extends Specification { + + def setup() { + RestAssuredMockMvc.standaloneSetup(new GreetingController()) + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/resources/contracts/greetings_ok.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/resources/contracts/greetings_ok.groovy new file mode 100644 index 0000000000..e782af7b50 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/resources/contracts/greetings_ok.groovy @@ -0,0 +1,37 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + priority 2 + request { + method 'GET' + urlPath('/greeting') { + queryParameters { + parameter 'name': 'Something' + } + } + headers { + header 'Content-Type': 'application/json' + } + } + response { + status 200 + body ( + id: 1, + content: "Hello, Something!" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/resources/contracts/greetings_with_default_value.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/resources/contracts/greetings_with_default_value.groovy new file mode 100644 index 0000000000..ad5e45965c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-groovy/src/test/resources/contracts/greetings_with_default_value.groovy @@ -0,0 +1,33 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + priority 2 + request { + method 'GET' + url('/greeting') + headers { + header 'Content-Type': 'application/json' + } + } + response { + status 200 + body ( + id: 1, + content: "Hello, World!" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/pom.xml new file mode 100644 index 0000000000..26dd0112b4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/pom.xml @@ -0,0 +1,110 @@ + + + + 4.0.0 + + org.springframework + gs-rest-service + 0.1.0 + + + org.springframework.boot + spring-boot-starter-parent + 1.3.5.RELEASE + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-test + test + + + ch.qos.logback + logback-classic + + + + + + com.jayway.restassured + rest-assured + 2.9.0 + test + + + com.jayway.restassured + spring-mock-mvc + 2.9.0 + test + + + com.toomuchcoding.jsonassert + jsonassert + 0.4.7 + test + + + org.assertj + assertj-core + 2.4.1 + test + + + + + + 1.8 + ${it-plugin.version} + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + ${accurest-plugin.version} + + + + convert + generateStubs + generateTests + + + + + hello.BaseAccurest + + + + + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/Application.java new file mode 100644 index 0000000000..bb79fe49da --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/Application.java @@ -0,0 +1,28 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/Greeting.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/Greeting.java new file mode 100644 index 0000000000..f22f746a8f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/Greeting.java @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +public class Greeting { + + private final long id; + private final String content; + + public Greeting(long id, String content) { + this.id = id; + this.content = content; + } + + public long getId() { + return id; + } + + public String getContent() { + return content; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/GreetingController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/GreetingController.java new file mode 100644 index 0000000000..f6db9e06b9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/main/java/hello/GreetingController.java @@ -0,0 +1,36 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import java.util.concurrent.atomic.AtomicLong; + +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class GreetingController { + + private static final String template = "Hello, %s!"; + private final AtomicLong counter = new AtomicLong(); + + @RequestMapping("/greeting") + public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) { + return new Greeting(counter.incrementAndGet(), + String.format(template, name)); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/java/hello/BaseAccurest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/java/hello/BaseAccurest.java new file mode 100644 index 0000000000..5d04fddb2f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/java/hello/BaseAccurest.java @@ -0,0 +1,30 @@ +/** + * + * Copyright 2013-2016 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. + */ +package hello; + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc; + +import org.junit.Before; + +public class BaseAccurest { + + @Before + public void setup() { + RestAssuredMockMvc.standaloneSetup(new GreetingController()); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/resources/contracts/greetings_ok.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/resources/contracts/greetings_ok.groovy new file mode 100644 index 0000000000..4a5d9a792f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/resources/contracts/greetings_ok.groovy @@ -0,0 +1,37 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + priority 2 + request { + method 'GET' + urlPath('/greeting') { + queryParameters { + parameter 'name': 'Something' + } + } + headers { + header 'Content-Type': 'application/json' + } + } + response { + status 200 + body( + id: 1, + content: "Hello, Something!" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/resources/contracts/greetings_with_default_value.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/resources/contracts/greetings_with_default_value.groovy new file mode 100644 index 0000000000..5b65b65ca7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/spring-boot-java/src/test/resources/contracts/greetings_with_default_value.groovy @@ -0,0 +1,33 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + priority 2 + request { + method 'GET' + url('/greeting') + headers { + header 'Content-Type': 'application/json' + } + } + response { + status 200 + body( + id: 1, + content: "Hello, World!" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/withStubs/pom.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/withStubs/pom.xml new file mode 100644 index 0000000000..e7ee761ca9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/withStubs/pom.xml @@ -0,0 +1,37 @@ + + + + 4.0.0 + + io.codearte.accurest.sample + sample-project + 0.1 + + + + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/withStubs/src/test/resources/stubs/Sample.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/withStubs/src/test/resources/stubs/Sample.groovy new file mode 100644 index 0000000000..094820225b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier-maven-plugin/spring-cloud-contract-verifier-maven-plugin/src/test/projects/withStubs/src/test/resources/stubs/Sample.groovy @@ -0,0 +1,34 @@ +/** + * + * Copyright 2013-2016 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. + */ +org.springframework.cloud.contract.spec.Contract.make { + request { + method 'POST' + url('/users') { + + } + headers { + header 'Content-Type': 'application/json' + } + body '''{ "login" : "john", "name": "John The Contract" }''' + } + response { + status 200 + headers { + header 'Location': '/users/john' + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/.gitignore b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/.gitignore new file mode 100644 index 0000000000..05f150069a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/.gitignore @@ -0,0 +1,11 @@ +*.class +*.iml + +.idea/ +.gradle/ +target/ +build/ + +hs_err_pid* +.DS_Store +*.log \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/LICENSE b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/LICENSE new file mode 100644 index 0000000000..e06d208186 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) 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 + + (d) 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. + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/README.adoc new file mode 100644 index 0000000000..9bd94b36f0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/README.adoc @@ -0,0 +1,221 @@ +// Do not edit this file (e.g. go instead to src/main/asciidoc) + +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core +:stubrunner_core_path: {core_path}/spring-cloud-contract-stub-runner +:documentation_url: http://codearte.github.io/accurest + += Spring Cloud Contract Verifier + +:images_url: https://raw.githubusercontent.com/Codearte/accurest/master/docs/src/main/asciidoc/images + +== Introduction + +IMPORTANT: http://codearte.github.io/accurest/deprecated[The documentation to the deprecated Accurest project in version 1.1.0 is available here.] + +TIP: The Accurest project was initially started by Marcin Grzejszczak and Jakub Kubrynski (http://codearte.io[codearte.io]) + +Just to make long story short - Spring Cloud Contract Verifier is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications. It is shipped +with __Contract Definition Language__ (DSL). Contract definitions are used to produce following resources: + +* 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, test data is produced by Spring Cloud Contract Verifier. +* Messaging routes if you're using one. We're integrating with Spring Integration, Spring Cloud Stream and Apache Camel. You can however set your own integrations if you want to +* Acceptance tests (in JUnit or Spock) used to verify if server-side implementation of the API is compliant with the contract (__server tests__). +Full test is generated by Spring Cloud Contract Verifier. + +Spring Cloud Contract Verifier moves TDD to the level of software architecture. + +=== Why? + +Let us assume that we have a system comprising of multiple microservices: + +image::{images_url}/Deps.png[Microservices Architecture] + +==== Testing issues + +If we wanted to test the application in top left corner if it can communicate with other services then we could do one of two things: + +- deploy all microservices and perform end to end tests +- mock other microservices in unit / integration tests + +Both have their advantages but also a lot of disadvantages. Let's focus on the latter. + +*Deploy all microservices and perform end to end tests* + +Advantages: + +- simulates production +- tests real communication between services + +Disadvantages: + +- to test one microservice we would have to deploy 6 microservices, a couple of databases etc. +- the environment where the tests would be conducted would be locked for a single suite of tests (i.e. nobody else would be able to run the tests in the meantime). +- long to run +- very late feedback +- extremely hard to debug + +*Mock other microservices in unit / integration tests* + +Advantages: + +- very fast feedback +- no infrastructure requirements + +Disadvantages: + +- the implementor of the service creates stubs thus they might have nothing to do with the reality +- you can go to production with passing tests and failing production + +To solve the aforementioned issues Spring Cloud Contract Verifier with Stub Runner were created. Their main idea is to give you very fast feedback, without the need +to set up the whole world of microservices. + +image::{images_url}/Stubs1.png[Stubbed Services] + +If you work on stubs then the only applications you need are those that your application is using directly. + +image::{images_url}/Stubs2.png[Stubbed Services] + +Spring Cloud Contract Verifier gives you the certainty that the stubs that you're using were created by the service that you're calling. Also if you can use them it means that they were +tested against the producer's side. In other words - you can trust those stubs. + + +=== Purposes + +The main purposes of Spring Cloud Contract Verifier with Stub Runner are: + + - to ensure that WireMock / Messaging stubs (used when developing the client) are doing exactly what actual server-side implementation will do, + - 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 generate boilerplate test code used on the server side. + +=== Client Side + +During the tests you want to have a Wiremock instance / Messaging route up and running that simulates the service Y. +You would like to feed that instance with a proper stub definition. That stub definition would need +to be valid and should also be reusable on the server side. + +__Summing it up:__ On this side, in the stub definition, you can use patterns for request stubbing and you need exact +values for responses. + +=== Server Side + +Being a service Y since you are developing your stub, you need to be sure that it's actually resembling your +concrete implementation. You can't have a situation where your stub acts in one way and your application on +production behaves in a different way. + +That's why from the provided stub acceptance tests will be generated that will ensure +that your application behaves in the same way as you define in your stub. + +__Summing it up:__ On this side, in the stub definition, you need exact values as request and can use patterns/methods +for response verification. + +=== Dependencies + +Spring Cloud Contract Verifier and Stub Runner are using the following libraries + +- http://wiremock.org/[WireMock] +- https://github.com/jayway/JsonPath[Jayway JSONPath] +- https://github.com/marcingrzejszczak/jsonassert[JSONAssert from Marcin Grzejszczak] + +=== Additional links + +Below you can find some resources related to Spring Cloud Contract Verifier and Stub Runner. Note that some can be outdated since the Spring Cloud Contract Verifier project +is under constant development. + +==== Videos + +*Olga Maciaszek-Sharma talking about Accurest (Spring Cloud Contract Verifier predecessor)* + +video::daafmTYFoDU[youtube] + +*Marcin Grzejszczak and Jakub Kubryński talking about Accurest (Spring Cloud Contract Verifier predecessor)* + +video::130779882[vimeo] + +==== Readings + +- http://www.slideshare.net/MarcinGrzejszczak/stick-to-the-rules-consumer-driven-contracts-201507-confitura[Slides from Marcin Grzejszczak's talk about Accurest] +- http://toomuchcoding.com/blog/categories/accurest/[Accurest related articles from Marcin Grzejszczak's blog] + +=== Samples + +Here you can find some https://github.com/Codearte/accurest-samples[working samples]. Check the readme of each project for more information. + +=== Why use Spring Cloud Contract Verifier and not X ? + +For the time being Spring Cloud Contract Verifier 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 + +== Links + +Here you can find interesting links related to Spring Cloud Contract Verifier: + +- https://github.com/Codearte/accurest[Spring Cloud Contract Verifier Github Repository] +- http://codearte.github.io/accurest[Spring Cloud Contract Verifier Documentation] +- http://codearte.github.io/accurest/deprecated[Accurest Legacy Documentation] +- https://codearte.github.io/accurest/#spring-cloud-contract-stub-runner[Spring Cloud Contract Stub Runner Documentation] +- http://codearte.github.io/accurest/#stub-runner-for-messaging[Spring Cloud Contract Stub Runner Messaging Documentation] +- https://gitter.im/Codearte/accurest[Spring Cloud Contract Verifier Gitter] +- https://github.com/Codearte/accurest-maven-plugin[Spring Cloud Contract Verifier Maven Plugin] + +== Documentation + +You can read more about Spring Cloud Contract Verifier by reading the {documentation_url}[docs] + +== Contributing + +Spring Cloud is released under the non-restrictive Apache 2.0 license, +and follows a very standard Github development process, using Github +tracker for issues and merging pull requests into master. If you want +to contribute even something trivial please do not hesitate, but +follow the guidelines below. + +=== Sign the Contributor License Agreement +Before we accept a non-trivial patch or pull request we will need you to sign the +https://support.springsource.com/spring_committer_signup[contributor's agreement]. +Signing the contributor's agreement does not grant anyone commit rights to the main +repository, but it does mean that we can accept your contributions, and you will get an +author credit if we do. Active contributors might be asked to join the core team, and +given the ability to merge pull requests. + +=== Code of Conduct +This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of +conduct]. By participating, you are expected to uphold this code. Please report +unacceptable behavior to spring-code-of-conduct@pivotal.io. + +=== Code Conventions and Housekeeping +None of these is essential for a pull request, but they will all help. They can also be +added after the original pull request but before a merge. + +* Use the Spring Framework code format conventions. If you use Eclipse + you can import formatter settings using the + `eclipse-code-formatter.xml` file from the + https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-dependencies-parent/eclipse-code-formatter.xml[Spring + Cloud Build] project. If using IntelliJ, you can use the + http://plugins.jetbrains.com/plugin/6546[Eclipse Code Formatter + Plugin] to import the same file. +* Make sure all new `.java` files to have a simple Javadoc class comment with at least an + `@author` tag identifying you, and preferably at least a paragraph on what the class is + for. +* Add the ASF license header comment to all new `.java` files (copy from existing files + in the project) +* Add yourself as an `@author` to the .java files that you modify substantially (more + than cosmetic changes). +* Add some Javadocs and, if you change the namespace, some XSD doc elements. +* A few unit tests would help a lot as well -- someone has to do it. +* If no-one else is using your branch, please rebase it against the current master (or + other target branch in the main project). +* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], + if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit + message (where XXXX is the issue number). \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/asciidoctor.css b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/asciidoctor.css new file mode 100644 index 0000000000..06d52e688a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/asciidoctor.css @@ -0,0 +1,399 @@ +/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ +/* Remove the comments around the @import statement below when using this as a custom stylesheet */ +/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic|Noto+Serif:400,400italic,700,700italic|Droid+Sans+Mono:400";*/ +article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} +audio,canvas,video{display:inline-block} +audio:not([controls]){display:none;height:0} +[hidden],template{display:none} +script{display:none!important} +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} +body{margin:0} +a{background:transparent} +a:focus{outline:thin dotted} +a:active,a:hover{outline:0} +h1{font-size:2em;margin:.67em 0} +abbr[title]{border-bottom:1px dotted} +b,strong{font-weight:bold} +dfn{font-style:italic} +hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} +mark{background:#ff0;color:#000} +code,kbd,pre,samp{font-family:monospace;font-size:1em} +pre{white-space:pre-wrap} +q{quotes:"\201C" "\201D" "\2018" "\2019"} +small{font-size:80%} +sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} +sup{top:-.5em} +sub{bottom:-.25em} +img{border:0} +svg:not(:root){overflow:hidden} +figure{margin:0} +fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} +legend{border:0;padding:0} +button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} +button,input{line-height:normal} +button,select{text-transform:none} +button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} +button[disabled],html input[disabled]{cursor:default} +input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} +input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} +input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} +button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} +textarea{overflow:auto;vertical-align:top} +table{border-collapse:collapse;border-spacing:0} +*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} +html,body{font-size:100%} +body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto} +a:hover{cursor:pointer} +img,object,embed{max-width:100%;height:auto} +object,embed{height:100%} +img{-ms-interpolation-mode:bicubic} +#map_canvas img,#map_canvas embed,#map_canvas object,.map_canvas img,.map_canvas embed,.map_canvas object{max-width:none!important} +.left{float:left!important} +.right{float:right!important} +.text-left{text-align:left!important} +.text-right{text-align:right!important} +.text-center{text-align:center!important} +.text-justify{text-align:justify!important} +.hide{display:none} +.antialiased,body{-webkit-font-smoothing:antialiased} +img{display:inline-block;vertical-align:middle} +textarea{height:auto;min-height:50px} +select{width:100%} +p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} +.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} +div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} +a{color:#2156a5;text-decoration:underline;line-height:inherit} +a:hover,a:focus{color:#1d4b8f} +a img{border:none} +p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} +p aside{font-size:.875em;line-height:1.35;font-style:italic} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} +h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} +h1{font-size:2.125em} +h2{font-size:1.6875em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} +h4,h5{font-size:1.125em} +h6{font-size:1em} +hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} +em,i{font-style:italic;line-height:inherit} +strong,b{font-weight:bold;line-height:inherit} +small{font-size:60%;line-height:inherit} +code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} +ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} +ul,ol,ul.no-bullet,ol.no-bullet{margin-left:1.5em} +ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} +ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} +ul.square{list-style-type:square} +ul.circle{list-style-type:circle} +ul.disc{list-style-type:disc} +ul.no-bullet{list-style:none} +ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} +dl dt{margin-bottom:.3125em;font-weight:bold} +dl dd{margin-bottom:1.25em} +abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} +abbr{text-transform:none} +blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} +blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} +blockquote cite:before{content:"\2014 \0020"} +blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} +blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} +@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} +h1{font-size:2.75em} +h2{font-size:2.3125em} +h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} +h4{font-size:1.4375em}}table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} +table thead,table tfoot{background:#f7f8f7;font-weight:bold} +table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} +table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} +table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} +table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} +h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} +h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} +.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} +.clearfix:after,.float-group:after{clear:both} +*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} +pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} +.keyseq{color:rgba(51,51,51,.8)} +kbd{display:inline-block;color:rgba(0,0,0,.8);font-size:.75em;line-height:1.4;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:-.15em .15em 0 .15em;padding:.2em .6em .2em .5em;vertical-align:middle;white-space:nowrap} +.keyseq kbd:first-child{margin-left:0} +.keyseq kbd:last-child{margin-right:0} +.menuseq,.menu{color:rgba(0,0,0,.8)} +b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} +b.button:before{content:"[";padding:0 3px 0 2px} +b.button:after{content:"]";padding:0 2px 0 3px} +p a>code:hover{color:rgba(0,0,0,.9)} +#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} +#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} +#header:after,#content:after,#footnotes:after,#footer:after{clear:both} +#content{margin-top:1.25em} +#content:before{content:none} +#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} +#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} +#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} +#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} +#header .details span:first-child{margin-left:-.125em} +#header .details span.email a{color:rgba(0,0,0,.85)} +#header .details br{display:none} +#header .details br+span:before{content:"\00a0\2013\00a0"} +#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} +#header .details br+span#revremark:before{content:"\00a0|\00a0"} +#header #revnumber{text-transform:capitalize} +#header #revnumber:after{content:"\00a0"} +#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} +#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} +#toc>ul{margin-left:.125em} +#toc ul.sectlevel0>li>a{font-style:italic} +#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} +#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} +#toc a{text-decoration:none} +#toc a:active{text-decoration:underline} +#toctitle{color:#7a2518;font-size:1.2em} +@media only screen and (min-width:768px){#toctitle{font-size:1.375em} +body.toc2{padding-left:15em;padding-right:0} +#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} +#toc.toc2 #toctitle{margin-top:0;font-size:1.2em} +#toc.toc2>ul{font-size:.9em;margin-bottom:0} +#toc.toc2 ul ul{margin-left:0;padding-left:1em} +#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} +body.toc2.toc-right{padding-left:0;padding-right:15em} +body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} +#toc.toc2{width:20em} +#toc.toc2 #toctitle{font-size:1.375em} +#toc.toc2>ul{font-size:.95em} +#toc.toc2 ul ul{padding-left:1.25em} +body.toc2.toc-right{padding-left:0;padding-right:20em}}#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +#content #toc>:first-child{margin-top:0} +#content #toc>:last-child{margin-bottom:0} +#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} +#footer-text{color:rgba(255,255,255,.8);line-height:1.44} +.sect1{padding-bottom:.625em} +@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}.sect1+.sect1{border-top:1px solid #efefed} +#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} +#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} +#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} +#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} +#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} +.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} +.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} +table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} +.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} +table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} +.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} +.admonitionblock>table td.icon{text-align:center;width:80px} +.admonitionblock>table td.icon img{max-width:none} +.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} +.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} +.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} +.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} +.exampleblock>.content>:first-child{margin-top:0} +.exampleblock>.content>:last-child{margin-bottom:0} +.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} +.sidebarblock>:first-child{margin-top:0} +.sidebarblock>:last-child{margin-bottom:0} +.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} +.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} +.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} +.listingblock pre.highlightjs{padding:0} +.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} +.listingblock pre.prettyprint{border-width:0} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} +table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} +table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0} +table.pyhltable td.code{padding-left:.75em;padding-right:0} +pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} +pre.pygments .lineno{display:inline-block;margin-right:.25em} +table.pyhltable .linenodiv{background:none!important;padding-right:0!important} +.quoteblock{margin:0 1em 1.25em 1.5em;display:table} +.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} +.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} +.quoteblock blockquote{margin:0;padding:0;border:0} +.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} +.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} +.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} +.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} +.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} +.quoteblock .quoteblock blockquote:before{display:none} +.verseblock{margin:0 1em 1.25em 1em} +.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} +.verseblock pre strong{font-weight:400} +.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} +.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} +.quoteblock .attribution br,.verseblock .attribution br{display:none} +.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.05em;color:rgba(0,0,0,.6)} +.quoteblock.abstract{margin:0 0 1.25em 0;display:block} +.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} +.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} +table.tableblock{max-width:100%;border-collapse:separate} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.spread{width:100%} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} +table thead th,table tfoot th{font-weight:bold} +tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} +tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} +p.tableblock>code:only-child{background:none;padding:0} +p.tableblock{font-size:1em} +td>div.verse{white-space:pre} +ol{margin-left:1.75em} +ul li ol{margin-left:1.5em} +dl dd{margin-left:1.125em} +dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} +ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} +ul.unstyled,ol.unnumbered,ul.checklist,ul.none{list-style-type:none} +ul.unstyled,ol.unnumbered,ul.checklist{margin-left:.625em} +ul.checklist li>p:first-child>.fa-check-square-o:first-child,ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em} +ul.checklist li>p:first-child>input[type="checkbox"]:first-child{position:relative;top:1px} +ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} +ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} +ul.inline>li>*{display:block} +.unstyled dl dt{font-weight:400;font-style:normal} +ol.arabic{list-style-type:decimal} +ol.decimal{list-style-type:decimal-leading-zero} +ol.loweralpha{list-style-type:lower-alpha} +ol.upperalpha{list-style-type:upper-alpha} +ol.lowerroman{list-style-type:lower-roman} +ol.upperroman{list-style-type:upper-roman} +ol.lowergreek{list-style-type:lower-greek} +.hdlist>table,.colist>table{border:0;background:none} +.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} +td.hdlist1{padding-right:.75em;font-weight:bold} +td.hdlist1,td.hdlist2{vertical-align:top} +.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} +.colist>table tr>td:first-of-type{padding:0 .75em;line-height:1} +.colist>table tr>td:last-of-type{padding:.25em 0} +.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} +.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} +.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} +.imageblock>.title{margin-bottom:0} +.imageblock.thumb,.imageblock.th{border-width:6px} +.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} +.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} +.image.left{margin-right:.625em} +.image.right{margin-left:.625em} +a.image{text-decoration:none} +span.footnote,span.footnoteref{vertical-align:super;font-size:.875em} +span.footnote a,span.footnoteref a{text-decoration:none} +span.footnote a:active,span.footnoteref a:active{text-decoration:underline} +#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} +#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} +#footnotes .footnote{padding:0 .375em;line-height:1.3;font-size:.875em;margin-left:1.2em;text-indent:-1.2em;margin-bottom:.2em} +#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} +#footnotes .footnote:last-of-type{margin-bottom:0} +#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} +.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} +.gist .file-data>table td.line-data{width:99%} +div.unbreakable{page-break-inside:avoid} +.big{font-size:larger} +.small{font-size:smaller} +.underline{text-decoration:underline} +.overline{text-decoration:overline} +.line-through{text-decoration:line-through} +.aqua{color:#00bfbf} +.aqua-background{background-color:#00fafa} +.black{color:#000} +.black-background{background-color:#000} +.blue{color:#0000bf} +.blue-background{background-color:#0000fa} +.fuchsia{color:#bf00bf} +.fuchsia-background{background-color:#fa00fa} +.gray{color:#606060} +.gray-background{background-color:#7d7d7d} +.green{color:#006000} +.green-background{background-color:#007d00} +.lime{color:#00bf00} +.lime-background{background-color:#00fa00} +.maroon{color:#600000} +.maroon-background{background-color:#7d0000} +.navy{color:#000060} +.navy-background{background-color:#00007d} +.olive{color:#606000} +.olive-background{background-color:#7d7d00} +.purple{color:#600060} +.purple-background{background-color:#7d007d} +.red{color:#bf0000} +.red-background{background-color:#fa0000} +.silver{color:#909090} +.silver-background{background-color:#bcbcbc} +.teal{color:#006060} +.teal-background{background-color:#007d7d} +.white{color:#bfbfbf} +.white-background{background-color:#fafafa} +.yellow{color:#bfbf00} +.yellow-background{background-color:#fafa00} +span.icon>.fa{cursor:default} +.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} +.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} +.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} +.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} +.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} +.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} +.conum[data-value] *{color:#fff!important} +.conum[data-value]+b{display:none} +.conum[data-value]:after{content:attr(data-value)} +pre .conum[data-value]{position:relative;top:-.125em} +b.conum *{color:inherit!important} +.conum:not([data-value]):empty{display:none} +h1,h2{letter-spacing:-.01em} +dt,th.tableblock,td.content{text-rendering:optimizeLegibility} +p,td.content{letter-spacing:-.01em} +p strong,td.content strong{letter-spacing:-.005em} +p,blockquote,dt,td.content{font-size:1.0625rem} +p{margin-bottom:1.25rem} +.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} +.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} +.print-only{display:none!important} +@media print{@page{margin:1.25cm .75cm} +*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} +a{color:inherit!important;text-decoration:underline!important} +a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} +a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} +abbr[title]:after{content:" (" attr(title) ")"} +pre,blockquote,tr,img{page-break-inside:avoid} +thead{display:table-header-group} +img{max-width:100%!important} +p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} +h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} +#toc,.sidebarblock,.exampleblock>.content{background:none!important} +#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} +.sect1{padding-bottom:0!important} +.sect1+.sect1{border:0!important} +#header>h1:first-child{margin-top:1.25rem} +body.book #header{text-align:center} +body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} +body.book #header .details{border:0!important;display:block;padding:0!important} +body.book #header .details span:first-child{margin-left:0!important} +body.book #header .details br{display:block} +body.book #header .details br+span:before{content:none!important} +body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} +body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} +.listingblock code[data-lang]:before{display:block} +#footer{background:none!important;padding:0 .9375em} +#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} +.hide-on-print{display:none!important} +.print-only{display:block!important} +.hide-for-print{display:none!important} +.show-for-print{display:inherit!important}} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.gradle new file mode 100644 index 0000000000..82570396cb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.gradle @@ -0,0 +1,88 @@ +buildscript { + repositories { + mavenCentral() + mavenLocal() + maven { url 'https://repo.spring.io/plugins-release' } + if (project.hasProperty('fatJar')) jcenter() + } + dependencies { + classpath "com.bmuschko:gradle-nexus-plugin:2.3" + classpath "io.codearte.gradle.nexus:gradle-nexus-staging-plugin:0.5.3" + if (project.hasProperty('fatJar')) classpath 'com.github.jengelman.gradle.plugins:shadow:1.2.3' + } +} + +ext { + repoUser = System.getenv('REPO_USERNAME') ?: project.findProperty('REPO_USERNAME') ?: '' + repoPass = System.getenv('REPO_PASSWORD') ?: project.findProperty('REPO_PASSWORD') ?: '' + projectsToSkipPublication = ['parent', 'samples', 'docs', 'root'] +} + +allprojects { + project.version = findProperty('contractVerifierVersion') ?: '1.0.0.BUILD-SNAPSHOT' + apply from: "$rootDir/gradle/release.gradle" +} + +subprojects { + apply plugin: 'groovy' + + group = 'org.springframework.cloud.contract' + + sourceCompatibility = 1.7 + targetCompatibility = 1.7 + + repositories { + mavenLocal() + mavenCentral() + jcenter() + maven { url "http://repo.spring.io/snapshot" } + maven { url "http://repo.spring.io/milestone" } + maven { url "http://repo.spring.io/libs-release-local" } + maven { url "http://repo.spring.io/libs-staging-local/" } + } + + //Dependencies in all subprojects - http://solidsoft.wordpress.com/2014/11/13/gradle-tricks-display-dependencies-for-all-subprojects-in-multi-project-build/ + task allDeps(type: DependencyReportTask) {} + task allInsight(type: DependencyInsightReportTask) {} + + dependencies { + compile localGroovy() + testCompile('org.spockframework:spock-core:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'info.solidsoft.spock:spock-global-unroll:0.5.0' + } + + test { + testLogging { + exceptionFormat = 'full' + } + } + + // fixing the groovydoc issue http://stackoverflow.com/questions/20618857/gradle-task-groovydoc-failing-with-noclassdeffounderror + configurations { + jansi.extendsFrom(runtime) + } + groovydoc { + def title = "IPDS ${version}" + groovyClasspath = project.configurations.jansi + } + dependencies { + jansi 'org.fusesource.jansi:jansi:1.11' + } +} + +configurations { + all { + resolutionStrategy { + eachDependency { DependencyResolveDetails details -> + // To prevent an accidental usage of groovy-all.jar and groovy.jar in different versions + // all modularized Groovy jars are replaced with groovy-all.jar by default. + if (details.requested.group == 'org.codehaus.groovy' && details.requested.name != "groovy-all") { + details.useTarget("org.codehaus.groovy:groovy-all:${details.requested.version}") + } + } + } + } +} + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.sh new file mode 100755 index 0000000000..0a16b0b0e9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +./gradlew clean build --parallel \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/deploy.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/deploy.sh new file mode 100755 index 0000000000..8c061c8b65 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/deploy.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +./gradlew clean build install && ./scripts/runTests.sh && ./gradlew uploadArchives -x test \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/build.gradle new file mode 100644 index 0000000000..2a79e0ef8f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/build.gradle @@ -0,0 +1,90 @@ +/* + * Copyright 2013-2016 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. + */ + +plugins { + id 'org.ajoberstar.github-pages' version '1.1.0' + id 'org.asciidoctor.gradle.asciidoctor' version '1.5.1' + id 'org.asciidoctor.convert' version '1.5.3' + id 'com.github.jruby-gradle.base' version '1.2.1' +} + + +apply plugin: 'org.asciidoctor.gradle.asciidoctor' +apply plugin: 'com.github.jruby-gradle.base' + +dependencies { + gems group: 'rubygems', name: 'asciidoctor', version: '1.5.3' +} + +asciidoctorj { + version = '1.5.4' +} + +task generateReadme(type: com.github.jrubygradle.JRubyExec) { + dependsOn jrubyPrepare + + description "Generates an output README.adoc" + script "${projectDir}/src/main/ruby/generate_readme.sh" + scriptArgs "-o${new File(project.rootDir, 'README.adoc')}" + gemWorkDir jrubyPrepare.outputDir +} + +asciidoctor { + String backend = 'html' + dependsOn jrubyPrepare + + resources { + from("src/main/asciidoc/") { + include '**/*.png' + include '**/*.jpg' + include '**/*.html' + } + into './' + } + + sourceDir 'src/main/asciidoc' + backends backend + attributes 'build-gradle': file('build.gradle'), + 'endpoint-url': 'https://Codearte.github.io/accurest', + 'source-highlighter': 'coderay', + 'imagesdir': 'images', + 'toc': 'left', + 'icons': 'font', + 'setanchors': 'true', + 'idprefix': '', + 'idseparator': '-', + 'docinfo1': 'true', + 'doctype' : 'article' + + gemPath = jrubyPrepare.outputDir +} + +generateReadme.dependsOn asciidoctor +publishGhPages.dependsOn asciidoctor + +githubPages { + repoUri = 'https://github.com/Codearte/accurest' + credentials { + username = project.hasProperty('githubToken') ? project.githubToken : '' + password = project.hasProperty('githubPass') ? project.githubPass : '' + } + + pages { + from('build/asciidoc/html') { + include '**/' + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/README.adoc new file mode 100644 index 0000000000..cc85698563 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/README.adoc @@ -0,0 +1,19 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core +:stubrunner_core_path: {core_path}/spring-cloud-contract-stub-runner +:documentation_url: http://codearte.github.io/accurest + += Spring Cloud Contract Verifier + +include::introduction.adoc[] + +include::links.adoc[] + +== Documentation + +You can read more about Spring Cloud Contract Verifier by reading the {documentation_url}[docs] + +== Contributing + +include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[] diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/contract.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/contract.adoc new file mode 100644 index 0000000000..a846910959 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/contract.adoc @@ -0,0 +1,220 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core + +== Contract DSL + +IMPORTANT: Remember that inside the contract file you have to provide the fully qualified name to +the `Contract` class and the `make` static import i.e. `org.springframework.cloud.contract.spec.Contract.make { ... }`. +You can also provide an import to the `Contract` class `import org.springframework.cloud.contract.spec.Contract` and then call + `Contract.make { ... }` + +Contract DSL is written in Groovy, but don't be alarmed if you didn't use Groovy before. Knowledge of the language is not really needed as our DSL uses only +a tiny subset of it (namely literals, method calls and closures). What's more the DSL is designed to be programmer-readable without any knowledge of the DSL itself - + it's statically typed. + +The Contract is present in the `spring-cloud-contract-spec` module of the Spring Cloud Contract Verifier repository. + +Let's look at full example of a contract definition. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcMethodBodyBuilderSpec.groovy[tags=dsl_example,indent=0] +---- + +Not all features of the DSL are used in example above. If you didn't find what you are looking for, please check next paragraphs on this page. + +> You can easily compile Contracts to WireMock stubs mapping using standalone maven command: `mvn org.springframework.cloud.contract:spring-cloud-contract-verifier-maven-plugin:convert`. + +=== Limitations + +WARNING: Spring Cloud Contract Verifier doesn't support XML properly. Please use JSON or help us implement this feature. + +WARNING: Spring Cloud Contract Verifier supports equality check on text response. Regular expressions are not yet available. + +WARNING: The support for the verification of size of JSON arrays is experimental. If you want to turn it on please provide +the value of a system property `spring.cloud.contract.verifier.assert.size` equal to `true`. By default this feature is set to +`false`. You can also provide the `assertJsonSize` property in the plugin configuration. + +=== HTTP Top-Level Elements + +Following methods can be called in the top-level closure of a contract definition. Request and response are mandatory, priority is optional. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=http_dsl,indent=0] +---- + +=== Request + +HTTP protocol requires only **method and address** to be specified in a request. The same information is mandatory in request definition of the Contract. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=request,indent=0] +---- + +It is possible to specify whole `url` instead of just path, but `urlPath` is the recommended way as it makes the tests **host-independent**. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=url,indent=0] + +---- + +Request may contain **query parameters**, which are specified in a closure nested in a call to `urlPath` or `url`. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=urlpath,indent=0] +---- + +It may contain additional **request headers**... + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=headers,indent=0] +---- + +...and a **request body**. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=body,indent=0] +---- + +**Body's format** can also be specified explicitly by invoking one of format functions. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=bodyAsXml,indent=0] +---- + +=== Response + +Minimal response must contain **HTTP status code**. + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=response,indent=0] +---- + +Besides status response may contain **headers** and **body**, which are specified the same way as in the request (see previous paragraph). + +=== Regular expressions +You can use regular expressions to write your requests in Contract DSL. It 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 it when you need to use patterns and not exact values both +for your test and your server side tests. + +Please see the example below: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=regex,indent=0] +---- + +=== Passing optional parameters + +It is possible to provide optional parameters in your contract. It's only possible to have optional parameter for the: + +- __STUB__ side of the Request +- __TEST__ side of the Response + +Example: + +[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 are in fact creating a regular expression that should be present 0 or more times. + +That way for the example above the following test would be generated if you pick Spock: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=optionals_test,indent=0] +---- + +and the following stub: + +[source,javascript,indent=0] +---- +include::{verifier_root_path}/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy[tags=wiremock,indent=0] +---- + +=== Executing custom methods on server side +It is also possible to define a method call to be executed on the server side during the test. Such a method can be added to the class defined as "baseClassForTests" +in the configuration. Please see the examples below: + +==== Contract DSL + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy[tags=method,indent=0] +---- + +==== Base Mock Spec + +[source,groovy,indent=0] +---- +include::{verifier_root_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0] +---- + +=== JAX-RS support +Starting with release 0.8.0 we support JAX-RS 2 Client API. Base class needs to define `protected WebTarget webTarget` and server initialization, right now the only option how to test JAX-RS API is to start a web server. + +Request with a body needs to have a content type set otherwise `application/octet-stream` is going to be used. + +In order to use JAX-RS mode, use the following settings: + +[source,groovy,indent=0] +---- +testMode == 'JAXRSCLIENT' +---- + +Example of a test API generated: + +[source,groovy,indent=0] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientMethodBuilderSpec.groovy[tags=jaxrs,indent=0] +---- + +=== Messaging Top-Level Elements + +The DSL for messaging looks a little bit different than the one that focuses on HTTP. + +==== Output triggered by a method + +The output message can be triggered by calling a method (e.g. a Scheduler was started and a message was sent) + +[source,groovy] +---- +include::../../../../samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy[tags=method_trigger,indent=0] +---- + +In this case the output message will be sent to `output` if a method called `bookReturnedTriggered` will be executed. In the message *publisher's* side +we will generate a test that will call that method to trigger the message. On the *consumer* side you can use the `some_label` to trigger the message. + +==== Output triggered by a message + +The output message can be triggered by receiving a message. + +[source,groovy] +---- +include::../../../../samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy[tags=message_trigger,indent=0] +---- + +In this case the output message will be sent to `output` if a proper message will be received on the `input` destination. In the message *publisher's* side +we will generate a test that will send the input message to the defined destination. On the *consumer* side you can either send a message to the input +destination or use the `some_label` to trigger the message. + +==== Consumer / Producer + +In HTTP you have a notion of `client`/`stub and `server`/`test` notation. You can use them also in messaging but we're providing also the `consumer` and `produer` methods +as presented below (note 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] +---- \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/contract.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/contract.html new file mode 100644 index 0000000000..a210b8ade0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/contract.html @@ -0,0 +1,1232 @@ + + + + + + + +Contract DSL + + + + + + + +
+
+

Contract DSL

+
+
+

Contract DSL in Accurest is written in Groovy, but don’t be alarmed if you didn’t use Groovy before. Knowledge of the language is not really needed as our DSL uses only +a tiny subset of it (namely literals, method calls and closures). What’s more, Accurest’s DSL is designed to be programmer-readable without any knowledge of the DSL itself - + it’s statically typed.

+
+
+ + + + + +
+ + +Since {messaging_version} you can use the io.codearte.accurest.dsl.Accurest class in your DSL files. +
+
+
+

Let’s look at full example of a contract definition.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method 'PUT'
+                url '/api/12'
+                headers {
+                        header 'Content-Type': 'application/vnd.com.ofg.twitter-places-analyzer.v1+json'
+                }
+                body '''\
+                [{
+                        "created_at": "Sat Jul 26 09:38:57 +0000 2014",
+                        "id": 492967299297845248,
+                        "id_str": "492967299297845248",
+                        "text": "Gonna see you at Warsaw",
+                        "place":
+                        {
+                                "attributes":{},
+                                "bounding_box":
+                                {
+                                        "coordinates":
+                                                [[
+                                                        [-77.119759,38.791645],
+                                                        [-76.909393,38.791645],
+                                                        [-76.909393,38.995548],
+                                                        [-77.119759,38.995548]
+                                                ]],
+                                        "type":"Polygon"
+                                },
+                                "country":"United States",
+                                "country_code":"US",
+                                "full_name":"Washington, DC",
+                                "id":"01fbe706f872cb32",
+                                "name":"Washington",
+                                "place_type":"city",
+                                "url": "http://api.twitter.com/1/geo/id/01fbe706f872cb32.json"
+                        }
+                }]
+        '''
+        }
+        response {
+                status 200
+        }
+}
+
+
+
+

Not all features of the DSL are used in example above. If you didn’t find what you are looking for, please check next paragraphs on this page.

+
+
+
+
+

You can easily compile Accurest Contracts to WireMock stubs mapping using standalone maven command: mvn io.codearte.accurest:accurest-maven-plugin:convert.

+
+
+
+
+

Limitations

+
+ + + + + +
+ + +Accurest doesn’t support XML properly. Please use JSON or help us implement this feature. +
+
+
+ + + + + +
+ + +Accurest supports equality check on text response. Regular expressions are not yet available. +
+
+
+
+

HTTP Top-Level Elements

+
+

Following methods can be called in the top-level closure of a contract definition. Request and response are mandatory, priority is optional.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        // Definition of HTTP request part of the contract
+        // (this can be a valid request or invalid depending
+        // on type of contract being specified).
+        request {
+                //...
+        }
+
+        // Definition of HTTP response part of the contract
+        // (a service implementing this contract should respond
+        // with following response after receiving request
+        // specified in "request" part above).
+        response {
+                //...
+        }
+
+        // Contract priority, which can be used for overriding
+        // contracts (1 is highest). Priority is optional.
+        priority 1
+}
+
+
+
+
+

Request

+
+

HTTP protocol requires only method and address to be specified in a request. The same information is mandatory in request definition of Accurest contract.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                // HTTP request method (GET/POST/PUT/DELETE).
+                method 'GET'
+
+                // Path component of request URL is specified as follows.
+                urlPath('/users')
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

It is possible to specify whole url instead of just path, but urlPath is the recommended way as it makes the tests host-independent.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method 'GET'
+
+                // Specifying `url` and `urlPath` in one contract is illegal.
+                url('http://localhost:8888/users')
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

Request may contain query parameters, which are specified in a closure nested in a call to urlPath or url.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                urlPath('/users') {
+
+                        // Each parameter is specified in form
+                        // `'paramName' : paramValue` where parameter value
+                        // may be a simple literal or one of matcher functions,
+                        // all of which are used in this example.
+                        queryParameters {
+
+                                // If a simple literal is used as value
+                                // default matcher function is used (equalTo)
+                                parameter 'limit': 100
+
+                                // `equalTo` function simply compares passed value
+                                // using identity operator (==).
+                                parameter 'filter': equalTo("email")
+
+                                // `containing` function matches strings
+                                // that contains passed substring.
+                                parameter 'gender': value(stub(containing("[mf]")), server('mf'))
+
+                                // `matching` function tests parameter
+                                // against passed regular expression.
+                                parameter 'offset': value(stub(matching("[0-9]+")), server(123))
+
+                                // `notMatching` functions tests if parameter
+                                // does not match passed regular expression.
+                                parameter 'loginStartsWith': value(stub(notMatching(".{0,2}")), server(3))
+                        }
+                }
+
+                //...
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

It may contain additional request headers…​

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                // Each header is added in form `'Header-Name' : 'Header-Value'`.
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+
+                //...
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

…​and a request body.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                // JSON and XML formats of request body are supported.
+                // Format will be determined from a header or body's content.
+                body '''{ "login" : "john", "name": "John The Contract" }'''
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

Body’s format can also be specified explicitly by invoking one of format functions.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                // In this case body will be formatted as XML.
+                body equalToXml(
+                                '''<user><login>john</login><name>John The Contract</name></user>'''
+                )
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+
+

Response

+
+

Minimal response must contain HTTP status code.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+        }
+        response {
+                // Status code sent by the server
+                // in response to request specified above.
+                status 200
+        }
+}
+
+
+
+

Besides status response may contain headers and body, which are specified the same way as in the request (see previous paragraph).

+
+
+
+

Regular expressions

+
+

You can use regular expressions to write your requests in Contract DSL. It 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 it when you need to use patterns and not exact values both +for your test and your server side tests.

+
+
+

Please see the example below:

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method('GET')
+                url $(client(~/\/[0-9]{2}/), server('/12'))
+        }
+        response {
+                status 200
+                body(
+                                id: value(
+                                                client('123'),
+                                                server(regex('[0-9]+'))
+                                ),
+                                surname: $(
+                                                client('Kowalsky'),
+                                                server('Lewandowski')
+                                ),
+                                name: 'Jan',
+                                created: $(client('2014-02-02 12:23:43'), server(execute('currentDate(it)'))),
+                                correlationId: value(client('5d1f9fef-e0dc-4f3d-a7e4-72d2220dd827'),
+                                                server(regex('[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}'))
+                                )
+                )
+                headers {
+                        header 'Content-Type': 'text/plain'
+                }
+        }
+}
+
+
+
+
+

Passing optional parameters

+
+

It is possible to provide optional parameters in your contract. It’s only possible to have optional parameter for the:

+
+
+
    +
  • +

    STUB side of the Request

    +
    • +
  • +

    TEST side of the Response

    +
    • +
+
+
+

Example:

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        priority 1
+        request {
+                method 'POST'
+                url '/users/password'
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+                body(
+                                email: $(stub(optional(regex(email()))), test('abc@abc.com')),
+                                callback_url: $(stub(regex(hostname())), test('http://partners.com'))
+                )
+        }
+        response {
+                status 404
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+                body(
+                                code: value(stub("123123"), test(optional("123123")))
+                )
+        }
+}
+
+
+
+

By wrapping a part of the body with the optional() method you are in fact creating a regular expression that should be present 0 or more times.

+
+
+

That way for the example above the following test would be generated if you pick Spock:

+
+
+
+
"""
+ given:
+  def request = given()
+    .header('Content-Type', 'application/json')
+    .body('''{"email":"abc@abc.com","callback_url":"http://partners.com"}''')
+
+ when:
+  def response = given().spec(request)
+    .post("/users/password")
+
+ then:
+  response.statusCode == 404
+  response.header('Content-Type')  == 'application/json'
+ and:
+  DocumentContext parsedJson = JsonPath.parse(response.body.asString())
+  assertThatJson(parsedJson).field("code").matches("(123123)?")
+"""
+
+
+
+

and the following stub:

+
+
+
+
'''
+{
+  "request" : {
+    "url" : "/users/password",
+    "method" : "POST",
+    "bodyPatterns" : [ {
+      "matchesJsonPath" : "$[?(@.email =~ /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,4})?/)]"
+    }, {
+      "matchesJsonPath" : "$[?(@.callback_url =~ /((http[s]?|ftp):\\\\/)\\\\/?([^:\\\\/\\\\s]+)(:[0-9]{1,5})?/)]"
+    } ],
+    "headers" : {
+      "Content-Type" : {
+        "equalTo" : "application/json"
+      }
+    }
+  },
+  "response" : {
+    "status" : 404,
+    "body" : "{\\"code\\":\\"123123\\",\\"message\\":\\"User not found by email == [not.existing@user.com]\\"}",
+    "headers" : {
+      "Content-Type" : "application/json"
+    }
+  },
+  "priority" : 1
+}
+'''
+
+
+
+
+

Executing custom methods on server side

+
+

It is also possible to define a method call to be executed on the server side during the test. Such a method can be added to the class defined as "baseClassForTests" +in the configuration. Please see the examples below:

+
+
+

Groovy DSL

+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method 'PUT'
+                url $(client(regex('^/api/[0-9]{2}$')), server('/api/12'))
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+                body '''\
+                                [{
+                                        "text": "Gonna see you at Warsaw"
+                                }]
+                        '''
+        }
+        response {
+                body (
+                                path: $(client('/api/12'), server(regex('^/api/[0-9]{2}$'))),
+                                correlationId: $(client('1223456'), server(execute('isProperCorrelationId($it)')))
+                )
+                status 200
+        }
+}
+
+
+
+
+

Base Mock Spec

+
+
+
abstract class BaseMockMvcSpec extends Specification {
+
+        def setup() {
+                RestAssuredMockMvc.standaloneSetup(new PairIdController())
+        }
+
+        void isProperCorrelationId(Integer correlationId) {
+                assert correlationId == 123456
+        }
+
+        void isEmpty(String value) {
+                assert value == null
+        }
+
+}
+
+
+
+
+
+

JAX-RS support

+
+

Starting with release 0.8.0 we support JAX-RS 2 Client API. Base class needs to define protected WebTarget webTarget and server initialization, right now the only option how to test JAX-RS API is to start a web server.

+
+
+

Request with a body needs to have a content type set otherwise application/octet-stream is going to be used.

+
+
+

In order to use JAX-RS mode, use the following settings:

+
+
+
+
testMode == 'JAXRSCLIENT'
+
+
+
+

Example of a test API generated:

+
+
+
+
'''
+ // 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()
+    .method("GET");
+
+  String responseAsString = response.readEntity(String.class);
+
+ // then:
+  assertThat(response.getStatus()).isEqualTo(200);
+ // and:
+  DocumentContext parsedJson = JsonPath.parse(responseAsString);
+  assertThatJson(parsedJson).field("property1").isEqualTo("a");
+'''
+
+
+
+
+

Messaging Top-Level Elements

+
+ + + + + +
+ + +Feature available since {messaging_version} +
+
+
+

The DSL for messaging looks a little bit different than the one that focuses on HTTP.

+
+
+

Output triggered by a method

+
+

The output message can be triggered by calling a method (e.g. a Scheduler was started and a message was sent)

+
+
+
+
def dsl = GroovyDsl.make {
+        // Human readable description
+        description 'Some description'
+        // Label by means of which the output message can be triggered
+        label 'some_label'
+        // input to the contract
+        input {
+                // the contract will be triggered by a method
+                triggeredBy('bookReturnedTriggered()')
+        }
+        // output message of the contract
+        outputMessage {
+                // destination to which the output message will be sent
+                sentTo('output')
+                // the body of the output message
+                body('''{ "bookName" : "foo" }''')
+                // the headers of the output message
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

In this case the output message will be sent to output if a method called bookReturnedTriggered will be executed. In the message publisher’s side +we will generate a test that will call that method to trigger the message. On the consumer side you can use the some_label to trigger the message.

+
+
+
+

Output triggered by a message

+
+

The output message can be triggered by receiving a message.

+
+
+
+
def dsl = GroovyDsl.make {
+        description 'Some Description'
+        label 'some_label'
+        // input is a message
+        input {
+                // the message was received from this destination
+                messageFrom('input')
+                // has the following body
+                messageBody([
+                        bookName: 'foo'
+                ])
+                // and the following headers
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('output')
+                body([
+                        bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

In this case the output message will be sent to output if a proper message will be received on the input destination. In the message publisher’s side +we will generate a test that will send the input message to the defined destination. On the consumer side you can either send a message to the input +destination or use the some_label to trigger the message.

+
+
+
+

Consumer / Producer

+
+

In HTTP you have a notion of client/stub and `server/test notation. You can use them also in messaging but we’re providing also the consumer and produer methods +as presented below (note you can use either $ or value methods to provide consumer and producer parts)

+
+
+
+
Accurest.make {
+        label 'some_label'
+        input {
+                messageFrom value(consumer('jms:output'), producer('jms:input'))
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo $(consumer('jms:input'), producer('jms:output'))
+                body([
+                                bookName: 'foo'
+                ])
+        }
+}
+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Deps.png b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Deps.png new file mode 100644 index 0000000000..1426814308 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Deps.png differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Stubs1.png b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Stubs1.png new file mode 100644 index 0000000000..ebadfdb910 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Stubs1.png differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Stubs2.png b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Stubs2.png new file mode 100644 index 0000000000..e4bad24987 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/images/Stubs2.png differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/index.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/index.html new file mode 100644 index 0000000000..a0ed7a1410 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/index.html @@ -0,0 +1,3914 @@ + + + + + + + +Accurest + + + + + + + +
+
+
+
+

Adam Dudczak, Marcin Grzejszczak, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła

+
+
+
+
+

Introduction

+
+
+

Just to make long story short - Accurest is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications. It is shipped +with Contract Definition Language (DSL). Contract definitions are used by Accurest to produce following resources:

+
+
+
    +
  • +

    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, test data is produced by Accurest.

    +
    • +
  • +

    Messaging routes if you’re using one. We’re integrating with Spring Integration, Spring Cloud Stream and Apache Camel. You can however set your own integrations if you want to

    +
    • +
  • +

    Acceptance tests (in JUnit or Spock) used to verify if server-side implementation of the API is compliant with the contract (server tests). Full test is generated by Accurest.

    +
    • +
+
+
+

Accurest moves TDD to the level of software architecture.

+
+
+

Why?

+
+

Let us assume that we have a system comprising of multiple microservices:

+
+
+
+Microservices Architecture +
+
+
+

Testing issues

+
+

If we wanted to test the application in top left corner if it can communicate with other services then we could do one of two things:

+
+
+
    +
  • +

    deploy all microservices and perform end to end tests

    +
    • +
  • +

    mock other microservices in unit / integration tests

    +
    • +
+
+
+

Both have their advantages but also a lot of disadvantages. Let’s focus on the latter.

+
+
+

Deploy all microservices and perform end to end tests

+
+
+

Advantages:

+
+
+
    +
  • +

    simulates production

    +
    • +
  • +

    tests real communication between services

    +
    • +
+
+
+

Disadvantages:

+
+
+
    +
  • +

    to test one microservice we would have to deploy 6 microservices, a couple of databases etc.

    +
    • +
  • +

    the environment where the tests would be conducted would be locked for a single suite of tests (i.e. nobody else would be able to run the tests in the meantime).

    +
    • +
  • +

    long to run

    +
    • +
  • +

    very late feedback

    +
    • +
  • +

    extremely hard to debug

    +
    • +
+
+
+

Mock other microservices in unit / integration tests

+
+
+

Advantages:

+
+
+
    +
  • +

    very fast feedback

    +
    • +
  • +

    no infrastructure requirements

    +
    • +
+
+
+

Disadvantages:

+
+
+
    +
  • +

    the implementor of the service creates stubs thus they might have nothing to do with the reality

    +
    • +
  • +

    you can go to production with passing tests and failing production

    +
    • +
+
+
+

To solve the aforementioned issues Accurest with Stub Runner were created. Their main idea is to give you very fast feedback, without the need +to set up the whole world of microservices.

+
+
+
+Stubbed Services +
+
+
+

If you work on stubs then the only applications you need are those that your application is using directly.

+
+
+
+Stubbed Services +
+
+
+

Accurest gives you the certainty that the stubs that you’re using were created by the service that you’re calling. Also if you can use them it means that they were +tested against the producer’s side. In other words - you can trust those stubs.

+
+
+
+
+

Purposes

+
+

The main purposes of Accurest with Stub Runner are:

+
+
+
    +
  • +

    to ensure that WireMock / Messaging stubs (used when developing the client) are doing exactly what actual server-side implementation will do,

    +
    • +
  • +

    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 generate boilerplate test code used on the server side.

    +
    • +
+
+
+
+

Client Side

+
+

During the tests you want to have a Wiremock instance / Messaging route up and running that simulates the service Y. +You would like to feed that instance with a proper stub definition. That stub definition would need +to be valid and should also be reusable on the server side.

+
+
+

Summing it up: On this side, in the stub definition, you can use patterns for request stubbing and you need exact +values for responses.

+
+
+
+

Server Side

+
+

Being a service Y since you are developing your stub, you need to be sure that it’s actually resembling your +concrete implementation. You can’t have a situation where your stub acts in one way and your application on +production behaves in a different way.

+
+
+

That’s why from the provided stub acceptance tests will be generated that will ensure +that your application behaves in the same way as you define in your stub.

+
+
+

Summing it up: On this side, in the stub definition, you need exact values as request and can use patterns/methods +for response verification.

+
+
+
+

Dependencies

+
+

Accurest and Stub Runner are using the following libraries

+
+
+ +
+
+
+ +
+

Below you can find some resources related to Accurest and Stub Runner. Note that some can be outdated since the Accurest project +is under constant development.

+
+
+

Videos

+
+

Olga Maciaszek-Sharma talking about Accurest

+
+
+
+ +
+
+
+

Marcin Grzejszczak and Jakub Kubryński talking about Accurest

+
+
+
+ +
+
+
+
+

Readings

+
+ +
+
+
+
+

Samples

+
+

Here you can find some working samples. Check the readme of each project for more information.

+
+
+
+
+
+

Contract DSL

+
+
+

Contract DSL in Accurest is written in Groovy, but don’t be alarmed if you didn’t use Groovy before. Knowledge of the language is not really needed as our DSL uses only +a tiny subset of it (namely literals, method calls and closures). What’s more, Accurest’s DSL is designed to be programmer-readable without any knowledge of the DSL itself - + it’s statically typed.

+
+
+ + + + + +
+ + +Since 1.1.0 you can use the io.codearte.accurest.dsl.Accurest class in your DSL files. +
+
+
+

Let’s look at full example of a contract definition.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method 'PUT'
+                url '/api/12'
+                headers {
+                        header 'Content-Type': 'application/vnd.com.ofg.twitter-places-analyzer.v1+json'
+                }
+                body '''\
+                [{
+                        "created_at": "Sat Jul 26 09:38:57 +0000 2014",
+                        "id": 492967299297845248,
+                        "id_str": "492967299297845248",
+                        "text": "Gonna see you at Warsaw",
+                        "place":
+                        {
+                                "attributes":{},
+                                "bounding_box":
+                                {
+                                        "coordinates":
+                                                [[
+                                                        [-77.119759,38.791645],
+                                                        [-76.909393,38.791645],
+                                                        [-76.909393,38.995548],
+                                                        [-77.119759,38.995548]
+                                                ]],
+                                        "type":"Polygon"
+                                },
+                                "country":"United States",
+                                "country_code":"US",
+                                "full_name":"Washington, DC",
+                                "id":"01fbe706f872cb32",
+                                "name":"Washington",
+                                "place_type":"city",
+                                "url": "http://api.twitter.com/1/geo/id/01fbe706f872cb32.json"
+                        }
+                }]
+        '''
+        }
+        response {
+                status 200
+        }
+}
+
+
+
+

Not all features of the DSL are used in example above. If you didn’t find what you are looking for, please check next paragraphs on this page.

+
+
+
+
+

You can easily compile Accurest Contracts to WireMock stubs mapping using standalone maven command: mvn io.codearte.accurest:accurest-maven-plugin:convert.

+
+
+
+
+

Limitations

+
+ + + + + +
+ + +Accurest doesn’t support XML properly. Please use JSON or help us implement this feature. +
+
+
+ + + + + +
+ + +Accurest supports equality check on text response. Regular expressions are not yet available. +
+
+
+
+

HTTP Top-Level Elements

+
+

Following methods can be called in the top-level closure of a contract definition. Request and response are mandatory, priority is optional.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        // Definition of HTTP request part of the contract
+        // (this can be a valid request or invalid depending
+        // on type of contract being specified).
+        request {
+                //...
+        }
+
+        // Definition of HTTP response part of the contract
+        // (a service implementing this contract should respond
+        // with following response after receiving request
+        // specified in "request" part above).
+        response {
+                //...
+        }
+
+        // Contract priority, which can be used for overriding
+        // contracts (1 is highest). Priority is optional.
+        priority 1
+}
+
+
+
+
+

Request

+
+

HTTP protocol requires only method and address to be specified in a request. The same information is mandatory in request definition of Accurest contract.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                // HTTP request method (GET/POST/PUT/DELETE).
+                method 'GET'
+
+                // Path component of request URL is specified as follows.
+                urlPath('/users')
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

It is possible to specify whole url instead of just path, but urlPath is the recommended way as it makes the tests host-independent.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method 'GET'
+
+                // Specifying `url` and `urlPath` in one contract is illegal.
+                url('http://localhost:8888/users')
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

Request may contain query parameters, which are specified in a closure nested in a call to urlPath or url.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                urlPath('/users') {
+
+                        // Each parameter is specified in form
+                        // `'paramName' : paramValue` where parameter value
+                        // may be a simple literal or one of matcher functions,
+                        // all of which are used in this example.
+                        queryParameters {
+
+                                // If a simple literal is used as value
+                                // default matcher function is used (equalTo)
+                                parameter 'limit': 100
+
+                                // `equalTo` function simply compares passed value
+                                // using identity operator (==).
+                                parameter 'filter': equalTo("email")
+
+                                // `containing` function matches strings
+                                // that contains passed substring.
+                                parameter 'gender': value(stub(containing("[mf]")), server('mf'))
+
+                                // `matching` function tests parameter
+                                // against passed regular expression.
+                                parameter 'offset': value(stub(matching("[0-9]+")), server(123))
+
+                                // `notMatching` functions tests if parameter
+                                // does not match passed regular expression.
+                                parameter 'loginStartsWith': value(stub(notMatching(".{0,2}")), server(3))
+                        }
+                }
+
+                //...
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

It may contain additional request headers…​

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                // Each header is added in form `'Header-Name' : 'Header-Value'`.
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+
+                //...
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

…​and a request body.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                // JSON and XML formats of request body are supported.
+                // Format will be determined from a header or body's content.
+                body '''{ "login" : "john", "name": "John The Contract" }'''
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+

Body’s format can also be specified explicitly by invoking one of format functions.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+
+                // In this case body will be formatted as XML.
+                body equalToXml(
+                                '''<user><login>john</login><name>John The Contract</name></user>'''
+                )
+        }
+
+        response {
+                //...
+        }
+}
+
+
+
+
+

Response

+
+

Minimal response must contain HTTP status code.

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                //...
+        }
+        response {
+                // Status code sent by the server
+                // in response to request specified above.
+                status 200
+        }
+}
+
+
+
+

Besides status response may contain headers and body, which are specified the same way as in the request (see previous paragraph).

+
+
+
+

Regular expressions

+
+

You can use regular expressions to write your requests in Contract DSL. It 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 it when you need to use patterns and not exact values both +for your test and your server side tests.

+
+
+

Please see the example below:

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method('GET')
+                url $(client(~/\/[0-9]{2}/), server('/12'))
+        }
+        response {
+                status 200
+                body(
+                                id: value(
+                                                client('123'),
+                                                server(regex('[0-9]+'))
+                                ),
+                                surname: $(
+                                                client('Kowalsky'),
+                                                server('Lewandowski')
+                                ),
+                                name: 'Jan',
+                                created: $(client('2014-02-02 12:23:43'), server(execute('currentDate(it)'))),
+                                correlationId: value(client('5d1f9fef-e0dc-4f3d-a7e4-72d2220dd827'),
+                                                server(regex('[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}'))
+                                )
+                )
+                headers {
+                        header 'Content-Type': 'text/plain'
+                }
+        }
+}
+
+
+
+
+

Passing optional parameters

+
+

It is possible to provide optional parameters in your contract. It’s only possible to have optional parameter for the:

+
+
+
    +
  • +

    STUB side of the Request

    +
    • +
  • +

    TEST side of the Response

    +
    • +
+
+
+

Example:

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        priority 1
+        request {
+                method 'POST'
+                url '/users/password'
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+                body(
+                                email: $(stub(optional(regex(email()))), test('abc@abc.com')),
+                                callback_url: $(stub(regex(hostname())), test('http://partners.com'))
+                )
+        }
+        response {
+                status 404
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+                body(
+                                code: value(stub("123123"), test(optional("123123")))
+                )
+        }
+}
+
+
+
+

By wrapping a part of the body with the optional() method you are in fact creating a regular expression that should be present 0 or more times.

+
+
+

That way for the example above the following test would be generated if you pick Spock:

+
+
+
+
"""
+ given:
+  def request = given()
+    .header('Content-Type', 'application/json')
+    .body('''{"email":"abc@abc.com","callback_url":"http://partners.com"}''')
+
+ when:
+  def response = given().spec(request)
+    .post("/users/password")
+
+ then:
+  response.statusCode == 404
+  response.header('Content-Type')  == 'application/json'
+ and:
+  DocumentContext parsedJson = JsonPath.parse(response.body.asString())
+  assertThatJson(parsedJson).field("code").matches("(123123)?")
+"""
+
+
+
+

and the following stub:

+
+
+
+
'''
+{
+  "request" : {
+    "url" : "/users/password",
+    "method" : "POST",
+    "bodyPatterns" : [ {
+      "matchesJsonPath" : "$[?(@.email =~ /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,4})?/)]"
+    }, {
+      "matchesJsonPath" : "$[?(@.callback_url =~ /((http[s]?|ftp):\\\\/)\\\\/?([^:\\\\/\\\\s]+)(:[0-9]{1,5})?/)]"
+    } ],
+    "headers" : {
+      "Content-Type" : {
+        "equalTo" : "application/json"
+      }
+    }
+  },
+  "response" : {
+    "status" : 404,
+    "body" : "{\\"code\\":\\"123123\\",\\"message\\":\\"User not found by email == [not.existing@user.com]\\"}",
+    "headers" : {
+      "Content-Type" : "application/json"
+    }
+  },
+  "priority" : 1
+}
+'''
+
+
+
+
+

Executing custom methods on server side

+
+

It is also possible to define a method call to be executed on the server side during the test. Such a method can be added to the class defined as "baseClassForTests" +in the configuration. Please see the examples below:

+
+
+

Groovy DSL

+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        request {
+                method 'PUT'
+                url $(client(regex('^/api/[0-9]{2}$')), server('/api/12'))
+                headers {
+                        header 'Content-Type': 'application/json'
+                }
+                body '''\
+                                [{
+                                        "text": "Gonna see you at Warsaw"
+                                }]
+                        '''
+        }
+        response {
+                body (
+                                path: $(client('/api/12'), server(regex('^/api/[0-9]{2}$'))),
+                                correlationId: $(client('1223456'), server(execute('isProperCorrelationId($it)')))
+                )
+                status 200
+        }
+}
+
+
+
+
+

Base Mock Spec

+
+
+
abstract class BaseMockMvcSpec extends Specification {
+
+        def setup() {
+                RestAssuredMockMvc.standaloneSetup(new PairIdController())
+        }
+
+        void isProperCorrelationId(Integer correlationId) {
+                assert correlationId == 123456
+        }
+
+        void isEmpty(String value) {
+                assert value == null
+        }
+
+}
+
+
+
+
+
+

JAX-RS support

+
+

Starting with release 0.8.0 we support JAX-RS 2 Client API. Base class needs to define protected WebTarget webTarget and server initialization, right now the only option how to test JAX-RS API is to start a web server.

+
+
+

Request with a body needs to have a content type set otherwise application/octet-stream is going to be used.

+
+
+

In order to use JAX-RS mode, use the following settings:

+
+
+
+
testMode == 'JAXRSCLIENT'
+
+
+
+

Example of a test API generated:

+
+
+
+
'''
+ // 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()
+    .method("GET");
+
+  String responseAsString = response.readEntity(String.class);
+
+ // then:
+  assertThat(response.getStatus()).isEqualTo(200);
+ // and:
+  DocumentContext parsedJson = JsonPath.parse(responseAsString);
+  assertThatJson(parsedJson).field("property1").isEqualTo("a");
+'''
+
+
+
+
+

Messaging Top-Level Elements

+
+ + + + + +
+ + +Feature available since 1.1.0 +
+
+
+

The DSL for messaging looks a little bit different than the one that focuses on HTTP.

+
+
+

Output triggered by a method

+
+

The output message can be triggered by calling a method (e.g. a Scheduler was started and a message was sent)

+
+
+
+
def dsl = GroovyDsl.make {
+        // Human readable description
+        description 'Some description'
+        // Label by means of which the output message can be triggered
+        label 'some_label'
+        // input to the contract
+        input {
+                // the contract will be triggered by a method
+                triggeredBy('bookReturnedTriggered()')
+        }
+        // output message of the contract
+        outputMessage {
+                // destination to which the output message will be sent
+                sentTo('output')
+                // the body of the output message
+                body('''{ "bookName" : "foo" }''')
+                // the headers of the output message
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

In this case the output message will be sent to output if a method called bookReturnedTriggered will be executed. In the message publisher’s side +we will generate a test that will call that method to trigger the message. On the consumer side you can use the some_label to trigger the message.

+
+
+
+

Output triggered by a message

+
+

The output message can be triggered by receiving a message.

+
+
+
+
def dsl = GroovyDsl.make {
+        description 'Some Description'
+        label 'some_label'
+        // input is a message
+        input {
+                // the message was received from this destination
+                messageFrom('input')
+                // has the following body
+                messageBody([
+                        bookName: 'foo'
+                ])
+                // and the following headers
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('output')
+                body([
+                        bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

In this case the output message will be sent to output if a proper message will be received on the input destination. In the message publisher’s side +we will generate a test that will send the input message to the defined destination. On the consumer side you can either send a message to the input +destination or use the some_label to trigger the message.

+
+
+
+

Consumer / Producer

+
+

In HTTP you have a notion of client/stub and `server/test notation. You can use them also in messaging but we’re providing also the consumer and produer methods +as presented below (note you can use either $ or value methods to provide consumer and producer parts)

+
+
+
+
Accurest.make {
+        label 'some_label'
+        input {
+                messageFrom value(consumer('jms:output'), producer('jms:input'))
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo $(consumer('jms:input'), producer('jms:output'))
+                body([
+                                bookName: 'foo'
+                ])
+        }
+}
+
+
+
+
+
+
+
+

Accurest HTTP

+
+
+

Gradle Project

+
+

Prerequisites

+
+

In order to use Accurest with Wiremock you have to use gradle or maven plugin.

+
+
+
Add gradle plugin
+
+
+
buildscript {
+        repositories {
+                mavenCentral()
+        }
+        dependencies {
+                classpath 'io.codearte.accurest:accurest-gradle-plugin:${accurest_version}'
+        }
+}
+
+apply plugin: 'groovy'
+apply plugin: 'accurest'
+
+dependencies {
+        testCompile 'org.codehaus.groovy:groovy-all:2.4.6'
+        testCompile 'org.spockframework:spock-core:1.0-groovy-2.4'
+        testCompile 'com.jayway.restassured:spring-mock-mvc:2.9.0' // needed if you're going to use Spring MockMvc
+}
+
+
+
+
+
Add maven plugin
+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+                <goal>generateTests</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+
+
+
+

Read more: accurest-maven-plugin

+
+
+
+
Add stubs
+
+

By default Accurest is looking for stubs in src/test/resources/accurest directory.

+
+
+

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 which will be used as test class name. If there is more than one level of nested directories all except the last one will be used as package name. +So with following structure

+
+
+
+
src/test/resources/accurest/myservice/shouldCreateUser.groovy
+src/test/resources/accurest/myservice/shouldReturnUser.groovy
+
+
+
+

Accurest will create test class defaultBasePackage.MyService with two methods

+
+
+
    +
  • +

    shouldCreateUser()

    +
    • +
  • +

    shouldReturnUser()

    +
    • +
+
+
+
+
+

Run plugin

+
+

Plugin registers itself to be invoked before check task. You have nothing to do as long as you want it to be part of your build process. If you just want to generate tests please invoke generateAccurest task.

+
+
+
+

Configure plugin

+
+

To change default configuration just add accurest snippet to your Gradle config

+
+
+
+
accurest {
+        testMode = 'MockMvc'
+        baseClassForTests = 'org.mycompany.tests'
+        generatedTestSourcesDir = project.file('src/accurest')
+}
+
+
+
+
Configuration options
+
+
    +
  • +

    testMode - defines mode for acceptance tests. By default MockMvc which is based on Spring’s MockMvc. It can also be changed to JaxRsClient or to Explicit for real HTTP calls.

    +
    • +
  • +

    imports - array with imports that should be included in generated tests (for example ['org.myorg.Matchers']). By default empty array []

    +
    • +
  • +

    staticImports - array with static imports that should be included in generated tests(for example ['org.myorg.Matchers.*']). By default empty array []

    +
    • +
  • +

    basePackageForTests - specifies base package for all generated tests. By default set to io.codearte.accurest.tests

    +
    • +
  • +

    baseClassForTests - base class for generated tests. By default spock.lang.Specification if using Spock tests.

    +
    • +
  • +

    ruleClassForTests - specifies Rule which should be added to generated test classes.

    +
    • +
  • +

    ignoredFiles - Ant matcher allowing defining stub files for which processing should be skipped. By default empty array []

    +
    • +
  • +

    contractsDslDir - directory containing contracts written using the GroovyDSL. By default $rootDir/src/test/resources/accurest

    +
    • +
  • +

    generatedTestSourcesDir - test source directory where tests generated from Groovy DSL should be placed. By default $buildDir/generated-test-sources/accurest

    +
    • +
  • +

    stubsOutputDir - dir where the generated Wiremock stubs from Groovy DSL should be placed

    +
    • +
  • +

    targetFramework - the target test framework to be used; currently Spock and JUnit are supported with JUnit being the default framework

    +
    • +
+
+
+
+
Base class for tests
+
+

When using Accurest in default MockMvc you need to create a base specification for all generated acceptance tests. In this class you need to point to endpoint which should be verified.

+
+
+
+
abstract class BaseMockMvcSpec extends Specification {
+
+        def setup() {
+                RestAssuredMockMvc.standaloneSetup(new PairIdController())
+        }
+
+        void isProperCorrelationId(Integer correlationId) {
+                assert correlationId == 123456
+        }
+
+        void isEmpty(String value) {
+                assert value == null
+        }
+
+}
+
+
+
+

In case of using Explicit mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of JAXRSCLIENT mode this base class +should also contain protected WebTarget webTarget field, right now the only option to test JAX-RS API is to start a web server.

+
+
+
+
+

Invoking generated tests

+
+

To ensure that provider side is complaint with defined contracts, you need to invoke:

+
+
+
+
./gradlew generateAccurest test
+
+
+
+
+

Accurest on consumer side

+
+

In consumer service you need to configure Accurest plugin in exactly the same way as in case of provider. If you don’t want to use Stub Runner then you need to copy contracts stored in +src/test/resources/accurest and generate WireMock json stubs using:

+
+
+
+
./gradlew generateWireMockClientStubs
+
+
+
+

Note that stubsOutputDir option has to be set for stub generation to work.

+
+
+

When present, json stubs can be used in consumer automated tests.

+
+
+
+
@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(pesel: '12345678901'), amount: 123.123)
+   when:
+        LoanApplicationResult loanApplication == sut.loanApplication(application)
+   then:
+        loanApplication.loanApplicationStatus === LoanApplicationStatus.LOAN_APPLIED
+        loanApplication.rejectionReason === null
+ }
+}
+
+
+
+

Underneath LoanApplication makes a call to FraudDetection service. This request is handled by Wiremock server configured using stubs generated by Accurest.

+
+
+
+
+

Using in your Maven project

+
+

Add maven plugin

+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+                <goal>generateTests</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+
+
+
+

Read more: accurest-maven-plugin

+
+
+
+

Add stubs

+
+

By default Accurest is looking for stubs in src/test/resources/accurest directory. +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 which will be used as test class name. If there is more than one level of nested directories all except the last one will be used as package name. +So with following structure

+
+
+
+
src/test/resources/accurest/myservice/shouldCreateUser.groovy
+src/test/resources/accurest/myservice/shouldReturnUser.groovy
+
+
+
+

Accurest will create test class defaultBasePackage.MyService with two methods + - shouldCreateUser() + - shouldReturnUser()

+
+
+
+

Run plugin

+
+

Plugin goal generateTests is assigned to be invoked in phase generate-test-sources. You have nothing to do as long as you want it to be part of your build process. If you just want to generate tests please invoke generateTests goal.

+
+
+
+

Configure plugin

+
+

To change default configuration just add configuration section to plugin definition or execution definition.

+
+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+                <goal>generateTests</goal>
+            </goals>
+        </execution>
+    </executions>
+    <configuration>
+        <basePackageForTests>com.ofg.twitter.place</basePackageForTests>
+        <baseClassForTests>com.ofg.twitter.place.BaseMockMvcSpec</baseClassForTests>
+    </configuration>
+</plugin>
+
+
+
+
Important configuration options
+
+
    +
  • +

    testMode - defines mode for acceptance tests. By default MockMvc which is based on Spring’s MockMvc. It can also be changed to JaxRsClient or to Explicit for real HTTP calls.

    +
    • +
  • +

    basePackageForTests - specifies base package for all generated tests. By default set to io.codearte.accurest.tests.

    +
    • +
  • +

    ruleClassForTests - specifies Rule which should be added to generated test classes.

    +
    • +
  • +

    baseClassForTests - base class for generated tests. By default spock.lang.Specification if using Spock tests.

    +
    • +
  • +

    contractsDir - directory containing contracts written using the GroovyDSL. By default /src/test/resources/accurest.

    +
    • +
  • +

    testFramework - the target test framework to be used; currently Spock and JUnit are supported with Spock being the default framework

    +
    • +
+
+
+

For complete information take a look at Plugin Documentation

+
+
+
+
Base class for tests
+
+
+
When using Accurest in default MockMvc you need to create a base specification for all generated acceptance tests. In this class you need to point to endpoint which should be verified.
+
+
+
+
+
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())
+  }
+}
+
+
+
+

In case of using Explicit mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of JAXRSCLIENT mode this base class should also contain protected WebTarget webTarget field, right now the only option to test JAX-RS API is to start a web server.

+
+
+
+
+

Invoking generated tests

+
+

Accurest Maven Plugins generates verification code into directory /generated-test-sources/accurest and attach this directory to testCompile goal.

+
+
+

For Groovy Spock code use:

+
+
+
+
<plugin>
+        <groupId>org.codehaus.gmavenplus</groupId>
+        <artifactId>gmavenplus-plugin</artifactId>
+        <version>1.5</version>
+        <executions>
+                <execution>
+                        <goals>
+                                <goal>testCompile</goal>
+                        </goals>
+                </execution>
+        </executions>
+        <configuration>
+                <testSources>
+                        <testSource>
+                                <directory>${project.basedir}/src/test/groovy</directory>
+                                <includes>
+                                        <include>**/*.groovy</include>
+                                </includes>
+                        </testSource>
+                        <testSource>
+                                <directory>${project.build.directory}/generated-test-sources/accurest</directory>
+                                <includes>
+                                        <include>**/*.groovy</include>
+                                </includes>
+                        </testSource>
+                </testSources>
+        </configuration>
+</plugin>
+
+
+
+

To ensure that provider side is complaint with defined contracts, you need to invoke mvn generateTest test

+
+
+
+

Accurest on consumer side

+
+

In consumer service you need to configure Accurest plugin in exactly the same way as in case of provider. You need to copy contracts stored in src/test/resources/accurest and generate Wiremock json stubs using: mvn generateStubs command. By default generated WireMock mapping is stored in directory target/mappings. Your project should create from this generated mappings additional artifact with classifier stubs for easy deploy to maven repository.

+
+
+

Sample configuration:

+
+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <version>${accurest-plugin.version}</version>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+
+
+
+

When present, json stubs can be used in consumer automated tests.

+
+
+
+
@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(pesel: '12345678901'), amount: 123.123)
+   when:
+        LoanApplicationResult loanApplication == sut.loanApplication(application)
+   then:
+        loanApplication.loanApplicationStatus === LoanApplicationStatus.LOAN_APPLIED
+        loanApplication.rejectionReason === null
+ }
+}
+
+
+
+

Underneath LoanApplication makes a call to FraudDetection service. This request is handled by Wiremock server configured using stubs generated by Accurest.

+
+
+
+
+

Scenarios

+
+

It’s possible to handle scenarios with Accurest. All you need to do is to stick to proper naming convention while creating your contracts. The convention requires to include order number followed by the underscore.

+
+
+
+
my_contracts_dir\
+  scenario1\
+    1_login.groovy
+    2_showCart.groovy
+    3_logout.groovy
+
+
+
+

Such tree will cause Accurest generating Wiremock’s scenario with name scenario1 and three 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 under [http://wiremock.org/stateful-behaviour.html](http://wiremock.org/stateful-behaviour.html)

+
+
+

Accurest will also generate tests with guaranteed order of execution.

+
+
+
+
+
+

Accurest Messaging

+
+
+ + + + + +
+ + +Feature available since 1.1.0 +
+
+
+

Accurest allows you to verify your application that uses messaging as means of communication. +All of our integrations are working with Spring but you can also set one yourself.

+
+
+

Integrations

+
+

You can use one of the three integration configurations:

+
+
+
    +
  • +

    Apache Camel

    +
    • +
  • +

    Spring Integration

    +
    • +
  • +

    Spring Cloud Stream

    +
    • +
+
+
+

If you’re using Spring Boot, the aforementioned test configurations will be appended automatically.

+
+
+

You have to provide as a dependency one of the Accurest Messaging modules. Example for Gradle:

+
+
+
+
// for Apache Camel
+testCompile "io.codearte.accurest:accurest-messaging-camel:${accurestVersion}"
+// for Spring Integration
+testCompile "io.codearte.accurest:accurest-messaging-integration:${accurestVersion}"
+// for Spring Cloud Stream
+testCompile "io.codearte.accurest:accurest-messaging-stream:${accurestVersion}"
+
+
+
+
+

Manual Integration

+
+

The accurest-messaging-core module contains 3 main interfaces:

+
+
+
    +
  • +

    AccurestMessage - describes a message received / sent to a channel / queue / topic etc.

    +
    • +
  • +

    AccurestMessageBuilder - describes how to build a message

    +
    • +
  • +

    AccurestMessaging - class that allows you to build, send and receive messages

    +
    • +
  • +

    AccurestFilter - interface to filter out the messages that do not follow the pattern from the DSL

    +
    • +
+
+
+

In the generated test the AccurestMessaging is injected via @Inject annotation thus you can use other injection +frameworks than Spring.

+
+
+

You have to provide as a dependency the accurest-messaging-core module. Example for Gradle:

+
+
+
+
testCompile "io.codearte.accurest:accurest-messaging-core:${accurestVersion}"
+
+
+
+
+

Publisher side test generation

+
+

Having the input or outputMessage sections in your DSL will result in creation of tests on the publisher’s side. By default +JUnit tests will be created, however there is also a possibility to create Spock tests.

+
+
+

There are 3 main scenarios that we should take into consideration:

+
+
+
    +
  • +

    Scenario 1: there is no input message that produces an output one. The output message is triggered by a component +inside the application (e.g. scheduler)

    +
    • +
  • +

    Scenario 2: the input message triggers an output message

    +
    • +
  • +

    Scenario 3: the input message is consumed and there is no output message

    +
    • +
+
+
+

Scenario 1 (no input message)

+
+

For the given contract:

+
+
+
+
def contractDsl = GroovyDsl.make {
+        label 'some_label'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('activemq:output')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

The following JUnit test will be created:

+
+
+
+
'''
+ // when:
+  bookReturnedTriggered();
+
+ // then:
+  AccurestMessage response = accurestMessaging.receiveMessage("activemq:output");
+  assertThat(response).isNotNull();
+  assertThat(response.getHeader("BOOK-NAME")).isEqualTo("foo");
+ // and:
+  DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.getPayload()));
+  assertThatJson(parsedJson).field("bookName").isEqualTo("foo");
+'''
+
+
+
+

And the following Spock test would be created:

+
+
+
+
'''
+ when:
+  bookReturnedTriggered()
+
+ then:
+  def response = accurestMessaging.receiveMessage('activemq:output')
+  assert response != null
+  response.getHeader('BOOK-NAME')  == 'foo'
+ and:
+  DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.payload))
+  assertThatJson(parsedJson).field("bookName").isEqualTo("foo")
+
+'''
+
+
+
+
+

Scenario 2 (output triggered by input)

+
+

For the given contract:

+
+
+
+
def contractDsl = GroovyDsl.make {
+        label 'some_label'
+        input {
+                messageFrom('jms:input')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('jms:output')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

The following JUnit test will be created:

+
+
+
+
'''
+// given:
+ AccurestMessage inputMessage = accurestMessaging.create(
+  "{\\"bookName\\":\\"foo\\"}"
+, headers()
+  .header("sample", "header"));
+
+// when:
+ accurestMessaging.send(inputMessage, "jms:input");
+
+// then:
+ AccurestMessage response = accurestMessaging.receiveMessage("jms:output");
+ assertThat(response).isNotNull();
+ assertThat(response.getHeader("BOOK-NAME")).isEqualTo("foo");
+// and:
+ DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.getPayload()));
+ assertThatJson(parsedJson).field("bookName").isEqualTo("foo");
+'''
+
+
+
+

And the following Spock test would be created:

+
+
+
+
"""\
+given:
+   def inputMessage = accurestMessaging.create(
+    '''{"bookName":"foo"}''',
+    ['sample': 'header']
+  )
+
+when:
+   accurestMessaging.send(inputMessage, 'jms:input')
+
+then:
+   def response = accurestMessaging.receiveMessage('jms:output')
+   assert response !- null
+   response.getHeader('BOOK-NAME')  == 'foo'
+and:
+   DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.payload))
+   assertThatJson(parsedJson).field("bookName").isEqualTo("foo")
+"""
+
+
+
+
+

Scenario 3 (no output message)

+
+

For the given contract:

+
+
+
+
def contractDsl = GroovyDsl.make {
+        label 'some_label'
+        input {
+                messageFrom('jms:delete')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+                assertThat('bookWasDeleted()')
+        }
+}
+
+
+
+

The following JUnit test will be created:

+
+
+
+
'''
+// given:
+ AccurestMessage inputMessage = accurestMessaging.create(
+        "{\\"bookName\\":\\"foo\\"}"
+, headers()
+        .header("sample", "header"));
+
+// when:
+ accurestMessaging.send(inputMessage, "jms:delete");
+
+// then:
+ bookWasDeleted();
+'''
+
+
+
+

And the following Spock test would be created:

+
+
+
+
'''
+given:
+         def inputMessage = accurestMessaging.create(
+                \'\'\'{"bookName":"foo"}\'\'\',
+                ['sample': 'header']
+        )
+
+when:
+         accurestMessaging.send(inputMessage, 'jms:delete')
+
+then:
+         noExceptionThrown()
+         bookWasDeleted()
+'''
+
+
+
+
+
+

Consumer Stub Side generation

+
+

Unlike the HTTP part - in Messaging we need to publish the Groovy DSL inside the JAR with a stub. Then it’s parsed on the consumer side +and proper stubbed routes are created.

+
+
+

For more infromation please consult the Stub Runner Messaging sections.

+
+
+

Gradle Setup

+
+

Example of Accurest Gradle setup:

+
+
+
+
ext {
+        contractsDir = file("mappings")
+        stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/")
+        wireMockStubsOutputDir = file(new File(stubsOutputDirRoot, 'repository/mappings/'))
+        contractsOutputDir = file(new File(stubsOutputDirRoot, 'repository/accurest/'))
+}
+
+task copyContracts(type: Copy) {
+        from contractsDir
+        include '**/*.groovy'
+        into contractsOutputDir
+}
+
+task stubsJar(type: Jar, dependsOn: ["generateWireMockClientStubs", copyContracts]) {
+        baseName = "${project.name}"
+        classifier = "stubs"
+        from stubsOutputDirRoot
+}
+
+artifacts {
+        archives stubsJar
+}
+
+publishing {
+        publications {
+                stubs(MavenPublication) {
+                        artifactId "${project.name}-stubs"
+                        artifact stubsJar
+                }
+        }
+}
+
+
+
+
+

Maven Setup

+
+

Example of Maven can be found in the Accurest Maven Plugin README

+
+
+
+
+
+
+

Stub Runner

+
+
+

One of the issues that you could have encountered while using Accurest was to pass the generated WireMock JSON stubs from the server side to the client side (or various clients). + The same takes place in terms of client side generation for messaging.

+
+
+

Copying the JSON files / setting the client side for messaging manually is out of the question.

+
+
+

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.

+
+
+

Gradle

+
+

Example of Accurest Gradle setup:

+
+
+
+
ext {
+        contractsDir = file("mappings")
+        stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/")
+        wireMockStubsOutputDir = file(new File(stubsOutputDirRoot, 'repository/mappings/'))
+        contractsOutputDir = file(new File(stubsOutputDirRoot, 'repository/accurest/'))
+}
+
+task copyContracts(type: Copy) {
+        from contractsDir
+        include '**/*.groovy'
+        into contractsOutputDir
+}
+
+task stubsJar(type: Jar, dependsOn: ["generateWireMockClientStubs", copyContracts]) {
+        baseName = "${project.name}"
+        classifier = "stubs"
+        from stubsOutputDirRoot
+}
+
+artifacts {
+        archives stubsJar
+}
+
+publishing {
+        publications {
+                stubs(MavenPublication) {
+                        artifactId "${project.name}-stubs"
+                        artifact stubsJar
+                }
+        }
+}
+
+
+
+
+

Maven

+
+

Example of Maven can be found in the Accurest Maven Plugin README

+
+
+
+
+

Modules

+
+

Accurest comes with a new structure of modules

+
+
+
+
└── stub-runner
+    ├── stub-runner
+    ├── stub-runner-boot
+    ├── stub-runner-junit
+    ├── stub-runner-spring
+    └── stub-runner-spring-cloud
+
+
+
+
+

Stub Runner Core

+
+

Runs stubs for service collaborators. Treating stubs as contracts of services allows to use stub-runner as an implementation of +Consumer Driven Contracts.

+
+
+

Stub Runner allows you to automatically download the stubs of the provided dependencies, start WireMock servers for them and feed them with proper stub definitions. +For messaging, special stub routes are defined.

+
+
+

Running stubs

+
+
Running using main app
+
+

You can set the following options to the main class:

+
+
+
+
-maxp (--maxPort) N            : Maximum port value to be assigned to the
+                                 Wiremock instance. Defaults to 15000
+                                 (default: 15000)
+-minp (--minPort) N            : Minimal port value to be assigned to the
+                                 Wiremock instance. Defaults to 10000
+                                 (default: 10000)
+-s (--stubs) VAL               : Comma separated list of Ivy representation of
+                                 jars with stubs. Eg. groupid:artifactid1,group
+                                 id2:artifactid2:version:classifier
+-sr (--stubRepositoryRoot) VAL : Location of a Jar containing server where you
+                                 keep your stubs (e.g. http://nexus.net/content
+                                 /repositories/repository)
+-ss (--stubsSuffix) VAL        : 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)
+-wo (--workOffline)            : Switch to work offline. Defaults to 'false'
+                                 (default: false)
+
+
+
+
+
Building a Fat Jar
+
+

Just call the following command:

+
+
+
+
./gradlew stub-runner-root:stub-runner:shadowJar -PfatJar
+
+
+
+

and inside the build/lib there will be a Fat Jar with classifier fatJar waiting for you to execute. E.g.

+
+
+
+
java -jar stub-runner/stub-runner/build/libs/stub-runner-1.0.1-SNAPSHOT-fatJar.jar -sr http://a.b.com -s a:b:c,d:e,f:g:h:i
+
+
+
+
+
+

Stub runner configuration

+
+

You can configure the stub runner by either passing the full arguments list with the -Pargs like this:

+
+
+
+
./gradlew stub-runner-root:stub-runner:run -Pargs="-c pl -minp 10000 -maxp 10005 -s a:b:c,d:e,f:g:h"
+
+
+
+

or each parameter separately with a -P prefix and without the hyphen - in the name of the param

+
+
+
+
./gradlew stub-runner-root:stub-runner:run -Pc=pl -Pminp=10000 -Pmaxp=10005 -Ps=a:b:c,d:e,f:g:h
+
+
+
+
HTTP Stubs
+
+

Stubs are defined in JSON documents, whose syntax is defined in WireMock documentation

+
+
+

Example:

+
+
+
+
{
+    "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.

+
+
+
+
Messaging Stubs
+
+

Depending on the provided Stub Runner dependency and the DSL the messaging routes are automatically set up.

+
+
+
+
+
+

Stub Runner Boot

+
+ + + + + +
+ + +Feature available since 1.1.0 +
+
+
+

Accurest 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 usecases is to run some smoke (end to end) tests on a deployed application. You can read + more about this in the "Microservice Deployment" article at Too Much Coding blog.

+
+
+

How to use it?

+
+

Just add the

+
+
+
+
compile "io.codearte.accurest:stub-runner-boot:${accurestVersion}"
+
+
+
+

and a messaging implementation:

+
+
+
+
// for Apache Camel
+compile "io.codearte.accurest:stub-runner-messaging-camel:${accurestVersion}"
+// for Spring Integration
+compile "io.codearte.accurest:stub-runner-messaging-integration:${accurestVersion}"
+// for Spring Cloud Stream
+compile "io.codearte.accurest:stub-runner-messaging-stream:${accurestVersion}"
+
+
+
+

Build a fat-jar and you’re ready to go!

+
+
+

For the properties check the Stub Runner Spring section.

+
+
+
+

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

+
+
+
@ContextConfiguration(classes = [StubRunnerBootSpec, StubRunnerBoot], loader = SpringApplicationContextLoader)
+@EnableBinding
+@Configuration
+class StubRunnerBootSpec extends Specification {
+
+        @Autowired StubRunning stubRunning
+
+        def setup() {
+                RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning),
+                                new TriggerController(stubRunning))
+        }
+
+        def 'should return a list of running stub servers in "full ivy:port" notation'() {
+                when:
+                        String response = RestAssuredMockMvc.get('/stubs').body.asString()
+                then:
+                        def root = new JsonSlurper().parseText(response)
+                        root.'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs' instanceof Integer
+        }
+
+        def 'should return a port on which a [#stubId] stub is running'() {
+                when:
+                        def response = RestAssuredMockMvc.get("/stubs/${stubId}")
+                then:
+                        response.statusCode == 200
+                        response.body.as(Integer) > 0
+                where:
+                        stubId << ['io.codearte.accurest.stubs:streamService:+:stubs',
+                                           'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs',
+                                           'io.codearte.accurest.stubs:streamService:+',
+                                           'io.codearte.accurest.stubs:streamService',
+                                           'streamService']
+        }
+
+        def 'should return 404 when missing stub was called'() {
+                when:
+                        def response = RestAssuredMockMvc.get("/stubs/a:b:c:d")
+                then:
+                        response.statusCode == 404
+        }
+
+        def 'should return a list of messaging labels that can be triggered when version and classifier are passed'() {
+                when:
+                        String response = RestAssuredMockMvc.get('/triggers').body.asString()
+                then:
+                        def root = new JsonSlurper().parseText(response)
+                        root.'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs'?.containsAll(["delete_book","return_book_1","return_book_2"])
+        }
+
+        def 'should trigger a messaging label'() {
+                given:
+                        StubRunning stubRunning = Mock()
+                        RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), new TriggerController(stubRunning))
+                when:
+                        def response = RestAssuredMockMvc.post("/triggers/delete_book")
+                then:
+                        response.statusCode == 200
+                and:
+                        1 * stubRunning.trigger('delete_book')
+        }
+
+        def 'should trigger a messaging label for a stub with [#stubId] ivy notation'() {
+                given:
+                        StubRunning stubRunning = Mock()
+                        RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), new TriggerController(stubRunning))
+                when:
+                        def response = RestAssuredMockMvc.post("/triggers/$stubId/delete_book")
+                then:
+                        response.statusCode == 200
+                and:
+                        1 * stubRunning.trigger(stubId, 'delete_book')
+                where:
+                        stubId << ['io.codearte.accurest.stubs:streamService:stubs', 'io.codearte.accurest.stubs:streamService', 'streamService']
+        }
+
+        def 'should return when trigger is missing'() {
+                when:
+                        def response = RestAssuredMockMvc.post("/triggers/missing_label")
+                then:
+                        response.statusCode == 404
+                        def root = new JsonSlurper().parseText(response.body.asString())
+                        root.'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs'?.containsAll(["delete_book","return_book_1","return_book_2"])
+        }
+
+}
+
+
+
+
+
+

Stub Runner JUnit Rule

+
+

Stub Runner comes with a JUnit rule thanks to which you can very easily download and run stubs for given group and artifact id:

+
+
+
+
@ClassRule public static AccurestRule rule = new AccurestRule()
+                .repoRoot(repoRoot())
+                .downloadStub("io.codearte.accurest.stubs", "loanIssuance")
+                .downloadStub("io.codearte.accurest.stubs:fraudDetectionServer");
+
+
+
+

After that rule gets 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

    +
    • +
+
+
+

Stub Runner uses Eclipse Aether mechanism to download the Maven dependencies. +Check their docs for more information.

+
+
+

Since the AccurestRule implements the StubFinder it allows you to find the started stubs:

+
+
+
+
package io.codearte.accurest.stubrunner
+
+import io.codearte.accurest.dsl.GroovyDsl
+
+interface StubFinder extends StubTrigger {
+        /**
+         * For the given groupId and artifactId tries to find the matching
+         * URL of the running stub.
+         *
+         * @param groupId - might be null. In that case a search only via artifactId takes place
+         * @return URL of a running stub or null if not found
+         */
+        URL findStubUrl(String groupId, String artifactId)
+
+        /**
+         * For the given Ivy notation {@code groupId:artifactId} tries to find the matching
+         * URL of the running stub. You can also pass only {@code artifactId}.
+         *
+         * @param ivyNotation - Ivy representation of the Maven artifact
+         * @return URL of a running stub or null if not found
+         */
+        URL findStubUrl(String ivyNotation)
+
+        /**
+         * Returns all running stubs
+         */
+        RunningStubs findAllRunningStubs()
+
+        /**
+         * Returns the list of Accurest contracts
+         */
+        Map<StubConfiguration, Collection<GroovyDsl>> getAccurestContracts()
+}
+
+
+
+

Example of usage in Spock tests:

+
+
+
+
@ClassRule @Shared AccurestRule rule = new AccurestRule()
+                .repoRoot(AccurestRuleSpec.getResource("/m2repo").toURI().toString())
+                .downloadStub("io.codearte.accurest.stubs", "loanIssuance")
+                .downloadStub("io.codearte.accurest.stubs:fraudDetectionServer")
+
+def 'should start WireMock servers'() {
+        expect: 'WireMocks are running'
+                rule.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance') != null
+                rule.findStubUrl('loanIssuance') != null
+                rule.findStubUrl('loanIssuance') == rule.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance')
+                rule.findStubUrl('io.codearte.accurest.stubs:fraudDetectionServer') != null
+        and:
+                rule.findAllRunningStubs().isPresent('loanIssuance')
+                rule.findAllRunningStubs().isPresent('io.codearte.accurest.stubs', 'fraudDetectionServer')
+                rule.findAllRunningStubs().isPresent('io.codearte.accurest.stubs:fraudDetectionServer')
+        and: 'Stubs were registered'
+                "${rule.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance'
+                "${rule.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer'
+}
+
+
+
+

Example of usage in JUnit tests:

+
+
+
+
@Test
+public void should_start_wiremock_servers() throws Exception {
+        // expect: 'WireMocks are running'
+                then(rule.findStubUrl("io.codearte.accurest.stubs", "loanIssuance")).isNotNull();
+                then(rule.findStubUrl("loanIssuance")).isNotNull();
+                then(rule.findStubUrl("loanIssuance")).isEqualTo(rule.findStubUrl("io.codearte.accurest.stubs", "loanIssuance"));
+                then(rule.findStubUrl("io.codearte.accurest.stubs:fraudDetectionServer")).isNotNull();
+        // and:
+                then(rule.findAllRunningStubs().isPresent("loanIssuance")).isTrue();
+                then(rule.findAllRunningStubs().isPresent("io.codearte.accurest.stubs", "fraudDetectionServer")).isTrue();
+                then(rule.findAllRunningStubs().isPresent("io.codearte.accurest.stubs:fraudDetectionServer")).isTrue();
+        // and: 'Stubs were registered'
+                then(httpGet(rule.findStubUrl("loanIssuance").toString() + "/name")).isEqualTo("loanIssuance");
+                then(httpGet(rule.findStubUrl("fraudDetectionServer").toString() + "/name")).isEqualTo("fraudDetectionServer");
+}
+
+
+
+

Check the Common properties for JUnit and Spring for more information on how to apply global configuration of Stub Runner.

+
+
+

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 AccurestRule you can add a stub to download and then pass the port for the last downloaded stub.

+
+
+
+
@ClassRule public static AccurestRule rule = new AccurestRule()
+                .repoRoot(repoRoot())
+                .downloadStub("io.codearte.accurest.stubs", "loanIssuance")
+                .withPort(12345)
+                .downloadStub("io.codearte.accurest.stubs:fraudDetectionServer:12346");
+
+
+
+

You can see that for this example the following test is valid:

+
+
+
+
then(rule.findStubUrl("loanIssuance")).isEqualTo(URI.create("http://localhost:12345").toURL());
+then(rule.findStubUrl("fraudDetectionServer")).isEqualTo(URI.create("http://localhost:12346").toURL());
+
+
+
+
+
+

Stub Runner 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:

+
+
+
+
@ContextConfiguration(classes = Config, loader = SpringApplicationContextLoader)
+class StubRunnerConfigurationSpec extends Specification {
+
+        @Autowired StubFinder stubFinder
+
+        def 'should start WireMock servers'() {
+                expect: 'WireMocks are running'
+                        stubFinder.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance') != null
+                        stubFinder.findStubUrl('loanIssuance') != null
+                        stubFinder.findStubUrl('loanIssuance') == stubFinder.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance')
+                        stubFinder.findStubUrl('io.codearte.accurest.stubs:fraudDetectionServer') != null
+                and:
+                        stubFinder.findAllRunningStubs().isPresent('loanIssuance')
+                        stubFinder.findAllRunningStubs().isPresent('io.codearte.accurest.stubs', 'fraudDetectionServer')
+                        stubFinder.findAllRunningStubs().isPresent('io.codearte.accurest.stubs:fraudDetectionServer')
+                and: 'Stubs were registered'
+                        "${stubFinder.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance'
+                        "${stubFinder.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer'
+        }
+
+        @Configuration
+        @Import(StubRunnerConfiguration)
+        @EnableAutoConfiguration
+        static class Config {}
+}
+
+
+
+

for the following configuration file:

+
+
+
+
stubrunner.stubs.repository.root: classpath:m2repo/repository/
+stubrunner.stubs.ids: io.codearte.accurest.stubs:loanIssuance,io.codearte.accurest.stubs:fraudDetectionServer
+
+
+
+
+

Stub Runner Spring Cloud

+
+

Registers the stubs in the provided Service Discovery. It’s enough to add the jar

+
+
+
+
io.codearte.accurest:stub-runner-spring-cloud
+
+
+
+

and the Stub Runner autoconfiguration should be picked up.

+
+
+

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 regardles 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.

+
+
+
+

Additional Configuration

+
+

You can match the artifactId of the stub with the name of your app by using the stubrunner.stubs.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

+
+
+
+
+

Common properties for JUnit and Spring

+
+

Some of the properties that are repetitive can be set using system properties or property sources (for Spring). Here are their names with their default values:

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property nameDefault valueDescription

stubrunner.port.range.min

10000

Minimal value of a port for a started WireMock with stubs

stubrunner.port.range.max

15000

Minimal value of a port for a started WireMock with stubs

stubrunner.stubs.repository.root

Comma separated list of Maven repo urls. If blank then will call the local maven repo

stubrunner.stubs.classifier

stubs

Default classifier for the stub artifacts

stubrunner.work-offline

false

If true then will not contact any remote repositories to download stubs

stubrunner.stubs.ids

Comma separated list of Ivy notation of stubs to download

+
+

Stub runner stubs ids

+
+

You can provide the stubs to download via the stubrunner.stubs.ids system property. They follow the following pattern:

+
+
+
+
groupId:artifactId:version:classifier:port
+
+
+
+

version, classifier and port are optional.

+
+
+
    +
  • +

    If you don’t provide the port then a random one will be picked

    +
    • +
  • +

    If you don’t provide the classifier then the default one will be taken.

    +
    • +
  • +

    If you don’t provide the version then the + will be passed and the latest one will be downloaded

    +
    • +
+
+
+

Where port means the port of the WireMock server.

+
+
+
+
+
+
+

Stub Runner for Messaging

+
+
+ + + + + +
+ + +Feature available since 1.1.0 +
+
+
+

Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box

+
+
+
    +
  • +

    Spring Integration

    +
    • +
  • +

    Spring Cloud Stream

    +
    • +
  • +

    Apache Camel

    +
    • +
+
+
+

It also provides points of entry to integrate with any other solution on the market.

+
+
+

Stub triggering

+
+

To trigger a message it’s enough to use the StubTigger interface:

+
+
+
+
package io.codearte.accurest.stubrunner
+
+interface StubTrigger {
+
+        /**
+         * Triggers an event by a given label for a given {@code groupid:artifactid} notation. You can use only {@code artifactId} too.
+         *
+         * Feature related to messaging.
+         *
+         * @return true - if managed to run a trigger
+         */
+        boolean trigger(String ivyNotation, String labelName)
+
+        /**
+         * Triggers an event by a given label.
+         *
+         * Feature related to messaging.
+         *
+         * @return true - if managed to run a trigger
+         */
+        boolean trigger(String labelName)
+
+        /**
+         * Triggers all possible events.
+         *
+         * Feature related to messaging.
+         *
+         * @return true - if managed to run a trigger
+         */
+        boolean trigger()
+
+        /**
+         * Returns a mapping of ivy notation of a dependency to all the labels it has.
+         *
+         * Feature related to messaging.
+         */
+        Map<String, Collection<String>> labels()
+}
+
+
+
+

For convenience the StubFinder interface extends StubTrigger so it’s enough to use only one in your tests.

+
+
+

StubTrigger gives you the following options to trigger a message:

+
+
+

Trigger by label

+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+
Trigger by group and artifact ids
+
+
+
stubFinder.trigger('io.codearte.accurest.stubs:camelService', 'return_book_1')
+
+
+
+
+
Trigger by artifact ids
+
+
+
stubFinder.trigger('camelService', 'return_book_1')
+
+
+
+
+
Trigger all messages
+
+
+
stubFinder.trigger()
+
+
+
+
+
+
+

Stub Runner Messaging Camel

+
+

Accurest 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

+
+

To use it you have to add the following dependency to your project (example for Gradle):

+
+
+
+
testCompile "io.codearte.accurest:stub-runner-messaging-camel:${accurestVersion}"
+
+
+
+
+

Examples

+
+
Stubs structure
+
+

Let us assume that we have the following Maven repository with a deployed stubs for the +camelService application.

+
+
+
+
└── .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:

+
+
+
+
├── META-INF
+│   └── MANIFEST.MF
+└── repository
+    ├── accurest
+    │   ├── bookDeleted.groovy
+    │   ├── bookReturned1.groovy
+    │   └── bookReturned2.groovy
+    └── mappings
+
+
+
+

Let’s consider the following contracts (let' number it with 1):

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_1'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('jms:output')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and number 2

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_2'
+        input {
+                messageFrom('jms:input')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('jms:output')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+
+
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

+
+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+

Next we’ll want to listen to the output of the message sent to jms:output

+
+
+
+
Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000)
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertThatBodyContainsBookNameFoo(receivedMessage.in.body)
+receivedMessage.in.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 2 (output triggered by input)
+
+

Since the route is set for you it’s enough to just send a message to the jms:output destination.

+
+
+
+
camelContext.createProducerTemplate().sendBodyAndHeaders('jms:input', new BookReturned('foo'), [sample: 'header'])
+
+
+
+

Next we’ll want to listen to the output of the message sent to jms:output

+
+
+
+
Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000)
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertThatBodyContainsBookNameFoo(receivedMessage.in.body)
+receivedMessage.in.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 3 (input with no output)
+
+

Since the route is set for you it’s enough to just send a message to the jms:output destination.

+
+
+
+
camelContext.createProducerTemplate().sendBodyAndHeaders('jms:delete', new BookReturned('foo'), [sample: 'header'])
+
+
+
+
+
+
+

Stub Runner Messaging Integration

+
+

Accurest Stub Runner’s messaging module gives you an easy way to integrate with Spring Integration. +For the provided artifacts it will automatically download the stubs and register the required +routes.

+
+
+

Adding it to the project

+
+

To use it you have to add the following dependency to your project (example for Gradle):

+
+
+
+
testCompile "io.codearte.accurest:stub-runner-messaging-integration:${accurestVersion}"
+
+
+
+
+

Examples

+
+
Stubs structure
+
+

Let us assume that we have the following Maven repository with a deployed stubs for the +integrationService application.

+
+
+
+
└── .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
+
+
+
+

And the stubs contain the following structure:

+
+
+
+
├── META-INF
+│   └── MANIFEST.MF
+└── repository
+    ├── accurest
+    │   ├── bookDeleted.groovy
+    │   ├── bookReturned1.groovy
+    │   └── bookReturned2.groovy
+    └── mappings
+
+
+
+

Let’s consider the following contracts (let' number it with 1):

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_1'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('output')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and number 2

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_2'
+        input {
+                messageFrom('input')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('output')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and the following Spring Integration Route:

+
+
+
+
<?xml version="1.0" encoding="UTF-8"?>
+<beans:beans xmlns="http://www.springframework.org/schema/integration"
+                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                         xmlns:beans="http://www.springframework.org/schema/beans"
+                         xsi:schemaLocation="http://www.springframework.org/schema/beans
+                        http://www.springframework.org/schema/beans/spring-beans.xsd
+                        http://www.springframework.org/schema/integration
+                        http://www.springframework.org/schema/integration/spring-integration.xsd">
+
+
+        <!-- REQUIRED FOR TESTING -->
+        <bridge input-channel="output"
+                        output-channel="outputTest"/>
+
+        <channel id="outputTest">
+                <queue/>
+        </channel>
+
+</beans:beans>
+
+
+
+
+
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

+
+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+

Next we’ll want to listen to the output of the message sent to output

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('outputTest')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 2 (output triggered by input)
+
+

Since the route is set for you it’s enough to just send a message to the output destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'input')
+
+
+
+

Next we’ll want to listen to the output of the message sent to output

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('outputTest')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 3 (input with no output)
+
+

Since the route is set for you it’s enough to just send a message to the input destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'delete')
+
+
+
+
+
+
+

Stub Runner Messaging Stream

+
+

Accurest Stub Runner’s messaging module gives you an easy way to integrate with Spring Stream. +For the provided artifacts it will automatically download the stubs and register the required +routes.

+
+
+ + + + + +
+ + +In Stub Runner’s integration with Stream the messageFrom or sentTo Strings are resolved +first as a destination of a channel, and then if there is no such destination it’s resolved as a +channel name. +
+
+
+

Adding it to the project

+
+

To use it you have to add the following dependency to your project (example for Gradle):

+
+
+
+
testCompile "io.codearte.accurest:stub-runner-messaging-stream:${accurestVersion}"
+
+
+
+
+

Examples

+
+
Stubs structure
+
+

Let us assume that we have the following Maven repository with a deployed stubs for the +streamService application.

+
+
+
+
└── .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
+
+
+
+

And the stubs contain the following structure:

+
+
+
+
├── META-INF
+│   └── MANIFEST.MF
+└── repository
+    ├── accurest
+    │   ├── bookDeleted.groovy
+    │   ├── bookReturned1.groovy
+    │   └── bookReturned2.groovy
+    └── mappings
+
+
+
+

Let’s consider the following contracts (let' number it with 1):

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_1'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('returnBook')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and number 2

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_2'
+        input {
+                messageFrom('bookStorage')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('returnBook')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and the following Spring configuration:

+
+
+
+
stubrunner.stubs.repository.root: classpath:m2repo/repository/
+stubrunner.stubs.ids: io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs
+
+spring:
+  cloud:
+    stream:
+      bindings:
+        output:
+          destination: returnBook
+        input:
+          destination: bookStorage
+
+
+
+
+
Scenario 1 (no input message)
+
+

So as to trigger a message via the return_book_1 label we’ll use the StubTrigger interface as follows

+
+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+

Next we’ll want to listen to the output of the message sent to a channel whose destination is returnBook

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('returnBook')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 2 (output triggered by input)
+
+

Since the route is set for you it’s enough to just send a message to the bookStorage destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'bookStorage')
+
+
+
+

Next we’ll want to listen to the output of the message sent to returnBook

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('returnBook')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 3 (input with no output)
+
+

Since the route is set for you it’s enough to just send a message to the output destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'delete')
+
+
+
+
+
+
+
+
+

Migration Guide

+
+
+

Migration to 0.4.7

+
+
    +
  • +

    in 0.4.7 we’ve fixed package name (coderate to codearte) so you’ve to do the same in your projects. This means replacing io.coderate.accurest.dsl.GroovyDsl with io.codearte.accurest.dsl.GroovyDsl

    +
    • +
+
+
+
+

Migration to 1.0.0-RC1

+
+
    +
  • +

    from 1.0.0 we’re distinguish ignored contracts from excluded contracts:

    +
    • +
  • +

    excludedFiles pattern tells Accurest to skip processing those files at all

    +
    • +
  • +

    ignoredFiles pattern tells Accurest to generate contracts and tests, but tests will be marked as @Ignore

    +
    • +
  • +

    from 1.0.0 the basePackageForTests behaviour has changed

    +
    • +
  • +

    prior to the change all DSL files had to be under contractsDslDir/basePackageForTests/subpackage resulting in basePackageForTests.subpackage test package creation

    +
    • +
  • +

    now all DSL files have to be under contractsDslDir/subpackage resulting in basePackageForTests.subpackage test package creation

    +
    • +
  • +

    If you don’t migrate to the new approach you will have your tests under contractsDslDir.contractsDslDir.subpackage

    +
    • +
+
+
+
+

Migration to 1.1.0

+
+
    +
  • +

    from 1.1.0 we’re setting JUnit as a default testing utility. You have to pass the following option to keep Spock +as your first choice:

    +
    • +
+
+
+
+
targetFramework = 'Spock'
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/introduction.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/introduction.html new file mode 100644 index 0000000000..5f173f30de --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/introduction.html @@ -0,0 +1,797 @@ + + + + + + + +Introduction + + + + + + + +
+
+

Introduction

+
+
+

Just to make long story short - Accurest is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications. It is shipped +with Contract Definition Language (DSL). Contract definitions are used by Accurest to produce following resources:

+
+
+
    +
  • +

    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, test data is produced by Accurest.

    +
    • +
  • +

    Messaging routes if you’re using one. We’re integrating with Spring Integration, Spring Cloud Stream and Apache Camel. You can however set your own integrations if you want to

    +
    • +
  • +

    Acceptance tests (in JUnit or Spock) used to verify if server-side implementation of the API is compliant with the contract (server tests). Full test is generated by Accurest.

    +
    • +
+
+
+

Accurest moves TDD to the level of software architecture.

+
+
+

Why?

+
+

Let us assume that we have a system comprising of multiple microservices:

+
+
+
+Microservices Architecture +
+
+
+

Testing issues

+
+

If we wanted to test the application in top left corner if it can communicate with other services then we could do one of two things:

+
+
+
    +
  • +

    deploy all microservices and perform end to end tests

    +
    • +
  • +

    mock other microservices in unit / integration tests

    +
    • +
+
+
+

Both have their advantages but also a lot of disadvantages. Let’s focus on the latter.

+
+
+

Deploy all microservices and perform end to end tests

+
+
+

Advantages:

+
+
+
    +
  • +

    simulates production

    +
    • +
  • +

    tests real communication between services

    +
    • +
+
+
+

Disadvantages:

+
+
+
    +
  • +

    to test one microservice we would have to deploy 6 microservices, a couple of databases etc.

    +
    • +
  • +

    the environment where the tests would be conducted would be locked for a single suite of tests (i.e. nobody else would be able to run the tests in the meantime).

    +
    • +
  • +

    long to run

    +
    • +
  • +

    very late feedback

    +
    • +
  • +

    extremely hard to debug

    +
    • +
+
+
+

Mock other microservices in unit / integration tests

+
+
+

Advantages:

+
+
+
    +
  • +

    very fast feedback

    +
    • +
  • +

    no infrastructure requirements

    +
    • +
+
+
+

Disadvantages:

+
+
+
    +
  • +

    the implementor of the service creates stubs thus they might have nothing to do with the reality

    +
    • +
  • +

    you can go to production with passing tests and failing production

    +
    • +
+
+
+

To solve the aforementioned issues Accurest with Stub Runner were created. Their main idea is to give you very fast feedback, without the need +to set up the whole world of microservices.

+
+
+
+Stubbed Services +
+
+
+

If you work on stubs then the only applications you need are those that your application is using directly.

+
+
+
+Stubbed Services +
+
+
+

Accurest gives you the certainty that the stubs that you’re using were created by the service that you’re calling. Also if you can use them it means that they were +tested against the producer’s side. In other words - you can trust those stubs.

+
+
+
+
+

Purposes

+
+

The main purposes of Accurest with Stub Runner are:

+
+
+
    +
  • +

    to ensure that WireMock / Messaging stubs (used when developing the client) are doing exactly what actual server-side implementation will do,

    +
    • +
  • +

    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 generate boilerplate test code used on the server side.

    +
    • +
+
+
+
+

Client Side

+
+

During the tests you want to have a Wiremock instance / Messaging route up and running that simulates the service Y. +You would like to feed that instance with a proper stub definition. That stub definition would need +to be valid and should also be reusable on the server side.

+
+
+

Summing it up: On this side, in the stub definition, you can use patterns for request stubbing and you need exact +values for responses.

+
+
+
+

Server Side

+
+

Being a service Y since you are developing your stub, you need to be sure that it’s actually resembling your +concrete implementation. You can’t have a situation where your stub acts in one way and your application on +production behaves in a different way.

+
+
+

That’s why from the provided stub acceptance tests will be generated that will ensure +that your application behaves in the same way as you define in your stub.

+
+
+

Summing it up: On this side, in the stub definition, you need exact values as request and can use patterns/methods +for response verification.

+
+
+
+

Dependencies

+
+

Accurest and Stub Runner are using the following libraries

+
+
+ +
+
+
+ +
+

Below you can find some resources related to Accurest and Stub Runner. Note that some can be outdated since the Accurest project +is under constant development.

+
+
+

Videos

+
+

Olga Maciaszek-Sharma talking about Accurest

+
+
+
+ +
+
+
+

Marcin Grzejszczak and Jakub Kubryński talking about Accurest

+
+
+
+ +
+
+
+
+

Readings

+
+ +
+
+
+
+

Samples

+
+

Here you can find some working samples. Check the readme of each project for more information.

+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/messaging.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/messaging.html new file mode 100644 index 0000000000..623d82b4b3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/messaging.html @@ -0,0 +1,914 @@ + + + + + + + +Accurest Messaging + + + + + + + +
+
+

Accurest Messaging

+
+
+ + + + + +
+ + +Feature available since {messaging_version} +
+
+
+

Accurest allows you to verify your application that uses messaging as means of communication. +All of our integrations are working with Spring but you can also set one yourself.

+
+
+

Integrations

+
+

You can use one of the three integration configurations:

+
+
+
    +
  • +

    Apache Camel

    +
    • +
  • +

    Spring Integration

    +
    • +
  • +

    Spring Cloud Stream

    +
    • +
+
+
+

If you’re using Spring Boot, the aforementioned test configurations will be appended automatically.

+
+
+

You have to provide as a dependency one of the Accurest Messaging modules. Example for Gradle:

+
+
+
+
// for Apache Camel
+testCompile "io.codearte.accurest:accurest-messaging-camel:${accurestVersion}"
+// for Spring Integration
+testCompile "io.codearte.accurest:accurest-messaging-integration:${accurestVersion}"
+// for Spring Cloud Stream
+testCompile "io.codearte.accurest:accurest-messaging-stream:${accurestVersion}"
+
+
+
+
+

Manual Integration

+
+

The accurest-messaging-core module contains 3 main interfaces:

+
+
+
    +
  • +

    AccurestMessage - describes a message received / sent to a channel / queue / topic etc.

    +
    • +
  • +

    AccurestMessageBuilder - describes how to build a message

    +
    • +
  • +

    AccurestMessaging - class that allows you to build, send and receive messages

    +
    • +
  • +

    AccurestFilter - interface to filter out the messages that do not follow the pattern from the DSL

    +
    • +
+
+
+

In the generated test the AccurestMessaging is injected via @Inject annotation thus you can use other injection +frameworks than Spring.

+
+
+

You have to provide as a dependency the accurest-messaging-core module. Example for Gradle:

+
+
+
+
testCompile "io.codearte.accurest:accurest-messaging-core:${accurestVersion}"
+
+
+
+
+

Publisher side test generation

+
+

Having the input or outputMessage sections in your DSL will result in creation of tests on the publisher’s side. By default +JUnit tests will be created, however there is also a possibility to create Spock tests.

+
+
+

There are 3 main scenarios that we should take into consideration:

+
+
+
    +
  • +

    Scenario 1: there is no input message that produces an output one. The output message is triggered by a component +inside the application (e.g. scheduler)

    +
    • +
  • +

    Scenario 2: the input message triggers an output message

    +
    • +
  • +

    Scenario 3: the input message is consumed and there is no output message

    +
    • +
+
+
+

Scenario 1 (no input message)

+
+

For the given contract:

+
+
+
+
def contractDsl = GroovyDsl.make {
+        label 'some_label'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('activemq:output')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

The following JUnit test will be created:

+
+
+
+
'''
+ // when:
+  bookReturnedTriggered();
+
+ // then:
+  AccurestMessage response = accurestMessaging.receiveMessage("activemq:output");
+  assertThat(response).isNotNull();
+  assertThat(response.getHeader("BOOK-NAME")).isEqualTo("foo");
+ // and:
+  DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.getPayload()));
+  assertThatJson(parsedJson).field("bookName").isEqualTo("foo");
+'''
+
+
+
+

And the following Spock test would be created:

+
+
+
+
'''
+ when:
+  bookReturnedTriggered()
+
+ then:
+  def response = accurestMessaging.receiveMessage('activemq:output')
+  assert response != null
+  response.getHeader('BOOK-NAME')  == 'foo'
+ and:
+  DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.payload))
+  assertThatJson(parsedJson).field("bookName").isEqualTo("foo")
+
+'''
+
+
+
+
+

Scenario 2 (output triggered by input)

+
+

For the given contract:

+
+
+
+
def contractDsl = GroovyDsl.make {
+        label 'some_label'
+        input {
+                messageFrom('jms:input')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('jms:output')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

The following JUnit test will be created:

+
+
+
+
'''
+// given:
+ AccurestMessage inputMessage = accurestMessaging.create(
+  "{\\"bookName\\":\\"foo\\"}"
+, headers()
+  .header("sample", "header"));
+
+// when:
+ accurestMessaging.send(inputMessage, "jms:input");
+
+// then:
+ AccurestMessage response = accurestMessaging.receiveMessage("jms:output");
+ assertThat(response).isNotNull();
+ assertThat(response.getHeader("BOOK-NAME")).isEqualTo("foo");
+// and:
+ DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.getPayload()));
+ assertThatJson(parsedJson).field("bookName").isEqualTo("foo");
+'''
+
+
+
+

And the following Spock test would be created:

+
+
+
+
"""\
+given:
+   def inputMessage = accurestMessaging.create(
+    '''{"bookName":"foo"}''',
+    ['sample': 'header']
+  )
+
+when:
+   accurestMessaging.send(inputMessage, 'jms:input')
+
+then:
+   def response = accurestMessaging.receiveMessage('jms:output')
+   assert response !- null
+   response.getHeader('BOOK-NAME')  == 'foo'
+and:
+   DocumentContext parsedJson = JsonPath.parse(accurestObjectMapper.writeValueAsString(response.payload))
+   assertThatJson(parsedJson).field("bookName").isEqualTo("foo")
+"""
+
+
+
+
+

Scenario 3 (no output message)

+
+

For the given contract:

+
+
+
+
def contractDsl = GroovyDsl.make {
+        label 'some_label'
+        input {
+                messageFrom('jms:delete')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+                assertThat('bookWasDeleted()')
+        }
+}
+
+
+
+

The following JUnit test will be created:

+
+
+
+
'''
+// given:
+ AccurestMessage inputMessage = accurestMessaging.create(
+        "{\\"bookName\\":\\"foo\\"}"
+, headers()
+        .header("sample", "header"));
+
+// when:
+ accurestMessaging.send(inputMessage, "jms:delete");
+
+// then:
+ bookWasDeleted();
+'''
+
+
+
+

And the following Spock test would be created:

+
+
+
+
'''
+given:
+         def inputMessage = accurestMessaging.create(
+                \'\'\'{"bookName":"foo"}\'\'\',
+                ['sample': 'header']
+        )
+
+when:
+         accurestMessaging.send(inputMessage, 'jms:delete')
+
+then:
+         noExceptionThrown()
+         bookWasDeleted()
+'''
+
+
+
+
+
+

Consumer Stub Side generation

+
+

Unlike the HTTP part - in Messaging we need to publish the Groovy DSL inside the JAR with a stub. Then it’s parsed on the consumer side +and proper stubbed routes are created.

+
+
+

For more infromation please consult the Stub Runner Messaging sections.

+
+
+

Gradle Setup

+
+

Example of Accurest Gradle setup:

+
+
+
+
ext {
+        contractsDir = file("mappings")
+        stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/")
+        wireMockStubsOutputDir = file(new File(stubsOutputDirRoot, 'repository/mappings/'))
+        contractsOutputDir = file(new File(stubsOutputDirRoot, 'repository/accurest/'))
+}
+
+task copyContracts(type: Copy) {
+        from contractsDir
+        include '**/*.groovy'
+        into contractsOutputDir
+}
+
+task stubsJar(type: Jar, dependsOn: ["generateWireMockClientStubs", copyContracts]) {
+        baseName = "${project.name}"
+        classifier = "stubs"
+        from stubsOutputDirRoot
+}
+
+artifacts {
+        archives stubsJar
+}
+
+publishing {
+        publications {
+                stubs(MavenPublication) {
+                        artifactId "${project.name}-stubs"
+                        artifact stubsJar
+                }
+        }
+}
+
+
+
+
+

Maven Setup

+
+

Example of Maven can be found in the Accurest Maven Plugin README

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/migration.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/migration.html new file mode 100644 index 0000000000..351572a2e3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/migration.html @@ -0,0 +1,594 @@ + + + + + + + +Migration Guide + + + + + + + +
+
+

Migration Guide

+
+
+

Migration to 0.4.7

+
+
    +
  • +

    in 0.4.7 we’ve fixed package name (coderate to codearte) so you’ve to do the same in your projects. This means replacing io.coderate.accurest.dsl.GroovyDsl with io.codearte.accurest.dsl.GroovyDsl

    +
    • +
+
+
+
+

Migration to 1.0.0-RC1

+
+
    +
  • +

    from 1.0.0 we’re distinguish ignored contracts from excluded contracts:

    +
    • +
  • +

    excludedFiles pattern tells Accurest to skip processing those files at all

    +
    • +
  • +

    ignoredFiles pattern tells Accurest to generate contracts and tests, but tests will be marked as @Ignore

    +
    • +
  • +

    from 1.0.0 the basePackageForTests behaviour has changed

    +
    • +
  • +

    prior to the change all DSL files had to be under contractsDslDir/basePackageForTests/subpackage resulting in basePackageForTests.subpackage test package creation

    +
    • +
  • +

    now all DSL files have to be under contractsDslDir/subpackage resulting in basePackageForTests.subpackage test package creation

    +
    • +
  • +

    If you don’t migrate to the new approach you will have your tests under contractsDslDir.contractsDslDir.subpackage

    +
    • +
+
+
+
+

Migration to {messaging_version}

+
+
    +
  • +

    from {messaging_version} we’re setting JUnit as a default testing utility. You have to pass the following option to keep Spock +as your first choice:

    +
    • +
+
+
+
+
targetFramework = 'Spock'
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/rest.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/rest.html new file mode 100644 index 0000000000..bab2a70944 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/rest.html @@ -0,0 +1,1032 @@ + + + + + + + +Accurest HTTP + + + + + + + +
+
+

Accurest HTTP

+
+
+

Gradle Project

+
+

Prerequisites

+
+

In order to use Accurest with Wiremock you have to use gradle or maven plugin.

+
+
+
Add gradle plugin
+
+
+
buildscript {
+        repositories {
+                mavenCentral()
+        }
+        dependencies {
+                classpath 'io.codearte.accurest:accurest-gradle-plugin:${accurest_version}'
+        }
+}
+
+apply plugin: 'groovy'
+apply plugin: 'accurest'
+
+dependencies {
+        testCompile 'org.codehaus.groovy:groovy-all:2.4.6'
+        testCompile 'org.spockframework:spock-core:1.0-groovy-2.4'
+        testCompile 'com.jayway.restassured:spring-mock-mvc:2.9.0' // needed if you're going to use Spring MockMvc
+}
+
+
+
+
+
Add maven plugin
+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+                <goal>generateTests</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+
+
+
+

Read more: accurest-maven-plugin

+
+
+
+
Add stubs
+
+

By default Accurest is looking for stubs in src/test/resources/accurest directory.

+
+
+

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 which will be used as test class name. If there is more than one level of nested directories all except the last one will be used as package name. +So with following structure

+
+
+
+
src/test/resources/accurest/myservice/shouldCreateUser.groovy
+src/test/resources/accurest/myservice/shouldReturnUser.groovy
+
+
+
+

Accurest will create test class defaultBasePackage.MyService with two methods

+
+
+
    +
  • +

    shouldCreateUser()

    +
    • +
  • +

    shouldReturnUser()

    +
    • +
+
+
+
+
+

Run plugin

+
+

Plugin registers itself to be invoked before check task. You have nothing to do as long as you want it to be part of your build process. If you just want to generate tests please invoke generateAccurest task.

+
+
+
+

Configure plugin

+
+

To change default configuration just add accurest snippet to your Gradle config

+
+
+
+
accurest {
+        testMode = 'MockMvc'
+        baseClassForTests = 'org.mycompany.tests'
+        generatedTestSourcesDir = project.file('src/accurest')
+}
+
+
+
+
Configuration options
+
+
    +
  • +

    testMode - defines mode for acceptance tests. By default MockMvc which is based on Spring’s MockMvc. It can also be changed to JaxRsClient or to Explicit for real HTTP calls.

    +
    • +
  • +

    imports - array with imports that should be included in generated tests (for example ['org.myorg.Matchers']). By default empty array []

    +
    • +
  • +

    staticImports - array with static imports that should be included in generated tests(for example ['org.myorg.Matchers.*']). By default empty array []

    +
    • +
  • +

    basePackageForTests - specifies base package for all generated tests. By default set to io.codearte.accurest.tests

    +
    • +
  • +

    baseClassForTests - base class for generated tests. By default spock.lang.Specification if using Spock tests.

    +
    • +
  • +

    ruleClassForTests - specifies Rule which should be added to generated test classes.

    +
    • +
  • +

    ignoredFiles - Ant matcher allowing defining stub files for which processing should be skipped. By default empty array []

    +
    • +
  • +

    contractsDslDir - directory containing contracts written using the GroovyDSL. By default $rootDir/src/test/resources/accurest

    +
    • +
  • +

    generatedTestSourcesDir - test source directory where tests generated from Groovy DSL should be placed. By default $buildDir/generated-test-sources/accurest

    +
    • +
  • +

    stubsOutputDir - dir where the generated Wiremock stubs from Groovy DSL should be placed

    +
    • +
  • +

    targetFramework - the target test framework to be used; currently Spock and JUnit are supported with JUnit being the default framework

    +
    • +
+
+
+
+
Base class for tests
+
+

When using Accurest in default MockMvc you need to create a base specification for all generated acceptance tests. In this class you need to point to endpoint which should be verified.

+
+
+
+
abstract class BaseMockMvcSpec extends Specification {
+
+        def setup() {
+                RestAssuredMockMvc.standaloneSetup(new PairIdController())
+        }
+
+        void isProperCorrelationId(Integer correlationId) {
+                assert correlationId == 123456
+        }
+
+        void isEmpty(String value) {
+                assert value == null
+        }
+
+}
+
+
+
+

In case of using Explicit mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of JAXRSCLIENT mode this base class +should also contain protected WebTarget webTarget field, right now the only option to test JAX-RS API is to start a web server.

+
+
+
+
+

Invoking generated tests

+
+

To ensure that provider side is complaint with defined contracts, you need to invoke:

+
+
+
+
./gradlew generateAccurest test
+
+
+
+
+

Accurest on consumer side

+
+

In consumer service you need to configure Accurest plugin in exactly the same way as in case of provider. If you don’t want to use Stub Runner then you need to copy contracts stored in +src/test/resources/accurest and generate WireMock json stubs using:

+
+
+
+
./gradlew generateWireMockClientStubs
+
+
+
+

Note that stubsOutputDir option has to be set for stub generation to work.

+
+
+

When present, json stubs can be used in consumer automated tests.

+
+
+
+
@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(pesel: '12345678901'), amount: 123.123)
+   when:
+        LoanApplicationResult loanApplication == sut.loanApplication(application)
+   then:
+        loanApplication.loanApplicationStatus === LoanApplicationStatus.LOAN_APPLIED
+        loanApplication.rejectionReason === null
+ }
+}
+
+
+
+

Underneath LoanApplication makes a call to FraudDetection service. This request is handled by Wiremock server configured using stubs generated by Accurest.

+
+
+
+
+

Using in your Maven project

+
+

Add maven plugin

+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+                <goal>generateTests</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+
+
+
+

Read more: accurest-maven-plugin

+
+
+
+

Add stubs

+
+

By default Accurest is looking for stubs in src/test/resources/accurest directory. +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 which will be used as test class name. If there is more than one level of nested directories all except the last one will be used as package name. +So with following structure

+
+
+
+
src/test/resources/accurest/myservice/shouldCreateUser.groovy
+src/test/resources/accurest/myservice/shouldReturnUser.groovy
+
+
+
+

Accurest will create test class defaultBasePackage.MyService with two methods + - shouldCreateUser() + - shouldReturnUser()

+
+
+
+

Run plugin

+
+

Plugin goal generateTests is assigned to be invoked in phase generate-test-sources. You have nothing to do as long as you want it to be part of your build process. If you just want to generate tests please invoke generateTests goal.

+
+
+
+

Configure plugin

+
+

To change default configuration just add configuration section to plugin definition or execution definition.

+
+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+                <goal>generateTests</goal>
+            </goals>
+        </execution>
+    </executions>
+    <configuration>
+        <basePackageForTests>com.ofg.twitter.place</basePackageForTests>
+        <baseClassForTests>com.ofg.twitter.place.BaseMockMvcSpec</baseClassForTests>
+    </configuration>
+</plugin>
+
+
+
+
Important configuration options
+
+
    +
  • +

    testMode - defines mode for acceptance tests. By default MockMvc which is based on Spring’s MockMvc. It can also be changed to JaxRsClient or to Explicit for real HTTP calls.

    +
    • +
  • +

    basePackageForTests - specifies base package for all generated tests. By default set to io.codearte.accurest.tests.

    +
    • +
  • +

    ruleClassForTests - specifies Rule which should be added to generated test classes.

    +
    • +
  • +

    baseClassForTests - base class for generated tests. By default spock.lang.Specification if using Spock tests.

    +
    • +
  • +

    contractsDir - directory containing contracts written using the GroovyDSL. By default /src/test/resources/accurest.

    +
    • +
  • +

    testFramework - the target test framework to be used; currently Spock and JUnit are supported with Spock being the default framework

    +
    • +
+
+
+

For complete information take a look at Plugin Documentation

+
+
+
+
Base class for tests
+
+
+
When using Accurest in default MockMvc you need to create a base specification for all generated acceptance tests. In this class you need to point to endpoint which should be verified.
+
+
+
+
+
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())
+  }
+}
+
+
+
+

In case of using Explicit mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of JAXRSCLIENT mode this base class should also contain protected WebTarget webTarget field, right now the only option to test JAX-RS API is to start a web server.

+
+
+
+
+

Invoking generated tests

+
+

Accurest Maven Plugins generates verification code into directory /generated-test-sources/accurest and attach this directory to testCompile goal.

+
+
+

For Groovy Spock code use:

+
+
+
+
<plugin>
+        <groupId>org.codehaus.gmavenplus</groupId>
+        <artifactId>gmavenplus-plugin</artifactId>
+        <version>1.5</version>
+        <executions>
+                <execution>
+                        <goals>
+                                <goal>testCompile</goal>
+                        </goals>
+                </execution>
+        </executions>
+        <configuration>
+                <testSources>
+                        <testSource>
+                                <directory>${project.basedir}/src/test/groovy</directory>
+                                <includes>
+                                        <include>**/*.groovy</include>
+                                </includes>
+                        </testSource>
+                        <testSource>
+                                <directory>${project.build.directory}/generated-test-sources/accurest</directory>
+                                <includes>
+                                        <include>**/*.groovy</include>
+                                </includes>
+                        </testSource>
+                </testSources>
+        </configuration>
+</plugin>
+
+
+
+

To ensure that provider side is complaint with defined contracts, you need to invoke mvn generateTest test

+
+
+
+

Accurest on consumer side

+
+

In consumer service you need to configure Accurest plugin in exactly the same way as in case of provider. You need to copy contracts stored in src/test/resources/accurest and generate Wiremock json stubs using: mvn generateStubs command. By default generated WireMock mapping is stored in directory target/mappings. Your project should create from this generated mappings additional artifact with classifier stubs for easy deploy to maven repository.

+
+
+

Sample configuration:

+
+
+
+
<plugin>
+    <groupId>io.codearte.accurest</groupId>
+    <artifactId>accurest-maven-plugin</artifactId>
+    <version>${accurest-plugin.version}</version>
+    <executions>
+        <execution>
+            <goals>
+                <goal>convert</goal>
+                <goal>generateStubs</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+
+
+
+

When present, json stubs can be used in consumer automated tests.

+
+
+
+
@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(pesel: '12345678901'), amount: 123.123)
+   when:
+        LoanApplicationResult loanApplication == sut.loanApplication(application)
+   then:
+        loanApplication.loanApplicationStatus === LoanApplicationStatus.LOAN_APPLIED
+        loanApplication.rejectionReason === null
+ }
+}
+
+
+
+

Underneath LoanApplication makes a call to FraudDetection service. This request is handled by Wiremock server configured using stubs generated by Accurest.

+
+
+
+
+

Scenarios

+
+

It’s possible to handle scenarios with Accurest. All you need to do is to stick to proper naming convention while creating your contracts. The convention requires to include order number followed by the underscore.

+
+
+
+
my_contracts_dir\
+  scenario1\
+    1_login.groovy
+    2_showCart.groovy
+    3_logout.groovy
+
+
+
+

Such tree will cause Accurest generating Wiremock’s scenario with name scenario1 and three 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 under [http://wiremock.org/stateful-behaviour.html](http://wiremock.org/stateful-behaviour.html)

+
+
+

Accurest will also generate tests with guaranteed order of execution.

+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/stubrunner.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/stubrunner.html new file mode 100644 index 0000000000..901a8fd60f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/stubrunner.html @@ -0,0 +1,1258 @@ + + + + + + + +Stub Runner + + + + + + + +
+
+

Stub Runner

+
+
+

One of the issues that you could have encountered while using Accurest was to pass the generated WireMock JSON stubs from the server side to the client side (or various clients). + The same takes place in terms of client side generation for messaging.

+
+
+

Copying the JSON files / setting the client side for messaging manually is out of the question.

+
+
+

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.

+
+
+

Gradle

+
+

Example of Accurest Gradle setup:

+
+
+
+
ext {
+        contractsDir = file("mappings")
+        stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/")
+        wireMockStubsOutputDir = file(new File(stubsOutputDirRoot, 'repository/mappings/'))
+        contractsOutputDir = file(new File(stubsOutputDirRoot, 'repository/accurest/'))
+}
+
+task copyContracts(type: Copy) {
+        from contractsDir
+        include '**/*.groovy'
+        into contractsOutputDir
+}
+
+task stubsJar(type: Jar, dependsOn: ["generateWireMockClientStubs", copyContracts]) {
+        baseName = "${project.name}"
+        classifier = "stubs"
+        from stubsOutputDirRoot
+}
+
+artifacts {
+        archives stubsJar
+}
+
+publishing {
+        publications {
+                stubs(MavenPublication) {
+                        artifactId "${project.name}-stubs"
+                        artifact stubsJar
+                }
+        }
+}
+
+
+
+
+

Maven

+
+

Example of Maven can be found in the Accurest Maven Plugin README

+
+
+
+
+

Modules

+
+

Accurest comes with a new structure of modules

+
+
+
+
└── stub-runner
+    ├── stub-runner
+    ├── stub-runner-boot
+    ├── stub-runner-junit
+    ├── stub-runner-spring
+    └── stub-runner-spring-cloud
+
+
+
+
+

Stub Runner Core

+
+

Runs stubs for service collaborators. Treating stubs as contracts of services allows to use stub-runner as an implementation of +Consumer Driven Contracts.

+
+
+

Stub Runner allows you to automatically download the stubs of the provided dependencies, start WireMock servers for them and feed them with proper stub definitions. +For messaging, special stub routes are defined.

+
+
+

Running stubs

+
+
Running using main app
+
+

You can set the following options to the main class:

+
+
+
+
-maxp (--maxPort) N            : Maximum port value to be assigned to the
+                                 Wiremock instance. Defaults to 15000
+                                 (default: 15000)
+-minp (--minPort) N            : Minimal port value to be assigned to the
+                                 Wiremock instance. Defaults to 10000
+                                 (default: 10000)
+-s (--stubs) VAL               : Comma separated list of Ivy representation of
+                                 jars with stubs. Eg. groupid:artifactid1,group
+                                 id2:artifactid2:version:classifier
+-sr (--stubRepositoryRoot) VAL : Location of a Jar containing server where you
+                                 keep your stubs (e.g. http://nexus.net/content
+                                 /repositories/repository)
+-ss (--stubsSuffix) VAL        : 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)
+-wo (--workOffline)            : Switch to work offline. Defaults to 'false'
+                                 (default: false)
+
+
+
+
+
Building a Fat Jar
+
+

Just call the following command:

+
+
+
+
./gradlew stub-runner-root:stub-runner:shadowJar -PfatJar
+
+
+
+

and inside the build/lib there will be a Fat Jar with classifier fatJar waiting for you to execute. E.g.

+
+
+
+
java -jar stub-runner/stub-runner/build/libs/stub-runner-1.0.1-SNAPSHOT-fatJar.jar -sr http://a.b.com -s a:b:c,d:e,f:g:h:i
+
+
+
+
+
+

Stub runner configuration

+
+

You can configure the stub runner by either passing the full arguments list with the -Pargs like this:

+
+
+
+
./gradlew stub-runner-root:stub-runner:run -Pargs="-c pl -minp 10000 -maxp 10005 -s a:b:c,d:e,f:g:h"
+
+
+
+

or each parameter separately with a -P prefix and without the hyphen - in the name of the param

+
+
+
+
./gradlew stub-runner-root:stub-runner:run -Pc=pl -Pminp=10000 -Pmaxp=10005 -Ps=a:b:c,d:e,f:g:h
+
+
+
+
HTTP Stubs
+
+

Stubs are defined in JSON documents, whose syntax is defined in WireMock documentation

+
+
+

Example:

+
+
+
+
{
+    "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.

+
+
+
+
Messaging Stubs
+
+

Depending on the provided Stub Runner dependency and the DSL the messaging routes are automatically set up.

+
+
+
+
+
+

Stub Runner Boot

+
+ + + + + +
+ + +Feature available since {messaging_version} +
+
+
+

Accurest 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 usecases is to run some smoke (end to end) tests on a deployed application. You can read + more about this in the "Microservice Deployment" article at Too Much Coding blog.

+
+
+

How to use it?

+
+

Just add the

+
+
+
+
compile "io.codearte.accurest:stub-runner-boot:${accurestVersion}"
+
+
+
+

and a messaging implementation:

+
+
+
+
// for Apache Camel
+compile "io.codearte.accurest:stub-runner-messaging-camel:${accurestVersion}"
+// for Spring Integration
+compile "io.codearte.accurest:stub-runner-messaging-integration:${accurestVersion}"
+// for Spring Cloud Stream
+compile "io.codearte.accurest:stub-runner-messaging-stream:${accurestVersion}"
+
+
+
+

Build a fat-jar and you’re ready to go!

+
+
+

For the properties check the Stub Runner Spring section.

+
+
+
+

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

+
+
+
@ContextConfiguration(classes = [StubRunnerBootSpec, StubRunnerBoot], loader = SpringApplicationContextLoader)
+@EnableBinding
+@Configuration
+class StubRunnerBootSpec extends Specification {
+
+        @Autowired StubRunning stubRunning
+
+        def setup() {
+                RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning),
+                                new TriggerController(stubRunning))
+        }
+
+        def 'should return a list of running stub servers in "full ivy:port" notation'() {
+                when:
+                        String response = RestAssuredMockMvc.get('/stubs').body.asString()
+                then:
+                        def root = new JsonSlurper().parseText(response)
+                        root.'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs' instanceof Integer
+        }
+
+        def 'should return a port on which a [#stubId] stub is running'() {
+                when:
+                        def response = RestAssuredMockMvc.get("/stubs/${stubId}")
+                then:
+                        response.statusCode == 200
+                        response.body.as(Integer) > 0
+                where:
+                        stubId << ['io.codearte.accurest.stubs:streamService:+:stubs',
+                                           'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs',
+                                           'io.codearte.accurest.stubs:streamService:+',
+                                           'io.codearte.accurest.stubs:streamService',
+                                           'streamService']
+        }
+
+        def 'should return 404 when missing stub was called'() {
+                when:
+                        def response = RestAssuredMockMvc.get("/stubs/a:b:c:d")
+                then:
+                        response.statusCode == 404
+        }
+
+        def 'should return a list of messaging labels that can be triggered when version and classifier are passed'() {
+                when:
+                        String response = RestAssuredMockMvc.get('/triggers').body.asString()
+                then:
+                        def root = new JsonSlurper().parseText(response)
+                        root.'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs'?.containsAll(["delete_book","return_book_1","return_book_2"])
+        }
+
+        def 'should trigger a messaging label'() {
+                given:
+                        StubRunning stubRunning = Mock()
+                        RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), new TriggerController(stubRunning))
+                when:
+                        def response = RestAssuredMockMvc.post("/triggers/delete_book")
+                then:
+                        response.statusCode == 200
+                and:
+                        1 * stubRunning.trigger('delete_book')
+        }
+
+        def 'should trigger a messaging label for a stub with [#stubId] ivy notation'() {
+                given:
+                        StubRunning stubRunning = Mock()
+                        RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), new TriggerController(stubRunning))
+                when:
+                        def response = RestAssuredMockMvc.post("/triggers/$stubId/delete_book")
+                then:
+                        response.statusCode == 200
+                and:
+                        1 * stubRunning.trigger(stubId, 'delete_book')
+                where:
+                        stubId << ['io.codearte.accurest.stubs:streamService:stubs', 'io.codearte.accurest.stubs:streamService', 'streamService']
+        }
+
+        def 'should return when trigger is missing'() {
+                when:
+                        def response = RestAssuredMockMvc.post("/triggers/missing_label")
+                then:
+                        response.statusCode == 404
+                        def root = new JsonSlurper().parseText(response.body.asString())
+                        root.'io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs'?.containsAll(["delete_book","return_book_1","return_book_2"])
+        }
+
+}
+
+
+
+
+
+

Stub Runner JUnit Rule

+
+

Stub Runner comes with a JUnit rule thanks to which you can very easily download and run stubs for given group and artifact id:

+
+
+
+
@ClassRule public static AccurestRule rule = new AccurestRule()
+                .repoRoot(repoRoot())
+                .downloadStub("io.codearte.accurest.stubs", "loanIssuance")
+                .downloadStub("io.codearte.accurest.stubs:fraudDetectionServer");
+
+
+
+

After that rule gets 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

    +
    • +
+
+
+

Stub Runner uses Eclipse Aether mechanism to download the Maven dependencies. +Check their docs for more information.

+
+
+

Since the AccurestRule implements the StubFinder it allows you to find the started stubs:

+
+
+
+
package io.codearte.accurest.stubrunner
+
+import io.codearte.accurest.dsl.GroovyDsl
+
+interface StubFinder extends StubTrigger {
+        /**
+         * For the given groupId and artifactId tries to find the matching
+         * URL of the running stub.
+         *
+         * @param groupId - might be null. In that case a search only via artifactId takes place
+         * @return URL of a running stub or null if not found
+         */
+        URL findStubUrl(String groupId, String artifactId)
+
+        /**
+         * For the given Ivy notation {@code groupId:artifactId} tries to find the matching
+         * URL of the running stub. You can also pass only {@code artifactId}.
+         *
+         * @param ivyNotation - Ivy representation of the Maven artifact
+         * @return URL of a running stub or null if not found
+         */
+        URL findStubUrl(String ivyNotation)
+
+        /**
+         * Returns all running stubs
+         */
+        RunningStubs findAllRunningStubs()
+
+        /**
+         * Returns the list of Accurest contracts
+         */
+        Map<StubConfiguration, Collection<GroovyDsl>> getAccurestContracts()
+}
+
+
+
+

Example of usage in Spock tests:

+
+
+
+
@ClassRule @Shared AccurestRule rule = new AccurestRule()
+                .repoRoot(AccurestRuleSpec.getResource("/m2repo").toURI().toString())
+                .downloadStub("io.codearte.accurest.stubs", "loanIssuance")
+                .downloadStub("io.codearte.accurest.stubs:fraudDetectionServer")
+
+def 'should start WireMock servers'() {
+        expect: 'WireMocks are running'
+                rule.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance') != null
+                rule.findStubUrl('loanIssuance') != null
+                rule.findStubUrl('loanIssuance') == rule.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance')
+                rule.findStubUrl('io.codearte.accurest.stubs:fraudDetectionServer') != null
+        and:
+                rule.findAllRunningStubs().isPresent('loanIssuance')
+                rule.findAllRunningStubs().isPresent('io.codearte.accurest.stubs', 'fraudDetectionServer')
+                rule.findAllRunningStubs().isPresent('io.codearte.accurest.stubs:fraudDetectionServer')
+        and: 'Stubs were registered'
+                "${rule.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance'
+                "${rule.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer'
+}
+
+
+
+

Example of usage in JUnit tests:

+
+
+
+
@Test
+public void should_start_wiremock_servers() throws Exception {
+        // expect: 'WireMocks are running'
+                then(rule.findStubUrl("io.codearte.accurest.stubs", "loanIssuance")).isNotNull();
+                then(rule.findStubUrl("loanIssuance")).isNotNull();
+                then(rule.findStubUrl("loanIssuance")).isEqualTo(rule.findStubUrl("io.codearte.accurest.stubs", "loanIssuance"));
+                then(rule.findStubUrl("io.codearte.accurest.stubs:fraudDetectionServer")).isNotNull();
+        // and:
+                then(rule.findAllRunningStubs().isPresent("loanIssuance")).isTrue();
+                then(rule.findAllRunningStubs().isPresent("io.codearte.accurest.stubs", "fraudDetectionServer")).isTrue();
+                then(rule.findAllRunningStubs().isPresent("io.codearte.accurest.stubs:fraudDetectionServer")).isTrue();
+        // and: 'Stubs were registered'
+                then(httpGet(rule.findStubUrl("loanIssuance").toString() + "/name")).isEqualTo("loanIssuance");
+                then(httpGet(rule.findStubUrl("fraudDetectionServer").toString() + "/name")).isEqualTo("fraudDetectionServer");
+}
+
+
+
+

Check the Common properties for JUnit and Spring for more information on how to apply global configuration of Stub Runner.

+
+
+

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 AccurestRule you can add a stub to download and then pass the port for the last downloaded stub.

+
+
+
+
@ClassRule public static AccurestRule rule = new AccurestRule()
+                .repoRoot(repoRoot())
+                .downloadStub("io.codearte.accurest.stubs", "loanIssuance")
+                .withPort(12345)
+                .downloadStub("io.codearte.accurest.stubs:fraudDetectionServer:12346");
+
+
+
+

You can see that for this example the following test is valid:

+
+
+
+
then(rule.findStubUrl("loanIssuance")).isEqualTo(URI.create("http://localhost:12345").toURL());
+then(rule.findStubUrl("fraudDetectionServer")).isEqualTo(URI.create("http://localhost:12346").toURL());
+
+
+
+
+
+

Stub Runner 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:

+
+
+
+
@ContextConfiguration(classes = Config, loader = SpringApplicationContextLoader)
+class StubRunnerConfigurationSpec extends Specification {
+
+        @Autowired StubFinder stubFinder
+
+        def 'should start WireMock servers'() {
+                expect: 'WireMocks are running'
+                        stubFinder.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance') != null
+                        stubFinder.findStubUrl('loanIssuance') != null
+                        stubFinder.findStubUrl('loanIssuance') == stubFinder.findStubUrl('io.codearte.accurest.stubs', 'loanIssuance')
+                        stubFinder.findStubUrl('io.codearte.accurest.stubs:fraudDetectionServer') != null
+                and:
+                        stubFinder.findAllRunningStubs().isPresent('loanIssuance')
+                        stubFinder.findAllRunningStubs().isPresent('io.codearte.accurest.stubs', 'fraudDetectionServer')
+                        stubFinder.findAllRunningStubs().isPresent('io.codearte.accurest.stubs:fraudDetectionServer')
+                and: 'Stubs were registered'
+                        "${stubFinder.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance'
+                        "${stubFinder.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer'
+        }
+
+        @Configuration
+        @Import(StubRunnerConfiguration)
+        @EnableAutoConfiguration
+        static class Config {}
+}
+
+
+
+

for the following configuration file:

+
+
+
+
stubrunner.stubs.repository.root: classpath:m2repo/repository/
+stubrunner.stubs.ids: io.codearte.accurest.stubs:loanIssuance,io.codearte.accurest.stubs:fraudDetectionServer
+
+
+
+
+

Stub Runner Spring Cloud

+
+

Registers the stubs in the provided Service Discovery. It’s enough to add the jar

+
+
+
+
io.codearte.accurest:stub-runner-spring-cloud
+
+
+
+

and the Stub Runner autoconfiguration should be picked up.

+
+
+

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 regardles 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.

+
+
+
+

Additional Configuration

+
+

You can match the artifactId of the stub with the name of your app by using the stubrunner.stubs.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

+
+
+
+
+

Common properties for JUnit and Spring

+
+

Some of the properties that are repetitive can be set using system properties or property sources (for Spring). Here are their names with their default values:

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property nameDefault valueDescription

stubrunner.port.range.min

10000

Minimal value of a port for a started WireMock with stubs

stubrunner.port.range.max

15000

Minimal value of a port for a started WireMock with stubs

stubrunner.stubs.repository.root

Comma separated list of Maven repo urls. If blank then will call the local maven repo

stubrunner.stubs.classifier

stubs

Default classifier for the stub artifacts

stubrunner.work-offline

false

If true then will not contact any remote repositories to download stubs

stubrunner.stubs.ids

Comma separated list of Ivy notation of stubs to download

+
+

Stub runner stubs ids

+
+

You can provide the stubs to download via the stubrunner.stubs.ids system property. They follow the following pattern:

+
+
+
+
groupId:artifactId:version:classifier:port
+
+
+
+

version, classifier and port are optional.

+
+
+
    +
  • +

    If you don’t provide the port then a random one will be picked

    +
    • +
  • +

    If you don’t provide the classifier then the default one will be taken.

    +
    • +
  • +

    If you don’t provide the version then the + will be passed and the latest one will be downloaded

    +
    • +
+
+
+

Where port means the port of the WireMock server.

+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/stubrunner_msg.html b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/stubrunner_msg.html new file mode 100644 index 0000000000..ae7b656eea --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/deprecated/stubrunner_msg.html @@ -0,0 +1,1247 @@ + + + + + + + +Stub Runner for Messaging + + + + + + + +
+
+

Stub Runner for Messaging

+
+
+ + + + + +
+ + +Feature available since {messaging_version} +
+
+
+

Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box

+
+
+
    +
  • +

    Spring Integration

    +
    • +
  • +

    Spring Cloud Stream

    +
    • +
  • +

    Apache Camel

    +
    • +
+
+
+

It also provides points of entry to integrate with any other solution on the market.

+
+
+

Stub triggering

+
+

To trigger a message it’s enough to use the StubTigger interface:

+
+
+
+
package io.codearte.accurest.stubrunner
+
+interface StubTrigger {
+
+        /**
+         * Triggers an event by a given label for a given {@code groupid:artifactid} notation. You can use only {@code artifactId} too.
+         *
+         * Feature related to messaging.
+         *
+         * @return true - if managed to run a trigger
+         */
+        boolean trigger(String ivyNotation, String labelName)
+
+        /**
+         * Triggers an event by a given label.
+         *
+         * Feature related to messaging.
+         *
+         * @return true - if managed to run a trigger
+         */
+        boolean trigger(String labelName)
+
+        /**
+         * Triggers all possible events.
+         *
+         * Feature related to messaging.
+         *
+         * @return true - if managed to run a trigger
+         */
+        boolean trigger()
+
+        /**
+         * Returns a mapping of ivy notation of a dependency to all the labels it has.
+         *
+         * Feature related to messaging.
+         */
+        Map<String, Collection<String>> labels()
+}
+
+
+
+

For convenience the StubFinder interface extends StubTrigger so it’s enough to use only one in your tests.

+
+
+

StubTrigger gives you the following options to trigger a message:

+
+
+

Trigger by label

+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+
Trigger by group and artifact ids
+
+
+
stubFinder.trigger('io.codearte.accurest.stubs:camelService', 'return_book_1')
+
+
+
+
+
Trigger by artifact ids
+
+
+
stubFinder.trigger('camelService', 'return_book_1')
+
+
+
+
+
Trigger all messages
+
+
+
stubFinder.trigger()
+
+
+
+
+
+
+

Stub Runner Messaging Camel

+
+

Accurest 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

+
+

To use it you have to add the following dependency to your project (example for Gradle):

+
+
+
+
testCompile "io.codearte.accurest:stub-runner-messaging-camel:${accurestVersion}"
+
+
+
+
+

Examples

+
+
Stubs structure
+
+

Let us assume that we have the following Maven repository with a deployed stubs for the +camelService application.

+
+
+
+
└── .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:

+
+
+
+
├── META-INF
+│   └── MANIFEST.MF
+└── repository
+    ├── accurest
+    │   ├── bookDeleted.groovy
+    │   ├── bookReturned1.groovy
+    │   └── bookReturned2.groovy
+    └── mappings
+
+
+
+

Let’s consider the following contracts (let' number it with 1):

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_1'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('jms:output')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and number 2

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_2'
+        input {
+                messageFrom('jms:input')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('jms:output')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+
+
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

+
+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+

Next we’ll want to listen to the output of the message sent to jms:output

+
+
+
+
Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000)
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertThatBodyContainsBookNameFoo(receivedMessage.in.body)
+receivedMessage.in.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 2 (output triggered by input)
+
+

Since the route is set for you it’s enough to just send a message to the jms:output destination.

+
+
+
+
camelContext.createProducerTemplate().sendBodyAndHeaders('jms:input', new BookReturned('foo'), [sample: 'header'])
+
+
+
+

Next we’ll want to listen to the output of the message sent to jms:output

+
+
+
+
Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000)
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertThatBodyContainsBookNameFoo(receivedMessage.in.body)
+receivedMessage.in.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 3 (input with no output)
+
+

Since the route is set for you it’s enough to just send a message to the jms:output destination.

+
+
+
+
camelContext.createProducerTemplate().sendBodyAndHeaders('jms:delete', new BookReturned('foo'), [sample: 'header'])
+
+
+
+
+
+
+

Stub Runner Messaging Integration

+
+

Accurest Stub Runner’s messaging module gives you an easy way to integrate with Spring Integration. +For the provided artifacts it will automatically download the stubs and register the required +routes.

+
+
+

Adding it to the project

+
+

To use it you have to add the following dependency to your project (example for Gradle):

+
+
+
+
testCompile "io.codearte.accurest:stub-runner-messaging-integration:${accurestVersion}"
+
+
+
+
+

Examples

+
+
Stubs structure
+
+

Let us assume that we have the following Maven repository with a deployed stubs for the +integrationService application.

+
+
+
+
└── .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
+
+
+
+

And the stubs contain the following structure:

+
+
+
+
├── META-INF
+│   └── MANIFEST.MF
+└── repository
+    ├── accurest
+    │   ├── bookDeleted.groovy
+    │   ├── bookReturned1.groovy
+    │   └── bookReturned2.groovy
+    └── mappings
+
+
+
+

Let’s consider the following contracts (let' number it with 1):

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_1'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('output')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and number 2

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_2'
+        input {
+                messageFrom('input')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('output')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and the following Spring Integration Route:

+
+
+
+
<?xml version="1.0" encoding="UTF-8"?>
+<beans:beans xmlns="http://www.springframework.org/schema/integration"
+                         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                         xmlns:beans="http://www.springframework.org/schema/beans"
+                         xsi:schemaLocation="http://www.springframework.org/schema/beans
+                        http://www.springframework.org/schema/beans/spring-beans.xsd
+                        http://www.springframework.org/schema/integration
+                        http://www.springframework.org/schema/integration/spring-integration.xsd">
+
+
+        <!-- REQUIRED FOR TESTING -->
+        <bridge input-channel="output"
+                        output-channel="outputTest"/>
+
+        <channel id="outputTest">
+                <queue/>
+        </channel>
+
+</beans:beans>
+
+
+
+
+
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

+
+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+

Next we’ll want to listen to the output of the message sent to output

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('outputTest')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 2 (output triggered by input)
+
+

Since the route is set for you it’s enough to just send a message to the output destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'input')
+
+
+
+

Next we’ll want to listen to the output of the message sent to output

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('outputTest')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 3 (input with no output)
+
+

Since the route is set for you it’s enough to just send a message to the input destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'delete')
+
+
+
+
+
+
+

Stub Runner Messaging Stream

+
+

Accurest Stub Runner’s messaging module gives you an easy way to integrate with Spring Stream. +For the provided artifacts it will automatically download the stubs and register the required +routes.

+
+
+ + + + + +
+ + +In Stub Runner’s integration with Stream the messageFrom or sentTo Strings are resolved +first as a destination of a channel, and then if there is no such destination it’s resolved as a +channel name. +
+
+
+

Adding it to the project

+
+

To use it you have to add the following dependency to your project (example for Gradle):

+
+
+
+
testCompile "io.codearte.accurest:stub-runner-messaging-stream:${accurestVersion}"
+
+
+
+
+

Examples

+
+
Stubs structure
+
+

Let us assume that we have the following Maven repository with a deployed stubs for the +streamService application.

+
+
+
+
└── .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
+
+
+
+

And the stubs contain the following structure:

+
+
+
+
├── META-INF
+│   └── MANIFEST.MF
+└── repository
+    ├── accurest
+    │   ├── bookDeleted.groovy
+    │   ├── bookReturned1.groovy
+    │   └── bookReturned2.groovy
+    └── mappings
+
+
+
+

Let’s consider the following contracts (let' number it with 1):

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_1'
+        input {
+                triggeredBy('bookReturnedTriggered()')
+        }
+        outputMessage {
+                sentTo('returnBook')
+                body('''{ "bookName" : "foo" }''')
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and number 2

+
+
+
+
io.codearte.accurest.dsl.GroovyDsl.make {
+        label 'return_book_2'
+        input {
+                messageFrom('bookStorage')
+                messageBody([
+                                bookName: 'foo'
+                ])
+                messageHeaders {
+                        header('sample', 'header')
+                }
+        }
+        outputMessage {
+                sentTo('returnBook')
+                body([
+                                bookName: 'foo'
+                ])
+                headers {
+                        header('BOOK-NAME', 'foo')
+                }
+        }
+}
+
+
+
+

and the following Spring configuration:

+
+
+
+
stubrunner.stubs.repository.root: classpath:m2repo/repository/
+stubrunner.stubs.ids: io.codearte.accurest.stubs:streamService:0.0.1-SNAPSHOT:stubs
+
+spring:
+  cloud:
+    stream:
+      bindings:
+        output:
+          destination: returnBook
+        input:
+          destination: bookStorage
+
+
+
+
+
Scenario 1 (no input message)
+
+

So as to trigger a message via the return_book_1 label we’ll use the StubTrigger interface as follows

+
+
+
+
stubFinder.trigger('return_book_1')
+
+
+
+

Next we’ll want to listen to the output of the message sent to a channel whose destination is returnBook

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('returnBook')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 2 (output triggered by input)
+
+

Since the route is set for you it’s enough to just send a message to the bookStorage destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'bookStorage')
+
+
+
+

Next we’ll want to listen to the output of the message sent to returnBook

+
+
+
+
AccurestMessage receivedMessage = messaging.receiveMessage('returnBook')
+
+
+
+

And the received message would pass the following assertions

+
+
+
+
receivedMessage != null
+assertJsons(receivedMessage.payload)
+receivedMessage.headers.get('BOOK-NAME') == 'foo'
+
+
+
+
+
Scenario 3 (input with no output)
+
+

Since the route is set for you it’s enough to just send a message to the output destination.

+
+
+
+
messaging.send(new BookReturned('foo'), [sample: 'header'], 'delete')
+
+
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Deps.png b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Deps.png new file mode 100644 index 0000000000..1426814308 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Deps.png differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Stubs1.png b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Stubs1.png new file mode 100644 index 0000000000..ebadfdb910 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Stubs1.png differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Stubs2.png b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Stubs2.png new file mode 100644 index 0000000000..e4bad24987 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/images/Stubs2.png differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/index.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/index.adoc new file mode 120000 index 0000000000..28dc0a7e0c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/index.adoc @@ -0,0 +1 @@ +spring-cloud-contract-verifier.adoc \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/introduction.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/introduction.adoc new file mode 100644 index 0000000000..86eb75f37d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/introduction.adoc @@ -0,0 +1,148 @@ +:images_url: https://raw.githubusercontent.com/Codearte/accurest/master/docs/src/main/asciidoc/images + +== Introduction + +IMPORTANT: http://codearte.github.io/accurest/deprecated[The documentation to the deprecated Accurest project in version 1.1.0 is available here.] + +TIP: The Accurest project was initially started by Marcin Grzejszczak and Jakub Kubrynski (http://codearte.io[codearte.io]) + +Just to make long story short - Spring Cloud Contract Verifier is a tool that enables Consumer Driven Contract (CDC) development of JVM-based applications. It is shipped +with __Contract Definition Language__ (DSL). Contract definitions are used to produce following resources: + +* 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, test data is produced by Spring Cloud Contract Verifier. +* Messaging routes if you're using one. We're integrating with Spring Integration, Spring Cloud Stream and Apache Camel. You can however set your own integrations if you want to +* Acceptance tests (in JUnit or Spock) used to verify if server-side implementation of the API is compliant with the contract (__server tests__). +Full test is generated by Spring Cloud Contract Verifier. + +Spring Cloud Contract Verifier moves TDD to the level of software architecture. + +=== Why? + +Let us assume that we have a system comprising of multiple microservices: + +image::{images_url}/Deps.png[Microservices Architecture] + +==== Testing issues + +If we wanted to test the application in top left corner if it can communicate with other services then we could do one of two things: + +- deploy all microservices and perform end to end tests +- mock other microservices in unit / integration tests + +Both have their advantages but also a lot of disadvantages. Let's focus on the latter. + +*Deploy all microservices and perform end to end tests* + +Advantages: + +- simulates production +- tests real communication between services + +Disadvantages: + +- to test one microservice we would have to deploy 6 microservices, a couple of databases etc. +- the environment where the tests would be conducted would be locked for a single suite of tests (i.e. nobody else would be able to run the tests in the meantime). +- long to run +- very late feedback +- extremely hard to debug + +*Mock other microservices in unit / integration tests* + +Advantages: + +- very fast feedback +- no infrastructure requirements + +Disadvantages: + +- the implementor of the service creates stubs thus they might have nothing to do with the reality +- you can go to production with passing tests and failing production + +To solve the aforementioned issues Spring Cloud Contract Verifier with Stub Runner were created. Their main idea is to give you very fast feedback, without the need +to set up the whole world of microservices. + +image::{images_url}/Stubs1.png[Stubbed Services] + +If you work on stubs then the only applications you need are those that your application is using directly. + +image::{images_url}/Stubs2.png[Stubbed Services] + +Spring Cloud Contract Verifier gives you the certainty that the stubs that you're using were created by the service that you're calling. Also if you can use them it means that they were +tested against the producer's side. In other words - you can trust those stubs. + + +=== Purposes + +The main purposes of Spring Cloud Contract Verifier with Stub Runner are: + + - to ensure that WireMock / Messaging stubs (used when developing the client) are doing exactly what actual server-side implementation will do, + - 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 generate boilerplate test code used on the server side. + +=== Client Side + +During the tests you want to have a Wiremock instance / Messaging route up and running that simulates the service Y. +You would like to feed that instance with a proper stub definition. That stub definition would need +to be valid and should also be reusable on the server side. + +__Summing it up:__ On this side, in the stub definition, you can use patterns for request stubbing and you need exact +values for responses. + +=== Server Side + +Being a service Y since you are developing your stub, you need to be sure that it's actually resembling your +concrete implementation. You can't have a situation where your stub acts in one way and your application on +production behaves in a different way. + +That's why from the provided stub acceptance tests will be generated that will ensure +that your application behaves in the same way as you define in your stub. + +__Summing it up:__ On this side, in the stub definition, you need exact values as request and can use patterns/methods +for response verification. + +=== Dependencies + +Spring Cloud Contract Verifier and Stub Runner are using the following libraries + +- http://wiremock.org/[WireMock] +- https://github.com/jayway/JsonPath[Jayway JSONPath] +- https://github.com/marcingrzejszczak/jsonassert[JSONAssert from Marcin Grzejszczak] + +=== Additional links + +Below you can find some resources related to Spring Cloud Contract Verifier and Stub Runner. Note that some can be outdated since the Spring Cloud Contract Verifier project +is under constant development. + +==== Videos + +*Olga Maciaszek-Sharma talking about Accurest (Spring Cloud Contract Verifier predecessor)* + +video::daafmTYFoDU[youtube] + +*Marcin Grzejszczak and Jakub Kubryński talking about Accurest (Spring Cloud Contract Verifier predecessor)* + +video::130779882[vimeo] + +==== Readings + +- http://www.slideshare.net/MarcinGrzejszczak/stick-to-the-rules-consumer-driven-contracts-201507-confitura[Slides from Marcin Grzejszczak's talk about Accurest] +- http://toomuchcoding.com/blog/categories/accurest/[Accurest related articles from Marcin Grzejszczak's blog] + +=== Samples + +Here you can find some https://github.com/Codearte/accurest-samples[working samples]. Check the readme of each project for more information. + +=== Why use Spring Cloud Contract Verifier and not X ? + +For the time being Spring Cloud Contract Verifier 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 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/links.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/links.adoc new file mode 100644 index 0000000000..e8e1df762b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/links.adoc @@ -0,0 +1,11 @@ +== Links + +Here you can find interesting links related to Spring Cloud Contract Verifier: + +- https://github.com/Codearte/accurest[Spring Cloud Contract Verifier Github Repository] +- http://codearte.github.io/accurest[Spring Cloud Contract Verifier Documentation] +- http://codearte.github.io/accurest/deprecated[Accurest Legacy Documentation] +- https://codearte.github.io/accurest/#spring-cloud-contract-stub-runner[Spring Cloud Contract Stub Runner Documentation] +- http://codearte.github.io/accurest/#stub-runner-for-messaging[Spring Cloud Contract Stub Runner Messaging Documentation] +- https://gitter.im/Codearte/accurest[Spring Cloud Contract Verifier Gitter] +- https://github.com/Codearte/accurest-maven-plugin[Spring Cloud Contract Verifier Maven Plugin] diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/messaging.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/messaging.adoc new file mode 100644 index 0000000000..24bc2bc272 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/messaging.adoc @@ -0,0 +1,150 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core + +== Spring Cloud Contract Verifier Messaging + +Spring Cloud Contract Verifier allows you to verify your application that uses messaging as means of communication. +All of our integrations are working with Spring but you can also set one yourself. + +=== Integrations + +You can use one of the three integration configurations: + +- Apache Camel +- Spring Integration +- Spring Cloud Stream + +If you're using Spring Boot, the aforementioned test configurations will be appended automatically. + +You have to provide as a dependency one of the Spring Cloud Contract Verifier Messaging modules. Example for Gradle: + +[source,groovy,indent=0] +---- +// for Apache Camel +testCompile "org.springframework.cloud.contract:spring-cloud-contract-verifier-camel:${verifierVersion}" +// for Spring Integration +testCompile "org.springframework.cloud.contract:spring-cloud-contract-verifier-integration:${verifierVersion}" +// for Spring Cloud Stream +testCompile "org.springframework.cloud.contract:spring-cloud-contract-verifier-stream:${verifierVersion}" +---- + +=== Manual Integration + +The `spring-cloud-contract-verifier-messaging-core` module contains 3 main interfaces: + +- `ContractVerifierMessage` - describes a message received / sent to a channel / queue / topic etc. +- `ContractVerifierMessageBuilder` - describes how to build a message +- `ContractVerifierMessaging` - class that allows you to build, send and receive messages +- `ContractVerifierFilter` - interface to filter out the messages that do not follow the pattern from the DSL + +In the generated test the `ContractVerifierMessaging` is injected via `@Inject` annotation thus you can use other injection +frameworks than Spring. + +You have to provide as a dependency the `spring-cloud-contract-verifier-messaging-core` module. Example for Gradle: + +[source,groovy,indent=0] +---- +testCompile "org.springframework.cloud.contract:spring-cloud-contract-verifier-messaging-core:${verifierVersion}" +---- + +=== Publisher side test generation + +Having the `input` or `outputMessage` sections in your DSL will result in creation of tests on the publisher's side. By default +JUnit tests will be created, however there is also a possibility to create Spock tests. + +There are 3 main scenarios that we should take into consideration: + +- Scenario 1: there is no input message that produces an output one. The output message is triggered by a component +inside the application (e.g. scheduler) +- Scenario 2: the input message triggers an output message +- Scenario 3: the input message is consumed and there is no output message + +==== Scenario 1 (no input message) + +For the given contract: + +[source,groovy] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_method_dsl] +---- + +The following JUnit test will be 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: + +[source,groovy] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_message_dsl] +---- + +The following JUnit test will be 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: + +[source,groovy] +---- +include::{verifier_core_path}/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy[tags=trigger_no_output_dsl] +---- + +The following JUnit test will be 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 Side generation + +Unlike the HTTP part - in Messaging we need to publish the Groovy DSL inside the JAR with a stub. Then it's parsed on the consumer side +and proper stubbed routes are created. + +For more infromation please consult the Stub Runner Messaging sections. + +==== Gradle Setup + +Example of Spring Cloud Contract Verifier Gradle setup: + +[source,groovy,indent=0] +---- +include::{verifier_root_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0] +---- + +==== Maven Setup + +Example of Maven can be found in the https://github.com/Codearte/accurest-maven-plugin/=publishing-wiremock-stubs-projectf-stubsjar[Spring Cloud Contract Verifier Maven Plugin README] diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/rest.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/rest.adoc new file mode 100644 index 0000000000..843d396ec6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/rest.adoc @@ -0,0 +1,437 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core + +== Spring Cloud Contract Verifier HTTP + +=== Gradle Project + +==== Prerequisites + +In order to use Spring Cloud Contract Verifier with Wiremock you have to use gradle or maven plugin. + +===== Add gradle plugin + +[source,groovy,indent=0] +---- +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath 'org.springframework.cloud.contract:spring-cloud-contract-verifier-gradle-plugin:${verifier_version}' + } +} + +apply plugin: 'groovy' +apply plugin: 'contract-verifier' + +dependencies { + testCompile 'org.codehaus.groovy:groovy-all:2.4.6' + testCompile 'org.spockframework:spock-core:1.0-groovy-2.4' + testCompile 'com.jayway.restassured:spring-mock-mvc:2.9.0' // needed if you're going to use Spring MockMvc +} +---- + +====== Snapshot versions + +Add the additional snapshot repository to your build.gradle to use snapshot versions which are automatically uploaded after every successful build: + +[source,groovy,indent=0] +---- +repositories { + (...) + //Required only for SNAPSHOT versions + maven { url "https://repo.spring.io/plugins-snapshot-local" } +} +---- + +===== Add maven plugin + +[source,xml,indent=0] +---- + + org.springframework.cloud.contract + spring-cloud-contract-verifier-maven-plugin + + + + convert + generateStubs + generateTests + + + + +---- + + +Read more: http://codearte.github.io/accurest-maven-plugin/[spring-cloud-contract-verifier-maven-plugin] + +===== Add stubs + +By default Spring Cloud Contract Verifier is looking for stubs in `src/test/resources/contracts` directory. + +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 which will be used as test class name. If there is more than one level of nested directories all except the last one will be used as package name. +So 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 will create test class `defaultBasePackage.MyService` with two methods + + - `shouldCreateUser()` + - `shouldReturnUser()` + +==== Run plugin + +Plugin registers itself to be invoked before `check` task. You have nothing to do as long as you want it to be part of your build process. If you just want to generate tests please invoke `generateContractTests` task. + +==== Default setup + +Default Gradle Plugin setup creates the following Gradle part of the build (it's a pseudocode) + +[source,groovy,indent=0] +---- +contractVerifier { + targetFramework = 'JUNIT' + testMode = 'MockMvc' + generatedTestSourcesDir = project.file("${project.buildDir}/generated-test-sources/contracts") + contractsDslDir = "${project.rootDir}/src/test/resources/contracts" + basePackageForTests = 'org.springframework.cloud.contract.verifier.tests' + stubsOutputDir = project.file("${project.buildDir}/stubs") +} + +tasks.create(type: Jar, name: 'verifierStubsJar', dependsOn: 'generateWireMockClientStubs') { + baseName = project.name + classifier = contractVerifier.stubsSuffix + from contractVerifier.stubsOutputDir +} + +project.artifacts { + archives task +} + +tasks.create(type: Copy, name: 'copyContracts') { + from contractVerifier.contractsDslDir + into contractVerifier.stubsOutputDir +} + +verifierStubsJar.dependsOn 'copyContracts' + +publishing { + publications { + stubs(MavenPublication) { + artifactId project.name + artifact verifierStubsJar + } + } +} +---- + +==== Configure plugin + +To change default configuration just add `contractVerifier` snippet to your Gradle config + +[source,groovy,indent=0] +---- +contractVerifier { + testMode = 'MockMvc' + baseClassForTests = 'org.mycompany.tests' + generatedTestSourcesDir = project.file('src/generatedContract') +} +---- + +===== Configuration options + + - **testMode** - defines mode for acceptance tests. By default MockMvc which is based on Spring's MockMvc. It can also be changed to **JaxRsClient** or to **Explicit** for real HTTP calls. + - **imports** - array with imports that should be included in generated tests (for example ['org.myorg.Matchers']). By default empty array [] + - **staticImports** - array with static imports that should be included in generated tests(for example ['org.myorg.Matchers.*']). By default empty array [] + - **basePackageForTests** - specifies base package for all generated tests. By default set to org.springframework.cloud.contract.verifier.tests + - **baseClassForTests** - base class for generated tests. By default `spock.lang.Specification` if using Spock tests. + - **ruleClassForTests** - specifies Rule which should be added to generated test classes. + - **ignoredFiles** - Ant matcher allowing defining stub files for which processing should be skipped. By default empty array [] + - **contractsDslDir** - directory containing contracts written using the GroovyDSL. By default `$rootDir/src/test/resources/contracts` + - **generatedTestSourcesDir** - test source directory where tests generated from Groovy DSL should be placed. By default `$buildDir/generated-test-sources/contractVerifier` + - **stubsOutputDir** - dir where the generated WireMock stubs from Groovy DSL should be placed + - **targetFramework** - the target test framework to be used; currently Spock and JUnit are supported with JUnit being the default framework + +===== Base class for 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 endpoint which should be verified. + +[source,groovy,indent=0] +---- +include::{verifier_root_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy[tags=base_class,indent=0] +---- + +In case of using `Explicit` mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of `JAXRSCLIENT` mode this base class +should also contain `protected WebTarget webTarget` field, right now the only option to test JAX-RS API is to start a web server. + +==== Invoking generated tests + +To ensure that provider side is complaint with defined contracts, you need to invoke: + +[source,bash,indent=0] +---- +./gradlew generateContractTests test +---- + +==== Spring Cloud Contract Verifier on consumer side + +In consumer service you need to configure Spring Cloud Contract Verifier plugin in exactly the same way as in case of provider. If you don't 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 generateWireMockClientStubs +---- + +Note that `stubsOutputDir` option has to be set for stub generation to work. + +When present, json stubs can be used in consumer automated tests. + +[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(pesel: '12345678901'), amount: 123.123) + when: + LoanApplicationResult loanApplication == sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus === LoanApplicationStatus.LOAN_APPLIED + loanApplication.rejectionReason === null + } +} +---- + +Underneath LoanApplication makes a call to FraudDetection service. This request is handled by Wiremock server configured using stubs generated by Spring Cloud Contract Verifier. + +=== Using in your Maven project + +==== Add maven plugin + +[source,xml,indent=0] +---- + + org.springframework.cloud.contract.verifier + spring-cloud-contract-verifier-maven-plugin + + + + convert + generateStubs + generateTests + + + + +---- + +Read more: http://codearte.github.io/accurest-maven-plugin/[spring-cloud-contract-verifier-maven-plugin] + +==== Add stubs + +By default Spring Cloud Contract Verifier is looking for stubs in `src/test/resources/contracts` directory. +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 which will be used as test class name. If there is more than one level of nested directories all except the last one will be used as package name. +So 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 will create test class `defaultBasePackage.MyService` with two methods + - `shouldCreateUser()` + - `shouldReturnUser()` + +==== Run plugin + +Plugin goal `generateTests` is assigned to be invoked in phase `generate-test-sources`. You have nothing to do as long as you want it to be part of your build process. If you just want to generate tests please invoke `generateTests` goal. + +==== Configure plugin + +To change default configuration just add `configuration` section to plugin definition or `execution` definition. + +[source,xml,indent=0] +---- + + org.springframework.cloud.contract.verifier + spring-cloud-contract-verifier-maven-plugin + + + + convert + generateStubs + generateTests + + + + + org.springframework.cloud.contract.verifier.twitter.place + org.springframework.cloud.contract.verifier.twitter.place.BaseMockMvcSpec + + +---- + +===== Important configuration options + + - **testMode** - defines mode for acceptance tests. By default `MockMvc` which is based on Spring's MockMvc. It can also be changed to `JaxRsClient` or to `Explicit` for real HTTP calls. + - **basePackageForTests** - specifies base package for all generated tests. By default set to `org.springframework.cloud.contract.verifier.tests`. + - **ruleClassForTests** - specifies Rule which should be added to generated test classes. + - **baseClassForTests** - base class for generated tests. By default `spock.lang.Specification` if using Spock tests. + - **contractsDir** - directory containing contracts written using the GroovyDSL. By default `/src/test/resources/contracts`. + - **testFramework** - the target test framework to be used; currently Spock and JUnit are supported with Spock being the default framework + +For complete information take a look at http://codearte.github.io/accurest-maven-plugin/plugin-info.html[Plugin Documentation] + +===== Base class for 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 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()) + } +} +---- + +In case of using `Explicit` mode, you can use base class to initialize the whole tested app similarly as in regular integration tests. In case of `JAXRSCLIENT` mode this base class should also contain `protected WebTarget webTarget` field, right now the only option to test JAX-RS API is to start a web server. + +==== Invoking generated tests + +Spring Cloud Contract Verifier Maven Plugins generates verification code into directory `/generated-test-sources/contractVerifier` and attach this directory to `testCompile` goal. + +For Groovy Spock code use: + +[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 complaint with defined contracts, you need to invoke `mvn generateTest test` + +==== Spring Cloud Contract Verifier on consumer side + +In consumer service you need to configure Spring Cloud Contract Verifier plugin in exactly the same way as in case of provider. You need to copy contracts stored in `src/test/resources/contracts` and generate Wiremock json stubs using: `mvn generateStubs` command. By default generated WireMock mapping is stored in directory `target/mappings`. Your project should create from this generated mappings additional artifact with classifier `stubs` for easy deploy to maven repository. + +Sample configuration: + +[source,xml,indent=0] +---- + + org.springframework.cloud.contract.verifier + spring-cloud-contract-verifier-maven-plugin + ${verifier-plugin.version} + + + + convert + generateStubs + + + + +---- + +When present, json stubs can be used in consumer automated tests. + +[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(pesel: '12345678901'), amount: 123.123) + when: + LoanApplicationResult loanApplication == sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus === LoanApplicationStatus.LOAN_APPLIED + loanApplication.rejectionReason === null + } +} +---- + +Underneath LoanApplication makes a call to FraudDetection service. This request is handled by Wiremock server configured using stubs generated by Spring Cloud Contract Verifier. + +=== Scenarios + +It's possible to handle scenarios with Spring Cloud Contract Verifier. All you need to do is to stick to proper naming convention while creating your contracts. The convention requires to include order number followed by the underscore. + +[source,indent=0] +---- +my_contracts_dir\ + scenario1\ + 1_login.groovy + 2_showCart.groovy + 3_logout.groovy +---- + +Such tree will cause Spring Cloud Contract Verifier generating Wiremock's scenario with name `scenario1` and three 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 under [http://wiremock.org/stateful-behaviour.html](http://wiremock.org/stateful-behaviour.html) + +Spring Cloud Contract Verifier will also generate tests with guaranteed order of execution. diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/spring-cloud-contract-verifier.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/spring-cloud-contract-verifier.adoc new file mode 100644 index 0000000000..96cc64d927 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/spring-cloud-contract-verifier.adoc @@ -0,0 +1,22 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core +:stubrunner_core_path: {core_path}/spring-cloud-contract-stub-runner + += Spring Cloud Contract Verifier + +_Documentation Authors: Adam Dudczak, Marcin Grzejszczak, Jakub Kubryński, Karol Lassak, Olga Maciaszek-Sharma, Mariusz Smykuła_ + +include::introduction.adoc[] + +include::contract.adoc[] + +include::rest.adoc[] + +include::messaging.adoc[] + +include::stubrunner.adoc[] + +include::stubrunner_msg.adoc[] + +include::links.adoc[] \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/stubrunner.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/stubrunner.adoc new file mode 100644 index 0000000000..6ba4fb98f9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/stubrunner.adoc @@ -0,0 +1,97 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core + +== Spring Cloud Contract Stub Runner + +One of the issues that you could have encountered while using Spring Cloud Contract Verifier was to pass the generated WireMock JSON stubs from the server side to the client side (or various clients). + The same takes place in terms of client side generation for messaging. + +Copying the JSON files / setting the client side for messaging manually is out of the question. + +=== Snapshot versions + +Add the additional snapshot repository to your build.gradle to use snapshot versions which are automatically uploaded after every successful build: + +[source,groovy,indent=0] +---- +repositories { + (...) + //Required only for SNAPSHOT versions + maven { url "https://repo.spring.io/libs-snapshot-local" } +} +---- + +=== 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. + +==== Gradle + +Example of Spring Cloud Contract Verifier Gradle setup: + +[source,groovy,indent=0] +---- +include::{verifier_root_path}/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle[tags=jar_setup,indent=0] +---- + +==== Maven + +Example of Maven can be found in the https://github.com/Codearte/accurest-maven-plugin/=publishing-wiremock-stubs-projectf-stubsjar[Spring Cloud Contract Verifier Maven Plugin README] + +=== Modules + +Spring Cloud Contract Stub Runner comes with a new structure of modules + +[source,indent=0] +---- +└── spring-cloud-contract-stub-runner + ├── spring-cloud-contract-stub-runner + ├── spring-cloud-contract-stub-runner-boot + ├── spring-cloud-contract-stub-runner-junit + ├── spring-cloud-contract-stub-runner-spring + └── spring-cloud-contract-stub-runner-spring-cloud +---- + +include::../../../../spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/README.adoc[] + +include::../../../../spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/README.adoc[] + +include::../../../../spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/README.adoc[] + +include::../../../../spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/README.adoc[] + +include::../../../../spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/README.adoc[] + + +=== Common properties for JUnit and Spring + +Some of the properties that are repetitive can be set using system properties or property sources (for Spring). Here are their names with their default values: + +[frame="topbot",options="header"] +|====================== +| Property name | Default value | Description +|stubrunner.port.range.min|10000| Minimal value of a port for a started WireMock with stubs +|stubrunner.port.range.max|15000| Minimal value of a port for a started WireMock with stubs +|stubrunner.stubs.repository.root|| Comma separated list of Maven repo urls. If blank then will call the local maven repo +|stubrunner.stubs.classifier|stubs| Default classifier for the stub artifacts +|stubrunner.work-offline|false| If true then will not contact any remote repositories to download stubs +|stubrunner.stubs.ids|| Comma separated list of Ivy notation of stubs to download +|====================== + +==== Stub runner stubs ids + +You can provide the stubs to download via the `stubrunner.stubs.ids` system property. They follow the following pattern: + +[source,java,indent=0] +---- +groupId:artifactId:version:classifier:port +---- + +`version`, `classifier` and `port` are optional. + +* If you don't provide the `port` then a random one will be picked +* If you don't provide the `classifier` then the default one will be taken. +* If you don't provide the `version` then the `+` will be passed and the latest one will be downloaded + +Where `port` means the port of the WireMock server. \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/stubrunner_msg.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/stubrunner_msg.adoc new file mode 100644 index 0000000000..194076d611 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/asciidoc/stubrunner_msg.adoc @@ -0,0 +1,61 @@ +:core_path: ../../../.. +:verifier_root_path: {core_path}/spring-cloud-contract-verifier +:verifier_core_path: {verifier_root_path}/spring-cloud-contract-verifier-core +:stubrunner_core_path: {core_path}/spring-cloud-contract-stub-runner + +== Stub Runner for Messaging + +Stub Runner has the functionality to run the published stubs in memory. It can integrate with the following frameworks out of the box + +- Spring Integration +- Spring Cloud Stream +- Apache Camel + +It also provides points of entry to integrate with any other solution on the market. + +=== Stub triggering + +To trigger a message it's enough to use the `StubTrigger` interface: + +[source,groovy] +---- +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubTrigger.groovy[] +---- + +For convenience the `StubFinder` interface extends `StubTrigger` so it's enough to use only one in your tests. + +`StubTrigger` gives you the following options to trigger a message: + +==== Trigger by label + +[source,groovy] +---- +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=client_trigger,indent=0] +---- + +===== Trigger by group and artifact ids + +[source,groovy] +---- +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=trigger_group_artifact,indent=0] +---- + +===== Trigger by artifact ids + +[source,groovy] +---- +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=trigger_artifact,indent=0] +---- + +===== Trigger all messages + +[source,groovy] +---- +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy[tags=trigger_all,indent=0] +---- + +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/README.adoc[] + +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/README.adoc[] + +include::{stubrunner_core_path}/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/README.adoc[] \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/ruby/generate_readme.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/ruby/generate_readme.sh new file mode 100755 index 0000000000..6d0ce9dc54 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/docs/src/main/ruby/generate_readme.sh @@ -0,0 +1,37 @@ +#!/usr/bin/env ruby + +base_dir = File.join(File.dirname(__FILE__),'../../..') +src_dir = File.join(base_dir, "/src/main/asciidoc") +require 'asciidoctor' +require 'optparse' + +options = {} +file = "#{src_dir}/README.adoc" + +OptionParser.new do |o| + o.on('-o OUTPUT_FILE', 'Output file (default is stdout)') { |file| options[:to_file] = file unless file=='-' } + o.on('-h', '--help') { puts o; exit } + o.parse! +end + +file = ARGV[0] if ARGV.length>0 + +# Copied from https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/scripts/asciidoc-coalescer.rb +doc = Asciidoctor.load_file file, safe: :unsafe, header_only: true, attributes: options[:attributes] +header_attr_names = (doc.instance_variable_get :@attributes_modified).to_a +header_attr_names.each {|k| doc.attributes[%(#{k}!)] = '' unless doc.attr? k } +attrs = doc.attributes +attrs['allow-uri-read'] = true +puts attrs + +out = "// Do not edit this file (e.g. go instead to src/main/asciidoc)\n\n" +doc = Asciidoctor.load_file file, safe: :unsafe, parse: false, attributes: attrs +out << doc.reader.read + +unless options[:to_file] + puts out +else + File.open(options[:to_file],'w+') do |file| + file.write(out) + end +end diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/generateReadme.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/generateReadme.sh new file mode 100755 index 0000000000..1638d7b172 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/generateReadme.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +./gradlew :docs:clean :docs:generateReadme --configure-on-demand \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle.properties new file mode 100644 index 0000000000..91057965e2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle.properties @@ -0,0 +1,33 @@ +# +# Copyright 2013-2016 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. +# + +nexusUsername = +nexusPassword = + +wiremockVersion = 2.0.10-beta +jsonassertVersion = 0.4.7 + +BOM_VERSION=Brixton-SR1 +springBootVersion=1.3.3.RELEASE +springVersion=4.2.5.RELEASE +springIntegrationDslVersion=1.1.2.RELEASE +springStreamVersion=1.0.0.RELEASE +springCloudVersion=1.1.0.RELEASE +springCloudZookeeperVersion=1.0.0.RELEASE +camelVersion=2.17.0 +aetherVersion=1.1.0 + +verifierVersion=1.0.0.BUILD-SNAPSHOT \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle/release.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle/release.gradle new file mode 100644 index 0000000000..ae90a8c9d7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle/release.gradle @@ -0,0 +1,92 @@ +apply plugin: 'maven' +apply plugin: 'signing' + +ext { + resolveRepoName = { Project project -> + String version = project.version + String name = project.name + String resolvedRepoName = "libs-${resolveVersion(version)}-local" + if (name.contains("gradle")) { + resolvedRepoName = "plugins-${resolveVersion(version)}-local" + } + logger.lifecycle("For project [$project.name] with " + + "version [$project.version] the resolved Artifactory repo is [$resolvedRepoName]") + return resolvedRepoName + } + + resolveVersion = { String version -> + if (version.endsWith('BUILD-SNAPSHOT')) return 'snapshot' + if (version.matches('[0-9].[0-9].[0-9].M[0-9]+')) return 'milestone' + if (version.matches('[0-9].[0-9].[0-9].RC[0-9]+')) return 'milestone' + if (version.endsWith('RELEASE')) return 'release' + return 'snapshot' + } + + isReleaseVersion = !version.endsWith("SNAPSHOT") +} + +uploadArchives.dependsOn { [check] } + +ext { + repositoryUrl = "https://repo.spring.io/${repoPrefix()}-${resolveVersion(version)}-local" + snapshotRepositoryUrl = "https://repo.spring.io/${repoPrefix()}-snapshot-local" + repoUrl = isReleaseVersion ? repositoryUrl : snapshotRepositoryUrl +} + +afterEvaluate { + uploadArchives { + repositories { + mavenDeployer { + // POM signature + if (isReleaseVersion) { + beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) } + } + // Target repository + repository(url: repoUrl) { + authentication(userName: repoUser, password: repoPass) + } + pom.project { + name "$project.name" + packaging 'jar' + description 'Consumer Driven Contract Verifier and Stub Runner' + url 'https://github.com/Codearte/accurest' + inceptionYear '2014' + + scm { + connection 'scm:git:git@github.com:Codearte/accurest.git' + developerConnection 'scm:git:git@github.com:Codearte/accurest.git' + url 'https://github.com/Codearte/accurest' + } + + licenses { + license { + name 'The Apache License, Version 2.0' + url 'http://www.apache.org/licenses/LICENSE-2.0.txt' + } + } + + developers { + developer { + id 'jkubrynski' + name 'Jakub Kubrynski' + email 'jk ATT codearte DOTT io' + } + developer { + id 'marcingrzejszczak' + name 'Marcin Grzejszczak' + email 'marcin ATT grzejszczak DOTT pl' + } + } + } + } + } + } +} + +String repoPrefix() { + return project.name.contains('gradle') ? 'plugins' : 'libs' +} + +if (projectsToSkipPublication.any { project.name.contains(it) }) { + uploadArchives.enabled = false +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle/wrapper/gradle-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..72e5e30b39 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Wed Jun 15 17:19:08 CEST 2016 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.14-bin.zip diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradlew b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradlew new file mode 100755 index 0000000000..9d82f78915 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradlew @@ -0,0 +1,160 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradlew.bat b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradlew.bat new file mode 100644 index 0000000000..5f192121eb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/publishDocs.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/publishDocs.sh new file mode 100755 index 0000000000..17ed699b55 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/publishDocs.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env bash + +./gradlew :docs:clean :docs:publishGhPages --configure-on-demand \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/build.gradle new file mode 100644 index 0000000000..bf8efc7f10 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/build.gradle @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-core") + compile "org.springframework.boot:spring-boot-starter-actuator:${springBootVersion}" + compile "org.apache.camel:camel-spring-boot-starter:${camelVersion}" + compile "org.apache.camel:camel-jms:${camelVersion}" + compile 'org.apache.activemq:activemq-camel:5.12.1' + compile 'org.apache.activemq:activemq-pool:5.12.1' + compile "org.apache.camel:camel-jackson:${camelVersion}" + + testCompile project(":$verifier-root:$verifier-messaging-root:$verifier-camel") + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookDeleted.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookDeleted.groovy new file mode 100644 index 0000000000..52af5fd871 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookDeleted.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookDeleted implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookDeleted(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookDeleter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookDeleter.groovy new file mode 100644 index 0000000000..c1ad517de9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookDeleter.groovy @@ -0,0 +1,44 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.apache.camel.Exchange +import org.springframework.stereotype.Component + +import java.util.concurrent.atomic.AtomicBoolean + +@CompileStatic +@Slf4j +@Component +class BookDeleter { + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + void bookDeleted(Exchange exchange) { + BookDeleted bookDeleted = exchange.in.getBody(BookDeleted) + log.info("Deleting book [$bookDeleted]") + bookSuccessfulyDeleted.set(true) + log.info("Book successfuly deleted [$bookSuccessfulyDeleted]") + } + + AtomicBoolean bookSuccessfulyDeleted = new AtomicBoolean(false) +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookReturned.groovy new file mode 100644 index 0000000000..373743a094 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookReturned.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookReturned implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookRouteConfiguration.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookRouteConfiguration.groovy new file mode 100644 index 0000000000..06ed844919 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookRouteConfiguration.groovy @@ -0,0 +1,53 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import org.apache.activemq.camel.component.ActiveMQComponent +import org.apache.camel.RoutesBuilder +import org.apache.camel.model.dataformat.JsonLibrary +import org.apache.camel.spring.SpringRouteBuilder +import org.springframework.beans.factory.annotation.Value +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration +/** + * @author Marcin Grzejszczak + */ +@Configuration +class BookRouteConfiguration { + + @Bean + ActiveMQComponent activeMQComponent(@Value('${activemq.url:vm://localhost?broker.persistent=false}') String url) { + return new ActiveMQComponent(brokerURL: url) + } + + @Bean + RoutesBuilder myRouter(BookService bookService, BookDeleter bookDeleter) { + return new SpringRouteBuilder() { + + @Override + public void configure() throws Exception { + // scenario 1 - from bean to output + from("direct:start").unmarshal().json(JsonLibrary.Jackson, BookReturned).bean(bookService).to("jms:output") + // scenario 2 - from input to output + from("jms:input").unmarshal().json(JsonLibrary.Jackson, BookReturned).bean(bookService).to("jms:output") + // scenario 3 - from input to no output + from("jms:delete").unmarshal().json(JsonLibrary.Jackson, BookDeleted).bean(bookDeleter) + } + + }; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookService.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookService.groovy new file mode 100644 index 0000000000..f60ec6fbe9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/BookService.groovy @@ -0,0 +1,44 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.apache.camel.Exchange +import org.springframework.stereotype.Service + +@Service +@CompileStatic +@Slf4j +class BookService { + + /** + Scenario for "should generate tests triggered by a method": + client side: must have a possibility to "trigger" sending of a message to the given messageFrom + server side: will run the method and await upon receiving message on the output messageFrom + + Method triggers sending a message to a source + */ + void returnBook(Exchange exchange) { + BookReturned bookReturned = exchange.in.getBody(BookReturned) + log.info("Returning book [$bookReturned]") + exchange.out.with { + body = bookReturned + setHeader('BOOK-NAME', bookReturned.bookName) + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/CamelMessagingApplication.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/CamelMessagingApplication.groovy new file mode 100644 index 0000000000..da6bddcb83 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/main/groovy/org/springframework/cloud/contract/verifier/samples/camel/CamelMessagingApplication.groovy @@ -0,0 +1,28 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import org.springframework.boot.SpringApplication +import org.springframework.boot.autoconfigure.SpringBootApplication + +@SpringBootApplication +class CamelMessagingApplication { + + static void main(String[] args) { + SpringApplication.run(CamelMessagingApplication.class, args) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/test/groovy/org/springframework/cloud/contract/verifier/samples/camel/CamelMessagingApplicationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/test/groovy/org/springframework/cloud/contract/verifier/samples/camel/CamelMessagingApplicationSpec.groovy new file mode 100644 index 0000000000..09f5a23df7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-camel/src/test/groovy/org/springframework/cloud/contract/verifier/samples/camel/CamelMessagingApplicationSpec.groovy @@ -0,0 +1,160 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.camel + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.apache.camel.model.ModelCamelContext +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification +import spock.util.concurrent.PollingConditions + +import javax.inject.Inject +/** + * SPIKE ON TESTS FROM NOTES IN MessagingSpec + */ +// Context configuration would end up in base class +@ContextConfiguration(classes = [CamelMessagingApplication], loader = SpringApplicationContextLoader) +public class CamelMessagingApplicationSpec extends Specification { + + // ALL CASES + @Inject ContractVerifierMessaging contractVerifierMessaging + ContractVerifierObjectMapper contractVerifierObjectMapper = new ContractVerifierObjectMapper() + + def "should work for triggered based messaging"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('activemq:output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + // generated test should look like this: + when: + bookReturnedTriggered() + then: + def response = contractVerifierMessaging.receiveMessage('activemq:output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + header('Content-Type', 'application/json') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'jms:input') + then: + def response = contractVerifierMessaging.receiveMessage('jms:output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests without destination, triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'jms:delete') + then: + noExceptionThrown() + bookWasDeleted() + } + + // BASE CLASS WOULD HAVE THIS: + + @Autowired ModelCamelContext camelContext + @Autowired BookDeleter bookDeleter + + void bookReturnedTriggered() { + camelContext.createProducerTemplate().sendBody('direct:start', '''{"bookName" : "foo" }''') + } + + PollingConditions pollingConditions = new PollingConditions() + + void bookWasDeleted() { + pollingConditions.eventually { + assert bookDeleter.bookSuccessfulyDeleted.get() + } + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/build.gradle new file mode 100644 index 0000000000..21eeaff00b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/build.gradle @@ -0,0 +1,28 @@ +/* + * Copyright 2013-2016 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. + */ +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-core") + compile "org.springframework.boot:spring-boot-starter-actuator:${springBootVersion}" + compile "org.springframework.boot:spring-boot-starter-integration:${springBootVersion}" + + testCompile project(":$verifier-root:$verifier-messaging-root:$verifier-integration") + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy new file mode 100644 index 0000000000..e43c21c9d2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookDeleted { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookDeleted(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy new file mode 100644 index 0000000000..e0041a8dcb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.messaging.Message +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder + +import java.util.concurrent.atomic.AtomicBoolean + +@CompileStatic +@Slf4j +class BookListener { + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + Message returnBook(BookReturned bookReturned) { + log.info("Returning book [$bookReturned]") + return MessageBuilder.createMessage(bookReturned, new MessageHeaders([ + 'BOOK-NAME': bookReturned.bookName as Object + ])) + } + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + void bookDeleted(BookDeleted bookDeleted) { + log.info("Deleting book [$bookDeleted]") + bookSuccessfulyDeleted.set(true) + } + + AtomicBoolean bookSuccessfulyDeleted = new AtomicBoolean(false) +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy new file mode 100644 index 0000000000..130c19d468 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookReturned { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy new file mode 100644 index 0000000000..888df79bce --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.beans.factory.annotation.Qualifier +import org.springframework.messaging.MessageChannel +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder +import org.springframework.stereotype.Service + +@Service +@CompileStatic +@Slf4j +class BookService { + + @Autowired @Qualifier("outputChannel") MessageChannel outputChannel + + /** + Scenario for "should generate tests triggered by a method": + client side: must have a possibility to "trigger" sending of a message to the given messageFrom + server side: will run the method and await upon receiving message on the output messageFrom + + Method triggers sending a message to a source + */ + void returnBook(BookReturned bookReturned) { + log.info("Returning book [$bookReturned]") + outputChannel.send(MessageBuilder.createMessage(bookReturned, new MessageHeaders([ + 'BOOK-NAME': bookReturned.bookName as Object + ]))) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplication.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplication.groovy new file mode 100644 index 0000000000..811fcbdfc3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplication.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import org.springframework.boot.SpringApplication +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.context.annotation.ImportResource + +@SpringBootApplication +@ImportResource("classpath*:integration-context.xml") +class IntegrationMessagingApplication { + + static void main(String[] args) { + SpringApplication.run(IntegrationMessagingApplication.class, args) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/resources/integration-context.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/resources/integration-context.xml new file mode 100644 index 0000000000..3dd916e22f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/main/resources/integration-context.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy new file mode 100644 index 0000000000..68eaf5009b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-integration/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/IntegrationMessagingApplicationSpec.groovy @@ -0,0 +1,168 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification + +import javax.inject.Inject +// Context configuration would end up in base class +@ContextConfiguration(classes = [IntegrationMessagingApplication], loader = SpringApplicationContextLoader) +public class IntegrationMessagingApplicationSpec extends Specification { + + // ALL CASES + @Inject ContractVerifierMessaging contractVerifierMessaging + ContractVerifierObjectMapper contractVerifierObjectMapper = new ContractVerifierObjectMapper() + + def "should work for triggered based messaging"() { + given: + // tag::method_trigger[] + def dsl = Contract.make { + // Human readable description + description 'Some description' + // Label by means of which the output message can be triggered + label 'some_label' + // input to the contract + input { + // the contract will be triggered by a method + triggeredBy('bookReturnedTriggered()') + } + // output message of the contract + outputMessage { + // destination to which the output message will be sent + sentTo('output') + // the body of the output message + body('''{ "bookName" : "foo" }''') + // the headers of the output message + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::method_trigger[] + // generated test should look like this: + when: + bookReturnedTriggered() + then: + def response = contractVerifierMessaging.receiveMessage('output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests triggered by a message"() { + given: + // tag::message_trigger[] + def dsl = Contract.make { + description 'Some Description' + label 'some_label' + // input is a message + input { + // the message was received from this destination + messageFrom('input') + // has the following body + messageBody([ + bookName: 'foo' + ]) + // and the following headers + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::message_trigger[] + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'input') + then: + def response = contractVerifierMessaging.receiveMessage('output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests without destination, triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'delete') + then: + noExceptionThrown() + bookWasDeleted() + } + + // BASE CLASS WOULD HAVE THIS: + + @Autowired BookService bookService + @Autowired BookListener bookListener + + void bookReturnedTriggered() { + bookService.returnBook(new BookReturned("foo")) + } + + void bookWasDeleted() { + assert bookListener.bookSuccessfulyDeleted.get() + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/build.gradle new file mode 100644 index 0000000000..dcc70f5e6e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/build.gradle @@ -0,0 +1,43 @@ +/* + * Copyright 2013-2016 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. + */ + +repositories { + mavenLocal() + jcenter() + maven { + url "http://repo.spring.io/snapshot" + } + maven { + url "http://repo.spring.io/milestone" + } +} + +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-core") + compile "org.springframework.boot:spring-boot-starter-actuator:${springBootVersion}" + compile "org.springframework:spring-jms:${springVersion}" + + compile 'org.apache.activemq:activemq-broker:5.12.1' + compile 'org.apache.activemq:activemq-pool:5.12.1' + + testCompile project(":$verifier-root:$verifier-messaging-root:$verifier-messaging-core") + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookDeleted.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookDeleted.groovy new file mode 100644 index 0000000000..3ee03c12ec --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookDeleted.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookDeleted implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookDeleted(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookListener.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookListener.groovy new file mode 100644 index 0000000000..117bf6a9b6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookListener.groovy @@ -0,0 +1,74 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring + +import com.fasterxml.jackson.databind.ObjectMapper +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.jms.annotation.JmsListener +import org.springframework.jms.core.JmsTemplate +import org.springframework.jms.core.MessageCreator +import org.springframework.stereotype.Service + +import javax.jms.JMSException +import javax.jms.Message +import javax.jms.Session +import java.util.concurrent.atomic.AtomicBoolean + +@CompileStatic +@Slf4j +@Service +class BookListener { + + @Autowired JmsTemplate jmsTemplate + ObjectMapper objectMapper = new ObjectMapper() + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + @JmsListener(destination = "input") + void returnBook(String messageAsString) { + BookReturned bookReturned = objectMapper.readerFor(BookReturned).readValue(messageAsString) as BookReturned + log.info("Returning book [$bookReturned]") + MessageCreator messageCreator = new MessageCreator() { + @Override + public Message createMessage(Session session) throws JMSException { + Message message = session.createObjectMessage(bookReturned); + message.setStringProperty('BOOK-NAME', bookReturned.bookName) + return message + } + }; + jmsTemplate.send('output', messageCreator) + } + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + @JmsListener(destination = "delete") + void bookDeleted(String bookDeletedAsString) { + BookDeleted bookDeleted = objectMapper.readerFor(BookDeleted).readValue(bookDeletedAsString) as BookDeleted + log.info("Deleting book [$bookDeleted]") + bookSuccessfulyDeleted.set(true) + } + + AtomicBoolean bookSuccessfulyDeleted = new AtomicBoolean(false) +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookReturned.groovy new file mode 100644 index 0000000000..a875572a76 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookReturned.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookReturned implements Serializable { + String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookService.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookService.groovy new file mode 100644 index 0000000000..b6413c21c4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/BookService.groovy @@ -0,0 +1,56 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.jms.core.JmsTemplate +import org.springframework.jms.core.MessageCreator +import org.springframework.stereotype.Service + +import javax.jms.JMSException +import javax.jms.Message +import javax.jms.Session + +@Service +@CompileStatic +@Slf4j +class BookService { + + @Autowired JmsTemplate jmsTemplate + + /** + Scenario for "should generate tests triggered by a method": + client side: must have a possibility to "trigger" sending of a message to the given messageFrom + server side: will run the method and await upon receiving message on the output messageFrom + + Method triggers sending a message to a source + */ + void returnBook(BookReturned bookReturned ) { + log.info("Returning book [$bookReturned]") + MessageCreator messageCreator = new MessageCreator() { + @Override + public Message createMessage(Session session) throws JMSException { + Message message = session.createObjectMessage(bookReturned); + message.setStringProperty('BOOK-NAME', bookReturned.bookName) + return message + } + }; + jmsTemplate.send('output', messageCreator) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/SpringMessagingApplication.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/SpringMessagingApplication.groovy new file mode 100644 index 0000000000..c4a6676fb8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/main/groovy/org/springframework/cloud/contract/verifier/samples/spring/SpringMessagingApplication.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring + +import org.springframework.boot.SpringApplication +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.jms.annotation.EnableJms + +@SpringBootApplication +@EnableJms +class SpringMessagingApplication { + + static void main(String[] args) { + SpringApplication.run(SpringMessagingApplication.class, args) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/SpringApplicationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/SpringApplicationSpec.groovy new file mode 100644 index 0000000000..082cf2f2fc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/SpringApplicationSpec.groovy @@ -0,0 +1,158 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification +import spock.util.concurrent.PollingConditions + +import javax.inject.Inject +/** + * SPIKE ON TESTS FROM NOTES IN MessagingSpec + */ +// Context configuration would end up in base class +@ContextConfiguration(classes = [SpringMessagingApplication], loader = SpringApplicationContextLoader) +public class SpringApplicationSpec extends Specification { + + // ALL CASES + @Inject ContractVerifierMessaging contractVerifierMessaging + ContractVerifierObjectMapper contractVerifierObjectMapper = new ContractVerifierObjectMapper() + + def "should work for triggered based messaging"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + // generated test should look like this: + when: + bookReturnedTriggered() + then: + def response = contractVerifierMessaging.receiveMessage('output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'input') + then: + def response = contractVerifierMessaging.receiveMessage('output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests without destination, triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'delete') + then: + noExceptionThrown() + bookWasDeleted() + } + + // BASE CLASS WOULD HAVE THIS: + + @Autowired BookService bookService + @Autowired BookListener bookListener + + void bookReturnedTriggered() { + bookService.returnBook(new BookReturned("foo")) + } + + PollingConditions pollingConditions = new PollingConditions() + + void bookWasDeleted() { + pollingConditions.eventually { + assert bookListener.bookSuccessfulyDeleted.get() + } + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ContractVerifierSpringMessageBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ContractVerifierSpringMessageBuilder.groovy new file mode 100644 index 0000000000..fdd0094caf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ContractVerifierSpringMessageBuilder.groovy @@ -0,0 +1,51 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring.config + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder +import org.springframework.jms.core.MessageCreator + +import javax.jms.JMSException +import javax.jms.Message +import javax.jms.Session +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierSpringMessageBuilder implements ContractVerifierMessageBuilder { + + @Override + public ContractVerifierMessage create(final T payload, final Map headers) { + MessageCreator messageCreator = new MessageCreator() { + @Override + public Message createMessage(Session session) throws JMSException { + Message message = session.createObjectMessage(payload); + headers.entrySet().each { Map.Entry entry -> + message.setObjectProperty(entry.key, entry.value) + } + return message + } + }; + + return new SpringMessage<>(messageCreator) + } + + @Override + public ContractVerifierMessage create(Message message) { + return new SpringMessage<>(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ContractVerifierSpringMessaging.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ContractVerifierSpringMessaging.groovy new file mode 100644 index 0000000000..bd7e93503b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ContractVerifierSpringMessaging.groovy @@ -0,0 +1,93 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring.config + +import org.slf4j.Logger +import org.slf4j.LoggerFactory +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.jms.core.JmsTemplate +import org.springframework.stereotype.Component + +import javax.jms.Message +import java.util.concurrent.TimeUnit +/** + * @author Marcin Grzejszczak + */ +@Component +public class ContractVerifierSpringMessaging implements ContractVerifierMessaging { + + private static final Logger log = LoggerFactory.getLogger(ContractVerifierSpringMessaging.class); + + private final JmsTemplate jmsTemplate; + private final ContractVerifierMessageBuilder builder; + + @Autowired + @SuppressWarnings("unchecked") + public ContractVerifierSpringMessaging(ContractVerifierMessageBuilder builder, JmsTemplate jmsTemplate) { + this.builder = builder + this.jmsTemplate = jmsTemplate + } + + @Override + @SuppressWarnings("unchecked") + public void send(T payload, Map headers, String destination) { + send(builder.create(payload, headers), destination); + } + + @Override + public void send(ContractVerifierMessage message, String destination) { + try { + jmsTemplate.send(destination, ((SpringMessage) message).messageCreator) + } catch (Exception e) { + log.error("Exception occurred while trying to send a message [" + message + "] " + + "to a channel with name [" + destination + "]", e); + throw e; + } + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage receiveMessage(String destination, long timeout, TimeUnit timeUnit) { + try { + return builder.create(jmsTemplate.receive(destination)); + } catch (Exception e) { + log.error("Exception occurred while trying to read a message from " + + " a channel with name [" + destination + "]", e); + throw new RuntimeException(e); + } + } + + @Override + public ContractVerifierMessage receiveMessage(String destination) { + return receiveMessage(destination, 5, TimeUnit.SECONDS); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage create(T t, Map headers) { + return builder.create(t, headers); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage create(Message message) { + return builder.create(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ManualContractVerifierConfiguration.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ManualContractVerifierConfiguration.groovy new file mode 100644 index 0000000000..eb9966e3b3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/ManualContractVerifierConfiguration.groovy @@ -0,0 +1,35 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring.config + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration +import org.springframework.jms.core.JmsTemplate + +/** + * @author Marcin Grzejszczak + */ +@Configuration +class ManualContractVerifierConfiguration { + + @Bean + ContractVerifierMessaging contractVerifierMessaging(JmsTemplate jmsTemplate) { + return new ContractVerifierSpringMessaging(new ContractVerifierSpringMessageBuilder(), jmsTemplate); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/SpringMessage.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/SpringMessage.groovy new file mode 100644 index 0000000000..28239443a1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-spring/src/test/groovy/org/springframework/cloud/contract/verifier/samples/spring/config/SpringMessage.groovy @@ -0,0 +1,68 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.spring.config + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.jms.core.MessageCreator + +import javax.jms.Message +import javax.jms.ObjectMessage +/** + * @author Marcin Grzejszczak + */ +public class SpringMessage implements ContractVerifierMessage { + + private final ObjectMessage messageDelegate; + final MessageCreator messageCreator; + + public SpringMessage(Message messageDelegate) { + this.messageDelegate = (ObjectMessage) messageDelegate; + this.messageCreator = null + } + + public SpringMessage(MessageCreator messageCreator) { + this.messageDelegate = null; + this.messageCreator = messageCreator + } + + @Override + public T getPayload() { + return messageDelegate.getObject(); + } + + @Override + public Map getHeaders() { + Map headers = [:] + def enumeration = messageDelegate.propertyNames + while(enumeration.hasMoreElements()) { + String propertyName = enumeration.nextElement() + headers << [(propertyName) : messageDelegate.getObjectProperty(propertyName)] + } + return headers + } + + @Override + Object getHeader(String key) { + return getHeaders().get(key) + } + + @Override + public Message convert() { + return messageDelegate; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/build.gradle new file mode 100644 index 0000000000..296798e705 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/build.gradle @@ -0,0 +1,40 @@ +/* + * Copyright 2013-2016 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. + */ + +repositories { + mavenLocal() + jcenter() + maven { + url "http://repo.spring.io/snapshot" + } + maven { + url "http://repo.spring.io/milestone" + } +} + +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-core") + compile "org.springframework.boot:spring-boot-starter-actuator:${springBootVersion}" + compile "org.springframework.cloud:spring-cloud-stream-binder-rabbit:${springStreamVersion}" + + testCompile project(":$verifier-root:$verifier-messaging-root:$verifier-stream") + testCompile "org.springframework.cloud:spring-cloud-stream-test-support:${springStreamVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy new file mode 100644 index 0000000000..e43c21c9d2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookDeleted.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookDeleted { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookDeleted(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy new file mode 100644 index 0000000000..6e70889df4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookListener.groovy @@ -0,0 +1,64 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.cloud.stream.annotation.EnableBinding +import org.springframework.cloud.stream.annotation.StreamListener +import org.springframework.cloud.stream.messaging.Sink +import org.springframework.cloud.stream.messaging.Source +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder + +import java.util.concurrent.atomic.AtomicBoolean + +@CompileStatic +@Slf4j +@EnableBinding([DeleteSink, Sink]) +class BookListener { + + @Autowired Source source + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + @StreamListener(Sink.INPUT) + void returnBook(BookReturned bookReturned) { + log.info("Returning book [$bookReturned]") + source.output().send(MessageBuilder.createMessage(bookReturned, new MessageHeaders([ + 'BOOK-NAME': bookReturned.bookName as Object + ]))) + } + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + @StreamListener(DeleteSink.INPUT) + void bookDeleted(BookDeleted bookDeleted) { + log.info("Deleting book [$bookDeleted]") + // ... doing some work + bookSuccessfulyDeleted.set(true) + } + + AtomicBoolean bookSuccessfulyDeleted = new AtomicBoolean(false) +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy new file mode 100644 index 0000000000..130c19d468 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookReturned.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookReturned { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy new file mode 100644 index 0000000000..4e8a8adefa --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/BookService.groovy @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.cloud.stream.messaging.Source +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder +import org.springframework.stereotype.Service + +@Service +@CompileStatic +@Slf4j +class BookService { + + private final Source source + + @Autowired + BookService(Source source) { + this.source = source + } + + /** + Scenario for "should generate tests triggered by a method": + client side: must have a possibility to "trigger" sending of a message to the given messageFrom + server side: will run the method and await upon receiving message on the output messageFrom + + Method triggers sending a message to a source + */ + void returnBook(BookReturned bookReturned) { + log.info("Returning book [$bookReturned]") + source.output().send(MessageBuilder.createMessage(bookReturned, new MessageHeaders([ + 'BOOK-NAME': bookReturned.bookName as Object + ]))) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/DeleteSink.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/DeleteSink.groovy new file mode 100644 index 0000000000..aa6e72e4e4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/DeleteSink.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import org.springframework.cloud.stream.annotation.Input +import org.springframework.cloud.stream.messaging.Sink +import org.springframework.messaging.SubscribableChannel + +/** + * @author Marcin Grzejszczak + */ +interface DeleteSink extends Sink { + + String INPUT = "delete"; + + @Input(DeleteSink.INPUT) + SubscribableChannel delete(); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/StreamMessagingApplication.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/StreamMessagingApplication.groovy new file mode 100644 index 0000000000..9fa8eb8f86 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/groovy/org/springframework/cloud/contract/verifier/samples/messaging/StreamMessagingApplication.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.cloud.stream.annotation.EnableBinding +import org.springframework.cloud.stream.messaging.Sink; +import org.springframework.cloud.stream.messaging.Source; + +@SpringBootApplication +@EnableBinding([Source, Sink]) +class StreamMessagingApplication { + + static void main(String[] args) { + SpringApplication.run(StreamMessagingApplication.class, args) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/resources/application.yml new file mode 100644 index 0000000000..1ff1cf7519 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/main/resources/application.yml @@ -0,0 +1,2 @@ +spring.cloud.stream.bindings.input.destination: inputDestination +spring.cloud.stream.bindings.output.destination: sentTo \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/StreamMessagingApplicationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/StreamMessagingApplicationSpec.groovy new file mode 100644 index 0000000000..1a21561554 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/samples/samples-messaging-stream/src/test/groovy/org/springframework/cloud/contract/verifier/samples/messaging/StreamMessagingApplicationSpec.groovy @@ -0,0 +1,152 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.samples.messaging + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification + +import javax.inject.Inject +/** + * SPIKE ON TESTS FROM NOTES IN MessagingSpec + */ +// Context configuration would end up in base class +@ContextConfiguration(classes = [StreamMessagingApplication], loader = SpringApplicationContextLoader) +public class StreamMessagingApplicationSpec extends Specification { + + // ALL CASES + @Inject ContractVerifierMessaging contractVerifierMessaging + ContractVerifierObjectMapper contractVerifierObjectMapper = new ContractVerifierObjectMapper() + + def "should work for triggered based messaging"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + // generated test should look like this: + when: + bookReturnedTriggered() + then: + def response = contractVerifierMessaging.receiveMessage('output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'input') + then: + def response = contractVerifierMessaging.receiveMessage('output') + response.headers.get('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + JsonAssertion.assertThat(parsedJson).field('bookName').isEqualTo('foo') + } + + def "should generate tests without destination, triggered by a message"() { + given: + def dsl = Contract.make { + label 'some_label' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + + // generated test should look like this: + + //given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + contractVerifierObjectMapper.writeValueAsString([bookName: 'foo']), + [sample: 'header'] + ) + when: + contractVerifierMessaging.send(inputMessage, 'delete') + then: + noExceptionThrown() + bookWasDeleted() + } + + // BASE CLASS WOULD HAVE THIS: + + @Autowired BookService bookService + @Autowired BookListener bookListener + + void bookReturnedTriggered() { + bookService.returnBook(new BookReturned("foo")) + } + + void bookWasDeleted() { + assert bookListener.bookSuccessfulyDeleted.get() + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/scripts/runTests.sh b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/scripts/runTests.sh new file mode 100755 index 0000000000..4eb0cf6494 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/scripts/runTests.sh @@ -0,0 +1,25 @@ +#!/usr/bin/env bash + +set -o errexit + +ROOT_FOLDER=`pwd` +echo "Current folder is $ROOT_FOLDER" + +mkdir -p build +CONTRACT_VERIFIER_VERSION=1.0.0.BUILD-SNAPSHOT +export CONTRACT_VERIFIER_VERSION=${CONTRACT_VERIFIER_VERSION} + +echo "Current Spring Cloud Contract Verifier version is ${CONTRACT_VERIFIER_VERSION}" + +cd build +echo "Cloning samples" +git clone https://github.com/Codearte/accurest-samples +cd accurest-samples + +echo "Running Gradle tests" +. ./runTests.sh + +echo "Running Maven tests" +. ./runMavenTests.sh + +cd $ROOT_FOLDER \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/settings.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/settings.gradle new file mode 100644 index 0000000000..bb28620d0c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/settings.gradle @@ -0,0 +1,39 @@ +String verifier = "spring-cloud-contract-verifier" +String stubRunner = "spring-cloud-contract-stub-runner" + +rootProject.name = "$verifier-parent" + +include "docs" + +include ":spring-cloud-contract-spec" + +include ":$verifier:$verifier-core", + ":$verifier:$verifier-gradle-plugin", + ":$verifier:$verifier-converters", + ":$verifier:$verifier-testing-utils" + +include ":$verifier:$verifier-messaging:$verifier-messaging-core", + ":$verifier:$verifier-messaging:$verifier-integration", + ":$verifier:$verifier-messaging:$verifier-stream", + ":$verifier:$verifier-messaging:$verifier-camel" + +include ":$stubRunner:$stubRunner", + ":$stubRunner:$stubRunner-spring", + ":$stubRunner:$stubRunner-boot", + ":$stubRunner:$stubRunner-spring-cloud", + ":$stubRunner:$stubRunner-junit" + +include ":$stubRunner:$stubRunner-messaging:$stubRunner-integration", + ":$stubRunner:$stubRunner-messaging:$stubRunner-stream", + ":$stubRunner:$stubRunner-messaging:$stubRunner-camel" + +include ":samples:samples-messaging-stream", + ":samples:samples-messaging-integration", + ":samples:samples-messaging-camel", + ":samples:samples-messaging-spring" + +//to prevent StackOverflow in Sonar +project(":$verifier").name = "$verifier-root" +project(":$stubRunner").name = "$stubRunner-root" +project(":$verifier:$verifier-messaging").name = "$verifier-messaging-root" +project(":$stubRunner:$stubRunner-messaging").name = "$stubRunner-messaging-root" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/Contract.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/Contract.groovy new file mode 100644 index 0000000000..7e424d019d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/Contract.groovy @@ -0,0 +1,93 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec + +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.internal.Input +import org.springframework.cloud.contract.spec.internal.OutputMessage +import org.springframework.cloud.contract.spec.internal.Request +import org.springframework.cloud.contract.spec.internal.Response + +/** + * The point of entry to the DSL + * + * @since 1.0.0 + */ +@TypeChecked +@EqualsAndHashCode +@ToString(includeFields = true, includePackage = false, includeNames = true) +class Contract { + + Integer priority + Request request + Response response + String label + String description + Input input + OutputMessage outputMessage + + protected Contract() {} + + /** + * Factory method to create the DSL + */ + static Contract make(Closure closure) { + Contract dsl = new Contract() + closure.delegate = dsl + closure() + return dsl + } + + void priority(int priority) { + this.priority = priority + } + + void label(String label) { + this.label = label + } + + void description(String description) { + this.description = description + } + + void request(@DelegatesTo(Request) Closure closure) { + this.request = new Request() + closure.delegate = request + closure() + } + + void response(@DelegatesTo(Response) Closure closure) { + this.response = new Response() + closure.delegate = response + closure() + } + + void input(@DelegatesTo(Input) Closure closure) { + this.input = new Input() + closure.delegate = input + closure() + } + + void outputMessage(@DelegatesTo(OutputMessage) Closure closure) { + this.outputMessage = new OutputMessage() + closure.delegate = outputMessage + closure() + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/ContractVerifierException.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/ContractVerifierException.groovy new file mode 100644 index 0000000000..2750320176 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/ContractVerifierException.groovy @@ -0,0 +1,34 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec + +import groovy.transform.CompileStatic + +/** + * @author Jakub Kubrynski, codearte.io + */ +@CompileStatic +class ContractVerifierException extends RuntimeException { + + ContractVerifierException(String message) { + super(message) + } + + ContractVerifierException(String message, Throwable cause) { + super(message, cause) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Body.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Body.groovy new file mode 100644 index 0000000000..38e42ad8ba --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Body.groovy @@ -0,0 +1,64 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +/** + * Represents a body of a request / response or a message + * + * @since 1.0.0 + */ +@ToString(includePackage = false, includeFields = true, includeNames = true) +@EqualsAndHashCode(includeFields = true) +@CompileStatic +class Body extends DslProperty { + + Body(Map body) { + super(extractValue(body, { DslProperty p -> p.clientValue}), extractValue(body, {DslProperty p -> p.serverValue})) + } + + private static Map extractValue(Map body, Closure valueProvider) { + body.collectEntries { Map.Entry entry -> + [(entry.key): valueProvider(entry.value)] + } as Map + } + + Body(List bodyAsList) { + super(bodyAsList.collect { DslProperty p -> p.clientValue }, bodyAsList.collect { DslProperty p -> p.serverValue }) + } + + Body(Object bodyAsValue) { + this("${bodyAsValue}") + } + + Body(GString bodyAsValue) { + super(bodyAsValue, bodyAsValue) + } + + Body(DslProperty bodyAsValue) { + super(bodyAsValue.clientValue, bodyAsValue.serverValue) + } + + Body(MatchingStrategy matchingStrategy) { + super(matchingStrategy, matchingStrategy) + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ClientDslProperty.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ClientDslProperty.groovy new file mode 100644 index 0000000000..e16afaffb5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ClientDslProperty.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic + +/** + * Represents a client side {@link DslProperty} + * + * @since 1.0.0 + */ +@CompileStatic +class ClientDslProperty extends DslProperty { + + ClientDslProperty(Object singleValue) { + super(singleValue) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Common.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Common.groovy new file mode 100644 index 0000000000..6cbf2a3a6f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Common.groovy @@ -0,0 +1,166 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.PackageScope +import groovy.transform.TypeChecked + +import java.util.regex.Pattern + +/** + * Contains useful common methods for the DSL. + * + * @TypeChecked instead of @CompileStatic due to usage of double dispatch. + * Double dispatch doesn't work if you're using @CompileStatic + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +class Common { + + @Delegate private final RegexPatterns regexPatterns = new RegexPatterns() + + Map convertObjectsToDslProperties(Map body) { + return body.collectEntries { + Map.Entry entry -> + [(entry.key): toDslProperty(entry.value)] + } as Map + } + + Collection convertObjectsToDslProperties(List body) { + return (body.collect { + Object element -> toDslProperty(element) + } as List) + } + + DslProperty toDslProperty(Object property) { + return new DslProperty(property) + } + + DslProperty toDslProperty(Map property) { + return new DslProperty(property.collectEntries { + [(it.key): toDslProperty(it.value)] + }) + } + + DslProperty toDslProperty(List property) { + return new DslProperty(property.collect { + toDslProperty(it) + }) + } + + DslProperty toDslProperty(DslProperty property) { + return property + } + + NamedProperty named(DslProperty name, DslProperty value){ + return new NamedProperty(name, value) + } + + NamedProperty named(Map namedMap){ + return new NamedProperty(namedMap) + } + + DslProperty value(ClientDslProperty client, ServerDslProperty server) { + assertThatSidesMatch(client.clientValue, server.serverValue) + return new DslProperty(client.clientValue, server.serverValue) + } + + DslProperty value(Object value) { + return new DslProperty(value) + } + + DslProperty value(ServerDslProperty server, ClientDslProperty client) { + assertThatSidesMatch(client.clientValue, server.serverValue) + return new DslProperty(client.clientValue, server.serverValue) + } + + DslProperty $(ClientDslProperty client, ServerDslProperty server) { + return value(client, server) + } + + DslProperty $(ServerDslProperty server, ClientDslProperty client) { + return value(server, client) + } + + Pattern regex(String regex) { + return Pattern.compile(regex) + } + + OptionalProperty optional(Object object) { + return new OptionalProperty(object) + } + + ExecutionProperty execute(String commandToExecute) { + return new ExecutionProperty(commandToExecute) + } + + ClientDslProperty client(Object clientValue) { + return new ClientDslProperty(clientValue) + } + + ClientDslProperty stub(Object clientValue) { + return new ClientDslProperty(clientValue) + } + + ServerDslProperty server(Object serverValue) { + return new ServerDslProperty(serverValue) + } + + ServerDslProperty test(Object serverValue) { + return new ServerDslProperty(serverValue) + } + + void assertThatSidesMatch(OptionalProperty stubSide, Object testSide) { + assert testSide ==~ Pattern.compile(stubSide.optionalPattern()) + } + + void assertThatSidesMatch(Pattern pattern, String value) { + assert value ==~ pattern + } + + void assertThatSidesMatch(String value, Pattern pattern) { + assert value ==~ pattern + } + + void assertThatSidesMatch(MatchingStrategy firstSide, MatchingStrategy secondSide) { + if (firstSide.type == MatchingStrategy.Type.ABSENT && secondSide != MatchingStrategy.Type.ABSENT) { + throwAbsentError() + } + } + + void assertThatSidesMatch(MatchingStrategy firstSide, Object secondSide) { + if (firstSide.type == MatchingStrategy.Type.ABSENT) { + throwAbsentError() + } + } + + void assertThatSidesMatch(Object firstSide, MatchingStrategy secondSide) { + if (secondSide.type == MatchingStrategy.Type.ABSENT) { + throwAbsentError() + } + } + + private void throwAbsentError() { + throw new IllegalStateException("Absent cannot only be used only on one side") + } + + void assertThatSidesMatch(Object firstSide, Object secondSide) { + // do nothing + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/DslProperty.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/DslProperty.groovy new file mode 100644 index 0000000000..4be6c853ae --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/DslProperty.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +/** + * Represents an element of a DSL that can contain client or sever side values + * + * @since 1.0.0 + */ +@CompileStatic +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false, includeNames = true) +class DslProperty { + + final T clientValue + final T serverValue + + DslProperty(T clientValue, T serverValue) { + this.clientValue = clientValue + this.serverValue = serverValue + } + + DslProperty(T singleValue) { + this.clientValue = singleValue + this.serverValue = singleValue + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ExecutionProperty.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ExecutionProperty.groovy new file mode 100644 index 0000000000..6f79e6dbcf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ExecutionProperty.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic + +/** + * Represents a property that will become an executable method in the + * generated tests + * + * @since 1.0.0 + */ +@CompileStatic +class ExecutionProperty { + + private static final String PLACEHOLDER_VALUE = '\\$it' + + final String executionCommand + + ExecutionProperty(String executionCommand) { + this.executionCommand = executionCommand + } + + /** + * Inserts the provided code as a parameter to the method and returns + * the code that represents that method execution + */ + String insertValue(String valueToInsert) { + return executionCommand.replaceAll(PLACEHOLDER_VALUE, valueToInsert) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Header.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Header.groovy new file mode 100644 index 0000000000..9989d875b4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Header.groovy @@ -0,0 +1,44 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +/** + * Represents a header of a request / response or a message + * + * @since 1.0.0 + */ +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false, includeFields = true, ignoreNulls = true, includeNames = true) +@CompileStatic +class Header extends DslProperty { + + String name + + Header(String name, DslProperty dslProperty) { + super(dslProperty.clientValue, dslProperty.serverValue) + this.name = name + } + + Header(String name, Object value) { + super(value) + this.name = name + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Headers.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Headers.groovy new file mode 100644 index 0000000000..036a23598e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Headers.groovy @@ -0,0 +1,73 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked + +/** + * Represents a set of headers of a request / response or a message + * + * @since 1.0.0 + */ +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false, includeFields = true, ignoreNulls = true, includeNames = true) +@TypeChecked +class Headers { + + Set
entries = [] + + void header(Map singleHeader) { + Map.Entry first = singleHeader.entrySet().first() + entries << new Header(first?.key, first?.value) + } + + void header(String headerKey, Object headerValue) { + entries << new Header(headerKey, headerValue) + } + + void executeForEachHeader(Closure closure) { + entries?.each { + header -> closure(header) + } + } + + /** + * Converts the headers into their stub side representations and returns as + * a map of String key => Object value. + */ + Map asStubSideMap() { + def acc = [:].withDefault { [] as Collection } + return entries.inject(acc as Map) { Map map, Header header -> + map[header.name] = header.clientValue + return map + } as Map + } + + boolean equals(o) { + if (this.is(o)) return true + if (getClass() != o.class) return false + Headers headers = (Headers) o + if (entries != headers.entries) return false + return true + } + + int hashCode() { + return entries.hashCode() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Input.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Input.groovy new file mode 100644 index 0000000000..124b25ce50 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Input.groovy @@ -0,0 +1,127 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked + +/** + * Represents an input for messaging. The input can be a message or some + * action inside the application. + * + * @since 1.0.0 + */ +@TypeChecked +@EqualsAndHashCode +@ToString(includePackage = false, includeNames = true) +class Input extends Common { + + DslProperty messageFrom + ExecutionProperty triggeredBy + Headers messageHeaders + BodyType messageBody + ExecutionProperty assertThat + + Input() {} + + Input(Input input) { + this.messageFrom = input.messageFrom + this.messageHeaders = input.messageHeaders + this.messageBody = input.messageBody + } + + /** + * Helper method to provide a better name for the producer side + */ + ServerDslProperty producer(Object clientValue) { + return new ServerDslProperty(clientValue) + } + + /** + * Helper method to provide a better name for the consumer side + */ + ClientDslProperty consumer(Object clientValue) { + return new ClientDslProperty(clientValue) + } + + /** + * Name of a destination from which message would come to trigger action in the system + */ + void messageFrom(String messageFrom) { + this.messageFrom = new DslProperty<>(messageFrom) + } + + /** + * Name of a destination from which message would come to trigger action in the system + */ + void messageFrom(DslProperty messageFrom) { + this.messageFrom = messageFrom + } + + /** + * Function that needs to be executed to trigger action in the system + */ + void triggeredBy(String triggeredBy) { + this.triggeredBy = new ExecutionProperty(triggeredBy) + } + + BodyType messageBody(Object bodyAsValue) { + this.messageBody = new BodyType(bodyAsValue) + } + + void messageHeaders(@DelegatesTo(Headers) Closure closure) { + this.messageHeaders = new Headers() + closure.delegate = messageHeaders + closure() + } + + static class BodyType extends DslProperty { + + BodyType(Object clientValue, Object serverValue) { + super(clientValue, serverValue) + } + + BodyType(Object singleValue) { + super(singleValue) + } + } + + void assertThat(String assertThat) { + this.assertThat = new ExecutionProperty(assertThat) + } +} + + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ServerInput extends Input { + ServerInput(Input request) { + super(request) + } +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ClientInput extends Input { + ClientInput(Input request) { + super(request) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/JSONCompareMode.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/JSONCompareMode.groovy new file mode 100644 index 0000000000..c1e3b21e7d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/JSONCompareMode.groovy @@ -0,0 +1,26 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +/** + * Represents JSON comparison modes + * + * @since 1.0.0 + */ +enum JSONCompareMode { + STRICT, LENIENT, NON_EXTENSIBLE, STRICT_ORDER +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/MatchingStrategy.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/MatchingStrategy.groovy new file mode 100644 index 0000000000..0b30b40f23 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/MatchingStrategy.groovy @@ -0,0 +1,67 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString; + +/** + * Represents a matching strategy for a JSON + * + * @since 1.0.0 + */ +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false, includeFields = true, ignoreNulls = true, includeNames = true) +@CompileStatic +class MatchingStrategy extends DslProperty { + + Type type + JSONCompareMode jsonCompareMode + + MatchingStrategy(Object value, Type type) { + this(value, type, null) + } + + MatchingStrategy(Object value, Type type, JSONCompareMode jsonCompareMode) { + super(value) + this.type = type + this.jsonCompareMode = jsonCompareMode + } + + MatchingStrategy(DslProperty value, Type type) { + this(value, type, null) + } + + MatchingStrategy(DslProperty value, Type type, JSONCompareMode jsonCompareMode) { + super(value.clientValue, value.serverValue) + this.type = type + this.jsonCompareMode = jsonCompareMode + } + + enum Type { + EQUAL_TO("equalTo"), CONTAINS("containing"), MATCHING("matches"), NOT_MATCHING("doesNotMatch"), + EQUAL_TO_JSON("equalToJson"), EQUAL_TO_XML("equalToXml"), ABSENT("absent") + + final String name + + Type(name) { + this.name = name + } + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Multipart.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Multipart.groovy new file mode 100644 index 0000000000..59efa9fe77 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Multipart.groovy @@ -0,0 +1,57 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +@ToString(includePackage = false, includeFields = true, includeNames = true) +@EqualsAndHashCode(includeFields = true) +@CompileStatic +class Multipart extends DslProperty { + + Multipart(Map multipart) { + super(extractValue(multipart, { DslProperty p -> p.clientValue}), extractValue(multipart, {DslProperty p -> p.serverValue})) + } + + private static Map extractValue(Map multipart, Closure valueProvider) { + return multipart.collectEntries { Map.Entry entry -> + [(entry.key): valueProvider(entry.value)] + } as Map + } + + Multipart(List multipartAsList) { + super(multipartAsList.collect { DslProperty p -> p.clientValue }, multipartAsList.collect { DslProperty p -> p.serverValue }) + } + + Multipart(Object multipartAsValue) { + this("${multipartAsValue}") + } + + Multipart(GString multipartAsValue) { + super(multipartAsValue, multipartAsValue) + } + + Multipart(DslProperty multipartAsValue) { + super(multipartAsValue.clientValue, multipartAsValue.serverValue) + } + + Multipart(MatchingStrategy matchingStrategy) { + super(matchingStrategy, matchingStrategy) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/NamedProperty.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/NamedProperty.groovy new file mode 100644 index 0000000000..798ddcb0f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/NamedProperty.groovy @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +/** + * Represents a property that has name and content. Used together with + * multipart requests. + * + * @since 1.0.0 + */ +@ToString(includePackage = false, includeFields = true, includeNames = true) +@EqualsAndHashCode(includeFields = true) +@CompileStatic +class NamedProperty { + + private static final String NAME = 'name' + private static final String CONTENT = 'content' + + DslProperty name + DslProperty value + + NamedProperty(DslProperty name, DslProperty value) { + this.name = name + this.value = value + } + + NamedProperty(Map namedMap) { + this(namedMap?.get(NAME), namedMap?.get(CONTENT)) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/OptionalProperty.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/OptionalProperty.groovy new file mode 100644 index 0000000000..6ac232f29c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/OptionalProperty.groovy @@ -0,0 +1,41 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic + +/** + * Represents a property that may or may not be there + * + * @since 1.0.0 + */ +@CompileStatic +class OptionalProperty { + final Object value + + OptionalProperty(Object value) { + this.value = value + } + + /** + * String version of a regular expression that wraps the provided value + * in an optional function + */ + String optionalPattern() { + return "($value)?" + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/OutputMessage.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/OutputMessage.groovy new file mode 100644 index 0000000000..260bd68f5a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/OutputMessage.groovy @@ -0,0 +1,93 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked + +@TypeChecked +@EqualsAndHashCode +@ToString(includePackage = false, includeNames = true) +class OutputMessage extends Common { + + DslProperty sentTo + Headers headers + DslProperty body + ExecutionProperty assertThat + + OutputMessage() {} + + OutputMessage(OutputMessage outputMessage) { + this.sentTo = outputMessage.sentTo + this.headers = outputMessage.headers + this.body = outputMessage.body + } + + void sentTo(String sentTo) { + this.sentTo = new DslProperty(sentTo) + } + + void sentTo(DslProperty sentTo) { + this.sentTo = sentTo + } + + ServerDslProperty producer(Object clientValue) { + return new ServerDslProperty(clientValue) + } + + ClientDslProperty consumer(Object clientValue) { + return new ClientDslProperty(clientValue) + } + + void body(Object bodyAsValue) { + this.body = new DslProperty(bodyAsValue) + } + + void body(DslProperty bodyAsValue) { + this.body = bodyAsValue + } + + void headers(@DelegatesTo(Headers) Closure closure) { + this.headers = new Headers() + closure.delegate = headers + closure() + } + + void assertThat(String assertThat) { + this.assertThat = new ExecutionProperty(assertThat) + } +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ServerOutputMessage extends OutputMessage { + ServerOutputMessage(OutputMessage request) { + super(request) + } +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ClientOutputMessage extends OutputMessage { + ClientOutputMessage(OutputMessage request) { + super(request) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/QueryParameter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/QueryParameter.groovy new file mode 100644 index 0000000000..d34ea61383 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/QueryParameter.groovy @@ -0,0 +1,55 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +import static org.springframework.cloud.contract.spec.util.ValidateUtils.validateServerValueIsAvailable + +/** + * Represents a single HTTP query parameter + * + * @since 1.0.0 + */ +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false, includeFields = true, ignoreNulls = true, includeNames = true) +@CompileStatic +class QueryParameter extends DslProperty { + + String name + + QueryParameter(String name, DslProperty dslProperty) { + super(dslProperty.clientValue, dslProperty.serverValue) + validateServerValueIsAvailable(dslProperty.serverValue, "Query parameter '$name'") + this.name = name + } + + QueryParameter(String name, MatchingStrategy matchingStrategy) { + super(matchingStrategy) + validateServerValueIsAvailable(matchingStrategy, "Query parameter '$name'") + this.name = name + } + + QueryParameter(String name, Object value) { + super(value) + validateServerValueIsAvailable(value, "Query parameter '$name'") + this.name = name + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/QueryParameters.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/QueryParameters.groovy new file mode 100644 index 0000000000..26cbec3730 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/QueryParameters.groovy @@ -0,0 +1,39 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked + +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false, includeFields = true, ignoreNulls = true, includeNames = true) +@TypeChecked +class QueryParameters { + + List parameters = [] + + void parameter(Map singleParameter) { + Map.Entry first = singleParameter.entrySet().first() + parameters << new QueryParameter(first?.key, first?.value) + } + + void parameter(String parameterName, Object parameterValue) { + parameters << new QueryParameter(parameterName, parameterValue) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/RegexPatterns.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/RegexPatterns.groovy new file mode 100644 index 0000000000..7177ecf7c0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/RegexPatterns.groovy @@ -0,0 +1,74 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic + +import java.util.regex.Pattern + +/** + * Contains most common regular expression patterns + * + * @since 1.0.0 + */ +@CompileStatic +class RegexPatterns { + + private static final Pattern TRUE_OR_FALSE = Pattern.compile(/(true|false)/) + private static final Pattern ONLY_ALPHA_UNICODE = Pattern.compile(/[\p{L}]*/) + private static final Pattern NUMBER = Pattern.compile('-?\\d*(\\.\\d+)?') + private static final Pattern IP_ADDRESS = Pattern.compile('([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])'); + private static final Pattern HOSTNAME_PATTERN = Pattern.compile('((http[s]?|ftp):\\/)\\/?([^:\\/\\s]+)(:[0-9]{1,5})?'); + private static final Pattern EMAIL = Pattern.compile('[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}'); + private static final Pattern URL = Pattern.compile('((www\\.|(http|https|ftp|news|file)+\\:\\/\\/)[_.a-z0-9-]+\\.[a-z0-9\\/_:@=.+?,##%&~-]*[^.|\\\'|\\# |!|\\(|?|,| |>|<|;|\\)])') + + String onlyAlphaUnicode() { + return ONLY_ALPHA_UNICODE.pattern() + } + + String number() { + return NUMBER.pattern() + } + + String anyBoolean() { + return TRUE_OR_FALSE.pattern() + } + + String ipAddress() { + return IP_ADDRESS.pattern() + } + + String hostname() { + return HOSTNAME_PATTERN.pattern() + } + + String email() { + return EMAIL.pattern() + } + + String url() { + return URL.pattern() + } + + static String multipartParam(Object name, Object value) { + return ".*--(.*)\r\nContent-Disposition: form-data; name=\"$name\"\r\n(Content-Type: .*\r\n)?(Content-Length: \\d+\r\n)?\r\n$value\r\n--\\1.*" + } + + static String multipartFile(Object name, Object filename, Object content) { + return ".*--(.*)\r\nContent-Disposition: form-data; name=\"$name\"; filename=\"$filename\"\r\n(Content-Type: .*\r\n)?(Content-Length: \\d+\r\n)?\r\n$content\r\n--\\1.*"; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Request.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Request.groovy new file mode 100644 index 0000000000..724771d2f4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Request.groovy @@ -0,0 +1,193 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked + +/** + * Represents the request side of the HTTP communication + * + * @since 1.0.0 + */ +@TypeChecked +@EqualsAndHashCode +@ToString(includePackage = false, includeNames = true) +class Request extends Common { + + DslProperty method + Url url + UrlPath urlPath + Headers headers + Body body + Multipart multipart + + Request() { + } + + Request(Request request) { + this.method = request.method + this.url = request.url + this.urlPath = request.urlPath + this.headers = request.headers + this.body = request.body + this.multipart = request.multipart + } + + void method(String method) { + this.method = toDslProperty(method) + } + + void method(DslProperty method) { + this.method = toDslProperty(method) + } + + void url(Object url) { + this.url = new Url(url) + } + + void url(DslProperty url) { + this.url = new Url(url) + } + + void url(Object url, @DelegatesTo(UrlPath) Closure closure) { + this.url = new Url(url) + closure.delegate = this.url + closure() + } + + void url(DslProperty url, @DelegatesTo(UrlPath) Closure closure) { + this.url = new Url(url) + closure.delegate = this.url + closure() + } + + void urlPath(String path) { + this.urlPath = new UrlPath(path) + } + + void urlPath(DslProperty path) { + this.urlPath = new UrlPath(path) + } + + void urlPath(String path, @DelegatesTo(UrlPath) Closure closure) { + this.urlPath = new UrlPath(path) + closure.delegate = urlPath + closure() + } + + void urlPath(DslProperty path, @DelegatesTo(UrlPath) Closure closure) { + this.urlPath = new UrlPath(path) + closure.delegate = urlPath + closure() + } + + void headers(@DelegatesTo(Headers) Closure closure) { + this.headers = new Headers() + closure.delegate = headers + closure() + } + + void body(Map body) { + this.body = new Body(convertObjectsToDslProperties(body)) + } + + void body(List body) { + this.body = new Body(convertObjectsToDslProperties(body)) + } + + void body(DslProperty dslProperty) { + this.body = new Body(dslProperty) + } + + void body(Object bodyAsValue) { + this.body = new Body(bodyAsValue) + } + + Body getBody() { + return body + } + + void multipart(Map body) { + this.multipart = new Multipart(convertObjectsToDslProperties(body)) + } + + void multipart(List multipartAsList) { + this.multipart = new Multipart(convertObjectsToDslProperties(multipartAsList)) + } + + void multipart(DslProperty dslProperty) { + this.multipart = new Multipart(dslProperty) + } + + void multipart(Object multipartAsValue) { + this.multipart = new Multipart(multipartAsValue) + } + + MatchingStrategy equalTo(Object value) { + return new MatchingStrategy(value, MatchingStrategy.Type.EQUAL_TO) + } + + MatchingStrategy containing(Object value) { + return new MatchingStrategy(value, MatchingStrategy.Type.CONTAINS) + } + + MatchingStrategy matching(Object value) { + return new MatchingStrategy(value, MatchingStrategy.Type.MATCHING) + } + + MatchingStrategy notMatching(Object value) { + return new MatchingStrategy(value, MatchingStrategy.Type.NOT_MATCHING) + } + + MatchingStrategy equalToXml(Object value) { + return new MatchingStrategy(value, MatchingStrategy.Type.EQUAL_TO_XML) + } + + MatchingStrategy equalToJson(Object value) { + return new MatchingStrategy(value, MatchingStrategy.Type.EQUAL_TO_JSON) + } + + MatchingStrategy absent() { + return new MatchingStrategy(true, MatchingStrategy.Type.ABSENT) + } + + void assertThatSidesMatch(Object stubSide, OptionalProperty testSide) { + throw new IllegalStateException("Optional can be used only for the stub side of the request!") + } + +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ServerRequest extends Request { + ServerRequest(Request request) { + super(request) + } +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ClientRequest extends Request { + ClientRequest(Request request) { + super(request) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Response.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Response.groovy new file mode 100644 index 0000000000..454841becd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Response.groovy @@ -0,0 +1,104 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString +import groovy.transform.TypeChecked + +/** + * Represents the response side of the HTTP communication + * + * @since 1.0.0 + */ +@TypeChecked +@EqualsAndHashCode +@ToString(includePackage = false, includeFields = true) +class Response extends Common { + + DslProperty status + DslProperty delay + Headers headers + Body body + boolean async + + Response() { + } + + Response(Response response) { + this.status = response.status + this.headers = response.headers + this.body = response.body + } + + void status(int status) { + this.status = toDslProperty(status) + } + + void status(DslProperty status) { + this.status = toDslProperty(status) + } + + void headers(@DelegatesTo(Headers) Closure closure) { + this.headers = new Headers() + closure.delegate = headers + closure() + } + + void body(Map body) { + this.body = new Body(convertObjectsToDslProperties(body)) + } + + void body(List body) { + this.body = new Body(convertObjectsToDslProperties(body)) + } + + void body(Object bodyAsValue) { + this.body = new Body(bodyAsValue) + } + + void fixedDelayMilliseconds(int timeInMilliseconds) { + this.delay = toDslProperty(timeInMilliseconds) + } + + void async() { + this.async = true + } + + void assertThatSidesMatch(OptionalProperty stubSide, Object testSide) { + throw new IllegalStateException("Optional can be used only in the test side of the response!") + } +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ServerResponse extends Response { + ServerResponse(Response request) { + super(request) + } +} + +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +class ClientResponse extends Response { + ClientResponse(Response request) { + super(request) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ServerDslProperty.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ServerDslProperty.groovy new file mode 100644 index 0000000000..3cf7ec93cc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/ServerDslProperty.groovy @@ -0,0 +1,36 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +/** + * Represents a server side {@link DslProperty} + * + * @since 1.0.0 + */ +@CompileStatic +@EqualsAndHashCode(includeFields = true) +@ToString(includePackage = false) +class ServerDslProperty extends DslProperty { + + ServerDslProperty(Object singleValue) { + super(singleValue) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Url.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Url.groovy new file mode 100644 index 0000000000..1abee32aa5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/Url.groovy @@ -0,0 +1,53 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +import static org.springframework.cloud.contract.spec.util.ValidateUtils.validateServerValueIsAvailable + +/** + * Represents a URL that may contain query parameters + * + * @since 1.0.0 + */ +@ToString(includePackage = false, includeFields = true, includeNames = true) +@EqualsAndHashCode(includeFields = true) +@CompileStatic +class Url extends DslProperty { + + QueryParameters queryParameters + + Url(DslProperty prop) { + super(prop.clientValue, prop.serverValue) + validateServerValueIsAvailable(prop.serverValue, "Url") + } + + Url(Object url) { + super(url) + validateServerValueIsAvailable(url, "Url") + } + + void queryParameters(@DelegatesTo(QueryParameters) Closure closure) { + this.queryParameters = new QueryParameters() + closure.delegate = queryParameters + closure() + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/UrlPath.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/UrlPath.groovy new file mode 100644 index 0000000000..df4f277459 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/internal/UrlPath.groovy @@ -0,0 +1,41 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.ToString + +/** + * Represents a url path + * + * @since 1.0.0 + */ +@ToString(includePackage = false, includeFields = true, includeNames = true) +@EqualsAndHashCode(includeFields = true) +@CompileStatic +class UrlPath extends Url { + + UrlPath(String path) { + super(path) + } + + UrlPath(DslProperty path) { + super(path) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/util/ValidateUtils.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/util/ValidateUtils.groovy new file mode 100644 index 0000000000..087ddb77f0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/main/groovy/org/springframework/cloud/contract/spec/util/ValidateUtils.groovy @@ -0,0 +1,69 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.util + +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.internal.DslProperty +import org.springframework.cloud.contract.spec.internal.MatchingStrategy + +import java.util.regex.Pattern + +import static org.springframework.cloud.contract.spec.internal.MatchingStrategy.Type.ABSENT +import static org.springframework.cloud.contract.spec.internal.MatchingStrategy.Type.EQUAL_TO + +/** + * Checks the validity of DSL entries. + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @since 1.0.0 + */ +@TypeChecked +class ValidateUtils { + + static Object validateServerValueIsAvailable(Object value) { + validateServerValueIsAvailable(value, "Server value") + return value + } + + static Object validateServerValueIsAvailable(Object value, String msg) { + validateServerValue(value, msg) + return value + } + + static void validateServerValue(Pattern pattern, String msg) { + throw new IllegalStateException("$msg can't be a pattern for the server side") + } + + static List ALLOWED_MATCHING_TYPES_ON_SERVER_SIDE = [EQUAL_TO, ABSENT] + + static void validateServerValue(MatchingStrategy matchingStrategy, String msg) { + if (!ALLOWED_MATCHING_TYPES_ON_SERVER_SIDE.contains(matchingStrategy.type)) { + throw new IllegalStateException("$msg can't be of a matching type: $matchingStrategy.type for the server side") + } + validateServerValue(matchingStrategy.serverValue, msg) + } + + static void validateServerValue(DslProperty value, String msg) { + validateServerValue(value.serverValue, msg) + } + + static void validateServerValue(Object value, String msg) { + // OK + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/test/groovy/org/springframework/cloud/contract/spec/internal/ExecutionPropertySpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/test/groovy/org/springframework/cloud/contract/spec/internal/ExecutionPropertySpec.groovy new file mode 100644 index 0000000000..65b3997d99 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/test/groovy/org/springframework/cloud/contract/spec/internal/ExecutionPropertySpec.groovy @@ -0,0 +1,35 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import spock.lang.Specification + +class ExecutionPropertySpec extends Specification { + + def 'should insert passed value in place of $it placeholder'() { + given: + String commandToExecute = 'commandToExecute($it)' + ExecutionProperty executionProperty = new ExecutionProperty(commandToExecute) + and: + String valueToInsert = 'someObject.itsValue' + when: + String commandWithInsertedValue = executionProperty.insertValue(valueToInsert) + then: + 'commandToExecute(someObject.itsValue)' == commandWithInsertedValue + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/test/groovy/org/springframework/cloud/contract/spec/internal/RegexPatternsSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/test/groovy/org/springframework/cloud/contract/spec/internal/RegexPatternsSpec.groovy new file mode 100644 index 0000000000..80b9333bce --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-spec/src/test/groovy/org/springframework/cloud/contract/spec/internal/RegexPatternsSpec.groovy @@ -0,0 +1,78 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import spock.lang.Specification + +import java.util.regex.Pattern + +class RegexPatternsSpec extends Specification { + + RegexPatterns regexPatterns = new RegexPatterns() + + def "should generate a regex for ip address [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.ipAddress()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + '123.123.123.123' || true + 'a.b.' || false + } + + def "should generate a regex for hostname [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.hostname()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + 'https://asd.com' || true + 'https://asd.com:8080' || true + 'https://localhost' || true + 'https://localhost:8080' || true + 'https://asd.com/asd' || false + 'asd.com' || false + } + + def "should generate a regex for email [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.email()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + 'asd@asd.com' || true + 'a.b.' || false + } + + def "should generate a regex for url [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.url()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + 'ftp://asd.com:9090/asd/a?a=b' || true + 'a.b.' || false + } + + def "should generate a regex for a number [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.number()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + '1' || true + '1.0' || true + '0.1' || true + '.1' || true + '1.' || false + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/README.adoc new file mode 100644 index 0000000000..99ed7baee7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/README.adoc @@ -0,0 +1,54 @@ +=== Stub Runner Boot + +Spring Cloud Contract Verifier 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 usecases is to run some smoke (end to end) tests on a deployed application. You can read + more about this in the http://toomuchcoding.com/blog/2015/09/27/microservice-deployment/["Microservice Deployment" article at Too Much Coding blog.] + +==== How to use it? + +Just add the + +[source,groovy,indent=0] +---- +compile "org.springframework.cloud.contract:stub-runner-boot:${verifierVersion}" +---- + +and a messaging implementation: + +[source,groovy,indent=0] +---- +// for Apache Camel +compile "org.springframework.cloud.contract:spring-cloud-contract-stub-runner-camel:${verifierVersion}" +// for Spring Integration +compile "org.springframework.cloud.contract:spring-cloud-contract-stub-runner-integration:${verifierVersion}" +// for Spring Cloud Stream +compile "org.springframework.cloud.contract:spring-cloud-contract-stub-runner-stream:${verifierVersion}" +---- + +Build a fat-jar and you're ready to go! + +For the properties check the *Stub Runner Spring* section. + +==== 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/boot/StubRunnerBootSpec.groovy[tags=boot_usage] +---- \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/build.gradle new file mode 100644 index 0000000000..a86573fc3a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/build.gradle @@ -0,0 +1,40 @@ +/* + * Copyright 2013-2016 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. + */ + +repositories { + mavenLocal() + jcenter() + maven { + url "http://repo.spring.io/snapshot" + } + maven { + url "http://repo.spring.io/milestone" + } +} + +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner-spring") + compile "org.springframework.boot:spring-boot-starter-web:${springBootVersion}" + + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile project(":$stubRunner-root:$stubRunner-messaging-root:$stubRunner-stream") + testCompile 'com.jayway.restassured:spring-mock-mvc:2.9.0' + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/HttpStubsController.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/HttpStubsController.groovy new file mode 100644 index 0000000000..35730cd6ff --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/HttpStubsController.groovy @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.boot + +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.cloud.contract.stubrunner.StubRunning +import org.springframework.http.HttpStatus +import org.springframework.http.ResponseEntity +import org.springframework.web.bind.annotation.PathVariable +import org.springframework.web.bind.annotation.RequestMapping +import org.springframework.web.bind.annotation.RestController + +/** + * @author Marcin Grzejszczak + */ +@RestController +@RequestMapping("/stubs") +class HttpStubsController { + + private final StubRunning stubRunning + + @Autowired + HttpStubsController(StubRunning stubRunning) { + this.stubRunning = stubRunning + } + + @RequestMapping + Map stubs() { + return stubRunning.runStubs().toIvyToPortMapping() + } + + @RequestMapping(path = "/{ivy:.*}") + ResponseEntity stub(@PathVariable String ivy) { + Integer port = stubRunning.runStubs().getPort(ivy) + if (port) { + return ResponseEntity.ok(port) + } + return new ResponseEntity(HttpStatus.NOT_FOUND) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/StubRunnerBoot.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/StubRunnerBoot.groovy new file mode 100644 index 0000000000..daedaba6d6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/StubRunnerBoot.groovy @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.boot + +import org.springframework.boot.SpringApplication +import org.springframework.boot.autoconfigure.AutoConfigureAfter +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean +import org.springframework.cloud.contract.stubrunner.spring.StubRunnerConfiguration +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessageBuilder +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessaging +import org.springframework.context.annotation.Bean + +/** + * @author Marcin Grzejszczak + */ +@SpringBootApplication +@AutoConfigureAfter(StubRunnerConfiguration.class) +class StubRunnerBoot { + + static void main(String[] args) { + SpringApplication.run(StubRunnerBoot.class, args); + } + + @Bean + @ConditionalOnMissingBean + ContractVerifierMessaging noOpContractVerifierMessaging() { + return new NoOpContractVerifierMessaging() + } + + @Bean + @ConditionalOnMissingBean + ContractVerifierMessageBuilder noOpContractVerifierMessageBuilder() { + return new NoOpContractVerifierMessageBuilder() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/TriggerController.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/TriggerController.groovy new file mode 100644 index 0000000000..d06760166a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/groovy/org/springframework/cloud/contract/stubrunner/boot/TriggerController.groovy @@ -0,0 +1,75 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.boot + +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.cloud.contract.stubrunner.StubFinder +import org.springframework.http.HttpStatus +import org.springframework.http.ResponseEntity +import org.springframework.web.bind.annotation.PathVariable +import org.springframework.web.bind.annotation.RequestMapping +import org.springframework.web.bind.annotation.RestController + +import static org.springframework.web.bind.annotation.RequestMethod.GET +import static org.springframework.web.bind.annotation.RequestMethod.POST + +/** + * @author Marcin Grzejszczak + */ +@RestController +@RequestMapping("/triggers") +@Slf4j +class TriggerController { + + private final StubFinder stubFinder + + @Autowired + TriggerController(StubFinder stubFinder) { + this.stubFinder = stubFinder + } + + @RequestMapping(method = POST, path = "/{label:.*}") + ResponseEntity>> trigger(@PathVariable String label) { + return respond(label) { + stubFinder.trigger(label) + } + } + + @RequestMapping(method = POST, path = "/{ivyNotation:.*}/{label:.*}") + ResponseEntity>> triggerByArtifact(@PathVariable String ivyNotation, @PathVariable String label) { + return respond(label) { + stubFinder.trigger(ivyNotation, label) + } + } + + @RequestMapping(method = GET) + Map> labels() { + return stubFinder.labels() + } + + private ResponseEntity>> respond(String label, Closure closure) { + try { + closure() + return ResponseEntity.ok().body() + } catch (Exception e) { + log.debug("Exception occurred while trying to return [$label] label", e) + return new ResponseEntity>>(stubFinder.labels(), HttpStatus.NOT_FOUND) + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..31aea03047 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.stubrunner.spring.StubRunnerConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/groovy/org/springframework/cloud/contract/stubrunner/boot/StubRunnerBootSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/groovy/org/springframework/cloud/contract/stubrunner/boot/StubRunnerBootSpec.groovy new file mode 100644 index 0000000000..40a2e22f41 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/groovy/org/springframework/cloud/contract/stubrunner/boot/StubRunnerBootSpec.groovy @@ -0,0 +1,118 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.boot + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc +import groovy.json.JsonSlurper +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.stubrunner.StubRunning +import org.springframework.cloud.stream.annotation.EnableBinding +import org.springframework.context.annotation.Configuration +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification + +/** + * @author Marcin Grzejszczak + */ +// tag::boot_usage[] +@ContextConfiguration(classes = [StubRunnerBootSpec, StubRunnerBoot], loader = SpringApplicationContextLoader) +@EnableBinding +@Configuration +class StubRunnerBootSpec extends Specification { + + @Autowired StubRunning stubRunning + + def setup() { + RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), + new TriggerController(stubRunning)) + } + + def 'should return a list of running stub servers in "full ivy:port" notation'() { + when: + String response = RestAssuredMockMvc.get('/stubs').body.asString() + then: + def root = new JsonSlurper().parseText(response) + root.'org.springframework.cloud.contract.verifier.stubs:streamService:0.0.1-SNAPSHOT:stubs' instanceof Integer + } + + def 'should return a port on which a [#stubId] stub is running'() { + when: + def response = RestAssuredMockMvc.get("/stubs/${stubId}") + then: + response.statusCode == 200 + response.body.as(Integer) > 0 + where: + stubId << ['org.springframework.cloud.contract.verifier.stubs:streamService:+:stubs', + 'org.springframework.cloud.contract.verifier.stubs:streamService:0.0.1-SNAPSHOT:stubs', + 'org.springframework.cloud.contract.verifier.stubs:streamService:+', + 'org.springframework.cloud.contract.verifier.stubs:streamService', + 'streamService'] + } + + def 'should return 404 when missing stub was called'() { + when: + def response = RestAssuredMockMvc.get("/stubs/a:b:c:d") + then: + response.statusCode == 404 + } + + def 'should return a list of messaging labels that can be triggered when version and classifier are passed'() { + when: + String response = RestAssuredMockMvc.get('/triggers').body.asString() + then: + def root = new JsonSlurper().parseText(response) + root.'org.springframework.cloud.contract.verifier.stubs:streamService:0.0.1-SNAPSHOT:stubs'?.containsAll(["delete_book","return_book_1","return_book_2"]) + } + + def 'should trigger a messaging label'() { + given: + StubRunning stubRunning = Mock() + RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), new TriggerController(stubRunning)) + when: + def response = RestAssuredMockMvc.post("/triggers/delete_book") + then: + response.statusCode == 200 + and: + 1 * stubRunning.trigger('delete_book') + } + + def 'should trigger a messaging label for a stub with [#stubId] ivy notation'() { + given: + StubRunning stubRunning = Mock() + RestAssuredMockMvc.standaloneSetup(new HttpStubsController(stubRunning), new TriggerController(stubRunning)) + when: + def response = RestAssuredMockMvc.post("/triggers/$stubId/delete_book") + then: + response.statusCode == 200 + and: + 1 * stubRunning.trigger(stubId, 'delete_book') + where: + stubId << ['org.springframework.cloud.contract.verifier.stubs:streamService:stubs', 'org.springframework.cloud.contract.verifier.stubs:streamService', 'streamService'] + } + + def 'should return when trigger is missing'() { + when: + def response = RestAssuredMockMvc.post("/triggers/missing_label") + then: + response.statusCode == 404 + def root = new JsonSlurper().parseText(response.body.asString()) + root.'org.springframework.cloud.contract.verifier.stubs:streamService:0.0.1-SNAPSHOT:stubs'?.containsAll(["delete_book","return_book_1","return_book_2"]) + } + +} +// end::boot_usage[] diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/application.yml new file mode 100644 index 0000000000..9b34d9d617 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/application.yml @@ -0,0 +1,2 @@ +stubrunner.stubs.repository.root: classpath:m2repo/repository/ +stubrunner.stubs.ids: org.springframework.cloud.contract.verifier.stubs:streamService \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/streamService-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/streamService-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..8613d57be0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/streamService-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + streamService + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata.xml new file mode 100644 index 0000000000..001cf26899 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-boot/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + streamService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/README.adoc new file mode 100644 index 0000000000..6fa5144dd0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/README.adoc @@ -0,0 +1,65 @@ +=== Stub Runner JUnit Rule + +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] +---- + +After that rule gets 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 + +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` implements the `StubFinder` it allows you to find the started stubs: + +[source,groovy,indent=0] +---- +include::../spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubFinder.groovy[] +---- + +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] +---- + +Check the *Common properties for JUnit and Spring* for more information on how to apply global configuration of Stub Runner. + +==== 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` 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] +---- + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/build.gradle new file mode 100644 index 0000000000..3349027ab9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/build.gradle @@ -0,0 +1,35 @@ +/* + * Copyright 2013-2016 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. + */ + +description = 'JUnit rule for stub-runner' + +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner") + + compile localGroovy() + compile 'junit:junit:4.12' + + testCompile('org.spockframework:spock-core:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'cglib:cglib-nodep:2.2' + testCompile 'org.objenesis:objenesis:2.1' + testCompile 'ch.qos.logback:logback-classic:1.1.3' + testCompile 'org.assertj:assertj-core:2.3.0' + testCompile 'org.apache.commons:commons-io:1.3.2' +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/main/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRule.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/main/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRule.java new file mode 100644 index 0000000000..f8067e292d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/main/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRule.java @@ -0,0 +1,223 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.junit; + +import java.net.URL; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Map; + +import org.junit.rules.TestRule; +import org.junit.runner.Description; +import org.junit.runners.model.Statement; +import org.springframework.cloud.contract.stubrunner.BatchStubRunner; +import org.springframework.cloud.contract.stubrunner.BatchStubRunnerFactory; +import org.springframework.cloud.contract.stubrunner.RunningStubs; +import org.springframework.cloud.contract.stubrunner.StubConfiguration; +import org.springframework.cloud.contract.stubrunner.StubFinder; +import org.springframework.cloud.contract.stubrunner.StubRunnerOptions; +import org.springframework.cloud.contract.stubrunner.StubRunnerOptionsBuilder; +import org.springframework.cloud.contract.spec.Contract; + +/** + * JUnit class rule that allows you to download the provided stubs. + * + * @author Marcin Grzejszczak + */ +public class StubRunnerRule implements TestRule, StubFinder { + private static final String DELIMITER = ":"; + private static final String LATEST_VERSION = "+"; + + private StubRunnerOptionsBuilder stubRunnerOptionsBuilder = new StubRunnerOptionsBuilder(defaultStubRunnerOptions()); + private BatchStubRunner stubFinder; + + @Override + public Statement apply(final Statement base, Description description) { + return new Statement() { + @Override + public void evaluate() throws Throwable { + before(); + base.evaluate(); + stubFinder.close(); + } + + private void before() { + stubFinder = new BatchStubRunnerFactory(stubRunnerOptionsBuilder.build()).buildBatchStubRunner(); + stubFinder.runStubs(); + } + }; + } + + private StubRunnerOptions defaultStubRunnerOptions() { + return new StubRunnerOptionsBuilder() + .withMinPort(Integer.valueOf(System.getProperty("stubrunner.port.range.min", "10000"))) + .withMaxPort(Integer.valueOf(System.getProperty("stubrunner.port.range.max", "15000"))) + .withStubRepositoryRoot(System.getProperty("stubrunner.stubs.repository.root", "")) + .withWorkOffline(Boolean.parseBoolean(System.getProperty("stubrunner.work-offline", "false"))) + .withStubsClassifier(System.getProperty("stubrunner.stubs.classifier", "stubs")) + .withStubs(System.getProperty("stubrunner.stubs.ids", "")) + .build(); + } + + /** + * Override all options + * + * @see StubRunnerOptions + */ + public StubRunnerRule options(StubRunnerOptions stubRunnerOptions) { + stubRunnerOptionsBuilder.withOptions(stubRunnerOptions); + return this; + } + + /** + * Min value of port for WireMock server + */ + public StubRunnerRule minPort(int minPort) { + stubRunnerOptionsBuilder.withMinPort(minPort); + return this; + } + + /** + * Max value of port for WireMock server + */ + public StubRunnerRule maxPort(int maxPort) { + stubRunnerOptionsBuilder.withMaxPort(maxPort); + return this; + } + + /** + * String URI of repository containing stubs + */ + public StubRunnerRule repoRoot(String repoRoot) { + stubRunnerOptionsBuilder.withStubRepositoryRoot(repoRoot); + return this; + } + + /** + * Should download stubs or use only the local repository + */ + public StubRunnerRule workOffline(boolean workOffline) { + stubRunnerOptionsBuilder.withWorkOffline(workOffline); + return this; + } + + /** + * Group Id, artifact Id, version and classifier of a single stub to download + */ + public StubRunnerRule downloadStub(String groupId, String artifactId, String version, String classifier) { + stubRunnerOptionsBuilder.withStubs(groupId + DELIMITER + artifactId + DELIMITER + version + DELIMITER + classifier); + return this; + } + + /** + * Group Id, artifact Id and classifier of a single stub to download in the latest version + */ + public StubRunnerRule downloadLatestStub(String groupId, String artifactId, String classifier) { + stubRunnerOptionsBuilder.withStubs(groupId + DELIMITER + artifactId + DELIMITER + LATEST_VERSION + DELIMITER + classifier); + return this; + } + + /** + * Group Id, artifact Id and version of a single stub to download + */ + public StubRunnerRule downloadStub(String groupId, String artifactId, String version) { + stubRunnerOptionsBuilder.withStubs(groupId + DELIMITER + artifactId + DELIMITER + version); + return this; + } + + /** + * Group Id, artifact Id of a single stub to download. Default classifier will be picked. + */ + public StubRunnerRule downloadStub(String groupId, String artifactId) { + stubRunnerOptionsBuilder.withStubs(groupId + DELIMITER + artifactId); + return this; + } + + /** + * Ivy notation of a single stub to download. + */ + public StubRunnerRule downloadStub(String ivyNotation) { + stubRunnerOptionsBuilder.withStubs(ivyNotation); + return this; + } + + /** + * Stubs to download in Ivy notations + */ + public StubRunnerRule downloadStubs(String... ivyNotations) { + stubRunnerOptionsBuilder.withStubs(Arrays.asList(ivyNotations)); + return this; + } + + /** + * Stubs to download in Ivy notations + */ + public StubRunnerRule downloadStubs(List ivyNotations) { + stubRunnerOptionsBuilder.withStubs(ivyNotations); + return this; + } + + /** + * Appends port to last added stub + */ + public StubRunnerRule withPort(Integer port) { + stubRunnerOptionsBuilder.withPort(port); + return this; + } + + @Override + public URL findStubUrl(String groupId, String artifactId) { + return stubFinder.findStubUrl(groupId, artifactId); + } + + @Override + public URL findStubUrl(String ivyNotation) { + return stubFinder.findStubUrl(ivyNotation); + } + + @Override + public RunningStubs findAllRunningStubs() { + return stubFinder.findAllRunningStubs(); + } + + @Override + public Map> getContracts() { + return stubFinder.getContracts(); + } + + @Override + public boolean trigger(String ivyNotation, String labelName) { + return stubFinder.trigger(ivyNotation, labelName); + } + + @Override + public boolean trigger(String labelName) { + return stubFinder.trigger(labelName); + } + + @Override + public boolean trigger() { + return stubFinder.trigger(); + } + + @Override + public Map> labels() { + return stubFinder.labels(); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java new file mode 100644 index 0000000000..06519312b3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleCustomPortJUnitTest.java @@ -0,0 +1,85 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.junit; + +import java.io.InputStream; +import java.net.URI; + +import org.apache.commons.io.IOUtils; +import org.assertj.core.api.BDDAssertions; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Test; + +import static org.assertj.core.api.BDDAssertions.then; + +/** + * @author Marcin Grzejszczak + */ +public class StubRunnerRuleCustomPortJUnitTest { + + @BeforeClass + @AfterClass + public static void setupProps() { + System.getProperties().setProperty("stubrunner.stubs.repository.root", ""); + System.getProperties().setProperty("stubrunner.stubs.classifier", "stubs"); + } + + // tag::classrule_with_port[] + @ClassRule public static StubRunnerRule rule = new StubRunnerRule() + .repoRoot(repoRoot()) + .downloadStub("org.springframework.cloud.contract.verifier.stubs", "loanIssuance") + .withPort(12345) + .downloadStub("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer:12346"); + // end::classrule_with_port[] + + @Test + public void should_start_wiremock_servers() throws Exception { + // expect: 'WireMocks are running' + then(rule.findStubUrl("org.springframework.cloud.contract.verifier.stubs", "loanIssuance")).isNotNull(); + then(rule.findStubUrl("loanIssuance")).isNotNull(); + then(rule.findStubUrl("loanIssuance")).isEqualTo(rule.findStubUrl("org.springframework.cloud.contract.verifier.stubs", "loanIssuance")); + then(rule.findStubUrl("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer")).isNotNull(); + // and: + BDDAssertions.then(rule.findAllRunningStubs().isPresent("loanIssuance")).isTrue(); + BDDAssertions.then(rule.findAllRunningStubs().isPresent("org.springframework.cloud.contract.verifier.stubs", "fraudDetectionServer")).isTrue(); + BDDAssertions.then(rule.findAllRunningStubs().isPresent("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer")).isTrue(); + // and: 'Stubs were registered' + then(httpGet(rule.findStubUrl("loanIssuance").toString() + "/name")).isEqualTo("loanIssuance"); + then(httpGet(rule.findStubUrl("fraudDetectionServer").toString() + "/name")).isEqualTo("fraudDetectionServer"); + // and: 'The port is fixed' + // tag::test_with_port[] + then(rule.findStubUrl("loanIssuance")).isEqualTo(URI.create("http://localhost:12345").toURL()); + then(rule.findStubUrl("fraudDetectionServer")).isEqualTo(URI.create("http://localhost:12346").toURL()); + // end::test_with_port[] + } + + private static String repoRoot() { + try { + return StubRunnerRuleCustomPortJUnitTest.class.getResource("/m2repo/repository/").toURI().toString(); + } catch (Exception e) { + return ""; + } + } + + private String httpGet(String url) throws Exception { + try(InputStream stream = URI.create(url).toURL().openStream()) { + return IOUtils.toString(stream); + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java new file mode 100644 index 0000000000..e5ae1d1c15 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleJUnitTest.java @@ -0,0 +1,81 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.junit; + +import java.io.InputStream; +import java.net.URI; + +import org.apache.commons.io.IOUtils; +import org.assertj.core.api.BDDAssertions; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Test; + +import static org.assertj.core.api.BDDAssertions.then; + +/** + * @author Marcin Grzejszczak + */ +public class StubRunnerRuleJUnitTest { + + @BeforeClass + @AfterClass + public static void setupProps() { + System.getProperties().setProperty("stubrunner.stubs.repository.root", ""); + System.getProperties().setProperty("stubrunner.stubs.classifier", "stubs"); + } + + // tag::classrule[] + @ClassRule public static StubRunnerRule rule = new StubRunnerRule() + .repoRoot(repoRoot()) + .downloadStub("org.springframework.cloud.contract.verifier.stubs", "loanIssuance") + .downloadStub("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer"); + // end::classrule[] + + // tag::test[] + @Test + public void should_start_wiremock_servers() throws Exception { + // expect: 'WireMocks are running' + then(rule.findStubUrl("org.springframework.cloud.contract.verifier.stubs", "loanIssuance")).isNotNull(); + then(rule.findStubUrl("loanIssuance")).isNotNull(); + then(rule.findStubUrl("loanIssuance")).isEqualTo(rule.findStubUrl("org.springframework.cloud.contract.verifier.stubs", "loanIssuance")); + then(rule.findStubUrl("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer")).isNotNull(); + // and: + BDDAssertions.then(rule.findAllRunningStubs().isPresent("loanIssuance")).isTrue(); + BDDAssertions.then(rule.findAllRunningStubs().isPresent("org.springframework.cloud.contract.verifier.stubs", "fraudDetectionServer")).isTrue(); + BDDAssertions.then(rule.findAllRunningStubs().isPresent("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer")).isTrue(); + // and: 'Stubs were registered' + then(httpGet(rule.findStubUrl("loanIssuance").toString() + "/name")).isEqualTo("loanIssuance"); + then(httpGet(rule.findStubUrl("fraudDetectionServer").toString() + "/name")).isEqualTo("fraudDetectionServer"); + } + // end::test[] + + private static String repoRoot() { + try { + return StubRunnerRuleJUnitTest.class.getResource("/m2repo/repository/").toURI().toString(); + } catch (Exception e) { + return ""; + } + } + + private String httpGet(String url) throws Exception { + try(InputStream stream = URI.create(url).toURL().openStream()) { + return IOUtils.toString(stream); + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleSpec.groovy new file mode 100644 index 0000000000..3399d25ea0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/groovy/org/springframework/cloud/contract/stubrunner/junit/StubRunnerRuleSpec.groovy @@ -0,0 +1,58 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.junit + +import org.junit.AfterClass +import org.junit.BeforeClass +import org.junit.ClassRule +import spock.lang.Shared +import spock.lang.Specification + +/** + * @author Marcin Grzejszczak + */ +class StubRunnerRuleSpec extends Specification { + + @BeforeClass + @AfterClass + void setupProps() { + System.getProperties().setProperty("stubrunner.stubs.repository.root", ""); + System.getProperties().setProperty("stubrunner.stubs.classifier", "stubs"); + } + + // tag::classrule[] + @ClassRule @Shared StubRunnerRule rule = new StubRunnerRule() + .repoRoot(StubRunnerRuleSpec.getResource("/m2repo/repository").toURI().toString()) + .downloadStub("org.springframework.cloud.contract.verifier.stubs", "loanIssuance") + .downloadStub("org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer") + + def 'should start WireMock servers'() { + expect: 'WireMocks are running' + rule.findStubUrl('org.springframework.cloud.contract.verifier.stubs', 'loanIssuance') != null + rule.findStubUrl('loanIssuance') != null + rule.findStubUrl('loanIssuance') == rule.findStubUrl('org.springframework.cloud.contract.verifier.stubs', 'loanIssuance') + rule.findStubUrl('org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer') != null + and: + rule.findAllRunningStubs().isPresent('loanIssuance') + rule.findAllRunningStubs().isPresent('org.springframework.cloud.contract.verifier.stubs', 'fraudDetectionServer') + rule.findAllRunningStubs().isPresent('org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer') + and: 'Stubs were registered' + "${rule.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance' + "${rule.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer' + } + // end::classrule[] +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/logback.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/logback.xml new file mode 100644 index 0000000000..7eecabf2f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/logback.xml @@ -0,0 +1,30 @@ + + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..40610c8cdb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + fraudDetectionServer + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml new file mode 100644 index 0000000000..281b9b3b80 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + fraudDetectionServer + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..59db343686 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + loanIssuance + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml new file mode 100644 index 0000000000..615428dae6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-junit/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + loanIssuance + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062111 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/README.adoc new file mode 100644 index 0000000000..3fbd56f5dd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/README.adoc @@ -0,0 +1,123 @@ +: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 + +To use it you have to add the following dependency to your project (example for Gradle): + +[source,groovy,indent=0] +---- +testCompile "org.springframework.cloud.contract:stub-runner-camel:${verifierVersion}" +---- + +==== 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/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/build.gradle new file mode 100644 index 0000000000..4aac34bc8e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/build.gradle @@ -0,0 +1,33 @@ +/* + * Copyright 2013-2016 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. + */ +String verifier = "spring-cloud-contract-verifier" +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner-spring") + compile project(":$verifier-root:$verifier-messaging-root:$verifier-camel") + compile "org.apache.camel:camel-spring-boot-starter:${camelVersion}" + compile "org.apache.camel:camel-jackson:${camelVersion}" + + testCompile "org.springframework:spring-beans:${springVersion}" + testCompile "org.apache.camel:camel-jms:${camelVersion}" + testCompile 'org.apache.activemq:activemq-camel:5.12.1' + testCompile 'org.apache.activemq:activemq-pool:5.12.1' + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelConfiguration.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelConfiguration.groovy new file mode 100644 index 0000000000..9acb8502c2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelConfiguration.groovy @@ -0,0 +1,51 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.camel + +import org.apache.camel.RoutesBuilder +import org.apache.camel.spring.SpringRouteBuilder +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.stubrunner.BatchStubRunner +import org.springframework.cloud.contract.stubrunner.StubConfiguration +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration + +/** + * Camel configuration that iterates over the downloaded Groovy DSLs + * and registers a route for each DSL. + * + * @author Marcin Grzejszczak + */ +@Configuration +class StubRunnerCamelConfiguration { + + @Bean + RoutesBuilder myRouter(BatchStubRunner batchStubRunner) { + return new SpringRouteBuilder() { + @Override + public void configure() throws Exception { + Map> contracts = batchStubRunner.contracts + (contracts.values().flatten() as Collection).findAll { it?.input?.messageFrom?.clientValue && it?.outputMessage?.sentTo }.each { + from(it.input.messageFrom.clientValue) + .filter(new StubRunnerCamelPredicate(it)) + .process(new StubRunnerCamelProcessor(it)) + .to(it.outputMessage.sentTo.clientValue) + } + } + }; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelPredicate.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelPredicate.groovy new file mode 100644 index 0000000000..3e5dc0448c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelPredicate.groovy @@ -0,0 +1,79 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.camel + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import com.toomuchcoding.jsonassert.JsonVerifiable +import groovy.transform.PackageScope +import org.springframework.cloud.contract.spec.Contract +import org.apache.camel.Exchange +import org.apache.camel.Predicate +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.cloud.contract.verifier.util.JsonPaths +import org.springframework.cloud.contract.verifier.util.JsonToJsonPathsConverter + +import java.util.regex.Pattern + +/** + * Passes through a message that matches the one defined in the DSL + * + * @author Marcin Grzejszczak + */ +@PackageScope +class StubRunnerCamelPredicate implements Predicate { + + private final Contract groovyDsl + private final ContractVerifierObjectMapper objectMapper = new ContractVerifierObjectMapper() + + StubRunnerCamelPredicate(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + @Override + boolean matches(Exchange exchange) { + if(!headersMatch(exchange)){ + return false + } + Object inputMessage = exchange.in.body + JsonPaths jsonPaths = JsonToJsonPathsConverter.transformToJsonPathWithStubsSideValues(groovyDsl.input.messageBody) + DocumentContext parsedJson = JsonPath.parse(objectMapper.writeValueAsString(inputMessage)) + return jsonPaths.every { matchesJsonPath(parsedJson, it) } + } + + private boolean matchesJsonPath(DocumentContext parsedJson, JsonVerifiable jsonVerifiable) { + try { + JsonAssertion.assertThat(parsedJson).matchesJsonPath(jsonVerifiable.jsonPath()) + return true + } catch (Exception e) { + return false + } + } + + private boolean headersMatch(Exchange exchange) { + Map headers = exchange.getIn().getHeaders() + return groovyDsl.input.messageHeaders.entries.every { + String name = it.name + Object value = it.clientValue + Object valueInHeader = headers.get(name) + return value instanceof Pattern ? + value.matcher(valueInHeader.toString()).matches() : + valueInHeader == value + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelProcessor.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelProcessor.groovy new file mode 100644 index 0000000000..acdf70191b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelProcessor.groovy @@ -0,0 +1,55 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.camel + +import groovy.transform.PackageScope +import org.springframework.cloud.contract.verifier.util.BodyExtractor +import org.apache.camel.Exchange +import org.apache.camel.Message +import org.apache.camel.Processor +import org.springframework.cloud.contract.spec.Contract + +/** + * Sends forward a message defined in the DSL. Also removes headers from the + * input message and provides the headers from the DSL. + * + * @author Marcin Grzejszczak + */ +@PackageScope +class StubRunnerCamelProcessor implements Processor { + + private final Contract groovyDsl + + StubRunnerCamelProcessor(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + @Override + void process(Exchange exchange) throws Exception { + Message input = exchange.in + groovyDsl.input.messageHeaders?.entries?.each { + input.removeHeader(it.name) + } + if (!groovyDsl.outputMessage) { + return + } + input.body = BodyExtractor.extractStubValueFrom(groovyDsl.outputMessage.body) + groovyDsl.outputMessage.headers?.entries?.each { + input.setHeader(it.name, it.clientValue) + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..26adb8c16c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.stubrunner.messaging.camel.StubRunnerCamelConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/BookReturned.groovy new file mode 100644 index 0000000000..72a689a659 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/BookReturned.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.camel + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode + +@CompileStatic +@EqualsAndHashCode +class BookReturned implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy new file mode 100644 index 0000000000..544ca961b3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/CamelStubRunnerSpec.groovy @@ -0,0 +1,227 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.camel + +import groovy.json.JsonOutput +import groovy.json.JsonSlurper +import org.apache.activemq.camel.component.ActiveMQComponent +import org.apache.camel.CamelContext +import org.apache.camel.Exchange +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.beans.factory.annotation.Value +import org.springframework.boot.autoconfigure.EnableAutoConfiguration +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.stubrunner.StubFinder +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.ComponentScan +import org.springframework.context.annotation.Configuration +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification +/** + * @author Marcin Grzejszczak + */ +@Configuration +@ComponentScan +@EnableAutoConfiguration +@ContextConfiguration(classes = CamelStubRunnerSpec, loader = SpringApplicationContextLoader) +class CamelStubRunnerSpec extends Specification { + + @Autowired StubFinder stubFinder + @Autowired CamelContext camelContext + + def setup() { + // ensure that message were taken from the queue + camelContext.createConsumerTemplate().receive('jms:output', 100) + } + + def 'should download the stub and register a route for it'() { + when: + // tag::client_send[] + camelContext.createProducerTemplate().sendBodyAndHeaders('jms:input', new BookReturned('foo'), [sample: 'header']) + // end::client_send[] + then: + // tag::client_receive[] + Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000) + // end::client_receive[] + and: + // tag::client_receive_message[] + receivedMessage != null + assertThatBodyContainsBookNameFoo(receivedMessage.in.body) + receivedMessage.in.headers.get('BOOK-NAME') == 'foo' + // end::client_receive_message[] + } + + def 'should trigger a message by label'() { + when: + // tag::client_trigger[] + stubFinder.trigger('return_book_1') + // end::client_trigger[] + then: + // tag::client_trigger_receive[] + Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000) + // end::client_trigger_receive[] + and: + // tag::client_trigger_message[] + receivedMessage != null + assertThatBodyContainsBookNameFoo(receivedMessage.in.body) + receivedMessage.in.headers.get('BOOK-NAME') == 'foo' + // end::client_trigger_message[] + } + + def 'should trigger a label for the existing groupId:artifactId'() { + when: + // tag::trigger_group_artifact[] + stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:camelService', 'return_book_1') + // end::trigger_group_artifact[] + then: + Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000) + and: + receivedMessage != null + assertThatBodyContainsBookNameFoo(receivedMessage.in.body) + receivedMessage.in.headers.get('BOOK-NAME') == 'foo' + } + + def 'should trigger a label for the existing artifactId'() { + when: + // tag::trigger_artifact[] + stubFinder.trigger('camelService', 'return_book_1') + // end::trigger_artifact[] + then: + Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000) + and: + receivedMessage != null + assertThatBodyContainsBookNameFoo(receivedMessage.in.body) + receivedMessage.in.headers.get('BOOK-NAME') == 'foo' + } + + def 'should throw an exception when missing label is passed'() { + when: + stubFinder.trigger('missing label') + then: + thrown(IllegalArgumentException) + } + + def 'should throw an exception when missing label and artifactid is passed'() { + when: + stubFinder.trigger('some:service', 'return_book_1') + then: + thrown(IllegalArgumentException) + } + + def 'should trigger messages by running all triggers'() { + when: + // tag::trigger_all[] + stubFinder.trigger() + // end::trigger_all[] + then: + Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 5000) + and: + receivedMessage != null + assertThatBodyContainsBookNameFoo(receivedMessage.in.body) + receivedMessage.in.headers.get('BOOK-NAME') == 'foo' + } + + def 'should trigger a label with no output message'() { + when: + // tag::trigger_no_output[] + camelContext.createProducerTemplate().sendBodyAndHeaders('jms:delete', new BookReturned('foo'), [sample: 'header']) + // end::trigger_no_output[] + then: + noExceptionThrown() + } + + def 'should not trigger a message that does not match input'() { + when: + camelContext.createProducerTemplate().sendBodyAndHeaders('jms:input', new BookReturned('notmatching'), [wrong: 'header_value']) + then: + Exchange receivedMessage = camelContext.createConsumerTemplate().receive('jms:output', 100) + and: + receivedMessage == null + } + + private boolean assertThatBodyContainsBookNameFoo(Object payload) { + String objectAsString = payload instanceof String ? payload : + JsonOutput.toJson(payload) + def json = new JsonSlurper().parseText(objectAsString) + return json.bookName == 'foo' + } + + @Bean + ActiveMQComponent activeMQComponent(@Value('${activemq.url:vm://localhost?broker.persistent=false}') String url) { + return new ActiveMQComponent(brokerURL: url) + } + + Contract dsl = + // tag::sample_dsl[] + Contract.make { + label 'return_book_1' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('jms:output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::sample_dsl[] + + Contract dsl2 = + // tag::sample_dsl_2[] + Contract.make { + label 'return_book_2' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::sample_dsl_2[] + + Contract dsl3 = + // tag::sample_dsl_3[] + Contract.make { + label 'delete_book' + input { + messageFrom('jms:delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + // end::sample_dsl_3[] +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelProcessorSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelProcessorSpec.groovy new file mode 100644 index 0000000000..279782c65e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/camel/StubRunnerCamelProcessorSpec.groovy @@ -0,0 +1,98 @@ +package org.springframework.cloud.contract.stubrunner.messaging.camel + +import org.apache.camel.CamelContext +import org.apache.camel.Exchange +import org.apache.camel.builder.ExchangeBuilder +import org.apache.camel.spring.SpringCamelContext +import org.springframework.cloud.contract.spec.Contract +import spock.lang.Specification + +class StubRunnerCamelProcessorSpec extends Specification { + + CamelContext camelContext = new SpringCamelContext() + Exchange message = ExchangeBuilder.anExchange(camelContext).build() + + def noOutputMessageContract = Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookId: $(consumer(regex('[0-9]+')), producer('123')) + ]) + messageHeaders { + header('sample', 'header') + } + } + } + + def 'should not process the message if there is no output message'() { + given: + StubRunnerCamelProcessor processor = new StubRunnerCamelProcessor(noOutputMessageContract) + when: + processor.process(message) + then: + noExceptionThrown() + } + + def dsl = Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookId: $(consumer(regex('[0-9]+')), producer('123')) + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('returnBook') + body([ + responseId: $(producer(regex('[0-9]+')), consumer('123')) + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + + def 'should process message when it has an output message section'() { + given: + StubRunnerCamelProcessor processor = new StubRunnerCamelProcessor(dsl) + when: + processor.process(message) + then: + message.getIn().getBody(String) == '{"responseId":"123"}' + } + + def dslWithRegexInGString = Contract.make { + // Human readable description + description 'Should produce valid sensor data' + // Label by means of which the output message can be triggered + label 'sensor1' + // input to the contract + input { + // the contract will be triggered by a method + triggeredBy('createSensorData()') + } + // output message of the contract + outputMessage { + // destination to which the output message will be sent + sentTo 'sensor-data' + headers { + header('contentType': 'application/json') + } + // the body of the output message + body("""{"id":"${value(producer(regex('[0-9]+')), consumer('99'))}","temperature":"123.45"}""") + } + } + + def 'should convert dsl into message with regex in GString'() { + given: + StubRunnerCamelProcessor processor = new StubRunnerCamelProcessor(dslWithRegexInGString) + when: + processor.process(message) + then: + message.getIn().getBody(String) == '''{"id":"99","temperature":"123.45"}''' + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/application.yml new file mode 100644 index 0000000000..db021bb201 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/application.yml @@ -0,0 +1,2 @@ +stubrunner.stubs.repository.root: classpath:m2repo/repository/ +stubrunner.stubs.ids: org.springframework.cloud.contract.verifier.stubs:camelService \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/0.0.1-SNAPSHOT/camelService-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/0.0.1-SNAPSHOT/camelService-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..0b56465de4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/0.0.1-SNAPSHOT/camelService-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + camelService + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/0.0.1-SNAPSHOT/maven-metadata-local.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/0.0.1-SNAPSHOT/maven-metadata-local.xml new file mode 100644 index 0000000000..8ac2715bc8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/0.0.1-SNAPSHOT/maven-metadata-local.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + camelService + 0.0.1-SNAPSHOT + + + true + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/maven-metadata-local.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/maven-metadata-local.xml new file mode 100644 index 0000000000..237fd747a9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/maven-metadata-local.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + camelService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/maven-metadata.xml new file mode 100644 index 0000000000..237fd747a9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-camel/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/camelService/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + camelService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/README.adoc new file mode 100644 index 0000000000..89f5a0a180 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/README.adoc @@ -0,0 +1,131 @@ +: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 will automatically download the stubs and register the required +routes. + +==== Adding it to the project + +To use it you have to add the following dependency to your project (example for Gradle): + +[source,groovy,indent=0] +---- +testCompile "org.springframework.cloud.contract:stub-runner-integration:${verifierVersion}" +---- + +==== Examples + +===== Stubs structure + +Let us assume that we have the following Maven repository with a 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 +---- + +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/integration/IntegrationStubRunnerSpec.groovy[tags=sample_dsl,indent=0] +---- + +and number *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[] +---- + + +===== 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/integration/IntegrationStubRunnerSpec.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/integration/IntegrationStubRunnerSpec.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/integration/IntegrationStubRunnerSpec.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/integration/IntegrationStubRunnerSpec.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/integration/IntegrationStubRunnerSpec.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/integration/IntegrationStubRunnerSpec.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 `{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/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/build.gradle new file mode 100644 index 0000000000..714d543a31 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/build.gradle @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ +String verifier = "spring-cloud-contract-verifier" +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner-spring") + compile project(":$verifier-root:$verifier-messaging-root:$verifier-integration") + compile "org.springframework.integration:spring-integration-java-dsl:${springIntegrationDslVersion}" + compile 'com.fasterxml.jackson.core:jackson-databind:2.7.0' + + testCompile "org.springframework.boot:spring-boot-starter-integration:${springBootVersion}" + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationConfiguration.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationConfiguration.groovy new file mode 100644 index 0000000000..70f082d629 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationConfiguration.groovy @@ -0,0 +1,75 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.integration + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.stubrunner.StubConfiguration +import org.springframework.beans.factory.config.AutowireCapableBeanFactory +import org.springframework.cloud.contract.stubrunner.BatchStubRunner +import org.springframework.cloud.contract.stubrunner.spring.StubRunnerConfiguration +import org.springframework.context.Lifecycle +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration +import org.springframework.context.annotation.Import +import org.springframework.integration.dsl.FilterEndpointSpec +import org.springframework.integration.dsl.GenericEndpointSpec +import org.springframework.integration.dsl.IntegrationFlowBuilder +import org.springframework.integration.dsl.IntegrationFlows +import org.springframework.messaging.Message + +/** + * Spring Integration configuration that iterates over the downloaded Groovy DSLs + * and registers a flow for each DSL. + * + * @author Marcin Grzejszczak + */ +@Configuration +@Import(StubRunnerConfiguration) +@CompileStatic +class StubRunnerIntegrationConfiguration { + + @Bean + FlowRegistrar flowRegistrar(AutowireCapableBeanFactory beanFactory, BatchStubRunner batchStubRunner) { + Map> contracts = batchStubRunner.contracts + contracts.each { StubConfiguration key, Collection value -> + String name = "${key.groupId}_${key.artifactId}" + value.findAll { it?.input?.messageFrom?.clientValue }.each { Contract dsl -> + String flowName = "${name}_${dsl.label}_${dsl.hashCode()}" + IntegrationFlowBuilder builder = IntegrationFlows.from(dsl.input.messageFrom.clientValue) + .filter(new StubRunnerIntegrationMessageSelector(dsl), { FilterEndpointSpec e -> e.id("${flowName}.filter") } ) + .transform(new StubRunnerIntegrationTransformer(dsl), { GenericEndpointSpec e -> e.id("${flowName}.transformer") }) + if (dsl.outputMessage?.sentTo) { + builder = builder.channel(dsl.outputMessage.sentTo.clientValue) + } else { + builder = builder.handle(new DummyMessageHandler(), "handle") + } + beanFactory.initializeBean(builder.get(), flowName) + beanFactory.getBean("${flowName}.filter", Lifecycle.class).start(); + beanFactory.getBean("${flowName}.transformer", Lifecycle.class).start(); + } + } + return new FlowRegistrar() + } + + @CompileStatic + private static class DummyMessageHandler { + void handle(Message message) {} + } + + static class FlowRegistrar {} +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationMessageSelector.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationMessageSelector.groovy new file mode 100644 index 0000000000..ff4413d5d5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationMessageSelector.groovy @@ -0,0 +1,78 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.integration + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import com.toomuchcoding.jsonassert.JsonVerifiable +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.cloud.contract.verifier.util.JsonPaths +import org.springframework.cloud.contract.verifier.util.JsonToJsonPathsConverter +import org.springframework.integration.core.MessageSelector +import org.springframework.messaging.Message + +import java.util.regex.Pattern +/** + * Passes through a message that matches the one defined in the DSL + * + * @author Marcin Grzejszczak + */ +@CompileStatic +class StubRunnerIntegrationMessageSelector implements MessageSelector { + + private final Contract groovyDsl + private final ContractVerifierObjectMapper objectMapper = new ContractVerifierObjectMapper() + + StubRunnerIntegrationMessageSelector(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + @Override + boolean accept(Message message) { + if(!headersMatch(message)){ + return false + } + Object inputMessage = message.getPayload() + JsonPaths jsonPaths = JsonToJsonPathsConverter.transformToJsonPathWithStubsSideValues(groovyDsl.input.messageBody) + DocumentContext parsedJson = JsonPath.parse(objectMapper.writeValueAsString(inputMessage)) + return jsonPaths.every { matchesJsonPath(parsedJson, it) } + } + + private boolean matchesJsonPath(DocumentContext parsedJson, JsonVerifiable jsonVerifiable) { + try { + JsonAssertion.assertThat(parsedJson).matchesJsonPath(jsonVerifiable.jsonPath()) + return true + } catch (Exception e) { + return false + } + } + + private boolean headersMatch(Message message) { + Map headers = message.getHeaders() + return groovyDsl.input.messageHeaders.entries.every { + String name = it.name + Object value = it.clientValue + Object valueInHeader = headers.get(name) + return value instanceof Pattern ? + value.matcher(valueInHeader.toString()).matches() : + valueInHeader == value + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationTransformer.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationTransformer.groovy new file mode 100644 index 0000000000..0bf9278b01 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationTransformer.groovy @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.integration + +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.util.BodyExtractor +import org.springframework.integration.transformer.GenericTransformer +import org.springframework.messaging.Message +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder + +/** + * Sends forward a message defined in the DSL. + * + * @author Marcin Grzejszczak + */ +class StubRunnerIntegrationTransformer implements GenericTransformer, Message> { + + private final Contract groovyDsl + + StubRunnerIntegrationTransformer(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + @Override + Message transform(Message source) { + if (!groovyDsl.outputMessage) { + return source + } + String payload = BodyExtractor.extractStubValueFrom(groovyDsl.outputMessage.body) + Map headers = groovyDsl.outputMessage.headers.asStubSideMap() + return MessageBuilder.createMessage(payload, new MessageHeaders(headers)) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..a69b005443 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.stubrunner.messaging.integration.StubRunnerIntegrationConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/BookReturned.groovy new file mode 100644 index 0000000000..bbb47bbb60 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/BookReturned.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.integration + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode + +@CompileStatic +@EqualsAndHashCode +class BookReturned implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy new file mode 100644 index 0000000000..bdd7368377 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/IntegrationStubRunnerSpec.groovy @@ -0,0 +1,224 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.integration + +import groovy.json.JsonOutput +import groovy.json.JsonSlurper +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.autoconfigure.EnableAutoConfiguration +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.stubrunner.StubFinder +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.context.annotation.ComponentScan +import org.springframework.context.annotation.Configuration +import org.springframework.context.annotation.ImportResource +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification + +import java.util.concurrent.TimeUnit +/** + * @author Marcin Grzejszczak + */ +@Configuration +@ComponentScan +@EnableAutoConfiguration +@ContextConfiguration(classes = IntegrationStubRunnerSpec, loader = SpringApplicationContextLoader) +@ImportResource("classpath*:integration-context.xml") +class IntegrationStubRunnerSpec extends Specification { + + @Autowired StubFinder stubFinder + @Autowired ContractVerifierMessaging messaging + + def setup() { + // ensure that message were taken from the queue + messaging.receiveMessage('outputTest', 100, TimeUnit.MILLISECONDS) + } + + def 'should download the stub and register a route for it'() { + when: + // tag::client_send[] + messaging.send(new BookReturned('foo'), [sample: 'header'], 'input') + // end::client_send[] + then: + // tag::client_receive[] + ContractVerifierMessage receivedMessage = messaging.receiveMessage('outputTest') + // end::client_receive[] + and: + // tag::client_receive_message[] + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + // end::client_receive_message[] + } + + def 'should trigger a message by label'() { + when: + // tag::client_trigger[] + stubFinder.trigger('return_book_1') + // end::client_trigger[] + then: + // tag::client_trigger_receive[] + ContractVerifierMessage receivedMessage = messaging.receiveMessage('outputTest') + // end::client_trigger_receive[] + and: + // tag::client_trigger_message[] + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + // end::client_trigger_message[] + } + + def 'should trigger a label for the existing groupId:artifactId'() { + when: + // tag::trigger_group_artifact[] + stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:integrationService', 'return_book_1') + // end::trigger_group_artifact[] + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('outputTest') + and: + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + } + + def 'should trigger a label for the existing artifactId'() { + when: + // tag::trigger_artifact[] + stubFinder.trigger('integrationService', 'return_book_1') + // end::trigger_artifact[] + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('outputTest') + and: + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + } + + def 'should throw exception when missing label is passed'() { + when: + stubFinder.trigger('missing label') + then: + thrown(IllegalArgumentException) + } + + def 'should throw exception when missing label and artifactid is passed'() { + when: + stubFinder.trigger('some:service', 'return_book_1') + then: + thrown(IllegalArgumentException) + } + + def 'should trigger messages by running all triggers'() { + when: + // tag::trigger_all[] + stubFinder.trigger() + // end::trigger_all[] + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('outputTest') + and: + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + } + + def 'should trigger a label with no output message'() { + when: + // tag::trigger_no_output[] + messaging.send(new BookReturned('foo'), [sample: 'header'], 'delete') + // end::trigger_no_output[] + then: + noExceptionThrown() + } + + def 'should not trigger a message that does not match input'() { + when: + messaging.send(new BookReturned('not_matching'), [wrong: 'header_value'], 'input') + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('outputTest', 100, TimeUnit.MILLISECONDS) + and: + receivedMessage == null + } + + private boolean assertJsons(Object payload) { + String objectAsString = payload instanceof String ? payload : + JsonOutput.toJson(payload) + def json = new JsonSlurper().parseText(objectAsString) + return json.bookName == 'foo' + } + + Contract dsl = + // tag::sample_dsl[] + Contract.make { + label 'return_book_1' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::sample_dsl[] + + Contract dsl2 = + // tag::sample_dsl_2[] + Contract.make { + label 'return_book_2' + input { + messageFrom('input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::sample_dsl_2[] + + Contract dsl3 = + // tag::sample_dsl_3[] + Contract.make { + label 'delete_book' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + // end::sample_dsl_3[] + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationTransformerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationTransformerSpec.groovy new file mode 100644 index 0000000000..31b4d19ab4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/integration/StubRunnerIntegrationTransformerSpec.groovy @@ -0,0 +1,95 @@ +package org.springframework.cloud.contract.stubrunner.messaging.integration + +import org.springframework.cloud.contract.spec.Contract +import org.springframework.messaging.Message +import org.springframework.messaging.support.MessageBuilder +import spock.lang.Specification + +class StubRunnerIntegrationTransformerSpec extends Specification { + + Message message = MessageBuilder.withPayload("hello").build() + + def noOutputMessageContract = Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookId: $(consumer(regex('[0-9]+')), producer('123')) + ]) + messageHeaders { + header('sample', 'header') + } + } + } + + def 'should not transform the message if there is no output message'() { + given: + StubRunnerIntegrationTransformer transformer = new StubRunnerIntegrationTransformer(noOutputMessageContract) + when: + def result = transformer.transform(message) + then: + result.is(message) + } + + def dsl = Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookId: $(consumer(regex('[0-9]+')), producer('123')) + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('returnBook') + body([ + responseId: $(producer(regex('[0-9]+')), consumer('123')) + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + + def 'should convert dsl into message'() { + given: + StubRunnerIntegrationTransformer transformer = new StubRunnerIntegrationTransformer(dsl) + when: + def result = transformer.transform(message) + then: + result.payload == '{"responseId":"123"}' + } + + def dslWithRegexInGString = Contract.make { + // Human readable description + description 'Should produce valid sensor data' + // Label by means of which the output message can be triggered + label 'sensor1' + // input to the contract + input { + // the contract will be triggered by a method + triggeredBy('createSensorData()') + } + // output message of the contract + outputMessage { + // destination to which the output message will be sent + sentTo 'sensor-data' + headers { + header('contentType': 'application/json') + } + // the body of the output message + body("""{"id":"${value(producer(regex('[0-9]+')), consumer('99'))}","temperature":"123.45"}""") + } + } + + def 'should convert dsl into message with regex in GString'() { + given: + StubRunnerIntegrationTransformer transformer = new StubRunnerIntegrationTransformer(dslWithRegexInGString) + when: + def result = transformer.transform(message) + then: + result.payload == '''{"id":"99","temperature":"123.45"}''' + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/application.yml new file mode 100644 index 0000000000..911b24bbaa --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/application.yml @@ -0,0 +1,2 @@ +stubrunner.stubs.repository.root: classpath:m2repo/repository/ +stubrunner.stubs.ids: org.springframework.cloud.contract.verifier.stubs:integrationService:0.0.1-SNAPSHOT \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/integration-context.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/integration-context.xml new file mode 100644 index 0000000000..1fdb1bb847 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/integration-context.xml @@ -0,0 +1,35 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/0.0.1-SNAPSHOT/integrationService-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/0.0.1-SNAPSHOT/integrationService-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..0581ac022d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/0.0.1-SNAPSHOT/integrationService-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + integrationService + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/0.0.1-SNAPSHOT/maven-metadata-local.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/0.0.1-SNAPSHOT/maven-metadata-local.xml new file mode 100644 index 0000000000..e6c62c5897 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/0.0.1-SNAPSHOT/maven-metadata-local.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + integrationService + 0.0.1-SNAPSHOT + + + true + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/maven-metadata-local.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/maven-metadata-local.xml new file mode 100644 index 0000000000..f619bafb54 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/maven-metadata-local.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + integrationService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/maven-metadata.xml new file mode 100644 index 0000000000..f619bafb54 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-integration/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/integrationService/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + integrationService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/README.adoc new file mode 100644 index 0000000000..e93eaeb43b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/README.adoc @@ -0,0 +1,132 @@ +=== 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 will automatically download the stubs and register the required +routes. + +WARNING: In Stub Runner's integration with Stream the `messageFrom` or `sentTo` Strings are resolved +first as a `destination` of a channel, and then if there is no such `destination` it's resolved as a +channel name. + +==== Adding it to the project + +To use it you have to add the following dependency to your project (example for Gradle): + +[source,groovy,indent=0] +---- +testCompile "org.springframework.cloud.contract:stub-runner-stream:${verifierVersion}" +---- + +==== Examples + +===== Stubs structure + +Let us assume that we 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 +---- + +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/stream/StreamStubRunnerSpec.groovy[tags=sample_dsl,indent=0] +---- + +and number *2* + +[source,groovy] +---- +include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=sample_dsl_2,indent=0] +---- + +and the following Spring configuration: + +[source,yaml] +---- +include::src/test/resources/application.yml[] +---- + + +===== Scenario 1 (no input message) + +So as to trigger a message via the `return_book_1` label we'll 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] +---- + +Next we'll want 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] +---- + +And the received message would pass the following assertions + +[source,groovy] +---- +include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.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 `bookStorage` `destination`. + +[source,groovy] +---- +include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy[tags=client_send,indent=0] +---- + +Next we'll want 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] +---- + +And the received message would pass the following assertions + +[source,groovy] +---- +include::src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.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/stream/StreamStubRunnerSpec.groovy[tags=trigger_no_output,indent=0] +---- diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/build.gradle new file mode 100644 index 0000000000..e211645f41 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/build.gradle @@ -0,0 +1,31 @@ +/* + * Copyright 2013-2016 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. + */ +String verifier = "spring-cloud-contract-verifier" +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner-spring") + compile project(":$verifier-root:$verifier-messaging-root:$verifier-stream") + compile "org.springframework.integration:spring-integration-java-dsl:${springIntegrationDslVersion}" + + testCompile "org.springframework:spring-context:${springVersion}" + testCompile "org.springframework:spring-beans:${springVersion}" + testCompile "org.springframework.cloud:spring-cloud-stream-test-support:${springStreamVersion}" + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamConfiguration.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamConfiguration.groovy new file mode 100644 index 0000000000..f6c1eb7ceb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamConfiguration.groovy @@ -0,0 +1,94 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.stream + +import groovy.transform.CompileStatic +import org.slf4j.Logger +import org.slf4j.LoggerFactory +import org.springframework.beans.factory.config.AutowireCapableBeanFactory +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.stubrunner.BatchStubRunner +import org.springframework.cloud.contract.stubrunner.StubConfiguration +import org.springframework.cloud.contract.stubrunner.spring.StubRunnerConfiguration +import org.springframework.cloud.stream.config.BindingProperties +import org.springframework.cloud.stream.config.ChannelBindingServiceProperties +import org.springframework.context.Lifecycle +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration +import org.springframework.context.annotation.Import +import org.springframework.integration.dsl.FilterEndpointSpec +import org.springframework.integration.dsl.GenericEndpointSpec +import org.springframework.integration.dsl.IntegrationFlowBuilder +import org.springframework.integration.dsl.IntegrationFlows +import org.springframework.messaging.Message +/** + * Spring Cloud Stream configuration that iterates over the downloaded Groovy DSLs + * and registers a flow for each DSL. + * + * @author Marcin Grzejszczak + */ +@Configuration +@Import(StubRunnerConfiguration) +@CompileStatic +class StubRunnerStreamConfiguration { + + private static final Logger log = LoggerFactory.getLogger(StubRunnerStreamConfiguration) + + @Bean + FlowRegistrar flowRegistrar(AutowireCapableBeanFactory beanFactory, BatchStubRunner batchStubRunner) { + Map> contracts = batchStubRunner.contracts + contracts.each { StubConfiguration key, Collection value -> + String name = "${key.groupId}_${key.artifactId}" + value.findAll { it?.input?.messageFrom?.clientValue }.each { Contract dsl -> + String flowName = "${name}_${dsl.label}_${dsl.hashCode()}" + String from = resolvedDestination(beanFactory, dsl.input.messageFrom.clientValue) + IntegrationFlowBuilder builder = IntegrationFlows.from(from) + .filter(new StubRunnerStreamMessageSelector(dsl), { FilterEndpointSpec e -> e.id("${flowName}.filter") } ) + .transform(new StubRunnerStreamTransformer(dsl), { GenericEndpointSpec e -> e.id("${flowName}.transformer") }) + if (dsl.outputMessage?.sentTo) { + builder = builder.channel(resolvedDestination(beanFactory, dsl.outputMessage.sentTo.clientValue)) + } else { + builder = builder.handle(new DummyMessageHandler(), "handle") + } + beanFactory.initializeBean(builder.get(), flowName) + beanFactory.getBean("${flowName}.filter", Lifecycle.class).start(); + beanFactory.getBean("${flowName}.transformer", Lifecycle.class).start(); + } + } + return new FlowRegistrar() + } + + private String resolvedDestination(AutowireCapableBeanFactory context, String destination) { + ChannelBindingServiceProperties channelBindingServiceProperties = context.getBean(ChannelBindingServiceProperties.class); + String resolvedDestination = destination; + for (Map.Entry entry : channelBindingServiceProperties.getBindings().entrySet()) { + if (entry.getValue().getDestination().equals(destination)) { + log.debug("Found a channel named [{}] with destination [{}]", entry.getKey(), destination); + return entry.getKey(); + } + } + log.debug("No destination named [{}] was found. Assuming that the destination equals the channel name", destination); + return resolvedDestination; + } + + @CompileStatic + private static class DummyMessageHandler { + void handle(Message message) {} + } + + static class FlowRegistrar {} +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamMessageSelector.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamMessageSelector.groovy new file mode 100644 index 0000000000..2bbe85eb21 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamMessageSelector.groovy @@ -0,0 +1,79 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.stream + +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.toomuchcoding.jsonassert.JsonAssertion +import com.toomuchcoding.jsonassert.JsonVerifiable +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper +import org.springframework.cloud.contract.verifier.util.JsonPaths +import org.springframework.cloud.contract.verifier.util.JsonToJsonPathsConverter +import org.springframework.integration.core.MessageSelector +import org.springframework.messaging.Message + +import java.util.regex.Pattern + +/** + * Passes through a message that matches the one defined in the DSL + * + * @author Marcin Grzejszczak + */ +@CompileStatic +class StubRunnerStreamMessageSelector implements MessageSelector { + + private final Contract groovyDsl + private final ContractVerifierObjectMapper objectMapper = new ContractVerifierObjectMapper() + + StubRunnerStreamMessageSelector(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + @Override + boolean accept(Message message) { + if(!headersMatch(message)){ + return false + } + Object inputMessage = message.getPayload() + JsonPaths jsonPaths = JsonToJsonPathsConverter.transformToJsonPathWithStubsSideValues(groovyDsl.input.messageBody) + DocumentContext parsedJson = JsonPath.parse(objectMapper.writeValueAsString(inputMessage)) + return jsonPaths.every { matchesJsonPath(parsedJson, it) } + } + + private boolean matchesJsonPath(DocumentContext parsedJson, JsonVerifiable jsonVerifiable) { + try { + JsonAssertion.assertThat(parsedJson).matchesJsonPath(jsonVerifiable.jsonPath()) + return true + } catch (Exception e) { + return false + } + } + + private boolean headersMatch(Message message) { + Map headers = message.getHeaders() + return groovyDsl.input.messageHeaders.entries.every { + String name = it.name + Object value = it.clientValue + Object valueInHeader = headers.get(name) + return value instanceof Pattern ? + value.matcher(valueInHeader.toString()).matches() : + valueInHeader == value + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamTransformer.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamTransformer.groovy new file mode 100644 index 0000000000..c40595e4be --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamTransformer.groovy @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.stream + +import org.springframework.cloud.contract.verifier.util.BodyExtractor +import org.springframework.cloud.contract.spec.Contract +import org.springframework.integration.transformer.GenericTransformer +import org.springframework.messaging.Message +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder + +/** + * Sends forward a message defined in the DSL. + * + * @author Marcin Grzejszczak + */ +class StubRunnerStreamTransformer implements GenericTransformer, Message> { + + private final Contract groovyDsl + + StubRunnerStreamTransformer(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + @Override + Message transform(Message source) { + if (!groovyDsl.outputMessage) { + return source + } + String payload = BodyExtractor.extractStubValueFrom(groovyDsl.outputMessage.body) + Map headers = groovyDsl.outputMessage.headers.asStubSideMap() + return MessageBuilder.createMessage(payload, new MessageHeaders(headers)) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..35f2e3fddc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.stubrunner.messaging.stream.StubRunnerStreamConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/BookReturned.groovy new file mode 100644 index 0000000000..49dea202eb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/BookReturned.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.stream + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode + +@CompileStatic +@EqualsAndHashCode +class BookReturned implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy new file mode 100644 index 0000000000..0860db7335 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StreamStubRunnerSpec.groovy @@ -0,0 +1,226 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.messaging.stream + +import groovy.json.JsonOutput +import groovy.json.JsonSlurper +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.stubrunner.StubFinder +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.autoconfigure.EnableAutoConfiguration +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.stream.annotation.EnableBinding +import org.springframework.cloud.stream.messaging.Sink +import org.springframework.cloud.stream.messaging.Source +import org.springframework.context.annotation.ComponentScan +import org.springframework.context.annotation.Configuration +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification + +import java.util.concurrent.TimeUnit +/** + * @author Marcin Grzejszczak + */ +@Configuration +@ComponentScan +@EnableAutoConfiguration +@ContextConfiguration(classes = StreamStubRunnerSpec, loader = SpringApplicationContextLoader) +@EnableBinding([Sink, Source]) +class StreamStubRunnerSpec extends Specification { + + @Autowired StubFinder stubFinder + @Autowired ContractVerifierMessaging messaging + + def setup() { + // ensure that message were taken from the queue + messaging.receiveMessage('returnBook', 100, TimeUnit.MILLISECONDS) + } + + def 'should download the stub and register a route for it'() { + when: + // tag::client_send[] + messaging.send(new BookReturned('foo'), [sample: 'header'], 'bookStorage') + // end::client_send[] + then: + // tag::client_receive[] + ContractVerifierMessage receivedMessage = messaging.receiveMessage('returnBook') + // end::client_receive[] + and: + // tag::client_receive_message[] + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + // end::client_receive_message[] + } + + def 'should trigger a message by label'() { + when: + // tag::client_trigger[] + stubFinder.trigger('return_book_1') + // end::client_trigger[] + then: + // tag::client_trigger_receive[] + ContractVerifierMessage receivedMessage = messaging.receiveMessage('returnBook') + // end::client_trigger_receive[] + and: + // tag::client_trigger_message[] + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + // end::client_trigger_message[] + } + + def 'should trigger a label for the existing groupId:artifactId'() { + when: + // tag::trigger_group_artifact[] + stubFinder.trigger('org.springframework.cloud.contract.verifier.stubs:streamService', 'return_book_1') + // end::trigger_group_artifact[] + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('returnBook') + and: + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + } + + def 'should trigger a label for the existing artifactId'() { + when: + // tag::trigger_artifact[] + stubFinder.trigger('streamService', 'return_book_1') + // end::trigger_artifact[] + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('returnBook') + and: + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + } + + def 'should throw exception when missing label is passed'() { + when: + stubFinder.trigger('missing label') + then: + thrown(IllegalArgumentException) + } + + def 'should throw exception when missing label and artifactid is passed'() { + when: + stubFinder.trigger('some:service', 'return_book_1') + then: + thrown(IllegalArgumentException) + } + + def 'should trigger messages by running all triggers'() { + when: + // tag::trigger_all[] + stubFinder.trigger() + // end::trigger_all[] + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('returnBook') + and: + receivedMessage != null + assertJsons(receivedMessage.payload) + receivedMessage.headers.get('BOOK-NAME') == 'foo' + } + + def 'should trigger a label with no output message'() { + when: + // tag::trigger_no_output[] + messaging.send(new BookReturned('foo'), [sample: 'header'], 'delete') + // end::trigger_no_output[] + then: + noExceptionThrown() + } + + def 'should not trigger a message that does not match input'() { + when: + messaging.send(new BookReturned('not_matching'), [wrong: 'header_value'], 'bookStorage') + then: + ContractVerifierMessage receivedMessage = messaging.receiveMessage('returnBook', 100, TimeUnit.MILLISECONDS) + and: + receivedMessage == null + } + + private boolean assertJsons(Object payload) { + String objectAsString = payload instanceof String ? payload : + JsonOutput.toJson(payload) + def json = new JsonSlurper().parseText(objectAsString) + return json.bookName == 'foo' + } + + Contract dsl = + // tag::sample_dsl[] + Contract.make { + label 'return_book_1' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('returnBook') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::sample_dsl[] + + Contract dsl2 = + // tag::sample_dsl_2[] + Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('returnBook') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + // end::sample_dsl_2[] + + Contract dsl3 = + // tag::sample_dsl_3[] + Contract.make { + label 'delete_book' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + // end::sample_dsl_3[] + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamTransformerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamTransformerSpec.groovy new file mode 100644 index 0000000000..a948936dad --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/groovy/org/springframework/cloud/contract/stubrunner/messaging/stream/StubRunnerStreamTransformerSpec.groovy @@ -0,0 +1,132 @@ +package org.springframework.cloud.contract.stubrunner.messaging.stream + +import org.springframework.cloud.contract.spec.Contract +import org.springframework.messaging.Message +import org.springframework.messaging.support.MessageBuilder +import spock.lang.Specification + +class StubRunnerStreamTransformerSpec extends Specification { + + Message message = MessageBuilder.withPayload("hello").build() + + def noOutputMessageContract = Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookId: $(consumer(regex('[0-9]+')), producer('123')) + ]) + messageHeaders { + header('sample', 'header') + } + } + } + + def 'should not transform the message if there is no output message'() { + given: + StubRunnerStreamTransformer streamTransformer = new StubRunnerStreamTransformer(noOutputMessageContract) + when: + def result = streamTransformer.transform(message) + then: + result.is(message) + } + + def dsl = Contract.make { + label 'return_book_2' + input { + messageFrom('bookStorage') + messageBody([ + bookId: $(consumer(regex('[0-9]+')), producer('123')) + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('returnBook') + body([ + responseId: $(producer(regex('[0-9]+')), consumer('123')) + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + + def 'should convert dsl into message'() { + given: + StubRunnerStreamTransformer streamTransformer = new StubRunnerStreamTransformer(dsl) + when: + def result = streamTransformer.transform(message) + then: + result.payload == '{"responseId":"123"}' + } + + def dslWithRegexInGString = Contract.make { + // Human readable description + description 'Should produce valid sensor data' + // Label by means of which the output message can be triggered + label 'sensor1' + // input to the contract + input { + // the contract will be triggered by a method + triggeredBy('createSensorData()') + } + // output message of the contract + outputMessage { + // destination to which the output message will be sent + sentTo 'sensor-data' + headers { + header('contentType': 'application/json') + } + // the body of the output message + body("""{"id":"${value(producer(regex('[0-9]+')), consumer('99'))}","temperature":"123.45"}""") + } + } + + def 'should convert dsl into message with regex in GString'() { + given: + StubRunnerStreamTransformer streamTransformer = new StubRunnerStreamTransformer(dslWithRegexInGString) + when: + def result = streamTransformer.transform(message) + then: + result.payload == '''{"id":"99","temperature":"123.45"}''' + } + + def 'should parse dsl without DslProperty'() { + given: + Contract contract = Contract.make { + // Human readable description + description 'Sends an order message' + // Label by means of which the output message can be triggered + label 'send_order' + // input to the contract + input { + // the contract will be triggered by a method + triggeredBy('orderTrigger()') + } + // output message of the contract + outputMessage { + // destination to which the output message will be sent + sentTo('orders') + // any headers for the output message + headers { + header('contentType': 'application/json') + } + // the body of the output message + body( + orderId: value( + consumer('40058c70-891c-4176-a033-f70bad0c5f77'), + producer(regex('([0-9|a-f]*-*)*'))), + description: "This is the order description" + ) + } + } + StubRunnerStreamTransformer streamTransformer = new StubRunnerStreamTransformer(contract) + when: + def result = streamTransformer.transform(message) + then: + result.payload == '''{"orderId":"40058c70-891c-4176-a033-f70bad0c5f77","description":"This is the order description"}''' + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/application.yml new file mode 100644 index 0000000000..f7c3f12f4a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/application.yml @@ -0,0 +1,11 @@ +stubrunner.stubs.repository.root: classpath:m2repo/repository/ +stubrunner.stubs.ids: org.springframework.cloud.contract.verifier.stubs:streamService:0.0.1-SNAPSHOT:stubs + +spring: + cloud: + stream: + bindings: + output: + destination: returnBook + input: + destination: bookStorage \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/maven-metadata-local.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/maven-metadata-local.xml new file mode 100644 index 0000000000..f14e885df3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/maven-metadata-local.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + streamService + 0.0.1-SNAPSHOT + + + true + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/streamService-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/streamService-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..8613d57be0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/0.0.1-SNAPSHOT/streamService-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + streamService + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata-local.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata-local.xml new file mode 100644 index 0000000000..001cf26899 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata-local.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + streamService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata.xml new file mode 100644 index 0000000000..001cf26899 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-messaging/spring-cloud-contract-stub-runner-stream/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/streamService/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + streamService + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/README.adoc new file mode 100644 index 0000000000..7ea59a2a37 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/README.adoc @@ -0,0 +1,27 @@ +=== Stub Runner Spring Cloud + +Registers the stubs in the provided Service Discovery. It's enough to add the jar + +[source,groovy,indent=0] +---- +org.springframework.cloud.contract:stub-runner-spring-cloud +---- + +and the Stub Runner autoconfiguration should be picked up. + +==== 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 regardles 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. + +==== Additional Configuration + +You can match the artifactId of the stub with the name of your app by using the `stubrunner.stubs.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` \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/build.gradle new file mode 100644 index 0000000000..0484ddae5c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/build.gradle @@ -0,0 +1,41 @@ +/* + * Copyright 2013-2016 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. + */ + +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner-spring") + + compile localGroovy() + // TODO: should be compile only + compile "org.springframework.cloud:spring-cloud-starter:${springCloudVersion}" + compile "org.springframework.cloud:spring-cloud-starter-ribbon:${springCloudVersion}" + + testCompile('org.spockframework:spock-core:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'cglib:cglib-nodep:2.2' + testCompile 'org.objenesis:objenesis:2.1' + testCompile "org.springframework.cloud:spring-cloud-starter-zookeeper-discovery:${springCloudZookeeperVersion}" + testCompile 'org.apache.curator:curator-test:2.9.1' + testCompile 'io.reactivex:rxjava:1.1.1' + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile "org.springframework:spring-web:${springVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'ch.qos.logback:logback-classic:1.1.3' +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubMapperProperties.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubMapperProperties.java new file mode 100644 index 0000000000..79d405b9b0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubMapperProperties.java @@ -0,0 +1,73 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud; + +import java.util.HashMap; +import java.util.Map; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Maps Ivy based ids to service Ids. You might want to name the service you're calling + * in another way than artifact id. If that's the case then this class should be used + * to change do the proper mapping. + * + * Just provide in your properties file for example: + * + * stubrunner.stubs.idsToServiceIds: + * ivyNotation: someValueInsideYourCode + * fraudDetectionServer: someNameThatShouldMapFraudDetectionServer + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +@ConfigurationProperties("stubrunner.stubs") +public class StubMapperProperties { + + /** + * Mapping of Ivy notation based ids to serviceIds + * inside your application + * + * Example + * + * "a:b" -> "myService" + * "artifactId" -> "myOtherService" + */ + private Map idsToServiceIds = new HashMap<>(); + + public Map getIdsToServiceIds() { + return this.idsToServiceIds; + } + + public void setIdsToServiceIds(Map idsToServiceIds) { + this.idsToServiceIds = idsToServiceIds; + } + + public String fromIvyNotationToId(String ivyNotation) { + return idsToServiceIds.get(ivyNotation); + } + + public String fromServiceIdToIvyNotation(String serviceId) { + for (Map.Entry entry : idsToServiceIds.entrySet()) { + if (entry.getValue().equals(serviceId)) { + return entry.getKey(); + } + } + return null; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerDiscoveryClient.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerDiscoveryClient.java new file mode 100644 index 0000000000..e4905c7814 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerDiscoveryClient.java @@ -0,0 +1,97 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud; + +import java.net.URI; +import java.net.URL; +import java.util.Collections; +import java.util.List; + +import org.springframework.cloud.client.DefaultServiceInstance; +import org.springframework.cloud.client.ServiceInstance; +import org.springframework.cloud.client.discovery.DiscoveryClient; +import org.springframework.cloud.client.discovery.noop.NoopDiscoveryClient; + +import org.springframework.cloud.contract.stubrunner.RunningStubs; +import org.springframework.cloud.contract.stubrunner.StubFinder; +import org.springframework.cloud.contract.stubrunner.util.StringUtils; + +/** + * Custom version of {@link DiscoveryClient} that tries to find an instance + * in one of the started WireMock servers + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +public class StubRunnerDiscoveryClient implements DiscoveryClient { + + private final DiscoveryClient delegate; + private final StubFinder stubFinder; + private final StubMapperProperties stubMapperProperties; + + public StubRunnerDiscoveryClient(DiscoveryClient delegate, StubFinder stubFinder, + StubMapperProperties stubMapperProperties, String springAppName) { + this.delegate = delegate instanceof StubRunnerDiscoveryClient ? + noOpDiscoveryClient(springAppName) : delegate; + this.stubFinder = stubFinder; + this.stubMapperProperties = stubMapperProperties; + } + + private NoopDiscoveryClient noOpDiscoveryClient(String springAppName) { + return new NoopDiscoveryClient(new DefaultServiceInstance(springAppName, "localhost", 0, false)); + } + + @Override + public String description() { + return delegate.description(); + } + + @Override + public ServiceInstance getLocalServiceInstance() { + return delegate.getLocalServiceInstance(); + } + + @Override + public List getInstances(String serviceId) { + String ivyNotation = stubMapperProperties.fromServiceIdToIvyNotation(serviceId); + String serviceToFind = StringUtils.hasText(ivyNotation) ? ivyNotation : serviceId; + URL stubUrl = stubFinder.findStubUrl(serviceToFind); + if (stubUrl == null) { + return delegate.getInstances(serviceId); + } + return Collections.singletonList( + new StubRunnerServiceInstance(serviceId, stubUrl.getHost(), stubUrl.getPort(), toUri(stubUrl)) + ); + } + + private URI toUri(URL url) { + try { + return url.toURI(); + } catch (Exception e) { + return null; + } + } + + @Override + public List getServices() { + List services = delegate.getServices(); + RunningStubs runningStubs = stubFinder.findAllRunningStubs(); + services.addAll(runningStubs.getAllServicesNames()); + return services; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerServiceInstance.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerServiceInstance.java new file mode 100644 index 0000000000..d34340f98e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerServiceInstance.java @@ -0,0 +1,75 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud; + +import java.net.URI; +import java.util.HashMap; +import java.util.Map; + +import org.springframework.cloud.client.ServiceInstance; + +/** + * {@link ServiceInstance} with a helpful constructor + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +public class StubRunnerServiceInstance implements ServiceInstance { + + private final String serviceId; + private final String host; + private final int port; + private final URI uri; + + public StubRunnerServiceInstance(String serviceId, String host, int port, URI uri) { + this.serviceId = serviceId; + this.host = host; + this.port = port; + this.uri = uri; + } + + @Override + public String getServiceId() { + return serviceId; + } + + @Override + public String getHost() { + return host; + } + + @Override + public int getPort() { + return port; + } + + @Override + public boolean isSecure() { + return false; + } + + @Override + public URI getUri() { + return uri; + } + + @Override + public Map getMetadata() { + return new HashMap<>(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfiguration.java new file mode 100644 index 0000000000..6a5ec3f72d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfiguration.java @@ -0,0 +1,61 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.cloud.contract.stubrunner.spring.StubRunnerConfiguration; +import org.springframework.cloud.client.discovery.DiscoveryClient; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Import; +import org.springframework.context.annotation.Primary; + +import org.springframework.cloud.contract.stubrunner.StubFinder; + +/** + * Wraps {@link DiscoveryClient} in a Stub Runner implementation that tries to find + * a corresponding WireMock server for a searched dependency + * + * @since 1.0.0 + */ +@Configuration +@EnableConfigurationProperties +@ConditionalOnClass(DiscoveryClient.class) +@Import(StubRunnerConfiguration.class) +@ConditionalOnProperty(value = "stubrunner.cloud.enabled", matchIfMissing = true) +public class StubRunnerSpringCloudAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public StubMapperProperties stubMapperProperties() { + return new StubMapperProperties(); + } + + @Bean + @Primary + public DiscoveryClient stubRunnerDiscoveryClient(DiscoveryClient discoveryClient, + StubFinder stubFinder, + StubMapperProperties stubMapperProperties, + @Value("${spring.application.name:unknown}") String springAppName) { + return new StubRunnerDiscoveryClient(discoveryClient, stubFinder, stubMapperProperties, springAppName); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonAutoConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonAutoConfiguration.java new file mode 100644 index 0000000000..7e886e6eac --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonAutoConfiguration.java @@ -0,0 +1,37 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud.ribbon; + +import com.netflix.loadbalancer.ServerList; +import org.springframework.cloud.contract.stubrunner.spring.cloud.StubMapperProperties; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.cloud.netflix.ribbon.RibbonAutoConfiguration; +import org.springframework.cloud.netflix.ribbon.RibbonClients; +import org.springframework.context.annotation.Configuration; + +@Configuration +@ConditionalOnClass(ServerList.class) +@ConditionalOnBean(StubMapperProperties.class) +@AutoConfigureAfter(RibbonAutoConfiguration.class) +@RibbonClients(defaultConfiguration = StubRunnerRibbonConfiguration.class) +@ConditionalOnProperty(value = "stubrunner.cloud.ribbon.enabled", matchIfMissing = true) +public class StubRunnerRibbonAutoConfiguration { + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonBeanPostProcessor.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonBeanPostProcessor.java new file mode 100644 index 0000000000..9ba1002603 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonBeanPostProcessor.java @@ -0,0 +1,79 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud.ribbon; + +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.ServerList; +import org.springframework.cloud.contract.stubrunner.StubFinder; +import org.springframework.cloud.contract.stubrunner.spring.cloud.StubMapperProperties; +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.config.BeanPostProcessor; + +/** + * Ribbon AutoConfiguration that manipulates the service id to make the service + * be picked from the list of available WireMock instance if one is available. + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +class StubRunnerRibbonBeanPostProcessor implements BeanPostProcessor { + + private final BeanFactory beanFactory; + private StubFinder stubFinder; + private StubMapperProperties stubMapperProperties; + private IClientConfig clientConfig; + + StubRunnerRibbonBeanPostProcessor(BeanFactory beanFactory) { + this.beanFactory = beanFactory; + } + + private StubFinder stubFinder() { + if (stubFinder == null) { + stubFinder = this.beanFactory.getBean(StubFinder.class); + } + return stubFinder; + } + + private StubMapperProperties stubMapperProperties() { + if (stubMapperProperties == null) { + stubMapperProperties = this.beanFactory.getBean(StubMapperProperties.class); + } + return stubMapperProperties; + } + + private IClientConfig clientConfig() { + if (clientConfig == null) { + clientConfig = this.beanFactory.getBean(IClientConfig.class); + } + return clientConfig; + } + + @Override + public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { + if (bean instanceof ServerList && !(bean instanceof StubRunnerRibbonServerList)) { + return new StubRunnerRibbonServerList(stubFinder(), stubMapperProperties(), clientConfig(), (ServerList) bean); + } + return bean; + } + + @Override + public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { + return bean; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonConfiguration.java new file mode 100644 index 0000000000..b03d729a5f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonConfiguration.java @@ -0,0 +1,51 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud.ribbon; + +import com.netflix.loadbalancer.Server; +import com.netflix.loadbalancer.ServerList; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.util.ArrayList; +import java.util.List; + +@Configuration +class StubRunnerRibbonConfiguration { + @Bean + StubRunnerRibbonBeanPostProcessor stubRunnerRibbonBeanPostProcessor(BeanFactory beanFactory) { + return new StubRunnerRibbonBeanPostProcessor(beanFactory); + } + + @Bean + @ConditionalOnMissingBean + public ServerList noOpServerList() { + return new ServerList() { + @Override + public List getInitialListOfServers() { + return new ArrayList<>(); + } + + @Override + public List getUpdatedListOfServers() { + return new ArrayList<>(); + } + }; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonServerList.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonServerList.java new file mode 100644 index 0000000000..e0efe4bc8d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/ribbon/StubRunnerRibbonServerList.java @@ -0,0 +1,113 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud.ribbon; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Map; + +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.Server; +import com.netflix.loadbalancer.ServerList; + +import org.springframework.cloud.contract.stubrunner.RunningStubs; +import org.springframework.cloud.contract.stubrunner.StubConfiguration; +import org.springframework.cloud.contract.stubrunner.StubFinder; +import org.springframework.cloud.contract.stubrunner.spring.cloud.StubMapperProperties; +import org.springframework.cloud.contract.stubrunner.util.StringUtils; + +/** + * Stub Runner representation of a server list + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +class StubRunnerRibbonServerList implements ServerList { + + private final ServerList serverList; + + @SuppressWarnings("unchecked") + StubRunnerRibbonServerList(final StubFinder stubFinder, + final StubMapperProperties stubMapperProperties, + final IClientConfig clientConfig, + final ServerList delegate) {; + String serviceName = clientConfig.getClientName(); + String mappedServiceName = StringUtils + .hasText(stubMapperProperties.fromServiceIdToIvyNotation(serviceName)) ? + stubMapperProperties.fromServiceIdToIvyNotation(serviceName) : serviceName; + RunningStubs runningStubs = stubFinder.findAllRunningStubs(); + final Map.Entry entry = runningStubs.getEntry(mappedServiceName); + final Collection servers = new ArrayList<>(); + if (entry != null) { + servers.add(new Server("localhost", entry.getValue()) { + @Override + public MetaInfo getMetaInfo() { + return new MetaInfo() { + @Override + public String getAppName() { + return stubMapperProperties.fromIvyNotationToId(entry.getKey().toColonSeparatedDependencyNotation()); + } + + @Override + public String getServerGroup() { + return null; + } + + @Override + public String getServiceIdForDiscovery() { + return stubMapperProperties.fromIvyNotationToId(entry.getKey().getArtifactId()); + } + + @Override + public String getInstanceId() { + return stubMapperProperties.fromIvyNotationToId(entry.getKey().getArtifactId()); + } + }; + } + }); + } + serverList = new ServerList() { + @Override + public List getInitialListOfServers() { + List combinedList = new ArrayList<>(); + combinedList.addAll(servers); + combinedList.addAll(delegate.getInitialListOfServers()); + return combinedList; + } + + @Override + public List getUpdatedListOfServers() { + List combinedList = new ArrayList<>(); + combinedList.addAll(servers); + combinedList.addAll(delegate.getUpdatedListOfServers()); + return combinedList; + } + }; + } + + @Override + public List getInitialListOfServers() { + return serverList.getInitialListOfServers(); + } + + @Override + public List getUpdatedListOfServers() { + return serverList.getUpdatedListOfServers(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..fd191f3591 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/main/resources/META-INF/spring.factories @@ -0,0 +1,4 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.stubrunner.spring.cloud.StubRunnerSpringCloudAutoConfiguration,\ +org.springframework.cloud.contract.stubrunner.spring.cloud.ribbon.StubRunnerRibbonAutoConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy new file mode 100644 index 0000000000..8a3c6f886e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/cloud/StubRunnerSpringCloudAutoConfigurationSpec.groovy @@ -0,0 +1,74 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring.cloud + +import org.apache.curator.test.TestingServer +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.autoconfigure.EnableAutoConfiguration +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.boot.test.WebIntegrationTest +import org.springframework.cloud.contract.stubrunner.StubFinder +import org.springframework.cloud.client.discovery.EnableDiscoveryClient +import org.springframework.cloud.client.loadbalancer.LoadBalanced +import org.springframework.cloud.zookeeper.discovery.ZookeeperServiceDiscovery +import org.springframework.context.ConfigurableApplicationContext +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration +import org.springframework.test.context.ContextConfiguration +import org.springframework.web.client.RestTemplate +import spock.lang.AutoCleanup +import spock.lang.Shared +import spock.lang.Specification + +/** + * @author Marcin Grzejszczak + */ +@ContextConfiguration(classes = Config, loader = SpringApplicationContextLoader) +@WebIntegrationTest(randomPort = true) +class StubRunnerSpringCloudAutoConfigurationSpec extends Specification { + + @Autowired StubFinder stubFinder + @Autowired @LoadBalanced RestTemplate restTemplate + @Autowired ZookeeperServiceDiscovery zookeeperServiceDiscovery + @Autowired ConfigurableApplicationContext applicationContext + @Shared @AutoCleanup TestingServer testingServer = new TestingServer(2181) + + def 'should make service discovery work'() { + expect: 'WireMocks are running' + "${stubFinder.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance' + "${stubFinder.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer' + and: 'Stubs can be reached via load service discovery' + restTemplate.getForObject('http://loanIssuance/name', String) == 'loanIssuance' + restTemplate.getForObject('http://someNameThatShouldMapFraudDetectionServer/name', String) == 'fraudDetectionServer' + } + + def cleanup() { + zookeeperServiceDiscovery.serviceDiscovery.close() + applicationContext.close() + } + + @Configuration + @EnableAutoConfiguration + @EnableDiscoveryClient + static class Config { + @Bean + @LoadBalanced + RestTemplate restTemplate() { + return new RestTemplate() + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/application.yml new file mode 100644 index 0000000000..629b688f80 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/application.yml @@ -0,0 +1,6 @@ +stubrunner.stubs.repository.root: classpath:m2repo/repository/ +stubrunner.stubs.ids: org.springframework.cloud.contract.verifier.stubs:loanIssuance,org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer + +stubrunner.stubs.idsToServiceIds: + ivyNotation: someValueInsideYourCode + fraudDetectionServer: someNameThatShouldMapFraudDetectionServer \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/logback.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/logback.xml new file mode 100644 index 0000000000..7eecabf2f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/logback.xml @@ -0,0 +1,30 @@ + + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..40610c8cdb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + fraudDetectionServer + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml new file mode 100644 index 0000000000..281b9b3b80 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + fraudDetectionServer + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..59db343686 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + loanIssuance + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml new file mode 100644 index 0000000000..615428dae6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring-cloud/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + loanIssuance + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062111 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/README.adoc new file mode 100644 index 0000000000..38169894bf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/README.adoc @@ -0,0 +1,21 @@ +=== Stub Runner 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.yml[] +---- \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/build.gradle new file mode 100644 index 0000000000..32586d07e3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/build.gradle @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +description = 'Spring configuration for stub-runner' + +String stubRunner = "spring-cloud-contract-stub-runner" + +dependencies { + compile project(":$stubRunner-root:$stubRunner") + + compile localGroovy() + compile "org.springframework:spring-context:${springVersion}" + + testCompile('org.spockframework:spock-core:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'cglib:cglib-nodep:2.2' + testCompile 'org.objenesis:objenesis:2.1' + testCompile "org.springframework.boot:spring-boot-starter:${springBootVersion}" + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile('org.spockframework:spock-spring:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'ch.qos.logback:logback-classic:1.1.3' +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfiguration.java new file mode 100644 index 0000000000..bea711f6f1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/main/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfiguration.java @@ -0,0 +1,85 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring; + +import java.io.IOException; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.cloud.contract.stubrunner.AetherStubDownloader; +import org.springframework.cloud.contract.stubrunner.BatchStubRunner; +import org.springframework.cloud.contract.stubrunner.BatchStubRunnerFactory; +import org.springframework.cloud.contract.stubrunner.StubDownloader; +import org.springframework.cloud.contract.stubrunner.StubRunner; +import org.springframework.cloud.contract.stubrunner.StubRunnerOptions; +import org.springframework.cloud.contract.stubrunner.StubRunnerOptionsBuilder; +import org.springframework.cloud.contract.stubrunner.StubRunning; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessaging; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.io.Resource; + +/** + * Configuration that initializes a {@link BatchStubRunner} that runs {@link StubRunner} instance for each stub + */ +@Configuration +public class StubRunnerConfiguration { + + @Autowired(required = false) ContractVerifierMessaging contractVerifierMessaging; + @Autowired(required = false) StubDownloader stubDownloader; + + /** + * Bean that initializes stub runners, runs them and on shutdown closes them. Upon its instantiation + * JAR with stubs is downloaded and unpacked to a temporary folder and WireMock server are started + * for each of those stubs + * + * @param minPortValue min port value of the WireMock instance for stubs + * @param maxPortValue max port value of the WireMock instance for stubs + * @param stubRepositoryRoot root URL from where the JAR with stub mappings will be downloaded + * @param stubsSuffix classifier for the jar containing stubs + * @param workOffline forces offline work + * @param stubs comma separated list of stubs presented in Ivy notation + */ + @Bean(destroyMethod = "close") + public StubRunning batchStubRunner( + @Value("${stubrunner.port.range.min:10000}") Integer minPortValue, + @Value("${stubrunner.port.range.max:15000}") Integer maxPortValue, + @Value("${stubrunner.stubs.repository.root:}") Resource stubRepositoryRoot, + @Value("${stubrunner.stubs.classifier:stubs}") String stubsSuffix, + @Value("${stubrunner.work-offline:false}") boolean workOffline, + @Value("${stubrunner.stubs.ids:}") String stubs) throws IOException { + StubRunnerOptions stubRunnerOptions = new StubRunnerOptionsBuilder() + .withMinMaxPort(minPortValue, maxPortValue) + .withStubRepositoryRoot(uriStringOrEmpty(stubRepositoryRoot)) + .withWorkOffline(stubRepositoryRoot == null || workOffline) + .withStubsClassifier(stubsSuffix) + .withStubs(stubs) + .build(); + BatchStubRunner batchStubRunner = new BatchStubRunnerFactory(stubRunnerOptions, + stubDownloader != null ? stubDownloader : new AetherStubDownloader(stubRunnerOptions), + contractVerifierMessaging != null ? contractVerifierMessaging : new NoOpContractVerifierMessaging()).buildBatchStubRunner(); + // TODO: Consider running it in a separate thread + batchStubRunner.runStubs(); + return batchStubRunner; + } + + private String uriStringOrEmpty(Resource stubRepositoryRoot) throws IOException { + return stubRepositoryRoot != null ? stubRepositoryRoot.getURI().toString() : ""; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..d39588e8dc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.stubrunner.spring.StubRunnerConfiguration \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy new file mode 100644 index 0000000000..4d9b01856d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/groovy/org/springframework/cloud/contract/stubrunner/spring/StubRunnerConfigurationSpec.groovy @@ -0,0 +1,57 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.spring + +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.autoconfigure.EnableAutoConfiguration +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.cloud.contract.stubrunner.StubFinder +import org.springframework.context.annotation.Configuration +import org.springframework.context.annotation.Import +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification + +/** + * @author Marcin Grzejszczak + */ +// tag::test[] +@ContextConfiguration(classes = Config, loader = SpringApplicationContextLoader) +class StubRunnerConfigurationSpec extends Specification { + + @Autowired StubFinder stubFinder + + def 'should start WireMock servers'() { + expect: 'WireMocks are running' + stubFinder.findStubUrl('org.springframework.cloud.contract.verifier.stubs', 'loanIssuance') != null + stubFinder.findStubUrl('loanIssuance') != null + stubFinder.findStubUrl('loanIssuance') == stubFinder.findStubUrl('org.springframework.cloud.contract.verifier.stubs', 'loanIssuance') + stubFinder.findStubUrl('org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer') != null + and: + stubFinder.findAllRunningStubs().isPresent('loanIssuance') + stubFinder.findAllRunningStubs().isPresent('org.springframework.cloud.contract.verifier.stubs', 'fraudDetectionServer') + stubFinder.findAllRunningStubs().isPresent('org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer') + and: 'Stubs were registered' + "${stubFinder.findStubUrl('loanIssuance').toString()}/name".toURL().text == 'loanIssuance' + "${stubFinder.findStubUrl('fraudDetectionServer').toString()}/name".toURL().text == 'fraudDetectionServer' + } + + @Configuration + @Import(StubRunnerConfiguration) + @EnableAutoConfiguration + static class Config {} +} +// end::test[] \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/application.yml new file mode 100644 index 0000000000..4f618057e1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/application.yml @@ -0,0 +1,2 @@ +stubrunner.stubs.repository.root: classpath:m2repo/repository/ +stubrunner.stubs.ids: org.springframework.cloud.contract.verifier.stubs:loanIssuance,org.springframework.cloud.contract.verifier.stubs:fraudDetectionServer \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/logback.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/logback.xml new file mode 100644 index 0000000000..7eecabf2f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/logback.xml @@ -0,0 +1,30 @@ + + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..40610c8cdb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/0.0.1-SNAPSHOT/fraudDetectionServer-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + fraudDetectionServer + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml new file mode 100644 index 0000000000..281b9b3b80 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/fraudDetectionServer/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + fraudDetectionServer + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062112 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom new file mode 100644 index 0000000000..59db343686 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/0.0.1-SNAPSHOT/loanIssuance-0.0.1-SNAPSHOT.pom @@ -0,0 +1,25 @@ + + + + + 4.0.0 + org.springframework.cloud.contract.verifier.stubs + loanIssuance + 0.0.1-SNAPSHOT + pom + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml new file mode 100644 index 0000000000..615428dae6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner-spring/src/test/resources/m2repo/repository/org/springframework/cloud/contract/verifier/stubs/loanIssuance/maven-metadata.xml @@ -0,0 +1,28 @@ + + + + + org.springframework.cloud.contract.verifier.stubs + loanIssuance + 0.0.1-SNAPSHOT + + + 0.0.1-SNAPSHOT + + 20160409062111 + + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/README.adoc new file mode 100644 index 0000000000..fd0ace56e4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/README.adoc @@ -0,0 +1,99 @@ +=== Stub Runner Core + +Runs stubs for service collaborators. Treating stubs as contracts of services allows to use stub-runner as an implementation of +http://martinfowler.com/articles/consumerDrivenContracts.html[Consumer Driven Contracts]. + +Stub Runner allows you to automatically download the stubs of the provided dependencies, start WireMock servers for them and feed them with proper stub definitions. +For messaging, special stub routes are defined. + +==== Running stubs + +===== Running using main app + +You can set the following options to the main class: + +[source,groovy,indent=0] +---- + -maxp (--maxPort) N : Maximum port value to be assigned to the + Wiremock instance. Defaults to 15000 + (default: 15000) + -minp (--minPort) N : Minimal port value to be assigned to the + Wiremock instance. Defaults to 10000 + (default: 10000) + -s (--stubs) VAL : Comma separated list of Ivy representation of + jars with stubs. Eg. groupid:artifactid1,group + id2:artifactid2:version:classifier + -sr (--stubRepositoryRoot) VAL : Location of a Jar containing server where you + keep your stubs (e.g. http://nexus.net/content + /repositories/repository) + -ss (--stubsSuffix) VAL : 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) + -wo (--workOffline) : Switch to work offline. Defaults to 'false' + (default: false) +---- + + +===== Building a Fat Jar + +Just call the following command: + +[source,groovy,indent=0] +---- +./gradlew spring-cloud-contract-stub-runner-root:spring-cloud-contract-stub-runner:shadowJar -PfatJar +---- + +and inside the `build/lib` there will be a Fat Jar with classifier `fatJar` waiting for you to execute. E.g. + +[source,groovy,indent=0] +---- +java -jar spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/build/libs/spring-cloud-contract-stub-runner-1.0.0-SNAPSHOT-fatJar.jar -sr http://a.b.com -s a:b:c,d:e,f:g:h:i +---- + +==== Stub runner configuration + +You can configure the stub runner by either passing the full arguments list with the `-Pargs` like this: + +[source,groovy,indent=0] +---- +./gradlew spring-cloud-contract-stub-runner-root:spring-cloud-contract-stub-runner:run -Pargs="-c pl -minp 10000 -maxp 10005 -s a:b:c,d:e,f:g:h" +---- + +or each parameter separately with a `-P` prefix and without the hyphen `-` in the name of the param + +[source,groovy,indent=0] +---- +./gradlew spring-cloud-contract-stub-runner-root:spring-cloud-contract-stub-runner:run -Pc=pl -Pminp=10000 -Pmaxp=10005 -Ps=a:b:c,d:e,f:g:h +---- + +===== 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. + +===== Messaging Stubs + +Depending on the provided Stub Runner dependency and the DSL the messaging routes are automatically set up. \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/build.gradle new file mode 100644 index 0000000000..dc362bdbdb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/build.gradle @@ -0,0 +1,119 @@ +/* + * Copyright 2013-2016 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. + */ + +description = 'Runs stubs for service collaborators' + +apply plugin: 'application' +mainClassName = 'org.springframework.cloud.stubrunner.StubRunnerMain' + +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-core") + compile project(":$verifier-root:$verifier-messaging-root:$verifier-messaging-core") + compile 'org.codehaus.groovy:groovy-all:2.4.4' + compile "com.github.tomakehurst:wiremock:$wiremockVersion" + compile 'javax.servlet:javax.servlet-api:3.1.0' + compile 'args4j:args4j:2.32' + compile "org.eclipse.aether:aether-api:${aetherVersion}" + compile "org.eclipse.aether:aether-impl:${aetherVersion}" + compile "org.eclipse.aether:aether-transport-file:${aetherVersion}" + compile "org.eclipse.aether:aether-transport-http:${aetherVersion}" + compile "org.eclipse.aether:aether-connector-basic:${aetherVersion}" + compile 'org.apache.maven:maven-aether-provider:3.3.9' + + if (rootProject.hasProperty("fatJar")) runtime 'ch.qos.logback:logback-classic:1.1.3' + + testCompile('org.spockframework:spock-core:1.0-groovy-2.4') { + exclude(group: 'org.codehaus.groovy') + } + testCompile 'cglib:cglib-nodep:2.2' + testCompile 'org.objenesis:objenesis:2.1' + testCompile 'ch.qos.logback:logback-classic:1.1.3' +} + +ext { + stubRepositoryRoot = getPropertyByEither('sr', 'stubRepositoryRoot') + stubsSuffix = getPropertyByEither('ss', 'stubsSuffix') + minPortValue = getPropertyByEither('minp', 'minPort') + maxPortValue = getPropertyByEither('maxp', 'maxPort') + skipLocalRepo = getPropertyByEither('wo', 'workOffline') + stubs = getPropertyByEither('s', 'stubs') + arguments = project.hasProperty('args') ? project.property('args') : [] + /* example of args: + '-minp 10000 -maxp 10005 -s ""groupid:artifactid1,groupid2:artifactid2" -sr http://dl.bintray.com/somelink/micro' + */ +} + +Object getPropertyByEither(String paramName1, String paramName2, Object defaultValue = null) { + return project.hasProperty(paramName1) ? project.property(paramName1) : + project.hasProperty(paramName2) ? project.property(paramName2) : defaultValue +} + +run { + main = 'org.springframework.cloud.stubrunner.StubRunnerMain' + List argumentList + if (arguments) { + argumentList = (arguments.split(' ') as List).findAll { it != null } + } else { + argumentList = parseArguments() + } + args = argumentList + if (args) { + println "Running task with args $args" + } +} + +List parseArguments() { + List arguments = [] + appendToListIfNotNull(stubRepositoryRoot, '-sr', arguments) + appendToListIfNotNull(stubsSuffix, '-ss', arguments) + appendToListIfNotNull(minPortValue, '-minp', arguments) + appendToListIfNotNull(maxPortValue, '-maxp', arguments) + appendToListIfNotNull(skipLocalRepo, '-wo', arguments) + appendToListIfNotNull(stubs, '-s', arguments) + return arguments +} + +Object appendToListIfNotNull(String argument, String prefix, List list) { + if (argument != null) { + list << "$prefix" + if (!argument.isAllWhitespace()) { + list << argument + } + } +} + +if (rootProject.hasProperty("fatJar")) { + + apply plugin: 'com.github.johnrengelman.shadow' + apply plugin: 'maven-publish' + + publishing { + publications { + shadow(MavenPublication) { + from components.java + artifact shadowJar + } + } + } + + shadowJar { + classifier = 'fatJar' + dependsOn build + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AetherFactories.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AetherFactories.groovy new file mode 100644 index 0000000000..df67a84c25 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AetherFactories.groovy @@ -0,0 +1,68 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import org.apache.maven.repository.internal.MavenRepositorySystemUtils +import org.eclipse.aether.DefaultRepositorySystemSession +import org.eclipse.aether.RepositorySystem +import org.eclipse.aether.RepositorySystemSession +import org.eclipse.aether.connector.basic.BasicRepositoryConnectorFactory +import org.eclipse.aether.impl.DefaultServiceLocator +import org.eclipse.aether.repository.LocalRepository +import org.eclipse.aether.repository.RemoteRepository +import org.eclipse.aether.repository.RepositoryPolicy +import org.eclipse.aether.spi.connector.RepositoryConnectorFactory +import org.eclipse.aether.spi.connector.transport.TransporterFactory +import org.eclipse.aether.transport.file.FileTransporterFactory +import org.eclipse.aether.transport.http.HttpTransporterFactory + +class AetherFactories { + + private static final String MAVEN_LOCAL_REPOSITORY_LOCATION = 'maven.repo.local' + + static RepositorySystem newRepositorySystem() { + DefaultServiceLocator locator = MavenRepositorySystemUtils.newServiceLocator() + locator.addService(RepositoryConnectorFactory, BasicRepositoryConnectorFactory) + locator.addService(TransporterFactory, FileTransporterFactory) + locator.addService(TransporterFactory, HttpTransporterFactory) + return locator.getService(RepositorySystem) + } + + static RepositorySystemSession newSession(RepositorySystem system, boolean workOffline) { + DefaultRepositorySystemSession session = MavenRepositorySystemUtils.newSession() + session.setOffline(workOffline) + if (!workOffline) { + session.setUpdatePolicy(RepositoryPolicy.UPDATE_POLICY_ALWAYS) + } + LocalRepository localRepo = new LocalRepository(localRepositoryDirectory()) + session.setLocalRepositoryManager(system.newLocalRepositoryManager(session, localRepo)) + return session + } + + static List newRepositories(List repositories) { + return repositories.withIndex() + .findAll { String repo, int index -> repo } + .collect { String repo, int index -> + new RemoteRepository.Builder('remote' + index, 'default', repo).build() + } + } + + static String localRepositoryDirectory() { + System.getProperty(MAVEN_LOCAL_REPOSITORY_LOCATION, "${System.getProperty("user.home")}/.m2/repository") + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AetherStubDownloader.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AetherStubDownloader.groovy new file mode 100644 index 0000000000..588e26c0b4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AetherStubDownloader.groovy @@ -0,0 +1,155 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.eclipse.aether.RepositorySystem +import org.eclipse.aether.RepositorySystemSession +import org.eclipse.aether.artifact.Artifact +import org.eclipse.aether.artifact.DefaultArtifact +import org.eclipse.aether.repository.RemoteRepository +import org.eclipse.aether.resolution.ArtifactRequest +import org.eclipse.aether.resolution.ArtifactResult +import org.eclipse.aether.resolution.VersionRangeRequest +import org.eclipse.aether.resolution.VersionRangeResult +import org.eclipse.aether.resolution.VersionRequest +import org.eclipse.aether.resolution.VersionResult + +import static AetherFactories.newRepositories +import static AetherFactories.newRepositorySystem +import static AetherFactories.newSession +import static org.springframework.cloud.contract.stubrunner.util.ZipCategory.unzipTo +import static java.nio.file.Files.createTempDirectory + +/** + * @author Mariusz Smykula + */ +@CompileStatic +@Slf4j +class AetherStubDownloader implements StubDownloader { + + private static final String TEMP_DIR_PREFIX = 'contracts' + private static final String ARTIFACT_EXTENSION = 'jar' + private static final String LATEST_ARTIFACT_VERSION = '(,]' + private static final String LATEST_VERSION_IN_IVY = '+' + + private final List remoteRepos + private final RepositorySystem repositorySystem + private final RepositorySystemSession session + + AetherStubDownloader(StubRunnerOptions stubRunnerOptions) { + this.remoteRepos = remoteRepositories(stubRunnerOptions) + if (!remoteRepos) { + log.error('Remote repositories for stubs are not specified!') + } + this.repositorySystem = newRepositorySystem() + this.session = newSession(this.repositorySystem, stubRunnerOptions.workOffline) + } + + /** + * Used by the Maven Plugin + * + * @param repositorySystem + * @param remoteRepositories - remote artifact repositories + * @param session + * @param workOffline + */ + AetherStubDownloader(RepositorySystem repositorySystem, + List remoteRepositories, + RepositorySystemSession session) { + this.remoteRepos = remoteRepositories + this.repositorySystem = repositorySystem + this.session = session + if (!remoteRepos) { + log.error('Remote remoteRepositories for stubs are not specified!') + } + } + + private List remoteRepositories(StubRunnerOptions stubRunnerOptions) { + return newRepositories(stubRunnerOptions.stubRepositoryRoot.split(',').toList()) + } + + private File unpackedJar(String resolvedVersion, String stubsGroup, String stubsModule, String classifier) { + log.info("Resolved version is [$resolvedVersion]") + if (!resolvedVersion) { + log.warn("Stub for group [$stubsGroup] module [$stubsModule] and classifier [$classifier] not found in $remoteRepos") + return null + } + Artifact artifact = new DefaultArtifact(stubsGroup, stubsModule, classifier, ARTIFACT_EXTENSION, resolvedVersion) + ArtifactRequest request = new ArtifactRequest(artifact: artifact, repositories: remoteRepos) + log.info("Resolving artifact '$artifact' using remote repositories $remoteRepos.url") + try { + ArtifactResult result = repositorySystem.resolveArtifact(session, request) + log.info("Resolved artifact $artifact to ${result.artifact.file}") + File temporaryFile = unpackStubJarToATemporaryFolder(result.artifact.file.toURI()) + log.info("Unpacked file to [$temporaryFile]") + return temporaryFile + } catch (Exception e) { + log.warn("Exception occured while trying to download a stub for group [$stubsGroup] module [$stubsModule] and classifier [$classifier] in $remoteRepos", e) + return null + } + + } + + private String getVersion(String stubsGroup, String stubsModule, String version, String classifier) { + if (!version || LATEST_VERSION_IN_IVY == version) { + log.info("Desired version is [$version] - will try to resolve the latest version") + return resolveHighestArtifactVersion(stubsGroup, stubsModule, classifier) + } + log.info("Will try to resolve version [$version]") + return resolveArtifactVersion(stubsGroup, stubsModule, version, classifier) + } + + @Override + Map.Entry downloadAndUnpackStubJar(StubRunnerOptions options, StubConfiguration stubConfiguration) { + String version = getVersion(stubConfiguration.groupId, stubConfiguration.artifactId, stubConfiguration.version, stubConfiguration.classifier) + File unpackedJar = unpackedJar(version, stubConfiguration.groupId, stubConfiguration.artifactId, + stubConfiguration.classifier) + if (!unpackedJar) { + return null + } + return new AbstractMap.SimpleEntry(new StubConfiguration(stubConfiguration.groupId, stubConfiguration.artifactId, version, stubConfiguration.classifier), + unpackedJar) + } + + private String resolveHighestArtifactVersion(String stubsGroup, String stubsModule, String classifier) { + Artifact artifact = new DefaultArtifact(stubsGroup, stubsModule, classifier, ARTIFACT_EXTENSION, LATEST_ARTIFACT_VERSION) + VersionRangeRequest versionRangeRequest = new VersionRangeRequest(artifact, remoteRepos, null) + VersionRangeResult rangeResult = repositorySystem.resolveVersionRange(session, versionRangeRequest) + if (!rangeResult.highestVersion) { + log.error("Version was not resolved!") + } + return rangeResult.highestVersion ?: '' + } + + private String resolveArtifactVersion(String stubsGroup, String stubsModule, String version, String classifier) { + Artifact artifact = new DefaultArtifact(stubsGroup, stubsModule, classifier, ARTIFACT_EXTENSION, version) + VersionRequest versionRequest = new VersionRequest(artifact, remoteRepos, null) + VersionResult versionResult = repositorySystem.resolveVersion(session, versionRequest) + return versionResult.version ?: '' + } + + private static File unpackStubJarToATemporaryFolder(URI stubJarUri) { + File tmpDirWhereStubsWillBeUnzipped = createTempDirectory(TEMP_DIR_PREFIX).toFile() + tmpDirWhereStubsWillBeUnzipped.deleteOnExit() + log.info("Unpacking stub from JAR [URI: ${stubJarUri}]") + unzipTo(new File(stubJarUri), tmpDirWhereStubsWillBeUnzipped) + return tmpDirWhereStubsWillBeUnzipped + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/Arguments.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/Arguments.groovy new file mode 100644 index 0000000000..254bc0634b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/Arguments.groovy @@ -0,0 +1,43 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import groovy.transform.ToString + +/** + * Arguments passed to the {@link StubRunner} application + * + * @see StubRunner + */ +@CompileStatic +@ToString(includeNames = true) +@PackageScope +class Arguments { + final StubRunnerOptions stubRunnerOptions + final String context + final String repositoryPath + final StubConfiguration stub + + Arguments(StubRunnerOptions stubRunnerOptions, String repositoryPath = "", StubConfiguration stub = null) { + this.stubRunnerOptions = stubRunnerOptions + this.context = context + this.repositoryPath = repositoryPath + this.stub = stub + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AvailablePortScanner.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AvailablePortScanner.groovy new file mode 100644 index 0000000000..d493199106 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/AvailablePortScanner.groovy @@ -0,0 +1,89 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import groovy.util.logging.Slf4j + +/** + * Tries to execute a closure with an available port from the given range + */ +@CompileStatic +@Slf4j +@PackageScope +class AvailablePortScanner { + + private static final int MAX_RETRY_COUNT = 1000 + + private final int minPortNumber + private final int maxPortNumber + private final int maxRetryCount + + AvailablePortScanner(int minPortNumber, int maxPortNumber, int maxRetryCount = MAX_RETRY_COUNT) { + checkPortRanges(minPortNumber, maxPortNumber) + this.minPortNumber = minPortNumber + this.maxPortNumber = maxPortNumber + this.maxRetryCount = maxRetryCount + } + + private void checkPortRanges(int minPortNumber, int maxPortNumber) { + if (minPortNumber > maxPortNumber) { + throw new InvalidPortRange(minPortNumber, maxPortNumber) + } + } + + public T tryToExecuteWithFreePort(Closure closure) { + for (i in (1..maxRetryCount)) { + try { + int numberOfPortsToBind = maxPortNumber - minPortNumber + 1 + int portToScan = new Random().nextInt(numberOfPortsToBind) + minPortNumber + checkIfPortIsAvailable(portToScan) + return executeLogicForAvailablePort(portToScan, closure) + } catch (BindException exception) { + log.debug("Failed to execute closure (try: $i/$maxRetryCount)", exception) + } + } + throw new NoPortAvailableException(minPortNumber, maxPortNumber) + } + + private T executeLogicForAvailablePort(int portToScan, Closure closure) { + log.debug("Trying to execute closure with port [$portToScan]") + return closure(portToScan) + } + + private void checkIfPortIsAvailable(int portToScan) { + ServerSocket socket = null + try { + socket = new ServerSocket(portToScan) + } finally { + socket?.close() + } + } + + static class NoPortAvailableException extends RuntimeException { + protected NoPortAvailableException(int lowerBound, int upperBound) { + super("Could not find available port in range $lowerBound:$upperBound") + } + } + + static class InvalidPortRange extends RuntimeException { + protected InvalidPortRange(int lowerBound, int upperBound) { + super("Invalid bounds exceptions, min port [$lowerBound] is greater to max port [$upperBound]") + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunner.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunner.groovy new file mode 100644 index 0000000000..a39d74fbe6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunner.groovy @@ -0,0 +1,141 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.Contract +/** + * Manages lifecycle of multiple {@link StubRunner} instances. + * + * @see StubRunner + */ +@CompileStatic +class BatchStubRunner implements StubRunning { + + private final Iterable stubRunners + + BatchStubRunner(Iterable stubRunners) { + this.stubRunners = stubRunners + } + + @Override + RunningStubs runStubs() { + Map appsAndPorts = stubRunners.inject([:]) { Map acc, StubRunner value -> + acc.putAll(value.runStubs().namesAndPorts) + return acc + } as Map + return new RunningStubs(appsAndPorts) + } + + @Override + URL findStubUrl(String groupId, String artifactId) { + return stubRunners.findResult(null) { StubRunner stubRunner -> + return stubRunner.findStubUrl(groupId, artifactId) + } as URL + } + + @Override + URL findStubUrl(String ivyNotation) { + String[] splitString = ivyNotation.split(":") + if (splitString.length > 3) { + throw new IllegalArgumentException("$ivyNotation is invalid") + } else if (splitString.length == 2) { + return findStubUrl(splitString[0], splitString[1]) + } + return findStubUrl(null, splitString[0]) + } + + @Override + RunningStubs findAllRunningStubs() { + return new RunningStubs(stubRunners.collect { StubRunner runner -> runner.findAllRunningStubs() }) + } + + @Override + Map> getContracts() { + return stubRunners.inject([:]) { Map> map, StubRunner stubRunner -> + map.putAll(stubRunner.contracts ?: [:]) + return map + } as Map> + } + + @Override + boolean trigger(String ivyNotation, String labelName) { + boolean triggered = stubRunners.inject(false) { boolean acc, StubRunner stubRunner -> + boolean success = stubRunner.trigger(ivyNotation, labelName) + if (acc) { + return true + } + return success + } + if (!triggered) { + throw new IllegalArgumentException("No label with name [$labelName] for " + + "dependency [$ivyNotation] was found. Here you have the list of dependencies " + + "and their labels [${ivyToLabels()}]") + } + return triggered + } + + private String ivyToLabels() { + return labels().entrySet().collect { + "Dependency [${it.key}] has labels ${it.value}]" + }.join('\n') + } + + @Override + boolean trigger(String labelName) { + boolean triggered = stubRunners.inject(false) { boolean acc, StubRunner stubRunner -> + boolean success = stubRunner.trigger(labelName) + if (acc) { + return true + } + return success + } + if (!triggered) { + throw new IllegalArgumentException("No label with name [$labelName] was found. " + + "Here you have the list of dependencies and their labels [${ivyToLabels()}") + } + return triggered + } + + @Override + boolean trigger() { + return stubRunners.inject(false) { boolean acc, StubRunner stubRunner -> + boolean success = stubRunner.trigger() + if (acc) { + return true + } + return success + } + } + + @Override + Map> labels() { + return stubRunners.inject([:]) { Map> map, StubRunner stubRunner -> + if (stubRunner) { + map.putAll(stubRunner.labels() ?: [:]) + } + return map + } as Map> + } + + @Override + void close() throws IOException { + stubRunners.each { + it.close() + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunnerFactory.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunnerFactory.groovy new file mode 100644 index 0000000000..6261afe289 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunnerFactory.groovy @@ -0,0 +1,59 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessaging + +/** + * Manages lifecycle of multiple {@link StubRunner} instances. + * + * @see StubRunner + * @see BatchStubRunner + */ +@CompileStatic +class BatchStubRunnerFactory { + + private final StubRunnerOptions stubRunnerOptions + private final StubDownloader stubDownloader + private final ContractVerifierMessaging contractVerifierMessaging + + BatchStubRunnerFactory(StubRunnerOptions stubRunnerOptions) { + this(stubRunnerOptions, new AetherStubDownloader(stubRunnerOptions), new NoOpContractVerifierMessaging()) + } + + BatchStubRunnerFactory(StubRunnerOptions stubRunnerOptions, ContractVerifierMessaging contractVerifierMessaging) { + this(stubRunnerOptions, new AetherStubDownloader(stubRunnerOptions), contractVerifierMessaging) + } + + BatchStubRunnerFactory(StubRunnerOptions stubRunnerOptions, StubDownloader stubDownloader) { + this(stubRunnerOptions, stubDownloader, new NoOpContractVerifierMessaging()) + } + + BatchStubRunnerFactory(StubRunnerOptions stubRunnerOptions, StubDownloader stubDownloader, ContractVerifierMessaging contractVerifierMessaging) { + this.stubRunnerOptions = stubRunnerOptions + this.stubDownloader = stubDownloader + this.contractVerifierMessaging = contractVerifierMessaging + } + + BatchStubRunner buildBatchStubRunner() { + StubRunnerFactory stubRunnerFactory = new StubRunnerFactory(stubRunnerOptions, stubDownloader, contractVerifierMessaging) + return new BatchStubRunner(stubRunnerFactory.createStubsFromServiceConfiguration()) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/GroovyDslWrapper.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/GroovyDslWrapper.groovy new file mode 100644 index 0000000000..2f2ca4f0b0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/GroovyDslWrapper.groovy @@ -0,0 +1,39 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import org.springframework.cloud.contract.spec.Contract + +/** + * @author Marcin Grzejszczak + */ +@PackageScope +@CompileStatic +class GroovyDslWrapper { + + @Delegate final Contract groovyDsl + + GroovyDslWrapper(Contract groovyDsl) { + this.groovyDsl = groovyDsl + } + + boolean hasHttpPart() { + return groovyDsl.request + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/MessageNotMatchingException.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/MessageNotMatchingException.groovy new file mode 100644 index 0000000000..d99d288ee0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/MessageNotMatchingException.groovy @@ -0,0 +1,28 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.InheritConstructors + +/** + * Exception thrown when message is not matched + * + * @author Marcin Grzejszczak + */ +@InheritConstructors +class MessageNotMatchingException extends RuntimeException { +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/RunningStubs.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/RunningStubs.groovy new file mode 100644 index 0000000000..d0d0b3f657 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/RunningStubs.groovy @@ -0,0 +1,84 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +/** + * Structure representing executed stubs. Contains the configuration of each stub + * together with the port on which its executed. + */ +@EqualsAndHashCode +@CompileStatic +class RunningStubs { + final Map namesAndPorts = [:] + + RunningStubs(Map map) { + this.namesAndPorts.putAll(map) + } + + RunningStubs(Collection runningStubs) { + runningStubs.each { + this.namesAndPorts.putAll(it.namesAndPorts) + } + } + + Integer getPort(String artifactId) { + return getEntry(artifactId)?.value + } + + Map.Entry getEntry(String artifactId) { + return namesAndPorts.entrySet().find { + it.key.matchesIvyNotation(artifactId) + } + } + + Integer getPort(String groupId, String artifactId) { + return namesAndPorts.entrySet().find { + it.key.matchesIvyNotation("$groupId:$artifactId") + }?.value + } + + boolean isPresent(String artifactId) { + return getEntry(artifactId) + } + + boolean isPresent(String groupId, String artifactId) { + return namesAndPorts.entrySet().find { + it.key.matchesIvyNotation("$groupId:$artifactId") + } + } + + Set getAllServices() { + return namesAndPorts.keySet() + } + + Set getAllServicesNames() { + return namesAndPorts.keySet().collect { it.artifactId } as Set + } + + Map toIvyToPortMapping() { + return namesAndPorts.collectEntries { [(it.key.toColonSeparatedDependencyNotation()) : it.value] } as Map + } + + @Override + String toString() { + return namesAndPorts.collect { + "Stub [${it.key.toColonSeparatedDependencyNotation()}] is running on port [${it.value}]" + }.join("\n") + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubConfiguration.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubConfiguration.groovy new file mode 100644 index 0000000000..82daa2d0cc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubConfiguration.groovy @@ -0,0 +1,156 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileDynamic +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import org.springframework.cloud.contract.stubrunner.util.StringUtils + +/** + * Represents a configuration of a single stub. The stub can be described + * by groupId:artifactId:classifier notation + */ +@CompileStatic +@EqualsAndHashCode +public class StubConfiguration { + private static final String STUB_COLON_DELIMITER = ":" + private static final String DEFAULT_VERSION = "+" + private static final String DEFAULT_CLASSIFIER = "stubs" + + final String groupId + final String artifactId + final String version + final String classifier + + public StubConfiguration(String groupId, String artifactId, String version) { + this.groupId = groupId + this.artifactId = artifactId + this.version = version + this.classifier = DEFAULT_CLASSIFIER + } + + public StubConfiguration(String groupId, String artifactId, String version, String classifier) { + this.groupId = groupId + this.artifactId = artifactId + this.version = version + this.classifier = classifier + } + + public StubConfiguration(String stubPath, String defaultClassifier) { + String[] parsedPath = parsedPathEmptyByDefault(stubPath, STUB_COLON_DELIMITER, defaultClassifier) + this.groupId = parsedPath[0] + this.artifactId = parsedPath[1] + this.version = parsedPath[2] + this.classifier = parsedPath[3] + } + + public StubConfiguration(String stubPath) { + String[] parsedPath = parsedPathEmptyByDefault(stubPath, STUB_COLON_DELIMITER, DEFAULT_CLASSIFIER) + this.groupId = parsedPath[0] + this.artifactId = parsedPath[1] + this.version = parsedPath[2] + this.classifier = parsedPath[3] + } + + private List parsedPathEmptyByDefault(String path, String delimiter, String defaultClassifier) { + String[] splitPath = path.split(delimiter) + String stubsGroupId = "" + String stubsArtifactId = "" + String stubsVersion = "" + String stubsClassifier = "" + if (splitPath.length >= 2) { + stubsGroupId = splitPath[0] + stubsArtifactId = splitPath[1] + stubsVersion = splitPath.length >= 3 ? splitPath[2] : DEFAULT_VERSION + stubsClassifier = splitPath.length == 4 ? splitPath[3] : defaultClassifier + } + return [stubsGroupId, stubsArtifactId, stubsVersion, stubsClassifier] + } + + private boolean isDefined() { + return StringUtils.hasText(groupId) && StringUtils.hasText(this.artifactId) + } + + String toColonSeparatedDependencyNotation() { + if(!isDefined()) { + return "" + } + return [groupId, artifactId, version, classifier].join(STUB_COLON_DELIMITER) + } + + @CompileDynamic + boolean groupIdAndArtifactMatches(String ivyNotationAsString) { + def (String groupId, String artifactId) = ivyNotationFrom(ivyNotationAsString) + if (!groupId) { + return this.artifactId == artifactId + } + return this.groupId == groupId && this.artifactId == artifactId + } + + boolean equals(o) { + if (this.is(o)) return true + if (getClass() != o.class) return false + + StubConfiguration that = (StubConfiguration) o + + if (artifactId != that.artifactId) return false + if (groupId != that.groupId) return false + + return true + } + + int hashCode() { + int result + result = (groupId != null ? groupId.hashCode() : 0) + result = 31 * result + (artifactId != null ? artifactId.hashCode() : 0) + return result + } + + boolean matchesIvyNotation(String ivyNotationAsString) { + def strings = ivyNotationAsString.split(':') + if (strings.length == 1) { + return artifactId == ivyNotationAsString + } else if(strings.length == 2) { + return groupId == strings[0] && + artifactId == strings[1] + } else if(strings.length == 3) { + return groupId == strings[0] && + artifactId == strings[1] && + (strings[2] == DEFAULT_VERSION || version == strings[2]) + } + return groupId == strings[0] && + artifactId == strings[1] && + (strings[2] == DEFAULT_VERSION || version == strings[2]) && + classifier == strings[3] + } + + private String[] ivyNotationFrom(String ivyNotation) { + String[] splitString = ivyNotation.split(":") + if (splitString.length == 1) { + // assuming that ivy notation represents artifactId only + return [null, splitString[0]] as String[] + } + return [splitString[0], splitString[1]] as String[] + } + + + @Override + public String toString() { + return toColonSeparatedDependencyNotation() + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubData.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubData.groovy new file mode 100644 index 0000000000..e66fbb3217 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubData.groovy @@ -0,0 +1,31 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import org.springframework.cloud.contract.spec.Contract + +/** + * @author Marcin Grzejszczak + */ +@CompileStatic +@EqualsAndHashCode +class StubData { + final Integer port + final List contracts +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubDownloader.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubDownloader.groovy new file mode 100644 index 0000000000..fba3a207a1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubDownloader.groovy @@ -0,0 +1,28 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +interface StubDownloader { + + /** + * Returns a mapping of updated StubConfiguration (it will contain the resolved version) and the location of the downloaded JAR. + * If there was no artifact this method will return {@code null}. + */ + Map.Entry downloadAndUnpackStubJar(StubRunnerOptions options, StubConfiguration stubConfiguration) + + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubFinder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubFinder.groovy new file mode 100644 index 0000000000..d2ba01caa9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubFinder.groovy @@ -0,0 +1,49 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import org.springframework.cloud.contract.spec.Contract + +interface StubFinder extends StubTrigger { + /** + * For the given groupId and artifactId tries to find the matching + * URL of the running stub. + * + * @param groupId - might be null. In that case a search only via artifactId takes place + * @return URL of a running stub or null if not found + */ + URL findStubUrl(String groupId, String artifactId) + + /** + * For the given Ivy notation {@code groupId:artifactId} tries to find the matching + * URL of the running stub. You can also pass only {@code artifactId}. + * + * @param ivyNotation - Ivy representation of the Maven artifact + * @return URL of a running stub or null if not found + */ + URL findStubUrl(String ivyNotation) + + /** + * Returns all running stubs + */ + RunningStubs findAllRunningStubs() + + /** + * Returns the list of Contracts + */ + Map> getContracts() +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRepository.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRepository.groovy new file mode 100644 index 0000000000..2f7f77c74a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRepository.groovy @@ -0,0 +1,105 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.util.ContractVerifierDslConverter + +/** + * Wraps the folder with WireMock mappings. + */ +@CompileStatic +@PackageScope +@Slf4j +class StubRepository { + + private final File path + final List projectDescriptors + final Collection contracts + + StubRepository(File repository) { + if (!repository.isDirectory()) { + throw new FileNotFoundException("Missing descriptor repository under path [$path]") + } + this.path = repository + this.projectDescriptors = projectDescriptors() + this.contracts = contracts() + } + + /** + * Returns a list of {@link Contract} + */ + private Collection contracts() { + List contracts = [] + contracts.addAll(contractDescriptors()) + return contracts + } + + /** + * Returns the list of WireMock JSON files wrapped in {@link WiremockMappingDescriptor} + */ + private List projectDescriptors() { + List mappingDescriptors = [] + mappingDescriptors.addAll(contextDescriptors()) + return mappingDescriptors + } + + private List contextDescriptors() { + return path.exists() ? collectMappingDescriptors(path) : [] + } + + private List collectMappingDescriptors(File descriptorsDirectory) { + List mappingDescriptors = [] + descriptorsDirectory.eachFileRecurse { File file -> + if (isMappingDescriptor(file)) { + mappingDescriptors << new WiremockMappingDescriptor(file) + } + } + return mappingDescriptors + } + + private Collection contractDescriptors() { + return path.exists() ? collectContractDescriptors(path) : [] + } + + private Collection collectContractDescriptors(File descriptorsDirectory) { + List mappingDescriptors = [] + descriptorsDirectory.eachFileRecurse { File file -> + if (isContractDescriptor(file)) { + try { + mappingDescriptors << ContractVerifierDslConverter.convert(file) + } catch (Exception e) { + log.warn("Exception occurred while trying to parse file [$file]", e) + } + } + } + return mappingDescriptors + } + + private static boolean isMappingDescriptor(File file) { + return file.isFile() && file.name.endsWith('.json') + } + + private static boolean isContractDescriptor(File file) { + //TODO: Consider script injections implications... + return file.isFile() && file.name.endsWith('.groovy') + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunner.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunner.groovy new file mode 100644 index 0000000000..7b460ebce7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunner.groovy @@ -0,0 +1,122 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessaging + +/** + * Represents a single instance of ready-to-run stubs. + * Can run the stubs and then will return the name of the collaborator together with + * its URI. + * Can also be queried if the current groupid and artifactid are matching the + * corresponding running stub. + */ +@Slf4j +@CompileStatic +class StubRunner implements StubRunning { + + private final StubRepository stubRepository + private final StubConfiguration stubsConfiguration + private final StubRunnerOptions stubRunnerOptions + private final StubRunnerExecutor localStubRunner + private final ContractVerifierMessaging contractVerifierMessaging + + @Deprecated + StubRunner(Arguments arguments) { + this(arguments.stubRunnerOptions, arguments.repositoryPath, arguments.stub) + } + + StubRunner(StubRunnerOptions stubRunnerOptions, String repositoryPath, StubConfiguration stubsConfiguration) { + this(stubRunnerOptions, repositoryPath, stubsConfiguration, new NoOpContractVerifierMessaging()) + } + + StubRunner(StubRunnerOptions stubRunnerOptions, String repositoryPath, StubConfiguration stubsConfiguration, + ContractVerifierMessaging contractVerifierMessaging) { + this.stubsConfiguration = stubsConfiguration + this.stubRunnerOptions = stubRunnerOptions + this.stubRepository = new StubRepository(new File(repositoryPath)) + AvailablePortScanner portScanner = new AvailablePortScanner(stubRunnerOptions.minPortValue, + stubRunnerOptions.maxPortValue) + this.contractVerifierMessaging = contractVerifierMessaging + this.localStubRunner = new StubRunnerExecutor(portScanner, contractVerifierMessaging) + } + + @Override + RunningStubs runStubs() { + registerShutdownHook() + return localStubRunner.runStubs(stubRunnerOptions,stubRepository, stubsConfiguration) + } + + @Override + URL findStubUrl(String groupId, String artifactId) { + return localStubRunner.findStubUrl(groupId, artifactId) + } + + @Override + URL findStubUrl(String ivyNotation) { + String[] splitString = ivyNotation.split(":") + if (splitString.length == 1) { + // assuming that ivy notation represents artifactId only + return findStubUrl(null, splitString[0]) + } + return findStubUrl(splitString[0], splitString[1]) + } + + @Override + RunningStubs findAllRunningStubs() { + return localStubRunner.findAllRunningStubs() + } + + @Override + Map> getContracts() { + return localStubRunner.getContracts() + } + + @Override + boolean trigger(String ivyNotation, String labelName) { + return localStubRunner.trigger(ivyNotation, labelName) + } + + @Override + boolean trigger(String labelName) { + return localStubRunner.trigger(labelName) + } + + @Override + boolean trigger() { + return localStubRunner.trigger() + } + + @Override + Map> labels() { + return localStubRunner.labels() + } + + private void registerShutdownHook() { + Runnable stopAllServers = { this.close() } + Runtime.runtime.addShutdownHook(new Thread(stopAllServers)) + } + + @Override + void close() throws IOException { + localStubRunner?.shutdown() + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerExecutor.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerExecutor.groovy new file mode 100644 index 0000000000..7e49ad4ee0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerExecutor.groovy @@ -0,0 +1,155 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.json.JsonOutput +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessaging +import org.springframework.cloud.contract.verifier.util.BodyExtractor + +/** + * Runs stubs for a particular {@link StubServer} + */ +@CompileStatic +@Slf4j +class StubRunnerExecutor implements StubFinder { + + private final AvailablePortScanner portScanner + private final ContractVerifierMessaging contractVerifierMessaging + private StubServer stubServer + + StubRunnerExecutor(AvailablePortScanner portScanner, ContractVerifierMessaging contractVerifierMessaging) { + this.portScanner = portScanner + this.contractVerifierMessaging = contractVerifierMessaging + } + + StubRunnerExecutor(AvailablePortScanner portScanner) { + this.portScanner = portScanner + this.contractVerifierMessaging = new NoOpContractVerifierMessaging() + } + + RunningStubs runStubs(StubRunnerOptions stubRunnerOptions, StubRepository repository, StubConfiguration stubConfiguration) { + startStubServers(stubRunnerOptions, stubConfiguration, repository) + RunningStubs runningCollaborators = + new RunningStubs([(stubServer.stubConfiguration): stubServer.port]) + log.info("All stubs are now running [${runningCollaborators.toString()}") + return runningCollaborators + } + + void shutdown() { + stubServer?.stop() + } + + @Override + URL findStubUrl(String groupId, String artifactId) { + if (!groupId) { + return returnStubUrlIfMatches(stubServer.stubConfiguration.artifactId == artifactId) + } + return returnStubUrlIfMatches(stubServer.stubConfiguration.artifactId == artifactId && + stubServer.stubConfiguration.groupId == groupId) + } + + @Override + URL findStubUrl(String ivyNotation) { + String[] splitString = ivyNotation.split(":") + if (splitString.length == 1) { + throw new IllegalArgumentException("$ivyNotation is invalid") + } + return findStubUrl(splitString[0], splitString[1]) + } + + @Override + RunningStubs findAllRunningStubs() { + return new RunningStubs([(stubServer.stubConfiguration) : stubServer.port]) + } + + @Override + Map> getContracts() { + return [(stubServer.stubConfiguration): stubServer.contracts] + } + + @Override + boolean trigger(String ivyNotationAsString, String labelName) { + Collection matchingContracts = getContracts().findAll { + it.key.groupIdAndArtifactMatches(ivyNotationAsString) + }.values().flatten() as Collection + return triggerForDsls(matchingContracts, labelName) + } + + @Override + boolean trigger(String labelName) { + return triggerForDsls(getContracts().values().flatten() as Collection, labelName) + } + + private boolean triggerForDsls(Collection dsls, String labelName) { + Collection matchingDsls = dsls.findAll { it.label == labelName } + if (matchingDsls.empty) { + return false + } + matchingDsls.each { + sendMessageIfApplicable(it) + } + return true + } + + @Override + boolean trigger() { + (getContracts().values().flatten() as Collection).each { Contract groovyDsl -> + sendMessageIfApplicable(groovyDsl) + } + return true + } + + @Override + Map> labels() { + return getContracts().collectEntries { + [(it.key.toColonSeparatedDependencyNotation()) : it.value.collect { it.label }] + } as Map> + } + + private void sendMessageIfApplicable(Contract groovyDsl) { + if (!groovyDsl.outputMessage) { + return + } + ContractVerifierMessage message = contractVerifierMessaging.create( + new JsonOutput().toJson(BodyExtractor.extractClientValueFromBody(groovyDsl.outputMessage?.body?.clientValue)), + groovyDsl.outputMessage?.headers?.asStubSideMap()) + contractVerifierMessaging.send(message, groovyDsl.outputMessage.sentTo.clientValue) + } + + private URL returnStubUrlIfMatches(boolean condition) { + return condition ? stubServer.stubUrl : null + } + + private void startStubServers(StubRunnerOptions stubRunnerOptions, StubConfiguration stubConfiguration, StubRepository repository) { + List mappings = repository.getProjectDescriptors() + Collection contracts = repository.contracts + Integer port = stubRunnerOptions.port(stubConfiguration) + if (port) { + stubServer = new StubServer(port, stubConfiguration, mappings, contracts).start() + } else { + stubServer = portScanner.tryToExecuteWithFreePort { int availablePort -> + return new StubServer(availablePort, stubConfiguration, mappings, contracts).start() + } + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerFactory.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerFactory.groovy new file mode 100644 index 0000000000..6429e56252 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerFactory.groovy @@ -0,0 +1,63 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging + +/** + * Factory of StubRunners. Basing on the options and passed collaborators + * downloads the stubs and returns a list of corresponding stub runners. + */ +@Slf4j +@CompileStatic +class StubRunnerFactory { + + private final StubRunnerOptions stubRunnerOptions + private final StubDownloader stubDownloader + private final ContractVerifierMessaging contractVerifierMessaging + + StubRunnerFactory(StubRunnerOptions stubRunnerOptions, StubDownloader stubDownloader, ContractVerifierMessaging contractVerifierMessaging) { + this.stubRunnerOptions = stubRunnerOptions + this.stubDownloader = stubDownloader + this.contractVerifierMessaging = contractVerifierMessaging + } + + Collection createStubsFromServiceConfiguration() { + return stubRunnerOptions.getDependencies().collect { StubConfiguration stubsConfiguration -> + Map.Entry entry = stubDownloader.downloadAndUnpackStubJar(stubRunnerOptions, stubsConfiguration) + if (!entry) { + return null + } + return createStubRunner(entry.key, entry.value) + }.findAll { it != null } + } + + private StubRunner createStubRunner(StubConfiguration stubsConfiguration, File unzipedStubDir) { + if (!unzipedStubDir) { + return null + } + return createStubRunner(unzipedStubDir, stubsConfiguration, stubRunnerOptions) + } + + private StubRunner createStubRunner(File unzippedStubsDir, StubConfiguration stubsConfiguration, + StubRunnerOptions stubRunnerOptions) { + return new StubRunner(stubRunnerOptions, unzippedStubsDir.path, stubsConfiguration, contractVerifierMessaging) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerMain.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerMain.groovy new file mode 100644 index 0000000000..3fc959780a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerMain.groovy @@ -0,0 +1,94 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.kohsuke.args4j.CmdLineException +import org.kohsuke.args4j.CmdLineParser +import org.kohsuke.args4j.Option + +import static org.kohsuke.args4j.OptionHandlerFilter.ALL + +@Slf4j +@CompileStatic +class StubRunnerMain { + + @Option(name = "-sr", aliases = ['--stubRepositoryRoot'], usage = "Location of a Jar containing server where you keep your stubs (e.g. http://nexus.net/content/repositories/repository)", required = true) + private String stubRepositoryRoot + + @Option(name = "-ss", aliases = ['--stubsSuffix'], usage = "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'") + private String stubsSuffix = 'stubs' + + @Option(name = "-minp", aliases = ['--minPort'], usage = "Minimal port value to be assigned to the WireMock instance. Defaults to 10000") + private Integer minPortValue = 10000 + + @Option(name = "-maxp", aliases = ['--maxPort'], usage = "Maximum port value to be assigned to the WireMock instance. Defaults to 15000") + private Integer maxPortValue = 15000 + + @Option(name = "-wo", aliases = ['--workOffline'], usage = "Switch to work offline. Defaults to 'false'") + private Boolean workOffline = Boolean.FALSE + + @Option(name = "-s", aliases = ['--stubs'], usage = 'Comma separated list of Ivy representation of jars with stubs. Eg. groupid:artifactid1,groupid2:artifactid2:classifier') + private String stubs + + private final Arguments arguments + + StubRunnerMain(String[] args) { + CmdLineParser parser = new CmdLineParser(this) + try { + parser.parseArgument(args) + StubRunnerOptions stubRunnerOptions = new StubRunnerOptionsBuilder() + .withMinMaxPort(minPortValue, maxPortValue) + .withStubRepositoryRoot(stubRepositoryRoot) + .withWorkOffline(workOffline) + .withStubsClassifier(stubsSuffix) + .withStubs(stubs) + .build() + this.arguments = new Arguments(stubRunnerOptions) + } catch (CmdLineException e) { + printErrorMessage(e, parser) + throw e + } + } + + private void printErrorMessage(CmdLineException e, CmdLineParser parser) { + System.err.println(e.getMessage()) + System.err.println("java -jar stub-runner.jar [options...] ") + parser.printUsage(System.err) + System.err.println() + System.err.println("Example: java -jar stub-runner.jar ${parser.printExample(ALL)}") + } + + static void main(String[] args) { + new StubRunnerMain(args).execute() + } + + private void execute() { + try { + log.debug("Launching StubRunner with args: $arguments") + // TODO: Pass StubsToRun either from String or File + BatchStubRunner stubRunner = new BatchStubRunnerFactory(arguments.stubRunnerOptions).buildBatchStubRunner() + RunningStubs runningCollaborators = stubRunner.runStubs() + log.info(runningCollaborators.toString()) + } catch (Exception e) { + log.error("An exception occurred while trying to execute the stubs", e) + throw e + } + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerMessagingTrigger.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerMessagingTrigger.groovy new file mode 100644 index 0000000000..594dd1c1ce --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerMessagingTrigger.groovy @@ -0,0 +1,35 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.PackageScope +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging + +/** + * @author Marcin Grzejszczak + */ +@PackageScope +class StubRunnerMessagingTrigger { + + private final ContractVerifierMessaging contractVerifierMessaging + + StubRunnerMessagingTrigger(ContractVerifierMessaging contractVerifierMessaging) { + this.contractVerifierMessaging = contractVerifierMessaging + } + + void trigger +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.groovy new file mode 100644 index 0000000000..d93f8ea034 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptions.groovy @@ -0,0 +1,86 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import groovy.transform.ToString + +/** + * Technical options related to running StubRunner + * + * Use {@class StubRunnerOptionsBuilder} to build this object. + * + * @see StubRunnerOptionsBuilder + */ +@ToString(includeNames = true) +@CompileStatic +class StubRunnerOptions { + + /** + * min port value of the WireMock instance for the given collaborator + */ + final Integer minPortValue + + /** + * max port value of the WireMock instance for the given collaborator + */ + final Integer maxPortValue + + /** + * root URL from where the JAR with stub mappings will be downloaded + */ + final String stubRepositoryRoot + + /** + * avoids local repository in dependency resolution + */ + final boolean workOffline + + /** + * stub definition classifier + */ + final String stubsClassifier + + final Collection dependencies + + /** + * colon separated list of ids to the desired port + */ + final Map stubIdsToPortMapping + + @PackageScope + StubRunnerOptions(Integer minPortValue, Integer maxPortValue, String stubRepositoryRoot, + boolean workOffline, String stubsClassifier, Collection dependencies, Map stubIdsToPortMapping) { + this.minPortValue = minPortValue + this.maxPortValue = maxPortValue + this.stubRepositoryRoot = stubRepositoryRoot + this.workOffline = workOffline + this.stubsClassifier = stubsClassifier + this.dependencies = dependencies + this.stubIdsToPortMapping = stubIdsToPortMapping + } + + Integer port(StubConfiguration stubConfiguration) { + if (stubIdsToPortMapping) { + return stubIdsToPortMapping[stubConfiguration] + } else { + return null + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptionsBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptionsBuilder.groovy new file mode 100644 index 0000000000..78b98c9186 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptionsBuilder.groovy @@ -0,0 +1,135 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.stubrunner.util.StubsParser + +@CompileStatic +class StubRunnerOptionsBuilder { + private static final String DELIMITER = ':' + private LinkedList stubs = new LinkedList<>() + private Map stubIdsToPortMapping = [:] + + private Integer minPortValue = 10000 + private Integer maxPortValue = 15000 + private String stubRepositoryRoot + private boolean workOffline = false + private String stubsClassifier = 'stubs' + + StubRunnerOptionsBuilder() { + } + + StubRunnerOptionsBuilder(StubRunnerOptions options) { + withOptions(options) + } + + StubRunnerOptionsBuilder withStubs(String stubs) { + addStub(stubsToList(stubs)) + return this + } + + StubRunnerOptionsBuilder withStubs(List stubs) { + for (String stub : stubs) { + withStubs(stub) + } + return this + } + + StubRunnerOptionsBuilder withMinMaxPort(Integer minPortValue, Integer maxPortValue) { + this.minPortValue = minPortValue + this.maxPortValue = maxPortValue + return this + } + + StubRunnerOptionsBuilder withMinPort(int minPortValue) { + this.minPortValue = minPortValue + return this + } + + StubRunnerOptionsBuilder withMaxPort(int maxPortValue) { + this.maxPortValue = maxPortValue + return this + } + + StubRunnerOptionsBuilder withStubRepositoryRoot(String stubRepositoryRoot) { + this.stubRepositoryRoot = stubRepositoryRoot + return this + } + + StubRunnerOptionsBuilder withWorkOffline(boolean workOffline) { + this.workOffline = workOffline + return this + } + + StubRunnerOptionsBuilder withStubsClassifier(String stubsClassifier) { + this.stubsClassifier = stubsClassifier + return this + } + + StubRunnerOptionsBuilder withPort(Integer port) { + String lastStub = stubs.peekLast() + println "PORT $lastStub -> $port" + addPort(lastStub + DELIMITER + port) + return this + } + + StubRunnerOptionsBuilder withOptions(StubRunnerOptions options) { + this.minPortValue = options.minPortValue + this.maxPortValue = options.maxPortValue + this.stubRepositoryRoot = options.stubRepositoryRoot + this.workOffline = options.workOffline + this.stubsClassifier = options.stubsClassifier + return this + } + + StubRunnerOptions build() { + return new StubRunnerOptions(minPortValue, maxPortValue, stubRepositoryRoot, workOffline, stubsClassifier, buildDependencies(), stubIdsToPortMapping) + } + + private Collection buildDependencies() { + return StubsParser.fromString(stubs, stubsClassifier) + } + + private static List stubsToList(String stubIdsToPortMapping) { + return stubIdsToPortMapping.split(',').collect { it } + } + + private void addStub(List notations) { + for (String notation : notations) { + addStub(notation) + } + } + + private void addStub(String notation) { + if (StubsParser.hasPort(notation)) { + addPort(notation) + stubs.add(StubsParser.ivyFromStringWithPort(notation)) + } else { + stubs.add(notation) + } + } + + private void addPort(String notation) { + putStubIdsToPortMapping(StubsParser.fromStringWithPort(notation)) + } + + private void putStubIdsToPortMapping(Map stubIdsToPortMapping) { + this.stubIdsToPortMapping.putAll(stubIdsToPortMapping) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunning.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunning.groovy new file mode 100644 index 0000000000..08758b541e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubRunning.groovy @@ -0,0 +1,25 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +interface StubRunning extends Closeable, StubFinder { + /** + * Runs the stubs and returns the {@link RunningStubs} + */ + RunningStubs runStubs() + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubServer.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubServer.groovy new file mode 100644 index 0000000000..5ef2d0968d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubServer.groovy @@ -0,0 +1,88 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import com.github.tomakehurst.wiremock.WireMockServer +import com.github.tomakehurst.wiremock.client.WireMock +import com.github.tomakehurst.wiremock.core.WireMockConfiguration +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.Contract + +@CompileStatic +@Slf4j +@PackageScope +class StubServer { + private WireMockServer wireMockServer + final StubConfiguration stubConfiguration + final Collection mappings + final Collection contracts + + StubServer(int port, StubConfiguration stubConfiguration, Collection mappings, + Collection contracts) { + this.stubConfiguration = stubConfiguration + this.mappings = mappings + this.wireMockServer = new WireMockServer(WireMockConfiguration.wireMockConfig().port(port)) + this.contracts = contracts + } + + StubServer start() { + wireMockServer.start() + log.info("Started stub server for project ${stubConfiguration.toColonSeparatedDependencyNotation()} on port ${wireMockServer.port()}") + registerStubMappings() + return this + } + + void stop() { + wireMockServer.stop() + } + + int getPort() { + return wireMockServer.port() + } + + URL getStubUrl() { + return new URL("http://localhost:$port") + } + + private void registerStubMappings() { + WireMock wireMock = new WireMock('localhost', wireMockServer.port()) + registerDefaultHealthChecks(wireMock) + registerStubs(mappings, wireMock) + } + + private void registerDefaultHealthChecks(WireMock wireMock) { + registerHealthCheck(wireMock, '/ping') + registerHealthCheck(wireMock, '/health') + } + + private void registerStubs(Collection sortedMappings, WireMock wireMock) { + sortedMappings.each { WiremockMappingDescriptor mappingDescriptor -> + try { + wireMock.register(mappingDescriptor.mapping) + log.debug("Registered stub mappings from $mappingDescriptor.descriptor") + } catch (Exception e) { + log.warn("Failed to register the stub mapping [$mappingDescriptor]", e) + } + } + } + + private void registerHealthCheck(WireMock wireMock, String url, String body = 'OK') { + wireMock.register(WireMock.get(WireMock.urlEqualTo(url)).willReturn(WireMock.aResponse().withBody(body).withStatus(200))) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubTrigger.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubTrigger.groovy new file mode 100644 index 0000000000..c9ef71bafa --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/StubTrigger.groovy @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +interface StubTrigger { + + /** + * Triggers an event by a given label for a given {@code groupid:artifactid} notation. You can use only {@code artifactId} too. + * + * Feature related to messaging. + * + * @return true - if managed to run a trigger + */ + boolean trigger(String ivyNotation, String labelName) + + /** + * Triggers an event by a given label. + * + * Feature related to messaging. + * + * @return true - if managed to run a trigger + */ + boolean trigger(String labelName) + + /** + * Triggers all possible events. + * + * Feature related to messaging. + * + * @return true - if managed to run a trigger + */ + boolean trigger() + + /** + * Returns a mapping of ivy notation of a dependency to all the labels it has. + * + * Feature related to messaging. + */ + Map> labels() +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/WiremockMappingDescriptor.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/WiremockMappingDescriptor.groovy new file mode 100644 index 0000000000..e3bdba3f9b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/WiremockMappingDescriptor.groovy @@ -0,0 +1,43 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import com.github.tomakehurst.wiremock.stubbing.StubMapping +import groovy.transform.CompileStatic +import groovy.transform.EqualsAndHashCode +import groovy.transform.PackageScope +import groovy.transform.ToString + +/** + * Represents a single JSON file that was found in the folder with + * potential WireMock stubs + */ +@CompileStatic +@EqualsAndHashCode +@ToString(includePackage = false) +@PackageScope +class WiremockMappingDescriptor { + final File descriptor + + WiremockMappingDescriptor(File mappingDescriptor) { + this.descriptor = mappingDescriptor + } + + StubMapping getMapping() { + return StubMapping.buildFrom(descriptor.getText('UTF-8')) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/StringUtils.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/StringUtils.groovy new file mode 100644 index 0000000000..5382f8ae57 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/StringUtils.groovy @@ -0,0 +1,140 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.util + +/** + * Utils ported from Apache Commons + * + * @author Marcin Grzejszczak + */ +class StringUtils { + public static String EMPTY = "" + private static int INDEX_NOT_FOUND = -1 + + // Empty checks + //----------------------------------------------------------------------- + /** + *

Checks if a String is empty ("") or null.

+ * + * 
+	 * StringUtils.isEmpty(null)      = true
+	 * StringUtils.isEmpty("")        = true
+	 * StringUtils.isEmpty(" ")       = false
+	 * StringUtils.isEmpty("bob")     = false
+	 * StringUtils.isEmpty("  bob  ") = false
+	 *
+ * + *

NOTE: This method changed in Lang version 2.0. + * It no longer trims the String. + * That functionality is available in isBlank().

+ * + * @param str the String to check, may be null + * @return true if the String is empty or null + */ + public static boolean isEmpty(String str) { + return str == null || str.length() == 0; + } + + static boolean isNotEmpty(String string) { + return string != null && !string.empty + } + + static boolean hasText(String string) { + return isNotEmpty(string) && !string.allWhitespace + } + + /** + *

Gets the substring before the last occurrence of a separator. + * The separator is not returned.

+ * + *

A null string input will return null. + * An empty ("") string input will return the empty string. + * An empty or null separator will return the input string.

+ * + *

If nothing is found, the string input is returned.

+ * + * 
+	 * StringUtils.substringBeforeLast(null, *)      = null
+	 * StringUtils.substringBeforeLast("", *)        = ""
+	 * StringUtils.substringBeforeLast("abcba", "b") = "abc"
+	 * StringUtils.substringBeforeLast("abc", "c")   = "ab"
+	 * StringUtils.substringBeforeLast("a", "a")     = ""
+	 * StringUtils.substringBeforeLast("a", "z")     = "a"
+	 * StringUtils.substringBeforeLast("a", null)    = "a"
+	 * StringUtils.substringBeforeLast("a", "")      = "a"
+	 *
+ * + * @param str the String to get a substring from, may be null + * @param separator the String to search for, may be null + * @return the substring before the last occurrence of the separator, + * null if null String input + * @since 2.0 + */ + public static String substringBeforeLast(String str, String separator) { + if (isEmpty(str) || isEmpty(separator)) { + return str; + } + int pos = str.lastIndexOf(separator); + if (pos == INDEX_NOT_FOUND) { + return str; + } + return str.substring(0, pos); + } + + /** + *

Gets the substring after the last occurrence of a separator. + * The separator is not returned.

+ * + *

A null string input will return null. + * An empty ("") string input will return the empty string. + * An empty or null separator will return the empty string if + * the input string is not null.

+ * + *

If nothing is found, the empty string is returned.

+ * + * 
+	 * StringUtils.substringAfterLast(null, *)      = null
+	 * StringUtils.substringAfterLast("", *)        = ""
+	 * StringUtils.substringAfterLast(*, "")        = ""
+	 * StringUtils.substringAfterLast(*, null)      = ""
+	 * StringUtils.substringAfterLast("abc", "a")   = "bc"
+	 * StringUtils.substringAfterLast("abcba", "b") = "a"
+	 * StringUtils.substringAfterLast("abc", "c")   = ""
+	 * StringUtils.substringAfterLast("a", "a")     = ""
+	 * StringUtils.substringAfterLast("a", "z")     = ""
+	 *
+ * + * @param str the String to get a substring from, may be null + * @param separator the String to search for, may be null + * @return the substring after the last occurrence of the separator, + * null if null String input + * @since 2.0 + */ + public static String substringAfterLast(String str, String separator) { + if (isEmpty(str)) { + return str; + } + if (isEmpty(separator)) { + return EMPTY; + } + int pos = str.lastIndexOf(separator); + if (pos == INDEX_NOT_FOUND || pos == (str.length() - separator.length())) { + return EMPTY; + } + return str.substring(pos + separator.length()); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/StubsParser.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/StubsParser.groovy new file mode 100644 index 0000000000..bb45d160fe --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/StubsParser.groovy @@ -0,0 +1,81 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.util + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.stubrunner.StubConfiguration + +/** + * Utility to parse string into a list of configuration of stubs + */ +@CompileStatic +class StubsParser { + + /** + * The string is expected to be a map with entry called "stubs" + * that contains a list of Strings in the format + * + *
    + *
  • groupid:artifactid:classifier
    • + *
  • groupid:artifactid
    • + *
+ * + * In the latter case the provided default stub classifier will be passed. + * + * Example: + * + * "a:b,c:d:e" + */ + static Set fromString(String list, String defaultClassifier) { + def splitList = list.split(',').findAll { it } + return fromString(splitList, defaultClassifier) + } + + static Set fromString(Collection collection, String defaultClassifier) { + return collection.findAll { it }.collect { String entry -> + def splitEntry = entry.split(':') + if (splitEntry.last().isInteger()) { + String id = entry - ":${splitEntry.last()}" + new StubConfiguration(id, defaultClassifier) + } + new StubConfiguration(entry, defaultClassifier) + } as Set + } + + static Map fromStringWithPort(String notation) { + def splitEntry = notation.split(':') + if (!splitEntry.last().isInteger()) { + return [:] + } + Integer port = splitEntry.last().toInteger() + String id = notation - ":${splitEntry.last()}" + return [(new StubConfiguration(id)): port] + } + + static String ivyFromStringWithPort(String notation) { + def splitEntry = notation.split(':') + if (!splitEntry.last().isInteger()) { + return '' + } + return notation - ":${splitEntry.last()}" + } + + static boolean hasPort(String notation) { + def splitEntry = notation.split(':') + return splitEntry.last().isInteger() + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/ZipCategory.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/ZipCategory.groovy new file mode 100644 index 0000000000..105298b558 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/groovy/org/springframework/cloud/contract/stubrunner/util/ZipCategory.groovy @@ -0,0 +1,72 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.util + +import groovy.transform.CompileStatic + +import java.util.zip.ZipEntry +import java.util.zip.ZipInputStream + +/** + * Based on https://github.com/timyates/groovy-common-extensions. + * + * Category for {@link File} that adds a method that allows you to unzip + * a given file to a specified location + * + */ +@CompileStatic +class ZipCategory { + + /** + * Unzips this file. If the destination + * directory is not provided, it will fall back to this file's parent directory. + * + * @param self + * @param destination (optional), the destination directory where this file's content will be unzipped to. + * @return a {@link Collection} of unzipped {@link File} objects. + */ + static Collection unzipTo(File self, File destination) { + checkUnzipDestination(destination) + // if destination directory is not given, we'll fall back to the parent directory of 'self' + if (destination == null) destination = new File(self.parent) + List unzippedFiles = [] + final ZipInputStream zipInput = new ZipInputStream(new FileInputStream(self)) + zipInput.withStream { + ZipEntry entry + while (entry = zipInput.nextEntry) { + if (!entry.isDirectory()) { + final File file = new File(destination, entry.name) + file.parentFile?.mkdirs() + FileOutputStream output = new FileOutputStream(file) + output.withStream { + output << zipInput + } + unzippedFiles << file + } else { + final File dir = new File(destination, entry.name) + dir.mkdirs() + unzippedFiles << dir + } + } + } + return unzippedFiles + } + + private static void checkUnzipDestination(File file) { + if (file && !file.isDirectory()) throw new IllegalArgumentException("'destination' has to be a directory.") + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/resources/accurestStubrunnerGrapeConfig.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/resources/accurestStubrunnerGrapeConfig.xml new file mode 100644 index 0000000000..cbbd28cea5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/main/resources/accurestStubrunnerGrapeConfig.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/AvailablePortScannerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/AvailablePortScannerSpec.groovy new file mode 100644 index 0000000000..6a7703ee84 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/AvailablePortScannerSpec.groovy @@ -0,0 +1,70 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +class AvailablePortScannerSpec extends Specification { + + private static final int MIN_PORT = 8989 + private static final int MAX_PORT = 8990 + private static final int MAX_RETRY_COUNT_FOR_NEGATIVE_SCENARIOS = 2 + + def 'should execute given closure with the next available port number'() { + given: + AvailablePortScanner portScanner = new AvailablePortScanner(MIN_PORT, MAX_PORT) + when: + int usedPort = portScanner.tryToExecuteWithFreePort { int port -> port } + then: + noExceptionThrown() + usedPort == MIN_PORT || MAX_PORT + } + + def 'should execute given closure with the available port from specified range'() { + given: + AvailablePortScanner portScanner = new AvailablePortScanner(MIN_PORT, MIN_PORT) + when: + int usedPort = portScanner.tryToExecuteWithFreePort { int port -> port } + then: + noExceptionThrown() + usedPort == MIN_PORT + } + + def 'should throw exception when improper range has been provided'() { + when: + new AvailablePortScanner(minPort, maxPort, MAX_RETRY_COUNT_FOR_NEGATIVE_SCENARIOS) + then: + def ex = thrown(AvailablePortScanner.InvalidPortRange) + ex.message == "Invalid bounds exceptions, min port [$minPort] is greater to max port [$maxPort]" + where: + minPort | maxPort + MAX_PORT | MIN_PORT + + } + + def 'should throw exception when there is no available port'() { + given: + AvailablePortScanner portScanner = new AvailablePortScanner(MIN_PORT, MAX_PORT, MAX_RETRY_COUNT_FOR_NEGATIVE_SCENARIOS) + when: + portScanner.tryToExecuteWithFreePort { + throw new BindException('Bind exception from closure') + } + then: + def ex = thrown(AvailablePortScanner.NoPortAvailableException) + ex.message == "Could not find available port in range $MIN_PORT:$MAX_PORT" + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunnerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunnerSpec.groovy new file mode 100644 index 0000000000..83c46a48d5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/BatchStubRunnerSpec.groovy @@ -0,0 +1,59 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +class BatchStubRunnerSpec extends Specification { + + static final String KNOWN_STUB_PATH = 'group:knownArtifact' + static final String UNKNOWN_STUB_PATH = 'group:unknownArtifact' + static final URL KNOWN_STUB_URL = new URL('http://localhost:8080') + + def 'should provide stub URL from enclosed stub runner'() { + given: + BatchStubRunner batchStubRunner = new BatchStubRunner(runners()) + expect: + batchStubRunner.findStubUrl(KNOWN_STUB_PATH) == KNOWN_STUB_URL + } + + def 'should return empty optional for unknown stub path'() { + given: + BatchStubRunner batchStubRunner = new BatchStubRunner(runners()) + expect: + !batchStubRunner.findStubUrl(UNKNOWN_STUB_PATH) + } + + def 'should throw exception if trying to execute not available trigger'() { + given: + BatchStubRunner batchStubRunner = new BatchStubRunner(runners()) + when: + batchStubRunner.trigger('non existing label') + then: + IllegalArgumentException exception = thrown(IllegalArgumentException) + exception.message == "No label with name [non existing label] was found. Here you have the list of dependencies and their labels [Dependency [a:b:c] has labels [foo]]" + } + + Collection runners() { + StubRunner runner = Mock(StubRunner) + runner.findStubUrl("group", "knownArtifact") >> KNOWN_STUB_URL + runner.findStubUrl("group", "unknownArtifact") >> null + runner.labels() >> ['a:b:c' : ['foo']] + return [runner] + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/MappingDescriptorSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/MappingDescriptorSpec.groovy new file mode 100644 index 0000000000..2fddae9d96 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/MappingDescriptorSpec.groovy @@ -0,0 +1,39 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import com.github.tomakehurst.wiremock.http.RequestMethod +import spock.lang.Specification + +class MappingDescriptorSpec extends Specification { + public static + final File MAPPING_DESCRIPTOR = new File('src/test/resources/repository/mappings/spring/cloud/ping/ping.json') + + def 'should describe stub mapping'() { + given: + WiremockMappingDescriptor mappingDescriptor = new WiremockMappingDescriptor(MAPPING_DESCRIPTOR) + + expect: + with(mappingDescriptor.mapping) { + request.method == RequestMethod.GET + request.url == '/ping' + response.status == 200 + response.body == 'pong' + response.headers.contentTypeHeader.mimeTypePart() == 'text/plain' + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/RunningStubsSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/RunningStubsSpec.groovy new file mode 100644 index 0000000000..57eac143b8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/RunningStubsSpec.groovy @@ -0,0 +1,87 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +/** + * @author Marcin Grzejszczak + */ +class RunningStubsSpec extends Specification { + RunningStubs runningStubs = new RunningStubs([(new StubConfiguration('group', 'artifact', 'version', 'classifier')) : 100]) + + def "should get port by group and artifact id"() { + expect: + runningStubs.getPort('group', 'artifact') == 100 + } + + def "should get port by artifact id"() { + expect: + runningStubs.getPort('artifact') == 100 + } + + def "should get port by group and artifact id in Ivy notation"() { + expect: + runningStubs.getPort('group:artifact') == 100 + } + + def "should get port by group, artifact id and version in Ivy notation"() { + expect: + runningStubs.getPort('group:artifact:version') == 100 + } + + def "should get port by group, artifact id, version and classifier in Ivy notation"() { + expect: + runningStubs.getPort('group:artifact:version:classifier') == 100 + } + + def "should return null if no stub has been found"() { + expect: + runningStubs.getPort('missing artifact id') == null + } + + def "should find stub by group and artifact id"() { + expect: + runningStubs.isPresent('group', 'artifact') + } + + def "should find stub by artifact id"() { + expect: + runningStubs.isPresent('artifact') + } + + def "should find stub by group and artifact id in Ivy notation"() { + expect: + runningStubs.isPresent('group:artifact') + } + + def "should find stub by group, artifact id and version in Ivy notation"() { + expect: + runningStubs.isPresent('group:artifact:version') + } + + def "should find stub by group, artifact id, version and classifier in Ivy notation"() { + expect: + runningStubs.isPresent('group:artifact:version:classifier') + } + + def "should return false if no stub has been found"() { + expect: + runningStubs.isPresent('missing artifact id') == false + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubConfigurationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubConfigurationSpec.groovy new file mode 100644 index 0000000000..0e5d631d8d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubConfigurationSpec.groovy @@ -0,0 +1,37 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +/** + * @author Marcin Grzejszczak + */ +class StubConfigurationSpec extends Specification { + + def 'should parse ivy notation'() { + given: + String ivy = 'group:artifact:version:classifier' + when: + StubConfiguration stubConfiguration = new StubConfiguration(ivy) + then: + stubConfiguration.artifactId == 'artifact' + stubConfiguration.groupId == 'group' + stubConfiguration.classifier == 'classifier' + stubConfiguration.version == 'version' + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRepositorySpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRepositorySpec.groovy new file mode 100644 index 0000000000..bc5614e5a1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRepositorySpec.groovy @@ -0,0 +1,50 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +class StubRepositorySpec extends Specification { + public static + final File REPOSITORY_LOCATION = new File('src/test/resources/repository') + + def 'should retrieve all descriptors for given project'() { + given: + StubRepository repository = new StubRepository(REPOSITORY_LOCATION) + int expectedDescriptorsSize = 8 + when: + List descriptors = repository.getProjectDescriptors() + then: + descriptors.size() == expectedDescriptorsSize + } + + def 'should return empty list if files are missing'() { + given: + StubRepository repository = new StubRepository(new File('src/test/resources/emptyrepo')) + when: + List descriptors = repository.getProjectDescriptors() + then: + descriptors.empty + } + + def 'should throw an exception if directory with mappings is missing'() { + when: + new StubRepository(new File('src/test/resources/nonexistingrepo')) + then: + thrown(FileNotFoundException) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerExecutorSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerExecutorSpec.groovy new file mode 100644 index 0000000000..ad8b9bfe41 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerExecutorSpec.groovy @@ -0,0 +1,130 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import groovy.json.JsonOutput +import org.springframework.cloud.contract.stubrunner.util.StubsParser +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging +import spock.lang.Specification + +import java.util.concurrent.TimeUnit + +class StubRunnerExecutorSpec extends Specification { + + static final int MIN_PORT = 8999 + static final int MAX_PORT = 9999 + + private AvailablePortScanner portScanner + private StubRepository repository + private StubConfiguration stub = new StubConfiguration("group:artifact", "stubs") + private StubRunnerOptions stubRunnerOptions = new StubRunnerOptionsBuilder().build() + + def setup() { + portScanner = new AvailablePortScanner(MIN_PORT, MAX_PORT) + repository = new StubRepository(new File('src/test/resources/repository')) + } + + def 'should provide URL for given relative path of stub'() { + given: + StubRunnerExecutor executor = new StubRunnerExecutor(portScanner) + when: + executor.runStubs(stubRunnerOptions, repository, stub) + then: + URL url = executor.findStubUrl("group", "artifact") + url.port >= MIN_PORT + url.port <= MAX_PORT + and: + executor.findAllRunningStubs().isPresent('artifact') + executor.findAllRunningStubs().isPresent('group', 'artifact') + executor.findAllRunningStubs().isPresent('group:artifact') + cleanup: + executor.shutdown() + } + + def 'should provide no URL for unknown dependency path'() { + given: + StubRunnerExecutor executor = new StubRunnerExecutor(portScanner) + when: + executor.runStubs(stubRunnerOptions, repository, stub) + then: + !executor.findStubUrl("unkowngroup", "unknownartifact") + } + + def 'should start a stub on a given port'() { + given: + StubRunnerExecutor executor = new StubRunnerExecutor(portScanner) + stubRunnerOptions = new StubRunnerOptionsBuilder(stubIdsToPortMapping: stubIdsWithPortsFromString('group:artifact:12345,someotherartifact:123')) + .build() + when: + executor.runStubs(stubRunnerOptions, repository, stub) + then: + executor.findStubUrl("group", "artifact") == 'http://localhost:12345'.toURL() + } + + def 'should ensure that triggered contracts have properly parsed message body when a message is sent'() { + given: + StubRunnerExecutor executor = new StubRunnerExecutor(portScanner, new AssertingContractVerifierMessaging()) + executor.runStubs(stubRunnerOptions, repository, stub) + when: + executor.trigger('send_order') + then: + noExceptionThrown() + } + + Map stubIdsWithPortsFromString(String stubIdsToPortMapping) { + return stubIdsToPortMapping.split(',').collectEntries { String entry -> + return StubsParser.fromStringWithPort(entry) + } + } + + private class AssertingContractVerifierMessaging implements ContractVerifierMessaging { + + @Override + void send(ContractVerifierMessage message, String destination) { + + } + + @Override + ContractVerifierMessage receiveMessage(String destination, long timeout, TimeUnit timeUnit) { + return null + } + + @Override + ContractVerifierMessage receiveMessage(String destination) { + return null + } + + @Override + void send(Object o, Map headers, String destination) { + + } + + @Override + ContractVerifierMessage create(Object o, Map headers) { + assert !(JsonOutput.toJson(o).contains("serverValue")) + assert headers.entrySet().every { !(it.value.toString().contains("serverValue")) } + return null + } + + @Override + ContractVerifierMessage create(Object o) { + return null + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerFactorySpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerFactorySpec.groovy new file mode 100644 index 0000000000..ced2a5f713 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerFactorySpec.groovy @@ -0,0 +1,55 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import org.junit.Rule +import org.junit.rules.TemporaryFolder +import org.springframework.cloud.contract.verifier.messaging.noop.NoOpContractVerifierMessaging +import spock.lang.Specification + +class StubRunnerFactorySpec extends Specification { + + @Rule + TemporaryFolder folder = new TemporaryFolder() + + String stubs = "a:b,c:d" + StubDownloader downloader = Mock(StubDownloader) + StubRunnerOptions stubRunnerOptions + StubRunnerFactory factory + + void setup() { + stubRunnerOptions = new StubRunnerOptionsBuilder() + .withStubRepositoryRoot(folder.root.absolutePath) // FIXME: not used + .withStubs(stubs).build() + factory = new StubRunnerFactory(stubRunnerOptions, downloader, new NoOpContractVerifierMessaging()) + } + + def "Should download stub definitions many times"() { + given: + folder.newFolder("mappings") + 1 * downloader.downloadAndUnpackStubJar(_, _) >> new AbstractMap.SimpleEntry(new StubConfiguration('a:b'), folder.root) + 1 * downloader.downloadAndUnpackStubJar(_, _) >> new AbstractMap.SimpleEntry(new StubConfiguration('c:d'), folder.root) + when: + Collection stubRunners = collectOnlyPresentValues(factory.createStubsFromServiceConfiguration()) + then: + stubRunners.size() == 2 + } + + private List collectOnlyPresentValues(Collection stubRunners) { + return stubRunners.findAll { it != null } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptionsBuilderSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptionsBuilderSpec.groovy new file mode 100644 index 0000000000..c0d4aba44c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerOptionsBuilderSpec.groovy @@ -0,0 +1,84 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +class StubRunnerOptionsBuilderSpec extends Specification { + + private StubRunnerOptionsBuilder builder = new StubRunnerOptionsBuilder() + + def shouldCreateDependenciesForStub() { + + given: + builder.withStubs('foo:bar') + + when: + StubRunnerOptions options = builder.build() + + then: + options.getDependencies().toString() == '[foo:bar:+:stubs]' + } + + def shouldCreateDependenciesForCommaSeparatedStubs() { + + given: + builder.withStubs('foo:bar,bar:foo') + + when: + StubRunnerOptions options = builder.build() + + then: + options.getDependencies().size() == 2 + } + + def shouldMapStubsWithPort() { + + given: + builder.withStubs('foo:bar:8080') + + when: + StubRunnerOptions options = builder.build() + + then: + options.getStubIdsToPortMapping().toString() == '[foo:bar:+:stubs:8080]' + } + + def shouldCreateDependenciesWithVersion() { + + given: + builder.withStubs('foo:1.2.3:bar') + + when: + StubRunnerOptions options = builder.build() + + then: + options.getDependencies().toString() == '[foo:1.2.3:bar:stubs]' + } + + def shouldCreateDependenciesWithClassifier() { + + given: + builder.withStubs('foo:bar').withStubsClassifier('xxx') + + when: + StubRunnerOptions options = builder.build() + + then: + options.getDependencies().toString() == '[foo:bar:+:xxx]' + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerSpec.groovy new file mode 100644 index 0000000000..18fb646e97 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubRunnerSpec.groovy @@ -0,0 +1,55 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +class StubRunnerSpec extends Specification { + + private static final int MIN_PORT = 8111 + private static final int MAX_PORT = 8111 + private static final URL EXPECTED_STUB_URL = new URL("http://localhost:$MIN_PORT") + + def 'should provide stub URL for provided groupid and artifactId'() { + given: + StubRunner runner = new StubRunner(argumentsWithProjectDefinition()) + when: + runner.runStubs() + then: + runner.findStubUrl("groupId", "artifactId") == EXPECTED_STUB_URL + cleanup: + runner.close() + } + + def 'should provide stub URL if only artifactId was passed'() { + given: + StubRunner runner = new StubRunner(argumentsWithProjectDefinition()) + when: + runner.runStubs() + then: + runner.findStubUrl(null, "artifactId") == EXPECTED_STUB_URL + cleanup: + runner.close() + } + + Arguments argumentsWithProjectDefinition() { + StubConfiguration stubConfiguration = new StubConfiguration("groupId", "artifactId", "classifier") + StubRunnerOptions stubRunnerOptions = new StubRunnerOptionsBuilder().withMinMaxPort(MIN_PORT, MAX_PORT).build() + return new Arguments(stubRunnerOptions, 'src/test/resources/repository', stubConfiguration) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubServerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubServerSpec.groovy new file mode 100644 index 0000000000..7be6fbaefc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/StubServerSpec.groovy @@ -0,0 +1,51 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner + +import spock.lang.Specification + +class StubServerSpec extends Specification { + static final int STUB_SERVER_PORT = 12180 + static final URL EXPECTED_URL = new URL("http://localhost:$STUB_SERVER_PORT") + + File repository = new File('src/test/resources/repository/mappings/spring/cloud/bye') + StubConfiguration stubConfiguration = new StubConfiguration("a:b") + + def 'should register stub mappings upon server start'() { + given: + List mappingDescriptors = new StubRepository(repository).getProjectDescriptors() + StubServer pingStubServer = new StubServer(STUB_SERVER_PORT, stubConfiguration, mappingDescriptors, []) + when: + pingStubServer.start() + then: + "http://localhost:$pingStubServer.port/bye".toURL().text == 'Goodbye world!' + cleanup: + pingStubServer.stop() + } + + def 'should provide stub server URL'() { + given: + List mappingDescriptors = new StubRepository(repository).getProjectDescriptors() + StubServer pingStubServer = new StubServer(STUB_SERVER_PORT, stubConfiguration, mappingDescriptors, []) + when: + pingStubServer.start() + then: + pingStubServer.stubUrl == EXPECTED_URL + cleanup: + pingStubServer.stop() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/util/ZipCategorySpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/util/ZipCategorySpec.groovy new file mode 100644 index 0000000000..c3b0834b02 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/groovy/org/springframework/cloud/contract/stubrunner/util/ZipCategorySpec.groovy @@ -0,0 +1,40 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.stubrunner.util + +import groovy.util.logging.Slf4j +import spock.lang.Specification + +@Slf4j +class ZipCategorySpec extends Specification { + + def 'should unzip a file to the specified location'() { + given: + File zipFile = new File(ZipCategorySpec.classLoader.getResource('file.zip').toURI()) + File tempDir = File.createTempDir() + tempDir.deleteOnExit() + when: + use(ZipCategory) { + zipFile.unzipTo(tempDir) + } + then: + tempDir.listFiles().find { + it.name == 'file.txt' + }?.text?.trim() == 'test' + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/bar/bar.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/bar/bar.json new file mode 100644 index 0000000000..0b71cbf35e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/bar/bar.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/bar" + }, + "response": { + "status": 200, + "body": "bar", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/foo/bar/foobar.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/foo/bar/foobar.json new file mode 100644 index 0000000000..e231b2c0c5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/foo/bar/foobar.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/foobar" + }, + "response": { + "status": 200, + "body": "foobar", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/foo/foo.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/foo/foo.json new file mode 100644 index 0000000000..209061ef5e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/mappings/spring/cloud/foo/foo.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/foo" + }, + "response": { + "status": 200, + "body": "foo", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/brokers/brokers.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/brokers/brokers.json new file mode 100644 index 0000000000..fae6436ad8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/brokers/brokers.json @@ -0,0 +1,5 @@ +{ + "pl": [ + "spring/cloud/bar" + ] +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/brokers/nested/anotherDescriptor.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/brokers/nested/anotherDescriptor.json new file mode 100644 index 0000000000..b3a72bfbcf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/brokers/nested/anotherDescriptor.json @@ -0,0 +1,5 @@ +{ + "pl": [ + "spring/cloud/foo/bar" + ] +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/descriptor.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/descriptor.json new file mode 100644 index 0000000000..a2384b0930 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/anotherRepository/projects/descriptor.json @@ -0,0 +1,5 @@ +{ + "pl": [ + "spring/cloud/foo" + ] +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/emptyrepo/.gitkeep b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/emptyrepo/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/file.zip b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/file.zip new file mode 100644 index 0000000000..3da3a91240 Binary files /dev/null and b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/file.zip differ diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/logback.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/logback.xml new file mode 100644 index 0000000000..7eecabf2f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/logback.xml @@ -0,0 +1,30 @@ + + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/contracts/contract1.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/contracts/contract1.groovy new file mode 100644 index 0000000000..94fc426530 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/contracts/contract1.groovy @@ -0,0 +1,27 @@ +org.springframework.cloud.contract.spec.Contract.make { + // Human readable description + description 'Sends an order message' + // Label by means of which the output message can be triggered + label 'send_order' + // input to the contract + input { + // the contract will be triggered by a method + triggeredBy('orderTrigger()') + } + // output message of the contract + outputMessage { + // destination to which the output message will be sent + sentTo('orders') + // any headers for the output message + headers { + header('contentType': 'application/json') + } + // the body of the output message + body( + orderId: value( + consumer('40058c70-891c-4176-a033-f70bad0c5f77'), + producer(regex('([0-9|a-f]*-*)*'))), + description: "This is the order description" + ) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/lv/spring/cloud/bye/lv_bye.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/lv/spring/cloud/bye/lv_bye.json new file mode 100644 index 0000000000..a062cd4674 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/lv/spring/cloud/bye/lv_bye.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/lv/bye" + }, + "response": { + "status": 200, + "body": "Another goodbye world!", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/pl/spring/cloud/bye/pl_bye.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/pl/spring/cloud/bye/pl_bye.json new file mode 100644 index 0000000000..b7c5e4ebc9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/pl/spring/cloud/bye/pl_bye.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/pl/bye" + }, + "response": { + "status": 200, + "body": "pl-bye", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/pl/spring/cloud/bye/pl_overridden_bye.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/pl/spring/cloud/bye/pl_overridden_bye.json new file mode 100644 index 0000000000..9c54c98914 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/pl/spring/cloud/bye/pl_overridden_bye.json @@ -0,0 +1,14 @@ +{ + + "request": { + "method": "GET", + "url": "/bye" + }, + "response": { + "status": 200, + "body": "overridden-bye", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/bye/admin/admin.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/bye/admin/admin.json new file mode 100644 index 0000000000..f730b7e3cf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/bye/admin/admin.json @@ -0,0 +1,9 @@ +{ + "request": { + "method": "GET", + "url": "/admin" + }, + "response": { + "status": 401 + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/bye/bye.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/bye/bye.json new file mode 100644 index 0000000000..1a65830d4a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/bye/bye.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/bye" + }, + "response": { + "status": 200, + "body": "Goodbye world!", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/README.md b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/README.md new file mode 100644 index 0000000000..484f8efe77 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/README.md @@ -0,0 +1 @@ +### Hello service stub \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/admin/admin.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/admin/admin.json new file mode 100644 index 0000000000..f730b7e3cf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/admin/admin.json @@ -0,0 +1,9 @@ +{ + "request": { + "method": "GET", + "url": "/admin" + }, + "response": { + "status": 401 + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/hello.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/hello.json new file mode 100644 index 0000000000..3cd9f7374b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/hello/hello.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/hello" + }, + "response": { + "status": 200, + "body": "Hello world!", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/ping/ping.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/ping/ping.json new file mode 100644 index 0000000000..db01229c52 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-stub-runner/spring-cloud-contract-stub-runner/src/test/resources/repository/mappings/spring/cloud/ping/ping.json @@ -0,0 +1,13 @@ +{ + "request": { + "method": "GET", + "url": "/ping" + }, + "response": { + "status": 200, + "body": "pong", + "headers": { + "Content-Type": "text/plain" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.gradle new file mode 100644 index 0000000000..b83dd96ee3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/build.gradle @@ -0,0 +1,109 @@ +/* + * Copyright 2013-2016 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. + */ + +String verifier = "spring-cloud-contract-verifier" + +project(":$verifier-root:$verifier-core") { + + dependencies { + compile project(":spring-cloud-contract-spec") + compile 'org.slf4j:slf4j-api:1.6.0' + compile 'commons-io:commons-io:2.0' + compile 'org.apache.commons:commons-lang3:3.3' + compile "com.github.tomakehurst:wiremock:$wiremockVersion" + compile "com.toomuchcoding.jsonassert:jsonassert:$jsonassertVersion" + compile 'org.codehaus.groovy:groovy-all:2.4.4' + testCompile 'cglib:cglib-nodep:2.2' + testCompile 'org.objenesis:objenesis:2.1' + testCompile project(":$verifier-root:$verifier-testing-utils") + } + +} + +project(":$verifier-root:$verifier-testing-utils") { + + dependencies { + compile 'org.skyscreamer:jsonassert:1.2.3' + } + +} + +project(":$verifier-root:$verifier-converters") { + dependencies { + compile project(":$verifier-root:$verifier-core") + compile 'org.apache.commons:commons-lang3:3.0' + compile 'commons-io:commons-io:2.0' + compile 'dk.brics.automaton:automaton:1.11-8' // needed for Xeger + testCompile "com.github.tomakehurst:wiremock:$wiremockVersion" + testCompile 'org.hamcrest:hamcrest-all:1.3' + } +} + +project(":$verifier-root:$verifier-gradle-plugin") { + + ext.messagingLibsDir ="$buildDir/messaging-libs" + ext.contractVerifierGradlePluginLibsDir ="$buildDir/contractVerifier-gradle-plugin-libs" + + ext.testSystemProperties = [ + 'contract-verifier-gradle-plugin-libs-dir': contractVerifierGradlePluginLibsDir, + 'messaging-libs-dir': messagingLibsDir + ] + + dependencies { + compile project(":$verifier-root:$verifier-core") + compile project(":$verifier-root:$verifier-converters") + compile gradleApi() + + testCompile gradleTestKit() + testCompile project(":$verifier-root:$verifier-testing-utils") + } + + configurations { + messagingLibs + contractVerifierGradlePluginLibs + } + + dependencies { + + messagingLibs project(":$verifier-root:$verifier-messaging-root:$verifier-integration") + messagingLibs project(":$verifier-root:$verifier-messaging-root:$verifier-messaging-core") + messagingLibs project(":$verifier-root:$verifier-testing-utils") + messagingLibs 'org.codehaus.groovy:groovy-all:2.4.5' + + contractVerifierGradlePluginLibs project(":$verifier-root:$verifier-gradle-plugin") + } + + test { + systemProperties = testSystemProperties + } + + task archiveMessagingLibsDependencies(type: Sync) { + from configurations.messagingLibs.resolvedConfiguration.resolvedArtifacts.collect { it.file } + into messagingLibsDir + } + + task archiveContractVerifierGradlePluginLibsDependencies(type: Sync) { + from configurations.contractVerifierGradlePluginLibs.resolvedConfiguration.resolvedArtifacts.collect { it.file } + into contractVerifierGradlePluginLibsDir + } + + // archive task needs to have jars ready + archiveMessagingLibsDependencies.dependsOn project(":$verifier-root:$verifier-messaging-root:$verifier-integration").tasks.jar + archiveContractVerifierGradlePluginLibsDependencies.dependsOn project(":$verifier-root:$verifier-gradle-plugin").tasks.jar + + test.dependsOn archiveMessagingLibsDependencies, archiveContractVerifierGradlePluginLibsDependencies + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/nl/flotsam/xeger/Xeger.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/nl/flotsam/xeger/Xeger.java new file mode 100644 index 0000000000..9bd42a674a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/nl/flotsam/xeger/Xeger.java @@ -0,0 +1,118 @@ +/** + * Copyright 2009 Wilfred Springer + * Copyright 2012 Jason Pell + * Copyright 2013 Antonio García-Domínguez + * + * 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. + * + * The class is bundled together with our code because it has not been + * released to any central repository. + * + */ +package nl.flotsam.xeger; + +import dk.brics.automaton.Automaton; +import dk.brics.automaton.RegExp; +import dk.brics.automaton.State; +import dk.brics.automaton.Transition; + +import java.util.List; +import java.util.Random; + +/** + * An object that will generate text from a regular expression. In a way, it's the opposite of a regular expression + * matcher: an instance of this class will produce text that is guaranteed to match the regular expression passed in. + */ +public class Xeger { + + private final Automaton automaton; + private Random random; + + /** + * Constructs a new instance, accepting the regular expression and the randomizer. + * + * @param regex The regular expression. (Not null.) + * @param random The object that will randomize the way the String is generated. (Not null.) + * @throws IllegalArgumentException If the regular expression is invalid. + */ + public Xeger(String regex, Random random) { + assert regex != null; + assert random != null; + this.automaton = new RegExp(regex).toAutomaton(); + this.random = random; + } + + /** + * As {@link nl.flotsam.xeger.Xeger#Xeger(String, java.util.Random)}, creating a {@link java.util.Random} instance + * implicityly. + * + * @param regex as string + */ + public Xeger(String regex) { + this(regex, new Random()); + } + + /** + * Generates a random String that is guaranteed to match the regular expression passed to the constructor. + * @return generated regexp + */ + public String generate() { + StringBuilder builder = new StringBuilder(); + generate(builder, automaton.getInitialState()); + return builder.toString(); + } + + private void generate(StringBuilder builder, State state) { + List transitions = state.getSortedTransitions(false); + if (transitions.size() == 0) { + assert state.isAccept(); + return; + } + int nroptions = state.isAccept() ? transitions.size() : transitions.size() - 1; + int option = Xeger.getRandomInt(0, nroptions, random); + if (state.isAccept() && option == 0) { // 0 is considered stop + return; + } + // Moving on to next transition + Transition transition = transitions.get(option - (state.isAccept() ? 1 : 0)); + appendChoice(builder, transition); + generate(builder, transition.getDest()); + } + + private void appendChoice(StringBuilder builder, Transition transition) { + char c = (char) Xeger.getRandomInt(transition.getMin(), transition.getMax(), random); + builder.append(c); + } + + public Random getRandom() { + return random; + } + + public void setRandom(Random random) { + this.random = random; + } + + /** + * Generates a random number within the given bounds. + * + * @param min The minimum number (inclusive). + * @param max The maximum number (inclusive). + * @param random The object used as the randomizer. + * @return A random number in the given range. + */ + static int getRandomInt(int min, int max, Random random) { + // Use random.nextInt as it guarantees a uniform distribution + int maxForRandom=max-min+1; + return random.nextInt(maxForRandom) + min; + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/converter/SingleFileConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/converter/SingleFileConverter.groovy new file mode 100644 index 0000000000..ad860b19ea --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/converter/SingleFileConverter.groovy @@ -0,0 +1,44 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.converter + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +/** + * Converts contracts into their stub representation + * + * @since 1.0.0 + */ +@CompileStatic +interface SingleFileConverter { + + /** + * Returns {@code true} if the converter can handle the file + */ + boolean canHandleFileName(String fileName) + + /** + * Returns the content of the converted file + */ + String convertContent(String rootName, ContractMetadata content) + + /** + * Returns the name of the converted file + */ + String generateOutputFileNameForInput(String inputFileName) +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/ConversionContractVerifierException.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/ConversionContractVerifierException.groovy new file mode 100644 index 0000000000..f6f9d5a6ee --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/ConversionContractVerifierException.groovy @@ -0,0 +1,33 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.ContractVerifierException + +/** + * Thrown when a a DSL can't be properly converted + * + * @since 1.0.0 + */ +@CompileStatic +class ConversionContractVerifierException extends ContractVerifierException { + + ConversionContractVerifierException(String message, Throwable cause) { + super(message, cause) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverter.groovy new file mode 100644 index 0000000000..3fe90afb25 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverter.groovy @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.verifier.dsl.wiremock.WireMockStubStrategy +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +import java.nio.charset.StandardCharsets + +/** + * Converts DSLs to WireMock stubs + * + * @since 1.0.0 + */ +@CompileStatic +class DslToWireMockClientConverter extends DslToWireMockConverter { + + @Override + String convertContent(String rootName, ContractMetadata contract) { + String dslContent = contract.path.getText(StandardCharsets.UTF_8.toString()) + return new WireMockStubStrategy(rootName, contract, createGroovyDSLFromStringContent(dslContent)).toWireMockClientStub() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.groovy new file mode 100644 index 0000000000..7cb8172674 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockConverter.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.converter.SingleFileConverter +import org.springframework.cloud.contract.verifier.util.ContractVerifierDslConverter + +/** + * WireMock implementation of the {@link SingleFileConverter} + * + * @since 1.0.0 + */ +@CompileStatic +abstract class DslToWireMockConverter implements SingleFileConverter { + + @Override + boolean canHandleFileName(String fileName) { + return fileName.endsWith('.groovy') + } + + @Override + String generateOutputFileNameForInput(String inputFileName) { + return inputFileName.replaceAll('.groovy', '.json') + } + + protected Contract createGroovyDSLFromStringContent(String groovyDslAsString) { + return ContractVerifierDslConverter.convert(groovyDslAsString) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/RecursiveFilesConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/RecursiveFilesConverter.groovy new file mode 100644 index 0000000000..56ddd3f99e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/RecursiveFilesConverter.groovy @@ -0,0 +1,93 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import com.google.common.collect.ListMultimap +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.converter.SingleFileConverter +import org.springframework.cloud.contract.verifier.file.ContractFileScanner +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +import java.nio.charset.StandardCharsets +import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.Paths +/** + * Recursively converts contracts into their stub representations + * + * @since 1.0.0 + */ +@Slf4j +@CompileStatic +class RecursiveFilesConverter { + + private final SingleFileConverter singleFileConverter + private final ContractVerifierConfigProperties properties + private final File outMappingsDir + + RecursiveFilesConverter(SingleFileConverter singleFileConverter, ContractVerifierConfigProperties properties) { + this.properties = properties + this.singleFileConverter = singleFileConverter + this.outMappingsDir = properties.stubsOutputDir + } + + RecursiveFilesConverter(SingleFileConverter singleFileConverter, ContractVerifierConfigProperties properties, File outMappingsDir) { + this.properties = properties + this.singleFileConverter = singleFileConverter + this.outMappingsDir = outMappingsDir + } + + void processFiles() { + ContractFileScanner scanner = new ContractFileScanner(properties.contractsDslDir, properties.excludedFiles as Set, [] as Set) + ListMultimap contracts = scanner.findContracts() + log.debug("Found the following contracts $contracts") + contracts.asMap().entrySet().each { entry -> + entry.value.each { ContractMetadata contract -> + File sourceFile = contract.path.toFile() + try { + if (!singleFileConverter.canHandleFileName(sourceFile.name)) { + return + } + String convertedContent = singleFileConverter.convertContent(entry.key.last().toString(), contract) + if (!convertedContent) { + return + } + Path absoluteTargetPath = createAndReturnTargetDirectory(sourceFile) + File newJsonFile = createTargetFileWithProperName(absoluteTargetPath, sourceFile) + newJsonFile.setText(convertedContent, StandardCharsets.UTF_8.toString()) + } catch (Exception e) { + throw new ConversionContractVerifierException("Unable to make conversion of ${sourceFile.name}", e) + } + } + } + } + + private Path createAndReturnTargetDirectory(File sourceFile) { + Path relativePath = Paths.get(properties.contractsDslDir.toURI()).relativize(sourceFile.parentFile.toPath()) + Path absoluteTargetPath = outMappingsDir.toPath().resolve(relativePath) + Files.createDirectories(absoluteTargetPath) + return absoluteTargetPath + } + + private File createTargetFileWithProperName(Path absoluteTargetPath, File sourceFile) { + File newJsonFile = new File(absoluteTargetPath.toFile(), singleFileConverter.generateOutputFileNameForInput(sourceFile.name)) + log.info("Creating new json [$newJsonFile.path]") + return newJsonFile + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/WireMockToDslConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/WireMockToDslConverter.groovy new file mode 100644 index 0000000000..960797316c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/main/groovy/org/springframework/cloud/contract/verifier/wiremock/WireMockToDslConverter.groovy @@ -0,0 +1,209 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import groovy.io.FileType +import groovy.json.JsonOutput +import groovy.json.JsonParserType +import groovy.json.JsonSlurper +import groovy.transform.CompileDynamic +import groovy.xml.XmlUtil +import org.springframework.cloud.contract.spec.Contract +import nl.flotsam.xeger.Xeger + +import java.nio.charset.StandardCharsets + +import static org.apache.commons.lang3.StringEscapeUtils.escapeJava + +/** + * Converts WireMock stubs into the DSL format + * + * @since 1.0.0 + */ +@CompileDynamic +class WireMockToDslConverter { + + /** + * Returns the string content of the contract + * + * @param wireMockStringStub - string content of the WireMock JSON stub + */ + static String fromWireMockStub(String wireMockStringStub) { + return new WireMockToDslConverter().convertFromWireMockStub(wireMockStringStub) + } + + private String convertFromWireMockStub(String wireMockStringStub) { + Object wireMockStub = parseStubDefinition(wireMockStringStub) + Integer priority = wireMockStub.priority + def request = wireMockStub.request + def response = wireMockStub.response + def bodyPatterns = request.bodyPatterns + String urlPattern = request.urlPattern + String urlPathPattern = request.urlPathPattern + return """\ + ${priority ? "priority ${priority}" : ''} + request { + ${request.method ? "method \"\"\"$request.method\"\"\"" : ""} + ${request.url ? "url \"\"\"$request.url\"\"\"" : ""} + ${urlPattern ? "url \$(client(regex('${escapeJava(urlPattern)}')), server('${new Xeger(escapeJava(urlPattern)).generate()}'))" : ""} + ${urlPathPattern ? "urlPath \$(client(regex('${escapeJava(urlPattern)}')), server('${new Xeger(escapeJava(urlPattern)).generate()}'))" : ""} + ${request.urlPath ? "url \"\"\"$request.urlPath\"\"\"" : ""} + ${ + request.headers ? """headers { + ${ + request.headers.collect { + def assertion = it.value + String headerName = it.key as String + def entry = assertion.entrySet().first() + """header(\"\"\"$headerName\"\"\", ${buildHeader(entry.key, entry.value)})\n""" + }.join('') + } + } + """ : "" + } + ${bodyPatterns?.equalTo?.every { it } ? "body('''${bodyPatterns.equalTo[0]}''')" : ''} + ${bodyPatterns?.equalToJson?.every { it } ? "body('''${bodyPatterns.equalToJson[0]}''')" : ''} + ${bodyPatterns?.matches?.every { it } ? "body \$(client(regex('${escapeJava(bodyPatterns.matches[0])}')), server('${new Xeger(escapeJava(bodyPatterns.matches[0])).generate()}'))" : ""} + } + response { + ${response.status ? "status $response.status" : ""} + ${response.body ? "body( ${buildBody(response.body)})" : ""} + ${ + response.headers ? """headers { + ${response.headers.collect { "header('$it.key': '${it.value}')\n" }.join('')} + } + """ : "" + } + } + """ + } + + private Object parseStubDefinition(String wireMockStringStub) { + new JsonSlurper().setType(JsonParserType.LAX).parseText(wireMockStringStub) + } + + private String buildHeader(String method, Object value) { + switch (method) { + case 'equalTo': + return wrapWithMultilineGString(value) + default: + return "regex(${wrapWithMultilineGString(escapeJava(value as String))})" + } + } + + private Object buildBody(Map responseBody) { + return responseBody.entrySet().collectAll(withQuotedMapStringElements()).inject([:], appendToIterable()) + } + + private Object buildBody(List responseBody) { + return responseBody.collectAll(withQuotedStringElements()).inject([], appendToIterable()) + } + + private Object buildBody(Integer responseBody) { + return responseBody + } + + private Object buildBody(String responseBody) { + try { + def json = new JsonSlurper().parseText(responseBody) + return wrapWithMultilineGString(JsonOutput.prettyPrint(responseBody)) + } catch (Exception jsonException) { + try { + def xml = new XmlSlurper().parseText(responseBody) + return wrapWithMultilineGString(XmlUtil.serialize(responseBody)) + } catch (Exception xmlException) { + return wrapWithMultilineGString(responseBody) + } + } + } + + private String wrapWithMultilineGString(String string) { + return """\"\"\"$string\"\"\"""" + } + + private Closure withQuotedMapStringElements() { + return { + [(it.key): convert(it.value)] + } + } + + private Closure withQuotedStringElements() { + return { + convert(it) + } + } + + private Closure appendToIterable() { + return { + acc, el -> acc << el + } + } + + private Object convert(Object element) { + return element + } + + private Object convert(String element) { + return quoteString(element) + } + + private String quoteString(String element) { + if (element =~ /^".*"$/) { + return element + } + return """\"\"\"${escapeJava(element)}\"\"\"""" + } + + private Object convert(List element) { + return element.collect { + convert(it) + } + } + + private Object convert(Map element) { + return element.collectEntries { + [(it.key): convert(it.value)] + } + } + + static void main(String[] args) { + String rootOfFolderWithStubs = args[0] + new File(rootOfFolderWithStubs).eachFileRecurse(FileType.FILES) { + try { + if (!it.name.endsWith('json')) { + return + } + String dslFromWireMockStub = fromWireMockStub(it.getText(StandardCharsets.UTF_8.toString())) + String dslWrappedWithFactoryMethod = wrapWithFactoryMethod(dslFromWireMockStub) + File newGroovyFile = new File(it.parent, it.name.replaceAll('json', 'groovy')) + println("Creating new groovy file [$newGroovyFile.path]") + newGroovyFile.setText(dslWrappedWithFactoryMethod, StandardCharsets.UTF_8.toString()) + } catch (Exception e) { + System.err.println(e) + } + + } + } + + static String wrapWithFactoryMethod(String dslFromWireMockStub) { + return """\ +${Contract.name}.make { + $dslFromWireMockStub +} +""" + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/nl/flotsam/xeger/XegerTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/nl/flotsam/xeger/XegerTest.java new file mode 100644 index 0000000000..f60e4bf5db --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/nl/flotsam/xeger/XegerTest.java @@ -0,0 +1,64 @@ +/** + * Copyright 2009 Wilfred Springer + * Copyright 2012 Jason Pell + * Copyright 2013 Antonio García-Domínguez + * + * 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. + */ +package nl.flotsam.xeger; + +import org.junit.Test; + +import java.util.ArrayList; +import java.util.List; +import java.util.Random; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; + +public class XegerTest { + + @Test + public void shouldGenerateTextCorrectly() { + String regex = "[ab]{4,6}c"; + Xeger generator = new Xeger(regex); + for (int i = 0; i < 100; i++) { + String text = generator.generate(); + assertTrue(text.matches(regex)); + } + } + + @Test + public void testRepeatableRegex() { + for (int x = 0; x < 1000; x++) { + Xeger generator = new Xeger("[ab]{4,6}c", new Random(1000)); + Xeger generator2 = new Xeger("[ab]{4,6}c", new Random(1000)); + + List firstRegexList = generateRegex(generator, 100); + List secondRegexList = generateRegex(generator2, 100); + + for (int i = 0; i < firstRegexList.size(); i++) { + assertEquals("Index mismatch: " + i, firstRegexList.get(i), + secondRegexList.get(i)); + } + } + } + + private List generateRegex(Xeger generator, int count) { + List regexList = new ArrayList(); + for (int i = 0; i < count; i++) { + regexList.add(generator.generate()); + } + return regexList; + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/nl/flotsam/xeger/XegerUtilsTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/nl/flotsam/xeger/XegerUtilsTest.java new file mode 100644 index 0000000000..ccabfeb54d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/nl/flotsam/xeger/XegerUtilsTest.java @@ -0,0 +1,39 @@ +/** + * Copyright 2009 Wilfred Springer + * Copyright 2012 Jason Pell + * Copyright 2013 Antonio García-Domínguez + * + * 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. + */ +package nl.flotsam.xeger; + +import org.hamcrest.Matchers; +import org.junit.Test; + +import java.util.Random; + +import static org.junit.Assert.assertThat; + +public class XegerUtilsTest { + + @Test + public void shouldGenerateRandomNumberCorrectly() { + Random random = new Random(); + for (int i = 0; i < 100; i++) { + int number = Xeger.getRandomInt(3, 7, random); + assertThat(number, Matchers.greaterThanOrEqualTo(3)); + assertThat(number, Matchers.lessThanOrEqualTo(7)); + } + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy new file mode 100755 index 0000000000..dbd37a54f3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/DslToWireMockClientConverterSpec.groovy @@ -0,0 +1,284 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import org.junit.Rule +import org.junit.rules.TemporaryFolder +import org.skyscreamer.jsonassert.JSONAssert +import org.springframework.cloud.contract.verifier.file.ContractMetadata +import spock.lang.Issue +import spock.lang.Specification + +class DslToWireMockClientConverterSpec extends Specification { + + @Rule + public TemporaryFolder tmpFolder = new TemporaryFolder(); + + def "should convert DSL file to WireMock JSON"() { + given: + def converter = new DslToWireMockClientConverter() + and: + File file = tmpFolder.newFile("dsl1.groovy") + file.write(""" + org.springframework.cloud.contract.spec.Contract.make { + request { + method('PUT') + url \$(client(~/\\/[0-9]{2}/), server('/12')) + } + response { + status 200 + } + } +""") + when: + String json = converter.convertContent("Test", new ContractMetadata(file.toPath(), false, 0, null)) + then: + JSONAssert.assertEquals(''' +{"request":{"method":"PUT","urlPattern":"/[0-9]{2}"},"response":{"status":200}} +''', json, false) + } + + @Issue("196") + def "should creation of delayed stub responses be possible"() { + given: + def converter = new DslToWireMockClientConverter() + and: + File file = tmpFolder.newFile("dsl-delay.groovy") + file.write(""" + org.springframework.cloud.contract.spec.Contract.make { + request { + } + response { + status 200 + fixedDelayMilliseconds 1000 + } + } +""") + when: + String json = converter.convertContent("test", new ContractMetadata(file.toPath(), false, 0, null)) + then: + JSONAssert.assertEquals(''' +{"request":{},"response":{"status":200,"fixedDelayMilliseconds":1000}} +''', json, false) + } + + def "should convert DSL file with a nested list to WireMock JSON"() { + given: + def converter = new DslToWireMockClientConverter() + and: + File file = tmpFolder.newFile("dsl2.groovy") + file.write(""" + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url '/api/12' + headers { + header 'Content-Type': 'application/vnd.org.springframework.cloud.contract.verifier.twitter-places-analyzer.v1+json' + + } + body ''' + [{ + "created_at": "Sat Jul 26 09:38:57 +0000 2014", + "id": 492967299297845248, + "id_str": "492967299297845248", + "text": "Gonna see you at Warsaw", + "place": + { + "attributes":{}, + "bounding_box": + { + "coordinates": + [[ + [-77.119759,38.791645], + [-76.909393,38.791645], + [-76.909393,38.995548], + [-77.119759,38.995548] + ]], + "type":"Polygon" + }, + "country":"United States", + "country_code":"US", + "full_name":"Washington, DC", + "id":"01fbe706f872cb32", + "name":"Washington", + "place_type":"city", + "url": "http://api.twitter.com/1/geo/id/01fbe706f872cb32.json" + } + }] + ''' + } + response { + status 200 + } + } +""") + when: + String json = converter.convertContent("Test", new ContractMetadata(file.toPath(), false, 0, null)) + then: + JSONAssert.assertEquals(''' +{ + "request" : { + "url" : "/api/12", + "method" : "PUT", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[*].place.bounding_box.coordinates[*][*][?(@ == -77.119759)]" + }, { + "matchesJsonPath" : "$[*][?(@.text == 'Gonna see you at Warsaw')]" + }, { + "matchesJsonPath" : "$[*].place[?(@.place_type == 'city')]" + }, { + "matchesJsonPath" : "$[*][?(@.id == 492967299297845248)]" + }, { + "matchesJsonPath" : "$[*].place.bounding_box.coordinates[*][*][?(@ == 38.791645)]" + }, { + "matchesJsonPath" : "$[*].place[?(@.country == 'United States')]" + }, { + "matchesJsonPath" : "$[*][?(@.id_str == '492967299297845248')]" + }, { + "matchesJsonPath" : "$[*].place.bounding_box.coordinates[*][*][?(@ == -76.909393)]" + }, { + "matchesJsonPath" : "$[*].place[?(@.name == 'Washington')]" + }, { + "matchesJsonPath" : "$[*].place.bounding_box[?(@.type == 'Polygon')]" + }, { + "matchesJsonPath" : "$[*].place[?(@.url == 'http://api.twitter.com/1/geo/id/01fbe706f872cb32.json')]" + }, { + "matchesJsonPath" : "$[*].place.bounding_box.coordinates[*][*][?(@ == 38.995548)]" + }, { + "matchesJsonPath" : "$[*].place[?(@.country_code == 'US')]" + }, { + "matchesJsonPath" : "$[*].place[?(@.full_name == 'Washington, DC')]" + }, { + "matchesJsonPath" : "$[*][?(@.created_at == 'Sat Jul 26 09:38:57 +0000 2014')]" + }, { + "matchesJsonPath" : "$[*].place[?(@.id == '01fbe706f872cb32')]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/vnd.org.springframework.cloud.contract.verifier.twitter-places-analyzer.v1+json" + } + } + }, + "response" : { + "status" : 200 + } +} +''', json, false) + } + + + @Issue("262") + def "should create stub with map inside list"() { + given: + def converter = new DslToWireMockClientConverter() + and: + File file = tmpFolder.newFile("dsl-mapinlist.groovy") + file.write(""" + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath '/foos' + } + response { + status 200 + body([[id: value( + client('123'), + server(regex('[0-9]+')) + )], [id: value( + client('567'), + server(regex('[0-9]+')) + )]]) + headers { + header 'Content-Type': 'application/json' + } + } + } +""") + when: + String json = converter.convertContent("test", new ContractMetadata(file.toPath(), false, 0, null)) + then: + JSONAssert.assertEquals(''' +{"request":{"urlPath":"/foos","method":"GET"},"response":{"body":"[{\\"id\\":\\"123\\"},{\\"id\\":\\"567\\"}]"}} +''', json, false) + } + + def 'should convert dsl to wiremock to show it in the docs'() { + given: + def converter = new DslToWireMockClientConverter() + and: + File file = tmpFolder.newFile("dsl_from_docs.groovy") + file.write(''' + org.springframework.cloud.contract.spec.Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + email: $(stub(optional(regex(email()))), test('abc@abc.com')), + callback_url: $(stub(regex(hostname())), test('http://partners.com')) + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + code: value(stub("123123"), test(optional("123123"))), + message: "User not found by email == [${value(test(regex(email())), stub('not.existing@user.com'))}]" + ) + } + } + ''') + when: + String json = converter.convertContent("Test", new ContractMetadata(file.toPath(), false, 0, null)) + then: + JSONAssert.assertEquals( // tag::wiremock[] +''' +{ + "request" : { + "url" : "/users/password", + "method" : "POST", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.email =~ /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,4})?/)]" + }, { + "matchesJsonPath" : "$[?(@.callback_url =~ /((http[s]?|ftp):\\\\/)\\\\/?([^:\\\\/\\\\s]+)(:[0-9]{1,5})?/)]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/json" + } + } + }, + "response" : { + "status" : 404, + "body" : "{\\"code\\":\\"123123\\",\\"message\\":\\"User not found by email == [not.existing@user.com]\\"}", + "headers" : { + "Content-Type" : "application/json" + } + }, + "priority" : 1 +} +''' +// end::wiremock[] + , json, false) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/RecursiveFilesConverterSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/RecursiveFilesConverterSpec.groovy new file mode 100755 index 0000000000..0e3de65413 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/RecursiveFilesConverterSpec.groovy @@ -0,0 +1,115 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import org.apache.commons.io.FileUtils +import org.apache.commons.io.filefilter.TrueFileFilter +import org.junit.Rule +import org.junit.rules.TemporaryFolder +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.converter.SingleFileConverter +import spock.lang.Specification + +import java.nio.file.Path +import java.nio.file.Paths + +class RecursiveFilesConverterSpec extends Specification { + + private static + final Set EXPECTED_TARGET_FILES = [Paths.get("dslRoot.json"), Paths.get("dir1/dsl1.json"), Paths.get("dir1/dsl1b.json"), Paths.get("dir2/dsl2.json")] + + @Rule + public TemporaryFolder tmpFolder = new TemporaryFolder(); + + def "should recursively convert all matching files"() { + given: + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties() + File originalSourceRootDirectory = new File(this.getClass().getResource("/converter/source").toURI()) + properties.contractsDslDir = tmpFolder.newFolder("source") + properties.stubsOutputDir = tmpFolder.newFolder("target") + FileUtils.copyDirectory(originalSourceRootDirectory, properties.contractsDslDir) + and: + def singleFileConverterStub = Stub(SingleFileConverter) + singleFileConverterStub.canHandleFileName(_) >> { String fileName -> fileName.endsWith(".groovy") } + singleFileConverterStub.convertContent(_, _) >> { "converted" } + singleFileConverterStub.generateOutputFileNameForInput(_) >> { String inputFileName -> inputFileName.replaceAll('.groovy', '.json') } + + RecursiveFilesConverter recursiveFilesConverter = new RecursiveFilesConverter(singleFileConverterStub, properties) + when: + recursiveFilesConverter.processFiles() + then: + Collection createdFiles = FileUtils.listFiles(properties.stubsOutputDir, TrueFileFilter.INSTANCE, TrueFileFilter.INSTANCE) + Set relativizedCreatedFiles = getRelativePathsForFilesInDirectory(createdFiles, properties.stubsOutputDir) + EXPECTED_TARGET_FILES == relativizedCreatedFiles + and: + createdFiles.each { it.text == "converted" } + } + + def "should recursively convert matching files with exlusions"() { + given: + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties() + File originalSourceRootDirectory = new File(this.getClass().getResource("/converter/source").toURI()) + properties.contractsDslDir = tmpFolder.newFolder("source") + properties.stubsOutputDir = tmpFolder.newFolder("target") + properties.excludedFiles = ["dir1/**"] + FileUtils.copyDirectory(originalSourceRootDirectory, properties.contractsDslDir) + and: + def singleFileConverterStub = Stub(SingleFileConverter) + singleFileConverterStub.canHandleFileName(_) >> { String fileName -> fileName.endsWith(".groovy") } + singleFileConverterStub.convertContent(_, _) >> { "converted" } + singleFileConverterStub.generateOutputFileNameForInput(_) >> { String inputFileName -> inputFileName.replaceAll('.groovy', '.json') } + + RecursiveFilesConverter recursiveFilesConverter = new RecursiveFilesConverter(singleFileConverterStub, properties) + when: + recursiveFilesConverter.processFiles() + then: + Collection createdFiles = FileUtils.listFiles(properties.stubsOutputDir, TrueFileFilter.INSTANCE, TrueFileFilter.INSTANCE) + Set relativizedCreatedFiles = getRelativePathsForFilesInDirectory(createdFiles, properties.stubsOutputDir) + [Paths.get("dslRoot.json"), Paths.get("dir2/dsl2.json")] as Set == relativizedCreatedFiles as Set + and: + createdFiles.each { it.text == "converted" } + } + + def "on failure should break processing and throw meaningful exception"() { + given: + def sourceFile = tmpFolder.newFile("test.groovy") + and: + def singleFileConverterStub = Stub(SingleFileConverter) + singleFileConverterStub.canHandleFileName(_) >> { true } + singleFileConverterStub.convertContent(_, _) >> { throw new NullPointerException("Test conversion error") } + singleFileConverterStub.generateOutputFileNameForInput(_) >> { String inputFileName -> "${inputFileName}2" } + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties() + properties.contractsDslDir = tmpFolder.root + properties.stubsOutputDir = tmpFolder.root + RecursiveFilesConverter recursiveFilesConverter = new RecursiveFilesConverter(singleFileConverterStub, properties) + when: + recursiveFilesConverter.processFiles() + then: + def e = thrown(ConversionContractVerifierException) + e.message?.contains(sourceFile.name) + e.cause?.message == "Test conversion error" + } + + private + static Set getRelativePathsForFilesInDirectory(Collection createdFiles, File targetRootDirectory) { + Path rootSourcePath = Paths.get(targetRootDirectory.toURI()) + Set relativizedCreatedFiles = createdFiles.collect { File file -> + rootSourcePath.relativize(Paths.get(file.toURI())) + } + return relativizedCreatedFiles + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/WireMockToDslConverterSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/WireMockToDslConverterSpec.groovy new file mode 100755 index 0000000000..9b1e4c2367 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/WireMockToDslConverterSpec.groovy @@ -0,0 +1,559 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import com.github.tomakehurst.wiremock.stubbing.StubMapping +import org.springframework.cloud.contract.verifier.util.ContractVerifierDslConverter +import org.springframework.cloud.contract.spec.Contract +import spock.lang.Specification + +class WireMockToDslConverterSpec extends Specification { + + def 'should produce a Groovy DSL from WireMock stub'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "GET", + "url": "/path", + "headers" : { + "Accept": { + "matches": "text/.*" + }, + "X-Custom-Header": { + "contains": "2134" + } + } + }, + "response": { + "status": 200, + "body": '{"id": { "value": "132" }, "surname": "Kowalsky", "name": "Jan", "created": "2014-02-02 12:23:43" }', + "headers": { + "Content-Type": "text/plain" + } + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'GET' + url '/path' + headers { + header('Accept': $( + client(regex('text/.*')), + server('text/plain') + )) + header('X-Custom-Header': $( + client(regex('^.*2134.*$')), + server('121345') + )) + + } + } + response { + status 200 + body( + id: [value: '132'], + surname: 'Kowalsky', + name: 'Jan', + created: '2014-02-02 12:23:43' + ) + headers { + header 'Content-Type': 'text/plain' + + } + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") == expectedGroovyDsl + } + + + def 'should convert WireMock stub with response body containing JSON with escaped double quotes'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "DELETE", + "urlPattern": "/credit-card-verification-data/[0-9]+", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.mymoid-adapter.v2+json; charset=UTF-8" + } + } + }, + "response": { + "status": 200, + "body": "{\\"status\\": \\"OK\\"}", + "headers": { + "Content-Type": "application/json" + } + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'DELETE' + url $(client(~/\/credit-card-verification-data\/[0-9]+/), server('/credit-card-verification-data/1')) + headers { + header('Content-Type': 'application/vnd.mymoid-adapter.v2+json; charset=UTF-8') + } + } + response { + status 200 + body("""{ + "status": "OK" +}""") + headers { + header 'Content-Type': 'application/json' + + } + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") == expectedGroovyDsl + } + + def 'should convert WireMock stub with response body containing integer'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "POST", + "url": "/charge/count", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.creditcard-reporter.v1+json" + } + } + }, + "response": { + "status": 200, + "body": 200, + "headers": { + "Content-Type": "application/json" + } + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/charge/count' + headers { + header('Content-Type': 'application/vnd.creditcard-reporter.v1+json') + } + } + response { + status 200 + body(200) + headers { + header 'Content-Type': 'application/json' + + } + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") == expectedGroovyDsl + } + + def 'should convert WireMock stub with response body as a list'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "POST", + "url": "/charge/count", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.creditcard-reporter.v1+json" + } + } + }, + "response": { + "status": 200, + "body": '[ {"a":1, "c":"3"}, "b", "a" ]', + "headers": { + "Content-Type": "application/json" + } + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/charge/count' + headers { + header('Content-Type': 'application/vnd.creditcard-reporter.v1+json') + } + } + response { + status 200 + body([ + [a: 1, c: '3'], + 'b', + 'a' + ]) + headers { + header 'Content-Type': 'application/json' + } + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") == expectedGroovyDsl + } + + def 'should convert WireMock stub with response body containing a nested list'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "POST", + "url": "/charge/search?pageNumber=0&size=2147483647", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.creditcard-reporter.v1+json" + } + } + }, + "response": { + "status": 200, + "body": '[{"amount":1.01, "name":"Name", "info":{"title":"title1", "payload":null}, "booleanvalue":true, "user":null}, {"amount":2.01, "name":"Name2", "info":{"title":"title2", "payload":null}, "booleanvalue":true, "user":null}]' + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/charge/search?pageNumber=0&size=2147483647' + headers { + header('Content-Type': 'application/vnd.creditcard-reporter.v1+json') + } + } + response { + status 200 + body("""[ + { + "amount": 1.01, + "name": "Name", + "info": { + "title": "title1", + "payload": null + }, + "booleanvalue": true, + "user": null + }, + { + "amount": 2.01, + "name": "Name2", + "info": { + "title": "title2", + "payload": null + }, + "booleanvalue": true, + "user": null + } +]""") + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") == expectedGroovyDsl + } + + def 'should convert WireMock stub with request body checking equality to Json'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "POST", + "url": "/test", + "bodyPatterns": [{ + "equalTo": '{"property1":"abc", "property2":"2017-01", "property3":"666", "property4":1428566412}' + }] + }, + "response": { + "status": 200 + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/test' + body ('''{"property1":"abc","property2":"2017-01","property3":"666","property4":1428566412}''') + } + response { + status 200 + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + Contract evaluatedGroovyDsl = ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") + and: + evaluatedGroovyDsl == expectedGroovyDsl + } + + def 'should convert WireMock stub with request body checking matching to Json'() { + given: + String wireMockStub = '''\ +{ + "request": { + "method": "POST", + "url": "/test", + "bodyPatterns": [{ + "matches": "[0-9]{5}" + }] + }, + "response": { + "status": 200 + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/test' + body $(client(~/[0-9]{5}/), server('12345')) + } + response { + status 200 + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + Contract evaluatedGroovyDsl = ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") + and: + evaluatedGroovyDsl == expectedGroovyDsl + } + + def 'should convert WireMock stub with request body with equalToJson'() { + given: + String wireMockStub = '''\ +{ + "request" : { + "url" : "/test", + "method" : "POST", + "bodyPatterns" : [ { + "equalToJson" : '{"pan":"4855141150107894", "expirationDate":"2017-01", "dcvx":"178"}', + "jsonCompareMode" : "LENIENT" + } ] + }, + "response" : { + "status" : 200 + } +} +''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/test' + body '''{"pan":"4855141150107894","expirationDate":"2017-01","dcvx":"178"}''' + } + response { + status 200 + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + Contract evaluatedGroovyDsl = ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") + and: + evaluatedGroovyDsl == expectedGroovyDsl + } + + def 'should convert WireMock stub with request body with equalTo'() { + given: + String wireMockStub = '''\ + { + "request" : { + "url" : "/test", + "method" : "POST", + "bodyPatterns" : [ { + "equalTo" : '{"pan":"4855141150107894", "expirationDate":"2017-01", "dcvx":"178"}' + } ] + }, + "response" : { + "status" : 200 + } + } + ''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/test' + body '''{"pan":"4855141150107894","expirationDate":"2017-01","dcvx":"178"}''' + } + response { + status 200 + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + Contract evaluatedGroovyDsl = ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") + and: + evaluatedGroovyDsl == expectedGroovyDsl + } + + def 'should convert WireMock stub with request body with matches'() { + given: + String wireMockStub = '''\ + { + "request" : { + "url" : "/test", + "method" : "POST", + "bodyPatterns" : [ { + "matches" : "[0-9]{2}" + } ] + }, + "response" : { + "status" : 200 + } + } + ''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + request { + method 'POST' + url '/test' + body $(client(~/[0-9]{2}/), server('12')) + } + response { + status 200 + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + Contract evaluatedGroovyDsl = ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") + and: + evaluatedGroovyDsl == expectedGroovyDsl + } + + def 'should convert WireMock stub with priorities'() { + given: + String wireMockStub = '''\ + { + "priority" : 2, + "request" : { + "url" : "/test", + "method" : "POST" + }, + "response" : { + "status" : 200 + } + } + ''' + and: + stubMappingIsValidWireMockStub(wireMockStub) + and: + Contract expectedGroovyDsl = Contract.make { + priority 2 + request { + method 'POST' + url '/test' + } + response { + status 200 + } + } + when: + String groovyDsl = WireMockToDslConverter.fromWireMockStub(wireMockStub) + then: + Contract evaluatedGroovyDsl = ContractVerifierDslConverter.convert( + """org.springframework.cloud.contract.spec.Contract.make { + $groovyDsl + }""") + and: + evaluatedGroovyDsl == expectedGroovyDsl + } + + void stubMappingIsValidWireMockStub(String mappingDefinition) { + StubMapping.buildFrom(mappingDefinition) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/WiremockScenarioConverterSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/WiremockScenarioConverterSpec.groovy new file mode 100755 index 0000000000..64f0cbe13b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/groovy/org/springframework/cloud/contract/verifier/wiremock/WiremockScenarioConverterSpec.groovy @@ -0,0 +1,62 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.wiremock + +import org.springframework.cloud.contract.verifier.file.ContractMetadata +import spock.lang.Specification + +import java.nio.file.Path +import java.nio.file.Paths + +class WiremockScenarioConverterSpec extends Specification { + + def "should generate first scenario step"() { + given: + DslToWireMockClientConverter converter = new DslToWireMockClientConverter() + Path dsl = Paths.get(this.getClass().getResource("/converter/scenario/main_scenario/01_login.groovy").toURI()) + when: + String content = converter.convertContent("Test", new ContractMetadata(dsl, false, 3, 0)) + then: + content.contains('"requiredScenarioState" : "Started"') + content.contains('"newScenarioState" : "Step1"') + content.contains('"scenarioName" : "Scenario_Test"') + } + + def "should generate mid scenario step"() { + given: + DslToWireMockClientConverter converter = new DslToWireMockClientConverter() + Path dsl = Paths.get(this.getClass().getResource("/converter/scenario/main_scenario/02_showCart.groovy").toURI()) + when: + String content = converter.convertContent("Test", new ContractMetadata(dsl, false, 3, 1)) + then: + content.contains('"requiredScenarioState" : "Step1"') + content.contains('"newScenarioState" : "Step2"') + content.contains('"scenarioName" : "Scenario_Test"') + } + + def "should generate last scenario step"() { + given: + DslToWireMockClientConverter converter = new DslToWireMockClientConverter() + Path dsl = Paths.get(this.getClass().getResource("/converter/scenario/main_scenario/03_logout.groovy").toURI()) + when: + String content = converter.convertContent("Test", new ContractMetadata(dsl, false, 3, 2)) + then: + content.contains('"requiredScenarioState" : "Step2"') + !content.contains('"newScenarioState"') + content.contains('"scenarioName" : "Scenario_Test"') + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/01_login.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/01_login.groovy new file mode 100644 index 0000000000..2911d82295 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/01_login.groovy @@ -0,0 +1,27 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('POST') + url '/login' + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/02_showCart.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/02_showCart.groovy new file mode 100644 index 0000000000..c7ed09b07c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/02_showCart.groovy @@ -0,0 +1,27 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('GET') + url '/cart' + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/03_logout.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/03_logout.groovy new file mode 100644 index 0000000000..221416f88a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/scenario/main_scenario/03_logout.groovy @@ -0,0 +1,27 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('POST') + url '/logout' + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir1/dsl1.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir1/dsl1.groovy new file mode 100644 index 0000000000..c724017ffd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir1/dsl1.groovy @@ -0,0 +1,30 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('PUT') + headers { + header 'Content-Type': 'application/json' + } + url $(client('/[0-9]{2}'), server('/12')) + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir1/dsl1b.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir1/dsl1b.groovy new file mode 100644 index 0000000000..daaf2950e8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir1/dsl1b.groovy @@ -0,0 +1,30 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('PUT') + headers { + header 'Content-Type': 'application/json' + } + urlPattern $(client('/[0-9]{2}'), server('/12')) + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir2/dsl2.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir2/dsl2.groovy new file mode 100644 index 0000000000..c724017ffd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dir2/dsl2.groovy @@ -0,0 +1,30 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('PUT') + headers { + header 'Content-Type': 'application/json' + } + url $(client('/[0-9]{2}'), server('/12')) + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dslRoot.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dslRoot.groovy new file mode 100644 index 0000000000..c724017ffd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-converters/src/test/resources/converter/source/dslRoot.groovy @@ -0,0 +1,30 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('PUT') + headers { + header 'Content-Type': 'application/json' + } + url $(client('/[0-9]{2}'), server('/12')) + } + response { + status 200 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/FileSaver.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/FileSaver.groovy new file mode 100644 index 0000000000..6b350b34e3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/FileSaver.groovy @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.verifier.config.TestFramework + +import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.Paths +import java.nio.file.StandardOpenOption + +import static org.springframework.cloud.contract.verifier.util.NamesUtil.beforeLast +import static org.springframework.cloud.contract.verifier.util.NamesUtil.capitalize +import static org.springframework.cloud.contract.verifier.util.NamesUtil.packageToDirectory + +@CompileStatic +@Slf4j +class FileSaver { + + File targetDirectory + TestFramework framework + + FileSaver(File targetDirectory, TestFramework framework) { + this.targetDirectory = targetDirectory + this.framework = framework + } + + void saveClassFile(String fileName, String basePackageClass, String includedDirectoryRelativePath, byte[] classBytes) { + + Path testBaseDir = Paths.get(targetDirectory.absolutePath, packageToDirectory(basePackageClass), + beforeLast(includedDirectoryRelativePath, File.separator)) + Files.createDirectories(testBaseDir) + Path classPath = Paths.get(testBaseDir.toString(), capitalize(fileName) + framework.classExtension).toAbsolutePath() + log.info("Creating new class file [$classPath]") + Files.write(classPath, classBytes, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/TestGenerator.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/TestGenerator.groovy new file mode 100755 index 0000000000..5457f654a7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/TestGenerator.groovy @@ -0,0 +1,105 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier + +import com.google.common.collect.ListMultimap +import groovy.transform.PackageScope +import org.apache.commons.lang3.StringUtils +import org.springframework.cloud.contract.spec.ContractVerifierException +import org.springframework.cloud.contract.verifier.builder.SingleTestGenerator +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.file.ContractFileScanner +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +import java.nio.charset.StandardCharsets +import java.nio.file.Path +import java.util.concurrent.atomic.AtomicInteger + +import static org.springframework.cloud.contract.verifier.util.NamesUtil.* + +/** + * @author Jakub Kubrynski, codearte.io + */ +class TestGenerator { + + private final ContractVerifierConfigProperties configProperties + private final String DEFAULT_CLASS_PREFIX = "ContractVerifier" + + private AtomicInteger counter = new AtomicInteger() + private SingleTestGenerator generator + private FileSaver saver + private ContractFileScanner contractFileScanner + + TestGenerator(ContractVerifierConfigProperties configProperties) { + this(configProperties, new SingleTestGenerator(configProperties), + new FileSaver(configProperties.generatedTestSourcesDir, configProperties.targetFramework)) + } + + TestGenerator(ContractVerifierConfigProperties configProperties, SingleTestGenerator generator, FileSaver saver) { + this.configProperties = configProperties + if (configProperties.contractsDslDir == null) { + throw new ContractVerifierException("Stubs directory not found under " + configProperties.contractsDslDir) + } + this.generator = generator + this.saver = saver + contractFileScanner = new ContractFileScanner(configProperties.contractsDslDir, + configProperties.excludedFiles as Set, + configProperties.ignoredFiles as Set) + } + + int generate() { + generateTestClasses(configProperties.basePackageForTests) + return counter.get() + } + + @PackageScope + void generateTestClasses(final String basePackageName) { + ListMultimap contracts = contractFileScanner.findContracts() + contracts.asMap().entrySet().each { + Map.Entry> entry -> processIncludedDirectory(relativizeContractPath(entry), entry.getValue(), basePackageName) + } + } + + private String relativizeContractPath(Map.Entry> entry) { + Path relativePath = configProperties.contractsDslDir.toPath().relativize(entry.getKey()) + if (StringUtils.isBlank(relativePath.toString())) { + return DEFAULT_CLASS_PREFIX + } + return relativePath.toString() + } + + private void processIncludedDirectory( + final String includedDirectoryRelativePath, Collection contracts, final String basePackageNameForClass) { + if (contracts.size()) { + def className = afterLast(includedDirectoryRelativePath.toString(), File.separator) + resolveNameSuffix() + def packageName = buildPackage(basePackageNameForClass, includedDirectoryRelativePath) + def classBytes = generator.buildClass(contracts, className, packageName).getBytes(StandardCharsets.UTF_8) + saver.saveClassFile(className, basePackageNameForClass, convertIllegalPackageChars(includedDirectoryRelativePath.toString()), classBytes) + counter.incrementAndGet() + } + } + + private String resolveNameSuffix() { + return configProperties.nameSuffixForTests ?: configProperties.targetFramework.classNameSuffix + } + + private static String buildPackage(final String packageNameForClass, final String includedDirectoryRelativePath) { + String directory = beforeLast(includedDirectoryRelativePath, File.separator) + return !directory.empty ? "$packageNameForClass.${directoryToPackage(convertIllegalPackageChars(directory))}" : packageNameForClass + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/BlockBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/BlockBuilder.groovy new file mode 100644 index 0000000000..2f0fb85483 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/BlockBuilder.groovy @@ -0,0 +1,106 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.CompileDynamic +import groovy.transform.CompileStatic +import groovy.transform.PackageScope + +/** + * Builds a block of code. Allows to start, end, indent etc. pieces of code. + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@PackageScope +@CompileStatic +class BlockBuilder { + + private final StringBuilder builder + private final String spacer + private int indents + + /** + * @param spacer - char used for spacing + */ + BlockBuilder(String spacer) { + this.spacer = spacer + builder = new StringBuilder() + } + + BlockBuilder startBlock() { + indents++ + return this + } + + BlockBuilder endBlock() { + indents-- + return this + } + + BlockBuilder indent() { + startBlock().startBlock() + return this + } + + BlockBuilder unindent() { + endBlock().endBlock() + return this + } + + BlockBuilder addLine(String line) { + addIndentation() + builder << "$line\n" + return this + } + + BlockBuilder addEmptyLine() { + builder << '\n' + return this + } + + @CompileDynamic + private void addIndentation() { + indents.times { + builder << spacer + } + } + + BlockBuilder addBlock(MethodBuilder methodBuilder) { + startBlock() + methodBuilder.appendTo(this) + endBlock() + addEmptyLine() + return this + } + + BlockBuilder addAtTheEnd(String toAdd) { + if (builder.charAt(builder.length() - 1) as String == '\n') { + builder.replace(builder.length() - 1, builder.length(), toAdd) + builder << '\n' + } else { + builder << toAdd + } + return this + } + + @Override + String toString() { + return builder.toString() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/ClassBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/ClassBuilder.groovy new file mode 100644 index 0000000000..4552ca7f05 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/ClassBuilder.groovy @@ -0,0 +1,173 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import org.springframework.cloud.contract.verifier.config.TestFramework +import org.springframework.cloud.contract.verifier.util.NamesUtil +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +/** + * Builds a class. Adds all the imports, static imports etc. + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@CompileStatic +@PackageScope +class ClassBuilder { + + private final String className + private final String packageName + private final String baseClass + private final List imports = [] + private final List staticImports = [] + private final List rules = [] + private final List fields = [] + private final List methods = [] + private final List classLevelAnnotations = [] + private final TestFramework lang + + private ClassBuilder(String className, String packageName, String baseClass, TestFramework lang) { + this.lang = lang + if (baseClass) { + imports << baseClass + } + this.baseClass = NamesUtil.afterLastDot(baseClass) + this.packageName = packageName + this.className = className + } + + /** + * Returns a {@link ClassBuilder} for the given parameters + */ + static ClassBuilder createClass(String className, String classPackage, ContractVerifierConfigProperties properties) { + String baseClassForTests + if (properties.targetFramework == TestFramework.SPOCK && !properties.baseClassForTests) { + baseClassForTests = 'spock.lang.Specification' + } else { + baseClassForTests = properties.baseClassForTests + } + return new ClassBuilder(className, classPackage, baseClassForTests, properties.targetFramework) + } + + ClassBuilder addImport(String importToAdd) { + imports << importToAdd + return this + } + + ClassBuilder addImport(List importsToAdd) { + imports.addAll(importsToAdd) + return this + } + + ClassBuilder addStaticImport(String importToAdd) { + staticImports << importToAdd + return this + } + + ClassBuilder addMethod(MethodBuilder methodBuilder) { + methods << methodBuilder + return this + } + + ClassBuilder addField(String fieldToAdd) { + fields << appendColonIfJUniTest(fieldToAdd) + return this + } + + private String appendColonIfJUniTest(String field) { + if (lang == TestFramework.JUNIT && !field.endsWith(';')) { + return "$field;" + } + return field + } + + ClassBuilder addField(List fieldsToAdd) { + fields.addAll(fieldsToAdd.collect { appendColonIfJUniTest(it) }) + return this + } + + ClassBuilder addRule(String ruleClass) { + imports << ruleClass + rules << NamesUtil.afterLastDot(ruleClass) + return this + } + + String build() { + BlockBuilder clazz = new BlockBuilder("\t") + .addLine("package $packageName$lang.lineSuffix") + .addEmptyLine() + + imports.sort().each { + clazz.addLine("import $it$lang.lineSuffix") + } + if (!imports.empty) { + clazz.addEmptyLine() + } + + staticImports.sort().each { + clazz.addLine("import static $it$lang.lineSuffix") + } + if (!staticImports.empty) { + clazz.addEmptyLine() + } + + classLevelAnnotations.sort().each { + clazz.addLine(it) + } + + def classLine = "${lang.classModifier}class $className" + if (baseClass) { + classLine += " extends $baseClass" + } + clazz.addLine(classLine + ' {') + clazz.addEmptyLine() + + clazz.startBlock() + rules.sort().each { + clazz.addLine("@Rule") + clazz.addLine("public $it ${NamesUtil.camelCase(it)} = new $it()$lang.lineSuffix") + } + clazz.endBlock() + if (!rules.empty) { + clazz.addEmptyLine() + } + + clazz.startBlock() + fields.sort().each { + clazz.addLine(it) + } + if (!fields.empty) { + clazz.addEmptyLine() + } + clazz.endBlock() + + methods.each { + clazz.addBlock(it) + } + + clazz.addLine('}') + clazz.toString() + } + + void addClassLevelAnnotation(String annotation) { + classLevelAnnotations << annotation + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JUnitMessagingMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JUnitMessagingMethodBodyBuilder.groovy new file mode 100644 index 0000000000..25063a8d7f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JUnitMessagingMethodBodyBuilder.groovy @@ -0,0 +1,192 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.json.StringEscapeUtils +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.Input +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +import static org.springframework.cloud.contract.verifier.config.TestFramework.JUNIT + +/** + * Builds a JUnit method for messaging + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Marcin Grzejszczak + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@PackageScope +@TypeChecked +class JUnitMessagingMethodBodyBuilder extends MessagingMethodBodyBuilder { + + JUnitMessagingMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected String getInputString(Input request) { + if (request.triggeredBy) { + return request.triggeredBy.executionCommand + } + return "contractVerifierMessaging.send(inputMessage, \"${request.messageFrom.serverValue}\")" + } + + @Override + protected String getResponseBodyPropertyComparisonString(String property, String value) { + return "responseBody$property == \"${value}\"" + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("parsedJson.read('\\\$$property')")}") + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, Map.Entry entry) { + processBodyElement(blockBuilder, property + "." + entry.key, entry.value) + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, String value) { + blockBuilder.addLine("assertThat(response.getHeader(\"$property\")).${createHeaderComparison(value)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern pattern) { + blockBuilder.addLine("assertThat(response.getHeader(\"$property\")).${createHeaderComparison(pattern)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("response.getHeader(\"$property\")")};") + } + + @Override + protected void validateResponseCodeBlock(BlockBuilder bb) { + + } + + @Override + protected void validateResponseHeadersBlock(BlockBuilder bb) { + bb.addLine("""ContractVerifierMessage response = contractVerifierMessaging.receiveMessage("${outputMessage.sentTo.serverValue}");""") + bb.addLine("""assertThat(response).isNotNull();""") + outputMessage.headers?.executeForEachHeader { Header header ->\ + processHeaderElement(bb, header.name, header.serverValue) + } + } + + @Override + protected String getResponseAsString() { + return 'contractVerifierObjectMapper.writeValueAsString(response.getPayload())' + } + + @Override + protected String addCommentSignIfRequired(String baseString) { + return "// $baseString" + } + + @Override + protected BlockBuilder addColonIfRequired(BlockBuilder blockBuilder) { + blockBuilder.addAtTheEnd(JUNIT.lineSuffix) + return blockBuilder + } + + @Override + protected String getPropertyInListString(String property, Integer listIndex) { + return "$property[$listIndex]" ?: '' + } + + @Override + protected String convertUnicodeEscapesIfRequired(String json) { + return StringEscapeUtils.unescapeJavaScript(json) + } + + @Override + protected String getParsedXmlResponseBodyString(String responseString) { + return "Object responseBody = new XmlSlurper().parseText($responseString);" + } + + @Override + protected String getSimpleResponseBodyString(String responseString) { + return "Object responseBody = ($responseString);" + } + + @Override + protected String getInputString() { + String request = 'ContractVerifierMessage inputMessage = contractVerifierMessaging.create(' + if (inputMessage.messageBody) { + request = "${request}\n \"${StringEscapeUtils.escapeJava(bodyAsString)}\"\n " + } + if (inputMessage.messageHeaders) { + request = "${request}, headers()\n" + } + inputMessage.messageHeaders?.executeForEachHeader { Header header -> + request = "${request} ${getHeaderString(header)}" + } + return "${request})" + } + + @Override + protected String getHeaderString(Header header) { + return ".header(\"${getTestSideValue(header.name)}\", \"${getTestSideValue(header.serverValue)}\")" + } + + @Override + protected String getBodyString(String bodyAsString) { + return '' + } + + @Override + protected String getMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) { + return "" + } + + @Override + protected String getParameterString(Map.Entry parameter) { + return "" + } + + protected String convertHeaderComparison(String headerValue) { + return " == '$headerValue'" + } + + protected String convertHeaderComparison(Pattern headerValue) { + return "==~ java.util.regex.Pattern.compile('$headerValue')" + } + + protected String createHeaderComparison(Object headerValue) { + String escapedHeader = convertUnicodeEscapesIfRequired("$headerValue") + return "isEqualTo(\"$escapedHeader\");" + } + + protected String createHeaderComparison(Pattern headerValue) { + String escapedHeader = convertUnicodeEscapesIfRequired("$headerValue") + return "matches(\"$escapedHeader\");" + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JUnitMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JUnitMethodBodyBuilder.groovy new file mode 100644 index 0000000000..730ade10c2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JUnitMethodBodyBuilder.groovy @@ -0,0 +1,156 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.json.StringEscapeUtils +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.spec.internal.Request +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +import static groovy.json.StringEscapeUtils.escapeJava +import static org.springframework.cloud.contract.verifier.config.TestFramework.JUNIT +import static org.springframework.cloud.contract.verifier.util.ContentUtils.getJavaMultipartFileParameterContent + +/** + * Root class for JUnit method building + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Jakub Kubrynski, codearte.io + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +abstract class JUnitMethodBodyBuilder extends RequestProcessingMethodBodyBuilder { + + JUnitMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected String getResponseAsString() { + return "response.getBody().asString()" + } + + @Override + protected String addCommentSignIfRequired(String baseString) { + return "// $baseString" + } + + @Override + protected BlockBuilder addColonIfRequired(BlockBuilder blockBuilder) { + blockBuilder.addAtTheEnd(JUNIT.lineSuffix) + return blockBuilder + } + + @Override + protected String getResponseBodyPropertyComparisonString(String property, String value) { + return "assertThat(responseBody${property}).isEqualTo(\"${value}\")" + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("parsedJson.read(\"\\\$$property\")")};") + } + + @Override + protected String getPropertyInListString(String property, Integer listIndex) { + return "${property}.get($listIndex)" ?: '' + } + + @Override + protected String convertUnicodeEscapesIfRequired(String json) { + String unescapedJson = StringEscapeUtils.unescapeJavaScript(json) + return escapeJava(unescapedJson) + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, Map.Entry entry) { + processBodyElement(blockBuilder, property + getMapKeyReferenceString(entry), entry.value) + } + + private String getMapKeyReferenceString(Map.Entry entry) { + if (entry.value instanceof ExecutionProperty) { + return "." + entry.key + } + return """.get(\\\"$entry.key\\\")""" + } + + @Override + protected String getParsedXmlResponseBodyString(String responseString) { + return "Object responseBody = new XmlSlurper().parseText($responseString);" + } + + @Override + protected String getSimpleResponseBodyString(String responseString) { + return "Object responseBody = ($responseString);" + } + + @Override + protected String getInputString(Request request) { + def inputString = 'ResponseOptions response = given().spec(request)' + if (response.async){ + inputString = inputString + '.when().async()' + } + return inputString + } + + @Override + protected String getInputString() { + return 'MockMvcRequestSpecification request = given()' + } + + @Override + protected String getHeaderString(Header header) { + return ".header(\"${getTestSideValue(header.name)}\", \"${getTestSideValue(header.serverValue)}\")" + } + + @Override + protected String getBodyString(String bodyAsString) { + return ".body(\"$bodyAsString\")" + } + + @Override + protected String getMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) { + return getJavaMultipartFileParameterContent(propertyName, propertyValue) + } + + @Override + protected String getParameterString(Map.Entry parameter) { + return """.param("${escapeJava(parameter.key)}", "${escapeJava(parameter.value as String)}")""" + } + + protected String createHeaderComparison(Object headerValue) { + String escapedHeader = convertUnicodeEscapesIfRequired("$headerValue") + return "isEqualTo(\"$escapedHeader\");" + } + + protected String createHeaderComparison(Pattern headerValue) { + String escapedHeader = convertUnicodeEscapesIfRequired("$headerValue") + return "matches(\"$escapedHeader\");" + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientJUnitMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientJUnitMethodBodyBuilder.groovy new file mode 100644 index 0000000000..61916f3197 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientJUnitMethodBodyBuilder.groovy @@ -0,0 +1,155 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.QueryParameter +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.spec.internal.QueryParameters +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +import static org.springframework.cloud.contract.verifier.config.TestFramework.JUNIT + +/** + * JaxRs implementation of the {@link JUnitMethodBodyBuilder}. Knows how to build + * a test method for JaxRs. + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +class JaxRsClientJUnitMethodBodyBuilder extends JUnitMethodBodyBuilder { + + JaxRsClientJUnitMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected void given(BlockBuilder bb) {} + + @Override + protected void givenBlock(BlockBuilder bb) { + } + + @Override + protected void when(BlockBuilder bb) { + bb.addLine("Response response = webTarget") + bb.indent() + + appendUrlPathAndQueryParameters(bb) + appendRequestWithRequiredResponseContentType(bb) + appendHeaders(bb) + appendMethodAndBody(bb) + bb.addAtTheEnd(JUNIT.lineSuffix) + + bb.unindent() + + bb.addEmptyLine() + bb.addLine("String responseAsString = response.readEntity(String.class);") + } + + protected void appendUrlPathAndQueryParameters(BlockBuilder bb) { + if (request.url) { + bb.addLine(".path(\"$request.url.serverValue\")") + appendQueryParams(request.url.queryParameters, bb) + } else if (request.urlPath) { + bb.addLine(".path(\"$request.urlPath.serverValue\")") + appendQueryParams(request.urlPath.queryParameters, bb) + } + } + + private void appendQueryParams(QueryParameters queryParameters, BlockBuilder bb) { + if (!queryParameters?.parameters) { + return + } + queryParameters.parameters.findAll(this.&allowedQueryParameter).each { QueryParameter param -> + bb.addLine(".queryParam(\"$param.name\", \"${resolveParamValue(param).toString()}\")") + } + } + + protected void appendMethodAndBody(BlockBuilder bb) { + String method = request.method.serverValue.toString().toLowerCase() + if (request.body) { + String contentType = getHeader('Content-Type') ?: getRequestContentType().mimeType + bb.addLine(".method(\"${method.toUpperCase()}\", entity(\"$bodyAsString\", \"$contentType\"))") + } else { + bb.addLine(".method(\"${method.toUpperCase()}\")") + } + } + + protected appendHeaders(BlockBuilder bb) { + request.headers?.executeForEachHeader { Header header -> + if (header.name == 'Content-Type' || header.name == 'Accept') return + bb.addLine(".header(\"${header.name}\", \"${header.serverValue}\")") + } + } + + protected void appendRequestWithRequiredResponseContentType(BlockBuilder bb) { + String acceptHeader = getHeader("Accept") + if (acceptHeader) { + bb.addLine(".request(\"$acceptHeader\")") + } else { + bb.addLine(".request()") + } + } + + @Override + protected void validateResponseCodeBlock(BlockBuilder bb) { + bb.addLine("assertThat(response.getStatus()).isEqualTo($response.status.serverValue);") + } + + @Override + protected void validateResponseHeadersBlock(BlockBuilder bb) { + response.headers?.executeForEachHeader { Header header -> + processHeaderElement(bb, header.name, header.serverValue) + } + } + + protected String getHeader(String name) { + return request.headers?.entries.find { it.name == name }?.serverValue + } + + @Override + protected String getResponseAsString() { + return 'responseAsString' + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, String value) { + blockBuilder.addLine("assertThat(response.getHeaderString(\"$property\")).${createHeaderComparison(value)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern pattern) { + blockBuilder.addLine("assertThat(response.getHeaderString(\"$property\")).${createHeaderComparison(pattern)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("response.getHeaderString(\"$property\")")};") + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientSpockMethodRequestProcessingBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientSpockMethodRequestProcessingBodyBuilder.groovy new file mode 100644 index 0000000000..97283c9596 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientSpockMethodRequestProcessingBodyBuilder.groovy @@ -0,0 +1,151 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.QueryParameter +import org.springframework.cloud.contract.spec.internal.QueryParameters +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +/** + * Knows how to build a Spock test method for JaxRs. + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@PackageScope +@TypeChecked +class JaxRsClientSpockMethodRequestProcessingBodyBuilder extends SpockMethodRequestProcessingBodyBuilder { + + JaxRsClientSpockMethodRequestProcessingBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected void given(BlockBuilder bb) {} + + @Override + protected void givenBlock(BlockBuilder bb) { + } + + @Override + protected void when(BlockBuilder bb) { + bb.addLine("def response = webTarget") + bb.indent() + + appendUrlPathAndQueryParameters(bb) + appendRequestWithRequiredResponseContentType(bb) + appendHeaders(bb) + appendMethodAndBody(bb) + + bb.unindent() + + bb.addEmptyLine() + bb.addLine("String responseAsString = response.readEntity(String)") + } + + protected void appendRequestWithRequiredResponseContentType(BlockBuilder bb) { + String acceptHeader = getHeader("Accept") + if (acceptHeader) { + bb.addLine(".request('$acceptHeader')") + } else { + bb.addLine(".request()") + } + } + + protected void appendUrlPathAndQueryParameters(BlockBuilder bb) { + if (request.url) { + bb.addLine(".path('$request.url.serverValue')") + appendQueryParams(request.url.queryParameters, bb) + } else if (request.urlPath) { + bb.addLine(".path('$request.urlPath.serverValue')") + appendQueryParams(request.urlPath.queryParameters, bb) + } + } + + private void appendQueryParams(QueryParameters queryParameters, BlockBuilder bb) { + if (!queryParameters?.parameters) { + return + } + queryParameters.parameters.findAll(this.&allowedQueryParameter).each { QueryParameter param -> + bb.addLine(".queryParam('$param.name', '${resolveParamValue(param).toString()}')") + } + } + + protected void appendMethodAndBody(BlockBuilder bb) { + String method = request.method.serverValue.toString().toLowerCase() + if (request.body) { + String contentType = getHeader('Content-Type') ?: getRequestContentType().mimeType + bb.addLine(".method('${method.toUpperCase()}', entity('$bodyAsString', '$contentType'))") + } else { + bb.addLine(".method('${method.toUpperCase()}')") + } + } + + protected appendHeaders(BlockBuilder bb) { + request.headers?.executeForEachHeader { Header header -> + if (header.name == 'Content-Type' || header.name == 'Accept') return // Particular headers are set via 'request' / 'entity' methods + bb.addLine(".header('${header.name}', '${header.serverValue}')") + } + } + + protected String getHeader(String name) { + return request.headers?.entries.find { it.name == name }?.serverValue + } + + @Override + protected void validateResponseCodeBlock(BlockBuilder bb) { + bb.addLine("response.status == $response.status.serverValue") + } + + @Override + protected void validateResponseHeadersBlock(BlockBuilder bb) { + response.headers?.executeForEachHeader { Header header -> + processHeaderElement(bb, header.name, header.serverValue) + } + } + + @Override + protected String getResponseAsString() { + return 'responseAsString' + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("response.getHeaderString(\'$property\')")}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, String value) { + blockBuilder.addLine("response.getHeaderString('$property') ${convertHeaderComparison(value)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern value) { + blockBuilder.addLine("response.getHeaderString('$property') ${convertHeaderComparison(value)}") + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilder.groovy new file mode 100644 index 0000000000..88366ce7b8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilder.groovy @@ -0,0 +1,109 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.json.JsonOutput +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Input +import org.springframework.cloud.contract.spec.internal.OutputMessage +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.util.ContentType + +import static org.springframework.cloud.contract.verifier.util.ContentUtils.recognizeContentTypeFromContent +import static org.springframework.cloud.contract.verifier.util.ContentUtils.recognizeContentTypeFromHeader + +/** + * Root class for messaging method building. + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +abstract class MessagingMethodBodyBuilder extends MethodBodyBuilder { + + protected final Input inputMessage + protected final OutputMessage outputMessage + + MessagingMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(configProperties) + this.inputMessage = stubDefinition.input + this.outputMessage = stubDefinition.outputMessage + } + + protected abstract String getInputString(Input request) + + @Override + protected boolean hasGivenSection() { + return !inputMessage.triggeredBy + } + + protected void processInput(BlockBuilder bb) { + + } + + protected void when(BlockBuilder bb) { + bb.addLine(getInputString(inputMessage)) + bb.indent() + + addColonIfRequired(bb) + bb.unindent() + } + + protected void then(BlockBuilder bb) { + validateResponseCodeBlock(bb) + if (inputMessage.assertThat) { + bb.addLine(inputMessage.assertThat.executionCommand) + addColonIfRequired(bb) + } + if (outputMessage) { + validateResponseHeadersBlock(bb) + if (outputMessage.body) { + bb.endBlock() + if (outputMessage.headers) { + bb.addLine(addCommentSignIfRequired('and:')).startBlock() + } + validateResponseBodyBlock(bb, outputMessage.body.serverValue) + } + if (outputMessage.assertThat) { + bb.addLine(outputMessage.assertThat.executionCommand) + addColonIfRequired(bb) + } + } + } + + protected ContentType getResponseContentType() { + ContentType contentType = recognizeContentTypeFromHeader(outputMessage.headers) + if (contentType == ContentType.UNKNOWN) { + contentType = recognizeContentTypeFromContent(outputMessage.body.serverValue) + } + return contentType + } + + protected String getBodyAsString() { + Object bodyValue = extractServerValueFromBody(inputMessage.messageBody.serverValue) + String json = new JsonOutput().toJson(bodyValue) + json = convertUnicodeEscapesIfRequired(json) + return trimRepeatedQuotes(json) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilder.groovy new file mode 100644 index 0000000000..a0b2730efc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MethodBodyBuilder.groovy @@ -0,0 +1,383 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.internal.* +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.util.ContentType +import org.springframework.cloud.contract.verifier.util.JsonPaths +import org.springframework.cloud.contract.verifier.util.JsonToJsonPathsConverter +import org.springframework.cloud.contract.verifier.util.MapConverter + +import java.util.regex.Pattern + +import static org.springframework.cloud.contract.verifier.util.ContentUtils.extractValue + +/** + * Main class for building method body. + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +abstract class MethodBodyBuilder { + + protected final ContractVerifierConfigProperties configProperties + + protected MethodBodyBuilder(ContractVerifierConfigProperties configProperties) { + this.configProperties = configProperties + } + + /** + * Builds the response body validation code block + */ + protected abstract void validateResponseCodeBlock(BlockBuilder bb) + + /** + * Builds the response headers validation code block + */ + protected abstract void validateResponseHeadersBlock(BlockBuilder bb) + + /** + * Builds the code that returns response in the string format + */ + protected abstract String getResponseAsString() + + /** + * Returns the given string with comment sign if required by the given implementation + */ + protected abstract String addCommentSignIfRequired(String baseString) + + /** + * Adds a colon sign at the end of each line if necessary + */ + protected abstract BlockBuilder addColonIfRequired(BlockBuilder blockBuilder) + + /** + * Builds the code that for the given {@code property} will compare it to + * the given {@code value} + */ + protected abstract String getResponseBodyPropertyComparisonString(String property, String value) + + /** + * Appends to the {@link BlockBuilder} the assertion for the given body element + */ + protected abstract void processBodyElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) + + /** + * Appends to the {@link BlockBuilder} the assertion for the given body element + */ + protected abstract void processBodyElement(BlockBuilder blockBuilder, String property, Map.Entry entry) + + /** + * Appends to the {@link BlockBuilder} the assertion for the given header element + */ + protected abstract void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern pattern) + + /** + * Appends to the {@link BlockBuilder} the assertion for the given header element + */ + protected abstract void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) + + /** + * Appends to the {@link BlockBuilder} the assertion for the given header element + */ + protected abstract void processHeaderElement(BlockBuilder blockBuilder, String property, String value) + + /** + * Appends to the {@link BlockBuilder} the code to retrieve a value for a property + * from the list with the given index + */ + protected abstract String getPropertyInListString(String property, Integer index) + + protected abstract String convertUnicodeEscapesIfRequired(String json) + + /** + * NOTE: XML support is experimental + */ + protected abstract String getParsedXmlResponseBodyString(String responseString) + + /** + * Builds the code that returns String from a body that is plain text + */ + protected abstract String getSimpleResponseBodyString(String responseString) + + /** + * Builds the code that returns the "message". For messaging it will be an input + * message. For REST it will be an input request. + */ + protected abstract String getInputString() + + /** + * Builds the code to append a header to the request / message + */ + protected abstract String getHeaderString(Header header) + + /** + * Builds the code to append body to the request / message + */ + protected abstract String getBodyString(String bodyAsString) + + /** + * Builds the code to append multipart content to the request. + * Not applicable for messaging. + */ + protected abstract String getMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) + + /** + * Builds the code to append a form parameter to the request. + * Not applicable for messaging. + */ + protected abstract String getParameterString(Map.Entry parameter) + + /** + * Appends the code to {@link BlockBuilder} for initial request processing + */ + protected abstract void processInput(BlockBuilder bb) + + /** + * Appends the code to {@link BlockBuilder} for the {@code //when} block + */ + protected abstract void when(BlockBuilder bb) + + /** + * Appends the code to {@link BlockBuilder} for the {@code //then} block + */ + protected abstract void then(BlockBuilder bb) + + /** + * Returns a {@link org.springframework.cloud.contract.verifier.util.ContentType} for the given request + */ + protected abstract ContentType getResponseContentType() + + /** + * Converts the body into String format + */ + protected abstract String getBodyAsString() + + /** + * Returns {@code true} if given section should be created + */ + protected abstract boolean hasGivenSection() + + /** + * Builds the test contents and appends them to {@link BlockBuilder} + */ + void appendTo(BlockBuilder blockBuilder) { + blockBuilder.startBlock() + + if (hasGivenSection()) { + givenBlock(blockBuilder) + } + whenBlock(blockBuilder) + thenBlock(blockBuilder) + + blockBuilder.endBlock() + } + + /** + * Prepares the {@code given} block section together with comments and indents + */ + protected void givenBlock(BlockBuilder bb) { + bb.addLine(addCommentSignIfRequired('given:')) + bb.startBlock() + given(bb) + bb.endBlock().addEmptyLine() + } + + /** + * Prepares the {@code when} block section together with comments and indents + */ + protected void whenBlock(BlockBuilder bb) { + bb.addLine(addCommentSignIfRequired('when:')) + bb.startBlock() + when(bb) + bb.endBlock().addEmptyLine() + } + + /** + * Prepares the {@code then} block section together with comments and indents + */ + protected void thenBlock(BlockBuilder bb) { + bb.addLine(addCommentSignIfRequired('then:')) + bb.startBlock() + then(bb) + bb.endBlock() + } + + /** + * Builds the {@code given} block section together with comments and indents + */ + protected void given(BlockBuilder bb) { + bb.addLine(getInputString()) + bb.indent() + processInput(bb) + addColonIfRequired(bb) + bb.unindent() + } + + /** + * Builds the response body verification part. The code will differ depending on the + * ContentType, type of response etc. The result will be appended to {@link BlockBuilder} + */ + protected void validateResponseBodyBlock(BlockBuilder bb, Object responseBody) { + ContentType contentType = getResponseContentType() + if (responseBody instanceof GString) { + responseBody = extractValue(responseBody, contentType, { DslProperty dslProperty -> dslProperty.serverValue }) + } + if (contentType == ContentType.JSON) { + appendJsonPath(bb, getResponseAsString()) + JsonPaths jsonPaths = new JsonToJsonPathsConverter(configProperties).transformToJsonPathWithTestsSideValues(responseBody) + jsonPaths.each { + String method = it.method() + String postProcessedMethod = postProcessJsonPathCall(method) + bb.addLine("assertThatJson(parsedJson)" + postProcessedMethod) + addColonIfRequired(bb) + } + processBodyElement(bb, "", responseBody) + } else if (contentType == ContentType.XML) { + bb.addLine(getParsedXmlResponseBodyString(getResponseAsString())) + addColonIfRequired(bb) + // TODO xml validation + } else { + bb.addLine(getSimpleResponseBodyString(getResponseAsString())) + processText(bb, "", responseBody as String) + addColonIfRequired(bb) + } + } + + /** + * Post processing of each JSON path entry + */ + protected String postProcessJsonPathCall(String jsonPath) { + return jsonPath + } + + /** + * Appends to {@link BlockBuilder} parsing of the JSON Path document + */ + protected void appendJsonPath(BlockBuilder blockBuilder, String json) { + blockBuilder.addLine(("DocumentContext parsedJson = JsonPath.parse($json)")) + addColonIfRequired(blockBuilder) + } + + /** + * Appends to {@link BlockBuilder} processing of the given String value. + */ + protected void processText(BlockBuilder blockBuilder, String property, String value) { + if (value.startsWith('$')) { + value = stripFirstChar(value).replaceAll('\\$value', "responseBody$property") + blockBuilder.addLine(value) + addColonIfRequired(blockBuilder) + } else { + blockBuilder.addLine(getResponseBodyPropertyComparisonString(property, value)) + } + } + + private String stripFirstChar(String s) { + return s.substring(1); + } + + /** + * Appends to the {@link BlockBuilder} the assertion for the given header element + */ + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Object value) { + } + + /** + * Appends to the {@link BlockBuilder} the assertion for the given body element + */ + protected void processBodyElement(BlockBuilder blockBuilder, String property, Object value) { + } + + /** + * Removes unnecessary quotes + */ + protected String trimRepeatedQuotes(String toTrim) { + return toTrim.startsWith('"') ? toTrim.replaceAll('"', '') : toTrim + } + + /** + * Converts the passed body into ints server side representation. All {@link DslProperty} + * will return their server side values + */ + protected Object extractServerValueFromBody(bodyValue) { + if (bodyValue instanceof GString) { + bodyValue = extractValue(bodyValue, { DslProperty dslProperty -> dslProperty.serverValue }) + } else { + bodyValue = MapConverter.transformValues(bodyValue, { it instanceof DslProperty ? it.serverValue : it }) + } + return bodyValue + } + + /** + * Converts the {@link org.springframework.cloud.contract.spec.internal.QueryParameter} server side value into its String + * representation + */ + protected String resolveParamValue(QueryParameter param) { + return resolveParamValue(param.serverValue) + } + + /** + * Converts the query parameter value into String + */ + protected String resolveParamValue(Object value) { + return value.toString() + } + + /** + * Converts the query parameter value into String + */ + protected String resolveParamValue(MatchingStrategy matchingStrategy) { + return matchingStrategy.serverValue.toString() + } + + /** + * Depending on the object type extracts the test side values and + * combines them into a String representation + */ + protected String getTestSideValue(Object object) { + return MapConverter.getTestSideValues(object).toString() + } + + /** + * Appends to the {@link BlockBuilder} the assertion for the given body element + */ + protected void processBodyElement(BlockBuilder blockBuilder, String property, Map map) { + map.each { + processBodyElement(blockBuilder, property, it) + } + } + + /** + * Appends to the {@link BlockBuilder} the assertion for the given body element + */ + protected void processBodyElement(BlockBuilder blockBuilder, String property, List list) { + list.eachWithIndex { listElement, listIndex -> + String prop = getPropertyInListString(property, listIndex as Integer) + processBodyElement(blockBuilder, prop, listElement) + } + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MethodBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MethodBuilder.groovy new file mode 100644 index 0000000000..0d17899d91 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MethodBuilder.groovy @@ -0,0 +1,96 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.CompileStatic +import groovy.transform.PackageScope +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.config.TestFramework +import org.springframework.cloud.contract.verifier.util.NamesUtil +import org.springframework.cloud.contract.verifier.config.TestMode +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +/** + * Builds a test method. Adds an ignore annotation on a method if necessary. + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@Slf4j +@CompileStatic +@PackageScope +class MethodBuilder { + + private final String methodName + private final Contract stubContent + private final ContractVerifierConfigProperties configProperties + private final boolean ignored + + private MethodBuilder(String methodName, Contract stubContent, ContractVerifierConfigProperties configProperties, boolean ignored) { + this.ignored = ignored + this.stubContent = stubContent + this.methodName = methodName + this.configProperties = configProperties + } + + /** + * A factory method that creates a {@link MethodBuilder} for the given arguments + */ + static MethodBuilder createTestMethod(ContractMetadata contract, File stubsFile, Contract stubContent, ContractVerifierConfigProperties configProperties) { + log.debug("Stub content Groovy DSL [$stubContent]") + String methodName = NamesUtil.camelCase(NamesUtil.toLastDot(NamesUtil.afterLast(stubsFile.path, File.separator))) + return new MethodBuilder(methodName, stubContent, configProperties, contract.ignored) + } + + /** + * Appends to the {@link BlockBuilder} the contents of the test + */ + void appendTo(BlockBuilder blockBuilder) { + if (configProperties.targetFramework == TestFramework.JUNIT) { + blockBuilder.addLine('@Test') + } + if (ignored) { + blockBuilder.addLine('@Ignore') + } + blockBuilder.addLine(configProperties.targetFramework.methodModifier + "validate_$methodName() throws Exception {") + getMethodBodyBuilder().appendTo(blockBuilder) + blockBuilder.addLine('}') + } + + private MethodBodyBuilder getMethodBodyBuilder() { + if (stubContent.input || stubContent.outputMessage) { + if (configProperties.targetFramework == TestFramework.JUNIT){ + return new JUnitMessagingMethodBodyBuilder(stubContent, configProperties) + } + return new SpockMessagingMethodBodyBuilder(stubContent, configProperties) + } + if (configProperties.testMode == TestMode.MOCKMVC && configProperties.targetFramework == TestFramework.JUNIT){ + return new MockMvcJUnitMethodBodyBuilder(stubContent, configProperties) + } + if (configProperties.testMode == TestMode.JAXRSCLIENT) { + if (configProperties.targetFramework == TestFramework.JUNIT){ + return new JaxRsClientJUnitMethodBodyBuilder(stubContent, configProperties) + } + return new JaxRsClientSpockMethodRequestProcessingBodyBuilder(stubContent, configProperties) + } + return new MockMvcSpockMethodRequestProcessingBodyBuilder(stubContent, configProperties) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcJUnitMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcJUnitMethodBodyBuilder.groovy new file mode 100644 index 0000000000..d4556732aa --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcJUnitMethodBodyBuilder.groovy @@ -0,0 +1,70 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +/** + * A {@link JUnitMethodBodyBuilder} implementation that uses MockMvc to send requests. + * + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +class MockMvcJUnitMethodBodyBuilder extends JUnitMethodBodyBuilder { + + MockMvcJUnitMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected void validateResponseCodeBlock(BlockBuilder bb) { + bb.addLine("assertThat(response.statusCode()).isEqualTo($response.status.serverValue);") + } + + @Override + protected void validateResponseHeadersBlock(BlockBuilder bb) { + response.headers?.executeForEachHeader { Header header ->\ + processHeaderElement(bb, header.name, header.serverValue) + } + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, String value) { + blockBuilder.addLine("assertThat(response.header(\"$property\")).${createHeaderComparison(value)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern pattern) { + blockBuilder.addLine("assertThat(response.header(\"$property\")).${createHeaderComparison(pattern)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("response.header(\"$property\")")};") + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcSpockMethodRequestProcessingBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcSpockMethodRequestProcessingBodyBuilder.groovy new file mode 100644 index 0000000000..a1655e52ce --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcSpockMethodRequestProcessingBodyBuilder.groovy @@ -0,0 +1,78 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +/** + * A {@link SpockMethodRequestProcessingBodyBuilder} implementation that uses MockMvc to send requests. + * + * @since 1.0.0 + */ +@PackageScope +@TypeChecked +class MockMvcSpockMethodRequestProcessingBodyBuilder extends SpockMethodRequestProcessingBodyBuilder { + + MockMvcSpockMethodRequestProcessingBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected void validateResponseCodeBlock(BlockBuilder bb) { + bb.addLine("response.statusCode == $response.status.serverValue") + } + + @Override + protected void validateResponseHeadersBlock(BlockBuilder bb) { + response.headers?.executeForEachHeader { Header header -> + processHeaderElement(bb, header.name, header.serverValue) + } + } + + @Override + protected String getResponseAsString() { + return 'response.body.asString()' + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("response.header(\'$property\')")}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, String value) { + blockBuilder.addLine("response.header('$property') ${convertHeaderComparison(value)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern value) { + blockBuilder.addLine("response.header('$property') ${convertHeaderComparison(value)}") + } + + // #273 - should escape $ for Groovy since it will try to make it a GString + @Override + protected String postProcessJsonPathCall(String jsonPath) { + return jsonPath.replace('$', '\\$') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/RequestProcessingMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/RequestProcessingMethodBodyBuilder.groovy new file mode 100644 index 0000000000..f1251acd6f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/RequestProcessingMethodBodyBuilder.groovy @@ -0,0 +1,209 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.json.JsonOutput +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import groovy.transform.TypeCheckingMode +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Request +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.MatchingStrategy +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.spec.internal.QueryParameter +import org.springframework.cloud.contract.spec.internal.Response +import org.springframework.cloud.contract.spec.internal.Url +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.util.ContentType +import org.springframework.cloud.contract.verifier.util.MapConverter + +import static org.springframework.cloud.contract.verifier.util.ContentUtils.recognizeContentTypeFromContent +import static org.springframework.cloud.contract.verifier.util.ContentUtils.recognizeContentTypeFromHeader + +/** + * An abstraction for creating a test method that includes processing of an HTTP request + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @author Olga Maciaszek-Sharma, codearte.io + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +abstract class RequestProcessingMethodBodyBuilder extends MethodBodyBuilder { + + protected final Request request + protected final Response response + + RequestProcessingMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(configProperties) + this.request = stubDefinition.request + this.response = stubDefinition.response + } + + /** + * Returns code used to retrieve a response for the given {@link Request} + */ + protected abstract String getInputString(Request request) + + @Override + protected boolean hasGivenSection() { + return true + } + + /** + * Returns {@code true} if the query parameter is allowed + */ + protected boolean allowedQueryParameter(QueryParameter param) { + return allowedQueryParameter(param.serverValue) + } + + /** + * Returns {@code true} if the query parameter is allowed + */ + protected boolean allowedQueryParameter(MatchingStrategy matchingStrategy) { + return matchingStrategy.type != MatchingStrategy.Type.ABSENT + } + + /** + * Returns {@code true} if the query parameter is allowed + */ + protected boolean allowedQueryParameter(Object o) { + return true + } + + @Override + protected void processInput(BlockBuilder bb) { + request.headers?.executeForEachHeader { Header header -> + bb.addLine(getHeaderString(header)) + } + if (request.body) { + bb.addLine(getBodyString(bodyAsString)) + } + if (request.multipart) { + multipartParameters?.each { Map.Entry entry -> bb.addLine(getMultipartParameterLine(entry)) } + } + } + + @Override + protected void when(BlockBuilder bb) { + bb.addLine(getInputString(request)) + bb.indent() + + String url = buildUrl(request) + String method = request.method.serverValue.toString().toLowerCase() + + bb.addLine(/.${method}("$url")/) + addColonIfRequired(bb) + bb.unindent() + } + + @Override + protected void then(BlockBuilder bb) { + validateResponseCodeBlock(bb) + if (response.headers) { + validateResponseHeadersBlock(bb) + } + if (response.body) { + bb.endBlock() + bb.addLine(addCommentSignIfRequired('and:')).startBlock() + validateResponseBodyBlock(bb, response.body.serverValue) + } + } + + @Override + protected ContentType getResponseContentType() { + ContentType contentType = recognizeContentTypeFromHeader(response.headers) + if (contentType == ContentType.UNKNOWN) { + contentType = recognizeContentTypeFromContent(response.body.serverValue) + } + return contentType + } + + @Override + protected String getBodyAsString() { + Object bodyValue = extractServerValueFromBody(request.body.serverValue) + String json = new JsonOutput().toJson(bodyValue) + json = convertUnicodeEscapesIfRequired(json) + return trimRepeatedQuotes(json) + } + + /** + * Returns a map of server side multipart parameters + */ + protected Map getMultipartParameters() { + return (Map) request?.multipart?.serverValue + } + + /** + * Maps the {@link Request} into a {@link ContentType} + */ + protected ContentType getRequestContentType() { + ContentType contentType = recognizeContentTypeFromHeader(request.headers) + if (contentType == ContentType.UNKNOWN) { + contentType = recognizeContentTypeFromContent(request.body.serverValue) + } + return contentType + } + + /** + * Builds a String URL from {@link Request}'s test side values. It can be + * a concrete value of the URL or a path. + */ + protected String buildUrl(Request request) { + if (request.url) + return getTestSideValue(buildUrlFromUrlPath(request.url)) + if (request.urlPath) + return getTestSideValue(buildUrlFromUrlPath(request.urlPath)) + throw new IllegalStateException("URL is not set!") + } + + /** + * Depending on the presence of query parameters builds the String value + * of the URL. Retrieves any present test side values + */ + @TypeChecked(TypeCheckingMode.SKIP) + protected String buildUrlFromUrlPath(Url url) { + if (hasQueryParams(url)) { + String params = url.queryParameters.parameters + .findAll(this.&allowedQueryParameter) + .inject([] as List) { List result, QueryParameter param -> + result << "${param.name}=${resolveParamValue(param).toString()}" + } + .join('&') + return "${MapConverter.getTestSideValues(url.serverValue)}?$params" + } + return MapConverter.getTestSideValues(url.serverValue) + } + + /** + * Returns a line of code to send a multi part parameter in the request + */ + protected String getMultipartParameterLine(Map.Entry parameter) { + if (parameter.value instanceof NamedProperty) { + return ".multiPart(${getMultipartFileParameterContent(parameter.key, (NamedProperty) parameter.value)})" + } + return getParameterString(parameter) + } + + + private boolean hasQueryParams(Url url) { + return url.queryParameters + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGenerator.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGenerator.groovy new file mode 100644 index 0000000000..dcfa2d4757 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGenerator.groovy @@ -0,0 +1,176 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.transform.Canonical +import groovy.transform.EqualsAndHashCode +import groovy.transform.PackageScope +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.config.TestFramework +import org.springframework.cloud.contract.verifier.file.ContractMetadata +import org.springframework.cloud.contract.verifier.util.ContractVerifierDslConverter +import org.springframework.cloud.contract.verifier.config.TestMode + +import static ClassBuilder.createClass +import static MethodBuilder.createTestMethod +import static org.springframework.cloud.contract.verifier.util.NamesUtil.capitalize + +/** + * Builds a single test for the given {@link ContractVerifierConfigProperties properties} + * + * @since 1.0.0 + */ +@Slf4j +class SingleTestGenerator { + + private static final String JSON_ASSERT_STATIC_IMPORT = 'com.toomuchcoding.jsonassert.JsonAssertion.assertThatJson' + private static final String JSON_ASSERT_CLASS = 'com.toomuchcoding.jsonassert.JsonAssertion' + + private final ContractVerifierConfigProperties configProperties + + SingleTestGenerator(ContractVerifierConfigProperties configProperties) { + this.configProperties = configProperties + } + + /** + * Returns String code representing a test class with test methods for + * each {@link ContractMetadata} + */ + @PackageScope + String buildClass(Collection listOfFiles, String className, String classPackage) { + ClassBuilder clazz = createClass(capitalize(className), classPackage, configProperties) + + if (configProperties.imports) { + configProperties.imports.each { + clazz.addImport(it) + } + } + + if (listOfFiles.ignored.find { it }) { + clazz.addImport(configProperties.targetFramework.getIgnoreClass()) + } + + if (configProperties.staticImports) { + configProperties.staticImports.each { + clazz.addStaticImport(it) + } + } + + if (isScenarioClass(listOfFiles)) { + clazz.addImport(configProperties.targetFramework.getOrderAnnotationImport()) + clazz.addClassLevelAnnotation(configProperties.targetFramework.getOrderAnnotation()) + } + + addJsonPathRelatedImports(clazz) + + Map contracts = mapContractsToTheirTestTypes(listOfFiles) + + boolean conditionalImportsAdded = false + contracts.each { ParsedDsl key, TestType value -> + if (!conditionalImportsAdded) { + if (contracts.values().contains(TestType.HTTP)) { + if (configProperties.testMode == TestMode.JAXRSCLIENT) { + clazz.addStaticImport('javax.ws.rs.client.Entity.*') + if (configProperties.targetFramework == TestFramework.JUNIT) { + clazz.addImport('javax.ws.rs.core.Response') + } + } else if (configProperties.testMode == TestMode.MOCKMVC) { + clazz.addStaticImport('com.jayway.restassured.module.mockmvc.RestAssuredMockMvc.*') + } else { + clazz.addStaticImport('com.jayway.restassured.RestAssured.*') + } + } + if (configProperties.targetFramework == TestFramework.JUNIT) { + if (contracts.values().contains(TestType.HTTP) && configProperties.testMode == TestMode.MOCKMVC) { + clazz.addImport('com.jayway.restassured.module.mockmvc.specification.MockMvcRequestSpecification') + clazz.addImport('com.jayway.restassured.response.ResponseOptions') + } + clazz.addImport('org.junit.Test') + clazz.addStaticImport('org.assertj.core.api.Assertions.assertThat') + } + if (configProperties.ruleClassForTests) { + clazz.addImport('org.junit.Rule').addRule(configProperties.ruleClassForTests) + } + if (contracts.values().contains(TestType.MESSAGING)) { + addMessagingRelatedEntries(clazz) + } + conditionalImportsAdded = true + } + clazz.addMethod(createTestMethod(key.contract, key.stubsFile, key.groovyDsl, configProperties)) + } + return clazz.build() + } + + private Map mapContractsToTheirTestTypes(Collection listOfFiles) { + return listOfFiles.collectEntries { + File stubsFile = it.path.toFile() + log.debug("Stub content from file [${stubsFile.text}]") + org.springframework.cloud.contract.spec.Contract stubContent = ContractVerifierDslConverter.convert(stubsFile) + TestType testType = (stubContent.input || stubContent.outputMessage) ? TestType.MESSAGING : TestType.HTTP + return [(new ParsedDsl(it, stubContent, stubsFile)): testType] + } + } + + @Canonical + @EqualsAndHashCode + private static class ParsedDsl { + ContractMetadata contract + org.springframework.cloud.contract.spec.Contract groovyDsl + File stubsFile + } + + private static enum TestType { + MESSAGING, HTTP + } + + private boolean isScenarioClass(Collection listOfFiles) { + listOfFiles.find({ it.order != null }) != null + } + + private ClassBuilder addJsonPathRelatedImports(ClassBuilder clazz) { + clazz.addImport(['com.jayway.jsonpath.DocumentContext', + 'com.jayway.jsonpath.JsonPath', + ]) + if (jsonAssertPresent()) { + clazz.addStaticImport(JSON_ASSERT_STATIC_IMPORT) + } + } + + private ClassBuilder addMessagingRelatedEntries(ClassBuilder clazz) { + clazz.addField(['@Inject ContractVerifierMessaging contractVerifierMessaging', + 'ContractVerifierObjectMapper contractVerifierObjectMapper = new ContractVerifierObjectMapper()' + ]) + clazz.addImport([ 'javax.inject.Inject', + 'org.springframework.cloud.contract.verifier.messaging.ContractVerifierObjectMapper', + 'org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage', + 'org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging', + ]) + clazz.addStaticImport('org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessagingUtil.headers') + } + + private static boolean jsonAssertPresent() { + try { + Class.forName(JSON_ASSERT_CLASS) + return true + } catch (ClassNotFoundException e) { + log.debug("JsonAssert is not present on classpath. Will not add a static import.") + return false + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SpockMessagingMethodBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SpockMessagingMethodBodyBuilder.groovy new file mode 100644 index 0000000000..639d28bbd6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SpockMessagingMethodBodyBuilder.groovy @@ -0,0 +1,185 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.json.StringEscapeUtils +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.Input +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern +/** + * @author Jakub Kubrynski, codearte.io + */ +@PackageScope +@TypeChecked +class SpockMessagingMethodBodyBuilder extends MessagingMethodBodyBuilder { + + SpockMessagingMethodBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected String getInputString(Input request) { + if (request.triggeredBy) { + return request.triggeredBy.executionCommand + } + return "contractVerifierMessaging.send(inputMessage, '${request.messageFrom.serverValue}')" + } + + @Override + protected String getResponseBodyPropertyComparisonString(String property, String value) { + return "responseBody$property == \"${value}\"" + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("parsedJson.read('\\\$$property')")}") + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, Map.Entry entry) { + processBodyElement(blockBuilder, property + "." + entry.key, entry.value) + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("response.getHeader(\'$property\')")}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, String value) { + blockBuilder.addLine("response.getHeader('$property') ${convertHeaderComparison(value)}") + } + + @Override + protected void processHeaderElement(BlockBuilder blockBuilder, String property, Pattern value) { + blockBuilder.addLine("response.getHeader('$property') ${convertHeaderComparison(value)}") + } + + @Override + protected void validateResponseCodeBlock(BlockBuilder bb) { + if (outputMessage) { + bb.addLine("""def response = contractVerifierMessaging.receiveMessage('${outputMessage.sentTo.serverValue}')""") + bb.addLine("""assert response != null""") + } else { + bb.addLine('noExceptionThrown()') + } + } + + @Override + protected void validateResponseHeadersBlock(BlockBuilder bb) { + outputMessage.headers?.executeForEachHeader { Header header -> + processHeaderElement(bb, header.name, header.serverValue) + } + } + + @Override + protected String getResponseAsString() { + return 'contractVerifierObjectMapper.writeValueAsString(response.payload)' + } + + @Override + protected String addCommentSignIfRequired(String baseString) { + return baseString + } + + @Override + protected BlockBuilder addColonIfRequired(BlockBuilder blockBuilder) { + return blockBuilder + } + + @Override + protected String getPropertyInListString(String property, Integer listIndex) { + "$property[$listIndex]" ?: '' + } + + @Override + protected String convertUnicodeEscapesIfRequired(String json) { + return StringEscapeUtils.unescapeJavaScript(json) + } + + @Override + protected String getParsedXmlResponseBodyString(String responseString) { + return "def responseBody = new XmlSlurper().parseText($responseString)" + } + + @Override + protected String getSimpleResponseBodyString(String responseString) { + return "def responseBody = ($responseString)" + } + + @Override + protected String getInputString() { + String request = 'def inputMessage = contractVerifierMessaging.create(' + if (inputMessage.messageBody) { + request = "${request}'''${bodyAsString}'''\n " + } + if (inputMessage.messageHeaders) { + request = "${request},[\n" + } + def headers = [] + inputMessage.messageHeaders?.executeForEachHeader { Header header -> + headers << " ${getHeaderString(header)}" + } + request = "${request}${headers.join(',\n')}" + if (inputMessage.messageHeaders) { + request = "${request}\n ]" + } + return "${request})" + } + + @Override + protected String getHeaderString(Header header) { + return "'${getTestSideValue(header.name)}': '${getTestSideValue(header.serverValue)}'" + } + + @Override + protected String getBodyString(String bodyAsString) { + return '' + } + + @Override + protected String getMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) { + return '' + } + + @Override + protected String getParameterString(Map.Entry parameter) { + return '' + } + + protected String convertHeaderComparison(String headerValue) { + return " == '$headerValue'" + } + + protected String convertHeaderComparison(Pattern headerValue) { + return "==~ java.util.regex.Pattern.compile('$headerValue')" + } + + // #273 - should escape $ for Groovy since it will try to make it a GString + @Override + protected String postProcessJsonPathCall(String method) { + return method.replace('$', '\\$') + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SpockMethodRequestProcessingBodyBuilder.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SpockMethodRequestProcessingBodyBuilder.groovy new file mode 100644 index 0000000000..a9d8274509 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/builder/SpockMethodRequestProcessingBodyBuilder.groovy @@ -0,0 +1,135 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import groovy.json.StringEscapeUtils +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Header +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.spec.internal.Request +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +import static org.springframework.cloud.contract.verifier.util.ContentUtils.getGroovyMultipartFileParameterContent + +/** + * A {@link RequestProcessingMethodBodyBuilder} implementation that uses Spock + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@PackageScope +@TypeChecked +abstract class SpockMethodRequestProcessingBodyBuilder extends RequestProcessingMethodBodyBuilder { + + SpockMethodRequestProcessingBodyBuilder(Contract stubDefinition, ContractVerifierConfigProperties configProperties) { + super(stubDefinition, configProperties) + } + + @Override + protected String getResponseBodyPropertyComparisonString(String property, String value) { + return "responseBody$property == \"${value}\"" + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, ExecutionProperty exec) { + blockBuilder.addLine("${exec.insertValue("parsedJson.read('\\\$$property')")}") + } + + @Override + protected void processBodyElement(BlockBuilder blockBuilder, String property, Map.Entry entry) { + processBodyElement(blockBuilder, property + "." + entry.key, entry.value) + } + + @Override + protected String addCommentSignIfRequired(String baseString) { + return baseString + } + + @Override + protected BlockBuilder addColonIfRequired(BlockBuilder blockBuilder) { + return blockBuilder + } + + @Override + protected String getPropertyInListString(String property, Integer listIndex) { + "$property[$listIndex]" ?: '' + } + + @Override + protected String convertUnicodeEscapesIfRequired(String json) { + return StringEscapeUtils.unescapeJavaScript(json) + } + + @Override + protected String getParsedXmlResponseBodyString(String responseString) { + return "def responseBody = new XmlSlurper().parseText($responseString)" + } + + @Override + protected String getSimpleResponseBodyString(String responseString) { + return "def responseBody = ($responseString)" + } + + @Override + protected String getInputString(Request request) { + def inputString = 'def response = given().spec(request)' + if (response.async){ + inputString = inputString + '.when().async()' + } + return inputString + } + + @Override + protected String getInputString() { + return 'def request = given()' + } + + @Override + protected String getHeaderString(Header header) { + return ".header('${getTestSideValue(header.name)}', '${getTestSideValue(header.serverValue)}')" + } + + @Override + protected String getBodyString(String bodyAsString) { + return ".body('''$bodyAsString''')" + } + + @Override + protected String getMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) { + return getGroovyMultipartFileParameterContent(propertyName, propertyValue) + } + + @Override + protected String getParameterString(Map.Entry parameter) { + return ".param('$parameter.key', '$parameter.value')" + } + + protected String convertHeaderComparison(String headerValue) { + return " == '$headerValue'" + } + + protected String convertHeaderComparison(Pattern headerValue) { + return "==~ java.util.regex.Pattern.compile('$headerValue')" + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/ContractVerifierConfigProperties.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/ContractVerifierConfigProperties.groovy new file mode 100644 index 0000000000..366c9c4c96 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/ContractVerifierConfigProperties.groovy @@ -0,0 +1,105 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.config + +/** + * Represents Contract Verifier configuration properties + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +class ContractVerifierConfigProperties { + + /** + * For which unit test library tests should be generated + */ + TestFramework targetFramework = TestFramework.JUNIT + + /** + * Which mechanism should be used to invoke REST calls during tests + */ + TestMode testMode = TestMode.MOCKMVC + + /** + * Base package for generated tests + */ + String basePackageForTests + + /** + * Class which all generated tests should extend + */ + String baseClassForTests + + /** + * Suffix for generated test classes, like Spec or Test + */ + String nameSuffixForTests + + /** + * Rule class that should be added to generated tests + */ + String ruleClassForTests + + /** + * Patterns that should not be taken into account for processing + */ + List excludedFiles = [] + + /** + * Patterns for which generated tests should be @Ignored + */ + List ignoredFiles = [] + + /** + * Imports that should be added to generated tests + */ + String[] imports = [] + + /** + * Static imports that should be added to generated tests + */ + String[] staticImports = [] + + /** + * Directory containing contracts written using the GroovyDSL + */ + File contractsDslDir + + /** + * Test source directory where tests generated from Groovy DSL should be placed + */ + File generatedTestSourcesDir + + /** + * Dir 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 + */ + File stubsOutputDir + + /** + * Suffix for the generated Stubs Jar task + */ + String stubsSuffix = 'stubs' + + /** + * Incubating feature. You can check the size of JSON arrays. If not turned on + * explicitly will be disabled. + */ + Boolean assertJsonSize + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/TestFramework.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/TestFramework.groovy new file mode 100644 index 0000000000..8b5f14e707 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/TestFramework.groovy @@ -0,0 +1,82 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.config + +/** + * Contains main building blocks for a test class for the given framework + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +enum TestFramework { + JUNIT("public ", "public void ", ";", ".java", "Test", "org.junit.Ignore", ["org.junit.FixMethodOrder", "org.junit.runners.MethodSorters"], "@FixMethodOrder(MethodSorters.NAME_ASCENDING)"), + SPOCK("", "def ", "", ".groovy", "Spec", "spock.lang.Ignore", ["spock.lang.Stepwise"], "@Stepwise") + + private final String classModifier + private final String methodModifier + private final String lineSuffix + private final String classExtension; + private final String classNameSuffix; + private final String ignoreClass + private final List orderAnnotationImports + private final String orderAnnotation + + TestFramework(String classModifier, String methodModifier, String lineSuffix, String classExtension, String classNameSuffix, + String ignoreClass, List orderAnnotationImports, String orderAnnotation) { + this.classModifier = classModifier + this.lineSuffix = lineSuffix + this.methodModifier = methodModifier + this.classExtension = classExtension + this.classNameSuffix = classNameSuffix + this.ignoreClass = ignoreClass + this.orderAnnotationImports = orderAnnotationImports + this.orderAnnotation = orderAnnotation + } + + String getClassModifier() { + return classModifier + } + + String getMethodModifier() { + return methodModifier + } + + String getLineSuffix() { + return lineSuffix + } + + String getClassExtension() { + return classExtension + } + + String getClassNameSuffix() { + return classNameSuffix + } + + String getIgnoreClass() { + return ignoreClass + } + + List getOrderAnnotationImport() { + return orderAnnotationImports + } + + String getOrderAnnotation() { + return orderAnnotation + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/TestMode.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/TestMode.groovy new file mode 100644 index 0000000000..a6df25c9e3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/config/TestMode.groovy @@ -0,0 +1,41 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.config + +/** + * Provides different testing modes + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +enum TestMode { + /** + * Uses Spring's MockMvc + */ + MOCKMVC, + + /** + * Uses direct HTTP invocations + */ + EXPLICIT, + + /** + * Uses JAX-RS client + */ + JAXRSCLIENT +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/BaseWireMockStubStrategy.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/BaseWireMockStubStrategy.groovy new file mode 100755 index 0000000000..1226c39bf1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/BaseWireMockStubStrategy.groovy @@ -0,0 +1,126 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.dsl.wiremock + +import groovy.json.JsonBuilder +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.internal.Headers +import org.springframework.cloud.contract.verifier.util.MapConverter +import org.springframework.cloud.contract.spec.internal.DslProperty +import org.springframework.cloud.contract.verifier.util.ContentType +import org.springframework.cloud.contract.verifier.util.ContentUtils + +import static ContentUtils.extractValue +import static MapConverter.transformValues + +/** + * Common abstraction over WireMock Request / Response conversion implementations + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +abstract class BaseWireMockStubStrategy { + + /** + * Returns the stub side values from the object + */ + protected getStubSideValue(Object object) { + return MapConverter.getStubSideValues(object) + } + + private static Closure transform = { + it instanceof DslProperty ? transformValues(it.clientValue, transform) : it + } + + /** + * For the given {@link org.springframework.cloud.contract.verifier.util.ContentType} returns the String version of the body + */ + String parseBody(Object value, ContentType contentType) { + return parseBody(value.toString(), contentType) + } + + /** + * For the given {@link ContentType} returns the Boolean version of the body + */ + Boolean parseBody(Boolean value, ContentType contentType) { + return value + } + + /** + * For the given {@link ContentType} returns the String version of the body + */ + String parseBody(Map map, ContentType contentType) { + def transformedMap = MapConverter.getStubSideValues(map) + return parseBody(toJson(transformedMap), contentType) + } + + /** + * For the given {@link ContentType} returns the String version of the body + */ + String parseBody(List list, ContentType contentType) { + List result = [] + list.each { + if (it instanceof Map) { + result += MapConverter.getStubSideValues(it) + } else { + result += parseBody(it, contentType) + } + } + return parseBody(toJson(result), contentType) + } + + /** + * For the given {@link ContentType} returns the String version of the body + */ + String parseBody(GString value, ContentType contentType) { + Object processedValue = extractValue(value, contentType, { DslProperty dslProperty -> dslProperty.clientValue }) + if (processedValue instanceof GString) { + return parseBody(processedValue.toString(), contentType) + } + return parseBody(processedValue, contentType) + } + + /** + * For the given {@link ContentType} returns the String version of the body + */ + String parseBody(String value, ContentType contentType) { + return value + } + + private static toJson(Object value) { + return new JsonBuilder(value).toString() + } + + /** + * Attempts to guess the {@link ContentType} from body and headers. Returns + * {@link ContentType#UNKNOWN} if it fails to guess. + */ + protected ContentType tryToGetContentType(Object body, Headers headers) { + ContentType contentType = ContentUtils.recognizeContentTypeFromHeader(headers) + if (contentType == ContentType.UNKNOWN) { + if (!body) { + return ContentType.UNKNOWN + } + return ContentUtils.getClientContentType(body) + } + return contentType + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockRequestStubStrategy.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockRequestStubStrategy.groovy new file mode 100755 index 0000000000..68606b280c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockRequestStubStrategy.groovy @@ -0,0 +1,292 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.dsl.wiremock + +import com.github.tomakehurst.wiremock.http.RequestMethod +import com.github.tomakehurst.wiremock.matching.RequestPattern +import com.github.tomakehurst.wiremock.matching.ValuePattern +import groovy.json.JsonOutput +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import groovy.transform.TypeCheckingMode +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Body +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.spec.internal.QueryParameters +import org.springframework.cloud.contract.verifier.util.ContentUtils +import org.springframework.cloud.contract.verifier.util.JsonPaths +import org.springframework.cloud.contract.verifier.util.MapConverter +import org.springframework.cloud.contract.spec.internal.DslProperty +import org.springframework.cloud.contract.spec.internal.OptionalProperty +import org.springframework.cloud.contract.spec.internal.RegexPatterns +import org.springframework.cloud.contract.spec.internal.Request +import org.springframework.cloud.contract.verifier.util.JsonToJsonPathsConverter +import org.springframework.cloud.contract.spec.internal.MatchingStrategy +import org.springframework.cloud.contract.verifier.util.ContentType + +import java.util.regex.Pattern + +import static ContentUtils.getEqualsTypeFromContentType +import static ContentUtils.recognizeContentTypeFromContent +import static ContentUtils.recognizeContentTypeFromHeader +import static ContentUtils.recognizeContentTypeFromMatchingStrategy +import static org.springframework.cloud.contract.verifier.util.RegexpBuilders.buildGStringRegexpForStubSide +import static org.springframework.cloud.contract.verifier.util.RegexpBuilders.buildJSONRegexpMatch + +/** + * Converts a {@link Request} into {@link RequestPattern} + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +class WireMockRequestStubStrategy extends BaseWireMockStubStrategy { + + private final Request request + + WireMockRequestStubStrategy(Contract groovyDsl) { + this.request = groovyDsl.request + } + + @PackageScope + RequestPattern buildClientRequestContent() { + if(!request) { + return null + } + RequestPattern requestPattern = new RequestPattern() + appendMethod(requestPattern) + appendHeaders(requestPattern) + appendUrl(requestPattern) + appendQueryParameters(requestPattern) + appendBody(requestPattern) + appendMultipart(requestPattern) + return requestPattern + } + + private void appendMethod(RequestPattern requestPattern) { + if(!request.method) { + return + } + requestPattern.setMethod(RequestMethod.fromString(request.method.clientValue?.toString())) + } + + private void appendBody(RequestPattern requestPattern) { + if (!request.body) { + return + } + ContentType contentType = tryToGetContentType(request.body.clientValue, request.headers) + if (contentType == ContentType.JSON) { + JsonPaths values = JsonToJsonPathsConverter.transformToJsonPathWithStubsSideValues(getMatchingStrategyFromBody(request.body)?.clientValue) + if (values.empty) { + requestPattern.bodyPatterns = [new ValuePattern(jsonCompareMode: org.skyscreamer.jsonassert.JSONCompareMode.LENIENT, + equalToJson: JsonOutput.toJson(getMatchingStrategy(request.body.clientValue).clientValue) ) ] + } else { + requestPattern.bodyPatterns = values.findAll{ !it.assertsSize() }.collect { new ValuePattern(matchesJsonPath: it.jsonPath().replace("\\\\", "\\")) } ?: null as List + } + } else if (contentType == ContentType.XML) { + requestPattern.bodyPatterns = [new ValuePattern(equalToXml: getMatchingStrategy(request.body.clientValue).clientValue.toString())] + } else if (containsPattern(request?.body)) { + MatchingStrategy matchingStrategy = appendBodyRegexpMatchPattern(request.body) + requestPattern.bodyPatterns = [convertToValuePattern(matchingStrategy)] + } else { + requestPattern.bodyPatterns = [convertToValuePattern(getMatchingStrategy(request.body.clientValue))] + } + } + + private void appendMultipart(RequestPattern requestPattern) { + if (!request.multipart) { + return + } + + if (request.multipart.clientValue instanceof Map) { + List multipartPatterns = (request.multipart.clientValue as Map).collect { + (it.value instanceof NamedProperty + ? ValuePattern.matches(RegexPatterns.multipartFile(it.key, (it.value as NamedProperty).name.clientValue, (it.value as NamedProperty).value.clientValue)) + : ValuePattern.matches(RegexPatterns.multipartParam(it.key, it.value)) ) + } + + requestPattern.bodyPatterns ? requestPattern.bodyPatterns.addAll(multipartPatterns) : (requestPattern.bodyPatterns = multipartPatterns) + } + } + + private void appendHeaders(RequestPattern requestPattern) { + if(!request.headers) { + return + } + request.headers.entries.each { + requestPattern.addHeader(it.name, convertToValuePattern(it.clientValue)) + } + } + + private void appendUrl(RequestPattern requestPattern) { + Object urlPath = request?.urlPath?.clientValue + if (urlPath) { + if(urlPath instanceof Pattern) { + requestPattern.setUrlPathPattern(getStubSideValue(urlPath.toString()).toString()) + } else { + requestPattern.setUrlPath(getStubSideValue(urlPath.toString()).toString()) + } + } + if(!request.url) { + return + } + Object url = getUrlIfGstring(request?.url?.clientValue) + if (url instanceof Pattern) { + requestPattern.setUrlPattern(url.pattern()) + } else { + requestPattern.setUrl(url.toString()) + } + } + + private Object getUrlIfGstring(Object clientSide) { + if (clientSide instanceof GString) { + if (clientSide.values.any { getStubSideValue(it) instanceof Pattern }) { + return Pattern.compile(getStubSideValue(clientSide).toString()) + } else { + return getStubSideValue(clientSide).toString() + } + } + return clientSide + } + + private void appendQueryParameters(RequestPattern requestPattern) { + QueryParameters queryParameters = request?.urlPath?.queryParameters ?: request?.url?.queryParameters + queryParameters?.parameters?.each { + requestPattern.addQueryParam(it.name, convertToValuePattern(it.clientValue)) + } + } + + @TypeChecked(TypeCheckingMode.SKIP) + private static ValuePattern convertToValuePattern(Object object) { + switch (object) { + case Pattern: + Pattern value = object as Pattern + return ValuePattern.matches(value.pattern()) + case OptionalProperty: + OptionalProperty value = object as OptionalProperty + return ValuePattern.matches(value.optionalPattern()) + case MatchingStrategy: + MatchingStrategy value = object as MatchingStrategy + switch (value.type) { + case MatchingStrategy.Type.NOT_MATCHING: + return new ValuePattern(doesNotMatch: value.clientValue) + case MatchingStrategy.Type.ABSENT: + return ValuePattern.absent() + default: + return ValuePattern."${value.type.name}"(value.clientValue) + } + default: + return ValuePattern.equalTo(object.toString()) + } + } + + private MatchingStrategy getMatchingStrategyFromBody(Body body) { + if(!body) { + return null + } + return getMatchingStrategy(body.clientValue) + } + + private MatchingStrategy getMatchingStrategy(MatchingStrategy matchingStrategy) { + return getMatchingStrategyIncludingContentType(matchingStrategy) + } + private MatchingStrategy getMatchingStrategy(GString gString) { + if (!gString) { + return new MatchingStrategy("", MatchingStrategy.Type.EQUAL_TO) + } + def extractedValue = ContentUtils.extractValue(gString) { + it instanceof DslProperty ? it.clientValue : getStringFromGString(it) + } + def value = getStringFromGString(extractedValue) + return getMatchingStrategy(value) + } + + private def getStringFromGString(Object object) { + return object instanceof GString ? object.toString() : object + } + + private MatchingStrategy getMatchingStrategy(Object bodyValue) { + return tryToFindMachingStrategy(bodyValue) + } + + private MatchingStrategy tryToFindMachingStrategy(Object bodyValue) { + return new MatchingStrategy(MapConverter.transformToClientValues(bodyValue), getEqualsTypeFromContentTypeHeader()) + } + + private MatchingStrategy getMatchingStrategyIncludingContentType(MatchingStrategy matchingStrategy) { + MatchingStrategy.Type type = matchingStrategy.type + Object value = matchingStrategy.clientValue + ContentType contentType = recognizeContentTypeFromMatchingStrategy(type) + if (contentType == ContentType.UNKNOWN && type == MatchingStrategy.Type.EQUAL_TO) { + contentType = recognizeContentTypeFromContent(value) + type = getEqualsTypeFromContentType(contentType) + } + return new MatchingStrategy(parseBody(value, contentType), type) + } + + private MatchingStrategy appendBodyRegexpMatchPattern(Object value, ContentType contentType) { + switch (contentType) { + case ContentType.JSON: + return new MatchingStrategy(buildJSONRegexpMatch(value), MatchingStrategy.Type.MATCHING) + case ContentType.UNKNOWN: + return new MatchingStrategy(buildGStringRegexpForStubSide(value), MatchingStrategy.Type.MATCHING) + case ContentType.XML: + throw new IllegalStateException("XML pattern matching is not implemented yet") + } + } + + private MatchingStrategy appendBodyRegexpMatchPattern(Object value) { + return appendBodyRegexpMatchPattern(value, ContentType.UNKNOWN) + } + + private boolean containsPattern(GString bodyAsValue) { + return containsPattern(bodyAsValue.values) + } + + private boolean containsPattern(Map map) { + return containsPattern(map.entrySet()) + } + + private boolean containsPattern(Collection collection) { + return collection.collect(this.&containsPattern).inject('') { a, b -> a || b } + } + + private boolean containsPattern(Object[] objects) { + return containsPattern(objects.toList()) + } + + private boolean containsPattern(Map.Entry entry) { + return containsPattern(entry.value) + } + + private boolean containsPattern(DslProperty dslProperty) { + return containsPattern(dslProperty.clientValue) + } + + private boolean containsPattern(Pattern pattern) { + return true + } + + private boolean containsPattern(Object o) { + return false + } + + private MatchingStrategy.Type getEqualsTypeFromContentTypeHeader() { + return getEqualsTypeFromContentType(recognizeContentTypeFromHeader(request.headers)) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockResponseStubStrategy.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockResponseStubStrategy.groovy new file mode 100755 index 0000000000..e1c6ecf4d2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockResponseStubStrategy.groovy @@ -0,0 +1,88 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.dsl.wiremock + +import com.github.tomakehurst.wiremock.client.ResponseDefinitionBuilder +import com.github.tomakehurst.wiremock.http.HttpHeader +import com.github.tomakehurst.wiremock.http.HttpHeaders +import com.github.tomakehurst.wiremock.http.ResponseDefinition +import groovy.transform.PackageScope +import groovy.transform.TypeChecked +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.spec.internal.Request +import org.springframework.cloud.contract.spec.internal.Response +import org.springframework.cloud.contract.verifier.util.ContentType + +import static org.springframework.cloud.contract.verifier.util.ContentUtils.recognizeContentTypeFromContent +import static org.springframework.cloud.contract.verifier.util.ContentUtils.recognizeContentTypeFromHeader + +/** + * Converts a {@link Request} into {@link ResponseDefinition} + * + * @since 1.0.0 + */ +@TypeChecked +@PackageScope +class WireMockResponseStubStrategy extends BaseWireMockStubStrategy { + + private final Response response + + WireMockResponseStubStrategy(Contract groovyDsl) { + this.response = groovyDsl.response + } + + @PackageScope + ResponseDefinition buildClientResponseContent() { + if(!response) { + return null + } + ResponseDefinitionBuilder builder = new ResponseDefinitionBuilder() + .withStatus(response.status.clientValue as Integer) + appendHeaders(builder) + appendBody(builder) + appendResponseDelayTime(builder) + return builder.build() + } + + private void appendHeaders(ResponseDefinitionBuilder builder) { + if (response.headers) { + builder.withHeaders(new HttpHeaders(response.headers.entries?.collect { + new HttpHeader(it.name, it.clientValue.toString()) + })) + } + } + + private void appendBody(ResponseDefinitionBuilder builder) { + if (response.body) { + Object body = response.body.clientValue + ContentType contentType = recognizeContentTypeFromHeader(response.headers) + if (contentType == ContentType.UNKNOWN) { + contentType = recognizeContentTypeFromContent(body) + } + builder.withBody(parseBody(body, contentType)) + } + } + + private void appendResponseDelayTime(ResponseDefinitionBuilder builder) { + // TODO: Add a missing test for this + if (response.delay) { + builder.withFixedDelay(response.delay.clientValue as Integer) + } + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockStubStrategy.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockStubStrategy.groovy new file mode 100644 index 0000000000..41c1ed1615 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/dsl/wiremock/WireMockStubStrategy.groovy @@ -0,0 +1,80 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.dsl.wiremock + +import com.github.tomakehurst.wiremock.http.ResponseDefinition +import com.github.tomakehurst.wiremock.matching.RequestPattern +import com.github.tomakehurst.wiremock.stubbing.StubMapping +import groovy.transform.CompileDynamic +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +/** + * Converts a {@link ContractMetadata} into a WireMock stub + * + * @since 1.0.0 + */ +@CompileStatic +class WireMockStubStrategy { + + private static final String STEP_START = "Started" + private static final String STEP_PREFIX = "Step" + private final WireMockRequestStubStrategy wireMockRequestStubStrategy + private final WireMockResponseStubStrategy wireMockResponseStubStrategy + private final Integer priority + private final ContractMetadata contract + private final String rootName + + WireMockStubStrategy(String rootName, ContractMetadata contract, org.springframework.cloud.contract.spec.Contract groovyDsl) { + this.rootName = rootName + this.contract = contract + this.wireMockRequestStubStrategy = new WireMockRequestStubStrategy(groovyDsl) + this.wireMockResponseStubStrategy = new WireMockResponseStubStrategy(groovyDsl) + this.priority = groovyDsl.priority + } + + /** + * Converts {@link ContractMetadata} to String version of {@link StubMapping} + */ + @CompileDynamic + String toWireMockClientStub() { + StubMapping stubMapping = new StubMapping() + + RequestPattern request = wireMockRequestStubStrategy.buildClientRequestContent() + ResponseDefinition response = wireMockResponseStubStrategy.buildClientResponseContent() + if (priority) { + stubMapping.priority = priority + } + + stubMapping.request = request + stubMapping.response = response + + if (!request || !response) { + return '' + } + + if (contract.order != null) { + stubMapping.scenarioName = "Scenario_" + rootName + stubMapping.requiredScenarioState = contract.order == 0 ? STEP_START : STEP_PREFIX + contract.order + if (contract.order < contract.groupSize - 1) { + stubMapping.newScenarioState = STEP_PREFIX + (contract.order + 1) + } + } + + return StubMapping.buildJsonStringFor(stubMapping) + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/file/ContractFileScanner.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/file/ContractFileScanner.groovy new file mode 100755 index 0000000000..7b7ad47618 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/file/ContractFileScanner.groovy @@ -0,0 +1,112 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.file + +import com.google.common.collect.ArrayListMultimap +import com.google.common.collect.ListMultimap +import groovy.transform.CompileStatic +import org.apache.commons.io.FilenameUtils +import org.apache.commons.lang3.SystemUtils + +import java.nio.file.FileSystem +import java.nio.file.FileSystems +import java.nio.file.Path +import java.nio.file.PathMatcher +import java.util.regex.Pattern + +/** + * Scans the provided file path for the DSLs. There's a possibility to provide + * inclusion and exclusion filters. + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@CompileStatic +class ContractFileScanner { + + private static final String MATCH_PREFIX = "glob:" + private static final Pattern SCENARIO_STEP_FILENAME_PATTERN = Pattern.compile("[0-9]+_.*") + private final File baseDir + private final Set excludeMatchers + private final Set ignoreMatchers + + ContractFileScanner(File baseDir, Set excluded, Set ignored) { + this.baseDir = baseDir + excludeMatchers = processPatterns(excluded ?: [] as Set) + ignoreMatchers = processPatterns(ignored ?: [] as Set) + } + + private Set processPatterns(Set patterns) { + FileSystem fileSystem = FileSystems.getDefault() + return patterns.collect({ + String syntaxAndPattern = MATCH_PREFIX + '**' + File.separator + it + // FIXME: This looks strange, need to be checked on windows + if (SystemUtils.IS_OS_WINDOWS) { + syntaxAndPattern = syntaxAndPattern.replace("\\", "\\\\") + } + fileSystem.getPathMatcher(syntaxAndPattern) + }) as Set + } + + /** + * Returns for a map of paths for which a list of matching contracts has been found + */ + ListMultimap findContracts() { + ListMultimap result = ArrayListMultimap.create() + appendRecursively(baseDir, result) + return result + } + + private void appendRecursively(File baseDir, ListMultimap result) { + File[] files = baseDir.listFiles() + if (!files) { + return; + } + files.sort().eachWithIndex { File file, int index -> + if (!matchesPattern(file, excludeMatchers)) { + if (isContractFile(file)) { + Path path = file.toPath() + Integer order = null + if (hasScenarioFilenamePattern(path)) { + order = index + } + result.put(file.parentFile.toPath(), new ContractMetadata(path, matchesPattern(file, ignoreMatchers), files.size(), order)) + } else { + appendRecursively(file, result) + } + } + } + } + + private boolean hasScenarioFilenamePattern(Path path) { + return SCENARIO_STEP_FILENAME_PATTERN.matcher(path.fileName.toString()).matches() + } + + private boolean matchesPattern(File file, Set excludeMatchers) { + for (PathMatcher matcher : excludeMatchers) { + if (matcher.matches(file.toPath())) { + return true; + } + } + return false; + } + + private boolean isContractFile(File file) { + return file.isFile() && FilenameUtils.getExtension(file.toString()).equalsIgnoreCase("groovy") + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/file/ContractMetadata.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/file/ContractMetadata.groovy new file mode 100644 index 0000000000..f201949740 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/file/ContractMetadata.groovy @@ -0,0 +1,53 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.file + +import groovy.transform.CompileStatic + +import java.nio.file.Path + +/** + * Contains metadata for a particular file with a DSL + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +@CompileStatic +class ContractMetadata { + final Path path; + final boolean ignored; + final int groupSize + final Integer order; + + ContractMetadata(Path path, boolean ignored, int groupSize, Integer order) { + this.groupSize = groupSize + this.path = path + this.ignored = ignored + this.order = order + } + + @Override + public String toString() { + return "ContractMetadata{" + + "fileName=" + path.fileName + + ", ignored=" + ignored + + ", groupSize=" + groupSize + + ", order=" + order + + '}'; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/BodyExtractor.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/BodyExtractor.groovy new file mode 100644 index 0000000000..9e69876737 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/BodyExtractor.groovy @@ -0,0 +1,84 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import groovy.json.JsonOutput +import groovy.json.StringEscapeUtils +import groovy.transform.CompileStatic +import org.springframework.cloud.contract.spec.internal.DslProperty + +import static ContentUtils.extractValue +/** + * Class that constructs a String from a body. The body can be a GString + * or a map. + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +@CompileStatic +class BodyExtractor { + + private BodyExtractor() {} + + /** + * Returns the string representation of the body for the server side. + * That means that all the interpolations etc. will be resolved for the + * server side. + */ + static String extractTestValueFrom(Object body) { + Object bodyValue = extractServerValueFromBody(body) + String json = new JsonOutput().toJson(bodyValue) + json = StringEscapeUtils.unescapeJavaScript(json) + return trimRepeatedQuotes(json) + } + + /** + * Returns the string representation of the body for the client side. + * That means that all the interpolations etc. will be resolved for the + * client side. + */ + static String extractStubValueFrom(Object body) { + Object bodyValue = extractClientValueFromBody(body); + String json = new JsonOutput().toJson(bodyValue) + json = StringEscapeUtils.unescapeJavaScript(json) + return trimRepeatedQuotes(json) + } + + private static String trimRepeatedQuotes(String toTrim) { + return toTrim.startsWith('"') ? toTrim.replaceAll('"', '') : toTrim + } + + static Object extractServerValueFromBody(bodyValue) { + if (bodyValue instanceof GString) { + bodyValue = extractValue(bodyValue, { DslProperty dslProperty -> dslProperty.serverValue }) + } else { + bodyValue = MapConverter.transformValues(bodyValue, { it instanceof DslProperty ? it.serverValue : it }) + } + return bodyValue + } + + static Object extractClientValueFromBody(bodyValue) { + if (bodyValue instanceof GString) { + return extractValue(bodyValue, { DslProperty dslProperty -> dslProperty.clientValue }) + } else if (bodyValue instanceof DslProperty) { + return extractClientValueFromBody(bodyValue.clientValue) + } else { + return MapConverter.transformValues(bodyValue, { it instanceof DslProperty ? it.clientValue : it }) + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContentType.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContentType.groovy new file mode 100644 index 0000000000..48887c3744 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContentType.groovy @@ -0,0 +1,36 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +/** + * Represents content type + * + * @since 1.0.0 + */ +enum ContentType { + + JSON("application/json"), + XML("application/xml"), + UNKNOWN("application/octet-stream") + + final String mimeType + + ContentType(String mimeType) { + this.mimeType = mimeType + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContentUtils.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContentUtils.groovy new file mode 100644 index 0000000000..366c03f5d8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContentUtils.groovy @@ -0,0 +1,373 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util +import groovy.json.JsonException +import groovy.json.JsonOutput +import groovy.json.JsonSlurper +import groovy.transform.TypeChecked +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.internal.Headers +import org.codehaus.groovy.runtime.GStringImpl +import org.springframework.cloud.contract.spec.internal.NamedProperty +import org.springframework.cloud.contract.spec.internal.DslProperty +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.spec.internal.MatchingStrategy +import org.springframework.cloud.contract.spec.internal.OptionalProperty + +import java.util.regex.Matcher +import java.util.regex.Pattern + +import static org.apache.commons.lang3.StringEscapeUtils.escapeJava +import static org.apache.commons.lang3.StringEscapeUtils.escapeJson +import static org.apache.commons.lang3.StringEscapeUtils.escapeXml11 + +@TypeChecked +@Slf4j +class ContentUtils { + + public static final Closure GET_STUB_SIDE = { + it instanceof DslProperty ? it.clientValue : it + } + + public static final Closure GET_TEST_SIDE = { + it instanceof DslProperty ? it.serverValue : it + } + + private static final Pattern TEMPORARY_PATTERN_HOLDER = Pattern.compile('.*REGEXP>>(.*)<<.*') + private static final Pattern TEMPORARY_EXECUTION_PATTERN_HOLDER = Pattern.compile('["]?EXECUTION>>(.*)<<["]?') + private static final Pattern TEMPORARY_OPTIONAL_PATTERN_HOLDER = Pattern.compile('OPTIONAL>>(.*)<<') + private static final String JSON_VALUE_PATTERN_FOR_REGEX = 'REGEXP>>%s<<' + private static final String JSON_VALUE_PATTERN_FOR_OPTIONAL = 'OPTIONAL>>%s<<' + private static final String JSON_VALUE_PATTERN_FOR_EXECUTION = '"EXECUTION>>%s<<"' + + /** + * Due to the fact that we allow users to have a body with GString and different values inside + * we need to be prepared that they pass regexps around both on client and server side. + * + * In order to preserve the original JSON structure we need to convert the passed Regex patterns + * to a temporary string, then convert all to a legitimate JSON structure and then finally + * convert it back from string to a pattern. + * + * @param bodyAsValue - GString with passed values + * @param valueProvider - provider of values either for server or client side + * @return JSON structure with replaced client / server side parts + */ + public static Object extractValue(GString bodyAsValue, ContentType contentType, Closure valueProvider) { + if (bodyAsValue.isEmpty()){ + return bodyAsValue + } + if (contentType == ContentType.JSON) { + return extractValueForJSON(bodyAsValue, valueProvider) + } + if (contentType == ContentType.XML) { + return extractValueForXML(bodyAsValue, valueProvider) + } + // else Brute force :( + try { + log.debug("No content type provided so trying to parse as JSON") + return extractValueForJSON(bodyAsValue, valueProvider) + } catch(JsonException e) { + // Not a JSON format + log.debug("Failed to parse as JSON - trying to parse as XML", e) + try { + return extractValueForXML(bodyAsValue, valueProvider) + } catch (Exception exception) { + log.debug("No content type provided and failed to parse as XML - returning the value back to the user", exception) + return extractValueForGString(bodyAsValue, valueProvider) + } + } + } + + public static ContentType getClientContentType(GString bodyAsValue) { + try { + extractValueForJSON(bodyAsValue, GET_STUB_SIDE) + return ContentType.JSON + } catch(JsonException e) { + try { + new XmlSlurper().parseText(extractValueForXML(bodyAsValue, GET_STUB_SIDE).toString()) + return ContentType.XML + } catch (Exception exception) { + extractValueForGString(bodyAsValue, GET_STUB_SIDE) + return ContentType.UNKNOWN + } + } + } + + public static ContentType getClientContentType(String bodyAsValue) { + try { + new JsonSlurper().parseText(bodyAsValue) + return ContentType.JSON + } catch(JsonException e) { + try { + new XmlSlurper().parseText(bodyAsValue) + return ContentType.XML + } catch (Exception exception) { + return ContentType.UNKNOWN + } + } + } + + public static ContentType getClientContentType(Object bodyAsValue) { + return ContentType.UNKNOWN + } + + public static ContentType getClientContentType(Map bodyAsValue) { + try { + JsonOutput.toJson(bodyAsValue) + return ContentType.JSON + } catch (Exception ignore) { + return ContentType.UNKNOWN + } + } + + public static ContentType getClientContentType(List bodyAsValue) { + try { + JsonOutput.toJson(bodyAsValue) + return ContentType.JSON + } catch (Exception ignore) { + return ContentType.UNKNOWN + } + } + + private static GStringImpl extractValueForGString(GString bodyAsValue, Closure valueProvider) { + return new GStringImpl( + bodyAsValue.values.collect { it instanceof DslProperty ? valueProvider(it) : it } as String[], + bodyAsValue.strings.clone() as String[] + ) + } + + public static Object extractValue(GString bodyAsValue, Closure valueProvider) { + return extractValue(bodyAsValue, ContentType.UNKNOWN, valueProvider) + } + + private static Object extractValueForJSON(GString bodyAsValue, Closure valueProvider) { + GString transformedString = new GStringImpl( + bodyAsValue.values.collect { transformJSONStringValue(it, valueProvider) } as String[], + bodyAsValue.strings.clone() as String[] + ) + def parsedJson = new JsonSlurper().parseText(transformedString.toString().replace('\\', '\\\\')) + return convertAllTemporaryRegexPlaceholdersBackToPatterns(parsedJson) + } + + private static GStringImpl extractValueForXML(GString bodyAsValue, Closure valueProvider) { + return new GStringImpl( + bodyAsValue.values.collect { transformXMLStringValue(it, valueProvider) } as String[], + bodyAsValue.strings.clone() as String[] + ) + } + + protected static Object transformJSONStringValue(Object obj, Closure valueProvider) { + return obj + } + + protected static Object transformJSONStringValue(DslProperty dslProperty, Closure valueProvider) { + return transformJSONStringValue(valueProvider(dslProperty), valueProvider) + } + + protected static Object transformJSONStringValue(Pattern pattern, Closure valueProvider) { + return String.format(JSON_VALUE_PATTERN_FOR_REGEX, pattern.pattern()) + } + + protected static Object transformJSONStringValue(OptionalProperty optional, Closure valueProvider) { + return String.format(JSON_VALUE_PATTERN_FOR_OPTIONAL, optional.value) + } + + protected static Object transformJSONStringValue(ExecutionProperty property, Closure valueProvider) { + return String.format(JSON_VALUE_PATTERN_FOR_EXECUTION, property.executionCommand) + } + + private static String transformXMLStringValue(Object obj, Closure valueProvider) { + return escapeXml11(obj.toString()) + } + + private static String transformXMLStringValue(DslProperty dslProperty, Closure valueProvider) { + return transformXMLStringValue(valueProvider(dslProperty), valueProvider) + } + + protected static Object convertDslPropsToTemporaryRegexPatterns(parsedJson) { + MapConverter.transformValues(parsedJson, { Object value -> + return transformJSONStringValue(value, GET_TEST_SIDE) + }) + } + + private static Object convertAllTemporaryRegexPlaceholdersBackToPatterns(parsedJson) { + MapConverter.transformValues(parsedJson, { Object value -> + if (value instanceof String) { + String string = (String) value + return returnParsedObject(string) + } + return value + }) + } + + /** + *

+ * If you wonder why there is val[1] without null-check then take a look at this: + *

+ *

+ * Example: + *

+ *

+ * Our string equals: {@code EXECUTION>>assertThatRejectionReasonIsNull($it)<<} + * The matcher matches this group with the pattern {@code EXECUTION>>(.*)<<} + *

+ *

+ * So {@code executionMatcher[0]} returns 2 elements: + *

    + *
  • index0: EXECUTION>>assertThatRejectionReasonIsNull($it)<<
    • + *
  • index1: assertThatRejectionReasonIsNull($it)<<
    • + *
+ *

+ *

+ * Thus one can safely write {@code executionMatcher[0][1]} to retrieve the matched group + *

+ * @param string to match the regexps against + * @return object converted from temporary holders + */ + static Object returnParsedObject(Object object) { + if (!(object instanceof String)) { + return object + } + String string = (String) object + Matcher matcher = TEMPORARY_PATTERN_HOLDER.matcher(string.trim()) + if (matcher.matches()) { + return Pattern.compile(patternFromMatchingGroup(matcher)) + } + Matcher executionMatcher = TEMPORARY_EXECUTION_PATTERN_HOLDER.matcher(string.trim()) + if (executionMatcher.matches()) { + return new ExecutionProperty(patternFromMatchingGroup(executionMatcher)) + } + Matcher optionalMatcher = TEMPORARY_OPTIONAL_PATTERN_HOLDER.matcher(string.trim()) + if (optionalMatcher.matches()) { + String patternToMatch = patternFromMatchingGroup(optionalMatcher) + return Pattern.compile(new OptionalProperty(patternToMatch).optionalPattern()) + } + return string + } + + private static String patternFromMatchingGroup(Matcher matcher) { + List val = matcher[0] as List + return val[1] + } + + public static ContentType recognizeContentTypeFromHeader(Headers headers) { + String content = headers?.entries.find { it.name == "Content-Type" } ?.clientValue?.toString() + if (content?.endsWith("json")) { + return ContentType.JSON + } + if (content?.endsWith("xml")) { + return ContentType.XML + } + return ContentType.UNKNOWN + } + + public static MatchingStrategy.Type getEqualsTypeFromContentType(ContentType contentType) { + switch (contentType) { + case ContentType.JSON: + return MatchingStrategy.Type.EQUAL_TO_JSON + case ContentType.XML: + return MatchingStrategy.Type.EQUAL_TO_XML + } + return MatchingStrategy.Type.EQUAL_TO + } + + public static ContentType recognizeContentTypeFromContent(GString gstring) { + if (isJsonType(gstring)) { + return ContentType.JSON + } + if (isXmlType(gstring)) { + return ContentType.XML + } + return ContentType.UNKNOWN + } + + public static ContentType recognizeContentTypeFromContent(Map jsonMap) { + return ContentType.JSON + } + + public static ContentType recognizeContentTypeFromContent(List jsonList) { + return ContentType.JSON + } + + public static ContentType recognizeContentTypeFromContent(String string) { + try { + new JsonSlurper().parseText(string) + return ContentType.JSON + } catch (Exception e){ + return ContentType.UNKNOWN + } + } + + public static ContentType recognizeContentTypeFromContent(Object gstring) { + return ContentType.UNKNOWN + } + + public static boolean isJsonType(GString gstring) { + if (gstring.isEmpty()) { + return false + } + GString stringWithoutValues = new GStringImpl( + gstring.values.collect({ + it instanceof String || it instanceof GString ? it.toString() : escapeJson(it.toString()) + }) as Object[], + gstring.strings.clone() as String[] + ) + try { + new JsonSlurper().parseText(stringWithoutValues.toString()) + return true + } catch (JsonException e) { + // Not JSON + } + return false + } + + public static boolean isXmlType(GString gstring) { + GString stringWithoutValues = new GStringImpl( + gstring.values.collect({ + it instanceof String || it instanceof GString ? it.toString() : escapeXml11(it.toString()) + }) as Object[], + gstring.strings.clone() as String[] + ) + try { + new XmlSlurper().parseText(stringWithoutValues.toString()) + return true + } catch (Exception e) { + // Not XML + } + return false + } + + public static ContentType recognizeContentTypeFromMatchingStrategy(MatchingStrategy.Type type) { + switch (type) { + case MatchingStrategy.Type.EQUAL_TO_XML: + return ContentType.XML + case MatchingStrategy.Type.EQUAL_TO_JSON: + return ContentType.JSON + } + return ContentType.UNKNOWN + } + + static String getGroovyMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) { + return "'$propertyName', '$propertyValue.name.serverValue', '$propertyValue.value.serverValue'.bytes" + } + + static String getJavaMultipartFileParameterContent(String propertyName, NamedProperty propertyValue) { + return """"${escapeJava(propertyName)}", "${escapeJava(propertyValue.name.serverValue as String)}", "${escapeJava(propertyValue.value.serverValue as String)}".getBytes()""" + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContractVerifierDslConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContractVerifierDslConverter.groovy new file mode 100644 index 0000000000..9cd8eb5956 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ContractVerifierDslConverter.groovy @@ -0,0 +1,44 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import groovy.transform.CompileStatic +import org.codehaus.groovy.control.CompilerConfiguration +import org.springframework.cloud.contract.spec.Contract + +/** + * Converts a file or String into a {@link Contract} + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +@CompileStatic +class ContractVerifierDslConverter { + + static Contract convert(String dsl) { + return groovyShell().evaluate(dsl) as Contract + } + + static Contract convert(File dsl) { + return groovyShell().evaluate(dsl) as Contract + } + + private static GroovyShell groovyShell() { + return new GroovyShell(ContractVerifierDslConverter.classLoader, new Binding(), new CompilerConfiguration(sourceEncoding: 'UTF-8')) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/DelegatingJsonVerifiable.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/DelegatingJsonVerifiable.java new file mode 100644 index 0000000000..5dd82a7fb1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/DelegatingJsonVerifiable.java @@ -0,0 +1,327 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util; + +import java.util.LinkedList; +import java.util.regex.Pattern; + +import com.toomuchcoding.jsonassert.JsonVerifiable; + +import static org.apache.commons.lang3.StringEscapeUtils.escapeJava; + +/** + * Implementation of the {@link MethodBufferingJsonVerifiable} that contains a list + * of String method commands that need to be executed to assert JSONs. + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +class DelegatingJsonVerifiable implements MethodBufferingJsonVerifiable { + + private static final Pattern FIELD_PATTERN = Pattern.compile("\\.field\\((\")?(.)+(\")?\\)"); + private static final Pattern ARRAY_PATTERN = Pattern.compile("\\.array\\((\")?(.)+(\")?\\)"); + + final JsonVerifiable delegate; + final LinkedList methodsBuffer; + + DelegatingJsonVerifiable(JsonVerifiable delegate, + LinkedList methodsBuffer) { + this.delegate = delegate; + this.methodsBuffer = new LinkedList<>(methodsBuffer); + } + + DelegatingJsonVerifiable(JsonVerifiable delegate) { + this.delegate = delegate; + this.methodsBuffer = new LinkedList<>(); + } + + private static String stringWithEscapedQuotes(Object object) { + String stringValue = object.toString(); + return stringValue.replaceAll("\"", "\\\\\""); + } + + private static String wrapValueWithQuotes(Object value) { + return value instanceof String ? + "\"" + stringWithEscapedQuotes(value) + "\"" : + value.toString(); + } + + private void appendMethodWithValue(String methodName, Object value) { + methodsBuffer.offer("." + methodName + "(" + value + ")"); + } + + private void appendMethodWithQuotedValue(String methodName, Object value) { + appendMethodWithValue(methodName, wrapValueWithQuotes(value)); + } + + @Override + public MethodBufferingJsonVerifiable contains(Object value) { + DelegatingJsonVerifiable verifiable = new FinishedDelegatingJsonVerifiable(delegate.contains(value), methodsBuffer); + verifiable.appendMethodWithQuotedValue("contains", value); + if (isAssertingAValueInArray()) { + verifiable.methodsBuffer.offer(".value()"); + } + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable field(Object value) { + Object valueToPut = value instanceof ShouldTraverse ? ((ShouldTraverse) value).value : value; + DelegatingJsonVerifiable verifiable = new DelegatingJsonVerifiable(delegate.field(valueToPut), methodsBuffer); + if (delegate.isIteratingOverArray() && !(value instanceof ShouldTraverse)) { + verifiable.appendMethodWithQuotedValue("contains", valueToPut); + } else { + verifiable.appendMethodWithQuotedValue("field", valueToPut); + } + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable field(String... strings) { + MethodBufferingJsonVerifiable verifiable = null; + for (String string : strings) { + verifiable = verifiable == null ? field(string) : verifiable.field(string); + } + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable array(Object value) { + DelegatingJsonVerifiable verifiable = new DelegatingJsonVerifiable(delegate.array(value), methodsBuffer); + verifiable.appendMethodWithQuotedValue("array", value); + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable arrayField(Object value) { + DelegatingJsonVerifiable verifiable = new DelegatingJsonVerifiable(delegate.field(value).arrayField(), methodsBuffer); + verifiable.appendMethodWithQuotedValue("array", value); + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable arrayField() { + DelegatingJsonVerifiable verifiable = new DelegatingJsonVerifiable(delegate.arrayField(), methodsBuffer); + verifiable.methodsBuffer.offer(".arrayField()"); + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable array() { + DelegatingJsonVerifiable verifiable = new DelegatingJsonVerifiable(delegate.array(), methodsBuffer); + verifiable.methodsBuffer.offer(".array()"); + return verifiable; + } + + @Override + public JsonVerifiable elementWithIndex(int i) { + DelegatingJsonVerifiable verifiable = new DelegatingJsonVerifiable(delegate.elementWithIndex(i), methodsBuffer); + verifiable.methodsBuffer.offer(".elementWithIndex(" + i + ")"); + return verifiable; + } + + @Override + public MethodBufferingJsonVerifiable iterationPassingArray() { + return new DelegatingJsonVerifiable(delegate, methodsBuffer); + } + + @Override + public MethodBufferingJsonVerifiable isEqualTo(String value) { + DelegatingJsonVerifiable readyToCheck = new FinishedDelegatingJsonVerifiable(delegate.isEqualTo(value), methodsBuffer); + if (delegate.isAssertingAValueInArray() && readyToCheck.methodsBuffer.peekLast().equals(".arrayField()")) { + readyToCheck.appendMethodWithQuotedValue("isEqualTo", escapeJava(value)); + readyToCheck.methodsBuffer.offer(".value()"); + } else if (delegate.isAssertingAValueInArray() && !readyToCheck.methodsBuffer.peekLast().contains("array")) { + readyToCheck.methodsBuffer.offer(".value()"); + } else { + readyToCheck.appendMethodWithQuotedValue("isEqualTo", escapeJava(value)); + } + return readyToCheck; + } + + @Override + public MethodBufferingJsonVerifiable isEqualTo(Object value) { + if (value == null) { + return isNull(); + } + return isEqualTo(value.toString()); + } + + @Override + public MethodBufferingJsonVerifiable isEqualTo(Number value) { + DelegatingJsonVerifiable readyToCheck = new FinishedDelegatingJsonVerifiable(delegate.isEqualTo(value), methodsBuffer); + // related to #271 - the problem is with asserting arrays of maps vs arrays of primitives + String last = readyToCheck.methodsBuffer.peekLast(); + boolean containsAMatcher = containsAnyMatcher(last); + if (delegate.isAssertingAValueInArray() && containsAMatcher) { + readyToCheck.methodsBuffer.offer(".value()"); + } else { + readyToCheck.appendMethodWithValue("isEqualTo", String.valueOf(value)); + } + return readyToCheck; + } + + private boolean containsAnyMatcher(String string) { + return string.contains("isEqualTo") || string.contains("matches") || string.contains("isNull"); + } + + @Override + public MethodBufferingJsonVerifiable isNull() { + DelegatingJsonVerifiable readyToCheck = new FinishedDelegatingJsonVerifiable(delegate.isNull(), methodsBuffer); + readyToCheck.methodsBuffer.offer(".isNull()"); + return readyToCheck; + } + + @Override + public MethodBufferingJsonVerifiable matches(String value) { + DelegatingJsonVerifiable readyToCheck = new FinishedDelegatingJsonVerifiable(delegate.matches(value), methodsBuffer); + if (delegate.isAssertingAValueInArray()) { + readyToCheck.appendMethodWithQuotedValue("matches", escapeJava(value)); + readyToCheck.methodsBuffer.offer(".value()"); + } else { + readyToCheck.appendMethodWithQuotedValue("matches", escapeJava(value)); + } + return readyToCheck; + } + + @Override + public MethodBufferingJsonVerifiable isEqualTo(Boolean value) { + DelegatingJsonVerifiable readyToCheck = new FinishedDelegatingJsonVerifiable(delegate.isEqualTo(value), methodsBuffer); + if (delegate.isAssertingAValueInArray()) { + readyToCheck.methodsBuffer.offer(".value()"); + } else { + readyToCheck.appendMethodWithValue("isEqualTo", String.valueOf(value)); + } + return readyToCheck; + } + + @Override + public MethodBufferingJsonVerifiable value() { + return new FinishedDelegatingJsonVerifiable(delegate, methodsBuffer); + } + + @Override + public boolean assertsSize() { + for (String s : methodsBuffer) { + if (s.contains(".hasSize(")) { + return true; + } + } + return false; + } + + @Override + public boolean assertsConcreteValue() { + for (String s : methodsBuffer) { + if (FIELD_PATTERN.matcher(s).matches()|| ARRAY_PATTERN.matcher(s).matches()) { + return true; + } + } + return false; + } + + @Override + public JsonVerifiable withoutThrowingException() { + return delegate.withoutThrowingException(); + } + + @Override + public String jsonPath() { + return delegate.jsonPath(); + } + + @Override + public void matchesJsonPath(String s) { + delegate.matchesJsonPath(s); + } + + @Override + public JsonVerifiable hasSize(int size) { + FinishedDelegatingJsonVerifiable verifiable = new FinishedDelegatingJsonVerifiable(delegate.hasSize(size), methodsBuffer); + verifiable.methodsBuffer.offer(".hasSize(" + size + ")"); + return verifiable; + } + + @Override + public boolean isIteratingOverNamelessArray() { + return delegate.isIteratingOverNamelessArray(); + } + + @Override + public boolean isIteratingOverArray() { + return delegate.isIteratingOverArray(); + } + + @Override + public boolean isAssertingAValueInArray() { + return delegate.isAssertingAValueInArray(); + } + + @Override + public String method() { + return createMethodString(); + } + + private String createMethodString() { + LinkedList queue = new LinkedList<>(methodsBuffer); + StringBuilder stringBuffer = new StringBuilder(); + while (!queue.isEmpty()) { + stringBuffer.append(queue.remove()); + } + return stringBuffer.toString(); + } + + @Override + public boolean equals(Object o) { + if (this == o) + return true; + if (o == null || getClass() != o.getClass()) + return false; + + DelegatingJsonVerifiable that = (DelegatingJsonVerifiable) o; + + if (delegate != null ? !delegate.equals(that.delegate) : that.delegate != null) + return false; + if (delegate == null) { + return false; + } + if (delegate.jsonPath() == null && that.delegate.jsonPath() == null) + return true; + return delegate.jsonPath().equals(that.delegate.jsonPath()); + + } + + @Override + public int hashCode() { + int result = delegate != null ? delegate.jsonPath().hashCode() : 0; + return 31 * result; + } + + @Override + public String toString() { + return "DelegatingJsonVerifiable{" + + "delegate=\n" + delegate + + ", methodsBuffer=" + methodsBuffer + + '}'; + } + + @Override + public T read(Class aClass) { + return delegate.read(aClass); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/FinishedDelegatingJsonVerifiable.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/FinishedDelegatingJsonVerifiable.java new file mode 100644 index 0000000000..000d6e75a4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/FinishedDelegatingJsonVerifiable.java @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util; + +import java.util.LinkedList; + +import com.toomuchcoding.jsonassert.JsonVerifiable; + +/** + * Helper class that represents a finished assertion of a JSON. + * Contains a list of all necessary method calls to assert the JSON. + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +class FinishedDelegatingJsonVerifiable extends DelegatingJsonVerifiable { + + FinishedDelegatingJsonVerifiable(JsonVerifiable delegate, + LinkedList methodsBuffer) { + super(delegate, methodsBuffer); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/JsonPaths.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/JsonPaths.groovy new file mode 100644 index 0000000000..f737a53602 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/JsonPaths.groovy @@ -0,0 +1,29 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import groovy.transform.CompileStatic + +/** + * Represents a set of Strings - set of method calls to assert a JSON + * + * @since 1.0.0 + */ +@CompileStatic +class JsonPaths extends HashSet { +} + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/JsonToJsonPathsConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/JsonToJsonPathsConverter.groovy new file mode 100644 index 0000000000..7825035622 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/JsonToJsonPathsConverter.groovy @@ -0,0 +1,265 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import com.toomuchcoding.jsonassert.JsonAssertion +import groovy.json.JsonOutput +import groovy.json.JsonSlurper +import groovy.util.logging.Slf4j +import org.springframework.cloud.contract.spec.internal.OptionalProperty +import org.springframework.cloud.contract.spec.internal.ExecutionProperty +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +import java.util.regex.Pattern + +/** + * I would like to apologize to anyone who is reading this class. Since JSON is a hectic structure + * this class is also hectic. The idea is to traverse the JSON structure and build a set of + * JSON Paths together with methods needed to be called to build them. + * + * @author Marcin Grzejszczak + */ +@Slf4j +class JsonToJsonPathsConverter { + + /** + * In case of issues with size assertion just provide this property as system property + * equal to "false" and then size assertion will be disabled + */ + private static final String SIZE_ASSERTION_SYSTEM_PROP = "spring.cloud.contract.verifier.assert.size" + + private static final Boolean SERVER_SIDE = false + private static final Boolean CLIENT_SIDE = true + + private final ContractVerifierConfigProperties configProperties + + JsonToJsonPathsConverter(ContractVerifierConfigProperties configProperties) { + this.configProperties = configProperties + } + + JsonToJsonPathsConverter() { + this.configProperties = new ContractVerifierConfigProperties() + } + + public static JsonPaths transformToJsonPathWithTestsSideValues(def json) { + return new JsonToJsonPathsConverter().transformToJsonPathWithValues(json, SERVER_SIDE) + } + + public static JsonPaths transformToJsonPathWithStubsSideValues(def json) { + return new JsonToJsonPathsConverter().transformToJsonPathWithValues(json, CLIENT_SIDE) + } + + private JsonPaths transformToJsonPathWithValues(def json, boolean clientSide) { + if(!json) { + return new JsonPaths() + } + JsonPaths pathsAndValues = [] as Set + Object convertedJson = MapConverter.getClientOrServerSideValues(json, clientSide) + Object jsonWithPatterns = ContentUtils.convertDslPropsToTemporaryRegexPatterns(convertedJson) + MethodBufferingJsonVerifiable methodBufferingJsonPathVerifiable = + new DelegatingJsonVerifiable(JsonAssertion.assertThat(JsonOutput.toJson(jsonWithPatterns)).withoutThrowingException()) + traverseRecursivelyForKey(jsonWithPatterns, methodBufferingJsonPathVerifiable) + { MethodBufferingJsonVerifiable key, Object value -> + if (value instanceof ExecutionProperty || !(key instanceof FinishedDelegatingJsonVerifiable)) { + return + } + pathsAndValues.add(key) + } + return pathsAndValues + } + + protected def traverseRecursively(Class parentType, MethodBufferingJsonVerifiable key, def value, Closure closure) { + value = ContentUtils.returnParsedObject(value) + if (value instanceof String && value) { + try { + def json = new JsonSlurper().parseText(value) + if (json instanceof Map) { + return convertWithKey(parentType, key, json, closure) + } + } catch (Exception ignore) { + return runClosure(closure, key, value) + } + } else if (isAnEntryWithNonCollectionLikeValue(value)) { + return convertWithKey(List, key, value as Map, closure) + } else if (isAnEntryWithoutNestedStructures(value)) { + return convertWithKey(List, key, value as Map, closure) + } else if (value instanceof Map) { + return convertWithKey(Map, key, value as Map, closure) + // JSON with a list of primitives ["a", "b", "c"] in root issue #266 + } else if (key.isIteratingOverNamelessArray() && value instanceof List && listContainsOnlyPrimitives(value)) { + addSizeVerificationForListWithPrimitives(key, closure, value) + value.each { + traverseRecursively(Object, key.arrayField().contains(ContentUtils.returnParsedObject(it)), + ContentUtils.returnParsedObject(it), closure) + } + // JSON containing list of primitives { "partners":[ { "role":"AGENT", "payment_methods":[ "BANK", "CASH" ] } ] + } else if (value instanceof List && listContainsOnlyPrimitives(value)) { + addSizeVerificationForListWithPrimitives(key, closure, value) + value.each { + traverseRecursively(Object, valueToAsserter(key.arrayField(), ContentUtils.returnParsedObject(it)), + ContentUtils.returnParsedObject(it), closure) + } + } else if (value instanceof List) { + MethodBufferingJsonVerifiable jsonPathVerifiable = createAsserterFromList(key, value) + addSizeVerificationForListWithPrimitives(key, closure, value) + value.each { def element -> + traverseRecursively(List, createAsserterFromListElement(jsonPathVerifiable, ContentUtils.returnParsedObject(element)), + ContentUtils.returnParsedObject(element), closure) + } + return value + } else if (key.isIteratingOverArray()) { + traverseRecursively(Object, key.arrayField().contains(ContentUtils.returnParsedObject(value)), + ContentUtils.returnParsedObject(value), closure) + } + try { + return runClosure(closure, key, value) + } catch (Exception ignore) { + return value + } + } + + // Size verification: https://github.com/Codearte/accurest/issues/279 + private void addSizeVerificationForListWithPrimitives(MethodBufferingJsonVerifiable key, Closure closure, List value) { + Boolean systemPropValue = Boolean.parseBoolean(System.getProperty(SIZE_ASSERTION_SYSTEM_PROP, "false")) + Boolean configPropValue = configProperties.assertJsonSize + boolean configPropSet = configPropValue != null + if (configPropSet && !configPropValue) { + return + } else if (!configPropSet && systemPropValue) { + return + } + log.debug("WARNING: Turning on the incubating feature of JSON array check") + if (isRootElement(key) || key.assertsConcreteValue()) { + if (value.size() > 0) { + closure(key.hasSize(value.size()), value) + } + } + } + + private boolean isRootElement(MethodBufferingJsonVerifiable key) { + return key.jsonPath() == '$' + } + + // If you have a list of not-only primitives it can contain different sets of elements (maps, lists, primitives) + private MethodBufferingJsonVerifiable createAsserterFromList(MethodBufferingJsonVerifiable key, List value) { + if (key.isIteratingOverNamelessArray()) { + return key.array() + } else if (key.isIteratingOverArray() && isAnEntryWithLists(value)) { + if (!value.every { listContainsOnlyPrimitives(it as List)} ) { + return key.array() + } else { + return key.iterationPassingArray() + } + } else if (key.isIteratingOverArray()) { + return key.iterationPassingArray() + } + return key + } + + private MethodBufferingJsonVerifiable createAsserterFromListElement(MethodBufferingJsonVerifiable jsonPathVerifiable, def element) { + if (jsonPathVerifiable.isAssertingAValueInArray()) { + def object = ContentUtils.returnParsedObject(element) + if (object instanceof Pattern) { + return jsonPathVerifiable.matches((object as Pattern).pattern()) + } + return jsonPathVerifiable.contains(object) + } + return jsonPathVerifiable + } + + private def runClosure(Closure closure, MethodBufferingJsonVerifiable key, def value) { + if (key.isAssertingAValueInArray() && !(value instanceof List || value instanceof Map)) { + return closure(valueToAsserter(key, value), value) + } + return closure(key, value) + } + + private boolean isAnEntryWithNonCollectionLikeValue(def value) { + if (!(value instanceof Map)) { + return false + } + Map valueAsMap = ((Map) value) + boolean mapHasOneEntry = valueAsMap.size() == 1 + if (!mapHasOneEntry) { + return false + } + Object valueOfEntry = valueAsMap.entrySet().first().value + return !(valueOfEntry instanceof Map || valueOfEntry instanceof List) + } + + private boolean isAnEntryWithoutNestedStructures(def value) { + if (!(value instanceof Map)) { + return false + } + Map valueAsMap = ((Map) value) + return valueAsMap.entrySet().every { Map.Entry entry -> + [String, Number, Boolean].any { it.isAssignableFrom(entry.value.getClass()) } + } + } + + private boolean listContainsOnlyPrimitives(List list) { + return list.every { def element -> + [String, Number, Boolean].any { + it.isAssignableFrom(element.getClass()) + } + } + } + private boolean isAnEntryWithLists(def value) { + if (!(value instanceof Iterable)) { + return false + } + return value.every { def entry -> + entry instanceof List + } + } + + private Map convertWithKey(Class parentType, MethodBufferingJsonVerifiable parentKey, Map map, Closure closureToExecute) { + return map.collectEntries { + Object entrykey, value -> + def convertedValue = ContentUtils.returnParsedObject(value) + [entrykey, traverseRecursively(parentType, + convertedValue instanceof List ? listContainsOnlyPrimitives(convertedValue) ? + parentKey.arrayField(entrykey) : + parentKey.array(entrykey) : + convertedValue instanceof Map ? parentKey.field(new ShouldTraverse(entrykey)) : + valueToAsserter(parentKey.field(entrykey), convertedValue) + , convertedValue, closureToExecute)] + } + } + + private void traverseRecursivelyForKey(def json, MethodBufferingJsonVerifiable rootKey, Closure closure) { + traverseRecursively(Map, rootKey, json, closure) + } + + protected MethodBufferingJsonVerifiable valueToAsserter(MethodBufferingJsonVerifiable key, Object value) { + def convertedValue = ContentUtils.returnParsedObject(value) + if (key instanceof FinishedDelegatingJsonVerifiable) { + return key + } + if (convertedValue instanceof Pattern) { + return key.matches((convertedValue as Pattern).pattern()) + } else if (convertedValue instanceof OptionalProperty) { + return key.matches((convertedValue as OptionalProperty).optionalPattern()) + } else if (convertedValue instanceof GString) { + return key.matches(RegexpBuilders.buildGStringRegexpForTestSide(convertedValue)) + } else if (convertedValue instanceof ExecutionProperty) { + return key + } + return key.isEqualTo(convertedValue) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MapConverter.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MapConverter.groovy new file mode 100644 index 0000000000..31c5aa1899 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MapConverter.groovy @@ -0,0 +1,129 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import groovy.json.JsonSlurper +import org.springframework.cloud.contract.spec.internal.DslProperty + +/** + * Converts an object into either client or server side representation. + * Iterates over the structure of an object (depending on whether it's an + * iterable or a primitive type etc.), converts the {@link DslProperty} into their + * client / server representation and returns the result + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +class MapConverter { + + public static final boolean STUB_SIDE = true + public static final boolean TEST_SIDE = false + + /** + * Returns the object with client side values of {@link org.springframework.cloud.contract.spec.internal.DslProperty} + */ + static def transformToClientValues(def value) { + return transformValues(value) { + it instanceof DslProperty ? it.clientValue : it + } + } + + /** + * Iterates over the structure of the object and executes the closure + * on each element of that structure. + * + * Returns the transformed structure + */ + static def transformValues(def value, Closure closure) { + if (value instanceof String && value) { + try { + def json = new JsonSlurper().parseText(value) + if (json instanceof Map) { + return convert(json, closure) + } + } catch (Exception ignore) { + } + return extractValue(value, closure); + } else if (value instanceof Map) { + return convert(value as Map, closure) + } else if (value instanceof List) { + return value.collect({ transformValues(it, closure) }) + } + return transformValue(closure, value) + } + + /** + * Transforms a value with the given closure. Needs to be protected, otherwise + * method access exception will occur at runtime. + */ + protected static Object transformValue(Closure closure, Object value) { + return extractValue(value, { Object val-> + Object newValue = closure(val) + if (newValue instanceof Map || newValue instanceof List || newValue instanceof String && value) { + return transformValues(newValue, closure) + } + return newValue; + }) + } + + private static extractValue(Object value, Closure closure) { + try { + return closure(value) + } catch (Exception ignore) { + return value + } + } + + private static Map convert(Map map, Closure closure) { + return map.collectEntries { + key, value -> + [key, transformValues(value, closure)] + } + } + + /** + * If {@code clientSide} is {@code true} returns the client side value for the + * provided object + */ + static Object getClientOrServerSideValues(json, boolean clientSide) { + return transformValues(json) { + if (it instanceof DslProperty) { + DslProperty dslProperty = ((DslProperty) it) + return clientSide ? + getClientOrServerSideValues(dslProperty.clientValue, clientSide) : getClientOrServerSideValues(dslProperty.serverValue, clientSide) + } else if (it instanceof GString) { + return ContentUtils.extractValue(it , null, { + if (it instanceof DslProperty) { + return clientSide ? + getClientOrServerSideValues((it as DslProperty).clientValue, clientSide) : getClientOrServerSideValues((it as DslProperty).serverValue, clientSide) + } + return it + }) + } + return it + } + } + + static Object getStubSideValues(json) { + return getClientOrServerSideValues(json, STUB_SIDE) + } + + static Object getTestSideValues(json) { + return getClientOrServerSideValues(json, TEST_SIDE) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MethodBuffering.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MethodBuffering.java new file mode 100644 index 0000000000..12774b14bb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MethodBuffering.java @@ -0,0 +1,29 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util; + +/** + * Contract for classes that buffer method executions + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +public interface MethodBuffering { + + String method(); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MethodBufferingJsonVerifiable.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MethodBufferingJsonVerifiable.java new file mode 100644 index 0000000000..746bf3a9a9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/MethodBufferingJsonVerifiable.java @@ -0,0 +1,74 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util; + +import com.toomuchcoding.jsonassert.JsonVerifiable; + +/** + * A wrapper over {@link JsonVerifiable} that allows to store the method + * name in order to print it out in the generated test + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +public interface MethodBufferingJsonVerifiable + extends JsonVerifiable, MethodBuffering { + @Override + MethodBufferingJsonVerifiable contains(Object value); + + @Override + MethodBufferingJsonVerifiable field(Object value); + + @Override + MethodBufferingJsonVerifiable array(Object value); + + MethodBufferingJsonVerifiable arrayField(Object value); + + @Override + MethodBufferingJsonVerifiable arrayField(); + + @Override + MethodBufferingJsonVerifiable array(); + + MethodBufferingJsonVerifiable iterationPassingArray(); + + @Override + MethodBufferingJsonVerifiable isEqualTo(String value); + + @Override + MethodBufferingJsonVerifiable isEqualTo(Object value); + + @Override + MethodBufferingJsonVerifiable isEqualTo(Number value); + + @Override + MethodBufferingJsonVerifiable isNull(); + + @Override + MethodBufferingJsonVerifiable matches(String value); + + @Override + MethodBufferingJsonVerifiable isEqualTo(Boolean value); + + @Override + MethodBufferingJsonVerifiable value(); + + boolean assertsSize(); + + boolean assertsConcreteValue(); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/NamesUtil.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/NamesUtil.groovy new file mode 100644 index 0000000000..6957ed3d8d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/NamesUtil.groovy @@ -0,0 +1,111 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +/** + * A utility class that helps to convert names + * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +class NamesUtil { + + /** + * Returns the first element before the last separator presence. + * Returns empty string if separator is not found. + */ + static String beforeLast(String string, String separator) { + if (string?.indexOf(separator) > -1) { + return string.substring(0, string.lastIndexOf(separator)) + } + return '' + } + + /** + * Returns the first element after the last separator presence + * Returns the provided string if separator is not found. + */ + static String afterLast(String string, String separator) { + if (string?.indexOf(separator) > -1) { + return string.substring(string.lastIndexOf(separator) + 1) + } + return string + } + + /** + * Returns the first element after the last dot presence + * Returns the provided string if separator is not found. + */ + static String afterLastDot(String string) { + return afterLast(string, '.') + } + + /** + * Converts a string into a camel case format + */ + static String camelCase(String className) { + if (!className) { + return className + } + String firstChar = className.charAt(0).toLowerCase() as String + return firstChar + className.substring(1) + } + + /** + * Capitalizes the provided string + */ + static String capitalize(String className) { + if (!className) { + return className + } + String firstChar = className.charAt(0).toUpperCase() as String + return firstChar + className.substring(1) + } + + /** + * Returns the whole string to the last present dot. + * Returns input string if there is no dot + */ + static String toLastDot(String string) { + if (string?.indexOf('.') > -1) { + return string.substring(0, string.lastIndexOf('.')) + } + return string + } + + /** + * Converts the Java package notation to a path format + */ + static String packageToDirectory(String packageName) { + return packageName.replace('.' as char, File.separatorChar) + } + + /** + * Converts the path format to a Java package notation + */ + static String directoryToPackage(String directory) { + return directory.replace(File.separator, '.') + } + + /** + * Converts illegal package characters to underscores + */ + static String convertIllegalPackageChars(String packageName) { + return packageName.replace('-', '_') + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/RegexpBuilders.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/RegexpBuilders.groovy new file mode 100644 index 0000000000..df267cfd87 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/RegexpBuilders.groovy @@ -0,0 +1,155 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import groovy.transform.TypeChecked +import org.codehaus.groovy.runtime.GStringImpl +import org.springframework.cloud.contract.spec.internal.DslProperty + +import java.util.regex.Pattern + +import static ContentUtils.extractValue +import static org.apache.commons.lang3.StringEscapeUtils.escapeJson + +/** + * Useful utility methods to work with regular expresisons + * + * Do not change to {@code @CompileStatic} since it's using double dispatch. + * + * @since 1.0.0 + */ +@TypeChecked +class RegexpBuilders { + + /** + * Converts the {@link GString} passed values into their stub side String representations + */ + static String buildGStringRegexpForStubSide(GString gString) { + new GStringImpl( + gString.values.collect(this.&buildGStringRegexpForStubSide) as Object[], + gString.strings.collect(this.&escapeSpecialRegexChars) as String[] + ) + } + + /** + * Converts the {@link Pattern} passed values into their stub side String representations + */ + static String buildGStringRegexpForStubSide(Pattern pattern) { + return pattern.pattern() + } + + /** + * Converts the {@link org.springframework.cloud.contract.spec.internal.DslProperty} passed values into their stub side String representations + */ + static String buildGStringRegexpForStubSide(DslProperty dslProperty) { + return buildGStringRegexpForStubSide(dslProperty.clientValue) + } + + /** + * Converts the {@link Object} passed values into their stub side String representations + */ + static String buildGStringRegexpForStubSide(Object o) { + return escapeSpecialRegexChars(o.toString()) + } + + /** + * Converts the {@link GString} passed values into their test side String representations + */ + static String buildGStringRegexpForTestSide(GString gString) { + new GStringImpl( + gString.values.collect(this.&buildGStringRegexpForTestSide) as Object[], + gString.strings.collect(this.&escapeSpecialRegexChars) as String[] + ) + } + + /** + * Converts the {@link Pattern} passed values into their test side String representations + */ + static String buildGStringRegexpForTestSide(Pattern pattern) { + return pattern.pattern() + } + + /** + * Converts the {@link DslProperty} passed values into their test side String representations + */ + static String buildGStringRegexpForTestSide(DslProperty dslProperty) { + return buildGStringRegexpForTestSide(dslProperty.clientValue) + } + + /** + * Converts the {@link Object} passed values into their test side String representations + */ + static String buildGStringRegexpForTestSide(Object o) { + return o.toString().replaceAll('\\\\', '\\\\\\\\') + } + + private final static Pattern SPECIAL_REGEX_CHARS = Pattern.compile('[{}()\\[\\].+*?^$\\\\|]') + + private static String escapeSpecialRegexChars(String str) { + return SPECIAL_REGEX_CHARS.matcher(str).replaceAll('\\\\\\\\$0') + } + + private final static String WS = /\s*/ + + static String buildJSONRegexpMatch(GString gString) { + return buildJSONRegexpMatch(extractValue(gString, ContentType.JSON, { DslProperty dslProperty -> dslProperty.clientValue })) + } + + static String buildJSONRegexpMatch(Map jsonMap) { + return WS + "\\{" + jsonMap.collect(this.&buildJSONRegexpMatch).join(",") + "\\}" + WS + } + + static String buildJSONRegexpMatch(List jsonList) { + return WS + "\\[" + jsonList.collect(this.&buildJSONRegexpMatch).join(",") + "\\]" + WS + } + + /** + * Converts the map into String representation of regular expressions + */ + static String buildJSONRegexpMatch(Map.Entry entry) { + return buildJSONRegexpMatchString(escapeJson(entry.key)) + ":" + buildJSONRegexpMatch(entry.value) + } + + /** + * Converts the object into String representation of regular expressions + */ + static String buildJSONRegexpMatch(Object value) { + return buildJSONRegexpMatchStringOptionalQuotes(escapeJson(value.toString())) + } + + /** + * Converts the pattern into String representation of regular expressions + */ + static String buildJSONRegexpMatch(Pattern pattern) { + return buildJSONRegexpMatchStringOptionalQuotes(pattern.pattern()) + } + + /** + * Converts the String into String representation of regular expressions + */ + static String buildJSONRegexpMatchString(String value) { + return WS + '"' + value + '"' + WS + } + + /** + * Converts the String into an optional String representation of regular expressions + */ + static String buildJSONRegexpMatchStringOptionalQuotes(String value) { + return WS + '"?' + value + '"?' + WS + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ShouldTraverse.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ShouldTraverse.java new file mode 100644 index 0000000000..2fad0fcd6a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/groovy/org/springframework/cloud/contract/verifier/util/ShouldTraverse.java @@ -0,0 +1,33 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util; + +/** + * Utility class that wraps an object that should be traversed + * when building a list of methods to execute in the generated test. + * + * @author Marcin Grzejszczak + * + * @since 1.0.0 + */ +class ShouldTraverse { + final Object value; + + ShouldTraverse(Object value) { + this.value = value; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/resources/stubs/wiremocks/other/sample.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/resources/stubs/wiremocks/other/sample.json new file mode 100644 index 0000000000..f4eca9faad --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/resources/stubs/wiremocks/other/sample.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "url": "/loanApplication", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.loanapplicationservice.v1+json" + } + }, + "bodyPatterns": [ + { + "matches": "{\"client\":{\"pesel\":\"1234567890\"},\"loanApplicationId\":123123123,\"amount\":123.123}" + } + ] + }, + "response": { + "status": 200, + "body": "{\"loanApplicationStatus\":\"LOAN_APPLIED\",\"loanApplicationId\":\"${123123123:$anyInt($it)}\"}", + "headers": { + "Content-Type": "application/vnd.loanapplicationservice.v1+json" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/resources/stubs/wiremocks/sample.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/resources/stubs/wiremocks/sample.json new file mode 100644 index 0000000000..92da92f7da --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/main/resources/stubs/wiremocks/sample.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "url": "/loanApplication", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.loanapplicationservice.v1+json" + } + }, + "bodyPatterns": [ + { + "matches": "\\{\"clientPesel\":\"1234567890\",\"loanAmount\":123.123\\}" + } + ] + }, + "response": { + "status": 200, + "body": "{\"loanApplicationStatus\":\"LOAN_APPLIED\",\"loanApplicationId\":\"${123123123:$anyInt($it)}\",\"rejectionReason\":null}", + "headers": { + "Content-Type": "application/vnd.loanapplicationservice.v1+json" + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/GeneratorScannerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/GeneratorScannerSpec.groovy new file mode 100644 index 0000000000..85f8c84fd4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/GeneratorScannerSpec.groovy @@ -0,0 +1,53 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier + +import org.springframework.cloud.contract.verifier.builder.SingleTestGenerator +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.config.TestFramework +import spock.lang.Specification + +class GeneratorScannerSpec extends Specification { + + private SingleTestGenerator classGenerator = Mock(SingleTestGenerator) + + def "should find all .json files and generate 6 classes for them"() { + given: + File resource = new File(this.getClass().getResource("/directory/with/stubs/stubsRepositoryIndicator").toURI()) + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties() + properties.contractsDslDir = resource.parentFile + TestGenerator testGenerator = new TestGenerator(properties, classGenerator, Stub(FileSaver)) + when: + testGenerator.generateTestClasses("org.springframework.cloud.contract.verifier") + then: + 6 * classGenerator.buildClass(_, _, _) >> "qwerty" + } + + def "should create class with full package"() { + given: + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(targetFramework: TestFramework.SPOCK) + properties.contractsDslDir = new File(this.getClass().getResource("/directory/with/stubs/package").toURI()) + TestGenerator testGenerator = new TestGenerator(properties, classGenerator, Stub(FileSaver)) + when: + testGenerator.generateTestClasses("org.springframework.cloud.contract.verifier") + then: + 1 * classGenerator.buildClass(_, 'exceptionsSpec', 'org.springframework.cloud.contract.verifier') >> "spec" + 1 * classGenerator.buildClass(_, 'exceptionsSpec', 'org.springframework.cloud.contract.verifier.v1') >> "spec1" + 1 * classGenerator.buildClass(_, 'exceptionsSpec', 'org.springframework.cloud.contract.verifier.v2') >> "spec2" + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/MainTest.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/MainTest.groovy new file mode 100644 index 0000000000..261416ca7e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/MainTest.groovy @@ -0,0 +1,32 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier + +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.config.TestFramework +import org.springframework.cloud.contract.verifier.config.TestMode + +class MainTest { + public static void main(String[] args) { + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties( + contractsDslDir: new File('/some/path/dsl'), + generatedTestSourcesDir: new File('/tmp/contracts'), + targetFramework: TestFramework.SPOCK, testMode: TestMode.MOCKMVC, basePackageForTests: 'io.test', + staticImports: ['com.package.Test.*'], imports: ['org.package.Test'], excludedFiles: ["**/other"]) + println new TestGenerator(properties).generate() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/BookReturned.groovy new file mode 100644 index 0000000000..c47554348a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/BookReturned.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookReturned implements Serializable { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy new file mode 100644 index 0000000000..1c23b37367 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/ContractHttpDocsSpec.groovy @@ -0,0 +1,317 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import spock.lang.Shared +import spock.lang.Specification + +/** + * Tests used for the documentation + * + * @author Marcin Grzejszczak + */ +class ContractHttpDocsSpec extends Specification { + + @Shared ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(assertJsonSize: true) + + org.springframework.cloud.contract.spec.Contract httpDsl = + // tag::http_dsl[] + org.springframework.cloud.contract.spec.Contract.make { + // Definition of HTTP request part of the contract + // (this can be a valid request or invalid depending + // on type of contract being specified). + request { + //... + } + + // Definition of HTTP response part of the contract + // (a service implementing this contract should respond + // with following response after receiving request + // specified in "request" part above). + response { + //... + } + + // Contract priority, which can be used for overriding + // contracts (1 is highest). Priority is optional. + priority 1 + } + // end::http_dsl[] + + org.springframework.cloud.contract.spec.Contract request = + // tag::request[] + org.springframework.cloud.contract.spec.Contract.make { + request { + // HTTP request method (GET/POST/PUT/DELETE). + method 'GET' + + // Path component of request URL is specified as follows. + urlPath('/users') + } + + response { + //... + } + } + // end::request[] + + org.springframework.cloud.contract.spec.Contract url = + // tag::url[] + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + + // Specifying `url` and `urlPath` in one contract is illegal. + url('http://localhost:8888/users') + } + + response { + //... + } + } + // end::url[] + + org.springframework.cloud.contract.spec.Contract urlPaths = + // tag::urlpath[] + org.springframework.cloud.contract.spec.Contract.make { + request { + //... + + urlPath('/users') { + + // Each parameter is specified in form + // `'paramName' : paramValue` where parameter value + // may be a simple literal or one of matcher functions, + // all of which are used in this example. + queryParameters { + + // If a simple literal is used as value + // default matcher function is used (equalTo) + parameter 'limit': 100 + + // `equalTo` function simply compares passed value + // using identity operator (==). + parameter 'filter': equalTo("email") + + // `containing` function matches strings + // that contains passed substring. + parameter 'gender': value(stub(containing("[mf]")), server('mf')) + + // `matching` function tests parameter + // against passed regular expression. + parameter 'offset': value(stub(matching("[0-9]+")), server(123)) + + // `notMatching` functions tests if parameter + // does not match passed regular expression. + parameter 'loginStartsWith': value(stub(notMatching(".{0,2}")), server(3)) + } + } + + //... + } + + response { + //... + } + } + // end::urlpath[] + + org.springframework.cloud.contract.spec.Contract headers = + // tag::headers[] + org.springframework.cloud.contract.spec.Contract.make { + request { + //... + + // Each header is added in form `'Header-Name' : 'Header-Value'`. + headers { + header 'Content-Type': 'application/json' + } + + //... + } + + response { + //... + } + } + // end::headers[] + + org.springframework.cloud.contract.spec.Contract body = + // tag::body[] + org.springframework.cloud.contract.spec.Contract.make { + request { + //... + + // JSON and XML formats of request body are supported. + // Format will be determined from a header or body's content. + body '''{ "login" : "john", "name": "John The Contract" }''' + } + + response { + //... + } + } + // end::body[] + + org.springframework.cloud.contract.spec.Contract bodyAsXml = + // tag::bodyAsXml[] + org.springframework.cloud.contract.spec.Contract.make { + request { + //... + + // In this case body will be formatted as XML. + body equalToXml( + '''johnJohn The Contract''' + ) + } + + response { + //... + } + } + // end::bodyAsXml[] + + org.springframework.cloud.contract.spec.Contract response = + // tag::response[] + org.springframework.cloud.contract.spec.Contract.make { + request { + //... + } + response { + // Status code sent by the server + // in response to request specified above. + status 200 + } + } + // end::response[] + + org.springframework.cloud.contract.spec.Contract regex = + // tag::regex[] + org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(~/\/[0-9]{2}/), server('/12')) + } + response { + status 200 + body( + id: value( + client('123'), + server(regex('[0-9]+')) + ), + surname: $( + client('Kowalsky'), + server('Lewandowski') + ), + name: 'Jan', + created: $(client('2014-02-02 12:23:43'), server(execute('currentDate(it)'))), + correlationId: value(client('5d1f9fef-e0dc-4f3d-a7e4-72d2220dd827'), + server(regex('[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}')) + ) + ) + headers { + header 'Content-Type': 'text/plain' + } + } + } + // end::regex[] + + org.springframework.cloud.contract.spec.Contract optionals = + // tag::optionals[] + org.springframework.cloud.contract.spec.Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + email: $(stub(optional(regex(email()))), test('abc@abc.com')), + callback_url: $(stub(regex(hostname())), test('http://partners.com')) + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + code: value(stub("123123"), test(optional("123123"))) + ) + } + } + // end::optionals[] + + def 'should convert dsl with optionals to proper Spock test'() { + given: + BlockBuilder blockBuilder = new BlockBuilder(" ") + new MockMvcSpockMethodRequestProcessingBodyBuilder(optionals, properties).appendTo(blockBuilder) + expect: + String expectedTest = +// tag::optionals_test[] +""" + given: + def request = given() + .header('Content-Type', 'application/json') + .body('''{"email":"abc@abc.com","callback_url":"http://partners.com"}''') + + when: + def response = given().spec(request) + .post("/users/password") + + then: + response.statusCode == 404 + response.header('Content-Type') == 'application/json' + and: + DocumentContext parsedJson = JsonPath.parse(response.body.asString()) + assertThatJson(parsedJson).field("code").matches("(123123)?") +""" +// end::optionals_test[] + stripped(blockBuilder.toString()) == stripped(expectedTest) + } + + org.springframework.cloud.contract.spec.Contract method = + // tag::method[] + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url $(client(regex('^/api/[0-9]{2}$')), server('/api/12')) + headers { + header 'Content-Type': 'application/json' + } + body '''\ + [{ + "text": "Gonna see you at Warsaw" + }] + ''' + } + response { + body ( + path: $(client('/api/12'), server(regex('^/api/[0-9]{2}$'))), + correlationId: $(client('1223456'), server(execute('isProperCorrelationId($it)'))) + ) + status 200 + } + } + // end::method[] + + private String stripped(String string) { + return string.stripMargin().stripIndent().replace('\t', '').replace('\n', '').replace(' ','') + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientMethodBuilderSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientMethodBuilderSpec.groovy new file mode 100644 index 0000000000..777c28a59c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/JaxRsClientMethodBuilderSpec.groovy @@ -0,0 +1,683 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.dsl.WireMockStubVerifier +import org.springframework.cloud.contract.verifier.file.ContractMetadata +import org.springframework.cloud.contract.verifier.dsl.wiremock.WireMockStubStrategy +import spock.lang.Issue +import spock.lang.Shared +import spock.lang.Specification + +class JaxRsClientMethodBuilderSpec extends Specification implements WireMockStubVerifier { + + @Shared ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(assertJsonSize: true) + + def "should generate assertions for simple response body with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """{ + "property1": "a", + "property2": "b" +}""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").isEqualTo("b")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue("#187") + def "should generate assertions for null and boolean values with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """{ + "property1": "true", + "property2": null, + "property3": false +}""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property3").isEqualTo(false)""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").isNull()""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("true")""") + and: + stubMappingIsValidWireMockStub(new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), contractDsl).toWireMockClientStub()) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue("#79") + def "should generate assertions for simple response body constructed from map with a list with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body( + property1: 'a', + property2: [ + [a: 'sth'], + [b: 'sthElse'] + ] + ) + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property2").contains("a").isEqualTo("sth")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property2").hasSize(2)""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property2").contains("b").isEqualTo("sthElse")""") + and: + stubMappingIsValidWireMockStub(new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), contractDsl).toWireMockClientStub()) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue("#82") + def "should generate proper request when body constructed from map with a list with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + body( + items: ['HOP'] + ) + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains(bodyString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyString + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | """entity('{\"items\":[\"HOP\"]}', 'application/json')""" + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | 'entity("{\\"items\\":[\\"HOP\\"]}", "application/json")' + } + + @Issue("#88") + def "should generate proper request when body constructed from GString with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + body( + "property1=VAL1" + ) + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains(bodyString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyString + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | """entity('property1=VAL1', 'application/octet-stream')""" + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | 'entity("\\"property1=VAL1\\"", "application/octet-stream")' + } + + def "should generate assertions for array in response body with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """[ +{ + "property1": "a" +}, +{ + "property2": "b" +}]""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).array().contains("property1").isEqualTo("a")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array().contains("property2").isEqualTo("b")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate assertions for array inside response body element with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """{ + "property1": [ + { "property2": "test1"}, + { "property3": "test2"} + ] +}""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property1").contains("property2").isEqualTo("test1")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property1").contains("property3").isEqualTo("test2")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate assertions for nested objects in response body with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body '''\ +{ + "property1": "a", + "property2": {"property3": "b"} +} +''' + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").field("property3").isEqualTo("b")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate regex assertions for map objects in response body with #methodBodyName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body( + property1: "a", + property2: value( + client('123'), + server(regex('[0-9]{3}')) + ) + ) + headers { + header('Content-Type': 'application/json') + + } + + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").matches("[0-9]{3}")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate regex assertions for string objects in response body with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body("""{"property1":"a","property2":"${value(client('123'), server(regex('[0-9]{3}')))}"}""") + headers { + header('Content-Type': 'application/json') + + } + + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").matches("[0-9]{3}")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should ignore 'Accept' header and use 'request' method with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + headers { + header("Accept", "text/plain") + } + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains(requestString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | requestString + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | "request('text/plain')" + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | 'request("text/plain")' + } + + def "should ignore 'Content-Type' header and use 'entity' method with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "GET" + url "test" + headers { + header("Content-Type", "text/plain") + header("Timer", "123") + } + body '' + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + for (String requestString : requestStrings) { + blockBuilder.toString().contains(requestString) + } + !blockBuilder.toString().contains("""Content Type""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | requestStrings + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | ["""entity('', 'text/plain')""", """header('Timer', '123')"""] + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | ['entity("\\"\\"", "text/plain")', 'header("Timer", "123")'] + } + + def "should generate a call with an url path and query parameters with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath('/users') { + queryParameters { + parameter 'limit': $(client(equalTo("20")), server(equalTo("10"))) + parameter 'offset': $(client(containing("20")), server(equalTo("20"))) + parameter 'filter': "email" + parameter 'sort': equalTo("name") + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("55")) + parameter 'age': $(client(notMatching("^\\w*\$")), server("99")) + parameter 'name': $(client(matching("Denis.*")), server("Denis.Stepanov")) + parameter 'email': "bob@email.com" + parameter 'hello': $(client(matching("Denis.*")), server(absent())) + parameter 'hello': absent() + } + } + } + response { + status 200 + body """ + { + "property1": "a", + "property2": "b" + } + """ + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(modifyStringIfRequired.call("queryParam('limit', '10'")) + test.contains(modifyStringIfRequired.call("queryParam('offset', '20'")) + test.contains(modifyStringIfRequired.call("queryParam('filter', 'email'")) + test.contains(modifyStringIfRequired.call("queryParam('sort', 'name'")) + test.contains(modifyStringIfRequired.call("queryParam('search', '55'")) + test.contains(modifyStringIfRequired.call("queryParam('age', '99'")) + test.contains(modifyStringIfRequired.call("queryParam('name', 'Denis.Stepanov'")) + test.contains(modifyStringIfRequired.call("queryParam('email', 'bob@email.com'")) + test.contains(modifyStringIfRequired.call("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""")) + test.contains(modifyStringIfRequired.call("""assertThatJson(parsedJson).field("property2").isEqualTo("b")""")) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | modifyStringIfRequired + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | { String paramString -> paramString } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | { String paramString -> paramString.replace("'", "\"") } + } + + @Issue('#169') + def "should generate a call with an url path and query parameters with url containing a pattern with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url($(stub(regex('/foo/[0-9]+')), test('/foo/123456'))) { + queryParameters { + parameter 'limit': $(client(equalTo("20")), server(equalTo("10"))) + parameter 'offset': $(client(containing("20")), server(equalTo("20"))) + parameter 'filter': "email" + parameter 'sort': equalTo("name") + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("55")) + parameter 'age': $(client(notMatching("^\\w*\$")), server("99")) + parameter 'name': $(client(matching("Denis.*")), server("Denis.Stepanov")) + parameter 'email': "bob@email.com" + parameter 'hello': $(client(matching("Denis.*")), server(absent())) + parameter 'hello': absent() + } + } + } + response { + status 200 + body """ + { + "property1": "a", + "property2": "b" + } + """ + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(modifyStringIfRequired.call("queryParam('limit', '10'")) + test.contains(modifyStringIfRequired.call("queryParam('offset', '20'")) + test.contains(modifyStringIfRequired.call("queryParam('filter', 'email'")) + test.contains(modifyStringIfRequired.call("queryParam('sort', 'name'")) + test.contains(modifyStringIfRequired.call("queryParam('search', '55'")) + test.contains(modifyStringIfRequired.call("queryParam('age', '99'")) + test.contains(modifyStringIfRequired.call("queryParam('name', 'Denis.Stepanov'")) + test.contains(modifyStringIfRequired.call("queryParam('email', 'bob@email.com'")) + test.contains(modifyStringIfRequired.call("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""")) + test.contains(modifyStringIfRequired.call("""assertThatJson(parsedJson).field("property2").isEqualTo("b")""")) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | modifyStringIfRequired + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | { String paramString -> paramString } + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | { String paramString -> paramString.replace("'", "\"") } + } + + def "should generate test for empty body with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('POST') + url("/ws/payments") + body("") + } + response { + status 406 + } + } + + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(bodyString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyString + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | "entity('', 'application/octet-stream')" + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | 'entity("\\"\\"", "application/octet-stream"' + } + + def "should generate test for String in response body with #methodBodyName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "POST" + url "test" + } + response { + status 200 + body "test" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(bodyDefinitionString) + test.contains(bodyEvaluationString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyDefinitionString | bodyEvaluationString + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | "String responseAsString = response.readEntity(String)" | 'responseBody == "test"' + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | 'Object responseBody = (responseAsString);' | 'assertThat(responseBody).isEqualTo("test");' + } + + @Issue('#171') + def "should generate test with uppercase method name with #methodBuilderName"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "get" + url "/v1/some_cool_requests/e86df6f693de4b35ae648464c5b0dc08" + } + response { + status 200 + headers { + header('Content-Type': 'application/json;charset=UTF-8') + } + body """ +{"id":"789fgh","other_data":1268} +""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(methodString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | methodString + "JaxRsClientSpockMethodRequestProcessingBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | ".method('GET')" + "JaxRsClientJUnitMethodBodyBuilder" | { org.springframework.cloud.contract.spec.Contract dsl -> new JaxRsClientJUnitMethodBodyBuilder(dsl, properties) } | 'method("GET")' + } + + def "should generate a call with an url path and query parameters with JUnit - we'll put it into docs"() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath('/users') { + queryParameters { + parameter 'limit': $(client(equalTo("20")), server(equalTo("10"))) + parameter 'offset': $(client(containing("20")), server(equalTo("20"))) + parameter 'filter': "email" + parameter 'sort': equalTo("name") + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("55")) + parameter 'age': $(client(notMatching("^\\w*\$")), server("99")) + parameter 'name': $(client(matching("Denis.*")), server("Denis.Stepanov")) + parameter 'email': "bob@email.com" + parameter 'hello': $(client(matching("Denis.*")), server(absent())) + parameter 'hello': absent() + } + } + } + response { + status 200 + body """ + { + "property1": "a" + } + """ + } + } + MethodBodyBuilder builder = new JaxRsClientJUnitMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedResponse = +// tag::jaxrs[] +''' + // 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() + .method("GET"); + + String responseAsString = response.readEntity(String.class); + + // then: + assertThat(response.getStatus()).isEqualTo(200); + // and: + DocumentContext parsedJson = JsonPath.parse(responseAsString); + assertThatJson(parsedJson).field("property1").isEqualTo("a"); +''' +// end::jaxrs[] + stripped(test) == stripped(expectedResponse) + and: + stubMappingIsValidWireMockStub(contractDsl) + } + + private String stripped(String string) { + return string.stripMargin().stripIndent().replace('\t', '').replace('\n', '').replace(' ','') + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy new file mode 100644 index 0000000000..2257459583 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MessagingMethodBodyBuilderSpec.groovy @@ -0,0 +1,447 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import spock.lang.Shared +import spock.lang.Specification +/** + * @author Marcin Grzejszczak + */ +class MessagingMethodBodyBuilderSpec extends Specification { + + @Shared ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(assertJsonSize: true) + + def "should work for triggered based messaging with Spock"() { + given: +// tag::trigger_method_dsl[] +def contractDsl = Contract.make { + label 'some_label' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('activemq:output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } +} +// end::trigger_method_dsl[] + MethodBodyBuilder builder = new SpockMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMessage = +// tag::trigger_method_test[] +''' + when: + bookReturnedTriggered() + + then: + def response = contractVerifierMessaging.receiveMessage('activemq:output') + assert response != null + response.getHeader('BOOK-NAME') == 'foo' + and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + assertThatJson(parsedJson).field("bookName").isEqualTo("foo") + +''' +// end::trigger_method_test[] + stripped(test) == stripped(expectedMessage) + } + + def "should work for triggered based messaging with JUnit"() { + given: + def contractDsl = Contract.make { + label 'some_label' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('activemq:output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } + } + MethodBodyBuilder builder = new JUnitMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMessage = +// tag::trigger_method_junit_test[] +''' + // when: + bookReturnedTriggered(); + + // then: + ContractVerifierMessage response = contractVerifierMessaging.receiveMessage("activemq:output"); + assertThat(response).isNotNull(); + assertThat(response.getHeader("BOOK-NAME")).isEqualTo("foo"); + // and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.getPayload())); + assertThatJson(parsedJson).field("bookName").isEqualTo("foo"); +''' +// end::trigger_method_junit_test[] + stripped(test) == stripped(expectedMessage) + } + + def "should generate tests triggered by a message for Spock"() { + given: + // tag::trigger_message_dsl[] +def contractDsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } +} + // end::trigger_message_dsl[] + MethodBodyBuilder builder = new SpockMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMessage = +// tag::trigger_message_spock[] +"""\ +given: + def inputMessage = contractVerifierMessaging.create( + '''{"bookName":"foo"}''', + ['sample': 'header'] + ) + +when: + contractVerifierMessaging.send(inputMessage, 'jms:input') + +then: + def response = contractVerifierMessaging.receiveMessage('jms:output') + assert response !- null + response.getHeader('BOOK-NAME') == 'foo' +and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + assertThatJson(parsedJson).field("bookName").isEqualTo("foo") +""" +// end::trigger_message_spock[] + stripped(test) == stripped(expectedMessage) + } + + def "should generate tests triggered by a message for JUnit"() { + given: + def contractDsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } + } + MethodBodyBuilder builder = new JUnitMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMessage = +// tag::trigger_message_junit[] +''' +// given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + "{\\"bookName\\":\\"foo\\"}" +, headers() + .header("sample", "header")); + +// when: + contractVerifierMessaging.send(inputMessage, "jms:input"); + +// then: + ContractVerifierMessage response = contractVerifierMessaging.receiveMessage("jms:output"); + assertThat(response).isNotNull(); + assertThat(response.getHeader("BOOK-NAME")).isEqualTo("foo"); +// and: + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.getPayload())); + assertThatJson(parsedJson).field("bookName").isEqualTo("foo"); +''' +// end::trigger_message_junit[] + stripped(test) == stripped(expectedMessage) + } + + def "should generate tests without destination, triggered by a message"() { + given: + // tag::trigger_no_output_dsl[] +def contractDsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } +} + // end::trigger_no_output_dsl[] + MethodBodyBuilder builder = new SpockMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMsg = +// tag::trigger_no_output_spock[] +''' +given: + def inputMessage = contractVerifierMessaging.create( + \'\'\'{"bookName":"foo"}\'\'\', + ['sample': 'header'] + ) + +when: + contractVerifierMessaging.send(inputMessage, 'jms:delete') + +then: + noExceptionThrown() + bookWasDeleted() +''' +// end::trigger_no_output_spock[] + stripped(test) == stripped(expectedMsg) + } + + def "should generate tests without destination, triggered by a message for JUnit"() { + given: + def contractDsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + MethodBodyBuilder builder = new JUnitMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMsg = +// tag::trigger_no_output_junit[] +''' +// given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + "{\\"bookName\\":\\"foo\\"}" +, headers() + .header("sample", "header")); + +// when: + contractVerifierMessaging.send(inputMessage, "jms:delete"); + +// then: + bookWasDeleted(); +''' +// end::trigger_no_output_junit[] + stripped(test) == stripped(expectedMsg) + } + + def "should generate tests without headers for JUnit"() { + given: + def contractDsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + } + } + MethodBodyBuilder builder = new JUnitMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMsg = +''' + // given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + "{\\"bookName\\":\\"foo\\"}" + , headers() + .header("sample", "header")); + + // when: + contractVerifierMessaging.send(inputMessage, "jms:input"); + + // then: + ContractVerifierMessage response = contractVerifierMessaging.receiveMessage("jms:output"); + assertThat(response).isNotNull(); + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.getPayload())); + assertThatJson(parsedJson).field("bookName").isEqualTo("foo"); +''' + stripped(test) == stripped(expectedMsg) + } + + def "should generate tests without headers for Spock"() { + given: + def contractDsl = Contract.make { + label 'some_label' + input { + messageFrom('jms:input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('jms:output') + body([ + bookName: 'foo' + ]) + } + } + MethodBodyBuilder builder = new SpockMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMsg = +""" + given: + def inputMessage = contractVerifierMessaging.create('''{"bookName":"foo"}''' + ,[ + 'sample': 'header' + ]) + + when: + contractVerifierMessaging.send(inputMessage, 'jms:input') + + then: + def response = contractVerifierMessaging.receiveMessage('jms:output') + assert response != null + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.payload)) + assertThatJson(parsedJson).field("bookName").isEqualTo("foo") +""" + stripped(test) == stripped(expectedMsg) + } + + private String stripped(String text) { + return text.stripIndent().stripMargin().replace(' ', '').replace('\n', '').replace('\t', '').replaceAll("\\W", "") + } + + def "should generate tests without headers for JUnit with consumer / producer notation"() { + given: + def contractDsl = + // tag::consumer_producer[] +Contract.make { + label 'some_label' + input { + messageFrom value(consumer('jms:output'), producer('jms:input')) + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo $(consumer('jms:input'), producer('jms:output')) + body([ + bookName: 'foo' + ]) + } +} + // end::consumer_producer[] + MethodBodyBuilder builder = new JUnitMessagingMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + String expectedMsg = + ''' + // given: + ContractVerifierMessage inputMessage = contractVerifierMessaging.create( + "{\\"bookName\\":\\"foo\\"}" + , headers() + .header("sample", "header")); + + // when: + contractVerifierMessaging.send(inputMessage, "jms:input"); + + // then: + ContractVerifierMessage response = contractVerifierMessaging.receiveMessage("jms:output"); + assertThat(response).isNotNull(); + DocumentContext parsedJson = JsonPath.parse(contractVerifierObjectMapper.writeValueAsString(response.getPayload())); + assertThatJson(parsedJson).field("bookName").isEqualTo("foo"); +''' + stripped(test) == stripped(expectedMsg) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcMethodBodyBuilderSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcMethodBodyBuilderSpec.groovy new file mode 100644 index 0000000000..7f8dec46f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/MockMvcMethodBodyBuilderSpec.groovy @@ -0,0 +1,1447 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import org.springframework.cloud.contract.spec.Contract +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.dsl.WireMockStubVerifier +import spock.lang.Issue +import spock.lang.Shared +import spock.lang.Specification + +import java.util.regex.Pattern +/** + * @author Jakub Kubrynski, codearte.io + */ +class MockMvcMethodBodyBuilderSpec extends Specification implements WireMockStubVerifier { + + @Shared ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(assertJsonSize: true) + + @Shared + Contract dslWithOptionalsInString = Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + email: $(stub(optional(regex(email()))), test('abc@abc.com')), + callback_url: $(stub(regex(hostname())), test('http://partners.com')) + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + code: value(stub("123123"), test(optional("123123"))), + message: "User not found by email = [${value(test(regex(email())), stub('not.existing@user.com'))}]" + ) + } + } + + @Shared + Contract dslWithOptionals = Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + """ { + "email" : "${ + value(stub(optional(regex(email()))), test('abc@abc.com')) + }", + "callback_url" : "${ + value(client(regex(hostname())), server('http://partners.com')) + }" + } + """ + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + """ { + "code" : "${value(stub(123123), test(optional(123123)))}", + "message" : "User not found by email = [${ + value(server(regex(email())), client('not.existing@user.com')) + }]" + } + """ + ) + } + } + + def "should generate assertions for simple response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """{ + "property1": "a", + "property2": "b" +}""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").isEqualTo("b")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue("#187") + def "should generate assertions for null and boolean values with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """{ + "property1": "true", + "property2": null, + "property3": false +}""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("true")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").isNull()""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property3").isEqualTo(false)""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue("#79") + def "should generate assertions for simple response body constructed from map with a list with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body( + property1: 'a', + property2: [ + [a: 'sth'], + [b: 'sthElse'] + ] + ) + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property2").contains("a").isEqualTo("sth")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property2").hasSize(2)""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property2").contains("b").isEqualTo("sthElse")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue("#82") + def "should generate proper request when body constructed from map with a list #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + body( + items: ['HOP'] + ) + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains(bodyString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | """.body('''{\"items\":[\"HOP\"]}''')""" + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | '.body("{\\"items\\":[\\"HOP\\"]}")' + } + + @Issue("#88") + def "should generate proper request when body constructed from GString with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + body( + "property1=VAL1" + ) + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains(bodyString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | """.body('''property1=VAL1''')""" + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | '.body("\\"property1=VAL1\\"")' + } + + @Issue("185") + def "should generate assertions for a response body containing map with integers as keys with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body( + property: [ + 14: 0.0, + 7 : 0.0 + ] + ) + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property").field(7).isEqualTo(0.0)""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property").field(14).isEqualTo(0.0)""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate assertions for array in response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """[ +{ + "property1": "a" +}, +{ + "property2": "b" +}]""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).array().contains("property2").isEqualTo("b")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array().contains("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate assertions for array inside response body element with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body """{ + "property1": [ + { "property2": "test1"}, + { "property3": "test2"} + ] +}""" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property1").contains("property2").isEqualTo("test1")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).array("property1").contains("property3").isEqualTo("test2")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate assertions for nested objects in response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body '''\ +{ + "property1": "a", + "property2": {"property3": "b"} +} +''' + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").field("property3").isEqualTo("b")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate regex assertions for map objects in response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body( + property1: "a", + property2: value( + client('123'), + server(regex('[0-9]{3}')) + ) + ) + headers { + header('Content-Type': 'application/json') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").matches("[0-9]{3}")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate regex assertions for string objects in response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body("""{"property1":"a","property2":"${ + value(client('123'), server(regex('[0-9]{3}'))) + }"}""") + headers { + header('Content-Type': 'application/json') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property2").matches("[0-9]{3}")""") + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property1").isEqualTo("a")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue(["#126", "#143"]) + def "should generate escaped regex assertions for string objects in response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + url "test" + } + response { + status 200 + body("""{"property":" ${ + value(client('123'), server(regex('\\d+'))) + }"}""") + headers { + header('Content-Type': 'application/json') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + then: + blockBuilder.toString().contains("""assertThatJson(parsedJson).field("property").matches("\\\\d+")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate a call with an url path and query parameters with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + urlPath('/users') { + queryParameters { + parameter 'limit': $(client(equalTo("20")), server(equalTo("10"))) + parameter 'offset': $(client(containing("20")), server(equalTo("20"))) + parameter 'filter': "email" + parameter 'sort': equalTo("name") + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("55")) + parameter 'age': $(client(notMatching("^\\w*\$")), server("99")) + parameter 'name': $(client(matching("Denis.*")), server("Denis.Stepanov")) + parameter 'email': "bob@email.com" + parameter 'hello': $(client(matching("Denis.*")), server(absent())) + parameter 'hello': absent() + } + } + } + response { + status 200 + body """ + { + "property1": "a", + "property2": "b" + } + """ + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('get("/users?limit=10&offset=20&filter=email&sort=name&search=55&age=99&name=Denis.Stepanov&email=bob@email.com")') + test.contains('assertThatJson(parsedJson).field("property1").isEqualTo("a")') + test.contains('assertThatJson(parsedJson).field("property2").isEqualTo("b")') + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('#169') + def "should generate a call with an url path and query parameters with url containing a pattern with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + url($(stub(regex('/foo/[0-9]+')), test('/foo/123456'))) { + queryParameters { + parameter 'limit': $(client(equalTo("20")), server(equalTo("10"))) + parameter 'offset': $(client(containing("20")), server(equalTo("20"))) + parameter 'filter': "email" + parameter 'sort': equalTo("name") + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("55")) + parameter 'age': $(client(notMatching("^\\w*\$")), server("99")) + parameter 'name': $(client(matching("Denis.*")), server("Denis.Stepanov")) + parameter 'email': "bob@email.com" + parameter 'hello': $(client(matching("Denis.*")), server(absent())) + parameter 'hello': absent() + } + } + } + response { + status 200 + body """ + { + "property1": "a", + "property2": "b" + } + """ + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('get("/foo/123456?limit=10&offset=20&filter=email&sort=name&search=55&age=99&name=Denis.Stepanov&email=bob@email.com")') + test.contains('assertThatJson(parsedJson).field("property1").isEqualTo("a")') + test.contains('assertThatJson(parsedJson).field("property2").isEqualTo("b")') + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should generate test for empty body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method('POST') + url("/ws/payments") + body("") + } + response { + status 406 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(bodyString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | ".body('''''')" + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | ".body(\"\\\"\\\"\")" + } + + def "should generate test for String in response body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "POST" + url "test" + } + response { + status 200 + body "test" + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(bodyDefinitionString) + test.contains(bodyEvaluationString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyDefinitionString | bodyEvaluationString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | 'def responseBody = (response.body.asString())' | 'responseBody == "test"' + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | 'Object responseBody = (response.getBody().asString());' | 'assertThat(responseBody).isEqualTo("test");' + } + + @Issue('113') + def "should generate regex test for String in response header with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'POST' + url $(client(regex('/partners/[0-9]+/users')), server('/partners/1000/users')) + headers { header 'Content-Type': 'application/json' } + body( + first_name: 'John', + last_name: 'Smith', + personal_id: '12345678901', + phone_number: '500500500', + invitation_token: '00fec7141bb94793bfe7ae1d0f39bda0', + password: 'john' + ) + } + response { + status 201 + headers { + header 'Location': $(client('http://localhost/partners/1000/users/1001'), server(regex('http://localhost/partners/[0-9]+/users/[0-9]+'))) + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(headerEvaluationString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | headerEvaluationString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | '''response.header('Location') ==~ java.util.regex.Pattern.compile('http://localhost/partners/[0-9]+/users/[0-9]+')''' + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | 'assertThat(response.header("Location")).matches("http://localhost/partners/[0-9]+/users/[0-9]+");' + } + + @Issue('115') + def "should generate regex with helper method with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'POST' + url $(client(regex('/partners/[0-9]+/users')), server('/partners/1000/users')) + headers { header 'Content-Type': 'application/json' } + body( + first_name: 'John', + last_name: 'Smith', + personal_id: '12345678901', + phone_number: '500500500', + invitation_token: '00fec7141bb94793bfe7ae1d0f39bda0', + password: 'john' + ) + } + response { + status 201 + headers { + header 'Location': $(client('http://localhost/partners/1000/users/1001'), server(regex("^${hostname()}/partners/[0-9]+/users/[0-9]+"))) + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(headerEvaluationString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | headerEvaluationString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | '''response.header('Location') ==~ java.util.regex.Pattern.compile('^((http[s]?|ftp):\\/)\\/?([^:\\/\\s]+)(:[0-9]{1,5})?/partners/[0-9]+/users/[0-9]+')''' + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | 'assertThat(response.header("Location")).matches("^((http[s]?|ftp):/)/?([^:/s]+)(:[0-9]{1,5})?/partners/[0-9]+/users/[0-9]+");' + } + + def "should work with more complex stuff and jsonpaths with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + priority 10 + request { + method 'POST' + url '/validation/client' + headers { + header 'Content-Type': 'application/json' + } + body( + bank_account_number: '0014282912345698765432161182', + email: 'foo@bar.com', + phone_number: '100299300', + personal_id: 'ABC123456' + ) + } + + response { + status 200 + body(errors: [ + [property: "bank_account_number", message: "incorrect_format"] + ]) + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains("""assertThatJson(parsedJson).array("errors").contains("property").isEqualTo("bank_account_number")""") + test.contains("""assertThatJson(parsedJson).array("errors").contains("message").isEqualTo("incorrect_format")""") + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should work properly with GString url with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + + request { + method 'PUT' + url "/partners/${value(client(regex('^[0-9]*$')), server('11'))}/agents/11/customers/09665703Z" + headers { + header 'Content-Type': 'application/json' + } + body( + first_name: 'Josef', + ) + } + response { + status 422 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('''/partners/11/agents/11/customers/09665703Z''') + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + def "should resolve properties in GString with regular expression with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + email: $(client(regex(email())), server('not.existing@user.com')), + callback_url: $(client(regex(hostname())), server('http://partners.com')) + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + code: 4, + message: "User not found by email = [${value(server(regex(email())), client('not.existing@user.com'))}]" + ) + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains("""assertThatJson(parsedJson).field("message").matches("User not found by email = \\\\\\\\[[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\\\\\.[a-zA-Z]{2,4}\\\\\\\\]")""") + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('42') + def "should not omit the optional field in the test creation with MockMvcSpockMethodBodyBuilder"() { + given: + MethodBodyBuilder builder = new MockMvcSpockMethodRequestProcessingBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('''"email":"abc@abc.com"''') + test.contains("""assertThatJson(parsedJson).field("code").matches("(123123)?")""") + !test.contains('''REGEXP''') + !test.contains('''OPTIONAL''') + !test.contains('''OptionalProperty''') + where: + contractDsl << [dslWithOptionals, dslWithOptionalsInString] + } + + @Issue('42') + def "should not omit the optional field in the test creation with MockMvcJUnitMethodBodyBuilder"() { + given: + MethodBodyBuilder builder = new MockMvcJUnitMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('\\"email\\":\\"abc@abc.com\\"') + test.contains('assertThatJson(parsedJson).field("code").matches("(123123)?");') + !test.contains('''REGEXP''') + !test.contains('''OPTIONAL''') + !test.contains('''OptionalProperty''') + where: + contractDsl << [dslWithOptionals, dslWithOptionalsInString] + } + + @Issue('72') + def "should make the execute method work with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method """PUT""" + url """/fraudcheck""" + body(""" + { + "clientPesel":"${ + value(client(regex('[0-9]{10}')), server('1234567890')) + }", + "loanAmount":123.123 + } + """ + ) + headers { + header("""Content-Type""", """application/vnd.fraud.v1+json""") + } + + } + response { + status 200 + body("""{ + "fraudCheckStatus": "OK", + "rejectionReason": ${ + value(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + } +}""") + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + header 'Location': value( + stub(null), + test(execute('assertThatLocationIsNull($it)')) + ) + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + String test = blockBuilder.toString() + then: + assertionStrings.each { String assertionString -> + assert test.contains(assertionString) + } + where: + methodBuilderName | methodBuilder | assertionStrings + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | ['''assertThatRejectionReasonIsNull(parsedJson.read('$.rejectionReason'))''', '''assertThatLocationIsNull(response.header('Location'))'''] + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | ['''assertThatRejectionReasonIsNull(parsedJson.read("$.rejectionReason"))''', '''assertThatLocationIsNull(response.header("Location"))'''] + } + + def "should support inner map and list definitions with #methodBuilderName"() { + given: + + Pattern PHONE_NUMBER = Pattern.compile(/[+\w]*/) + Pattern ANYSTRING = Pattern.compile(/.*/) + Pattern NUMBERS = Pattern.compile(/[\d\.]*/) + Pattern DATETIME = ANYSTRING + + Contract contractDsl = Contract.make { + request { + method "PUT" + url "/v1/payments/e86df6f693de4b35ae648464c5b0dc09/client_data" + headers { + header('Content-Type': 'application/json') + } + body( + client: [ + first_name : $(stub(regex(onlyAlphaUnicode())), test('Denis')), + last_name : $(stub(regex(onlyAlphaUnicode())), test('FakeName')), + email : $(stub(regex(email())), test('fakemail@fakegmail.com')), + fax : $(stub(PHONE_NUMBER), test('+xx001213214')), + phone : $(stub(PHONE_NUMBER), test('2223311')), + data_of_birth: $(stub(DATETIME), test('2002-10-22T00:00:00Z')) + ], + client_id_card: [ + id : $(stub(ANYSTRING), test('ABC12345')), + date_of_issue: $(stub(ANYSTRING), test('2002-10-02T00:00:00Z')), + address : [ + street : $(stub(ANYSTRING), test('Light Street')), + city : $(stub(ANYSTRING), test('Fire')), + region : $(stub(ANYSTRING), test('Skys')), + country: $(stub(ANYSTRING), test('HG')), + zip : $(stub(NUMBERS), test('658965')) + ] + ], + incomes_and_expenses: [ + monthly_income : $(stub(NUMBERS), test('0.0')), + monthly_loan_repayments: $(stub(NUMBERS), test('100')), + monthly_living_expenses: $(stub(NUMBERS), test('22')) + ], + additional_info: [ + allow_to_contact: $(stub(optional(regex(anyBoolean()))), test('true')) + ] + ) + } + response { + status 200 + headers { + header('Content-Type': 'application/json') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains bodyString + !test.contains("clientValue") + !test.contains("cursor") + where: + methodBuilderName | methodBuilder | bodyString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | '"street":"Light Street"' + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | '\\"street\\":\\"Light Street\\"' + + } + + def "shouldn't generate unicode escape characters with #methodBuilderName"() { + given: + Pattern ONLY_ALPHA_UNICODE = Pattern.compile(/[\p{L}]*/) + + Contract contractDsl = Contract.make { + request { + method "PUT" + url "/v1/payments/e86df6f693de4b35ae648464c5b0dc09/енев" + headers { + header('Content-Type': 'application/json') + } + body( + client: [ + first_name: $(stub(ONLY_ALPHA_UNICODE), test('Пенева')), + last_name : $(stub(ONLY_ALPHA_UNICODE), test('Пенева')) + ] + ) + } + response { + status 200 + headers { + header('Content-Type': 'application/json') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + !test.contains("\\u041f") + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('177') + def "should generate proper test code when having multiline body with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "PUT" + url "/multiline" + body('''hello, +World.''') + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.given(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(bodyString) + where: + methodBuilderName | methodBuilder | bodyString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | """'''hello, +World.'''""" + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | '\\"hello,\\nWorld.\\"' + } + + @Issue('180') + def "should generate proper test code when having multipart parameters with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "PUT" + url "/multipart" + headers { + header('content-type', 'multipart/form-data;boundary=AaB03x') + } + multipart( + formParameter: value(client(regex('.+')), server('"formParameterValue"')), + someBooleanParameter: value(client(regex('(true|false)')), server('true')), + file: named(value(client(regex('.+')), server('filename.csv')), value(client(regex('.+')), server('file content'))) + ) + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + for (String requestString : requestStrings) { + test.contains(requestString) + } + where: + methodBuilderName | methodBuilder | requestStrings + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | ["""'content-type', 'multipart/form-data;boundary=AaB03x'""", + """.param('formParameter', '"formParameterValue"'""", + """.param('someBooleanParameter', 'true')""", + """.multiPart('file', 'filename.csv', 'file content'.bytes)"""] + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | ['"content-type", "multipart/form-data;boundary=AaB03x"', + '.param("formParameter", "\\"formParameterValue\\"")', + '.param("someBooleanParameter", "true")', + '.multiPart("file", "filename.csv", "file content".getBytes());'] + } + + @Issue('180') + def "should generate proper test code when having multipart parameters with named as map with #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method "PUT" + url "/multipart" + multipart( + formParameter: value(client(regex('".+"')), server('"formParameterValue"')), + someBooleanParameter: value(client(regex('(true|false)')), server('true')), + file: named( + name: value(client(regex('.+')), server('filename.csv')), + content: value(client(regex('.+')), server('file content'))) + ) + } + response { + status 200 + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.given(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('.multiPart') + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('#216') + def "should parse JSON with arrays using Spock"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + urlPath('/auth/oauth/check_token') { + queryParameters { + parameter 'token': + value( + client(regex('^[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}')), + server('6973b31d-7140-402a-bca6-1cdb954e03a7') + ) + } + } + } + response { + status 200 + body( + authorities: [ + value(stub('ROLE_ADMIN'), test(regex('^[a-zA-Z0-9_\\- ]+$'))) + ] + ) + } + } + MethodBodyBuilder builder = new MockMvcSpockMethodRequestProcessingBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('''assertThatJson(parsedJson).array("authorities").arrayField().matches("^[a-zA-Z0-9_\\\\- ]+\\$").value()''') + } + + @Issue('#216') + def "should parse JSON with arrays using JUnit"() { + given: + Contract contractDsl = Contract.make { + request { + method "GET" + urlPath('/auth/oauth/check_token') { + queryParameters { + parameter 'token': + value( + client(regex('^[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}')), + server('6973b31d-7140-402a-bca6-1cdb954e03a7') + ) + } + } + } + response { + status 200 + body( + authorities: [ + value(stub('ROLE_ADMIN'), test(regex('^[a-zA-Z0-9_\\- ]+$'))) + ] + ) + } + } + MethodBodyBuilder builder = new MockMvcJUnitMethodBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('''assertThatJson(parsedJson).array("authorities").arrayField().matches("^[a-zA-Z0-9_\\\\- ]+$").value()''') + } + + def "should work with execution property"() { + given: + Contract contractDsl = Contract.make { + request { + method 'PUT' + url '/fraudcheck' + } + response { + status 200 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + } + + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + !test.contains('''assertThatJson(parsedJson).field("rejectionReason").isEqualTo("assertThatRejectionReasonIsNull("''') + test.contains('''assertThatRejectionReasonIsNull(''') + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('262') + def "should generate proper test code with map inside list"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + urlPath '/foos' + } + response { + status 200 + body([[id: value( + client('123'), + server(regex('[0-9]+')) + )], [id: value( + client('567'), + server(regex('[0-9]+')) + )]]) + headers { + header('Content-Type': 'application/json;charset=UTF-8') + } + } + } + MethodBodyBuilder builder = new MockMvcSpockMethodRequestProcessingBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.then(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('assertThatJson(parsedJson).array().contains("id").matches("[0-9]+")') + } + + @Issue('266') + def "should generate proper test code with top level array using #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + urlPath '/api/tags' + } + response { + status 200 + body(["Java", "Java8", "Spring", "SpringBoot", "Stream"]) + headers { + header('Content-Type': 'application/json;charset=UTF-8') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.then(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('assertThatJson(parsedJson).hasSize(5)') + test.contains('assertThatJson(parsedJson).arrayField().contains("Java8").value()') + test.contains('assertThatJson(parsedJson).arrayField().contains("Spring").value()') + test.contains('assertThatJson(parsedJson).arrayField().contains("Java").value()') + test.contains('assertThatJson(parsedJson).arrayField().contains("Stream").value()') + test.contains('assertThatJson(parsedJson).arrayField().contains("SpringBoot").value()') + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('266') + def "should generate proper test code with top level array or arrays using #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + urlPath '/api/categories' + } + response { + status 200 + body([["Programming", "Java"], ["Programming", "Java", "Spring", "Boot"]]) + headers { + header('Content-Type': 'application/json;charset=UTF-8') + } + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.then(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('assertThatJson(parsedJson).hasSize(2)') + test.contains('assertThatJson(parsedJson).array().arrayField().isEqualTo("Programming").value()') + test.contains('assertThatJson(parsedJson).array().arrayField().isEqualTo("Java").value()') + test.contains('assertThatJson(parsedJson).array().arrayField().isEqualTo("Spring").value()') + test.contains('assertThatJson(parsedJson).array().arrayField().isEqualTo("Boot").value()') + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('47') + def "should generate async body when async flag set in response"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + url '/test' + } + response { + status 200 + async() + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.appendTo(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains(bodyDefinitionString) + and: + stubMappingIsValidWireMockStub(contractDsl) + where: + methodBuilderName | methodBuilder | bodyDefinitionString + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } | '.when().async()' + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } | '.when().async()' + } + + def "should generate proper test code with array of primitives using #methodBuilderName"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + urlPath '/api/tags' + } + response { + status 200 + body('''{ + "partners":[ + { + "payment_methods":[ "BANK", "CASH" ] + } + ] + } + ''') + } + } + MethodBodyBuilder builder = methodBuilder(contractDsl) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.then(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('assertThatJson(parsedJson).array("partners").array("payment_methods").arrayField().isEqualTo("BANK").value()') + test.contains('assertThatJson(parsedJson).array("partners").array("payment_methods").arrayField().isEqualTo("CASH").value()') + where: + methodBuilderName | methodBuilder + "MockMvcSpockMethodBuilder" | { Contract dsl -> new MockMvcSpockMethodRequestProcessingBodyBuilder(dsl, properties) } + "MockMvcJUnitMethodBuilder" | { Contract dsl -> new MockMvcJUnitMethodBodyBuilder(dsl, properties) } + } + + @Issue('#273') + def "should not escape dollar in Spock regex tests"() { + given: + Contract contractDsl = Contract.make { + request { + method 'GET' + urlPath '/get' + } + response { + status 200 + body( code: 9, message: $(client('Wrong credentials'), server(regex('^(?!\\s*$).+'))) ) + } + } + MethodBodyBuilder builder = new MockMvcSpockMethodRequestProcessingBodyBuilder(contractDsl, properties) + BlockBuilder blockBuilder = new BlockBuilder(" ") + when: + builder.then(blockBuilder) + def test = blockBuilder.toString() + then: + test.contains('assertThatJson(parsedJson).field("message").matches("^(?!\\\\s*\\$).+")') + } + + + Contract dslForDocs = + // tag::dsl_example[] + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url '/api/12' + headers { + header 'Content-Type': 'application/vnd.org.springframework.cloud.contract.verifier.twitter-places-analyzer.v1+json' + } + body '''\ + [{ + "created_at": "Sat Jul 26 09:38:57 +0000 2014", + "id": 492967299297845248, + "id_str": "492967299297845248", + "text": "Gonna see you at Warsaw", + "place": + { + "attributes":{}, + "bounding_box": + { + "coordinates": + [[ + [-77.119759,38.791645], + [-76.909393,38.791645], + [-76.909393,38.995548], + [-77.119759,38.995548] + ]], + "type":"Polygon" + }, + "country":"United States", + "country_code":"US", + "full_name":"Washington, DC", + "id":"01fbe706f872cb32", + "name":"Washington", + "place_type":"city", + "url": "http://api.twitter.com/1/geo/id/01fbe706f872cb32.json" + } + }] + ''' + } + response { + status 200 + } + } + // end::dsl_example[] +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy new file mode 100644 index 0000000000..8bb9f1591f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/builder/SingleTestGeneratorSpec.groovy @@ -0,0 +1,149 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.builder + +import org.junit.Rule +import org.junit.rules.TemporaryFolder +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.config.TestMode +import org.springframework.cloud.contract.verifier.file.ContractMetadata +import spock.lang.Specification + +import static org.springframework.cloud.contract.verifier.config.TestFramework.JUNIT +import static org.springframework.cloud.contract.verifier.config.TestFramework.SPOCK + +class SingleTestGeneratorSpec extends Specification { + + @Rule + TemporaryFolder tmpFolder = new TemporaryFolder() + File file + + static List jUnitClassStrings = ['package test;', 'import com.jayway.jsonpath.DocumentContext;', 'import com.jayway.jsonpath.JsonPath;', + 'import org.junit.FixMethodOrder;', 'import org.junit.Ignore;', 'import org.junit.Test;', 'import org.junit.runners.MethodSorters;', + 'import static com.toomuchcoding.jsonassert.JsonAssertion.assertThatJson;', 'import static com.jayway.restassured.module.mockmvc.RestAssuredMockMvc.*;', + '@FixMethodOrder(MethodSorters.NAME_ASCENDING)', '@Test', '@Ignore', 'mport com.jayway.restassured.module.mockmvc.specification.MockMvcRequestSpecification;', + 'import com.jayway.restassured.response.ResponseOptions;', 'import static org.assertj.core.api.Assertions.assertThat;'] + + static List spockClassStrings = ['package test', 'import com.jayway.jsonpath.DocumentContext', 'import com.jayway.jsonpath.JsonPath', + 'import spock.lang.Ignore', 'import spock.lang.Specification', 'import spock.lang.Stepwise', + 'import static com.toomuchcoding.jsonassert.JsonAssertion.assertThatJson', 'import static com.jayway.restassured.module.mockmvc.RestAssuredMockMvc.*', + '@Stepwise', '@Ignore'] + + def setup() { + file = tmpFolder.newFile() + file.write(""" + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url 'url' + } + response { + status 200 + } + } +""") + } + + def "should build MockMvc test class for #testFramework"() { + given: + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(); + properties.targetFramework = testFramework + ContractMetadata contract = new ContractMetadata(file.toPath(), true, 1, 2) + contract.ignored >> true + contract.order >> 2 + SingleTestGenerator testGenerator = new SingleTestGenerator(properties) + + when: + String clazz = testGenerator.buildClass([contract], "test", "test") + + then: + classStrings.each { clazz.contains(it) } + + where: + testFramework | classStrings + JUNIT | jUnitClassStrings + SPOCK | spockClassStrings + } + + def "should build JaxRs test class for #testFramework"() { + given: + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(); + properties.testMode = TestMode.JAXRSCLIENT + properties.targetFramework = testFramework + ContractMetadata contract = new ContractMetadata(file.toPath(), true, 1, 2) + contract.ignored >> true + contract.order >> 2 + SingleTestGenerator testGenerator = new SingleTestGenerator(properties) + + when: + String clazz = testGenerator.buildClass([contract], "test", "test") + + then: + classStrings.each { clazz.contains(it) } + + where: + testFramework | classStrings + JUNIT | ['import static javax.ws.rs.client.Entity.*;', 'import javax.ws.rs.core.Response;'] + SPOCK | ['import static javax.ws.rs.client.Entity.*;'] + } + + def "should work if there is messaging and rest in one folder #testFramework"() { + given: + File secondFile = tmpFolder.newFile() + secondFile.write(""" + org.springframework.cloud.contract.spec.Contract.make { + label 'some_label' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } + } + """) + and: + ContractVerifierConfigProperties properties = new ContractVerifierConfigProperties(); + properties.targetFramework = testFramework + ContractMetadata contract = new ContractMetadata(file.toPath(), true, 1, 2) + contract.ignored >> true + contract.order >> 2 + and: + ContractMetadata contract2 = new ContractMetadata(secondFile.toPath(), true, 1, 2) + contract2.ignored >> true + contract2.order >> 2 + and: + SingleTestGenerator testGenerator = new SingleTestGenerator(properties) + + when: + String clazz = testGenerator.buildClass([contract, contract2], "test", "test") + + then: + classStrings.each { clazz.contains(it) } + clazz.contains('@Inject ContractVerifierMessaging') + + where: + testFramework | classStrings + JUNIT | jUnitClassStrings + SPOCK | spockClassStrings + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/WireMockGroovyDslSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/WireMockGroovyDslSpec.groovy new file mode 100755 index 0000000000..92c0f26a49 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/WireMockGroovyDslSpec.groovy @@ -0,0 +1,1577 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.dsl + +import groovy.json.JsonBuilder +import groovy.json.JsonSlurper +import org.springframework.cloud.contract.verifier.dsl.wiremock.WireMockStubStrategy +import org.springframework.cloud.contract.verifier.file.ContractMetadata +import org.springframework.cloud.contract.verifier.util.AssertionUtil +import spock.lang.Issue +import spock.lang.Specification + +class WireMockGroovyDslSpec extends Specification implements WireMockStubVerifier { + + def 'should convert groovy dsl stub to wireMock stub for the client side'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(~/\/[0-9]{2}/), server('/12')) + } + response { + status 200 + body( + id: value( + client('123'), + server(regex('[0-9]+')) + ), + surname: $( + client('Kowalsky'), + server('Lewandowski') + ), + name: 'Jan', + created: $(client('2014-02-02 12:23:43'), server({ currentDate(it) })) + ) + headers { + header 'Content-Type': 'text/plain' + } + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual(''' + { + "request" : { + "urlPattern" : "/[0-9]{2}", + "method" : "GET" + }, + "response" : { + "status" : 200, + "body" : "{\\"id\\":\\"123\\",\\"surname\\":\\"Kowalsky\\",\\"name\\":\\"Jan\\",\\"created\\":\\"2014-02-02 12:23:43\\"}", + "headers" : { + "Content-Type" : "text/plain" + } + } + } + ''', wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + @Issue("#79") + def 'should convert groovy dsl stub to wireMock stub for the client side with a body containing a map'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url '/ingredients' + headers { + header 'Content-Type': 'application/vnd.pl.devoxx.aggregatr.v1+json' + } + } + response { + status 200 + body( + ingredients: [ + [type: 'MALT', quantity: 100], + [type: 'WATER', quantity: 200], + [type: 'HOP', quantity: 300], + [type: 'YIEST', quantity: 400] + ] + ) + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual(''' +{ + "request" : { + "url" : "/ingredients", + "method" : "GET", + "headers" : { + "Content-Type" : { + "equalTo" : "application/vnd.pl.devoxx.aggregatr.v1+json" + } + } + }, + "response" : { + "status" : 200, + "body" : "{\\"ingredients\\":[{\\"type\\":\\"MALT\\",\\"quantity\\":100},{\\"type\\":\\"WATER\\",\\"quantity\\":200},{\\"type\\":\\"HOP\\",\\"quantity\\":300},{\\"type\\":\\"YIEST\\",\\"quantity\\":400}]}" + } +} +''', wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + @Issue("#86") + def 'should convert groovy dsl stub with GString and regexp'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('POST') + url('/ws/payments') + headers { + header("Content-Type": 'application/x-www-form-urlencoded') + } + body("""paymentType=INCOMING&transferType=BANK&amount=${ + value(client(regex('[0-9]{3}\\.[0-9]{2}')), server(500.00)) + }&bookingDate=${ + value(client(regex('[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])')), server('2015-05-18')) + }""") + } + response { + status 204 + body( + paymentId: value(client('4'), server(regex('[1-9][0-9]*'))), + foundExistingPayment: false + ) + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual(''' +{ + "request": { + "method": "POST", + "headers": { + "Content-Type": { + "equalTo": "application/x-www-form-urlencoded" + } + }, + "url": "/ws/payments", + "bodyPatterns": [ + { + "matches": "paymentType=INCOMING&transferType=BANK&amount=[0-9]{3}\\\\.[0-9]{2}&bookingDate=[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])" + } + ] + }, + "response": { + "status": 204, + "body": "{\\"paymentId\\":\\"4\\",\\"foundExistingPayment\\":false}" + } +} +''', wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should convert groovy dsl stub with Body as String to wireMock stub for the client side'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(~/\/[0-9]{2}/), server('/12')) + } + response { + status 200 + body("""\ + { + "id": "${value(client('123'), server('321'))}", + "surname": "${value(client('Kowalsky'), server('Lewandowski'))}", + "name": "Jan", + "created" : "${$(client('2014-02-02 12:23:43'), server('2999-09-09 01:23:45'))}" + } + """ + ) + headers { + header 'Content-Type': 'text/plain' + } + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "urlPattern" : "/[0-9]{2}", + "method" : "GET" + }, + "response" : { + "status" : 200, + "body" : "{\\"created\\":\\"2014-02-02 12:23:43\\",\\"id\\":\\"123\\",\\"name\\":\\"Jan\\",\\"surname\\":\\"Kowalsky\\"}", + "headers" : { + "Content-Type" : "text/plain" + } + } +} +'''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should convert groovy dsl stub with simple Body as String to wireMock stub for the client side'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(regex('/[0-9]{2}')), server('/12')) + body """ + { + "name": "Jan" + } + """ + } + response { + status 200 + body("""\ + { + "name": "Jan" + } + """ + ) + headers { + header 'Content-Type': 'text/plain' + } + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual(''' +{ + "request" : { + "urlPattern" : "/[0-9]{2}", + "method" : "GET", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.name == 'Jan')]" + } ] + }, + "response" : { + "status" : 200, + "body" : "{\\"name\\":\\"Jan\\"}", + "headers" : { + "Content-Type" : "text/plain" + } + } +} +''', wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should use equalToJson when body match is defined as map'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(~/\/[0-9]{2}/), server('/12')) + body( + id: value( + client('123'), + server({ regex('[0-9]+') }) + ), + surname: $( + client('Kowalsky'), + server('Lewandowski') + ), + name: 'Jan', + created: $(client('2014-02-02 12:23:43'), server({ currentDate(it) })) + ) + } + response { + status 200 + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "urlPattern" : "/[0-9]{2}", + "method" : "GET", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.created == '2014-02-02 12:23:43')]" + }, { + "matchesJsonPath" : "$[?(@.surname == 'Kowalsky')]" + }, { + "matchesJsonPath" : "$[?(@.name == 'Jan')]" + }, { + "matchesJsonPath" : "$[?(@.id == '123')]" + } ] + }, + "response" : { + "status" : 200 + } +} + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should use equalToJson when content type ends with json'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url "/users" + headers { + header "Content-Type", "customtype/json" + } + body """ + { + "name": "Jan" + } + """ + } + response { + status 200 + } + } + when: + String json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "url" : "/users", + "method" : "GET", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.name == 'Jan')]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "customtype/json" + } + } + }, + "response" : { + "status" : 200 + } +} + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should use equalToXml when content type ends with xml'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url "/users" + headers { + header "Content-Type", "customtype/xml" + } + body """${value(client('Jozo'), server('Denis'))}${ + value(client(""), server('1234567890')) + }""" + } + response { + status 200 + } + } + when: + String json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "url": "/users", + "headers": { + "Content-Type": { + "equalTo": "customtype/xml" + } + }, + "bodyPatterns": [ + { + "equalToXml":"Jozo<test>" + } + ] + }, + "response": { + "status": 200 + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should use equalToXml when content type is parsable xml'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url "/users" + body """${value(client('Jozo'), server('Denis'))}${ + value(client(""), server('1234567890')) + }""" + } + response { + status 200 + } + } + when: + String json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "url": "/users", + "bodyPatterns": [ + { + "equalToXml":"Jozo<test>" + } + ] + }, + "response": { + "status": 200 + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should support xml as a response body'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url "/users" + } + response { + status 200 + body """${value(client('Jozo'), server('Denis'))}${ + value(client(""), server('1234567890')) + }""" + } + } + when: + String json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "url": "/users" + }, + "response": { + "status": 200, + "body":"Jozo<test>" + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should use equalToJson'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url "/users" + body equalToJson('''{"name":"Jan"}''') + } + response { + status 200 + } + } + when: + String json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "url": "/users", + "bodyPatterns": [ + { + "equalToJson":"{\\"name\\":\\"Jan\\"}" + } + ] + }, + "response": { + "status": 200 + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should use equalToXml'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url "/users" + body equalToXml("""${value(client('Jozo'), server('Denis'))}${ + value(client(""), server('1234567890')) + }""") + } + response { + status 200 + } + } + when: + String json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "url": "/users", + "bodyPatterns": [ + { + "equalToXml":"Jozo<test>" + } + ] + }, + "response": { + "status": 200 + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should convert groovy dsl stub with regexp Body as String to wireMock stub for the client side'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(regex('/[0-9]{2}')), server('/12')) + body """ + { + "personalId": "${value(client(regex('^[0-9]{11}$')), server('57593728525'))}" + } + """ + } + response { + status 200 + body("""\ + { + "name": "Jan" + } + """ + ) + headers { + header 'Content-Type': 'text/plain' + } + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "urlPattern" : "/[0-9]{2}", + "method" : "GET", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.personalId =~ /^[0-9]{11}$/)]" + } ] + }, + "response" : { + "status" : 200, + "body" : "{\\"name\\":\\"Jan\\"}", + "headers" : { + "Content-Type" : "text/plain" + } + } +} +'''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should convert groovy dsl stub with a regexp and an integer in request body'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'PUT' + url '/fraudcheck' + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":123.123 + } + """ + ) + headers { + header('Content-Type', 'application/vnd.fraud.v1+json') + } + + } + response { + status 200 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "url" : "/fraudcheck", + "method" : "PUT", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.loanAmount == 123.123)]" + }, { + "matchesJsonPath" : "$[?(@.clientPesel =~ /[0-9]{10}/)]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/vnd.fraud.v1+json" + } + } + }, + "response" : { + "status" : 200, + "body" : "{\\"fraudCheckStatus\\":\\"OK\\",\\"rejectionReason\\":null}", + "headers" : { + "Content-Type" : "application/vnd.fraud.v1+json" + } + } +} +'''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def "should generate request with urlPath and queryParameters for client side"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath($(client("users"), server("items"))) { + queryParameters { + parameter 'limit': $(client(equalTo("20")), server("10")) + parameter 'offset': $(client(containing("10")), server("10")) + parameter 'filter': "email" + parameter 'sort': $(client(~/^[0-9]{10}$/), server("1234567890")) + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("10")) + parameter 'age': $(client(notMatching("^\\w*\$")), server(10)) + parameter 'name': $(client(matching("Denis.*")), server("Denis")) + parameter 'credit': absent() + } + } + } + response { + status 200 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "urlPath": "users", + "queryParameters": { + "offset": { + "contains": "10" + }, + "limit": { + "equalTo": "20" + }, + "filter": { + "equalTo": "email" + }, + "sort": { + "matches": "^[0-9]{10}$" + }, + "search": { + "doesNotMatch": "^/[0-9]{2}$" + }, + "age": { + "doesNotMatch": "^\\\\w*$" + }, + "name": { + "matches": "Denis.*" + }, + "credit": { + "absent": true + } + } + }, + "response": { + "status": 200, + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + @Issue('#230') + def "should generate request with urlPathPattern and queryParameters for client side\ + when both contains regular expressions"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath($(client(regex("/users/[0-9]+")), server("/users/1"))) { + queryParameters { + parameter 'search': $(client(notMatching(~/^\/[0-9]{2}$/)), server("10")) + } + } + } + response { + status 200 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "urlPathPattern": "/users/[0-9]+", + "queryParameters": { + "search": { + "doesNotMatch": "^/[0-9]{2}$" + } + } + }, + "response": { + "status": 200, + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + + def "should generate request with urlPath for client side"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath $(client("boxes"), server("items")) + } + response { + status 200 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "urlPath": "boxes" + }, + "response": { + "status": 200, + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def "should generate simple request with urlPath for client side"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath "boxes" + } + response { + status 200 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "urlPath": "boxes" + }, + "response": { + "status": 200, + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def "should not allow regexp in url for server value"() { + when: + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url(regex(/users\/[0-9]*/)) { + queryParameters { + parameter 'age': notMatching("^\\w*\$") + parameter 'name': matching("Denis.*") + } + } + } + response { + status 200 + } + } + then: + def e = thrown(IllegalStateException) + e.message.contains "Url can't be a pattern for the server side" + } + + def "should not allow regexp in query parameter for server value"() { + when: + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url("abc") { + queryParameters { + parameter 'age': $(client(notMatching("^\\w*\$")), server(regex(".*"))) + } + } + } + response { + status 200 + } + } + then: + def e = thrown(IllegalStateException) + e.message.contains "Query parameter 'age' can't be a pattern for the server side" + } + + def "should not allow query parameter unresolvable for a server value"() { + when: + org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath("users") { + queryParameters { + parameter 'age': notMatching("^\\w*\$") + parameter 'name': matching("Denis.*") + } + } + } + response { + status 200 + } + } + then: + def e = thrown(IllegalStateException) + e.message.contains "Query parameter 'age' can't be of a matching type: NOT_MATCHING for the server side" + } + + def "should not allow query parameter with a different absent variation for server/client"() { + when: + org.springframework.cloud.contract.spec.Contract.make dsl + then: + def e = thrown(IllegalStateException) + e.message.contains "Absent cannot only be used only on one side" + where: + dsl << [ + { + request { + method 'GET' + urlPath("users") { + queryParameters { + parameter 'name': $(client(absent()), server("")) + } + } + } + response { + status 200 + } + }, + { + request { + method 'GET' + urlPath("users") { + queryParameters { + parameter 'name': $(client(""), server(absent())) + } + } + } + response { + status 200 + } + }, + { + request { + method 'GET' + urlPath("users") { + queryParameters { + parameter 'name': $(client(absent()), server(matching("abc"))) + } + } + } + response { + status 200 + } + } + ] + } + + def "should generate request with url and queryParameters for client side"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + url($(client(regex(/users\/[0-9]*/)), server("users/123"))) { + queryParameters { + parameter 'age': $(client(notMatching("^\\w*\$")), server(10)) + parameter 'name': $(client(matching("Denis.*")), server("Denis")) + } + } + } + response { + status 200 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "GET", + "urlPattern": "users/[0-9]*", + "queryParameters": { + "age": { + "doesNotMatch": "^\\\\w*$" + }, + "name": { + "matches": "Denis.*" + } + } + }, + "response": { + "status": 200, + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } + + def 'should convert groovy dsl stub with rich tree Body as String to wireMock stub for the client side'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('GET') + url $(client(~/\/[0-9]{2}/), server('/12')) + body """\ + { + "personalId": "${value(client(regex('[0-9]{11}')), server('57593728525'))}", + "firstName": "${value(client(regex('.*')), server('Bruce'))}", + "lastName": "${value(client(regex('.*')), server('Lee'))}", + "birthDate": "${value(client(regex('[0-9]{4}-[0-9]{2}-[0-9]{2}')), server('1985-12-12'))}", + "errors": [ + { + "propertyName": "${value(client(regex('[0-9]{2}')), server('04'))}", + "providerValue": "Test" + }, + { + "propertyName": "${value(client(regex('[0-9]{2}')), server('08'))}", + "providerValue": "Test" + } + ] + } + """ + } + response { + status 200 + body("""\ + { + "name": "Jan" + } + """ + ) + headers { + header 'Content-Type': 'text/plain' + } + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "urlPattern" : "/[0-9]{2}", + "method" : "GET", + "bodyPatterns" : [ { + "matchesJsonPath" : "$.errors[*][?(@.propertyName =~ /[0-9]{2}/)]" + }, { + "matchesJsonPath" : "$.errors[*][?(@.providerValue == 'Test')]" + }, { + "matchesJsonPath" : "$[?(@.lastName =~ /.*/)]" + }, { + "matchesJsonPath" : "$[?(@.firstName =~ /.*/)]" + }, { + "matchesJsonPath" : "$[?(@.birthDate =~ /[0-9]{4}-[0-9]{2}-[0-9]{2}/)]" + }, { + "matchesJsonPath" : "$[?(@.personalId =~ /[0-9]{11}/)]" + }] + }, + "response" : { + "status" : 200, + "body" : "{\\"name\\":\\"Jan\\"}", + "headers" : { + "Content-Type" : "text/plain" + } + } +} + '''), wireMockStub) + } + + def 'should use regexp matches when request body match is defined using a map with a pattern'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'POST' + url '/reissue-payment-order' + body( + loanNumber: "999997001", + amount: value(client(regex('[0-9.]+')), server('100.00')), + currency: "DKK", + applicationName: value(client(regex('.*')), server("Auto-Repayments")), + username: value(client(regex('.*')), server("scheduler")), + cardId: 1 + ) + } + response { + status 200 + body ''' + { + "status": "OK" + } + ''' + headers { + header 'Content-Type': 'application/json' + } + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "url" : "/reissue-payment-order", + "method" : "POST", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.loanNumber == '999997001')]" + }, { + "matchesJsonPath" : "$[?(@.username =~ /.*/)]" + }, { + "matchesJsonPath" : "$[?(@.amount =~ /[0-9.]+/)]" + }, { + "matchesJsonPath" : "$[?(@.cardId == 1)]" + }, { + "matchesJsonPath" : "$[?(@.currency == 'DKK')]" + }, { + "matchesJsonPath" : "$[?(@.applicationName =~ /.*/)]" + } ] + }, + "response" : { + "status" : 200, + "body" : "{\\"status\\":\\"OK\\"}", + "headers" : { + "Content-Type" : "application/json" + } + } +} + '''), json) + } + + def "should generate stub for empty body"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('POST') + url("test") + body("") + } + response { + status 406 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "POST", + "url": "test", + "bodyPatterns": [ + { + "equalTo": "" + } + ] + }, + "response": { + "status": 406 + } + } +'''), json) + } + + def "should generate stub with priority"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + priority 9 + request { + method('POST') + url("test") + } + response { + status 406 + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "priority": 9, + "request": { + "method": "POST", + "url": "test" + }, + "response": { + "status": 406 + } + } + '''), json) + } + + @Issue("#127") + def 'should use "test" as an alias for "server"'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('POST') + body( + property: value(stub("value"), test("value")) + ) + } + response { + status 200 + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' +{ + "request" : { + "method" : "POST", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.property == 'value')]" + } ] + }, + "response" : { + "status" : 200 + } +} + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + @Issue("#121") + def 'should generate stub with empty list as a value of a field'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method('POST') + body( + values: [] + ) + } + response { + status 200 + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request": { + "method": "POST", + "bodyPatterns": [ + { + "equalToJson": "{\\"values\\":[]}" + } + ] + }, + "response": { + "status": 200 + } + } + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should generate stub properly resolving GString with regular expression'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + email: $(client(regex(email())), server('not.existing@user.com')), + callback_url: $(client(regex(hostname())), server('http://partners.com')) + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + code: 4, + message: "User not found by email = [${value(server(regex(email())), client('not.existing@user.com'))}]" + ) + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request" : { + "url" : "/users/password", + "method" : "POST", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.callback_url =~ /((http[s]?|ftp):\\\\/)\\\\/?([^:\\\\/\\\\s]+)(:[0-9]{1,5})?/)]" + }, { + "matchesJsonPath" : "$[?(@.email =~ /[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,4}/)]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/json" + } + } + }, + "response" : { + "status" : 404, + "body" : "{\\"code\\":4,\\"message\\":\\"User not found by email = [not.existing@user.com]\\"}", + "headers" : { + "Content-Type" : "application/json" + } + }, + "priority" : 1 + } + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + def 'should generate stub properly resolving GString with regular expression in url'() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + + request { + method 'PUT' + url "/partners/${value(client(regex('^[0-9]*$')), server('11'))}/agents/11/customers/09665703Z" + headers { + header 'Content-Type': 'application/json' + } + body( + first_name: 'Josef', + ) + } + response { + status 422 + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request" : { + "urlPattern" : "/partners/^[0-9]*$/agents/11/customers/09665703Z", + "method" : "PUT", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.first_name == 'Josef')]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/json" + } + } + }, + "response" : { + "status" : 422 + } + } + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + @Issue('42') + def 'should generate stub without optional parameters'() { + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), contractDsl).toWireMockClientStub() + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request" : { + "url" : "/users/password", + "method" : "POST", + "bodyPatterns" : [ { + "matchesJsonPath" : "$[?(@.callback_url =~ /((http[s]?|ftp):\\\\/)\\\\/?([^:\\\\/\\\\s]+)(:[0-9]{1,5})?/)]" + }, { + "matchesJsonPath" : "$[?(@.email =~ /([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,4})?/)]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/json" + } + } + }, + "response" : { + "status" : 404, + "body" : "{\\"code\\":\\"123123\\",\\"message\\":\\"User not found by email = [not.existing@user.com]\\"}", + "headers" : { + "Content-Type" : "application/json" + } + }, + "priority" : 1 + } + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + where: + contractDsl << [ + org.springframework.cloud.contract.spec.Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + email: $(stub(optional(regex(email()))), test('abc@abc.com')), + callback_url: $(stub(regex(hostname())), test('http://partners.com')) + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + code: $(stub("123123"), test(optional("123123"))), + message: "User not found by email = [${value(test(regex(email())), stub('not.existing@user.com'))}]" + ) + } + }, + org.springframework.cloud.contract.spec.Contract.make { + priority 1 + request { + method 'POST' + url '/users/password' + headers { + header 'Content-Type': 'application/json' + } + body( + """ { + "email" : "${value(stub(optional(regex(email()))), test('abc@abc.com'))}", + "callback_url" : "${value(client(regex(hostname())), server('http://partners.com'))}" + } + """ + ) + } + response { + status 404 + headers { + header 'Content-Type': 'application/json' + } + body( + """ { + "code" : "${value(stub(123123), test(optional(123123)))}", + "message" : "User not found by email = [${value(server(regex(email())), client('not.existing@user.com'))}]" + } + """ + ) + } + } + ] + } + + String toJsonString(value) { + new JsonBuilder(value).toPrettyString() + } + + Object parseJson(json) { + new JsonSlurper().parseText(json) + } + + String toWireMockClientJsonStub(groovyDsl) { + new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), groovyDsl).toWireMockClientStub() + } + + @Issue('180') + def 'should generate stub with multipart parameters'() { + given: + org.springframework.cloud.contract.spec.Contract contractDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method "PUT" + url "/multipart" + multipart( + formParameter: value(client(regex('".+"')), server('"formParameterValue"')), + someBooleanParameter: value(client(regex('(true|false)')), server('true')), + file: named( + name: value(client(regex('.+')), server('filename.csv')), + content: value(client(regex('.+')), server('file content'))) + ) + } + response { + status 200 + } + } + when: + String wireMockStub = new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), contractDsl).toWireMockClientStub() + then: + println wireMockStub + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request" : { + "url" : "/multipart", + "method" : "PUT", + "bodyPatterns" : [ { + "matches" : ".*--(.*)\\r\\nContent-Disposition: form-data; name=\\"formParameter\\"\\r\\n(Content-Type: .*\\r\\n)?(Content-Length: \\\\d+\\r\\n)?\\r\\n\\".+\\"\\r\\n--\\\\1.*" + }, { + "matches" : ".*--(.*)\\r\\nContent-Disposition: form-data; name=\\"someBooleanParameter\\"\\r\\n(Content-Type: .*\\r\\n)?(Content-Length: \\\\d+\\r\\n)?\\r\\n(true|false)\\r\\n--\\\\1.*" + }, { + "matches" : ".*--(.*)\\r\\nContent-Disposition: form-data; name=\\"file\\"; filename=\\".+\\"\\r\\n(Content-Type: .*\\r\\n)?(Content-Length: \\\\d+\\r\\n)?\\r\\n.+\\r\\n--\\\\1.*" + } ] + }, + "response" : { + "status" : 200 + } + } + '''), wireMockStub) + and: + stubMappingIsValidWireMockStub(wireMockStub) + } + + @Issue('#219') + def "should generate request with an optional queryParameter for client side"() { + given: + org.springframework.cloud.contract.spec.Contract groovyDsl = org.springframework.cloud.contract.spec.Contract.make { + request { + method 'GET' + urlPath ('/some/api') { + queryParameters { + parameter 'size': value( + client(regex('[0-9]+')), + server(1) + ) + parameter 'page': value( + client(regex('[0-9]+')), + server(0) + ) + parameter sort: value( + client(optional(regex('^[a-z]+$'))), + server('id') + ) + } + } + } + response { + status 200 + body( + content: [[ + id : '00000000-0000-0000-0000-000000000000', + type : 'Extraordinary', + state : 'ACTIVE', + ]], + totalPages: 1, + totalElements: 1, + last: true, + sort: [[ + direction: 'ASC', + property: 'id', + ignoreCase: false, + nullHandling: 'NATIVE', + ascending: true + ]], + first: true, + numberOfElements: 1, + size: 1, + number: 0 + ) + } + } + when: + def json = toWireMockClientJsonStub(groovyDsl) + then: + AssertionUtil.assertThatJsonsAreEqual((''' + { + "request" : { + "urlPath" : "/some/api", + "method" : "GET", + "queryParameters" : { + "size" : { + "matches" : "[0-9]+" + }, + "page" : { + "matches" : "[0-9]+" + }, + "sort" : { + "matches" : "(^[a-z]+$)?" + } + } + }, + "response" : { + "status" : 200, + "body" : "{\\"content\\":[{\\"id\\":\\"00000000-0000-0000-0000-000000000000\\",\\"type\\":\\"Extraordinary\\",\\"state\\":\\"ACTIVE\\"}],\\"totalPages\\":1,\\"totalElements\\":1,\\"last\\":true,\\"sort\\":[{\\"direction\\":\\"ASC\\",\\"property\\":\\"id\\",\\"ignoreCase\\":false,\\"nullHandling\\":\\"NATIVE\\",\\"ascending\\":true}],\\"first\\":true,\\"numberOfElements\\":1,\\"size\\":1,\\"number\\":0}" + } + } + '''), json) + and: + stubMappingIsValidWireMockStub(json) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/WireMockStubVerifier.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/WireMockStubVerifier.groovy new file mode 100644 index 0000000000..825b913136 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/WireMockStubVerifier.groovy @@ -0,0 +1,39 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.dsl + +import com.github.tomakehurst.wiremock.stubbing.StubMapping +import org.springframework.cloud.contract.verifier.dsl.wiremock.WireMockStubStrategy +import org.springframework.cloud.contract.verifier.file.ContractMetadata + +import java.util.regex.Pattern + +trait WireMockStubVerifier { + + void stubMappingIsValidWireMockStub(String mappingDefinition) { + StubMapping stubMapping = StubMapping.buildFrom(mappingDefinition) + stubMapping.request.bodyPatterns.findAll { it.matches }.every { + Pattern.compile(it.matches) + } + assert !mappingDefinition.contains('org.springframework.cloud.contract.spec.internal') + } + + void stubMappingIsValidWireMockStub(org.springframework.cloud.contract.spec.Contract contractDsl) { + stubMappingIsValidWireMockStub(new WireMockStubStrategy("Test", new ContractMetadata(null, false, 0, null), contractDsl).toWireMockClientStub()) + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/internal/ExecutionPropertySpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/internal/ExecutionPropertySpec.groovy new file mode 100644 index 0000000000..65b3997d99 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/internal/ExecutionPropertySpec.groovy @@ -0,0 +1,35 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import spock.lang.Specification + +class ExecutionPropertySpec extends Specification { + + def 'should insert passed value in place of $it placeholder'() { + given: + String commandToExecute = 'commandToExecute($it)' + ExecutionProperty executionProperty = new ExecutionProperty(commandToExecute) + and: + String valueToInsert = 'someObject.itsValue' + when: + String commandWithInsertedValue = executionProperty.insertValue(valueToInsert) + then: + 'commandToExecute(someObject.itsValue)' == commandWithInsertedValue + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/internal/RegexPatternsSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/internal/RegexPatternsSpec.groovy new file mode 100644 index 0000000000..80b9333bce --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/dsl/internal/RegexPatternsSpec.groovy @@ -0,0 +1,78 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.spec.internal + +import spock.lang.Specification + +import java.util.regex.Pattern + +class RegexPatternsSpec extends Specification { + + RegexPatterns regexPatterns = new RegexPatterns() + + def "should generate a regex for ip address [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.ipAddress()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + '123.123.123.123' || true + 'a.b.' || false + } + + def "should generate a regex for hostname [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.hostname()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + 'https://asd.com' || true + 'https://asd.com:8080' || true + 'https://localhost' || true + 'https://localhost:8080' || true + 'https://asd.com/asd' || false + 'asd.com' || false + } + + def "should generate a regex for email [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.email()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + 'asd@asd.com' || true + 'a.b.' || false + } + + def "should generate a regex for url [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.url()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + 'ftp://asd.com:9090/asd/a?a=b' || true + 'a.b.' || false + } + + def "should generate a regex for a number [#textToMatch] that is a match [#shouldMatch]"() { + expect: + shouldMatch == Pattern.compile(regexPatterns.number()).matcher(textToMatch).matches() + where: + textToMatch || shouldMatch + '1' || true + '1.0' || true + '0.1' || true + '.1' || true + '1.' || false + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/file/ContractFileScannerSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/file/ContractFileScannerSpec.groovy new file mode 100644 index 0000000000..73e7fc85c0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/file/ContractFileScannerSpec.groovy @@ -0,0 +1,76 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.file + +import com.google.common.collect.ListMultimap +import spock.lang.Specification + +import java.nio.file.Path + +/** + * @author Jakub Kubrynski, codearte.io + */ +class ContractFileScannerSpec extends Specification { + + def "should find contract files"() { + given: + File baseDir = new File(this.getClass().getResource("/directory/with/stubs").toURI()) + Set excluded = ["package/**"] as Set + Set ignored = ["other/different/**"] as Set + ContractFileScanner scanner = new ContractFileScanner(baseDir, excluded, ignored) + when: + ListMultimap result = scanner.findContracts() + then: + result.keySet().size() == 3 + result.get(baseDir.toPath().resolve("different")).size() == 1 + result.get(baseDir.toPath().resolve("other")).size() == 2 + and: + Collection ignoredSet = result.get(baseDir.toPath().resolve("other").resolve("different")) + ignoredSet.size() == 1 + ignoredSet.ignored == [true] + } + + def "should find contract files in strange directories"() { + given: + File baseDir = new File(this.getClass().getResource("/strange_[3.3.3]_directory").toURI()) + Set excluded = ["foo/**"] as Set + Set ignored = ["bar/**"] as Set + ContractFileScanner scanner = new ContractFileScanner(baseDir, excluded, ignored) + when: + ListMultimap result = scanner.findContracts() + then: + result.entries().size() == 2 + and: + Collection ignoredSet = result.get(baseDir.toPath().resolve("bar")) + ignoredSet.size() == 1 + ignoredSet.ignored == [true] + } + + def "should find contracts group in scenario"() { + given: + File baseDir = new File(this.getClass().getResource("/directory/with/scenario").toURI()) + ContractFileScanner scanner = new ContractFileScanner(baseDir, [] as Set, [] as Set) + when: + ListMultimap contracts = scanner.findContracts() + then: + contracts.values().size() == 3 + contracts.values().find { it.path.fileName.toString().startsWith('01') }.groupSize == 3 + contracts.values().find { it.path.fileName.toString().startsWith('01') }.order == 0 + contracts.values().find { it.path.fileName.toString().startsWith('02') }.order == 1 + contracts.values().find { it.path.fileName.toString().startsWith('03') }.order == 2 + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/util/JsonToJsonPathsConverterSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/util/JsonToJsonPathsConverterSpec.groovy new file mode 100644 index 0000000000..7bbf672dca --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/groovy/org/springframework/cloud/contract/verifier/util/JsonToJsonPathsConverterSpec.groovy @@ -0,0 +1,611 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import com.jayway.jsonpath.Configuration +import com.jayway.jsonpath.DocumentContext +import com.jayway.jsonpath.JsonPath +import com.jayway.jsonpath.Option +import com.toomuchcoding.jsonassert.JsonAssertion +import groovy.json.JsonOutput +import groovy.json.JsonSlurper +import net.minidev.json.JSONArray +import spock.lang.Specification + +import java.util.regex.Pattern + +class JsonToJsonPathsConverterSpec extends Specification { + + def 'should convert a json with list as root to a map of path to value'() { + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method() == """.array().field("some").field("nested").field("json").isEqualTo("with value")""" && + it.jsonPath() == '''$[*].some.nested[?(@.json == 'with value')]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").field("anothervalue").isEqualTo(4)""" && + it.jsonPath() == '''$[*].some.nested[?(@.anothervalue == 4)]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").array("withlist").contains("name").isEqualTo("name1")""" && + it.jsonPath() == '''$[*].some.nested.withlist[*][?(@.name == 'name1')]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").array("withlist").contains("name").isEqualTo("name2")""" && + it.jsonPath() == '''$[*].some.nested.withlist[*][?(@.name == 'name2')]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").array("withlist").field("anothernested").field("name").isEqualTo("name3")""" && + it.jsonPath() == '''$[*].some.nested.withlist[*].anothernested[?(@.name == 'name3')]''' + } + and: + assertThatJsonPathsInMapAreValid(json, pathAndValues) + where: + json << [ + ''' + [ { + "some" : { + "nested" : { + "json" : "with value", + "anothervalue": 4, + "withlist" : [ + { "name" :"name1"} , {"name": "name2"}, {"anothernested": { "name": "name3"} } + ] + } + } + }, + { + "someother" : { + "nested" : { + "json" : "with value", + "anothervalue": 4, + "withlist" : [ + { "name" :"name1"} , {"name": "name2"} + ] + } + } + } + ] + ''', + ''' + [{ + "someother" : { + "nested" : { + "json" : "with value", + "anothervalue": 4, + "withlist" : [ + { "name" :"name1"} , {"name": "name2"} + ] + } + } + }, + { + "some" : { + "nested" : { + "json" : "with value", + "anothervalue": 4, + "withlist" : [ + {"name": "name2"}, {"anothernested": { "name": "name3"} }, { "name" :"name1"} + ] + } + } + } + ]'''] + } + + def 'should convert a json with a map as root to a map of path to value'() { + given: + String json = ''' + { + "some" : { + "nested" : { + "json" : "with value", + "anothervalue": 4, + "withlist" : [ + { "name" :"name1"} , {"name": "name2"} + ] + } + } + } +''' + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method() == """.field("some").field("nested").field("json").isEqualTo("with value")""" && + it.jsonPath() == '''$.some.nested[?(@.json == 'with value')]''' + } + pathAndValues.find { + it.method() == """.field("some").field("nested").field("anothervalue").isEqualTo(4)""" && + it.jsonPath() == '''$.some.nested[?(@.anothervalue == 4)]''' + } + pathAndValues.find { + it.method() == """.field("some").field("nested").array("withlist").contains("name").isEqualTo("name1")""" && + it.jsonPath() == '''$.some.nested.withlist[*][?(@.name == 'name1')]''' + } + pathAndValues.find { + it.method() == """.field("some").field("nested").array("withlist").contains("name").isEqualTo("name2")""" && + it.jsonPath() == '''$.some.nested.withlist[*][?(@.name == 'name2')]''' + } + and: + assertThatJsonPathsInMapAreValid(json, pathAndValues) + } + + def 'should convert a json with a list'() { + given: + String json = ''' + { + "items" : ["HOP"] + } +''' + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method() == """.array("items").arrayField().isEqualTo("HOP").value()""" && + it.jsonPath() == '''$.items[?(@ == 'HOP')]''' + } + and: + assertThatJsonPathsInMapAreValid(json, pathAndValues) + } + + def 'should convert a json with null and boolean values'() { + given: + String json = ''' + { + "property1" : null, + "property2" : true + } +''' + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method() == """.field("property1").isNull()""" && + it.jsonPath() == '''$[?(@.property1 == null)]''' + } + pathAndValues.find { + it.method() == """.field("property2").isEqualTo(true)""" && + it.jsonPath() == '''$[?(@.property2 == true)]''' + } + } + + def "should convert numbers map"() { + given: + String json = ''' { + "extensions": {"7":28.00,"14":41.00,"30":60.00} + } + ''' + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method() == """.field("extensions").field("7").isEqualTo(28)""" && + it.jsonPath() == '''$.extensions[?(@.7 == 28)]''' + } + pathAndValues.find { + it.method() == """.field("extensions").field("14").isEqualTo(41)""" && + it.jsonPath() == '''$.extensions[?(@.14 == 41)]''' + } + pathAndValues.find { + it.method() == """.field("extensions").field("30").isEqualTo(60)""" && + it.jsonPath() == '''$.extensions[?(@.30 == 60)]''' + } + and: + assertThatJsonPathsInMapAreValid(json, pathAndValues) + } + + def 'should convert a json with a list of errors'() { + given: + String json = ''' + { + "errors" : [ + { "property" : "email", "message" : "inconsistent value" }, + { "property" : "email", "message" : "inconsistent value2" } + ] + } +''' + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method() == """.array("errors").contains("property").isEqualTo("email")""" && + it.jsonPath() == '''$.errors[*][?(@.property == 'email')]''' + } + pathAndValues.find { + it.method() == """.array("errors").contains("message").isEqualTo("inconsistent value")""" && + it.jsonPath() == '''$.errors[*][?(@.message == 'inconsistent value')]''' + } + pathAndValues.find { + it.method() == """.array("errors").contains("message").isEqualTo("inconsistent value2")""" && + it.jsonPath() == '''$.errors[*][?(@.message == 'inconsistent value2')]''' + } + and: + assertThatJsonPathsInMapAreValid(json, pathAndValues) + } + + def 'should convert a map json with a regex pattern'() { + given: + List json = [ + [some: + [nested: [ + json: "with value", + anothervalue: 4, + withlist: + [ + [name: "name2"], + [name: "name1"], + [anothernested: + [name: Pattern.compile("[a-zA-Z]+")] + ], + [age: "123456789"] + ] + ] + ] + ], + [someother: + [nested: [ + json: "with value", + anothervalue: 4, + withlist: + [ + [name: "name2"], + [name: "name1"] + ] + ] + ] + ] + ] + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(json) + then: + pathAndValues.find { + it.method() == """.array().field("some").field("nested").field("json").isEqualTo("with value")""" && + it.jsonPath() == '''$[*].some.nested[?(@.json == 'with value')]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").field("anothervalue").isEqualTo(4)""" && + it.jsonPath() == '''$[*].some.nested[?(@.anothervalue == 4)]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").array("withlist").contains("name").isEqualTo("name1")""" && + it.jsonPath() == '''$[*].some.nested.withlist[*][?(@.name == 'name1')]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").array("withlist").contains("name").isEqualTo("name2")""" && + it.jsonPath() == '''$[*].some.nested.withlist[*][?(@.name == 'name2')]''' + } + pathAndValues.find { + it.method() == """.array().field("some").field("nested").array("withlist").field("anothernested").field("name").matches("[a-zA-Z]+")""" && + it.jsonPath() == '''$[*].some.nested.withlist[*].anothernested[?(@.name =~ /[a-zA-Z]+/)]''' + } + when: + json.some.nested.withlist[0][2].anothernested.name = "Kowalski" + then: + assertThatJsonPathsInMapAreValid(JsonOutput.prettyPrint(JsonOutput.toJson(json)), pathAndValues) + } + + + def "should generate assertions for simple response body"() { + given: + String json = """{ + "property1": "a", + "property2": "b" + }""" + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method()== """.field("property1").isEqualTo("a")""" && + it.jsonPath() == """\$[?(@.property1 == 'a')]""" + } + pathAndValues.find { + it.method()== """.field("property2").isEqualTo("b")""" && + it.jsonPath() == """\$[?(@.property2 == 'b')]""" + } + and: + pathAndValues.size() == 2 + } + + def "should generate assertions for null and boolean values"() { + given: + String json = """{ + "property1": "true", + "property2": null, + "property3": false + }""" + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method()== """.field("property1").isEqualTo("true")""" && + it.jsonPath() == """\$[?(@.property1 == 'true')]""" + } + pathAndValues.find { + it.method()== """.field("property2").isNull()""" && + it.jsonPath() == """\$[?(@.property2 == null)]""" + } + pathAndValues.find { + it.method()== """.field("property3").isEqualTo(false)""" && + it.jsonPath() == """\$[?(@.property3 == false)]""" + } + and: + pathAndValues.size() == 3 + } + + def "should generate assertions for simple response body constructed from map with a list"() { + given: + Map json = [ + property1: 'a', + property2: [ + [a: 'sth'], + [b: 'sthElse'] + ] + ] + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(json) + then: + pathAndValues.find { + it.method()== """.field("property1").isEqualTo("a")""" && + it.jsonPath() == """\$[?(@.property1 == 'a')]""" + } + pathAndValues.find { + it.method()== """.array("property2").contains("a").isEqualTo("sth")""" && + it.jsonPath() == """\$.property2[*][?(@.a == 'sth')]""" + } + pathAndValues.find { + it.method()== """.array("property2").hasSize(2)""" && + it.jsonPath() == """\$.property2[*]""" + } + pathAndValues.find { + it.method()== """.array("property2").contains("b").isEqualTo("sthElse")""" && + it.jsonPath() == """\$.property2[*][?(@.b == 'sthElse')]""" + } + and: + pathAndValues.size() == 4 + } + + def "should generate assertions for a response body containing map with integers as keys"() { + given: + Map json = [ + property: [ + 14: 0.0, + 7 : 0.0 + ] + ] + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(json) + then: + pathAndValues.find { + it.method()== """.field("property").field(7).isEqualTo(0.0)""" && + it.jsonPath() == """\$.property[?(@.7 == 0.0)]""" + } + pathAndValues.find { + it.method()== """.field("property").field(14).isEqualTo(0.0)""" && + it.jsonPath() == """\$.property[?(@.14 == 0.0)]""" + } + and: + pathAndValues.size() == 2 + } + + def "should generate assertions for array in response body"() { + given: + String json = """[ + { + "property1": "a" + }, + { + "property2": "b" + }]""" + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method()== """.array().contains("property1").isEqualTo("a")""" && + it.jsonPath() == """\$[*][?(@.property1 == 'a')]""" + } + pathAndValues.find { + it.method()== """.array().contains("property2").isEqualTo("b")""" && + it.jsonPath() == """\$[*][?(@.property2 == 'b')]""" + } + pathAndValues.find { + it.method()== """.hasSize(2)""" && + it.jsonPath() == """\$""" + } + and: + pathAndValues.size() == 3 + } + + def "should generate assertions for array inside response body element"() { + given: + String json = """{ + "property1": [ + { "property2": "test1"}, + { "property3": "test2"} + ] +}""" + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method()== """.array("property1").contains("property2").isEqualTo("test1")""" && + it.jsonPath() == """\$.property1[*][?(@.property2 == 'test1')]""" + } + pathAndValues.find { + it.method()== """.array("property1").contains("property3").isEqualTo("test2")""" && + it.jsonPath() == """\$.property1[*][?(@.property3 == 'test2')]""" + } + pathAndValues.find { + it.method()== """.array("property1").hasSize(2)""" && + it.jsonPath() == """\$.property1[*]""" + } + and: + pathAndValues.size() == 3 + } + + def "should generate assertions for nested objects in response body"() { + given: + String json = """{ + "property1": "a", + "property2": {"property3": "b"} + }""" + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method()== """.field("property2").field("property3").isEqualTo("b")""" && + it.jsonPath() == """\$.property2[?(@.property3 == 'b')]""" + } + pathAndValues.find { + it.method()== """.field("property1").isEqualTo("a")""" && + it.jsonPath() == """\$[?(@.property1 == 'a')]""" + } + and: + pathAndValues.size() == 2 + } + + def "should generate regex assertions for map objects in response body"() { + given: + Map json = [ + property1: "a", + property2: Pattern.compile('[0-9]{3}') + ] + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(json) + then: + pathAndValues.find { + it.method()== """.field("property2").matches("[0-9]{3}")""" && + it.jsonPath() == """\$[?(@.property2 =~ /[0-9]{3}/)]""" + } + pathAndValues.find { + it.method()== """.field("property1").isEqualTo("a")""" && + it.jsonPath() == """\$[?(@.property1 == 'a')]""" + } + and: + pathAndValues.size() == 2 + } + + def "should generate escaped regex assertions for string objects in response body"() { + given: + Map json = [ + property2: Pattern.compile('\\d+') + ] + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(json) + then: + pathAndValues.find { + it.method()== """.field("property2").matches("\\\\d+")""" && + it.jsonPath() == """\$[?(@.property2 =~ /\\d+/)]""" + } + and: + pathAndValues.size() == 1 + } + + + def "should work with more complex stuff and jsonpaths"() { + given: + Map json = [ + errors: [ + [property: "bank_account_number", + message: "incorrect_format"] + ] + ] + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(json) + then: + pathAndValues.find { + it.method()== """.array("errors").contains("property").isEqualTo("bank_account_number")""" && + it.jsonPath() == """\$.errors[*][?(@.property == 'bank_account_number')]""" + } + pathAndValues.find { + it.method()== """.array("errors").contains("message").isEqualTo("incorrect_format")""" && + it.jsonPath() == """\$.errors[*][?(@.message == 'incorrect_format')]""" + } + pathAndValues.find { + it.method()== """.array("errors").hasSize(1)""" && + it.jsonPath() == """\$.errors[*]""" + } + and: + pathAndValues.size() == 3 + } + + def "should manage to parse a double array"() { + given: + String json = ''' + [{ + "place": + { + "bounding_box": + { + "coordinates": + [[ + [-77.119759,38.995548], + [-76.909393,38.791645] + ]] + } + } + }] + ''' + when: + JsonPaths pathAndValues = new JsonToJsonPathsConverter().transformToJsonPathWithTestsSideValues(new JsonSlurper().parseText(json)) + then: + pathAndValues.find { + it.method()== """.array().field("place").field("bounding_box").array("coordinates").array().arrayField().isEqualTo(38.995548)""" && + it.jsonPath() == """\$[*].place.bounding_box.coordinates[*][*][?(@ == 38.995548)]""" + } + pathAndValues.find { + it.method()== """.array().field("place").field("bounding_box").array("coordinates").array().arrayField().isEqualTo(-77.119759)""" && + it.jsonPath() == """\$[*].place.bounding_box.coordinates[*][*][?(@ == -77.119759)]""" + } + pathAndValues.find { + it.method()== """.array().field("place").field("bounding_box").array("coordinates").array().arrayField().isEqualTo(-76.909393)""" && + it.jsonPath() == """\$[*].place.bounding_box.coordinates[*][*][?(@ == -76.909393)]""" + } + pathAndValues.find { + it.method()== """.array().field("place").field("bounding_box").array("coordinates").array().arrayField().isEqualTo(38.791645)""" && + it.jsonPath() == """\$[*].place.bounding_box.coordinates[*][*][?(@ == 38.791645)]""" + } + pathAndValues.find { + it.method()== """.hasSize(1)""" && + it.jsonPath() == """\$""" + } + pathAndValues.find { + it.method()== """.array().field("place").field("bounding_box").array("coordinates").array().hasSize(2)""" && + it.jsonPath() == """\$[*].place.bounding_box.coordinates[*][*]""" + } + pathAndValues.find { + it.method()== """.array().field("place").field("bounding_box").array("coordinates").hasSize(1)""" && + it.jsonPath() == """\$[*].place.bounding_box.coordinates[*]""" + } + and: + pathAndValues.size() == 7 + and: + pathAndValues.each { + JsonAssertion.assertThat(json).matchesJsonPath(it.jsonPath()) + } + } + + private void assertThatJsonPathsInMapAreValid(String json, JsonPaths pathAndValues) { + DocumentContext parsedJson = JsonPath.using(Configuration.builder().options(Option.ALWAYS_RETURN_LIST).build()).parse(json); + pathAndValues.each { + assert !parsedJson.read(it.jsonPath(), JSONArray).empty + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/01_login.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/01_login.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/01_login.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/02_showCart.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/02_showCart.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/02_showCart.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/03_logout.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/03_logout.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/scenario/03_logout.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/different/diff.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/different/diff.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/different/diff.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/different/diff.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/different/diff.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/different/diff.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/other.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/other.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/other.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/sample.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/sample.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/other/sample.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/exceptions/test.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/exceptions/test.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/exceptions/test.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/v1/exceptions/testv1.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/v1/exceptions/testv1.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/v1/exceptions/testv1.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/v2/exceptions/testv2.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/v2/exceptions/testv2.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/package/v2/exceptions/testv2.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/stubsRepositoryIndicator b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/directory/with/stubs/stubsRepositoryIndicator new file mode 100644 index 0000000000..e69de29bb2 diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/dsl/basic/sampleDsl.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/dsl/basic/sampleDsl.groovy new file mode 100644 index 0000000000..a24fc9fb0a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/dsl/basic/sampleDsl.groovy @@ -0,0 +1,48 @@ +import org.springframework.cloud.contract.spec.Contract + +/* + * Copyright 2013-2016 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. + */ + +Contract.make { + request { + method('PUT') + headers { + header 'Content-Type': 'application/json' + } + body("""\ + { + "name": "Jan", + "id": "${value(client('abc'), server('def'))}", + } + """ + ) + url $(client('/[0-9]{2}'), server('/12')) + } + response { + status 200 + body("""\ + { + "name": "Jan", + "id": "${value(client('123'), server('321'))}", + "surname": "${value(client('Kowalsky'), server('$checkIfSurnameValid($value)'))}" + } + """ + ) + headers { + header 'Content-Type': 'text/plain' + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/main.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/main.json new file mode 100644 index 0000000000..e69de29bb2 diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/02_login.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/02_login.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/02_login.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/bar/03_login.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/bar/03_login.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/bar/03_login.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/foo/01_login.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/foo/01_login.groovy new file mode 100644 index 0000000000..958ccd0673 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-core/src/test/resources/strange_[3.3.3]_directory/foo/01_login.groovy @@ -0,0 +1,16 @@ +/* + * Copyright 2013-2016 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. + */ + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/GenerateServerTestsTask.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/GenerateServerTestsTask.groovy new file mode 100644 index 0000000000..ce5301b3fd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/GenerateServerTestsTask.groovy @@ -0,0 +1,61 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import org.gradle.api.GradleException +import org.gradle.api.internal.ConventionTask +import org.gradle.api.tasks.InputDirectory +import org.gradle.api.tasks.OutputDirectory +import org.gradle.api.tasks.TaskAction +import org.springframework.cloud.contract.spec.ContractVerifierException +import org.springframework.cloud.contract.verifier.TestGenerator +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties + +/** + * Task used to generate server side tests + * + * @since 1.0.0 + */ +class GenerateServerTestsTask extends ConventionTask { + + @InputDirectory + File contractsDslDir + @OutputDirectory + File generatedTestSourcesDir + + //TODO: How to deal with @Input*, @Output* and that domain object? + ContractVerifierConfigProperties configProperties + + @TaskAction + void generate() { + project.logger.info("Spring Cloud Contract Verifier Plugin: Invoking test sources generation") + + project.sourceSets.test.groovy { + project.logger.info("Registering ${getConfigProperties().generatedTestSourcesDir} as test source directory") + srcDir getConfigProperties().generatedTestSourcesDir + } + + try { + //TODO: What with that? How to pass? + TestGenerator generator = new TestGenerator(getConfigProperties()) + int generatedClasses = generator.generate() + project.logger.info("Generated {} test classes", generatedClasses) + } catch (ContractVerifierException e) { + throw new GradleException("Spring Cloud Contract Verifier Plugin exception: ${e.message}", e) + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/GenerateWireMockClientStubsFromDslTask.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/GenerateWireMockClientStubsFromDslTask.groovy new file mode 100644 index 0000000000..e87a0422cd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/GenerateWireMockClientStubsFromDslTask.groovy @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import org.gradle.api.internal.ConventionTask +import org.gradle.api.tasks.InputDirectory +import org.gradle.api.tasks.OutputDirectory +import org.gradle.api.tasks.TaskAction +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +import org.springframework.cloud.contract.verifier.wiremock.DslToWireMockClientConverter +import org.springframework.cloud.contract.verifier.wiremock.RecursiveFilesConverter +//TODO: Implement as an incremental task: https://gradle.org/docs/current/userguide/custom_tasks.html#incremental_tasks ? +/** + * Generates WireMock stubs from the contracts + * + * @since 1.0.0 + */ +class GenerateWireMockClientStubsFromDslTask extends ConventionTask { + + private static final String DEFAULT_MAPPINGS_FOLDER = 'mappings' + + @InputDirectory + File contractsDslDir + @OutputDirectory + File stubsOutputDir + + ContractVerifierConfigProperties configProperties + + @TaskAction + void generate() { + logger.info("Spring Cloud Contract Verifier Plugin: Invoking DSL to WireMock client stubs conversion") + logger.debug("From '${getContractsDslDir()}' to '${getStubsOutputDir()}'") + ContractVerifierConfigProperties props = getConfigProperties() + File outMappingsDir = props.stubsOutputDir != null ? new File(props.stubsOutputDir, DEFAULT_MAPPINGS_FOLDER) + : new File(project.buildDir, "stubs/$DEFAULT_MAPPINGS_FOLDER") + RecursiveFilesConverter converter = new RecursiveFilesConverter(new DslToWireMockClientConverter(), + getConfigProperties(), outMappingsDir) + converter.processFiles() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/SpringCloudContractVerifierGradlePlugin.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/SpringCloudContractVerifierGradlePlugin.groovy new file mode 100644 index 0000000000..2ee94f97da --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/groovy/org/springframework/cloud/contract/verifier/plugin/SpringCloudContractVerifierGradlePlugin.groovy @@ -0,0 +1,206 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.Task +import org.gradle.api.publish.maven.MavenPublication +import org.gradle.api.publish.maven.plugins.MavenPublishPlugin +import org.gradle.api.tasks.Copy +import org.gradle.jvm.tasks.Jar +import org.springframework.cloud.contract.verifier.config.ContractVerifierConfigProperties +/** + * Gradle plugin for Spring Cloud Contract Verifier that from the DSL contract can + *
    + *
  • generate tests
    • + *
  • generate stubs
    • + *
+ * + * Also adds the necessary {@code testCompile} dependencies + * + *
    + *
  • WireMock
    • + *
  • JSON Assert
    • + *
  • AssertJ
    • + *
+ * + * @author Jakub Kubrynski, codearte.io + * + * @since 1.0.0 + */ +class SpringCloudContractVerifierGradlePlugin implements Plugin { + + private static final String GENERATE_SERVER_TESTS_TASK_NAME = 'generateContractTests' + private static final String DSL_TO_WIREMOCK_CLIENT_TASK_NAME = 'generateWireMockClientStubs' + private static final String COPY_CONTRACTS_TASK_NAME = 'copyContracts' + private static final String VERIFIER_STUBS_JAR_TASK_NAME = 'verifierStubsJar' + + private static final Class IDEA_PLUGIN_CLASS = org.gradle.plugins.ide.idea.IdeaPlugin + private static final String GROUP_NAME = "Verification" + private static final String EXTENSION_NAME = 'contractVerifier' + + private Project project + + @Override + void apply(Project project) { + this.project = project + ContractVerifierConfigProperties extension = project.extensions.create(EXTENSION_NAME, ContractVerifierConfigProperties) + + project.check.dependsOn(GENERATE_SERVER_TESTS_TASK_NAME) + + setConfigurationDefaults(extension) + createGenerateTestsTask(extension) + createAndConfigureGenerateWireMockClientStubsFromDslTask(extension) + Task stubsJar = createAndConfigureStubsJarTasks(extension) + createAndConfigureCopyContractsTask(stubsJar, extension) + createAndConfigureMavenPublishPlugin(stubsJar, extension) + project.dependencies.add("testCompile", "com.github.tomakehurst:wiremock:2.0.10-beta") + project.dependencies.add("testCompile", "com.toomuchcoding.jsonassert:jsonassert:0.4.7") + project.dependencies.add("testCompile", "org.assertj:assertj-core:2.3.0") + + project.afterEvaluate { + def hasIdea = project.plugins.findPlugin(IDEA_PLUGIN_CLASS) + if (hasIdea) { + project.idea { + module { + testSourceDirs += extension.generatedTestSourcesDir + testSourceDirs += extension.contractsDslDir + } + } + } + } + } + + private void setConfigurationDefaults(ContractVerifierConfigProperties extension) { + extension.with { + generatedTestSourcesDir = project.file("${project.buildDir}/generated-test-sources/contracts") + contractsDslDir = defaultContractsDir() //TODO: Use sourceset + basePackageForTests = 'org.springframework.cloud.contract.verifier.tests' + stubsOutputDir = stubsOutputDir ?: project.file("${project.buildDir}/stubs") + } + } + + private File defaultContractsDir() { + project.file("${project.rootDir}/src/test/resources/contracts") + } + + private void createGenerateTestsTask(ContractVerifierConfigProperties extension) { + Task task = project.tasks.create(GENERATE_SERVER_TESTS_TASK_NAME, GenerateServerTestsTask) + task.description = "Generate server tests from the contracts" + task.group = GROUP_NAME + task.conventionMapping.with { + contractsDslDir = { extension.contractsDslDir } + generatedTestSourcesDir = { extension.generatedTestSourcesDir } + configProperties = { extension } + } + } + + private void createAndConfigureGenerateWireMockClientStubsFromDslTask(ContractVerifierConfigProperties extension) { + Task task = project.tasks.create(DSL_TO_WIREMOCK_CLIENT_TASK_NAME, GenerateWireMockClientStubsFromDslTask) + task.description = "Generate WireMock client stubs from the contracts" + task.group = GROUP_NAME + task.conventionMapping.with { + contractsDslDir = { extension.contractsDslDir } + stubsOutputDir = { extension.stubsOutputDir } + configProperties = { extension } + } + } + + private Task createAndConfigureStubsJarTasks(ContractVerifierConfigProperties extension) { + Task task = stubsTask() + if (task) { + project.logger.info("Spring Cloud Contract Verifier Plugin: Stubs jar task was present - won't create one. Remember about adding it to artifacts as an archive!") + return task + } else { + task = project.tasks.create(type: Jar, name: VERIFIER_STUBS_JAR_TASK_NAME, + dependsOn: DSL_TO_WIREMOCK_CLIENT_TASK_NAME) { + baseName = project.name + classifier = extension.stubsSuffix + from { extension.stubsOutputDir ?: project.file("${project.buildDir}/stubs") } + } + task.description = "Creates the stubs JAR task" + task.group = GROUP_NAME + + project.artifacts { + archives task + } + return task + } + } + + private Task stubsTask() { + try { + return project.tasks.getByName(VERIFIER_STUBS_JAR_TASK_NAME) + } catch (Exception e) { + return null + } + } + + private Task createAndConfigureCopyContractsTask(Task stubs, ContractVerifierConfigProperties extension) { + Task task = project.tasks.create(type: Copy, name: COPY_CONTRACTS_TASK_NAME) { + from { extension.contractsDslDir } + into { extension.stubsOutputDir != null ? + project.file("${extension.stubsOutputDir}/contracts") : project.file("${project.buildDir}/stubs/contracts") } + } + task.description = "Copies contracts to the output folder" + task.group = GROUP_NAME + stubs.dependsOn task + return task + } + + private void createAndConfigureMavenPublishPlugin(Task stubsTask, ContractVerifierConfigProperties extension) { + if (!classIsOnClasspath("org.gradle.api.publish.maven.plugins.MavenPublishPlugin")) { + project.logger.debug("Maven Publish Plugin is not present - won't add default publication") + return + } + project.logger.debug("Spring Cloud Contract Verifier Plugin: Generating default publication") + project.afterEvaluate { + project.plugins.withType(MavenPublishPlugin) { def publishingPlugin -> + def publishingExtension = project.extensions.findByName('publishing') + if (!hasPublication(publishingExtension)) { + project.logger.debug("Spring Cloud Contract Verifier Plugin: Stubs publication is not present - will create one") + publishingExtension.publications { + stubs(MavenPublication) { + artifactId "${project.name}" + artifact stubsTask + } + } + } else { + project.logger.info("Spring Cloud Contract Verifier Plugin: Stubs publication was present - won't create a new one. Remember about passing stubs as artifact") + } + } + } + } + + private boolean hasPublication(def publishingExtension) { + try { + return publishingExtension.publications.getByName('stubs') + } catch (Exception e) { + return false + } + } + + private boolean classIsOnClasspath(String className) { + try { + Class.forName(className) + return true + } catch (Exception e) { + project.logger.debug("Maven Publish Plugin is not available") + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/resources/META-INF/gradle-plugins/contract-verifier.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/resources/META-INF/gradle-plugins/contract-verifier.properties new file mode 100644 index 0000000000..d5479da71a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/main/resources/META-INF/gradle-plugins/contract-verifier.properties @@ -0,0 +1,17 @@ +# +# Copyright 2013-2016 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. +# + +implementation-class=org.springframework.cloud.contract.verifier.plugin.SpringCloudContractVerifierGradlePlugin \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/BasicFunctionalSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/BasicFunctionalSpec.groovy new file mode 100755 index 0000000000..8634877b49 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/BasicFunctionalSpec.groovy @@ -0,0 +1,113 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin +import org.springframework.cloud.contract.verifier.util.AssertionUtil +import org.gradle.testkit.runner.BuildResult +import spock.lang.Stepwise + +import static org.gradle.testkit.runner.TaskOutcome.SUCCESS +import static org.gradle.testkit.runner.TaskOutcome.UP_TO_DATE + +@Stepwise +class BasicFunctionalSpec extends ContractVerifierIntegrationSpec { + + private static final String GENERATED_TEST = "build//generated-test-sources//contracts//contracts//spring//cloud//twitter_places_analyzer//PairIdSpec.groovy" + private static final String GENERATED_CLIENT_JSON_STUB = "build//production//bootSimple-stubs//repository//mappings//spring//cloud//twitter-places-analyzer//pairId//collerate_PlacesFrom_Tweet.json" + private static final String GROOVY_DSL_CONTRACT = "repository//mappings//spring//cloud//twitter-places-analyzer//pairId//collerate_PlacesFrom_Tweet.groovy" + private static final String TEST_EXECUTION_XML_REPORT = "build/test-results/TEST-contracts.spring.cloud.twitter_places_analyzer.PairIdSpec.xml" + + def setup() { + setupForProject("functionalTest/bootSimple") + runTasksSuccessfully('clean') //delete accidental output when previously importing SimpleBoot into Idea to tweak it + } + + def "should pass basic flow"() { + when: + BuildResult result = run("check", "publishToMavenLocal") + then: + result.task(":generateWireMockClientStubs").outcome == SUCCESS + result.task(":generateContractTests").outcome == SUCCESS + + and: "tests generated" + fileExists(GENERATED_TEST) + + and: "client stubs generated" + fileExists(GENERATED_CLIENT_JSON_STUB) + + and: "generated tests executed" + fileExists(TEST_EXECUTION_XML_REPORT) + } + + def "should generate valid client json stubs for simple input"() { + when: + run('generateWireMockClientStubs') + then: + def generatedClientJsonStub = file(GENERATED_CLIENT_JSON_STUB).text + AssertionUtil.assertThatJsonsAreEqual(""" + { + "request" : { + "url" : "/api/12", + "method" : "PUT", + "bodyPatterns" : [ { + "matchesJsonPath" : "\$[*][?(@.text == 'Gonna see you at Warsaw')]" + } ], + "headers" : { + "Content-Type" : { + "equalTo" : "application/json" + } + } + }, + "response" : { + "status" : 200 + }, + "priority" : 2 + } + """, generatedClientJsonStub) + } + + def "tasks should be up-to-date when appropriate"() { + given: + assert !fileExists(GENERATED_CLIENT_JSON_STUB) + assert !fileExists(TEST_EXECUTION_XML_REPORT) + when: + runTasksSuccessfully('generateWireMockClientStubs', 'generateContractTests') + then: + fileExists(GENERATED_CLIENT_JSON_STUB) + fileExists(GENERATED_TEST) + + when: "running generation without change inputs" + def secondExecutionResult = run('generateWireMockClientStubs', 'generateContractTests') + + then: "tasks should be up-to-date" + validateTasksOutcome(secondExecutionResult, UP_TO_DATE, 'generateWireMockClientStubs', 'generateContractTests') + + when: "inputs changed" + def groovyDslFile = file(GROOVY_DSL_CONTRACT) + groovyDslFile.text = groovyDslFile.text.replace("200", "599") + + and: "tasks run" + def thirdExecutionResult = run('generateWireMockClientStubs', 'generateContractTests') + + then: "tasks should be reexecuted" + validateTasksOutcome(thirdExecutionResult, SUCCESS, 'generateWireMockClientStubs', 'generateContractTests') + + and: "changes visible in generate files" + file(GENERATED_CLIENT_JSON_STUB).text.contains("599") + file(GENERATED_TEST).text.contains("599") + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierIntegrationSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierIntegrationSpec.groovy new file mode 100644 index 0000000000..6e3ced3368 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ContractVerifierIntegrationSpec.groovy @@ -0,0 +1,154 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import org.apache.commons.io.FileUtils +import org.gradle.testkit.runner.BuildResult +import org.gradle.testkit.runner.BuildTask +import org.gradle.testkit.runner.GradleRunner +import org.gradle.testkit.runner.TaskOutcome +import spock.lang.Specification + +import java.nio.file.Files +import java.nio.file.Path +import java.util.zip.ZipException +import java.util.zip.ZipFile + +import static java.nio.charset.StandardCharsets.UTF_8 + +abstract class ContractVerifierIntegrationSpec extends Specification { + + File testProjectDir + + def setup() { + def dateString = new Date().format("yyyy-MM-dd_HH-mm-ss") + def testFolder = new File("build/generated-tests/${getClass().simpleName}/${dateString}") + testFolder.mkdirs() + testProjectDir = testFolder + } + + public static final String SPOCK = "targetFramework = 'Spock'" + public static final String JUNIT = "targetFramework = 'JUnit'" + public static final String MVC_SPEC = "baseClassForTests = 'org.springframework.cloud.MvcSpec'" + public static final String MVC_TEST = "baseClassForTests = 'org.springframework.cloud.MvcTest'" + + protected void setupForProject(String projectRoot) { + copyResourcesToRoot(projectRoot) + String gradlePluginSysProp = System.getProperty("contract-verifier-gradle-plugin-libs-dir") + String gradlePluginLibsDir = (gradlePluginSysProp ?: new File("build/").toString()).replace('\\', '\\\\') + String messagingLibDirProp = System.getProperty("messaging-libs-dir") + String messagingLibDir = (messagingLibDirProp ?: new File("build/").toString()).replace('\\', '\\\\') + + buildFile.write """ + ext.messagingLibsDir = '$messagingLibDir' + + buildscript { + dependencies { + classpath fileTree(dir: '$gradlePluginLibsDir', include: '*.jar') + } + } + + """ + buildFile.text + // Extending buildscript is required when 'apply' is used. + // 'GradleRunner#withPluginClasspath' can be used when plugin is added using 'plugins { id...' + } + + protected void switchToJunitTestFramework() { + switchToJunitTestFramework(MVC_SPEC, MVC_TEST) + } + + protected void switchToJunitTestFramework(String from, String to) { + Path path = buildFile.toPath() + String content = new StringBuilder(new String(Files.readAllBytes(path), UTF_8)).replaceAll(SPOCK, JUNIT) + .replaceAll(from, to) + Files.write(path, content.getBytes(UTF_8)) + } + + protected void runTasksSuccessfully(String... tasks) { + BuildResult result = run(tasks) + result.tasks.each { + assert it.outcome == TaskOutcome.SUCCESS || it.outcome == TaskOutcome.UP_TO_DATE + } + } + + protected BuildResult validateTasksOutcome(BuildResult result, TaskOutcome expectedOutcome, String... tasks) { + tasks.each { + BuildTask task = result.task(":" + it) + assert task + assert task.outcome == expectedOutcome + } + return result + } + + protected BuildResult run(String... tasks) { + return GradleRunner.create() + .withProjectDir(testProjectDir) + .withArguments(tasks) + .build() + } + + protected void copyResourcesToRoot(String srcDir) { + copyResources(srcDir, testProjectDir) + } + + protected void copyResources(String srcDir, File destinationFile) { + ClassLoader classLoader = getClass().getClassLoader() + URL resource = classLoader.getResource(srcDir) + if (resource == null) { + throw new RuntimeException("Could not find classpath resource: $srcDir") + } + File resourceFile = new File(resource.toURI()) + if (resourceFile.file) { + FileUtils.copyFile(resourceFile, destinationFile) + } else { + FileUtils.copyDirectory(resourceFile, destinationFile) + } + } + + protected File file(String path) { + return new File(testProjectDir, path) + } + + protected boolean fileExists(String path) { + return file(path).exists() + } + + protected File getBuildFile() { + return new File('build.gradle', testProjectDir) + } + + protected boolean jarContainsContractVerifierContracts(String path) { + assert fileExists(path) + File rootFile = file(path) + boolean containsGroovyFiles = false + rootFile.eachFileRecurse { File file -> + try { + if (file.isFile() && file.name.endsWith('jar')) { + new ZipFile(file).entries().each { + if (it.name.endsWith('.groovy')) { + containsGroovyFiles = true + } + } + } + }catch (ZipException zipEx) { + println "Unable to open file ${file.name}" + } + } + return containsGroovyFiles + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/MessagingProjectSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/MessagingProjectSpec.groovy new file mode 100755 index 0000000000..9f63a1b29c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/MessagingProjectSpec.groovy @@ -0,0 +1,47 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import spock.lang.Stepwise + +@Stepwise +class MessagingProjectSpec extends ContractVerifierIntegrationSpec { + + def setup() { + setupForProject("functionalTest/messagingProject") + runTasksSuccessfully('clean') //delete accidental output when previously importing SimpleBoot into Idea to tweak it + } + + def "should pass basic flow for Spock"() { + given: + assert fileExists('build.gradle') + expect: + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('build/libs') + } + + def "should pass basic flow for JUnit"() { + given: + runTasksSuccessfully('clean') + assert fileExists('build.gradle') + expect: + switchToJunitTestFramework('org.springframework.cloud.samples.book.MessagingBaseSpec', 'org.springframework.cloud.samples.book.MessagingBaseTest') + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('build/libs') + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/SampleJerseyProjectSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/SampleJerseyProjectSpec.groovy new file mode 100755 index 0000000000..25b6754d60 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/SampleJerseyProjectSpec.groovy @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import spock.lang.Stepwise + +@Stepwise +class SampleJerseyProjectSpec extends ContractVerifierIntegrationSpec { + + def setup() { + setupForProject("functionalTest/sampleJerseyProject") + runTasksSuccessfully('clean') //delete accidental output when previously importing SimpleBoot into Idea to tweak it + } + + def "should pass basic flow for Spock"() { + given: + assert fileExists('build.gradle') + expect: + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('fraudDetectionService/build/libs') + } + + def "should pass basic flow for JUnit"() { + given: + switchToJunitTestFramework() + assert fileExists('build.gradle') + expect: + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('fraudDetectionService/build/libs') + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/SampleProjectSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/SampleProjectSpec.groovy new file mode 100755 index 0000000000..5b31c3d4dd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/SampleProjectSpec.groovy @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import spock.lang.Stepwise + +@Stepwise +class SampleProjectSpec extends ContractVerifierIntegrationSpec { + + def setup() { + setupForProject("functionalTest/sampleProject") + runTasksSuccessfully('clean') //delete accidental output when previously importing SimpleBoot into Idea to tweak it + } + + def "should pass basic flow for Spock"() { + given: + assert fileExists('build.gradle') + expect: + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('fraudDetectionService/build/libs') + } + + def "should pass basic flow for JUnit"() { + given: + switchToJunitTestFramework() + assert fileExists('build.gradle') + expect: + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('fraudDetectionService/build/libs') + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ScenarioProjectSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ScenarioProjectSpec.groovy new file mode 100755 index 0000000000..f822982bef --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/groovy/org/springframework/cloud/contract/verifier/plugin/ScenarioProjectSpec.groovy @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.plugin + +import spock.lang.Stepwise + +@Stepwise +class ScenarioProjectSpec extends ContractVerifierIntegrationSpec { + + def setup() { + setupForProject("functionalTest/scenarioProject") + runTasksSuccessfully('clean') //delete accidental output when previously importing SimpleBoot into Idea to tweak it + } + + def "should pass basic flow for Spock"() { + given: + assert fileExists('build.gradle') + expect: + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('fraudDetectionService/build/libs') + } + + def "should pass basic flow for JUnit"() { + given: + assert fileExists('build.gradle') + expect: + switchToJunitTestFramework() + runTasksSuccessfully('check', "publishToMavenLocal") + jarContainsContractVerifierContracts('fraudDetectionService/build/libs') + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/build.gradle new file mode 100644 index 0000000000..1f0e725251 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/build.gradle @@ -0,0 +1,69 @@ +buildscript { + repositories { + mavenCentral() + } +} + +apply plugin: 'groovy' +apply plugin: 'contract-verifier' +apply plugin: 'maven-publish' + +group = 'org.springframework.cloud.testprojects' + +ext { + contractsDir = file("repository/mappings") + stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/repository/") +} + +configurations { + all { + resolutionStrategy { + eachDependency { DependencyResolveDetails details -> + // To prevent an accidental usage of groovy-all.jar and groovy.jar in different versions + // all modularized Groovy jars are replaced with groovy-all.jar by default. + if (details.requested.group == 'org.codehaus.groovy' && details.requested.name != "groovy-all") { + details.useTarget("org.codehaus.groovy:groovy-all:${details.requested.version}") + } + } + } + } +} + +repositories { + mavenCentral() + mavenLocal() +} + +dependencies { + compile "org.springframework:spring-web:$springVersion" + compile "org.springframework:spring-context-support:$springVersion" + compile "org.codehaus.groovy:groovy-all:2.4.5" + compile 'com.jayway.jsonpath:json-path-assert:2.2.0' + + testCompile "com.github.tomakehurst:wiremock:2.0.10-beta" + testCompile "org.spockframework:spock-spring:1.0-groovy-2.4" + testCompile "com.jayway.restassured:rest-assured:$restAssuredVersion" + testCompile "com.jayway.restassured:spring-mock-mvc:$restAssuredVersion" + testCompile "ch.qos.logback:logback-classic:1.1.2" +} + +contractVerifier { + baseClassForTests = 'org.springframework.cloud.contract.verifier.twitter.places.BaseMockMvcSpec' + basePackageForTests = 'contracts' + contractsDslDir = contractsDir +// generatedTestSourcesDir = file("${project.rootDir}/src/test/groovy/") + stubsOutputDir = stubsOutputDirRoot + targetFramework = 'Spock' +} + +generateContractTests.dependsOn generateWireMockClientStubs + +wrapper { + gradleVersion '2.2.1' +} + +test { + testLogging { + exceptionFormat = 'full' + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradle.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradle.properties new file mode 100644 index 0000000000..7c325172fd --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradle.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +groupId=org.springframework.cloud.contract.verifier +jacksonMapper=1.9.13 +restAssuredVersion=2.4.0 +springVersion=4.1.7.RELEASE + +springBootVersion=1.3.3.RELEASE \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradle/wrapper/gradle-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradle/wrapper/gradle-wrapper.properties new file mode 100755 index 0000000000..f510690c32 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +#Sat Feb 21 20:13:29 CET 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradlew b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradlew new file mode 100755 index 0000000000..91a7e269e1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradlew.bat b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradlew.bat new file mode 100755 index 0000000000..8a0b282aa6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/repository/mappings/spring/cloud/twitter-places-analyzer/pairId/collerate_PlacesFrom_Tweet.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/repository/mappings/spring/cloud/twitter-places-analyzer/pairId/collerate_PlacesFrom_Tweet.groovy new file mode 100644 index 0000000000..ab1d853b3e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/repository/mappings/spring/cloud/twitter-places-analyzer/pairId/collerate_PlacesFrom_Tweet.groovy @@ -0,0 +1,36 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + priority 2 + request { + method 'PUT' + url '/api/12' + headers { + header 'Content-Type': 'application/json' + } + body '''\ + [{ + "text": "Gonna see you at Warsaw" + }] +''' + } + response { + status 200 + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/repository/mappings/spring/cloud/twitter-places-analyzer/pairId/moreComplexVersion.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/repository/mappings/spring/cloud/twitter-places-analyzer/pairId/moreComplexVersion.groovy new file mode 100644 index 0000000000..887e54edf7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/repository/mappings/spring/cloud/twitter-places-analyzer/pairId/moreComplexVersion.groovy @@ -0,0 +1,43 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method 'PUT' + url $(client(regex('^/api/[0-9]{2}$')), server('/api/12')) + headers { + header 'Content-Type': 'application/json' + } + body '''\ + [{ + "text": "Gonna see you at Warsaw" + }] +''' + } + response { + headers { + header 'Content-Type': $(client('application/json'), server(regex('application/json.*'))) + header 'Location': $(client('https://localhost:8080'), server(execute('isEmpty($it)'))) + } + body ( + path: $(client('/api/12'), server(regex('^/api/[0-9]{2}$'))), + correlationId: $(client('1223456'), server(execute('isProperCorrelationId($it)'))) + ) + status 200 + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/settings.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/settings.gradle new file mode 100644 index 0000000000..f452413fb1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/settings.gradle @@ -0,0 +1,17 @@ +/* + * Copyright 2013-2016 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. + */ + +rootProject.name='bootSimple' diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/main/groovy/org/springframework/cloud/twitter/place/PairIdController.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/main/groovy/org/springframework/cloud/twitter/place/PairIdController.groovy new file mode 100644 index 0000000000..38b7dfc178 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/main/groovy/org/springframework/cloud/twitter/place/PairIdController.groovy @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.twitter.place + +import groovy.transform.TypeChecked +import groovy.util.logging.Slf4j +import org.springframework.http.MediaType +import org.springframework.web.bind.annotation.PathVariable +import org.springframework.web.bind.annotation.RequestBody +import org.springframework.web.bind.annotation.RequestMapping +import org.springframework.web.bind.annotation.RestController + +import static org.springframework.web.bind.annotation.RequestMethod.PUT + +@Slf4j +@RestController +@RequestMapping('/api') +@TypeChecked +class PairIdController { + + @RequestMapping( + value = '{pairId}', + method = PUT, + consumes = MediaType.APPLICATION_JSON_VALUE, + produces = MediaType.APPLICATION_JSON_VALUE) + String getPlacesFromTweets(@PathVariable long pairId, @RequestBody List tweets) { + log.info("Inside PairIdController, doing very important logic") + if (tweets?.text != ["Gonna see you at Warsaw"]) { + throw new IllegalArgumentException("Wrong text in tweet: ${tweets?.text}") + } + return """ + { + "path" : "/api/$pairId", + "correlationId" : 123456 + } + """ + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/main/groovy/org/springframework/cloud/twitter/place/Tweet.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/main/groovy/org/springframework/cloud/twitter/place/Tweet.java new file mode 100644 index 0000000000..9417289cec --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/main/groovy/org/springframework/cloud/twitter/place/Tweet.java @@ -0,0 +1,13 @@ +package org.springframework.cloud.contract.verifier.twitter.place; + +public class Tweet { + private String text; + + public String getText() { + return text; + } + + public void setText(String text) { + this.text = text; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/AcceptanceSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/AcceptanceSpec.groovy new file mode 100644 index 0000000000..9f482e0b4c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/AcceptanceSpec.groovy @@ -0,0 +1,39 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.twitter.places + +import org.springframework.cloud.contract.verifier.twitter.place.PairIdController +import org.springframework.http.MediaType +import org.springframework.test.web.servlet.MockMvc +import org.springframework.test.web.servlet.setup.MockMvcBuilders +import spock.lang.Specification + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status + +class AcceptanceSpec extends Specification { + + def "should have controller up and running"() { + given: + MockMvc mockMvc = MockMvcBuilders.standaloneSetup(new PairIdController()).build() + expect: + mockMvc.perform(put("/api/${1}"). + contentType(MediaType.APPLICATION_JSON). + content("""[{"text":"Gonna see you at Warsaw"}]""")). + andExpect(status().isOk()) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy new file mode 100644 index 0000000000..6057d7081a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/groovy/org/springframework/cloud/contract/verifier/twitter/places/BaseMockMvcSpec.groovy @@ -0,0 +1,39 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.twitter.places + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc +import org.springframework.cloud.contract.verifier.twitter.place.PairIdController +import spock.lang.Specification + +// tag::base_class[] +abstract class BaseMockMvcSpec extends Specification { + + def setup() { + RestAssuredMockMvc.standaloneSetup(new PairIdController()) + } + + void isProperCorrelationId(Integer correlationId) { + assert correlationId == 123456 + } + + void isEmpty(String value) { + assert value == null + } + +} +// end::base_class[] diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/resources/logback-test.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/resources/logback-test.groovy new file mode 100644 index 0000000000..0b49bdfb4a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/bootSimple/src/test/resources/logback-test.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +import ch.qos.logback.classic.encoder.PatternLayoutEncoder +import ch.qos.logback.core.ConsoleAppender + +String console = "CONSOLE" +String logPattern = "%d{yyyy-MM-dd HH:mm:ss.SSSZ, Europe/Warsaw} | %-5level | %X{correlationId} | %thread | %logger{1} | %m%n" + +appender(console, ConsoleAppender) { + encoder(PatternLayoutEncoder) { + pattern = logPattern + } +} + +root(INFO, [console]) +logger("org.springframework.cloud.contract.verifier", DEBUG) diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/build.gradle new file mode 100644 index 0000000000..222f9b241c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/build.gradle @@ -0,0 +1,80 @@ +buildscript { + repositories { + mavenLocal() + mavenCentral() + } +} + +apply plugin: 'groovy' +apply plugin: 'contract-verifier' +apply plugin: 'maven-publish' + +group = 'org.springframework.cloud.testprojects' + +ext { + contractsDir = file("repository/mappings") + stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/") + targetFramework = 'Spock' +} + +configurations { + all { + resolutionStrategy { + eachDependency { DependencyResolveDetails details -> + // To prevent an accidental usage of groovy-all.jar and groovy.jar in different versions + // all modularized Groovy jars are replaced with groovy-all.jar by default. + if (details.requested.group == 'org.codehaus.groovy' && details.requested.name != "groovy-all") { + details.useTarget("org.codehaus.groovy:groovy-all:${details.requested.version}") + } + } + } + } +} + +repositories { + mavenCentral() + mavenLocal() + maven { + url "http://repo.spring.io/snapshot" + } + maven { + url "http://repo.spring.io/milestone" + } +} + +dependencies { + compile "org.codehaus.groovy:groovy-all:2.4.5" + compile "org.springframework.boot:spring-boot-starter-web:${springBootVersion}" + compile "org.springframework.boot:spring-boot-starter-actuator:${springBootVersion}" + compile "org.springframework.boot:spring-boot-starter-integration:${springBootVersion}" + + compile fileTree(dir: messagingLibsDir, include: '*.jar') + + testCompile "org.spockframework:spock-spring:1.0-groovy-2.4" + testCompile "org.springframework.boot:spring-boot-starter-test:${springBootVersion}" + testCompile "ch.qos.logback:logback-classic:1.1.2" + testCompile 'com.jayway.restassured:spring-mock-mvc:2.9.0' // needed if you're going to use Spring MockMvc +} + +contractVerifier { + //baseClassForTests = 'org.springframework.cloud.samples.book.MessagingBaseTest' + baseClassForTests = 'org.springframework.cloud.samples.book.MessagingBaseSpec' + basePackageForTests = 'contracts' + //targetFramework = 'JUnit' + targetFramework = 'Spock' + contractsDslDir = contractsDir +// generatedTestSourcesDir = file("${project.rootDir}/src/test/groovy/") + stubsOutputDir = stubsOutputDirRoot +} + +generateContractTests.dependsOn generateWireMockClientStubs + +wrapper { + gradleVersion '2.12' +} + +test { + testLogging { + exceptionFormat = 'full' + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradle.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradle.properties new file mode 100644 index 0000000000..7293ee6bc8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradle.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +groupId=org.springframework.cloud +jacksonMapper=1.9.13 +restAssuredVersion=2.9.0 +springVersion=4.2.3.RELEASE + +springBootVersion=1.3.3.RELEASE \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradle/wrapper/gradle-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradle/wrapper/gradle-wrapper.properties new file mode 100755 index 0000000000..7f6620ddcf --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +#Sun Apr 17 20:31:11 CEST 2016 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradlew b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradlew new file mode 100755 index 0000000000..9d82f78915 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradlew @@ -0,0 +1,160 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradlew.bat b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradlew.bat new file mode 100755 index 0000000000..5f192121eb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/a_foo.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/a_foo.groovy new file mode 100644 index 0000000000..476aa94eb3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/a_foo.groovy @@ -0,0 +1,28 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + url '/foo' + method 'GET' + } + response { + status 200 + body 'bar' + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookDeleted.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookDeleted.groovy new file mode 100644 index 0000000000..4f7ca765f5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookDeleted.groovy @@ -0,0 +1,31 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + label 'some_label' + input { + messageFrom('delete') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + assertThat('bookWasDeleted()') + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookReturned1.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookReturned1.groovy new file mode 100644 index 0000000000..302e1d11f2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookReturned1.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + label 'some_label' + input { + triggeredBy('bookReturnedTriggered()') + } + outputMessage { + sentTo('output') + body('''{ "bookName" : "foo" }''') + headers { + header('BOOK-NAME', 'foo') + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookReturned2.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookReturned2.groovy new file mode 100644 index 0000000000..c5a9919e99 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/repository/mappings/bookReturned2.groovy @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + label 'some_label' + input { + messageFrom('input') + messageBody([ + bookName: 'foo' + ]) + messageHeaders { + header('sample', 'header') + } + } + outputMessage { + sentTo('output') + body([ + bookName: 'foo' + ]) + headers { + header('BOOK-NAME', 'foo') + } + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/settings.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/settings.gradle new file mode 100644 index 0000000000..f452413fb1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/settings.gradle @@ -0,0 +1,17 @@ +/* + * Copyright 2013-2016 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. + */ + +rootProject.name='bootSimple' diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookDeleted.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookDeleted.groovy new file mode 100644 index 0000000000..3d9e527fb5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookDeleted.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookDeleted { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookDeleted(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookListener.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookListener.groovy new file mode 100644 index 0000000000..6399b53a79 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookListener.groovy @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.messaging.Message +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder + +import java.util.concurrent.atomic.AtomicBoolean + +@CompileStatic +@Slf4j +class BookListener { + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + Message returnBook(BookReturned bookReturned) { + log.info("Returning book [$bookReturned]") + return MessageBuilder.createMessage(bookReturned, new MessageHeaders([ + 'BOOK-NAME': bookReturned.bookName as Object + ])) + } + + /** + Scenario for "should generate tests triggered by a message": + client side: if sends a message to input.messageFrom then message will be sent to output.messageFrom + server side: will send a message to input, verify the message contents and await upon receiving message on the output messageFrom + */ + void bookDeleted(BookDeleted bookDeleted) { + log.info("Deleting book [$bookDeleted]") + bookSuccessfulyDeleted.set(true) + } + + AtomicBoolean bookSuccessfulyDeleted = new AtomicBoolean(false) +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookReturned.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookReturned.groovy new file mode 100644 index 0000000000..22353e827f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookReturned.groovy @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book + +import com.fasterxml.jackson.annotation.JsonCreator +import groovy.transform.CompileStatic + +@CompileStatic +class BookReturned { + final String bookName + + @JsonCreator(mode = JsonCreator.Mode.PROPERTIES) + BookReturned(String bookName) { + this.bookName = bookName + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookService.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookService.groovy new file mode 100644 index 0000000000..b44a36a834 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/BookService.groovy @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book + +import groovy.transform.CompileStatic +import groovy.util.logging.Slf4j +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.beans.factory.annotation.Qualifier +import org.springframework.messaging.MessageChannel +import org.springframework.messaging.MessageHeaders +import org.springframework.messaging.support.MessageBuilder +import org.springframework.stereotype.Service + +@Service +@CompileStatic +@Slf4j +class BookService { + + @Autowired @Qualifier("outputChannel") MessageChannel outputChannel + + /** + Scenario for "should generate tests triggered by a method": + client side: must have a possibility to "trigger" sending of a message to the given messageFrom + server side: will run the method and await upon receiving message on the output messageFrom + + Method triggers sending a message to a source + */ + void returnBook(BookReturned bookReturned) { + log.info("Returning book [$bookReturned]") + outputChannel.send(MessageBuilder.createMessage(bookReturned, new MessageHeaders([ + 'BOOK-NAME': bookReturned.bookName as Object + ]))) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/IntegrationMessagingApplication.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/IntegrationMessagingApplication.groovy new file mode 100644 index 0000000000..e7345c64c8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/groovy/org/springframework/cloud/samples/book/IntegrationMessagingApplication.groovy @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book + +import org.springframework.boot.SpringApplication +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.context.annotation.ImportResource +import org.springframework.web.bind.annotation.RequestMapping +import org.springframework.web.bind.annotation.RestController + +@SpringBootApplication +@RestController +@ImportResource("classpath*:integration-context.xml") +class IntegrationMessagingApplication { + + @RequestMapping("/foo") + String foo() { + return "bar" + } + + static void main(String[] args) { + SpringApplication.run(IntegrationMessagingApplication.class, args) + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/resources/integration-context.xml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/resources/integration-context.xml new file mode 100644 index 0000000000..f29045cdb2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/main/resources/integration-context.xml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/test/groovy/org/springframework/cloud/samples/book/MessagingBaseSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/test/groovy/org/springframework/cloud/samples/book/MessagingBaseSpec.groovy new file mode 100644 index 0000000000..b0950a030c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/test/groovy/org/springframework/cloud/samples/book/MessagingBaseSpec.groovy @@ -0,0 +1,47 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book + +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.test.context.ContextConfiguration +import spock.lang.Specification +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc + +/** + * @author Marcin Grzejszczak + */ +@ContextConfiguration(classes = [IntegrationMessagingApplication], loader = SpringApplicationContextLoader) +abstract class MessagingBaseSpec extends Specification { + + // BASE CLASS WOULD HAVE THIS: + + @Autowired BookService bookService + @Autowired BookListener bookListener + + def setup() { + RestAssuredMockMvc.standaloneSetup(new IntegrationMessagingApplication()) + } + + void bookReturnedTriggered() { + bookService.returnBook(new BookReturned("foo")) + } + + void bookWasDeleted() { + assert bookListener.bookSuccessfulyDeleted.get() + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/test/java/org/springframework/cloud/samples/book/MessagingBaseTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/test/java/org/springframework/cloud/samples/book/MessagingBaseTest.java new file mode 100644 index 0000000000..2cc4aa8abb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/messagingProject/src/test/java/org/springframework/cloud/samples/book/MessagingBaseTest.java @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.samples.book; + +import org.assertj.core.api.Assertions; +import org.junit.runner.RunWith; +import org.junit.Before; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.SpringApplicationContextLoader; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc; + +/** + * @author Marcin Grzejszczak + */ +@RunWith(SpringJUnit4ClassRunner.class) +@ContextConfiguration(classes = {IntegrationMessagingApplication.class}, loader = SpringApplicationContextLoader.class) +public abstract class MessagingBaseTest { + + // BASE CLASS WOULD HAVE THIS: + + @Autowired BookService bookService; + @Autowired BookListener bookListener; + + @Before + public void setup() { + RestAssuredMockMvc.standaloneSetup(new IntegrationMessagingApplication()); + } + + public void bookReturnedTriggered() { + bookService.returnBook(new BookReturned("foo")); + } + + public void bookWasDeleted() { + Assertions.assertThat(bookListener.getBookSuccessfulyDeleted().get()).isTrue(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/build.gradle new file mode 100644 index 0000000000..9375d437c5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/build.gradle @@ -0,0 +1,119 @@ +/* + * Copyright 2013-2016 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. + */ + +buildscript { + repositories { + mavenLocal() + mavenCentral() + } + dependencies { + classpath "org.springframework.boot:spring-boot-gradle-plugin:1.2.6.RELEASE" + } +} + +group = 'org.springframework.cloud.testprojects' + +ext { + restAssuredVersion = '2.5.0' + spockVersion = '1.0-groovy-2.4' + wiremockVersion = '2.0.10-beta' + + contractVerifierStubsBaseDirectory = 'src/test/resources/stubs' +} + +subprojects { + apply plugin: 'groovy' + + repositories { + mavenCentral() + mavenLocal() + } + + dependencies { + testCompile 'org.codehaus.groovy:groovy-all:2.4.5' + testCompile "org.spockframework:spock-core:$spockVersion" + testCompile 'junit:junit:4.12' + testCompile "com.github.tomakehurst:wiremock:$wiremockVersion" + } +} + +configure([project(':fraudDetectionService'), project(':loanApplicationService')]) { + apply plugin: 'spring-boot' + apply plugin: 'contract-verifier' + apply plugin: 'maven-publish' + + ext { + contractsDir = file("mappings") + stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/") + } + + contractVerifier { + targetFramework = 'Spock' + testMode = 'JaxRsClient' + baseClassForTests = 'org.springframework.cloud.MvcSpec' + contractsDslDir = file("${project.projectDir.absolutePath}/mappings/") + generatedTestSourcesDir = file("${project.buildDir}/generated-test-sources/") + stubsOutputDir = stubsOutputDirRoot + } + + jar { + version = '0.0.1' + } + + configurations { + compile.exclude module: "spring-boot-starter-tomcat" + } + + dependencies { + compile 'org.glassfish.jersey.containers:jersey-container-jetty-http:2.15' + compile 'org.springframework.boot:spring-boot-starter-jersey' + compile 'org.springframework.boot:spring-boot-starter-jetty' + + testRuntime "org.spockframework:spock-spring:$spockVersion" + + compile 'org.glassfish.jersey.connectors:jersey-apache-connector:2.15' + testCompile 'org.springframework:spring-test' + } + + task cleanup(type: Delete) { + delete 'src/test/resources/mappings', 'src/test/resources/stubs' + } + + clean.dependsOn('cleanup') + + test { + testLogging { + exceptionFormat = 'full' + } + } + +} + +configure(project(':fraudDetectionService')) { + test.dependsOn('generateWireMockClientStubs') +} + +configure(project(':loanApplicationService')) { + + task copyCollaboratorStubs(type: Copy) { + File fraudBuildDir = project(':fraudDetectionService').buildDir + from(new File(fraudBuildDir, "/production/${project(':fraudDetectionService').name}-stubs/")) + into "src/test/resources/" + } + + generateContractTests.dependsOn('copyCollaboratorStubs') +} + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsFraud.groovy new file mode 100644 index 0000000000..1fc39340b5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsFraud.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method """PUT""" + url """/fraudcheck""" + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":99999} + """ + ) + headers { + header("""Content-Type""", """application/vnd.fraud.v1+json""") + } + + } + response { + status 200 + body( """{ + "fraudCheckStatus": "${value(client('FRAUD'), server(regex('[A-Z]{5}')))}", + "rejectionReason": "Amount too high" +}""") + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.groovy new file mode 100644 index 0000000000..94026415f3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.groovy @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method 'PUT' + url '/fraudcheck' + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":123.123 + } + """ + ) + headers { + header('Content-Type', 'application/vnd.fraud.v1+json') + } + + } + response { + status 200 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/Application.java new file mode 100644 index 0000000000..e671a56892 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/Application.java @@ -0,0 +1,24 @@ +package org.springframework.cloud.frauddetection; + +import org.glassfish.jersey.server.ResourceConfig; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + + @Bean + ResourceConfig resourceConfig() { + return ResourceConfig.forApplication(new FraudRestApplication()); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudDetectionController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudDetectionController.java new file mode 100644 index 0000000000..3eaaea3a42 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudDetectionController.java @@ -0,0 +1,38 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.cloud.frauddetection.model.FraudCheck; +import org.springframework.cloud.frauddetection.model.FraudCheckResult; +import org.springframework.stereotype.Controller; +import org.springframework.web.bind.annotation.RequestBody; + +import javax.ws.rs.*; +import java.math.BigDecimal; + +import static org.springframework.cloud.frauddetection.model.FraudCheckStatus.FRAUD; +import static org.springframework.cloud.frauddetection.model.FraudCheckStatus.OK; + +@Controller +@Path("/") +public class FraudDetectionController { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = "application/vnd.fraud.v1+json"; + private static final String NO_REASON = null; + private static final String AMOUNT_TOO_HIGH = "Amount too high"; + private static final BigDecimal MAX_AMOUNT = new BigDecimal("5000"); + + @PUT + @Path("/fraudcheck") + @Produces(FRAUD_SERVICE_JSON_VERSION_1) + @Consumes(FRAUD_SERVICE_JSON_VERSION_1) + public FraudCheckResult fraudCheck(@RequestBody(required = false) FraudCheck fraudCheck) { + if (amountGreaterThanThreshold(fraudCheck)) { + return new FraudCheckResult(FRAUD, AMOUNT_TOO_HIGH); + } + return new FraudCheckResult(OK, NO_REASON); + } + + private boolean amountGreaterThanThreshold(FraudCheck fraudCheck) { + return MAX_AMOUNT.compareTo(fraudCheck.getLoanAmount()) < 0; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudRestApplication.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudRestApplication.java new file mode 100644 index 0000000000..064e59196b --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudRestApplication.java @@ -0,0 +1,13 @@ +package org.springframework.cloud.frauddetection; + +import java.util.Collections; +import java.util.Set; + +public class FraudRestApplication extends javax.ws.rs.core.Application { + + @Override + public Set> getClasses() { + return Collections.>singleton(FraudDetectionController.class); + } + +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheck.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheck.java new file mode 100644 index 0000000000..72551915bc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheck.java @@ -0,0 +1,29 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudCheck { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudCheck() { + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckResult.java new file mode 100644 index 0000000000..95fd5e04c4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckResult.java @@ -0,0 +1,32 @@ +package org.springframework.cloud.frauddetection.model; + +public class FraudCheckResult { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudCheckResult() { + } + + public FraudCheckResult(FraudCheckStatus fraudCheckStatus, String rejectionReason) { + this.fraudCheckStatus = fraudCheckStatus; + this.rejectionReason = rejectionReason; + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..b4fd951df2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/resources/application.yml new file mode 100644 index 0000000000..a30a91f034 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/main/resources/application.yml @@ -0,0 +1 @@ +server.port=8085 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy new file mode 100644 index 0000000000..1fab371acc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy @@ -0,0 +1,73 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud +import org.springframework.cloud.frauddetection.Application +import org.springframework.cloud.frauddetection.FraudRestApplication +import org.eclipse.jetty.server.Server +import org.glassfish.jersey.apache.connector.ApacheConnectorProvider +import org.glassfish.jersey.client.ClientConfig +import org.glassfish.jersey.jetty.JettyHttpContainerFactory +import org.glassfish.jersey.server.ResourceConfig +import org.springframework.context.annotation.AnnotationConfigApplicationContext +import spock.lang.Shared +import spock.lang.Specification + +import javax.ws.rs.client.Client +import javax.ws.rs.client.ClientBuilder +import javax.ws.rs.client.WebTarget +import javax.ws.rs.core.UriBuilder + +import static org.springframework.util.SocketUtils.findAvailableTcpPort + +abstract class MvcSpec extends Specification { + + @Shared + WebTarget webTarget + + @Shared + private Server server + + @Shared + private Client client + + def setupSpec() { + + URI baseUri = UriBuilder.fromUri("http://localhost").port(findAvailableTcpPort(8000)).build() + + + ResourceConfig resourceConfig = ResourceConfig.forApplication(new FraudRestApplication()) + resourceConfig.property("contextConfig", new AnnotationConfigApplicationContext(Application)) + server = JettyHttpContainerFactory.createServer(baseUri, resourceConfig, true) + + ClientConfig clientConfig = new ClientConfig() + clientConfig.connectorProvider(new ApacheConnectorProvider()) + client = ClientBuilder.newClient(clientConfig) + + webTarget = client.target(baseUri) + + server.start() + } + + def cleanupSpec() { + client?.close() + server?.stop() + } + + void assertThatRejectionReasonIsNull(def rejectionReason) { + assert !rejectionReason + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java new file mode 100644 index 0000000000..93c9209621 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java @@ -0,0 +1,70 @@ +package org.springframework.cloud; + +import org.springframework.cloud.frauddetection.Application; +import org.springframework.cloud.frauddetection.FraudRestApplication; +import org.eclipse.jetty.server.Server; +import org.glassfish.jersey.apache.connector.ApacheConnectorProvider; +import org.glassfish.jersey.client.ClientConfig; +import org.glassfish.jersey.jetty.JettyHttpContainerFactory; +import org.glassfish.jersey.server.ResourceConfig; +import org.junit.AfterClass; +import org.junit.BeforeClass; +import org.springframework.context.annotation.AnnotationConfigApplicationContext; + +import javax.ws.rs.client.Client; +import javax.ws.rs.client.ClientBuilder; +import javax.ws.rs.client.WebTarget; +import javax.ws.rs.core.UriBuilder; +import java.net.URI; + +import static org.springframework.util.SocketUtils.findAvailableTcpPort; + +public abstract class MvcTest { + + public static WebTarget webTarget; + + private static Server server; + + private static Client client; + + @BeforeClass + public static void setupTest() { + + URI baseUri = UriBuilder.fromUri("http://localhost").port(findAvailableTcpPort(8000)).build(); + + + ResourceConfig resourceConfig = ResourceConfig.forApplication(new FraudRestApplication()); + resourceConfig.property("contextConfig", new AnnotationConfigApplicationContext(Application.class)); + server = JettyHttpContainerFactory.createServer(baseUri, resourceConfig, true); + + ClientConfig clientConfig = new ClientConfig(); + clientConfig.connectorProvider(new ApacheConnectorProvider()); + client = ClientBuilder.newClient(clientConfig); + + webTarget = client.target(baseUri); + + try { + server.start(); + } catch (Exception e) { + e.printStackTrace(); + } + } + + @AfterClass + public static void cleanupTest() { + if(client != null) { + client.close(); + } + if (server != null) { + try { + server.stop(); + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + public void assertThatRejectionReasonIsNull(Object rejectionReason) { + assert rejectionReason == null; + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradle/wrapper/gradle-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..1aa6b34ba4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +#Wed Jan 28 00:32:44 CET 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradlew b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradlew new file mode 100755 index 0000000000..91a7e269e1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradlew.bat b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradlew.bat new file mode 100644 index 0000000000..8a0b282aa6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/mappings/.gitkeep b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/mappings/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java new file mode 100644 index 0000000000..e70eca242e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java @@ -0,0 +1,33 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java new file mode 100644 index 0000000000..64402473fa --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java @@ -0,0 +1,84 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection; + +import org.springframework.cloud.frauddetection.model.FraudCheckStatus; +import org.springframework.cloud.frauddetection.model.FraudServiceRequest; +import org.springframework.cloud.frauddetection.model.FraudServiceResponse; +import org.springframework.cloud.frauddetection.model.LoanApplication; +import org.springframework.cloud.frauddetection.model.LoanApplicationResult; +import org.springframework.cloud.frauddetection.model.LoanApplicationStatus; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +@Service +public class LoanApplicationService { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = + "application/vnd.fraud.v1+json"; + + private final RestTemplate restTemplate; + + private int port = 8080; + + public LoanApplicationService() { + this.restTemplate = new RestTemplate(); + } + + public LoanApplicationResult loanApplication(LoanApplication loanApplication) { + FraudServiceRequest request = + new FraudServiceRequest(loanApplication); + + FraudServiceResponse response = + sendRequestToFraudDetectionService(request); + + return buildResponseFromFraudResult(response); + } + + private FraudServiceResponse sendRequestToFraudDetectionService( + FraudServiceRequest request) { + HttpHeaders httpHeaders = new HttpHeaders(); + httpHeaders.add(HttpHeaders.CONTENT_TYPE, FRAUD_SERVICE_JSON_VERSION_1); + + ResponseEntity response = + restTemplate.exchange("http://localhost:" + port + "/fraudcheck", HttpMethod.PUT, + new HttpEntity<>(request, httpHeaders), + FraudServiceResponse.class); + + return response.getBody(); + } + + private LoanApplicationResult buildResponseFromFraudResult(FraudServiceResponse response) { + LoanApplicationStatus applicationStatus = null; + if (FraudCheckStatus.OK == response.getFraudCheckStatus()) { + applicationStatus = LoanApplicationStatus.LOAN_APPLIED; + } else if (FraudCheckStatus.FRAUD == response.getFraudCheckStatus()) { + applicationStatus = LoanApplicationStatus.LOAN_APPLICATION_REJECTED; + } + + return new LoanApplicationResult(applicationStatus, response.getRejectionReason()); + } + + public void setPort(int port) { + this.port = port; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java new file mode 100644 index 0000000000..403da83818 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +public class Client { + + private String pesel; + + public String getPesel() { + return pesel; + } + + public void setPesel(String pesel) { + this.pesel = pesel; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..4fb43b0cf8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,21 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java new file mode 100644 index 0000000000..fc2aa4580c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java @@ -0,0 +1,50 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudServiceRequest { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudServiceRequest() { + } + + public FraudServiceRequest(LoanApplication loanApplication) { + this.clientPesel = loanApplication.getClient().getPesel(); + this.loanAmount = loanApplication.getAmount(); + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java new file mode 100644 index 0000000000..79eb5b2c0d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java @@ -0,0 +1,43 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +public class FraudServiceResponse { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudServiceResponse() { + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java new file mode 100644 index 0000000000..ad2c6c80a1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class LoanApplication { + + private Client client; + + private BigDecimal amount; + + private String loanApplicationId; + + public Client getClient() { + return client; + } + + public void setClient(Client client) { + this.client = client; + } + + public BigDecimal getAmount() { + return amount; + } + + public void setAmount(BigDecimal amount) { + this.amount = amount; + } + + public String getLoanApplicationId() { + return loanApplicationId; + } + + public void setLoanApplicationId(String loanApplicationId) { + this.loanApplicationId = loanApplicationId; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java new file mode 100644 index 0000000000..a9b0617c11 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +public class LoanApplicationResult { + + private LoanApplicationStatus loanApplicationStatus; + + private String rejectionReason; + + public LoanApplicationResult() { + } + + public LoanApplicationResult(LoanApplicationStatus loanApplicationStatus, String rejectionReason) { + this.loanApplicationStatus = loanApplicationStatus; + this.rejectionReason = rejectionReason; + } + + public LoanApplicationStatus getLoanApplicationStatus() { + return loanApplicationStatus; + } + + public void setLoanApplicationStatus(LoanApplicationStatus loanApplicationStatus) { + this.loanApplicationStatus = loanApplicationStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java new file mode 100644 index 0000000000..e939d49b8f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java @@ -0,0 +1,21 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.frauddetection.model; + +public enum LoanApplicationStatus { + LOAN_APPLIED, LOAN_APPLICATION_REJECTED +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/resources/application.yml new file mode 100644 index 0000000000..e86bbd0e0f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/main/resources/application.yml @@ -0,0 +1 @@ +server.port=8090 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy new file mode 100644 index 0000000000..d5104eb499 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy @@ -0,0 +1,72 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud + +import org.springframework.cloud.frauddetection.Application +import org.springframework.cloud.frauddetection.LoanApplicationService +import org.springframework.cloud.frauddetection.model.Client +import org.springframework.cloud.frauddetection.model.LoanApplication +import org.springframework.cloud.frauddetection.model.LoanApplicationResult +import org.springframework.cloud.frauddetection.model.LoanApplicationStatus +import com.github.tomakehurst.wiremock.junit.WireMockClassRule +import org.junit.ClassRule +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.test.context.ContextConfiguration +import spock.lang.Shared +import spock.lang.Specification + +@ContextConfiguration(loader = SpringApplicationContextLoader, classes = Application) +class LoanApplicationServiceSpec extends Specification { + + public static int port = org.springframework.util.SocketUtils.findAvailableTcpPort() + + @ClassRule + @Shared + WireMockClassRule wireMockRule = new WireMockClassRule(port) + + @Autowired + LoanApplicationService sut + + def setup() { + sut.port = port + } + + def 'should successfully apply for loan'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(pesel: '1234567890'), amount: 123.123) + when: + LoanApplicationResult loanApplication = sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLIED + loanApplication.rejectionReason == null + } + + def 'should be rejected due to abnormal loan amount'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(pesel: '1234567890'), amount: 99_999) + when: + LoanApplicationResult loanApplication = sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLICATION_REJECTED + loanApplication.rejectionReason == 'Amount too high' + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json new file mode 100644 index 0000000000..7229872299 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.fraud.v1+json" + } + }, + "url": "/fraudcheck", + "bodyPatterns": [ + { + "matches": "\\s*\\{\\s*\"clientPesel\"\\s*:\\s*\"?[0-9]{10}\"?\\s*,\\s*\"loanAmount\"\\s*:\\s*\"?99999\"?\\s*\\}\\s*" + } + ] + }, + "response": { + "status": 200, + "headers": { + "Content-Type": "application/vnd.fraud.v1+json" + }, + "body": "{\"fraudCheckStatus\":\"FRAUD\",\"rejectionReason\":\"Amount too high\"}" + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json new file mode 100644 index 0000000000..5a251171c7 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.fraud.v1+json" + } + }, + "url": "/fraudcheck", + "bodyPatterns": [ + { + "matches": "\\s*\\{\\s*\"clientPesel\"\\s*:\\s*\"?[0-9]{10}\"?\\s*,\\s*\"loanAmount\"\\s*:\\s*\"?123.123\"?\\s*\\}\\s*" + } + ] + }, + "response": { + "status": 200, + "headers": { + "Content-Type": "application/vnd.fraud.v1+json" + }, + "body": "{\"fraudCheckStatus\":\"OK\",\"rejectionReason\":null}" + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/settings.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/settings.gradle new file mode 100644 index 0000000000..48db488159 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleJerseyProject/settings.gradle @@ -0,0 +1,18 @@ +/* + * Copyright 2013-2016 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. + */ + +include ':fraudDetectionService' +include ':loanApplicationService' diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/build.gradle new file mode 100644 index 0000000000..eb108f14e3 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/build.gradle @@ -0,0 +1,116 @@ +/* + * Copyright 2013-2016 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. + */ + +buildscript { + repositories { + mavenCentral() + mavenLocal() + } + dependencies { + classpath("org.springframework.boot:spring-boot-gradle-plugin:1.2.6.RELEASE") + } +} + +ext { + restAssuredVersion = '2.5.0' + spockVersion = '1.0-groovy-2.4' + wiremockVersion = '2.0.10-beta' + + contractVerifierStubsBaseDirectory = 'src/test/resources/stubs' +} + +group = 'org.springframework.cloud.testprojects' + +subprojects { + apply plugin: 'groovy' + + repositories { + mavenCentral() + mavenLocal() + } + + dependencies { + testCompile "org.codehaus.groovy:groovy-all:2.4.5" + testCompile "org.spockframework:spock-core:$spockVersion" + testCompile("junit:junit:4.12") + testCompile "com.github.tomakehurst:wiremock:$wiremockVersion" + } +} + +configure([project(':fraudDetectionService'), project(':loanApplicationService')]) { + apply plugin: 'spring-boot' + apply plugin: 'contract-verifier' + apply plugin: 'maven-publish' + + ext { + contractsDir = file("mappings") + stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/") + } + + contractVerifier { + targetFramework = 'Spock' + testMode = 'MockMvc' + baseClassForTests = 'org.springframework.cloud.MvcSpec' + contractsDslDir = file("${project.projectDir.absolutePath}/mappings/") + generatedTestSourcesDir = file("${project.buildDir}/generated-test-sources/") + stubsOutputDir = stubsOutputDirRoot + } + + jar { + version = '0.0.1' + } + + dependencies { + compile("org.springframework.boot:spring-boot-starter-web") { + exclude module: "spring-boot-starter-tomcat" + } + compile("org.springframework.boot:spring-boot-starter-jetty") + compile("org.springframework.boot:spring-boot-starter-actuator") + + testRuntime "org.spockframework:spock-spring:$spockVersion" + testCompile "org.springframework:spring-test" + testCompile "com.jayway.restassured:rest-assured:$restAssuredVersion" + testCompile "com.jayway.restassured:spring-mock-mvc:$restAssuredVersion" + } + + task cleanup(type: Delete) { + delete 'src/test/resources/mappings', 'src/test/resources/stubs' + } + + clean.dependsOn('cleanup') + + test { + testLogging { + exceptionFormat = 'full' + } + } +} + +configure(project(':fraudDetectionService')) { + test.dependsOn('generateWireMockClientStubs') +} + +configure(project(':loanApplicationService')) { + + task copyCollaboratorStubs(type: Copy) { + File fraudBuildDir = project(':fraudDetectionService').buildDir + from(new File(fraudBuildDir, "/production/${project(':fraudDetectionService').name}-stubs/")) + into "src/test/resources/" + } + + generateContractTests.dependsOn('copyCollaboratorStubs') +} + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsFraud.groovy new file mode 100644 index 0000000000..a2e6875fd9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsFraud.groovy @@ -0,0 +1,44 @@ +/* + * Copyright 2013-2016 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. + */ +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method """PUT""" + url """/fraudcheck""" + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":99999} + """ + ) + headers { + header("""Content-Type""", """application/vnd.fraud.v1+json""") + } + + } + response { + status 200 + body( """{ + "fraudCheckStatus": "${value(client('FRAUD'), server(regex('[A-Z]{5}')))}", + "rejectionReason": "Amount too high" +}""") + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.groovy new file mode 100644 index 0000000000..76df090cd6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method 'PUT' + url '/fraudcheck' + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":123.123 + } + """ + ) + headers { + header('Content-Type', 'application/vnd.fraud.v1+json') + } + + } + response { + status 200 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/Application.java new file mode 100644 index 0000000000..bc8131fe49 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/Application.java @@ -0,0 +1,18 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class Application { + + public static void main(String[] args) { + SpringApplication.run( + org.springframework.cloud.frauddetection.Application.class, args); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/FraudDetectionController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/FraudDetectionController.java new file mode 100644 index 0000000000..213a037f87 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/FraudDetectionController.java @@ -0,0 +1,39 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.cloud.frauddetection.model.FraudCheck; +import org.springframework.cloud.frauddetection.model.FraudCheckResult; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.math.BigDecimal; + +import static org.springframework.cloud.frauddetection.model.FraudCheckStatus.FRAUD; +import static org.springframework.cloud.frauddetection.model.FraudCheckStatus.OK; +import static org.springframework.web.bind.annotation.RequestMethod.PUT; + +@RestController +public class FraudDetectionController { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = "application/vnd.fraud.v1+json"; + private static final String NO_REASON = null; + private static final String AMOUNT_TOO_HIGH = "Amount too high"; + private static final BigDecimal MAX_AMOUNT = new BigDecimal("5000"); + + @RequestMapping( + value = "/fraudcheck", + method = PUT, + consumes = FRAUD_SERVICE_JSON_VERSION_1, + produces = FRAUD_SERVICE_JSON_VERSION_1) + public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) { + if (amountGreaterThanThreshold(fraudCheck)) { + return new FraudCheckResult(FRAUD, AMOUNT_TOO_HIGH); + } + return new FraudCheckResult(OK, NO_REASON); + } + + private boolean amountGreaterThanThreshold(FraudCheck fraudCheck) { + return MAX_AMOUNT.compareTo(fraudCheck.getLoanAmount()) < 0; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheck.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheck.java new file mode 100644 index 0000000000..72551915bc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheck.java @@ -0,0 +1,29 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudCheck { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudCheck() { + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheckResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheckResult.java new file mode 100644 index 0000000000..95fd5e04c4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheckResult.java @@ -0,0 +1,32 @@ +package org.springframework.cloud.frauddetection.model; + +public class FraudCheckResult { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudCheckResult() { + } + + public FraudCheckResult(FraudCheckStatus fraudCheckStatus, String rejectionReason) { + this.fraudCheckStatus = fraudCheckStatus; + this.rejectionReason = rejectionReason; + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..b4fd951df2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/java/org/springframework/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/resources/application.yml new file mode 100644 index 0000000000..a30a91f034 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/main/resources/application.yml @@ -0,0 +1 @@ +server.port=8085 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy new file mode 100644 index 0000000000..dfff02db5e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy @@ -0,0 +1,31 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud + +import org.springframework.cloud.frauddetection.FraudDetectionController +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc +import spock.lang.Specification + +class MvcSpec extends Specification { + def setup() { + RestAssuredMockMvc.standaloneSetup(new FraudDetectionController()) + } + + void assertThatRejectionReasonIsNull(def rejectionReason) { + assert !rejectionReason + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java new file mode 100644 index 0000000000..8fa2aad6ff --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java @@ -0,0 +1,16 @@ +package org.springframework.cloud; + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc; +import org.junit.Before; + +public class MvcTest { + + @Before + public void setup() { + RestAssuredMockMvc.standaloneSetup(new org.springframework.cloud.frauddetection.FraudDetectionController()); + } + + public void assertThatRejectionReasonIsNull(Object rejectionReason) { + assert rejectionReason == null; + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradle/wrapper/gradle-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..1aa6b34ba4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +#Wed Jan 28 00:32:44 CET 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradlew b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradlew new file mode 100755 index 0000000000..91a7e269e1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradlew.bat b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradlew.bat new file mode 100644 index 0000000000..8a0b282aa6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/mappings/.gitkeep b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/mappings/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java new file mode 100644 index 0000000000..bc8131fe49 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java @@ -0,0 +1,18 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class Application { + + public static void main(String[] args) { + SpringApplication.run( + org.springframework.cloud.frauddetection.Application.class, args); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java new file mode 100644 index 0000000000..65ec787113 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java @@ -0,0 +1,68 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.cloud.frauddetection.model.FraudCheckStatus; +import org.springframework.cloud.frauddetection.model.FraudServiceRequest; +import org.springframework.cloud.frauddetection.model.FraudServiceResponse; +import org.springframework.cloud.frauddetection.model.LoanApplication; +import org.springframework.cloud.frauddetection.model.LoanApplicationResult; +import org.springframework.cloud.frauddetection.model.LoanApplicationStatus; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +@Service +public class LoanApplicationService { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = + "application/vnd.fraud.v1+json"; + + private final RestTemplate restTemplate; + + private int port = 8080; + + public LoanApplicationService() { + this.restTemplate = new RestTemplate(); + } + + public LoanApplicationResult loanApplication(LoanApplication loanApplication) { + FraudServiceRequest request = + new FraudServiceRequest(loanApplication); + + FraudServiceResponse response = + sendRequestToFraudDetectionService(request); + + return buildResponseFromFraudResult(response); + } + + private FraudServiceResponse sendRequestToFraudDetectionService( + FraudServiceRequest request) { + HttpHeaders httpHeaders = new HttpHeaders(); + httpHeaders.add(HttpHeaders.CONTENT_TYPE, FRAUD_SERVICE_JSON_VERSION_1); + + ResponseEntity response = + restTemplate.exchange("http://localhost:" + port + "/fraudcheck", HttpMethod.PUT, + new HttpEntity<>(request, httpHeaders), + FraudServiceResponse.class); + + return response.getBody(); + } + + private LoanApplicationResult buildResponseFromFraudResult(FraudServiceResponse response) { + LoanApplicationStatus applicationStatus = null; + if (FraudCheckStatus.OK == response.getFraudCheckStatus()) { + applicationStatus = LoanApplicationStatus.LOAN_APPLIED; + } else if (FraudCheckStatus.FRAUD == response.getFraudCheckStatus()) { + applicationStatus = LoanApplicationStatus.LOAN_APPLICATION_REJECTED; + } + + return new LoanApplicationResult(applicationStatus, response.getRejectionReason()); + } + + public void setPort(int port) { + this.port = port; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java new file mode 100644 index 0000000000..1a85740dde --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java @@ -0,0 +1,14 @@ +package org.springframework.cloud.frauddetection.model; + +public class Client { + + private String pesel; + + public String getPesel() { + return pesel; + } + + public void setPesel(String pesel) { + this.pesel = pesel; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..b4fd951df2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java new file mode 100644 index 0000000000..f79ff3b740 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java @@ -0,0 +1,34 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudServiceRequest { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudServiceRequest() { + } + + public FraudServiceRequest(LoanApplication loanApplication) { + this.clientPesel = loanApplication.getClient().getPesel(); + this.loanAmount = loanApplication.getAmount(); + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java new file mode 100644 index 0000000000..dbf8384a53 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java @@ -0,0 +1,27 @@ +package org.springframework.cloud.frauddetection.model; + +public class FraudServiceResponse { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudServiceResponse() { + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java new file mode 100644 index 0000000000..58757331d0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java @@ -0,0 +1,36 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class LoanApplication { + + private Client client; + + private BigDecimal amount; + + private String loanApplicationId; + + public Client getClient() { + return client; + } + + public void setClient(Client client) { + this.client = client; + } + + public BigDecimal getAmount() { + return amount; + } + + public void setAmount(BigDecimal amount) { + this.amount = amount; + } + + public String getLoanApplicationId() { + return loanApplicationId; + } + + public void setLoanApplicationId(String loanApplicationId) { + this.loanApplicationId = loanApplicationId; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java new file mode 100644 index 0000000000..11c3ee1d2c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java @@ -0,0 +1,32 @@ +package org.springframework.cloud.frauddetection.model; + +public class LoanApplicationResult { + + private LoanApplicationStatus loanApplicationStatus; + + private String rejectionReason; + + public LoanApplicationResult() { + } + + public LoanApplicationResult(LoanApplicationStatus loanApplicationStatus, String rejectionReason) { + this.loanApplicationStatus = loanApplicationStatus; + this.rejectionReason = rejectionReason; + } + + public LoanApplicationStatus getLoanApplicationStatus() { + return loanApplicationStatus; + } + + public void setLoanApplicationStatus(LoanApplicationStatus loanApplicationStatus) { + this.loanApplicationStatus = loanApplicationStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java new file mode 100644 index 0000000000..bdb886d0fc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum LoanApplicationStatus { + LOAN_APPLIED, LOAN_APPLICATION_REJECTED +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/resources/application.yml new file mode 100644 index 0000000000..e86bbd0e0f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/main/resources/application.yml @@ -0,0 +1 @@ +server.port=8090 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy new file mode 100644 index 0000000000..d5104eb499 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy @@ -0,0 +1,72 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud + +import org.springframework.cloud.frauddetection.Application +import org.springframework.cloud.frauddetection.LoanApplicationService +import org.springframework.cloud.frauddetection.model.Client +import org.springframework.cloud.frauddetection.model.LoanApplication +import org.springframework.cloud.frauddetection.model.LoanApplicationResult +import org.springframework.cloud.frauddetection.model.LoanApplicationStatus +import com.github.tomakehurst.wiremock.junit.WireMockClassRule +import org.junit.ClassRule +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.test.context.ContextConfiguration +import spock.lang.Shared +import spock.lang.Specification + +@ContextConfiguration(loader = SpringApplicationContextLoader, classes = Application) +class LoanApplicationServiceSpec extends Specification { + + public static int port = org.springframework.util.SocketUtils.findAvailableTcpPort() + + @ClassRule + @Shared + WireMockClassRule wireMockRule = new WireMockClassRule(port) + + @Autowired + LoanApplicationService sut + + def setup() { + sut.port = port + } + + def 'should successfully apply for loan'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(pesel: '1234567890'), amount: 123.123) + when: + LoanApplicationResult loanApplication = sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLIED + loanApplication.rejectionReason == null + } + + def 'should be rejected due to abnormal loan amount'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(pesel: '1234567890'), amount: 99_999) + when: + LoanApplicationResult loanApplication = sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLICATION_REJECTED + loanApplication.rejectionReason == 'Amount too high' + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json new file mode 100644 index 0000000000..157726ca2e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.fraud.v1+json" + } + }, + "url": "/fraudcheck", + "bodyPatterns": [ + { + "matches": "{\"clientPesel\":\"[0-9]{10}\",\"loanAmount\":\"99999\"}" + } + ] + }, + "response": { + "status": 200, + "headers": { + "Content-Type": "application/vnd.fraud.v1+json" + }, + "body": "{\"fraudCheckStatus\":\"FRAUD\",\"rejectionReason\":\"Amount too high\"}" + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json new file mode 100644 index 0000000000..afa27159d9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.fraud.v1+json" + } + }, + "url": "/fraudcheck", + "bodyPatterns": [ + { + "matches": "{\"clientPesel\":\"[0-9]{10}\",\"loanAmount\":\"123.123\"}" + } + ] + }, + "response": { + "status": 200, + "headers": { + "Content-Type": "application/vnd.fraud.v1+json" + }, + "body": "{\"fraudCheckStatus\":\"OK\",\"rejectionReason\":null}" + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/settings.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/settings.gradle new file mode 100644 index 0000000000..48db488159 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/sampleProject/settings.gradle @@ -0,0 +1,18 @@ +/* + * Copyright 2013-2016 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. + */ + +include ':fraudDetectionService' +include ':loanApplicationService' diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle new file mode 100644 index 0000000000..67fa4ba4b8 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/build.gradle @@ -0,0 +1,134 @@ +/* + * Copyright 2013-2016 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. + */ + +buildscript { + repositories { + mavenCentral() + mavenLocal() + } + dependencies { + classpath("org.springframework.boot:spring-boot-gradle-plugin:1.2.6.RELEASE") + } +} + +ext { + restAssuredVersion = '2.5.0' + spockVersion = '1.0-groovy-2.4' + wiremockVersion = '2.0.10-beta' + + contractVerifierStubsBaseDirectory = 'src/test/resources/stubs' +} + +group = 'org.springframework.cloud.testprojects' + +subprojects { + apply plugin: 'groovy' + apply plugin: 'maven-publish' + + repositories { + mavenCentral() + mavenLocal() + } + + dependencies { + testCompile "org.codehaus.groovy:groovy-all:2.4.5" + testCompile "org.spockframework:spock-core:$spockVersion" + testCompile("junit:junit:4.12") + testCompile "com.github.tomakehurst:wiremock:$wiremockVersion" + } +} + +configure([project(':fraudDetectionService'), project(':loanApplicationService')]) { + apply plugin: 'spring-boot' + apply plugin: 'contract-verifier' + + // tag::jar_setup[] + ext { + contractsDir = file("mappings") + stubsOutputDirRoot = file("${project.buildDir}/production/${project.name}-stubs/") + } + + // Automatically added by plugin: + // copyContracts - copies contracts to the output folder from which JAR will be created + // verifierStubsJar - JAR with a provided stub suffix + // the presented publication is also added by the plugin but you can modify it as you wish + + publishing { + publications { + stubs(MavenPublication) { + artifactId "${project.name}-stubs" + artifact verifierStubsJar + } + } + } + // end::jar_setup[] + + contractVerifier { + // tag::target_framework[] + targetFramework = 'Spock' + // end::target_framework[] + testMode = 'MockMvc' + baseClassForTests = 'org.springframework.cloud.MvcSpec' + contractsDslDir = file("${project.projectDir.absolutePath}/mappings/") + generatedTestSourcesDir = file("${project.buildDir}/generated-test-sources/") + stubsOutputDir = stubsOutputDirRoot + } + + jar { + version = '0.0.1' + } + + dependencies { + compile("org.springframework.boot:spring-boot-starter-web") { + exclude module: "spring-boot-starter-tomcat" + } + compile("org.springframework.boot:spring-boot-starter-jetty") + compile("org.springframework.boot:spring-boot-starter-actuator") + + testRuntime "org.spockframework:spock-spring:$spockVersion" + testCompile "org.springframework:spring-test" + testCompile "com.jayway.restassured:rest-assured:$restAssuredVersion" + testCompile "com.jayway.restassured:spring-mock-mvc:$restAssuredVersion" + } + + task cleanup(type: Delete) { + delete 'src/test/resources/mappings', 'src/test/resources/stubs' + } + + clean.dependsOn('cleanup') + + test { + testLogging { + exceptionFormat = 'full' + } + } +} + +configure(project(':fraudDetectionService')) { + test.dependsOn('generateWireMockClientStubs') +} + +configure(project(':loanApplicationService')) { + + task copyCollaboratorStubs(type: Copy) { + File fraudBuildDir = project(':fraudDetectionService').buildDir + from(new File(fraudBuildDir, "/production/${project(':fraudDetectionService').name}-stubs/")) + into "src/test/resources/" + } + + generateContractTests.dependsOn('copyCollaboratorStubs') +} + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/mappings/fraudDetectionService/1_shouldMarkClientAsNotFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/mappings/fraudDetectionService/1_shouldMarkClientAsNotFraud.groovy new file mode 100644 index 0000000000..76df090cd6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/mappings/fraudDetectionService/1_shouldMarkClientAsNotFraud.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method 'PUT' + url '/fraudcheck' + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":123.123 + } + """ + ) + headers { + header('Content-Type', 'application/vnd.fraud.v1+json') + } + + } + response { + status 200 + body( + fraudCheckStatus: "OK", + rejectionReason: $(client(null), server(execute('assertThatRejectionReasonIsNull($it)'))) + ) + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/mappings/fraudDetectionService/2_shouldMarkClientAsFraud.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/mappings/fraudDetectionService/2_shouldMarkClientAsFraud.groovy new file mode 100644 index 0000000000..1fc39340b5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/mappings/fraudDetectionService/2_shouldMarkClientAsFraud.groovy @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ + +import org.springframework.cloud.contract.spec.Contract + +Contract.make { + request { + method """PUT""" + url """/fraudcheck""" + body(""" + { + "clientPesel":"${value(client(regex('[0-9]{10}')), server('1234567890'))}", + "loanAmount":99999} + """ + ) + headers { + header("""Content-Type""", """application/vnd.fraud.v1+json""") + } + + } + response { + status 200 + body( """{ + "fraudCheckStatus": "${value(client('FRAUD'), server(regex('[A-Z]{5}')))}", + "rejectionReason": "Amount too high" +}""") + headers { + header('Content-Type': 'application/vnd.fraud.v1+json') + } + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/Application.java new file mode 100644 index 0000000000..bc8131fe49 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/Application.java @@ -0,0 +1,18 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class Application { + + public static void main(String[] args) { + SpringApplication.run( + org.springframework.cloud.frauddetection.Application.class, args); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudDetectionController.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudDetectionController.java new file mode 100644 index 0000000000..213a037f87 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/FraudDetectionController.java @@ -0,0 +1,39 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.cloud.frauddetection.model.FraudCheck; +import org.springframework.cloud.frauddetection.model.FraudCheckResult; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +import java.math.BigDecimal; + +import static org.springframework.cloud.frauddetection.model.FraudCheckStatus.FRAUD; +import static org.springframework.cloud.frauddetection.model.FraudCheckStatus.OK; +import static org.springframework.web.bind.annotation.RequestMethod.PUT; + +@RestController +public class FraudDetectionController { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = "application/vnd.fraud.v1+json"; + private static final String NO_REASON = null; + private static final String AMOUNT_TOO_HIGH = "Amount too high"; + private static final BigDecimal MAX_AMOUNT = new BigDecimal("5000"); + + @RequestMapping( + value = "/fraudcheck", + method = PUT, + consumes = FRAUD_SERVICE_JSON_VERSION_1, + produces = FRAUD_SERVICE_JSON_VERSION_1) + public FraudCheckResult fraudCheck(@RequestBody FraudCheck fraudCheck) { + if (amountGreaterThanThreshold(fraudCheck)) { + return new FraudCheckResult(FRAUD, AMOUNT_TOO_HIGH); + } + return new FraudCheckResult(OK, NO_REASON); + } + + private boolean amountGreaterThanThreshold(FraudCheck fraudCheck) { + return MAX_AMOUNT.compareTo(fraudCheck.getLoanAmount()) < 0; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheck.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheck.java new file mode 100644 index 0000000000..72551915bc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheck.java @@ -0,0 +1,29 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudCheck { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudCheck() { + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckResult.java new file mode 100644 index 0000000000..95fd5e04c4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckResult.java @@ -0,0 +1,32 @@ +package org.springframework.cloud.frauddetection.model; + +public class FraudCheckResult { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudCheckResult() { + } + + public FraudCheckResult(FraudCheckStatus fraudCheckStatus, String rejectionReason) { + this.fraudCheckStatus = fraudCheckStatus; + this.rejectionReason = rejectionReason; + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..b4fd951df2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/resources/application.yml new file mode 100644 index 0000000000..a30a91f034 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/main/resources/application.yml @@ -0,0 +1 @@ +server.port=8085 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy new file mode 100644 index 0000000000..dfff02db5e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/test/groovy/org/springframework/cloud/MvcSpec.groovy @@ -0,0 +1,31 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud + +import org.springframework.cloud.frauddetection.FraudDetectionController +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc +import spock.lang.Specification + +class MvcSpec extends Specification { + def setup() { + RestAssuredMockMvc.standaloneSetup(new FraudDetectionController()) + } + + void assertThatRejectionReasonIsNull(def rejectionReason) { + assert !rejectionReason + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java new file mode 100644 index 0000000000..8fa2aad6ff --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/fraudDetectionService/src/test/java/org/springframework/cloud/MvcTest.java @@ -0,0 +1,16 @@ +package org.springframework.cloud; + +import com.jayway.restassured.module.mockmvc.RestAssuredMockMvc; +import org.junit.Before; + +public class MvcTest { + + @Before + public void setup() { + RestAssuredMockMvc.standaloneSetup(new org.springframework.cloud.frauddetection.FraudDetectionController()); + } + + public void assertThatRejectionReasonIsNull(Object rejectionReason) { + assert rejectionReason == null; + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradle/wrapper/gradle-wrapper.properties b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..1aa6b34ba4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,22 @@ +# +# Copyright 2013-2016 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. +# + +#Wed Jan 28 00:32:44 CET 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradlew b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradlew new file mode 100755 index 0000000000..91a7e269e1 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradlew.bat b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradlew.bat new file mode 100644 index 0000000000..8a0b282aa6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/mappings/.gitkeep b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/mappings/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java new file mode 100644 index 0000000000..bc8131fe49 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/Application.java @@ -0,0 +1,18 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.context.annotation.Configuration; + +@Configuration +@EnableAutoConfiguration +@ComponentScan +public class Application { + + public static void main(String[] args) { + SpringApplication.run( + org.springframework.cloud.frauddetection.Application.class, args); + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java new file mode 100644 index 0000000000..65ec787113 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/LoanApplicationService.java @@ -0,0 +1,68 @@ +package org.springframework.cloud.frauddetection; + +import org.springframework.cloud.frauddetection.model.FraudCheckStatus; +import org.springframework.cloud.frauddetection.model.FraudServiceRequest; +import org.springframework.cloud.frauddetection.model.FraudServiceResponse; +import org.springframework.cloud.frauddetection.model.LoanApplication; +import org.springframework.cloud.frauddetection.model.LoanApplicationResult; +import org.springframework.cloud.frauddetection.model.LoanApplicationStatus; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +@Service +public class LoanApplicationService { + + private static final String FRAUD_SERVICE_JSON_VERSION_1 = + "application/vnd.fraud.v1+json"; + + private final RestTemplate restTemplate; + + private int port = 8080; + + public LoanApplicationService() { + this.restTemplate = new RestTemplate(); + } + + public LoanApplicationResult loanApplication(LoanApplication loanApplication) { + FraudServiceRequest request = + new FraudServiceRequest(loanApplication); + + FraudServiceResponse response = + sendRequestToFraudDetectionService(request); + + return buildResponseFromFraudResult(response); + } + + private FraudServiceResponse sendRequestToFraudDetectionService( + FraudServiceRequest request) { + HttpHeaders httpHeaders = new HttpHeaders(); + httpHeaders.add(HttpHeaders.CONTENT_TYPE, FRAUD_SERVICE_JSON_VERSION_1); + + ResponseEntity response = + restTemplate.exchange("http://localhost:" + port + "/fraudcheck", HttpMethod.PUT, + new HttpEntity<>(request, httpHeaders), + FraudServiceResponse.class); + + return response.getBody(); + } + + private LoanApplicationResult buildResponseFromFraudResult(FraudServiceResponse response) { + LoanApplicationStatus applicationStatus = null; + if (FraudCheckStatus.OK == response.getFraudCheckStatus()) { + applicationStatus = LoanApplicationStatus.LOAN_APPLIED; + } else if (FraudCheckStatus.FRAUD == response.getFraudCheckStatus()) { + applicationStatus = LoanApplicationStatus.LOAN_APPLICATION_REJECTED; + } + + return new LoanApplicationResult(applicationStatus, response.getRejectionReason()); + } + + public void setPort(int port) { + this.port = port; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java new file mode 100644 index 0000000000..1a85740dde --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/Client.java @@ -0,0 +1,14 @@ +package org.springframework.cloud.frauddetection.model; + +public class Client { + + private String pesel; + + public String getPesel() { + return pesel; + } + + public void setPesel(String pesel) { + this.pesel = pesel; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java new file mode 100644 index 0000000000..b4fd951df2 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudCheckStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum FraudCheckStatus { + OK, FRAUD +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java new file mode 100644 index 0000000000..f79ff3b740 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceRequest.java @@ -0,0 +1,34 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class FraudServiceRequest { + + private String clientPesel; + + private BigDecimal loanAmount; + + public FraudServiceRequest() { + } + + public FraudServiceRequest(LoanApplication loanApplication) { + this.clientPesel = loanApplication.getClient().getPesel(); + this.loanAmount = loanApplication.getAmount(); + } + + public String getClientPesel() { + return clientPesel; + } + + public void setClientPesel(String clientPesel) { + this.clientPesel = clientPesel; + } + + public BigDecimal getLoanAmount() { + return loanAmount; + } + + public void setLoanAmount(BigDecimal loanAmount) { + this.loanAmount = loanAmount; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java new file mode 100644 index 0000000000..dbf8384a53 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/FraudServiceResponse.java @@ -0,0 +1,27 @@ +package org.springframework.cloud.frauddetection.model; + +public class FraudServiceResponse { + + private FraudCheckStatus fraudCheckStatus; + + private String rejectionReason; + + public FraudServiceResponse() { + } + + public FraudCheckStatus getFraudCheckStatus() { + return fraudCheckStatus; + } + + public void setFraudCheckStatus(FraudCheckStatus fraudCheckStatus) { + this.fraudCheckStatus = fraudCheckStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java new file mode 100644 index 0000000000..58757331d0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplication.java @@ -0,0 +1,36 @@ +package org.springframework.cloud.frauddetection.model; + +import java.math.BigDecimal; + +public class LoanApplication { + + private Client client; + + private BigDecimal amount; + + private String loanApplicationId; + + public Client getClient() { + return client; + } + + public void setClient(Client client) { + this.client = client; + } + + public BigDecimal getAmount() { + return amount; + } + + public void setAmount(BigDecimal amount) { + this.amount = amount; + } + + public String getLoanApplicationId() { + return loanApplicationId; + } + + public void setLoanApplicationId(String loanApplicationId) { + this.loanApplicationId = loanApplicationId; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java new file mode 100644 index 0000000000..11c3ee1d2c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationResult.java @@ -0,0 +1,32 @@ +package org.springframework.cloud.frauddetection.model; + +public class LoanApplicationResult { + + private LoanApplicationStatus loanApplicationStatus; + + private String rejectionReason; + + public LoanApplicationResult() { + } + + public LoanApplicationResult(LoanApplicationStatus loanApplicationStatus, String rejectionReason) { + this.loanApplicationStatus = loanApplicationStatus; + this.rejectionReason = rejectionReason; + } + + public LoanApplicationStatus getLoanApplicationStatus() { + return loanApplicationStatus; + } + + public void setLoanApplicationStatus(LoanApplicationStatus loanApplicationStatus) { + this.loanApplicationStatus = loanApplicationStatus; + } + + public String getRejectionReason() { + return rejectionReason; + } + + public void setRejectionReason(String rejectionReason) { + this.rejectionReason = rejectionReason; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java new file mode 100644 index 0000000000..bdb886d0fc --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/java/org/springframework/cloud/frauddetection/model/LoanApplicationStatus.java @@ -0,0 +1,5 @@ +package org.springframework.cloud.frauddetection.model; + +public enum LoanApplicationStatus { + LOAN_APPLIED, LOAN_APPLICATION_REJECTED +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/resources/application.yml b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/resources/application.yml new file mode 100644 index 0000000000..e86bbd0e0f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/main/resources/application.yml @@ -0,0 +1 @@ +server.port=8090 \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy new file mode 100644 index 0000000000..eae9a5c817 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/groovy/org/springframework/cloud/LoanApplicationServiceSpec.groovy @@ -0,0 +1,74 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud + +import org.springframework.cloud.frauddetection.Application +import org.springframework.cloud.frauddetection.LoanApplicationService +import org.springframework.cloud.frauddetection.model.Client +import org.springframework.cloud.frauddetection.model.LoanApplication +import org.springframework.cloud.frauddetection.model.LoanApplicationResult +import org.springframework.cloud.frauddetection.model.LoanApplicationStatus +import com.github.tomakehurst.wiremock.junit.WireMockClassRule +import org.junit.ClassRule +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.boot.test.SpringApplicationContextLoader +import org.springframework.test.context.ContextConfiguration +import spock.lang.Shared +import spock.lang.Specification +import spock.lang.Stepwise + +@ContextConfiguration(loader = SpringApplicationContextLoader, classes = Application) +@Stepwise +class LoanApplicationServiceSpec extends Specification { + + public static int port = org.springframework.util.SocketUtils.findAvailableTcpPort() + + @ClassRule + @Shared + WireMockClassRule wireMockRule = new WireMockClassRule(port) + + @Autowired + LoanApplicationService sut + + def setup() { + sut.port = port + } + + def 'should successfully apply for loan'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(pesel: '1234567890'), amount: 123.123) + when: + LoanApplicationResult loanApplication = sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLIED + loanApplication.rejectionReason == null + } + + def 'should be rejected due to abnormal loan amount'() { + given: + LoanApplication application = + new LoanApplication(client: new Client(pesel: '1234567890'), amount: 99_999) + when: + LoanApplicationResult loanApplication = sut.loanApplication(application) + then: + loanApplication.loanApplicationStatus == LoanApplicationStatus.LOAN_APPLICATION_REJECTED + loanApplication.rejectionReason == 'Amount too high' + } + + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json new file mode 100644 index 0000000000..157726ca2e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsFraud.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.fraud.v1+json" + } + }, + "url": "/fraudcheck", + "bodyPatterns": [ + { + "matches": "{\"clientPesel\":\"[0-9]{10}\",\"loanAmount\":\"99999\"}" + } + ] + }, + "response": { + "status": 200, + "headers": { + "Content-Type": "application/vnd.fraud.v1+json" + }, + "body": "{\"fraudCheckStatus\":\"FRAUD\",\"rejectionReason\":\"Amount too high\"}" + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json new file mode 100644 index 0000000000..afa27159d9 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/loanApplicationService/src/test/resources/mappings/fraudDetectionService/shouldMarkClientAsNotFraud.json @@ -0,0 +1,23 @@ +{ + "request": { + "method": "PUT", + "headers": { + "Content-Type": { + "equalTo": "application/vnd.fraud.v1+json" + } + }, + "url": "/fraudcheck", + "bodyPatterns": [ + { + "matches": "{\"clientPesel\":\"[0-9]{10}\",\"loanAmount\":\"123.123\"}" + } + ] + }, + "response": { + "status": 200, + "headers": { + "Content-Type": "application/vnd.fraud.v1+json" + }, + "body": "{\"fraudCheckStatus\":\"OK\",\"rejectionReason\":null}" + } +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/settings.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/settings.gradle new file mode 100644 index 0000000000..48db488159 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-gradle-plugin/src/test/resources/functionalTest/scenarioProject/settings.gradle @@ -0,0 +1,18 @@ +/* + * Copyright 2013-2016 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. + */ + +include ':fraudDetectionService' +include ':loanApplicationService' diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/README.adoc b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/README.adoc new file mode 100644 index 0000000000..2488410263 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/README.adoc @@ -0,0 +1,23 @@ + = Spring Cloud Contract Verifier Messaging + +Spring Cloud Contract Verifier allows you to verify your application that uses messaging as means of communication. +All of our integrations are working with Spring but you can also set one yourself. + +== Integrations + +You can use one of the three integration configurations: + +- Apache Camel +- Spring Integration +- Spring Cloud Stream + +If you're using Spring Boot, the aforementioned test configurations will be appended automatically. + +== Manual Integration + +The `spring-cloud-contract-verifier-messaging-core` module contains 3 main interfaces: + +- `ContractVerifierMessage` - describes a message received / sent to a channel / queue / topic etc. +- `ContractVerifierMessageBuilder` - describes how to build a message +- `ContractVerifierMessaging` - class that allows you to build, send and receive messages + diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/build.gradle new file mode 100644 index 0000000000..fd255690d6 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/build.gradle @@ -0,0 +1,22 @@ +/* + * Copyright 2013-2016 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. + */ +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-messaging-root:$verifier-messaging-core") + compile "org.apache.camel:camel-spring:${camelVersion}" + compile 'org.slf4j:slf4j-api:1.6.0' +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/CamelMessage.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/CamelMessage.java new file mode 100644 index 0000000000..1d4a94257d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/CamelMessage.java @@ -0,0 +1,56 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.camel; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.apache.camel.Message; + +import java.util.Map; + +/** + * @author Marcin Grzejszczak + */ +public class CamelMessage implements ContractVerifierMessage { + + private final Message delegate; + + public CamelMessage(Message delegate) { + this.delegate = delegate; + } + + @Override + @SuppressWarnings("unchecked") + public T getPayload() { + return (T) delegate.getBody(); + } + + @Override + public Map getHeaders() { + return delegate.getHeaders(); + } + + @Override + public Object getHeader(String key) { + return getHeaders().get(key); + } + + @Override + public Message convert() { + return delegate; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelConfiguration.java new file mode 100644 index 0000000000..71280d4700 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelConfiguration.java @@ -0,0 +1,37 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.camel; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.apache.camel.CamelContext; +import org.springframework.context.annotation.Bean; + +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierCamelConfiguration { + + @Bean ContractVerifierMessaging contractVerifierMessaging(CamelContext context, + ContractVerifierMessageBuilder builder) { + return new ContractVerifierCamelMessaging(context, builder); + } + + @Bean ContractVerifierMessageBuilder contractVerifierMessageBuilder() { + return new ContractVerifierCamelMessageBuilder(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelMessageBuilder.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelMessageBuilder.java new file mode 100644 index 0000000000..77aa4f2c91 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelMessageBuilder.java @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.camel; + +import java.util.Map; + +import org.apache.camel.Message; +import org.apache.camel.impl.DefaultMessage; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; + +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierCamelMessageBuilder implements + ContractVerifierMessageBuilder { + + @Override + public ContractVerifierMessage create(T payload, Map headers) { + DefaultMessage message = new DefaultMessage(); + message.setBody(payload); + message.setHeaders(headers); + return new CamelMessage<>(message); + } + + @Override + public ContractVerifierMessage create(Message message) { + if (message == null) { + return null; + } + return new CamelMessage<>(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelMessaging.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelMessaging.java new file mode 100644 index 0000000000..14b0a7db36 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/java/org/springframework/cloud/contract/verifier/messaging/camel/ContractVerifierCamelMessaging.java @@ -0,0 +1,107 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.camel; + +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.ConsumerTemplate; +import org.apache.camel.Exchange; +import org.apache.camel.Message; +import org.apache.camel.ProducerTemplate; +import org.apache.camel.impl.DefaultExchange; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.springframework.stereotype.Component; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; + +/** + * @author Marcin Grzejszczak + */ +@Component +public class ContractVerifierCamelMessaging implements + ContractVerifierMessaging { + + private static final Logger log = LoggerFactory.getLogger( + ContractVerifierCamelMessaging.class); + + private final CamelContext context; + private final ContractVerifierMessageBuilder builder; + + @Autowired + @SuppressWarnings("unchecked") + public ContractVerifierCamelMessaging(CamelContext context, ContractVerifierMessageBuilder contractVerifierMessageBuilder) { + this.context = context; + this.builder = contractVerifierMessageBuilder; + } + + @Override + public void send(ContractVerifierMessage message, String destination) { + try { + ProducerTemplate producerTemplate = context.createProducerTemplate(); + Exchange exchange = new DefaultExchange(context); + exchange.setIn(message.convert()); + producerTemplate.send(destination, exchange); + } catch (Exception e) { + log.error("Exception occurred while trying to send a message [" + message + "] " + + "to a channel with name [" + destination + "]", e); + throw e; + } + } + + @Override + @SuppressWarnings("unchecked") + public void send(T payload, Map headers, String destination) { + send(builder.create(payload, headers), destination); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage receiveMessage(String destination, long timeout, TimeUnit timeUnit) { + try { + ConsumerTemplate consumerTemplate = context.createConsumerTemplate(); + Exchange exchange = consumerTemplate.receive(destination, timeUnit.toMillis(timeout)); + return builder.create(exchange.getIn()); + } catch (Exception e) { + log.error("Exception occurred while trying to read a message from " + + " a channel with name [" + destination + "]", e); + throw new RuntimeException(e); + } + } + + @Override + public ContractVerifierMessage receiveMessage(String destination) { + return receiveMessage(destination, 5, TimeUnit.SECONDS); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage create(T t, Map headers) { + return builder.create(t, headers); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage create(Message message) { + return builder.create(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..4515c7bbdb --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-camel/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.verifier.messaging.camel.ContractVerifierCamelConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/build.gradle new file mode 100644 index 0000000000..e785784138 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/build.gradle @@ -0,0 +1,23 @@ +/* + * Copyright 2013-2016 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. + */ + +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-messaging-root:$verifier-messaging-core") + compile "org.springframework:spring-messaging:${springVersion}" + compile 'org.slf4j:slf4j-api:1.6.0' +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationConfiguration.java new file mode 100644 index 0000000000..3f1ddc2c97 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationConfiguration.java @@ -0,0 +1,36 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.integration; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; + +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierIntegrationConfiguration { + + @Bean ContractVerifierMessaging contractVerifierMessaging(ApplicationContext applicationContext, ContractVerifierMessageBuilder contractVerifierMessageBuilder) { + return new ContractVerifierIntegrationMessaging(applicationContext, contractVerifierMessageBuilder); + } + + @Bean ContractVerifierMessageBuilder contractVerifierMessageBuilder() { + return new ContractVerifierIntegrationMessageBuilder(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationMessageBuilder.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationMessageBuilder.java new file mode 100644 index 0000000000..60f10b1493 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationMessageBuilder.java @@ -0,0 +1,45 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.integration; + +import java.util.Map; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.messaging.Message; +import org.springframework.messaging.MessageHeaders; +import org.springframework.messaging.support.MessageBuilder; + +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierIntegrationMessageBuilder implements + ContractVerifierMessageBuilder> { + + @Override + public ContractVerifierMessage> create(T payload, Map headers) { + return new IntegrationMessage<>(MessageBuilder.createMessage(payload, new MessageHeaders(headers))); + } + + @Override + public ContractVerifierMessage> create(Message message) { + if (message == null) { + return null; + } + return new IntegrationMessage<>(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationMessaging.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationMessaging.java new file mode 100644 index 0000000000..960e07d520 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/ContractVerifierIntegrationMessaging.java @@ -0,0 +1,102 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.integration; + +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.context.ApplicationContext; +import org.springframework.messaging.Message; +import org.springframework.messaging.MessageChannel; +import org.springframework.messaging.PollableChannel; +import org.springframework.stereotype.Component; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; + +/** + * @author Marcin Grzejszczak + */ +@Component +public class ContractVerifierIntegrationMessaging implements + ContractVerifierMessaging> { + + private static final Logger log = LoggerFactory.getLogger( + ContractVerifierIntegrationMessaging.class); + + private final ApplicationContext context; + private final ContractVerifierMessageBuilder builder; + + @Autowired + @SuppressWarnings("unchecked") + public ContractVerifierIntegrationMessaging(ApplicationContext context, ContractVerifierMessageBuilder contractVerifierMessageBuilder) { + this.context = context; + this.builder = contractVerifierMessageBuilder; + } + + @Override + @SuppressWarnings("unchecked") + public void send(T payload, Map headers, String destination) { + send(builder.create(payload, headers), destination); + } + + @Override + public void send(ContractVerifierMessage> message, String destination) { + try { + MessageChannel messageChannel = context.getBean(destination, MessageChannel.class); + messageChannel.send(message.convert()); + } catch (Exception e) { + log.error("Exception occurred while trying to send a message [" + message + "] " + + "to a channel with name [" + destination + "]", e); + throw e; + } + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage> receiveMessage(String destination, long timeout, TimeUnit timeUnit) { + try { + PollableChannel messageChannel = context.getBean(destination, PollableChannel.class); + return builder.create(messageChannel.receive(timeUnit.toMillis(timeout))); + } catch (Exception e) { + log.error("Exception occurred while trying to read a message from " + + " a channel with name [" + destination + "]", e); + throw new RuntimeException(e); + } + } + + @Override + public ContractVerifierMessage> receiveMessage(String destination) { + return receiveMessage(destination, 5, TimeUnit.SECONDS); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage> create(T t, Map headers) { + return builder.create(t, headers); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage> create(Message message) { + return builder.create(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/IntegrationMessage.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/IntegrationMessage.java new file mode 100644 index 0000000000..b75e92eb69 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/java/org/springframework/cloud/contract/verifier/messaging/integration/IntegrationMessage.java @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.integration; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.messaging.Message; +import org.springframework.messaging.MessageHeaders; + +/** + * @author Marcin Grzejszczak + */ +public class IntegrationMessage implements ContractVerifierMessage> { + + private final Message delegate; + + public IntegrationMessage(Message delegate) { + this.delegate = delegate; + } + + @Override + public T getPayload() { + return delegate.getPayload(); + } + + @Override + public MessageHeaders getHeaders() { + return delegate.getHeaders(); + } + + @Override + public Object getHeader(String key) { + return getHeaders().get(key); + } + + @Override + public Message convert() { + return delegate; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..2251d19bd0 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-integration/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.verifier.messaging.integration.ContractVerifierIntegrationConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/build.gradle new file mode 100644 index 0000000000..068826284e --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/build.gradle @@ -0,0 +1,24 @@ +/* + * Copyright 2013-2016 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. + */ + +repositories { + jcenter() +} + +dependencies { + compile 'com.fasterxml.jackson.core:jackson-databind:2.7.0' + compile 'javax.inject:javax.inject:1' +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierFilter.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierFilter.java new file mode 100644 index 0000000000..3c864f1bee --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierFilter.java @@ -0,0 +1,30 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging; + +/** + * Contract for filtering out messages that do not match the structure in the Contract DSL + * + * @author Marcin Grzejszczak + */ +public interface ContractVerifierFilter { + + /** + * @return @{code true} if the message should be passed through, @{code false} if the message should be filtered out, + */ + boolean matches(ContractVerifierMessage message); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessage.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessage.java new file mode 100644 index 0000000000..c8510cd526 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessage.java @@ -0,0 +1,48 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging; + +import java.util.Map; + +/** + * Describes a message. Contains payload and headers. A message can be converted + * to another type (e.g. Spring Messaging Message) + * + * @author Marcin Grzejszczak + */ +public interface ContractVerifierMessage { + + /** + * Returns a payload of type {@code PAYLOAD} + */ + PAYLOAD getPayload(); + + /** + * Returns a map of headers + */ + Map getHeaders(); + + /** + * Returns a header for a given key + */ + Object getHeader(String key); + + /** + * Converts the message to {@code TYPE_TO_CONVERT_INTO} type + */ + TYPE_TO_CONVERT_INTO convert(); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessageBuilder.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessageBuilder.java new file mode 100644 index 0000000000..7325ac29de --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessageBuilder.java @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging; + +import java.util.Map; + +/** + * Contract for creation of (@link ContractVerifierMessage}. You can create a message from + * payload and headers or from some type (e.g. Spring Messaging Message). + * + * @author Marcin Grzejszczak + */ +public interface ContractVerifierMessageBuilder { + + /** + * Creates a {@link ContractVerifierMessage} from payload and headers + */ + ContractVerifierMessage create(PAYLOAD payload, Map headers); + + /** + * Creates a {@link ContractVerifierMessage} from the {@code TYPE_TO_CONVERT_INTO} type + */ + ContractVerifierMessage create(TYPE_TO_CONVERT_INTO typeToConvertInto); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessaging.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessaging.java new file mode 100644 index 0000000000..01c377aa8f --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessaging.java @@ -0,0 +1,51 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging; + +import java.util.Map; +import java.util.concurrent.TimeUnit; + +/** + * Core interface that allows you to build, send and receive messages. + * + * Destination is relevant to the underlaying implementation. Might be a channel, queue, topic etc. + * + * @author Marcin Grzejszczak + */ +public interface ContractVerifierMessaging extends + ContractVerifierMessageBuilder { + /** + * Sends the {@link ContractVerifierMessage} to the given destination. + */ + void send(ContractVerifierMessage message, String destination); + + /** + * Sends the given payload with headers, to the given destination. + */ + void send(PAYLOAD payload, Map headers, String destination); + + /** + * Receives the {@link ContractVerifierMessage} from the given destination. You can provide the timeout + * for receiving that message. + */ + ContractVerifierMessage receiveMessage(String destination, long timeout, TimeUnit timeUnit); + + /** + * Receives the {@link ContractVerifierMessage} from the given destination. A default timeout will be applied. + */ + ContractVerifierMessage receiveMessage(String destination); +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessagingUtil.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessagingUtil.java new file mode 100644 index 0000000000..18de368aa5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierMessagingUtil.java @@ -0,0 +1,114 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging; + +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; + +/** + * Helper class that allows to build headers in a nice way + * + * @author Marcin Grzejszczak + */ +public class ContractVerifierMessagingUtil { + + public static ContractVerifierHeaders headers() { + return new ContractVerifierHeaders(); + } + + public static class ContractVerifierHeaders implements Map { + + private final Map delegate = new HashMap<>(); + + public ContractVerifierHeaders header(String key, Object value) { + put(key, value); + return this; + } + + @Override + public int size() { + return delegate.size(); + } + + @Override + public boolean isEmpty() { + return delegate.isEmpty(); + } + + @Override + public boolean containsKey(Object key) { + return delegate.containsKey(key); + } + + @Override + public boolean containsValue(Object value) { + return delegate.containsValue(value); + } + + @Override + public Object get(Object key) { + return delegate.get(key); + } + + @Override + public Object put(String key, Object value) { + return delegate.put(key, value); + } + + @Override + public Object remove(Object key) { + return delegate.remove(key); + } + + @Override + public void putAll(Map m) { + delegate.putAll(m); + } + + @Override + public void clear() { + delegate.clear(); + } + + @Override + public Set keySet() { + return delegate.keySet(); + } + + @Override + public Collection values() { + return delegate.values(); + } + + @Override + public Set> entrySet() { + return delegate.entrySet(); + } + + @Override + public boolean equals(Object o) { + return delegate.equals(o); + } + + @Override + public int hashCode() { + return delegate.hashCode(); + } + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierObjectMapper.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierObjectMapper.java new file mode 100644 index 0000000000..dfbdcf461d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/ContractVerifierObjectMapper.java @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; + +/** + * Wrapper over {@link ObjectMapper} that won't try to parse + * String but will directly return it. + * + * @author Marcin Grzejszczak + */ +public class ContractVerifierObjectMapper { + + private final ObjectMapper objectMapper; + + public ContractVerifierObjectMapper(ObjectMapper objectMapper) { + this.objectMapper = objectMapper; + } + + public ContractVerifierObjectMapper() { + this.objectMapper = new ObjectMapper(); + } + + public String writeValueAsString(Object payload) throws JsonProcessingException { + if (payload instanceof String) { + return payload.toString(); + } + return objectMapper.writeValueAsString(payload); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessage.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessage.java new file mode 100644 index 0000000000..c7c37514d5 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessage.java @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.noop; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; + +import java.util.Map; + +/** + * @author Marcin Grzejszczak + */ +public class NoOpContractVerifierMessage implements ContractVerifierMessage { + @Override + public Object getPayload() { + return null; + } + + @Override + public Map getHeaders() { + return null; + } + + @Override + public Object getHeader(String key) { + return null; + } + + @Override + public Object convert() { + return null; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessageBuilder.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessageBuilder.java new file mode 100644 index 0000000000..edd9a3142c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessageBuilder.java @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.noop; + +import java.util.Map; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; + +/** + * @author Marcin Grzejszczak + */ +public class NoOpContractVerifierMessageBuilder + implements ContractVerifierMessageBuilder { + @Override + public ContractVerifierMessage create(Object o, Map headers) { + return new NoOpContractVerifierMessage(); + } + + @Override + public ContractVerifierMessage create(Object o) { + return new NoOpContractVerifierMessage(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessaging.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessaging.java new file mode 100644 index 0000000000..da28a92d56 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-messaging-core/src/main/java/org/springframework/cloud/contract/verifier/messaging/noop/NoOpContractVerifierMessaging.java @@ -0,0 +1,58 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.noop; + +import java.util.Map; +import java.util.concurrent.TimeUnit; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; + +/** + * @author Marcin Grzejszczak + */ +public class NoOpContractVerifierMessaging implements ContractVerifierMessaging { + @Override + public void send(ContractVerifierMessage message, String destination) { + + } + + @Override + public void send(Object payload, Map headers, String destination) { + + } + + @Override + public ContractVerifierMessage receiveMessage(String destination, long timeout, TimeUnit timeUnit) { + return null; + } + + @Override + public ContractVerifierMessage receiveMessage(String destination) { + return null; + } + + @Override + public ContractVerifierMessage create(Object o, Map headers) { + return null; + } + + @Override + public ContractVerifierMessage create(Object o) { + return null; + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/build.gradle b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/build.gradle new file mode 100644 index 0000000000..bfaed27076 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/build.gradle @@ -0,0 +1,24 @@ +/* + * Copyright 2013-2016 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. + */ + +String verifier = "spring-cloud-contract-verifier" + +dependencies { + compile project(":$verifier-root:$verifier-messaging-root:$verifier-messaging-core") + compile "org.springframework.cloud:spring-cloud-stream:${springStreamVersion}" + // for MessageCollector + compile "org.springframework.cloud:spring-cloud-stream-test-support:${springStreamVersion}" +} \ No newline at end of file diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamAutoConfiguration.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamAutoConfiguration.java new file mode 100644 index 0000000000..00d445917d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamAutoConfiguration.java @@ -0,0 +1,38 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.stream; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * @author Marcin Grzejszczak + */ +@Configuration +public class ContractVerifierStreamAutoConfiguration { + + @Bean ContractVerifierMessaging contractVerifierMessaging(ApplicationContext applicationContext, ContractVerifierMessageBuilder contractVerifierMessageBuilder) { + return new ContractVerifierStreamMessaging(applicationContext, contractVerifierMessageBuilder); + } + + @Bean ContractVerifierMessageBuilder contractVerifierMessageBuilder() { + return new ContractVerifierStreamMessageBuilder(); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamMessageBuilder.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamMessageBuilder.java new file mode 100644 index 0000000000..90270657b4 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamMessageBuilder.java @@ -0,0 +1,46 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.stream; + +import java.util.Map; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.messaging.Message; +import org.springframework.messaging.MessageHeaders; +import org.springframework.messaging.support.MessageBuilder; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; + +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierStreamMessageBuilder implements + ContractVerifierMessageBuilder> { + + @Override + public ContractVerifierMessage> create(T payload, Map headers) { + return new StreamMessage<>(MessageBuilder.createMessage(payload, new MessageHeaders(headers))); + } + + @Override + public ContractVerifierMessage> create(Message message) { + if (message == null) { + return null; + } + return new StreamMessage<>(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamMessaging.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamMessaging.java new file mode 100644 index 0000000000..3b885a4801 --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/ContractVerifierStreamMessaging.java @@ -0,0 +1,115 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.stream; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessageBuilder; +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessaging; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cloud.stream.config.BindingProperties; +import org.springframework.cloud.stream.config.ChannelBindingServiceProperties; +import org.springframework.cloud.stream.test.binder.MessageCollector; +import org.springframework.context.ApplicationContext; +import org.springframework.messaging.Message; +import org.springframework.messaging.MessageChannel; + +import java.util.Map; +import java.util.concurrent.TimeUnit; + +/** + * @author Marcin Grzejszczak + */ +public class ContractVerifierStreamMessaging implements + ContractVerifierMessaging> { + + private static final Logger log = LoggerFactory.getLogger(ContractVerifierStreamMessaging.class); + + private final ApplicationContext context; + private final MessageCollector messageCollector; + private final ContractVerifierMessageBuilder builder; + + @Autowired + @SuppressWarnings("unchecked") + public ContractVerifierStreamMessaging(ApplicationContext context, ContractVerifierMessageBuilder builder) { + this.context = context; + this.messageCollector = context.getBean(MessageCollector.class); + this.builder = builder; + } + + @Override + @SuppressWarnings("unchecked") + public void send(T payload, Map headers, String destination) { + send(builder.create(payload, headers), destination); + } + + @Override + public void send(ContractVerifierMessage> message, String destination) { + try { + MessageChannel messageChannel = context.getBean(resolvedDestination(destination), MessageChannel.class); + messageChannel.send(message.convert()); + } catch (Exception e) { + log.error("Exception occurred while trying to send a message [" + message + "] " + + "to a channel with name [" + destination + "]", e); + throw e; + } + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage> receiveMessage(String destination, long timeout, TimeUnit timeUnit) { + try { + MessageChannel messageChannel = context.getBean(resolvedDestination(destination), MessageChannel.class); + return builder.create(messageCollector.forChannel(messageChannel).poll(timeout, timeUnit)); + } catch (Exception e) { + log.error("Exception occurred while trying to read a message from " + + " a channel with name [" + destination + "]", e); + throw new RuntimeException(e); + } + } + + private String resolvedDestination(String destination) { + ChannelBindingServiceProperties channelBindingServiceProperties = context.getBean(ChannelBindingServiceProperties.class); + String resolvedDestination = destination; + for (Map.Entry entry : channelBindingServiceProperties.getBindings().entrySet()) { + if (entry.getValue().getDestination().equals(destination)) { + log.debug("Found a channel named [{}] with destination [{}]", entry.getKey(), destination); + return entry.getKey(); + } + } + log.debug("No destination named [{}] was found. Assuming that the destination equals the channel name", destination); + return resolvedDestination; + } + + @Override + public ContractVerifierMessage> receiveMessage(String destination) { + return receiveMessage(destination, 5, TimeUnit.SECONDS); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage> create(T t, Map headers) { + return builder.create(t, headers); + } + + @Override + @SuppressWarnings("unchecked") + public ContractVerifierMessage> create(Message message) { + return builder.create(message); + } +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/StreamMessage.java b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/StreamMessage.java new file mode 100644 index 0000000000..7582daf46a --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/java/org/springframework/cloud/contract/verifier/messaging/stream/StreamMessage.java @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.messaging.stream; + +import org.springframework.cloud.contract.verifier.messaging.ContractVerifierMessage; +import org.springframework.messaging.Message; +import org.springframework.messaging.MessageHeaders; + +/** + * @author Marcin Grzejszczak + */ +public class StreamMessage implements ContractVerifierMessage> { + + private final Message delegate; + + public StreamMessage(Message delegate) { + this.delegate = delegate; + } + + @Override + public T getPayload() { + return delegate.getPayload(); + } + + @Override + public MessageHeaders getHeaders() { + return delegate.getHeaders(); + } + + @Override + public Object getHeader(String key) { + return getHeaders().get(key); + } + + @Override + public Message convert() { + return delegate; + } + +} diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/resources/META-INF/spring.factories b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/resources/META-INF/spring.factories new file mode 100644 index 0000000000..6b6e2b930d --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-messaging/spring-cloud-contract-verifier-stream/src/main/resources/META-INF/spring.factories @@ -0,0 +1,3 @@ +# Auto Configuration +org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ +org.springframework.cloud.contract.verifier.messaging.stream.ContractVerifierStreamAutoConfiguration diff --git a/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-testing-utils/src/main/groovy/org/springframework/cloud/contract/verifier/util/AssertionUtil.groovy b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-testing-utils/src/main/groovy/org/springframework/cloud/contract/verifier/util/AssertionUtil.groovy new file mode 100644 index 0000000000..8b23a3473c --- /dev/null +++ b/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier/spring-cloud-contract-verifier-testing-utils/src/main/groovy/org/springframework/cloud/contract/verifier/util/AssertionUtil.groovy @@ -0,0 +1,28 @@ +/* + * Copyright 2013-2016 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. + */ + +package org.springframework.cloud.contract.verifier.util + +import org.skyscreamer.jsonassert.JSONAssert + +class AssertionUtil { + + private static boolean NON_STRICT = false + + public static void assertThatJsonsAreEqual(String expected, String actual) { + JSONAssert.assertEquals(expected, actual, NON_STRICT) + } +}