Use JsonAssert for request assertions

Closes gh-41

Author: sjohnr

api/github/github-api.gradle

@@ -12,6 +12,7 @@ dependencies {
 
 	testImplementation "org.assertj:assertj-core"
 	testImplementation "org.mockito:mockito-core"
+	testImplementation "com.jayway.jsonpath:json-path-assert"
 	testImplementation "com.squareup.okhttp3:mockwebserver"
 }
 

api/github/src/test/java/com/github/api/GitHubApiTests.java

@@ -24,6 +24,7 @@
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
+import com.jayway.jsonassert.JsonAssert;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
 import org.junit.jupiter.api.AfterEach;
@@ -32,6 +33,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
+import static org.hamcrest.CoreMatchers.is;
 
 public class GitHubApiTests {
 
@@ -102,8 +104,12 @@ public void createReleaseWhenValidParametersThenSuccess() throws Exception {
 		assertThat(recordedRequest.getHeader("Accept")).isEqualTo("application/json");
 		assertThat(recordedRequest.getHeader("Content-Type")).isEqualTo("application/json");
 		assertThat(recordedRequest.getHeader("Authorization")).isEqualTo("Bearer %s".formatted(AUTH_TOKEN));
-		assertThat(recordedRequest.getBody().readString(Charset.defaultCharset()))
-			.isEqualTo(string("CreateReleaseRequest.json"));
+
+		var json = JsonAssert.with(recordedRequest.getBody().readString(Charset.defaultCharset()));
+		json.assertThat("$.tag_name", is("1.0.0"));
+		json.assertThat("$.draft", is(false));
+		json.assertThat("$.prerelease", is(false));
+		json.assertThat("$.generate_release_notes", is(false));
 	}
 
 	@Test
@@ -120,8 +126,10 @@ public void createMilestoneWhenValidParametersThenSuccess() throws Exception {
 		assertThat(recordedRequest.getHeader("Accept")).isEqualTo("application/json");
 		assertThat(recordedRequest.getHeader("Content-Type")).isEqualTo("application/json");
 		assertThat(recordedRequest.getHeader("Authorization")).isEqualTo("Bearer %s".formatted(AUTH_TOKEN));
-		assertThat(recordedRequest.getBody().readString(Charset.defaultCharset()))
-			.isEqualTo(string("CreateMilestoneRequest.json"));
+
+		var json = JsonAssert.with(recordedRequest.getBody().readString(Charset.defaultCharset()));
+		json.assertThat("$.title", is("1.0.0"));
+		json.assertThat("$.due_on", is("2022-05-04T12:00:00Z"));
 	}
 
 	@Test
@@ -212,8 +220,9 @@ public void closeMilestoneWhenValidParametersThenSuccess() throws Exception {
 		assertThat(recordedRequest.getPath()).isEqualTo("/repos/spring-projects/spring-security/milestones/191");
 		assertThat(recordedRequest.getHeader("Accept")).isEqualTo("application/json");
 		assertThat(recordedRequest.getHeader("Authorization")).isEqualTo("Bearer %s".formatted(AUTH_TOKEN));
-		assertThat(recordedRequest.getBody().readString(Charset.defaultCharset()))
-			.isEqualTo(string("UpdateMilestoneRequest.json"));
+
+		var json = JsonAssert.with(recordedRequest.getBody().readString(Charset.defaultCharset()));
+		json.assertThat("$.state", is("closed"));
 	}
 
 	private static MockResponse json(String path) throws IOException {

api/github/src/test/resources/CreateMilestoneRequest.json

@@ -12,6 +12,7 @@ dependencies {
 
 	testImplementation "org.assertj:assertj-core"
 	testImplementation "org.mockito:mockito-core"
+	testImplementation "com.jayway.jsonpath:json-path-assert"
 	testImplementation "com.squareup.okhttp3:mockwebserver"
 }
 

api/github/src/test/resources/CreateReleaseRequest.json

@@ -25,6 +25,7 @@
 import java.util.Comparator;
 import java.util.Objects;
 
+import com.jayway.jsonassert.JsonAssert;
 import io.spring.api.Release.ReleaseStatus;
 import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.MockWebServer;
@@ -33,6 +34,7 @@
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hamcrest.CoreMatchers.is;
 
 /**
  * @author Steve Riesenberg
@@ -154,8 +156,13 @@ public void createReleaseWhenValidParametersThenSuccess() throws Exception {
 		assertThat(recordedRequest.getHeader("Accept")).isNull();
 		assertThat(recordedRequest.getHeader("Content-Type")).isEqualTo("application/json");
 		assertThat(recordedRequest.getHeader("Authorization")).isEqualTo("Basic %s".formatted(AUTH_TOKEN));
-		assertThat(recordedRequest.getBody().readString(Charset.defaultCharset()))
-			.isEqualTo(string("CreateReleaseRequest.json"));
+
+		var json = JsonAssert.with(recordedRequest.getBody().readString(Charset.defaultCharset()));
+		json.assertThat("$.version", is("6.1.0"));
+		json.assertThat("$.referenceDocUrl", is("https://docs.spring.io/spring-security/reference/{version}/index.html"));
+		json.assertThat("$.apiDocUrl", is("https://docs.spring.io/spring-security/site/docs/{version}/api/"));
+		json.assertThat("$.status", is("GENERAL_AVAILABILITY"));
+		json.assertThat("$.current", is(true));
 	}
 
 	@Test

api/github/src/test/resources/UpdateMilestoneRequest.json

@@ -14,5 +14,6 @@ dependencies {
 		api "org.assertj:assertj-core:3.25.3"
 		api "org.mockito:mockito-core:5.11.0"
 		api "com.squareup.okhttp3:mockwebserver:4.12.0"
+		api "com.jayway.jsonpath:json-path-assert:2.9.0"
 	}
 }