diff --git a/pact/pact-message-consumer/.gitignore b/pact/pact-message-consumer/.gitignore new file mode 100644 index 0000000..c9f7010 --- /dev/null +++ b/pact/pact-message-consumer/.gitignore @@ -0,0 +1,25 @@ +.gradle +/build/ +!gradle/wrapper/gradle-wrapper.jar + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +nbproject/private/ +build/ +nbbuild/ +dist/ +nbdist/ +.nb-gradle/ \ No newline at end of file diff --git a/pact/pact-message-consumer/README.md b/pact/pact-message-consumer/README.md new file mode 100644 index 0000000..d8fbf91 --- /dev/null +++ b/pact/pact-message-consumer/README.md @@ -0,0 +1,15 @@ +# Consumer-Driven-Contract Test for a Spring Boot Provider + +This repo contains an example of consumer-driven-contract testing for a Spring +Boot API provider. The corresponding consumer to the contract is +implemented in the module `pact-angular`. + +The contract is created and verified with [Pact](https://docs.pact.io/). + +Before running the build, you need to follow the instructions on the [consumer-side](../pact-angular/) +to create the consumer-driven contract file (pact file). + +## Running the application + +The interesting part in this code base is the class `UserControllerProviderTest`. +You can run the tests with `gradlew test` on Windows or `./gradlew test` on Unix. \ No newline at end of file diff --git a/pact/pact-message-consumer/application.yml b/pact/pact-message-consumer/application.yml new file mode 100644 index 0000000..bfca1b8 --- /dev/null +++ b/pact/pact-message-consumer/application.yml @@ -0,0 +1,11 @@ +spring: + datasource: + url: jdbc:h2:mem:AZ;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE + driverClassName: org.h2.Driver + username: sa + password: + h2: + console: + enabled: true + +logging.level.org.hibernate.SQL: OFF \ No newline at end of file diff --git a/pact/pact-message-consumer/build.gradle b/pact/pact-message-consumer/build.gradle new file mode 100644 index 0000000..3895d57 --- /dev/null +++ b/pact/pact-message-consumer/build.gradle @@ -0,0 +1,36 @@ +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath("org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}") + } +} + +apply plugin: 'java' +apply plugin: 'eclipse' +apply plugin: 'org.springframework.boot' +apply plugin: 'io.spring.dependency-management' + +version = '0.0.1-SNAPSHOT' +sourceCompatibility = 1.8 + +repositories { + mavenLocal() + mavenCentral() +} + +dependencies { + compile('org.springframework.boot:spring-boot-starter-data-jpa') + compile('org.springframework.boot:spring-boot-starter-web') + compile('org.springframework.boot:spring-boot-starter-amqp') + compile('com.h2database:h2:1.4.196') + compileOnly('org.projectlombok:lombok') + testCompile("au.com.dius:pact-jvm-consumer-junit_2.12:${pact_version}") + testCompile("au.com.dius:pact-jvm-consumer-groovy_2.12:${pact_version}") + testCompile('org.springframework.boot:spring-boot-starter-test') +} + +bootRun { + jvmArgs = ["-Xdebug", "-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"] +} diff --git a/pact/pact-message-consumer/gradle.properties b/pact/pact-message-consumer/gradle.properties new file mode 100644 index 0000000..7cc49a1 --- /dev/null +++ b/pact/pact-message-consumer/gradle.properties @@ -0,0 +1,2 @@ +springboot_version=2.0.4.RELEASE +pact_version=3.5.20 \ No newline at end of file diff --git a/pact/pact-message-consumer/gradle/wrapper/gradle-wrapper.jar b/pact/pact-message-consumer/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..1a958be Binary files /dev/null and b/pact/pact-message-consumer/gradle/wrapper/gradle-wrapper.jar differ diff --git a/pact/pact-message-consumer/gradle/wrapper/gradle-wrapper.properties b/pact/pact-message-consumer/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..52dd1f0 --- /dev/null +++ b/pact/pact-message-consumer/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip diff --git a/pact/pact-message-consumer/gradlew b/pact/pact-message-consumer/gradlew new file mode 100644 index 0000000..4453cce --- /dev/null +++ b/pact/pact-message-consumer/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# 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 + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# 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 +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +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" -a "$nonstop" = "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 + +# Escape application args +save ( ) { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/pact/pact-message-consumer/gradlew.bat b/pact/pact-message-consumer/gradlew.bat new file mode 100644 index 0000000..f955316 --- /dev/null +++ b/pact/pact-message-consumer/gradlew.bat @@ -0,0 +1,84 @@ +@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 + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@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= + +@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 + +: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=%* + +: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/pact/pact-message-consumer/src/main/java/io/reflectoring/DemoApplication.java b/pact/pact-message-consumer/src/main/java/io/reflectoring/DemoApplication.java new file mode 100644 index 0000000..222eabe --- /dev/null +++ b/pact/pact-message-consumer/src/main/java/io/reflectoring/DemoApplication.java @@ -0,0 +1,15 @@ +package io.reflectoring; + +import org.springframework.amqp.rabbit.annotation.EnableRabbit; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.web.servlet.config.annotation.EnableWebMvc; + +@SpringBootApplication +@EnableRabbit +public class DemoApplication { + + public static void main(String[] args) { + SpringApplication.run(DemoApplication.class, args); + } +} diff --git a/pact/pact-message-consumer/src/main/java/io/reflectoring/MessageConsumerConfiguration.java b/pact/pact-message-consumer/src/main/java/io/reflectoring/MessageConsumerConfiguration.java new file mode 100644 index 0000000..5e5706d --- /dev/null +++ b/pact/pact-message-consumer/src/main/java/io/reflectoring/MessageConsumerConfiguration.java @@ -0,0 +1,59 @@ +package io.reflectoring; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.springframework.amqp.core.Binding; +import org.springframework.amqp.core.BindingBuilder; +import org.springframework.amqp.core.Queue; +import org.springframework.amqp.core.TopicExchange; +import org.springframework.amqp.rabbit.connection.ConnectionFactory; +import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer; +import org.springframework.amqp.rabbit.listener.adapter.MessageListenerAdapter; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class MessageConsumerConfiguration { + + private static final String QUEUE_NAME = "myQueue"; + + private static final String EXCHANGE_NAME = "myExchange"; + + @Bean + public TopicExchange receiverExchange() { + return new TopicExchange(EXCHANGE_NAME); + } + + @Bean + public Queue queue() { + return new Queue(QUEUE_NAME); + } + + @Bean + public Binding binding(Queue eventReceivingQueue, TopicExchange receiverExchange) { + return BindingBuilder + .bind(eventReceivingQueue) + .to(receiverExchange) + .with("*.*"); + } + + @Bean + public SimpleMessageListenerContainer container(ConnectionFactory connectionFactory, + MessageListenerAdapter listenerAdapter) { + SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(); + container.setConnectionFactory(connectionFactory); + container.setQueueNames(QUEUE_NAME); + container.setMessageListener(listenerAdapter); + return container; + } + + @Bean + public MessageListenerAdapter listenerAdapter(StringMessageConsumer stringMessageConsumer) { + return new MessageListenerAdapter(stringMessageConsumer, "consumeStringMessage"); + } + + @Bean + public StringMessageConsumer eventReceiver(ObjectMapper objectMapper) { + return new StringMessageConsumer(objectMapper); + } + +} diff --git a/pact/pact-message-consumer/src/main/java/io/reflectoring/StringMessageConsumer.java b/pact/pact-message-consumer/src/main/java/io/reflectoring/StringMessageConsumer.java new file mode 100644 index 0000000..f5cabfa --- /dev/null +++ b/pact/pact-message-consumer/src/main/java/io/reflectoring/StringMessageConsumer.java @@ -0,0 +1,37 @@ +package io.reflectoring; + + +import javax.validation.ConstraintViolation; +import javax.validation.ConstraintViolationException; +import javax.validation.Validation; +import javax.validation.Validator; + +import java.io.IOException; +import java.util.Set; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class StringMessageConsumer { + + private Logger logger = LoggerFactory.getLogger(StringMessageConsumer.class); + + private ObjectMapper objectMapper; + + public StringMessageConsumer(ObjectMapper objectMapper) { + this.objectMapper = objectMapper; + } + + public void consumeStringMessage(String messageString) throws IOException { + logger.info("Consuming message '{}'", messageString); + UserCreatedMessage message = objectMapper.readValue(messageString, UserCreatedMessage.class); + Validator validator = Validation.buildDefaultValidatorFactory().getValidator(); + Set> violations = validator.validate(message); + if(!violations.isEmpty()){ + throw new ConstraintViolationException(violations); + } + // do something with the message + } + +} diff --git a/pact/pact-message-consumer/src/main/java/io/reflectoring/User.java b/pact/pact-message-consumer/src/main/java/io/reflectoring/User.java new file mode 100644 index 0000000..0825130 --- /dev/null +++ b/pact/pact-message-consumer/src/main/java/io/reflectoring/User.java @@ -0,0 +1,16 @@ +package io.reflectoring; + +import javax.validation.constraints.NotNull; + +import lombok.Data; + +@Data +public class User { + + @NotNull + private long id; + + @NotNull + private String name; + +} diff --git a/pact/pact-message-consumer/src/main/java/io/reflectoring/UserCreatedMessage.java b/pact/pact-message-consumer/src/main/java/io/reflectoring/UserCreatedMessage.java new file mode 100644 index 0000000..e06180f --- /dev/null +++ b/pact/pact-message-consumer/src/main/java/io/reflectoring/UserCreatedMessage.java @@ -0,0 +1,16 @@ +package io.reflectoring; + +import javax.validation.constraints.NotNull; + +import lombok.Data; + +@Data +public class UserCreatedMessage { + + @NotNull + private String messageUuid; + + @NotNull + private User user; + +} diff --git a/pact/pact-message-consumer/src/test/java/io/reflectoring/StringMessageConsumerTest.java b/pact/pact-message-consumer/src/test/java/io/reflectoring/StringMessageConsumerTest.java new file mode 100644 index 0000000..238131e --- /dev/null +++ b/pact/pact-message-consumer/src/test/java/io/reflectoring/StringMessageConsumerTest.java @@ -0,0 +1,59 @@ +package io.reflectoring; + +import java.io.IOException; + +import au.com.dius.pact.consumer.MessagePactBuilder; +import au.com.dius.pact.consumer.MessagePactProviderRule; +import au.com.dius.pact.consumer.Pact; +import au.com.dius.pact.consumer.PactVerification; +import au.com.dius.pact.consumer.dsl.PactDslJsonBody; +import au.com.dius.pact.model.v3.messaging.MessagePact; +import org.junit.Rule; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.junit4.SpringRunner; + +@RunWith(SpringRunner.class) +@SpringBootTest +public class StringMessageConsumerTest { + + @Rule + public MessagePactProviderRule mockProvider = new MessagePactProviderRule(this); + private byte[] currentMessage; + + @Autowired + private StringMessageConsumer stringMessageConsumer; + + @Pact(state = "provider is up and running", provider = "userservice", consumer = "userclient") + public MessagePact userCreatedMessagePact(MessagePactBuilder builder) { + PactDslJsonBody body = new PactDslJsonBody(); + body.stringType("messageUuid"); + body.object("user") + .numberType("id", 42L) + .stringType("name", "Zaphod Beeblebrox") + .closeObject(); + + // @formatter:off + return builder + .expectsToReceive("a user created message") + .withContent(body) + .toPact(); + // @formatter:on + } + + @Test + @PactVerification("userCreatedMessagePact") + public void verifyCreatePersonPact() throws IOException { + stringMessageConsumer.consumeStringMessage(new String(this.currentMessage)); + } + + /** + * This method is called by the Pact framework. + */ + public void setMessage(byte[] message) { + this.currentMessage = message; + } + +} diff --git a/pact/pact-message-consumer/target/pacts/userclient-userservice.json b/pact/pact-message-consumer/target/pacts/userclient-userservice.json new file mode 100644 index 0000000..f05d97d --- /dev/null +++ b/pact/pact-message-consumer/target/pacts/userclient-userservice.json @@ -0,0 +1,59 @@ +{ + "consumer": { + "name": "userclient" + }, + "provider": { + "name": "userservice" + }, + "messages": [ + { + "description": "a user created message", + "metaData": { + "Content-Type": "application/json; charset=UTF-8" + }, + "contents": { + "messageUuid": "string", + "user": { + "name": "Zaphod Beeblebrox", + "id": 42 + } + }, + "matchingRules": { + "body": { + "$.messageUuid": { + "matchers": [ + { + "match": "type" + } + ], + "combine": "AND" + }, + "$.user.id": { + "matchers": [ + { + "match": "number" + } + ], + "combine": "AND" + }, + "$.user.name": { + "matchers": [ + { + "match": "type" + } + ], + "combine": "AND" + } + } + } + } + ], + "metadata": { + "pactSpecification": { + "version": "3.0.0" + }, + "pact-jvm": { + "version": "3.5.20" + } + } +} \ No newline at end of file diff --git a/settings.gradle b/settings.gradle index eb39aad..f7afe9f 100644 --- a/settings.gradle +++ b/settings.gradle @@ -9,6 +9,7 @@ include 'spring-cloud:spring-cloud-contract-consumer' include 'pact:pact-spring-provider' include 'pact:pact-feign-consumer' +include 'pact:pact-message-consumer' include 'spring-boot:rabbitmq-event-brokering'