Compare commits

...

113 Commits

Author SHA1 Message Date
Tom Hombergs
e316c2dc04 rename module to "spring-boot-springdoc" 2020-06-05 07:10:41 +10:00
Petros Stergioulas
c36bedd679 Remove actuator 2020-05-25 19:01:49 +02:00
Petros Stergioulas
eff3c3c935 Add security and actuator 2020-05-16 19:49:07 +02:00
Petros Stergioulas
94f88c4489 Add security and actuator 2020-05-16 19:46:43 +02:00
Petros Stergioulas
bb7ac442b1 Init 2020-04-29 20:07:36 +02:00
Petros Stergioulas
5da17c5a20 Implement UserApiDelegate, instead of the UserApi 2020-03-09 20:08:40 +01:00
Petros Stergioulas
26739aada2 Rename module to spring-boot-openapi, also add maven wrapper in root 2020-02-11 20:59:00 +01:00
Petros Stergioulas
dabc601384 Reflect-91 init 2020-02-09 22:25:26 +01:00
thombergs
0be1335d24 add EXPOSE 2020-02-06 06:45:21 +11:00
thombergs
1437ac4429 added warning do code that isn't working 2020-02-03 06:56:10 +11:00
thombergs
5b76cbac62 reduces visibility 2020-02-03 06:37:25 +11:00
thombergs
b6d167f4ae finished reactive example 2020-02-02 06:45:58 +11:00
Tom Hombergs
ec2bdc9327 Reactive Batch Processing Example 2020-01-31 19:48:06 +11:00
Tom Hombergs
5fe5deca66 added Single.defer to fan out messages over multiple threads 2020-01-31 09:18:02 +11:00
Tom Hombergs
3fb809911a Reactive Batch Processing Example 2020-01-30 21:35:03 +11:00
Tom Hombergs
3461549263 AWS Hello World docker file 2020-01-23 06:59:18 +11:00
Tom Hombergs
9e9b030c3f add README 2019-12-31 08:47:14 +11:00
Tom Hombergs
71af6ee95d add example for Spring Boot profiles 2019-12-31 08:40:49 +11:00
Tom Hombergs
b8e0845744 added missing gradle wrapper 2019-12-14 08:06:21 +11:00
Tom Hombergs
8baf275c8f isolated all modules 2019-12-14 07:59:28 +11:00
Tom Hombergs
92c266586c isolated some modules 2019-12-13 06:38:02 +11:00
Tom Hombergs
802046466f finish startup code example 2019-12-02 06:08:28 +11:00
Tom Hombergs
895d48c163 add startup examples 2019-11-30 07:46:18 +11:00
Tom Hombergs
6667bcde4d added @ConstructorBinding annotation 2019-11-17 06:33:05 +11:00
Tom Hombergs
5975aff396 modified code to match blog post 2019-11-17 06:25:58 +11:00
Tom Hombergs
44fb22ff50 fixed build 2019-11-10 10:29:35 +11:00
Tom Hombergs
dff7cf37f0 added missing gradle wrapper 2019-11-10 09:31:28 +11:00
Tom Hombergs
659a602e97 added code example for static data 2019-11-10 09:18:16 +11:00
Tom Hombergs
d34df7ad4e fixed build 2019-09-25 10:10:02 +02:00
Tom Hombergs
4c1318cc50 added immutable example code 2019-09-25 09:05:26 +02:00
Tom Hombergs
aa09ca31cb added mocking example 2019-09-18 08:03:33 +02:00
Tom Hombergs
7712f41e3e travis skip install 2019-09-03 06:44:50 +02:00
Tom Hombergs
2690f6b14d empty install, single call to each sub module in build-all.sh 2019-09-03 06:43:06 +02:00
Tom Hombergs
fa74e78e5d fixed travis build 2019-09-03 06:30:59 +02:00
Tom Hombergs
2c50fa9a12 fixed travis build 2019-09-03 06:01:01 +02:00
Tom Hombergs
c48921f554 fixed travis build 2019-09-03 05:46:55 +02:00
Tom Hombergs
df9575152f Merge remote-tracking branch 'origin/master' 2019-09-03 05:23:19 +02:00
Tom Hombergs
203c8d053a separated validation module from the rest 2019-09-03 05:23:07 +02:00
Tom Hombergs
9cf783c0a4 fixed URL 2019-08-30 21:14:09 +02:00
Tom Hombergs
9049c0f970 finalized code example for spring boot starter 2019-08-30 06:09:09 +02:00
Tom Hombergs
58c58e02d4 added permission for build.gradle 2019-08-28 21:38:13 +02:00
Tom Hombergs
9f84fcd49f added event-starter to travis build 2019-08-28 21:25:11 +02:00
Tom Hombergs
5646e0f169 added example Spring Boot Starter 2019-08-28 21:21:05 +02:00
Tom Hombergs
43e82f71d2 introduced BDDMockito 2019-07-01 21:39:09 +02:00
Tom Hombergs
8877f30ebc upgraded to Java 11 and fixed build 2019-03-30 08:02:10 +01:00
Tom Hombergs
b0ae545cd8 fixed compile error 2019-03-30 06:54:26 +01:00
Tom Hombergs
fb0aeb0a36 paging examples 2019-03-30 06:47:49 +01:00
Tom Hombergs
b3532e2f1e paging 2019-03-28 06:09:03 +01:00
Tom Hombergs
2c8d828ca1 pagination example 2019-03-25 15:35:32 +01:00
Tom Hombergs
d660463d74 added code examples for @ConfigurationProperties 2019-03-17 11:52:32 +01:00
Tom Hombergs
3207a3bc82 added README 2019-03-07 21:23:10 +01:00
Tom Hombergs
14039b84d5 added missing gradle files 2019-03-07 21:20:21 +01:00
Tom Hombergs
7528cd0069 code examples for Spring Boot @Conditionals 2019-03-07 06:44:14 +01:00
Tom Hombergs
f7e158a83c added missing flyway and liquibase scripts 2019-03-01 16:24:24 +01:00
Tom Hombergs
d01cccb574 refactored @SpringBootConfiguration examples 2019-03-01 11:52:52 +01:00
Tom Hombergs
71fad7e002 added code examples for @SpringBootTest article 2019-02-24 06:55:20 +01:00
Tom Hombergs
93f8074914 added missing test classes 2019-02-03 06:20:48 +01:00
Tom Hombergs
5ecb279f64 fixed build 2019-02-03 06:19:55 +01:00
Tom Hombergs
d5713b6ca3 code examples for @DataJpaTest 2019-02-03 06:15:17 +01:00
Tom Hombergs
188b53f526 moved jacocoTestReport to test instead of build phase 2019-01-31 21:00:14 +01:00
Tom Hombergs
86e8458980 minor changes 2019-01-21 06:36:50 +01:00
Tom Hombergs
8d8937c6bf tutorial about testing web controllers 2019-01-21 05:20:05 +01:00
Tom Hombergs
5352631522 Update README.md 2019-01-12 15:39:17 +01:00
Tom Hombergs
5f85a1cf67 added spring boot unit test example 2019-01-12 08:28:18 +01:00
Tom Hombergs
576a726cbd refactoring 2018-11-14 22:49:31 +01:00
Tom Hombergs
027abc1271 fixed node messaging example 2018-11-14 21:11:30 +01:00
Tom Hombergs
037dca0127 added .gitignore 2018-11-12 23:15:57 +01:00
Tom Hombergs
b245679a55 replaced broker config with local pact 2018-11-12 23:02:54 +01:00
Tom Hombergs
375b46309b added example for a node message provider 2018-11-12 23:00:33 +01:00
Tom Hombergs
38d9b4ee72 removed trailing comma 2018-11-11 21:56:28 +01:00
Tom Hombergs
93edb8c6f8 renamed test script 2018-11-11 21:55:48 +01:00
Tom Hombergs
a4c3f21391 node message consumer example 2018-11-11 21:55:18 +01:00
Tom Hombergs
382c307ae9 fixes for graphql consumer 2018-11-10 11:45:39 +01:00
Tom Hombergs
3e2c23cf45 added graphql provider test 2018-11-08 21:49:22 +01:00
Tom Hombergs
01242c5674 added missing setup script 2018-11-08 21:05:01 +01:00
Tom Hombergs
a58b5e670d added graphql consumer example 2018-11-08 16:31:46 +01:00
Tom Hombergs
a5a1381e1b added article link 2018-10-28 08:31:35 +01:00
Tom Hombergs
da30072399 re-created example repeating tutorial steps 2018-10-28 04:46:48 +01:00
Tom Hombergs
65c49a3ea7 added pact-node-provider example 2018-10-28 04:17:28 +01:00
Tom Hombergs
5fb2d69ca7 removed users endpoint 2018-10-27 06:02:57 +02:00
Tom Hombergs
a2df3dde0b basic heroes endpoint 2018-10-27 06:00:02 +02:00
Tom Hombergs
ff2030eafd basic express server 2018-10-27 05:47:23 +02:00
Tom Hombergs
4e45af2fbd basic express server 2018-10-27 05:47:06 +02:00
Tom Hombergs
8b384c602b updated README 2018-10-25 21:10:22 +02:00
Tom Hombergs
c11403d8fa added react pact example 2018-10-25 13:31:45 +02:00
Tom Hombergs
e8786b1bc3 ignored failing test due to complicated CI setup 2018-10-14 15:57:25 +02:00
Tom Hombergs
dab12b2c3c ignored failing test due to complicated CI setup 2018-10-14 15:37:33 +02:00
Tom Hombergs
31515b8a35 added missing classes 2018-10-14 15:07:06 +02:00
Tom Hombergs
aa05723b18 removed local jdk11 reference 2018-10-14 14:58:54 +02:00
Tom Hombergs
cac0c62b71 fixed jacoco build 2018-10-14 14:54:50 +02:00
Tom Hombergs
24d00fae37 Spring Boot Bean Validation example 2018-10-14 14:48:57 +02:00
Tom Hombergs
03f1680103 added jacoco code example 2018-10-05 21:06:13 +02:00
Tom Hombergs
884546b69c added dependency to spring-cloud-contract-provider 2018-10-02 06:42:40 +02:00
Tom Hombergs
be8be2efc4 added --info to travis build 2018-10-02 06:21:48 +02:00
Tom Hombergs
0e2f10862e changed port 2018-10-02 06:11:47 +02:00
Tom Hombergs
441cd4f801 updated gradle wrapper and activated junit 5 tests in gradle build 2018-09-15 12:08:15 +02:00
Tom Hombergs
de7fa53d55 refactored message pact examples 2018-09-13 06:24:27 +02:00
Tom Hombergs
b4bec09a3e updated readmes 2018-09-10 21:45:22 +02:00
Tom Hombergs
818e162c7f Merge branch 'pact-message-provider' 2018-09-10 21:42:04 +02:00
Tom Hombergs
a18ad84da2 working (but awkward) example of a message provider test 2018-09-10 21:41:49 +02:00
Tom Hombergs
d60f95b6c0 added readme with link to article 2018-08-31 09:00:24 +02:00
Tom Hombergs
52bc347d12 added object mother with fluent builder example 2018-08-31 08:59:04 +02:00
Tom Hombergs
5e93dcb84b updated messaging example for cleaner separation of publishing and converting messages 2018-08-26 22:58:14 +02:00
Tom Hombergs
3b0eb77b5d example for message provider with pact (not working yet) 2018-08-24 11:16:30 +02:00
Tom Hombergs
a9c9faba1d added example for a message consumer test with pact 2018-08-22 21:32:54 +02:00
Tom Hombergs
8672d163e2 updated spring-cloud-contract exampled to current versions 2018-08-16 22:27:41 +02:00
Tom Hombergs
3eefd80192 removed the manual truncating 2018-08-11 21:35:37 +02:00
Tom Hombergs
5a36a2365e updated pact provider example to JUnit 5 and Spring Boot 2 2018-08-11 16:47:03 +02:00
Tom Hombergs
5f675f91a8 changed logging configuration 2018-08-11 00:22:08 +02:00
Tom Hombergs
3559378d1a logging example with Spring Boot and Logback 2018-08-11 00:00:15 +02:00
Tom Hombergs
b72ab0d580 Merge pull request #8 from thombergs/cdc-updates
updated pact-feign example to Spring Boot 2 and JUnit 5
2018-08-10 00:14:21 +02:00
Tom Hombergs
ed45066496 updated pact-feign example to Spring Boot 2 and JUnit 5 2018-08-10 00:09:11 +02:00
Tom Hombergs
ddb3e08ee5 Merge pull request #7 from thombergs/logging-format
removed deprecated examples
2018-08-04 09:21:55 +02:00
582 changed files with 40469 additions and 417 deletions

