chore!: Update Spring and Java (#100)

BREAKING CHANGE: The documentation structure of query parameters has been changed in the new version. Keep in mind that this version is based on Spring 3.x.x

Author: meysamzamani

.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v3
         with:
-          java-version: 17
+          java-version: 21
           distribution: 'temurin'
           cache: gradle
       - name: Cache Gradle packages

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v3
         with:
-          java-version: 17
+          java-version: 21
           distribution: 'temurin'
           cache: gradle
       - name: Cache SonarCloud packages

README.md

@@ -16,6 +16,7 @@ Details and background information can be read on our [ePages Developer Blog](ht
 <!-- TOC depthFrom:2 depthTo:3 -->
 
 - [Contents](#contents)
+- [Versions](#versions)
 - [How to include `restdocs-wiremock` into your server project](#how-to-include-restdocs-wiremock-into-your-server-project)
     - [Dependencies](#dependencies)
     - [Producing snippets](#producing-snippets)
@@ -36,6 +37,16 @@ This repository consists of two libraries:
 * `wiremock-spring-boot-starter`: A spring boot starter which adds a `WireMockServer` to your client's ApplicationContext for integration testing.
   This is optional, but highly recommended when verifying your client contract in a SpringBootTest.
 
+## Versions
+
+There are multiple major versions of the libraries in different branches.
+The following table provides an overview which "restdocs-wiremock" release branch is to be used for microservices on specific Spring Boot versions.
+
+| restdocs-wiremock version                                                     | Spring Boot version | Java version |
+|-----------------------------------------------------------------------|---------------------|--------------|
+| [1.x.x](https://github.com/ePages-de/restdocs-wiremock/releases?q=1.) | 3.3.x               | 21           |
+| [0.x.x](https://github.com/ePages-de/restdocs-wiremock/releases?q=0.) | 2.7.x               | 17           |
+
 ## How to include `restdocs-wiremock` into your server project
 
 ### Dependencies
@@ -51,7 +62,7 @@ In gradle it would look like this:
 
 ```groovy
 dependencies {
-  testCompile('com.epages:restdocs-wiremock:0.8.5')
+  testCompile('com.epages:restdocs-wiremock:0.8.9')
   testCompile('org.springframework.restdocs:spring-restdocs-mockmvc')
 }
 ```
@@ -62,7 +73,7 @@ When using maven:
 <dependency>
 	<groupId>com.epages</groupId>
 	<artifactId>restdocs-wiremock</artifactId>
-	<version>0.8.5</version>
+	<version>0.8.9</version>
 	<scope>test</scope>
 </dependency>
 <dependency>
@@ -230,7 +241,7 @@ On the client side, add a dependency to the test-runtime to the jar containing t
 that, the JSON files can be accessed as classpath resources.
 
 ```groovy
-testRuntime (group:'com.epages', name:'restdocs-server', version:'0.8.5', classifier:'wiremock', ext:'jar')
+testRuntime (group:'com.epages', name:'restdocs-server', version:'0.8.9', classifier:'wiremock', ext:'jar')
 ```
 
 ## How to use WireMock in your client tests
@@ -247,7 +258,7 @@ Services based on `spring-cloud-netflix`, i.e. using `feign` and `ribbon`, are a
 To add a dependency via gradle, extend your `build.gradle` with the following line:
 
 ```groovy
-testCompile('com.epages:wiremock-spring-boot-starter:0.8.5')
+testCompile('com.epages:wiremock-spring-boot-starter:0.8.9')
 ```
 
 
@@ -257,7 +268,7 @@ When using maven, add the following dependency in test scope.
 <dependency>
 	<groupId>com.epages</groupId>
 	<artifactId>wiremock-spring-boot-starter</artifactId>
-	<version>0.8.5</version>
+	<version>0.8.9</version>
 	<scope>test</scope>
 </dependency>
 ```

build.gradle

@@ -40,8 +40,8 @@ subprojects {
         mavenCentral()
     }
 
-    sourceCompatibility = JavaVersion.VERSION_17
-    targetCompatibility = JavaVersion.VERSION_17
+    sourceCompatibility = JavaVersion.VERSION_21
+    targetCompatibility = JavaVersion.VERSION_21
 
     task sourceJar(type: Jar) {
         from sourceSets.main.allJava

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

wiremock-spring-boot-starter/build.gradle

@@ -3,7 +3,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'org.springframework.boot:spring-boot-gradle-plugin:2.7.18'
+        classpath 'org.springframework.boot:spring-boot-gradle-plugin:3.3.2'
     }
 }
 
@@ -17,7 +17,7 @@ group = 'com.epages'
 description = 'Spring Boot Starter for adding a WireMock server to your integration test'
 
 dependencies {
-    api 'org.wiremock:wiremock-standalone:3.5.3'
+    api 'org.wiremock:wiremock-standalone:3.9.1'
 
     implementation 'org.springframework.boot:spring-boot-starter-test'
     implementation 'org.springframework.boot:spring-boot-starter'

wiremock-spring-boot-starter/src/main/java/com/epages/wiremock/starter/WireMockListener.java

@@ -102,7 +102,7 @@ public void afterTestClass(TestContext testContext) {
 	private void addPropertySourceProperties(TestContext testContext, String[] properties) {
 		try {
 			MergedContextConfiguration configuration = (MergedContextConfiguration) ReflectionTestUtils
-					.getField(testContext, "mergedContextConfiguration");
+					.getField(testContext, "mergedConfig");
 			new MergedContextConfigurationProperties(configuration).add(properties);
 		} catch (RuntimeException ex) {
 			throw ex;

wiremock/build.gradle

@@ -1,13 +1,14 @@
 dependencies {
-    // FIXME: Starting with version 2.0.3.RELEASE there are missing dependencies from "org.springframework.web"
-    // See https://github.com/spring-projects/spring-restdocs/releases/tag/v2.0.4.RELEASE
-    implementation 'org.springframework.restdocs:spring-restdocs-core:2.0.3.RELEASE'
-    implementation 'com.jayway.jsonpath:json-path:2.8.0'
+    // See https://github.com/spring-projects/spring-restdocs/releases/tag/v3.0.0
+    implementation 'org.springframework.restdocs:spring-restdocs-core:3.0.1'
+    implementation 'org.springframework:spring-web:6.1.12'
+    implementation 'com.jayway.jsonpath:json-path:2.9.0'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.16.2'
     compileOnly 'junit:junit:4.13.2'
     testImplementation 'junit:junit:4.13.2'
     testImplementation 'org.mockito:mockito-core:5.11.0'
-    testImplementation 'org.skyscreamer:jsonassert:1.5.1'
-    testImplementation 'com.google.guava:guava:30.0-jre'
+    testImplementation 'org.skyscreamer:jsonassert:1.5.3'
+    testImplementation 'com.google.guava:guava:33.2.1-jre'
     testImplementation 'org.hamcrest:hamcrest:2.2'
 }
 

wiremock/src/main/java/com/epages/restdocs/WireMockJsonSnippet.java

@@ -66,7 +66,7 @@ protected Map<Object, Object> createModel(Operation operation) {
 		OperationResponse response = operation.getResponse();
 
 		Maps.Builder<Object, Object> requestBuilder = Maps.builder()
-				.put("method", operation.getRequest().getMethod());
+				.put("method", operation.getRequest().getMethod().name());
 
 		urlPathOrUrlPattern(operation, requestBuilder);
 
@@ -132,11 +132,11 @@ private Map<Object, Object> responseHeaders(OperationResponse response) {
 	private Map<Object, Object> queryParams(Operation operation) {
 		Maps.Builder<Object, Object> queryParams = Maps.builder();
 
-		Parameters queryStringParameters = new QueryStringParser().parse(operation.getRequest().getUri());
+		QueryParameters queryStringParameters = QueryParameters.from(operation.getRequest());
 
 		for (Map.Entry<String, List<String>> e : queryStringParameters.entrySet()) {
 			List<String> values = e.getValue();
-			if (!values.isEmpty()) {
+			if (!values.isEmpty() && !values.get(0).isEmpty())  {
 				queryParams.put(e.getKey(), Maps.of("equalTo", values.get(0)));
 			}
 		}

wiremock/src/test/java/org/springframework/restdocs/test/OperationBuilder.java

@@ -37,7 +37,7 @@
 import org.springframework.restdocs.operation.OperationRequestPartFactory;
 import org.springframework.restdocs.operation.OperationResponse;
 import org.springframework.restdocs.operation.OperationResponseFactory;
-import org.springframework.restdocs.operation.Parameters;
+import org.springframework.restdocs.operation.QueryParameters;
 import org.springframework.restdocs.operation.StandardOperation;
 import org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory;
 import org.springframework.restdocs.snippet.StandardWriterResolver;
@@ -137,7 +137,7 @@ public final class OperationRequestBuilder {
 
 		private HttpHeaders headers = new HttpHeaders();
 
-		private Parameters parameters = new Parameters();
+		private QueryParameters parameters;
 
 		private List<OperationRequestPartBuilder> partBuilders = new ArrayList<>();
 
@@ -151,7 +151,7 @@ private OperationRequest buildRequest() {
 				parts.add(builder.buildPart());
 			}
 			return new OperationRequestFactory().create(this.requestUri, this.method,
-					this.content, this.headers, this.parameters, parts);
+					this.content, this.headers, parts);
 		}
 
 		public Operation build() {