Initial version of sample pact consumer and provider
This commit is contained in:
commit
ec9c105e3b
17 changed files with 871 additions and 0 deletions
37
.gitignore
vendored
Normal file
37
.gitignore
vendored
Normal file
|
@ -0,0 +1,37 @@
|
|||
HELP.md
|
||||
.gradle
|
||||
build/
|
||||
!gradle/wrapper/gradle-wrapper.jar
|
||||
!**/src/main/**/build/
|
||||
!**/src/test/**/build/
|
||||
|
||||
### STS ###
|
||||
.apt_generated
|
||||
.classpath
|
||||
.factorypath
|
||||
.project
|
||||
.settings
|
||||
.springBeans
|
||||
.sts4-cache
|
||||
bin/
|
||||
!**/src/main/**/bin/
|
||||
!**/src/test/**/bin/
|
||||
|
||||
### IntelliJ IDEA ###
|
||||
.idea
|
||||
*.iws
|
||||
*.iml
|
||||
*.ipr
|
||||
out/
|
||||
!**/src/main/**/out/
|
||||
!**/src/test/**/out/
|
||||
|
||||
### NetBeans ###
|
||||
/nbproject/private/
|
||||
/nbbuild/
|
||||
/dist/
|
||||
/nbdist/
|
||||
/.nb-gradle/
|
||||
|
||||
### VS Code ###
|
||||
.vscode/
|
27
build.gradle
Normal file
27
build.gradle
Normal file
|
@ -0,0 +1,27 @@
|
|||
plugins {
|
||||
id 'java'
|
||||
id 'org.springframework.boot' version '3.0.0'
|
||||
id 'io.spring.dependency-management' version '1.1.0'
|
||||
}
|
||||
|
||||
group = 'de.rpr'
|
||||
version = '0.0.1-SNAPSHOT'
|
||||
sourceCompatibility = '17'
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
implementation 'org.springframework.boot:spring-boot-starter-web'
|
||||
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||
testImplementation 'au.com.dius.pact:consumer:4.4.2'
|
||||
testImplementation 'au.com.dius.pact.consumer:junit5:4.4.2'
|
||||
testImplementation 'au.com.dius.pact:provider:4.4.2'
|
||||
testImplementation 'au.com.dius.pact.provider:junit5:4.4.2'
|
||||
testImplementation 'au.com.dius.pact.provider:junit5spring:4.4.2'
|
||||
}
|
||||
|
||||
tasks.named('test') {
|
||||
useJUnitPlatform()
|
||||
}
|
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
Binary file not shown.
5
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
5
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
|
@ -0,0 +1,5 @@
|
|||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
240
gradlew
vendored
Executable file
240
gradlew
vendored
Executable file
|
@ -0,0 +1,240 @@
|
|||
#!/bin/sh
|
||||
|
||||
#
|
||||
# Copyright © 2015-2021 the original authors.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# https://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
##############################################################################
|
||||
#
|
||||
# Gradle start up script for POSIX generated by Gradle.
|
||||
#
|
||||
# Important for running:
|
||||
#
|
||||
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||
# noncompliant, but you have some other compliant shell such as ksh or
|
||||
# bash, then to run this script, type that shell name before the whole
|
||||
# command line, like:
|
||||
#
|
||||
# ksh Gradle
|
||||
#
|
||||
# Busybox and similar reduced shells will NOT work, because this script
|
||||
# requires all of these POSIX shell features:
|
||||
# * functions;
|
||||
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||
# * compound commands having a testable exit status, especially «case»;
|
||||
# * various built-in commands including «command», «set», and «ulimit».
|
||||
#
|
||||
# Important for patching:
|
||||
#
|
||||
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||
#
|
||||
# The "traditional" practice of packing multiple parameters into a
|
||||
# space-separated string is a well documented source of bugs and security
|
||||
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||
# options in "$@", and eventually passing that to Java.
|
||||
#
|
||||
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||
# see the in-line comments for details.
|
||||
#
|
||||
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||
# Darwin, MinGW, and NonStop.
|
||||
#
|
||||
# (3) This script is generated from the Groovy template
|
||||
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||
# within the Gradle project.
|
||||
#
|
||||
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||
#
|
||||
##############################################################################
|
||||
|
||||
# Attempt to set APP_HOME
|
||||
|
||||
# Resolve links: $0 may be a link
|
||||
app_path=$0
|
||||
|
||||
# Need this for daisy-chained symlinks.
|
||||
while
|
||||
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||
[ -h "$app_path" ]
|
||||
do
|
||||
ls=$( ls -ld "$app_path" )
|
||||
link=${ls#*' -> '}
|
||||
case $link in #(
|
||||
/*) app_path=$link ;; #(
|
||||
*) app_path=$APP_HOME$link ;;
|
||||
esac
|
||||
done
|
||||
|
||||
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=${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='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD=maximum
|
||||
|
||||
warn () {
|
||||
echo "$*"
|
||||
} >&2
|
||||
|
||||
die () {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
} >&2
|
||||
|
||||
# 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 ;; #(
|
||||
MSYS* | 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" && ! "$darwin" && ! "$nonstop" ; then
|
||||
case $MAX_FD in #(
|
||||
max*)
|
||||
MAX_FD=$( ulimit -H -n ) ||
|
||||
warn "Could not query maximum file descriptor limit"
|
||||
esac
|
||||
case $MAX_FD in #(
|
||||
'' | soft) :;; #(
|
||||
*)
|
||||
ulimit -n "$MAX_FD" ||
|
||||
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||
esac
|
||||
fi
|
||||
|
||||
# Collect all arguments for the java command, stacking in reverse order:
|
||||
# * args from the command line
|
||||
# * the main class name
|
||||
# * -classpath
|
||||
# * -D...appname settings
|
||||
# * --module-path (only if needed)
|
||||
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||
if "$cygwin" || "$msys" ; then
|
||||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||
|
||||
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||
|
||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||
for arg do
|
||||
if
|
||||
case $arg in #(
|
||||
-*) false ;; # don't mess with options #(
|
||||
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||
[ -e "$t" ] ;; #(
|
||||
*) false ;;
|
||||
esac
|
||||
then
|
||||
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||
fi
|
||||
# Roll the args list around exactly as many times as the number of
|
||||
# args, so each arg winds up back in the position where it started, but
|
||||
# possibly modified.
|
||||
#
|
||||
# NB: a `for` loop captures its iteration list before it begins, so
|
||||
# changing the positional parameters here affects neither the number of
|
||||
# iterations, nor the values presented in `arg`.
|
||||
shift # remove old arg
|
||||
set -- "$@" "$arg" # push replacement arg
|
||||
done
|
||||
fi
|
||||
|
||||
# Collect all arguments for the java command;
|
||||
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
|
||||
# shell script including quotes and variable substitutions, so put them in
|
||||
# double quotes to make sure that they get re-expanded; and
|
||||
# * put everything else in single quotes, so that it's not re-expanded.
|
||||
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
org.gradle.wrapper.GradleWrapperMain \
|
||||
"$@"
|
||||
|
||||
# Stop when "xargs" is not available.
|
||||
if ! command -v xargs >/dev/null 2>&1
|
||||
then
|
||||
die "xargs is not available"
|
||||
fi
|
||||
|
||||
# Use "xargs" to parse quoted args.
|
||||
#
|
||||
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||
#
|
||||
# In Bash we could simply go:
|
||||
#
|
||||
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||
# set -- "${ARGS[@]}" "$@"
|
||||
#
|
||||
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||
# character that might be a shell metacharacter, then use eval to reverse
|
||||
# that process (while maintaining the separation between arguments), and wrap
|
||||
# the whole thing up as a single "set" statement.
|
||||
#
|
||||
# This will of course break if any of these variables contains a newline or
|
||||
# an unmatched quote.
|
||||
#
|
||||
|
||||
eval "set -- $(
|
||||
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||
xargs -n1 |
|
||||
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||
tr '\n' ' '
|
||||
)" '"$@"'
|
||||
|
||||
exec "$JAVACMD" "$@"
|
91
gradlew.bat
vendored
Normal file
91
gradlew.bat
vendored
Normal file
|
@ -0,0 +1,91 @@
|
|||
@rem
|
||||
@rem Copyright 2015 the original author or authors.
|
||||
@rem
|
||||
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||
@rem you may not use this file except in compliance with the License.
|
||||
@rem You may obtain a copy of the License at
|
||||
@rem
|
||||
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||
@rem
|
||||
@rem Unless required by applicable law or agreed to in writing, software
|
||||
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
@rem See the License for the specific language governing permissions and
|
||||
@rem limitations under the License.
|
||||
@rem
|
||||
|
||||
@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 Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||
|
||||
@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="-Xmx64m" "-Xms64m"
|
||||
|
||||
@rem Find java.exe
|
||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||
|
||||
set JAVA_EXE=java.exe
|
||||
%JAVA_EXE% -version >NUL 2>&1
|
||||
if %ERRORLEVEL% equ 0 goto execute
|
||||
|
||||
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 execute
|
||||
|
||||
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
|
||||
|
||||
: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 %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
if %ERRORLEVEL% equ 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!
|
||||
set EXIT_CODE=%ERRORLEVEL%
|
||||
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||
exit /b %EXIT_CODE%
|
||||
|
||||
:mainEnd
|
||||
if "%OS%"=="Windows_NT" endlocal
|
||||
|
||||
:omega
|
1
settings.gradle
Normal file
1
settings.gradle
Normal file
|
@ -0,0 +1 @@
|
|||
rootProject.name = 'pact-example'
|
13
src/main/java/de/rpr/pactexample/PactExampleApplication.java
Normal file
13
src/main/java/de/rpr/pactexample/PactExampleApplication.java
Normal file
|
@ -0,0 +1,13 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
|
||||
@SpringBootApplication
|
||||
public class PactExampleApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(PactExampleApplication.class, args);
|
||||
}
|
||||
|
||||
}
|
5
src/main/java/de/rpr/pactexample/User.java
Normal file
5
src/main/java/de/rpr/pactexample/User.java
Normal file
|
@ -0,0 +1,5 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
public record User(int id, String name) {
|
||||
|
||||
}
|
27
src/main/java/de/rpr/pactexample/UserController.java
Normal file
27
src/main/java/de/rpr/pactexample/UserController.java
Normal file
|
@ -0,0 +1,27 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
@RestController
|
||||
@RequestMapping("/users")
|
||||
public class UserController {
|
||||
|
||||
private final UserRepository userRepository;
|
||||
|
||||
public UserController(UserRepository userRepository) {
|
||||
this.userRepository = userRepository;
|
||||
}
|
||||
|
||||
@GetMapping
|
||||
public List<User> getUsers() {
|
||||
return userRepository.getAllUsers();
|
||||
}
|
||||
|
||||
@GetMapping("{id}")
|
||||
public ResponseEntity<User> getUser(@PathVariable("id") int id) {
|
||||
return userRepository.getUser(id).map(ResponseEntity::ok).orElse(ResponseEntity.notFound().build());
|
||||
}
|
||||
}
|
26
src/main/java/de/rpr/pactexample/UserRepository.java
Normal file
26
src/main/java/de/rpr/pactexample/UserRepository.java
Normal file
|
@ -0,0 +1,26 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import org.springframework.stereotype.Repository;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Optional;
|
||||
|
||||
@Repository
|
||||
public class UserRepository {
|
||||
|
||||
private final List<User> users = Arrays.asList(
|
||||
new User(1, "Jane Doe"),
|
||||
new User(2, "John Doe")
|
||||
);
|
||||
|
||||
public List<User> getAllUsers() {
|
||||
return users;
|
||||
}
|
||||
|
||||
public Optional<User> getUser(int id) {
|
||||
return users.stream()
|
||||
.filter(u -> u.id() == id)
|
||||
.findFirst();
|
||||
}
|
||||
}
|
1
src/main/resources/application.properties
Normal file
1
src/main/resources/application.properties
Normal file
|
@ -0,0 +1 @@
|
|||
|
108
src/test/java/de/rpr/pactexample/PactConsumerJUnit5Test.java
Normal file
108
src/test/java/de/rpr/pactexample/PactConsumerJUnit5Test.java
Normal file
|
@ -0,0 +1,108 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import au.com.dius.pact.consumer.MockServer;
|
||||
import au.com.dius.pact.consumer.PactTestExecutionContext;
|
||||
import au.com.dius.pact.consumer.dsl.PactBuilder;
|
||||
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.core.model.RequestResponsePact;
|
||||
import au.com.dius.pact.core.model.V4Pact;
|
||||
import au.com.dius.pact.core.model.annotations.Pact;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.springframework.boot.web.client.RestTemplateBuilder;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
@ExtendWith(PactConsumerTestExt.class)
|
||||
public class PactConsumerJUnit5Test {
|
||||
|
||||
@Pact(provider = "UserServiceJUnit5", consumer = "UserConsumer")
|
||||
public V4Pact getAllUsers(PactBuilder builder) {
|
||||
|
||||
String expectedUsers = """
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Jane Doe"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "John Doe"
|
||||
}
|
||||
]
|
||||
""";
|
||||
|
||||
return builder
|
||||
.usingLegacyDsl()
|
||||
.given("A running user service")
|
||||
.uponReceiving("A request for a user list")
|
||||
.path("/users")
|
||||
.method("GET")
|
||||
.willRespondWith()
|
||||
.status(200)
|
||||
.headers(Map.of("Content-Type", "application/json"))
|
||||
.body(expectedUsers)
|
||||
.toPact()
|
||||
.asV4Pact()
|
||||
.get();
|
||||
}
|
||||
|
||||
@Pact(provider = "UserServiceJUnit5", consumer = "UserConsumer")
|
||||
public V4Pact getUserById(PactBuilder builder) {
|
||||
|
||||
String expectedUser = """
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Jane Doe"
|
||||
}
|
||||
""";
|
||||
|
||||
return builder
|
||||
.usingLegacyDsl()
|
||||
.given("A running user service")
|
||||
.uponReceiving("A request for a user")
|
||||
.path("/users/1")
|
||||
.method("GET")
|
||||
.willRespondWith()
|
||||
.status(200)
|
||||
.headers(Map.of("Content-Type", "application/json"))
|
||||
.body(expectedUser)
|
||||
.toPact()
|
||||
.asV4Pact()
|
||||
.get();
|
||||
}
|
||||
|
||||
@Test
|
||||
@PactTestFor(providerName = "UserServiceJUnit5", pactMethod = "getUserById")
|
||||
void getUserById(MockServer mockServer) {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().rootUri(mockServer.getUrl()).build();
|
||||
User user = restTemplate.getForObject("/users/1", User.class);
|
||||
|
||||
assertThat(user)
|
||||
.isNotNull()
|
||||
.isEqualTo(new User(1, "Jane Doe"));
|
||||
}
|
||||
|
||||
@Test
|
||||
@PactTestFor(providerName = "UserServiceJUnit5", pactMethod = "getAllUsers")
|
||||
void getAllUsers(MockServer mockServer) {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().rootUri(mockServer.getUrl()).build();
|
||||
User[] response = restTemplate.getForObject("/users", User[].class);
|
||||
|
||||
assertThat(response)
|
||||
.isNotNull()
|
||||
.containsExactly(
|
||||
new User(1, "Jane Doe"),
|
||||
new User(2, "John Doe")
|
||||
);
|
||||
}
|
||||
|
||||
}
|
110
src/test/java/de/rpr/pactexample/PactConsumerTest.java
Normal file
110
src/test/java/de/rpr/pactexample/PactConsumerTest.java
Normal file
|
@ -0,0 +1,110 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import au.com.dius.pact.consumer.ConsumerPactBuilder;
|
||||
import au.com.dius.pact.consumer.MockServer;
|
||||
import au.com.dius.pact.consumer.PactTestExecutionContext;
|
||||
import au.com.dius.pact.consumer.PactVerificationResult;
|
||||
import au.com.dius.pact.consumer.model.MockProviderConfig;
|
||||
import au.com.dius.pact.core.model.RequestResponsePact;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.boot.web.client.RestTemplateBuilder;
|
||||
import org.springframework.web.client.RestTemplate;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import static au.com.dius.pact.consumer.ConsumerPactRunnerKt.runConsumerTest;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
|
||||
public class PactConsumerTest {
|
||||
|
||||
@Test
|
||||
public void getAllUsersPact() {
|
||||
String expectedUsers = """
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Jane Doe"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "John Doe"
|
||||
}
|
||||
]
|
||||
""";
|
||||
|
||||
RequestResponsePact pact = ConsumerPactBuilder
|
||||
.consumer("UserConsumer")
|
||||
.hasPactWith("UserService")
|
||||
.uponReceiving("A request for a user list")
|
||||
.path("/users")
|
||||
.method("GET")
|
||||
.willRespondWith()
|
||||
.status(200)
|
||||
.headers(Map.of("Content-Type", "application/json"))
|
||||
.body(expectedUsers)
|
||||
.toPact();
|
||||
|
||||
MockProviderConfig config = MockProviderConfig.createDefault();
|
||||
PactVerificationResult result = runConsumerTest(pact, config, PactConsumerTest::getAllUsers);
|
||||
|
||||
if (result instanceof PactVerificationResult.Error) {
|
||||
throw new RuntimeException(((PactVerificationResult.Error) result).getError());
|
||||
}
|
||||
|
||||
assertEquals(new PactVerificationResult.Ok(
|
||||
Arrays.asList(
|
||||
new User(1, "Jane Doe"),
|
||||
new User(2, "John Doe")
|
||||
)), result);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getSpecificUserPact() {
|
||||
String expectedUser = """
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Jane Doe"
|
||||
}
|
||||
""";
|
||||
|
||||
RequestResponsePact pact = ConsumerPactBuilder
|
||||
.consumer("UserConsumer")
|
||||
.hasPactWith("UserService")
|
||||
.uponReceiving("A request for a user")
|
||||
.path("/users/1")
|
||||
.method("GET")
|
||||
.willRespondWith()
|
||||
.status(200)
|
||||
.headers(Map.of("Content-Type", "application/json"))
|
||||
.body(expectedUser)
|
||||
.toPact();
|
||||
|
||||
MockProviderConfig config = MockProviderConfig.createDefault();
|
||||
PactVerificationResult result = runConsumerTest(pact, config, PactConsumerTest::getUser);
|
||||
|
||||
if (result instanceof PactVerificationResult.Error) {
|
||||
throw new RuntimeException(((PactVerificationResult.Error) result).getError());
|
||||
}
|
||||
|
||||
assertEquals(new PactVerificationResult.Ok(new User(1, "Jane Doe")), result);
|
||||
}
|
||||
|
||||
private static User getUser(MockServer mockServer, PactTestExecutionContext context) {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().rootUri(mockServer.getUrl()).build();
|
||||
return restTemplate.getForObject("/users/1", User.class);
|
||||
}
|
||||
|
||||
private static List<User> getAllUsers(MockServer mockServer, PactTestExecutionContext context) {
|
||||
RestTemplate restTemplate = new RestTemplateBuilder().rootUri(mockServer.getUrl()).build();
|
||||
User[] resultingUsers = restTemplate.getForObject("/users", User[].class);
|
||||
if (resultingUsers != null) {
|
||||
return Arrays.stream(resultingUsers).toList();
|
||||
} else {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
41
src/test/java/de/rpr/pactexample/PactProviderJUnit5Test.java
Normal file
41
src/test/java/de/rpr/pactexample/PactProviderJUnit5Test.java
Normal file
|
@ -0,0 +1,41 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import au.com.dius.pact.provider.junit5.HttpTestTarget;
|
||||
import au.com.dius.pact.provider.junit5.PactVerificationContext;
|
||||
import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider;
|
||||
import au.com.dius.pact.provider.junitsupport.Provider;
|
||||
import au.com.dius.pact.provider.junitsupport.State;
|
||||
import au.com.dius.pact.provider.junitsupport.loader.PactFolder;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.TestTemplate;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.boot.test.web.server.LocalServerPort;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
|
||||
@Provider("UserServiceJUnit5")
|
||||
@PactFolder("build/pacts")
|
||||
public class PactProviderJUnit5Test {
|
||||
|
||||
@LocalServerPort
|
||||
int port;
|
||||
|
||||
@BeforeEach
|
||||
public void setup(PactVerificationContext context) {
|
||||
context.setTarget(new HttpTestTarget("localhost", port));
|
||||
}
|
||||
|
||||
// see: https://docs.pact.io/getting_started/provider_states
|
||||
@State("A running user service")
|
||||
void setupUserService() {
|
||||
// no state setup ATM
|
||||
}
|
||||
|
||||
@TestTemplate
|
||||
@ExtendWith(PactVerificationInvocationContextProvider.class)
|
||||
void pactVerificationTestTemplate(PactVerificationContext context) {
|
||||
context.verifyInteraction();
|
||||
}
|
||||
}
|
|
@ -0,0 +1,53 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import au.com.dius.pact.provider.junit5.PactVerificationContext;
|
||||
import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider;
|
||||
import au.com.dius.pact.provider.junitsupport.Provider;
|
||||
import au.com.dius.pact.provider.junitsupport.State;
|
||||
import au.com.dius.pact.provider.junitsupport.loader.PactFolder;
|
||||
import au.com.dius.pact.provider.spring.junit5.MockMvcTestTarget;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.TestTemplate;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
|
||||
import org.springframework.boot.test.context.TestConfiguration;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.test.web.servlet.MockMvc;
|
||||
|
||||
@WebMvcTest
|
||||
@Provider("UserServiceJUnit5")
|
||||
@PactFolder("build/pacts")
|
||||
public class PactProviderSpringJUnit5Test {
|
||||
|
||||
@TestConfiguration
|
||||
static class Config {
|
||||
|
||||
@Bean
|
||||
public UserRepository userRepo() {
|
||||
return new UserRepository();
|
||||
}
|
||||
}
|
||||
|
||||
@Autowired
|
||||
MockMvc mockMvc;
|
||||
@Autowired
|
||||
UserRepository userRepository;
|
||||
|
||||
@BeforeEach
|
||||
public void setup(PactVerificationContext context) {
|
||||
context.setTarget(new MockMvcTestTarget(mockMvc));
|
||||
}
|
||||
|
||||
// see: https://docs.pact.io/getting_started/provider_states
|
||||
@State("A running user service")
|
||||
void setupUserService() {
|
||||
// no state setup ATM
|
||||
}
|
||||
|
||||
@TestTemplate
|
||||
@ExtendWith(PactVerificationInvocationContextProvider.class)
|
||||
void pactVerificationTestTemplate(PactVerificationContext context) {
|
||||
context.verifyInteraction();
|
||||
}
|
||||
}
|
86
src/test/java/de/rpr/pactexample/PactProviderTest.java
Normal file
86
src/test/java/de/rpr/pactexample/PactProviderTest.java
Normal file
|
@ -0,0 +1,86 @@
|
|||
package de.rpr.pactexample;
|
||||
|
||||
import au.com.dius.pact.core.model.*;
|
||||
import au.com.dius.pact.provider.*;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.boot.test.web.server.LocalServerPort;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
|
||||
public class PactProviderTest {
|
||||
|
||||
ProviderInfo providerInfo;
|
||||
ConsumerInfo consumerInfo;
|
||||
static Pact consumerPact;
|
||||
|
||||
@LocalServerPort
|
||||
int port;
|
||||
|
||||
@BeforeEach
|
||||
void setup() {
|
||||
providerInfo = new ProviderInfo("UserService");
|
||||
providerInfo.setProtocol("http");
|
||||
providerInfo.setHost("localhost");
|
||||
providerInfo.setPort(port);
|
||||
providerInfo.setPath("/");
|
||||
|
||||
consumerInfo = new ConsumerInfo("UserClient");
|
||||
consumerInfo.setName("consumer_client");
|
||||
consumerInfo.setPactSource(new FileSource(new File("build/pacts/UserConsumer-UserService.json")));
|
||||
//noinspection ConstantConditions
|
||||
consumerPact = DefaultPactReader.INSTANCE.loadPact(consumerInfo.getPactSource());
|
||||
}
|
||||
|
||||
@Test
|
||||
void runConsumerPacts() {
|
||||
// grab the first interaction from the pact with consumer
|
||||
Interaction interaction = consumerPact.getInteractions().get(0);
|
||||
|
||||
// setup the verifier
|
||||
ProviderVerifier verifier = setupVerifier(interaction, providerInfo, consumerInfo);
|
||||
|
||||
// setup any provider state
|
||||
|
||||
// setup the client and interaction to fire against the provider
|
||||
ProviderClient client = new ProviderClient(providerInfo, new HttpClientFactory());
|
||||
Map<String, Object> failures = new HashMap<>();
|
||||
//noinspection ConstantConditions
|
||||
|
||||
VerificationResult result = verifier.verifyResponseFromProvider(
|
||||
providerInfo,
|
||||
interaction.asSynchronousRequestResponse(),
|
||||
interaction.getDescription(),
|
||||
failures,
|
||||
client);
|
||||
|
||||
if (!(result instanceof VerificationResult.Ok)) {
|
||||
verifier.displayFailures(List.of((VerificationResult.Failed) result));
|
||||
}
|
||||
assertThat(result).isInstanceOf(VerificationResult.Ok.class);
|
||||
}
|
||||
|
||||
private ProviderVerifier setupVerifier(Interaction interaction, ProviderInfo provider, ConsumerInfo consumer) {
|
||||
ProviderVerifier verifier = new ProviderVerifier();
|
||||
|
||||
verifier.initialiseReporters(provider);
|
||||
|
||||
if (!interaction.getProviderStates().isEmpty()) {
|
||||
for (ProviderState providerState : interaction.getProviderStates()) {
|
||||
//noinspection ConstantConditions
|
||||
verifier.reportStateForInteraction(providerState.getName(), provider, consumer, true);
|
||||
}
|
||||
}
|
||||
|
||||
verifier.reportInteractionDescription(interaction);
|
||||
|
||||
return verifier;
|
||||
}
|
||||
}
|
Loading…
Reference in a new issue