3
.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
**/.idea/
**/*.iml

View File

@@ -1,11 +0,0 @@
<component name="libraryTable">
<library name="Gradle: org.projectlombok:lombok:1.16.20">
<CLASSES>
<root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/org.projectlombok/lombok/1.16.20/ac76d9b956045631d1561a09289cbf472e077c01/lombok-1.16.20.jar!/" />
</CLASSES>
<JAVADOC />
<SOURCES>
<root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/org.projectlombok/lombok/1.16.20/69ebf81bb97bdb3c9581c171762bb4929cb5289c/lombok-1.16.20-sources.jar!/" />
</SOURCES>
</library>
</component>

View File

@@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<module external.linked.project.id=":spring-boot:spring-boot-testing" external.linked.project.path="$MODULE_DIR$/../../spring-boot/spring-boot-testing" external.root.project.path="$MODULE_DIR$/../.." external.system.id="GRADLE" external.system.module.group="reflectoring.io" external.system.module.version="0.0.1-SNAPSHOT" type="JAVA_MODULE" version="4">
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing">
<excludeFolder url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing/.gradle" />
<excludeFolder url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing/build" />
<excludeFolder url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing/out" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

View File

@@ -1,5 +1,5 @@
before_install:
- chmod +x gradlew
- chmod +x build-all.sh
- |
if ! git diff --name-only $TRAVIS_COMMIT_RANGE | grep -qvE '(.md)|^(LICENSE)'
then
@@ -7,7 +7,12 @@ before_install:
exit
fi
install: skip
script:
- ./build-all.sh
language: java
jdk:
- oraclejdk8
- oraclejdk11

View File

@@ -2,7 +2,20 @@
[![Travis CI Status](https://travis-ci.org/thombergs/code-examples.svg?branch=master)](https://travis-ci.org/thombergs/code-examples)
This repo contains example projects which show how to use different java technologies.
This repo contains example projects which show how to use different (not only) Java technologies.
The examples are usually accompanied by a blog post on [https://reflectoring.io](https://reflectoring.io).
See the READMEs in each subdirectory of this repo for more information.
See the READMEs in each subdirectory of this repo for more information on each module.
## Java Modules
All Java modules require **Java 11** to compile and run.
### Building with Gradle
Each module should be an independent build and can be built by calling `./gradlew clean build` in the module directory.
All modules are listed in [build-all.sh](build-all.sh) to run in the CI pipeline.
### Non-Java Modules
Some folders contain non-Java projects. For those, refer to the README within the module folder.

32
aws/aws-hello-world/.gitignore vendored Normal file
View File

@@ -0,0 +1,32 @@
HELP.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**
!**/src/test/**
### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/
### VS Code ###
.vscode/

View File

@@ -0,0 +1,5 @@
FROM openjdk:8-jdk-alpine
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java","-jar","/app.jar"]
EXPOSE 8080

View File

@@ -0,0 +1,24 @@
plugins {
id 'org.springframework.boot' version '2.2.4.RELEASE'
id 'io.spring.dependency-management' version '1.0.9.RELEASE'
id 'java'
}
group = 'io.reflectoring'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
testImplementation('org.springframework.boot:spring-boot-starter-test') {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}
}
test {
useJUnitPlatform()
}

Binary file not shown.

View File

@@ -1,6 +1,5 @@
#Sun Jul 30 16:58:54 CEST 2017
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-all.zip

172
aws/aws-hello-world/gradlew vendored Executable file
View File

@@ -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" "$@"

0
gradlew.bat → aws/aws-hello-world/gradlew.bat vendored Normal file → Executable file
View File

View File

@@ -0,0 +1 @@
rootProject.name = 'aws-hello-world'

View File

@@ -0,0 +1,13 @@
package io.reflectoring.awshelloworld;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class AwsHelloWorldApplication {
public static void main(String[] args) {
SpringApplication.run(AwsHelloWorldApplication.class, args);
}
}

View File

@@ -0,0 +1,14 @@
package io.reflectoring.awshelloworld;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloWorldController {
@GetMapping("/hello")
public String helloWorld(){
return "Hello AWS!";
}
}

View File

@@ -0,0 +1 @@

View File

@@ -0,0 +1,13 @@
package io.reflectoring.awshelloworld;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class AwsHelloWorldApplicationTests {
@Test
void contextLoads() {
}
}

68
build-all.sh Executable file
View File

@@ -0,0 +1,68 @@
#!/bin/bash
MAIN_DIR=$PWD
build_gradle_module() {
MODULE_PATH=$1
echo ""
echo "+++"
echo "+++ BUILDING MODULE $MODULE_PATH"
echo "+++"
cd $MODULE_PATH && {
chmod +x gradlew
./gradlew clean build --info --stacktrace
if [ $? -ne 0 ]
then
echo ""
echo "+++"
echo "+++ BUILDING MODULE $MODULE_PATH FAILED"
echo "+++"
exit 1
else
echo ""
echo "+++"
echo "+++ BUILDING MODULE $MODULE_PATH SUCCESSFUL"
echo "+++"
fi
cd $MAIN_DIR
}
}
chmod +x gradlew
build_gradle_module "spring-boot/spring-boot-springdoc"
build_gradle_module "reactive"
build_gradle_module "junit/assumptions"
build_gradle_module "logging"
build_gradle_module "pact/pact-feign-consumer"
# currently disabled since the consumer build won't run
# build_gradle_module "pact/pact-message-consumer"
# build_gradle_module "pact/pact-message-producer"
build_gradle_module "pact/pact-spring-provider"
build_gradle_module "patterns"
build_gradle_module "spring-boot/conditionals"
build_gradle_module "spring-boot/configuration"
build_gradle_module "spring-boot/mocking"
build_gradle_module "spring-boot/modular"
build_gradle_module "spring-boot/paging"
build_gradle_module "spring-boot/rabbitmq-event-brokering"
build_gradle_module "spring-boot/spring-boot-logging"
build_gradle_module "spring-boot/spring-boot-testing"
build_gradle_module "spring-boot/starter"
build_gradle_module "spring-boot/startup"
build_gradle_module "spring-boot/static"
build_gradle_module "spring-boot/validation"
build_gradle_module "spring-boot/profiles"
build_gradle_module "spring-cloud/feign-with-spring-data-rest"
build_gradle_module "spring-cloud/sleuth-downstream-service"
build_gradle_module "spring-cloud/sleuth-upstream-service"
build_gradle_module "spring-cloud/spring-cloud-contract-consumer"
build_gradle_module "spring-cloud/spring-cloud-contract-provider"
build_gradle_module "spring-data/spring-data-rest-associations"
build_gradle_module "spring-data/spring-data-rest-springfox"
build_gradle_module "tools/jacoco"
echo ""
echo "+++"
echo "+++ ALL MODULES SUCCESSFUL"
echo "+++"

View File

@@ -7,7 +7,7 @@ buildscript {
apply plugin: 'java'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
sourceCompatibility = 11
repositories {
mavenLocal()
@@ -23,3 +23,6 @@ dependencies {
testCompile 'junit:junit:4.12'
}
test {
useJUnitPlatform()
}

View File

@@ -2,4 +2,4 @@ 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
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip

View File

@@ -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.10.1-bin.zip

View File

View File

@@ -1,27 +0,0 @@
package io.reflectoring.logging;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import ch.qos.logback.classic.pattern.LoggerConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
public class TruncatedLoggerConverter extends LoggerConverter {
@Override
public String convert(ILoggingEvent event) {
String maxLengthString = getFirstOption();
int maxLength = Integer.parseInt(maxLengthString);
String loggerName = super.convert(event);
if (loggerName.length() <= maxLength) {
return loggerName + generateSpaces(maxLength - loggerName.length());
} else {
return "..." + loggerName.substring(loggerName.length() - maxLength + 3);
}
}
private String generateSpaces(int count) {
return Stream.generate(() -> " ").limit(count).collect(Collectors.joining());
}
}

View File

@@ -1,28 +0,0 @@
package io.reflectoring.logging;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import ch.qos.logback.classic.pattern.ClassicConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;
public class TruncatedThreadConverter extends ClassicConverter {
@Override
public String convert(ILoggingEvent event) {
String maxLengthString = getFirstOption();
int maxLength = Integer.parseInt(maxLengthString);
String threadName = event.getThreadName();
if (threadName.length() <= maxLength) {
return threadName + generateSpaces(maxLength - threadName.length());
} else {
return "..." + threadName.substring(threadName.length() - maxLength + 3);
}
}
private String generateSpaces(int count) {
return Stream.generate(() -> " ").limit(count).collect(Collectors.joining());
}
}

View File

@@ -10,7 +10,7 @@
<!-- Appender to log to console -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{yyyy-MM-dd} | %d{HH:mm:ss.SSS} | %truncatedThread{20} | %5p | %truncatedLogger{25} | %12(ID: %8mdc{id}) | %m%n</pattern>
<pattern>%d{yyyy-MM-dd} | %d{HH:mm:ss.SSS} | %-20.20thread | %5p | %-25.25logger{25} | %12(ID: %8mdc{id}) | %m%n</pattern>
<charset>utf8</charset>
</encoder>
</appender>

View File

@@ -4,6 +4,9 @@ This example project shows how to setup an Angular application to use [Pact](htt
in order to create Pact files from a consumer test and validate the
a consumer against the Pact.
## Relevant Blog Post
[Creating a Consumer-Driven Contract with Angular and Pact](https://reflectoring.io/consumer-driven-contracts-with-angular-and-pact/)
## Key Files
* [`user.service.ts`](src/app/user.service.ts): Angular service that calls a REST

View File

@@ -1,5 +0,0 @@
userservice:
ribbon:
eureka:
enabled: false
listOfServers: localhost:8080

View File

@@ -1,5 +1,3 @@
apply plugin: 'org.springframework.boot'
buildscript {
repositories {
mavenLocal()
@@ -10,18 +8,56 @@ buildscript {
}
}
plugins {
id "au.com.dius.pact" version "3.5.20"
}
apply plugin: 'java'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'
version '1.0.0.SNAPSHOT'
repositories {
mavenLocal()
jcenter()
}
dependencies {
compile("org.springframework.boot:spring-boot-starter-data-jpa:${springboot_version}")
compile("org.springframework.boot:spring-boot-starter-web:${springboot_version}")
compile("org.springframework.cloud:spring-cloud-starter-feign:1.4.1.RELEASE")
compile('com.h2database:h2:1.4.196')
testCompile('org.codehaus.groovy:groovy-all:2.4.6')
testCompile("au.com.dius:pact-jvm-consumer-junit_2.11:3.5.2")
testCompile("org.springframework.boot:spring-boot-starter-test:${springboot_version}")
dependencyManagement {
imports {
mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springcloud_version}"
}
}
dependencies {
compile('org.springframework.boot:spring-boot-starter-data-jpa')
compile('org.springframework.boot:spring-boot-starter-web')
compile('org.springframework.cloud:spring-cloud-starter-openfeign')
compile('org.springframework.cloud:spring-cloud-starter-netflix-ribbon')
compile('com.h2database:h2:1.4.196')
// add jaxb since it's no longer available in Java 11
runtime('javax.xml.bind:jaxb-api:2.3.1')
// add javassist >= 3.23.1-GA since earlier versions are broken in Java 11
// see https://github.com/jboss-javassist/javassist/issues/194
runtime('org.javassist:javassist:3.23.1-GA')
testCompile('org.codehaus.groovy:groovy-all:2.4.6')
testCompile("au.com.dius:pact-jvm-consumer-junit5_2.12:${pact_version}")
testCompile('org.springframework.boot:spring-boot-starter-test')
testRuntimeOnly( 'org.junit.jupiter:junit-jupiter-engine:5.1.0')
}
pact {
publish {
pactDirectory = 'target/pacts'
pactBrokerUrl = 'TODO'
pactBrokerUsername = 'TODO'
pactBrokerPassword = 'TODO'
}
}
test {
useJUnitPlatform()
}

View File

@@ -1,2 +1,3 @@
springboot_version=1.5.9.RELEASE
verifier_version=1.2.2.RELEASE
springboot_version=2.0.4.RELEASE
springcloud_version=Finchley.SR1
pact_version=3.5.20

View File

@@ -2,4 +2,4 @@ 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
distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.1-bin.zip

View File

@@ -2,10 +2,12 @@ package io.reflectoring;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.feign.EnableFeignClients;
import org.springframework.cloud.netflix.ribbon.RibbonClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
@SpringBootApplication
@EnableFeignClients
@RibbonClient(name = "userservice", configuration = RibbonConfiguration.class)
public class ConsumerApplication {
public static void main(String[] args) {

View File

@@ -0,0 +1,15 @@
package io.reflectoring;
import com.netflix.client.config.IClientConfig;
import com.netflix.loadbalancer.IRule;
import com.netflix.loadbalancer.RandomRule;
import org.springframework.context.annotation.Bean;
public class RibbonConfiguration {
@Bean
public IRule ribbonRule(IClientConfig config) {
return new RandomRule();
}
}

View File

@@ -1,6 +1,6 @@
package io.reflectoring;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;

View File

@@ -1,83 +1,88 @@
package io.reflectoring;
import au.com.dius.pact.consumer.Pact;
import au.com.dius.pact.consumer.PactProviderRuleMk2;
import au.com.dius.pact.consumer.PactVerification;
import au.com.dius.pact.consumer.dsl.PactDslJsonBody;
import au.com.dius.pact.consumer.dsl.PactDslWithProvider;
import au.com.dius.pact.consumer.junit5.PactConsumerTestExt;
import au.com.dius.pact.consumer.junit5.PactTestFor;
import au.com.dius.pact.model.RequestResponsePact;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import static org.assertj.core.api.Assertions.assertThat;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.web.client.RestTemplate;
@RunWith(SpringRunner.class)
@SpringBootTest(properties = {
// overriding provider address
"userservice.ribbon.listOfServers: localhost:8888"
import static org.assertj.core.api.Assertions.*;
@ExtendWith(PactConsumerTestExt.class)
@ExtendWith(SpringExtension.class)
@PactTestFor(providerName = "userservice", port = "8888")
@SpringBootTest({
// overriding provider address
"userservice.ribbon.listOfServers: localhost:8888"
})
public class UserServiceConsumerTest {
class UserServiceConsumerTest {
@Rule
public PactProviderRuleMk2 stubProvider = new PactProviderRuleMk2("userservice", "localhost", 8888, this);
@Autowired
private UserClient userClient;
@Autowired
private UserClient userClient;
@Pact(state = "provider accepts a new person", provider = "userservice", consumer = "userclient")
RequestResponsePact createPersonPact(PactDslWithProvider builder) {
@Pact(state = "provider accepts a new person", provider = "userservice", consumer = "userclient")
public RequestResponsePact createPersonPact(PactDslWithProvider builder) {
return builder
.given("provider accepts a new person")
.uponReceiving("a request to POST a person")
.path("/user-service/users")
.method("POST")
.willRespondWith()
.status(201)
.matchHeader("Content-Type", "application/json")
.body(new PactDslJsonBody()
.integerType("id", 42))
.toPact();
}
// @formatter:off
return builder
.given("provider accepts a new person")
.uponReceiving("a request to POST a person")
.path("/user-service/users")
.method("POST")
.willRespondWith()
.status(201)
.matchHeader("Content-Type", "application/json")
.body(new PactDslJsonBody()
.integerType("id", 42))
.toPact();
// @formatter:on
}
@Pact(state = "person 42 exists", provider = "userservice", consumer = "userclient")
public RequestResponsePact updatePersonPact(PactDslWithProvider builder) {
return builder
.given("person 42 exists")
.uponReceiving("a request to PUT a person")
.path("/user-service/users/42")
.method("PUT")
.willRespondWith()
.status(200)
.matchHeader("Content-Type", "application/json")
.body(new PactDslJsonBody()
.stringType("firstName", "Zaphod")
.stringType("lastName", "Beeblebrox"))
.toPact();
}
@Pact(state = "person 42 exists", provider = "userservice", consumer = "userclient")
RequestResponsePact updatePersonPact(PactDslWithProvider builder) {
// @formatter:off
return builder
.given("person 42 exists")
.uponReceiving("a request to PUT a person")
.path("/user-service/users/42")
.method("PUT")
.willRespondWith()
.status(200)
.matchHeader("Content-Type", "application/json")
.body(new PactDslJsonBody()
.stringType("firstName", "Zaphod")
.stringType("lastName", "Beeblebrox"))
.toPact();
// @formatter:on
}
@Test
@PactVerification(fragment = "createPersonPact")
public void verifyCreatePersonPact() {
User user = new User();
user.setFirstName("Zaphod");
user.setLastName("Beeblebrox");
IdObject id = userClient.createUser(user);
assertThat(id.getId()).isEqualTo(42);
}
@Test
@PactTestFor(pactMethod = "createPersonPact")
void verifyCreatePersonPact() {
User user = new User();
user.setFirstName("Zaphod");
user.setLastName("Beeblebrox");
IdObject id = userClient.createUser(user);
assertThat(id.getId()).isEqualTo(42);
}
@Test
@PactVerification(fragment = "updatePersonPact")
public void verifyUpdatePersonPact() {
User user = new User();
user.setFirstName("Zaphod");
user.setLastName("Beeblebrox");
User updatedUser = userClient.updateUser(42L, user);
assertThat(updatedUser.getFirstName()).isEqualTo("Zaphod");
assertThat(updatedUser.getLastName()).isEqualTo("Beeblebrox");
}
@Test
@PactTestFor(pactMethod = "updatePersonPact")
void verifyUpdatePersonPact() {
User user = new User();
user.setFirstName("Zaphod");
user.setLastName("Beeblebrox");
User updatedUser = userClient.updateUser(42L, user);
assertThat(updatedUser.getFirstName()).isEqualTo("Zaphod");
assertThat(updatedUser.getLastName()).isEqualTo("Beeblebrox");
}
}

View File

@@ -0,0 +1,115 @@
{
"provider": {
"name": "userservice"
},
"consumer": {
"name": "userclient"
},
"interactions": [
{
"description": "a request to PUT a person",
"request": {
"method": "PUT",
"path": "/user-service/users/42"
},
"response": {
"status": 200,
"headers": {
"Content-Type": "application/json"
},
"body": {
"firstName": "Zaphod",
"lastName": "Beeblebrox"
},
"matchingRules": {
"body": {
"$.firstName": {
"matchers": [
{
"match": "type"
}
],
"combine": "AND"
},
"$.lastName": {
"matchers": [
{
"match": "type"
}
],
"combine": "AND"
}
},
"header": {
"Content-Type": {
"matchers": [
{
"match": "regex",
"regex": "application/json"
}
],
"combine": "AND"
}
}
}
},
"providerStates": [
{
"name": "person 42 exists"
}
]
},
{
"description": "a request to POST a person",
"request": {
"method": "POST",
"path": "/user-service/users"
},
"response": {
"status": 201,
"headers": {
"Content-Type": "application/json"
},
"body": {
"id": 42
},
"matchingRules": {
"header": {
"Content-Type": {
"matchers": [
{
"match": "regex",
"regex": "application/json"
}
],
"combine": "AND"
}
},
"body": {
"$.id": {
"matchers": [
{
"match": "integer"
}
],
"combine": "AND"
}
}
}
},
"providerStates": [
{
"name": "provider accepts a new person"
}
]
}
],
"metadata": {
"pactSpecification": {
"version": "3.0.0"
},
"pact-jvm": {
"version": "3.5.20"
}
}
}

25
pact/pact-message-consumer/.gitignore vendored Normal file
View File

@@ -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/

View File

@@ -0,0 +1,7 @@
# Consumer-Driven-Contract Test for a Spring Boot Message Consumer
This module shows how to use Pact to implement a contract test for a message provider.
## Companion Articles
[Testing a Spring Message Producer and Consumer against a Contract with Pact](https://reflectoring.io/cdc-pact-messages/)

View File

@@ -0,0 +1 @@
spring.rabbitmq.connection-timeout=10

View File

@@ -0,0 +1,43 @@
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 = 11
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
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:1.18.2')
// add jaxb since it's no longer available in Java 11
runtime('javax.xml.bind:jaxb-api:2.3.1')
// add javassist >= 3.23.1-GA since earlier versions are broken in Java 11
// see https://github.com/jboss-javassist/javassist/issues/194
runtime('org.javassist:javassist:3.23.1-GA')
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"]
}

View File

@@ -0,0 +1,2 @@
springboot_version=2.0.4.RELEASE
pact_version=3.5.20

View File

@@ -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-5.6.4-bin.zip

84
pact/pact-message-consumer/gradlew.bat vendored Normal file
View File

@@ -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

View File

@@ -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);
}
}

View File

@@ -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 MessageConsumer {
private Logger logger = LoggerFactory.getLogger(MessageConsumer.class);
private ObjectMapper objectMapper;
public MessageConsumer(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<ConstraintViolation<UserCreatedMessage>> violations = validator.validate(message);
if(!violations.isEmpty()){
throw new ConstraintViolationException(violations);
}
// pass message into business use case
}
}

View File

@@ -0,0 +1,60 @@
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.setConsumerStartTimeout(1000); // we don't want to wait in this example project
container.setConnectionFactory(connectionFactory);
container.setQueueNames(QUEUE_NAME);
container.setMessageListener(listenerAdapter);
return container;
}
@Bean
public MessageListenerAdapter listenerAdapter(MessageConsumer messageConsumer) {
return new MessageListenerAdapter(messageConsumer, "consumeStringMessage");
}
@Bean
public MessageConsumer eventReceiver(ObjectMapper objectMapper) {
return new MessageConsumer(objectMapper);
}
}

View File

@@ -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;
}

View File

@@ -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;
}

View File

@@ -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 MessageConsumerTest {
@Rule
public MessagePactProviderRule mockProvider = new MessagePactProviderRule(this);
private byte[] currentMessage;
@Autowired
private MessageConsumer messageConsumer;
@Pact(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 {
messageConsumer.consumeStringMessage(new String(this.currentMessage));
}
/**
* This method is called by the Pact framework.
*/
public void setMessage(byte[] message) {
this.currentMessage = message;
}
}

