Merge pull request #3975 from cloudfoundry/remove-hamcrest

Migrate tests off Hamcrest to AssertJ and remove the dependency

Author: duanemay

gradle/libs.versions.toml

@@ -86,9 +86,6 @@ guava = { module = "com.google.guava:guava", version.ref = "guava" }
 # Greenmail
 greenmail = { module = "com.icegreen:greenmail", version.ref = "greenmail" }
 
-# Hamcrest
-hamcrest = { module = "org.hamcrest:hamcrest" }
-
 # Hibernate
 hibernateValidator = { module = "org.hibernate.validator:hibernate-validator" }
 

metrics-data/build.gradle.kts

@@ -14,7 +14,6 @@ dependencies {
     testImplementation(libs.springBootStarterTest) {
         exclude(group = "org.junit.vintage", module = "junit-vintage-engine")
     }
-    testImplementation(libs.hamcrest)
     testImplementation(libs.junit5JupiterApi)
     testImplementation(libs.junit5JupiterParams)
     testImplementation(libs.junit5JupiterEngine)

model/build.gradle.kts

@@ -29,7 +29,6 @@ dependencies {
     testImplementation(libs.springBootStarterTest) {
         exclude(group = "org.junit.vintage", module = "junit-vintage-engine")
     }
-    testImplementation(libs.hamcrest)
     testImplementation(libs.junit5JupiterApi)
     testImplementation(libs.junit5JupiterParams)
     testImplementation(libs.junit5JupiterEngine)

model/src/test/java/org/cloudfoundry/identity/uaa/ProxyingBeanInfoMatcher.java

@@ -3,7 +3,6 @@
 import tools.jackson.databind.ObjectMapper;
 import tools.jackson.databind.json.JsonMapper;
 
-import org.hamcrest.Matchers;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
@@ -18,7 +17,6 @@
 import java.util.TreeSet;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.HamcrestCondition.matching;
 
 class UaaClientDetailsTest {
 
@@ -41,11 +39,10 @@ void setUp() {
         void copiesUaaBaseClientDetails() {
             testClient.setClientSecret("secret");
             UaaClientDetails copy = new UaaClientDetails(testClient);
-            assertThat(copy).is(matching(UaaClientDetailsMatcher.aUaaClientDetails()
-                    .withClientId("test")
-                    .withClientSecret("secret")
-                    .withScope(Matchers.contains("test.none"))
-                    .withResourceIds(Matchers.emptyIterable())));
+            assertThat(copy.getClientId()).isEqualTo("test");
+            assertThat(copy.getClientSecret()).isEqualTo("secret");
+            assertThat(copy.getScope()).containsExactly("test.none");
+            assertThat(copy.getResourceIds()).isEmpty();
 
             List<String> authorities = copy.getAuthorities().stream()
                     .map(GrantedAuthority::getAuthority)
@@ -57,8 +54,9 @@ void copiesUaaBaseClientDetails() {
         void copiesAdditionalInformation() {
             testClient.setAdditionalInformation(Collections.singletonMap("key", "value"));
             UaaClientDetails copy = new UaaClientDetails(testClient);
-            assertThat(copy).is(matching(UaaClientDetailsMatcher.aUaaClientDetails()
-                    .withAdditionalInformation(Matchers.allOf(Matchers.aMapWithSize(1), Matchers.hasEntry("key", "value")))));
+            assertThat(copy.getAdditionalInformation())
+                    .hasSize(1)
+                    .containsEntry("key", "value");
         }
 
         @Test
@@ -98,7 +96,7 @@ class WhenSettingScope {
         void splitsScopesWhichIncludeAComma() {
             UaaClientDetails client = new UaaClientDetails(new UaaClientDetails());
             client.setScope(Collections.singleton("foo,bar"));
-            assertThat(client).is(matching(UaaClientDetailsMatcher.aUaaClientDetails().withScope(Matchers.containsInAnyOrder("foo", "bar"))));
+            assertThat(client.getScope()).containsExactlyInAnyOrder("foo", "bar");
         }
     }
 

model/src/test/java/org/cloudfoundry/identity/uaa/client/UaaClientDetailsMatcher.java

@@ -6,9 +6,6 @@
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.HamcrestCondition.matching;
-import static org.cloudfoundry.identity.uaa.test.JsonMatcher.isJsonFile;
-import static org.cloudfoundry.identity.uaa.test.JsonMatcher.isJsonString;
 import static org.cloudfoundry.identity.uaa.test.JsonTranslation.WithAllNullFields.EXPECT_EMPTY_JSON;
 import static org.cloudfoundry.identity.uaa.test.JsonTranslation.WithAllNullFields.EXPECT_NULLS_IN_JSON;
 import static org.cloudfoundry.identity.uaa.test.ModelTestUtils.getResourceAsString;
@@ -65,7 +62,7 @@ void toJson() throws Exception {
 
         String actual = objectMapper.writeValueAsString(subject);
 
-        assertThat(actual).is(matching(isJsonFile(subjectClass, jsonFileName)));
+        assertJsonEquals(actual, getResourceAsString(subjectClass, jsonFileName));
     }
 
     @Test
@@ -87,7 +84,7 @@ void withNullFields_checkIsEmptyJson() throws Exception {
         validate();
 
         String actual = objectMapper.writeValueAsString(subjectClass.newInstance());
-        assertThat(actual).is(matching(isJsonString("{}")));
+        assertJsonEquals(actual, "{}");
     }
 
     @Test
@@ -101,6 +98,12 @@ void withNullFields_compareToFile() throws Exception {
         assertThat(subjectClass.getResourceAsStream(fileName)).as("file <%s/%s> must exist on classpath, or choose a different %s".formatted(subjectClass.getPackage().getName().replace(".", "/"), fileName, WithAllNullFields.class.getSimpleName())).isNotNull();
 
         String actual = objectMapper.writeValueAsString(subjectClass.newInstance());
-        assertThat(actual).is(matching(isJsonFile(this.getClass(), fileName)));
+        assertJsonEquals(actual, getResourceAsString(this.getClass(), fileName));
+    }
+
+    /** Compares two JSON documents structurally (field order and formatting insensitive). */
+    private void assertJsonEquals(String actualJson, String expectedJson) {
+        assertThat(objectMapper.readTree(actualJson))
+                .isEqualTo(objectMapper.readTree(expectedJson));
     }
 }

model/src/test/java/org/cloudfoundry/identity/uaa/client/UaaClientDetailsTest.java

@@ -92,7 +92,6 @@ dependencies {
     testImplementation(libs.springBootStarterTest) {
         exclude(group = "org.junit.vintage", module = "junit-vintage-engine")
     }
-    testImplementation(libs.hamcrest)
     testImplementation(libs.junit5JupiterApi)
     testImplementation(libs.junit5JupiterParams)
     testImplementation(libs.junit5JupiterEngine)