View File

@@ -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": {
"id": 42,
"name": "Zaphod Beeblebrox"
}
},
"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"
}
}
}

25
pact/pact-message-producer/.gitignore vendored Normal file
View File

@@ -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/

View File

@@ -0,0 +1,3 @@
# Consumer-Driven-Contract Test for a Spring Boot Message Provider
This module shows how to use Pact to implement a contract test for a message provider.

View File

@@ -0,0 +1,46 @@
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 = 11
repositories {
mavenLocal()
mavenCentral()
}
dependencies {
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:1.18.2')
// add jaxb since it's no longer available in Java 11
runtime('javax.xml.bind:jaxb-api:2.3.1')
// add javassist >= 3.23.1-GA since earlier versions are broken in Java 11
// see https://github.com/jboss-javassist/javassist/issues/194
runtime('org.javassist:javassist:3.23.1-GA')
// overriding bytebuddy to newer version that supports Java 11
// see https://github.com/raphw/byte-buddy/issues/428
testCompile('net.bytebuddy:byte-buddy:1.9.12')
testCompile("au.com.dius:pact-jvm-provider-junit_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"]
}

View File

@@ -0,0 +1,2 @@
springboot_version=2.0.4.RELEASE
pact_version=3.5.20

Binary file not shown.

View File

@@ -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.10.1-bin.zip

172
pact/pact-message-producer/gradlew vendored Normal file
View File

@@ -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" "$@"

84
pact/pact-message-producer/gradlew.bat vendored Normal file
View File

@@ -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

View File

@@ -0,0 +1,12 @@
package io.reflectoring;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}

View File

@@ -0,0 +1,31 @@
package io.reflectoring;
import java.io.IOException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Takes a {@link UserCreatedMessage}, converts it to a {@link String} and sends it to be published.
*/
class MessageProducer {
private Logger logger = LoggerFactory.getLogger(MessageProducer.class);
private ObjectMapper objectMapper;
private MessagePublisher messagePublisher;
MessageProducer(ObjectMapper objectMapper, MessagePublisher messagePublisher) {
this.objectMapper = objectMapper;
this.messagePublisher = messagePublisher;
}
void produceUserCreatedMessage(UserCreatedMessage message) throws IOException {
String stringMessage = objectMapper.writeValueAsString(message);
messagePublisher.publishMessage(stringMessage, "user.created");
logger.info("Published message '{}'", stringMessage);
}
}

View File

@@ -0,0 +1,36 @@
package io.reflectoring;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.amqp.core.TopicExchange;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;
@Configuration
@EnableScheduling
class MessageProviderConfiguration {
@Bean
TopicExchange topicExchange() {
return new TopicExchange("myExchange");
}
@Bean
MessageProducer messageProvider(ObjectMapper objectMapper, MessagePublisher publisher) {
return new MessageProducer(objectMapper, publisher);
}
@Bean
MessagePublisher messagePublisher(RabbitTemplate rabbitTemplate, TopicExchange topicExchange) {
return new MessagePublisher(rabbitTemplate, topicExchange);
}
@Bean
SendMessageJob job(MessageProducer messageProducer) {
return new SendMessageJob(messageProducer);
}
}

View File

@@ -0,0 +1,24 @@
package io.reflectoring;
import org.springframework.amqp.core.TopicExchange;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
/**
* Publishes a String message to RabbitMQ.
*/
class MessagePublisher {
private RabbitTemplate rabbitTemplate;
private TopicExchange topicExchange;
MessagePublisher(RabbitTemplate rabbitTemplate, TopicExchange topicExchange) {
this.rabbitTemplate = rabbitTemplate;
this.topicExchange = topicExchange;
}
void publishMessage(String message, String routingKey) {
rabbitTemplate.convertAndSend(topicExchange.getName(), routingKey, message);
}
}

View File

@@ -0,0 +1,37 @@
package io.reflectoring;
import java.io.IOException;
import java.util.Random;
import java.util.UUID;
import org.springframework.scheduling.annotation.Scheduled;
class SendMessageJob {
private Random random = new Random();
private MessageProducer messageProducer;
SendMessageJob(MessageProducer messageProducer) {
this.messageProducer = messageProducer;
}
/**
* This scheduled job simulates the "real" business logic that should produce messages.
*/
@Scheduled(fixedDelay = 1000)
void sendUserCreatedMessage() {
try {
UserCreatedMessage userCreatedMessage = UserCreatedMessage.builder()
.messageUuid(UUID.randomUUID().toString())
.user(User.builder()
.id(random.nextLong())
.name("Zaphpod Beeblebrox")
.build())
.build();
messageProducer.produceUserCreatedMessage(userCreatedMessage);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}

View File

@@ -0,0 +1,18 @@
package io.reflectoring;
import javax.validation.constraints.NotNull;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
class User {
@NotNull
private long id;
@NotNull
private String name;
}

View File

@@ -0,0 +1,18 @@
package io.reflectoring;
import javax.validation.constraints.NotNull;
import lombok.Builder;
import lombok.Data;
@Data
@Builder
class UserCreatedMessage {
@NotNull
private String messageUuid;
@NotNull
private User user;
}

View File

@@ -0,0 +1,41 @@
package io.reflectoring;
import java.util.List;
import au.com.dius.pact.model.Interaction;
import au.com.dius.pact.model.ProviderState;
import au.com.dius.pact.provider.ConsumerInfo;
import au.com.dius.pact.provider.ProviderInfo;
import au.com.dius.pact.provider.ProviderVerifier;
import au.com.dius.pact.provider.junit.target.AmqpTarget;
import org.jetbrains.annotations.NotNull;
/**
* Custom implementation of {@link AmqpTarget} since with {@link AmqpTarget}
* I had classpath troubles (see https://github.com/DiUS/pact-jvm/issues/763).
* Use at own risk, since the implementation is not complete and may behave
* a little different that the original class.
*/
public class CustomAmqpTarget extends AmqpTarget {
public CustomAmqpTarget(List<String> packagesToScan) {
super(packagesToScan);
}
@NotNull
@Override
protected ProviderVerifier setupVerifier(Interaction interaction, ProviderInfo provider, ConsumerInfo consumer) {
ProviderVerifier verifier = new CustomProviderVerifier(getPackagesToScan());
setupReporters(verifier, provider.getName(), interaction.getDescription());
verifier.initialiseReporters(provider);
verifier.reportVerificationForConsumer(consumer, provider);
if (!interaction.getProviderStates().isEmpty()) {
for (ProviderState state : interaction.getProviderStates()) {
verifier.reportStateForInteraction(state.getName(), provider, consumer, true);
}
}
verifier.reportInteractionDescription(interaction);
return verifier;
}
}

View File

@@ -0,0 +1,62 @@
package io.reflectoring;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import au.com.dius.pact.model.Interaction;
import au.com.dius.pact.model.v3.messaging.Message;
import au.com.dius.pact.provider.ConsumerInfo;
import au.com.dius.pact.provider.PactVerifyProvider;
import au.com.dius.pact.provider.ProviderInfo;
import au.com.dius.pact.provider.ProviderVerifier;
import org.reflections.Reflections;
import org.reflections.scanners.MethodAnnotationsScanner;
import org.reflections.util.ConfigurationBuilder;
public class CustomProviderVerifier extends ProviderVerifier {
private List<String> packagesToScan;
public CustomProviderVerifier(List<String> packagesToScan) {
this.packagesToScan = packagesToScan;
}
@Override
public boolean verifyResponseByInvokingProviderMethods(ProviderInfo providerInfo, ConsumerInfo consumer,
Object interaction, String interactionMessage, Map failures) {
try {
ConfigurationBuilder configurationBuilder = new ConfigurationBuilder()
.setScanners(new MethodAnnotationsScanner())
.forPackages(packagesToScan.toArray(new String[]{}));
Reflections reflections = new Reflections(configurationBuilder);
Set<Method> methodsAnnotatedWith = reflections.getMethodsAnnotatedWith(PactVerifyProvider.class);
Set<Method> providerMethods = methodsAnnotatedWith.stream()
.filter(m -> {
PactVerifyProvider annotation = m.getAnnotation(PactVerifyProvider.class);
return annotation.value().equals(((Interaction)interaction).getDescription());
})
.collect(Collectors.toSet());
if (providerMethods.isEmpty()) {
throw new RuntimeException("No annotated methods were found for interaction " +
"'${interaction.description}'. You need to provide a method annotated with " +
"@PactVerifyProvider(\"${interaction.description}\") that returns the message contents.");
} else {
if (interaction instanceof Message) {
verifyMessagePact(providerMethods, (Message) interaction, interactionMessage, failures);
} else {
throw new RuntimeException("only supports Message interactions!");
}
}
} catch (Exception e) {
throw new RuntimeException("verification failed", e);
}
return true;
}
}

View File

@@ -0,0 +1,53 @@
package io.reflectoring;
import java.io.IOException;
import java.util.Collections;
import java.util.UUID;
import au.com.dius.pact.provider.PactVerifyProvider;
import au.com.dius.pact.provider.junit.PactRunner;
import au.com.dius.pact.provider.junit.Provider;
import au.com.dius.pact.provider.junit.loader.PactFolder;
import au.com.dius.pact.provider.junit.target.Target;
import au.com.dius.pact.provider.junit.target.TestTarget;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Mockito;
import static org.mockito.Mockito.*;
@RunWith(PactRunner.class)
@Provider("userservice")
@PactFolder("../pact-message-consumer/target/pacts")
public class UserCreatedMessageProviderTest {
@TestTarget
public final Target target = new CustomAmqpTarget(Collections.singletonList("io.reflectoring"));
private MessagePublisher publisher = Mockito.mock(MessagePublisher.class);
private MessageProducer messageProducer = new MessageProducer(new ObjectMapper(), publisher);
@PactVerifyProvider("a user created message")
public String verifyUserCreatedMessage() throws IOException {
// given
doNothing().when(publisher).publishMessage(any(String.class), eq("user.created"));
// when
UserCreatedMessage message = UserCreatedMessage.builder()
.messageUuid(UUID.randomUUID().toString())
.user(User.builder()
.id(42L)
.name("Zaphod Beeblebrox")
.build())
.build();
messageProducer.produceUserCreatedMessage(message);
// then
ArgumentCaptor<String> messageCapture = ArgumentCaptor.forClass(String.class);
verify(publisher, times(1)).publishMessage(messageCapture.capture(), eq("user.created"));
// returning the message
return messageCapture.getValue();
}
}

24
pact/pact-node-messages/.gitignore vendored Normal file
View File

@@ -0,0 +1,24 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
# testing
/coverage
# production
/build
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*
.nyc_output/*
coverage/*

2543
pact/pact-node-messages/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,17 @@
{
"name": "pact-node-messages",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test:pact:consumer": "mocha src/consumer/*.spec.js --exit",
"test:pact:provider": "mocha src/provider/*.spec.js --exit",
"publish:pact": "node pact/publish.js"
},
"author": "Tom Hombergs",
"license": "MIT",
"devDependencies": {
"@pact-foundation/pact": "^7.0.3",
"mocha": "^5.2.0"
}
}

View File

@@ -0,0 +1,12 @@
let publisher = require('@pact-foundation/pact-node');
let path = require('path');
let opts = {
pactFilesOrDirs: [path.resolve(process.cwd(), 'pacts')],
pactBroker: 'https://adesso.pact.dius.com.au/',
pactBrokerUsername: process.env.PACT_USERNAME,
pactBrokerPassword: process.env.PACT_PASSWORD,
consumerVersion: '2.0.0'
};
publisher.publishPacts(opts).then(() => console.log("Pacts successfully published"));

View File

@@ -0,0 +1,63 @@
{
"consumer": {
"name": "node-message-consumer"
},
"provider": {
"name": "node-message-provider"
},
"messages": [
{
"description": "a hero created message",
"providerStates": [
],
"contents": {
"id": 42,
"name": "Superman",
"superpower": "flying",
"universe": "DC"
},
"matchingRules": {
"body": {
"$.id": {
"matchers": [
{
"match": "type"
}
]
},
"$.name": {
"matchers": [
{
"match": "type"
}
]
},
"$.superpower": {
"matchers": [
{
"match": "type"
}
]
},
"$.universe": {
"matchers": [
{
"match": "regex",
"regex": "^(DC|Marvel)$"
}
]
}
}
},
"metaData": {
"content-type": "application/json"
}
}
],
"metadata": {
"pactSpecification": {
"version": "3.0.0"
}
}
}

View File

@@ -0,0 +1,35 @@
class HeroCreatedEvent {
constructor(name, superpower, universe, id) {
this.id = id;
this.name = name;
this.superpower = superpower;
this.universe = universe;
}
static validateUniverse(event) {
if (typeof event.universe !== 'string') {
throw new Error(`Hero universe must be a string! Invalid value: ${event.universe}`)
}
}
static validateSuperpower(event) {
if (typeof event.superpower !== 'string') {
throw new Error(`Hero superpower must be a string! Invalid value: ${event.superpower}`)
}
}
static validateName(event) {
if (typeof event.name !== 'string') {
throw new Error(`Hero name must be a string! Invalid value: ${event.name}`);
}
}
static validateId(event) {
if (typeof event.id !== 'number') {
throw new Error(`Hero id must be a number! Invalid value: ${event.id}`)
}
}
}
module.exports = HeroCreatedEvent;

View File

@@ -0,0 +1,15 @@
const HeroCreatedEvent = require('../common/hero-created-event');
exports.HeroEventHandler = {
handleHeroCreatedEvent: (message) => {
HeroCreatedEvent.validateId(message);
HeroCreatedEvent.validateName(message);
HeroCreatedEvent.validateSuperpower(message);
HeroCreatedEvent.validateUniverse(message);
// pass message into business logic
// note that the business logic should be mocked away for the contract test
}
};

View File

@@ -0,0 +1,35 @@
const {MessageConsumerPact, Matchers, synchronousBodyHandler} = require('@pact-foundation/pact');
const {HeroEventHandler} = require('./hero-event-handler');
const path = require('path');
describe("message consumer", () => {
const messagePact = new MessageConsumerPact({
consumer: "node-message-consumer",
provider: "node-message-provider",
dir: path.resolve(process.cwd(), "pacts"),
pactfileWriteMode: "update",
logLevel: "info",
});
describe("'hero created' message Handler", () => {
it("should accept a valid hero created message", (done) => {
messagePact
.expectsToReceive("a hero created message")
.withContent({
id: Matchers.like(42),
name: Matchers.like("Superman"),
superpower: Matchers.like("flying"),
universe: Matchers.term({generate: "DC", matcher: "^(DC|Marvel)$"})
})
.withMetadata({
"content-type": "application/json",
})
.verify(synchronousBodyHandler(HeroEventHandler.handleHeroCreatedEvent))
.then(() => done(), (error) => done(error));
}).timeout(5000);
});
});

View File

@@ -0,0 +1,9 @@
const HeroCreatedEvent = require('../common/hero-created-event');
exports.CreateHeroEventProducer = {
produceHeroCreatedEvent: () => {
return new Promise((resolve, reject) => {
resolve(new HeroCreatedEvent("Superman", "Flying", "DC", 42));
});
}
};

View File

@@ -0,0 +1,37 @@
const {MessageProviderPact} = require('@pact-foundation/pact');
const {CreateHeroEventProducer} = require('./hero-event-producer');
const path = require('path');
describe("message producer", () => {
const messagePact = new MessageProviderPact({
messageProviders: {
"a hero created message": () => CreateHeroEventProducer.produceHeroCreatedEvent(),
},
log: path.resolve(process.cwd(), "logs", "pact.log"),
logLevel: "info",
provider: "node-message-provider",
pactUrls: [path.resolve(process.cwd(), "pacts", "node-message-consumer-node-message-provider.json")],
// Pact seems not to load a pact file from a pact broker, so we have to make do with the local pact file
// see https://github.com/pact-foundation/pact-js/issues/248
// pactBrokerUrl: "https://adesso.pact.dius.com.au",
// pactBrokerUsername: process.env.PACT_USERNAME,
// pactBrokerPassword: process.env.PACT_PASSWORD,
// publishVerificationResult: true,
// providerVersion: '1.0.0',
tags: ['latest']
});
describe("'hero created' message producer", () => {
it("should create a valid hero created message", (done) => {
messagePact
.verify()
.then(() => done(), (error) => done(error));
}).timeout(5000);
});
});

21
pact/pact-node-provider/.gitignore vendored Normal file
View File

@@ -0,0 +1,21 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
# testing
/coverage
# production
/build
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*

View File

@@ -0,0 +1,7 @@
# Node Pact example
This example project shows how to setup an Express server with Node and create
a contract test for the provider side of a contract with Pact Node.
## Relevant Blog Post
[Step By Step Tutorial for Implementing Consumer-Driven Contracts for a Node Express Server with Pact](https://reflectoring.io/pact-node-provider/)

View File

@@ -0,0 +1,29 @@
const express = require('express');
const path = require('path');
const cookieParser = require('cookie-parser');
const logger = require('morgan');
const indexRouter = require('./routes/index');
const usersRouter = require('./routes/users');
const heroesRouter = require('./routes/heroes');
const graphqlRouter = require('./routes/graphql');
const providerStateRouter = require ('./routes/provider_state');
const app = express();
app.use(logger('dev'));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));
app.use('/', indexRouter);
app.use('/users', usersRouter);
app.use('/heroes', heroesRouter);
app.use('/graphql', graphqlRouter);
if (process.env.PACT_MODE === 'true') {
app.use('/provider-state', providerStateRouter);
}
module.exports = app;

View File

@@ -0,0 +1,90 @@
#!/usr/bin/env node
/**
* Module dependencies.
*/
var app = require('../app');
var debug = require('debug')('test:server');
var http = require('http');
/**
* Get port from environment and store in Express.
*/
var port = normalizePort(process.env.PORT || '3000');
app.set('port', port);
/**
* Create HTTP server.
*/
var server = http.createServer(app);
/**
* Listen on provided port, on all network interfaces.
*/
server.listen(port);
server.on('error', onError);
server.on('listening', onListening);
/**
* Normalize a port into a number, string, or false.
*/
function normalizePort(val) {
var port = parseInt(val, 10);
if (isNaN(port)) {
// named pipe
return val;
}
if (port >= 0) {
// port number
return port;
}
return false;
}
/**
* Event listener for HTTP server "error" event.
*/
function onError(error) {
if (error.syscall !== 'listen') {
throw error;
}
var bind = typeof port === 'string'
? 'Pipe ' + port
: 'Port ' + port;
// handle specific listen errors with friendly messages
switch (error.code) {
case 'EACCES':
console.error(bind + ' requires elevated privileges');
process.exit(1);
break;
case 'EADDRINUSE':
console.error(bind + ' is already in use');
process.exit(1);
break;
default:
throw error;
}
}
/**
* Event listener for HTTP server "listening" event.
*/
function onListening() {
var addr = server.address();
var bind = typeof addr === 'string'
? 'pipe ' + addr
: 'port ' + addr.port;
debug('Listening on ' + bind);
}

2802
pact/pact-node-provider/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,23 @@
{
"name": "test",
"version": "0.0.0",
"private": true,
"scripts": {
"start": "node ./bin/www",
"pact:providerTests": "node ./pact/provider_tests.js",
"pact:providerTests:graphql": "node ./pact/provider_tests_graphql.js",
"test:pact": "start-server-and-test start http://localhost:3000 pact:providerTests",
"test:pact:graphql": "start-server-and-test start http://localhost:3000 pact:providerTests:graphql"
},
"dependencies": {
"cookie-parser": "~1.4.3",
"debug": "~2.6.9",
"express": "~4.16.0",
"express-graphql": "^0.7.1",
"morgan": "~1.9.0"
},
"devDependencies": {
"@pact-foundation/pact": "7.0.3",
"start-server-and-test": "^1.7.5"
}
}

View File

@@ -0,0 +1,17 @@
const { Verifier } = require('@pact-foundation/pact');
const packageJson = require('../package.json');
let opts = {
providerBaseUrl: 'http://localhost:3000',
provider: 'hero-provider',
pactBrokerUrl: 'https://adesso.pact.dius.com.au',
pactBrokerUsername: process.env.PACT_USERNAME,
pactBrokerPassword: process.env.PACT_PASSWORD,
publishVerificationResult: true,
providerVersion: packageJson.version,
providerStatesSetupUrl: 'http://localhost:3000/provider-state'
};
new Verifier().verifyProvider(opts).then(function () {
console.log("Pacts successfully verified!");
});

View File

@@ -0,0 +1,16 @@
const { Verifier } = require('@pact-foundation/pact');
const packageJson = require('../package.json');
let opts = {
providerBaseUrl: 'http://localhost:3000',
provider: 'graphql-hero-provider',
pactBrokerUrl: 'https://adesso.pact.dius.com.au',
pactBrokerUsername: process.env.PACT_USERNAME,
pactBrokerPassword: process.env.PACT_PASSWORD,
publishVerificationResult: true,
providerVersion: packageJson.version,
};
new Verifier().verifyProvider(opts).then(function () {
console.log("Pacts successfully verified!");
});

View File

@@ -0,0 +1,13 @@
<html>
<head>
<title>Express</title>
<link rel="stylesheet" href="/stylesheets/style.css">
</head>
<body>
<h1>Express</h1>
<p>Welcome to Express</p>
</body>
</html>

View File

@@ -0,0 +1,8 @@
body {
padding: 50px;
font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
}
a {
color: #00B7FF;
}

View File

@@ -0,0 +1,36 @@
const graphqlHTTP = require('express-graphql');
const {buildSchema} = require("graphql");
const heroesSchema = buildSchema(`
type Query {
hero(id: Int!): Hero
}
type Hero {
id: Int!
name: String!
superpower: String!
universe: String!
}
`);
const getHero = function () {
return {
id: 42,
name: "Superman",
superpower: "Flying",
universe: "DC"
}
};
const root = {
hero: getHero
};
const router = graphqlHTTP({
schema: heroesSchema,
graphiql: true,
rootValue: root
});
module.exports = router;

View File

@@ -0,0 +1,27 @@
const express = require('express');
const router = express.Router();
router.route('/:hero_id')
.get(function (req, res) {
const heroId = parseInt(req.params['hero_id']);
res.status(200);
res.json({
id: heroId,
superpower: 'flying',
name: 'Superman',
universe: 'DC'
});
});
router.route('/')
.post(function (req, res) {
res.status(201);
res.json({
id: 42,
superpower: 'flying',
name: 'Superman',
universe: 'DC'
});
});
module.exports = router;

View File

@@ -0,0 +1,9 @@
var express = require('express');
var router = express.Router();
/* GET home page. */
router.get('/', function(req, res, next) {
res.render('index', { title: 'Express' });
});
module.exports = router;

View File

@@ -0,0 +1,13 @@
const express = require('express');
const router = express.Router();
router.route('/')
.post(function (req, res) {
const consumer = req.query['consumer'];
const providerState = req.query['state'];
// imagine we're setting the server into a certain state
res.send(`changed to provider state "${providerState}" for consumer "${consumer}"`);
res.status(200);
});
module.exports = router;

View File

@@ -0,0 +1,9 @@
var express = require('express');
var router = express.Router();
/* GET users listing. */
router.get('/', function(req, res, next) {
res.send('respond with a resource');
});
module.exports = router;

23
pact/pact-react-consumer/.gitignore vendored Normal file
View File

@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
# testing
/coverage
# production
/build
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*
/.idea

View File

@@ -0,0 +1,8 @@
# React Pact example
This example project shows how to setup a React application to use [Pact](http://pact.io)
in order to create Pact files from a consumer test and validate the
a consumer against the Pact.
## Relevant Blog Post
[Step By Step Tutorial for Implementing Consumer-Driven Contracts for a React App with Pact and Jest](https://reflectoring.io/pact-react-consumer/)

15763
pact/pact-react-consumer/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More