Migrate all tests to JUnit Jupiter (hamcrest#424)

This change migrates all tests to use JUnit Jupiter, so that is all tests are now annotated with `org.junit.jupiter.api.Test`. In most cases, this is a simple change of imports, with a few exceptions: * Uses of `assertTrue` have been adjusted to allow for the description being the last parameter * `org.hamcrest.AbstractMatcherTest` has been moved to `org.hamcrest.test.AbstractMatcherTest` * Static assertion methods in `AbstractMatcherTest` have been moved to `org.hamcrest.test.MatcherAssertions`
tumbarumba · Oct 12, 2024 · 581d6ba · 581d6ba
1 parent 246967c
commit 581d6ba
Show file tree

Hide file tree

Showing 77 changed files with 543 additions and 246 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -23,6 +23,7 @@ these methods will need to be updated. The following methods are affected:
 * Javadoc improvements and cleanup ([PR #420](https://github.com/hamcrest/JavaHamcrest/pull/420))
 * Optional matchers ([PR #421](https://github.com/hamcrest/JavaHamcrest/pull/421))
 * Derive version from git tags ([PR #419](https://github.com/hamcrest/JavaHamcrest/pull/419))
+* Migrate all tests to JUnit Jupiter ([PR #424](https://github.com/hamcrest/JavaHamcrest/pull/424))
 
 ### Bugfixes
 

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -0,0 +1,7 @@
+# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format
+
+[versions]
+junit-jupiter = "5.11.2"
+
+[libraries]
+junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit-jupiter" }
diff --git a/hamcrest/hamcrest.gradle b/hamcrest/hamcrest.gradle
@@ -5,13 +5,12 @@ plugins {
 version = rootProject.version
 
 dependencies {
-    testImplementation(group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.3') {
-        transitive = true
-    }
-    testImplementation(group: 'org.junit.vintage', name: 'junit-vintage-engine', version: '5.10.3') {
-        transitive = true
-        exclude(module: 'hamcrest-core')
-    }
+    testImplementation libs.junit.jupiter
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+}
+
+tasks.named("test") {
+    useJUnitPlatform()
 }
 
 jar {

diff --git a/hamcrest/src/test/java/org/hamcrest/AbstractMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/AbstractMatcherTest.java
diff --git a/hamcrest/src/test/java/org/hamcrest/BaseDescriptionTest.java b/hamcrest/src/test/java/org/hamcrest/BaseDescriptionTest.java
@@ -1,8 +1,8 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public final class BaseDescriptionTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/BaseMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/BaseMatcherTest.java
@@ -1,8 +1,8 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public final class BaseMatcherTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/CustomMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/CustomMatcherTest.java
@@ -1,8 +1,9 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
+
+import static org.hamcrest.test.MatcherAssertions.assertDescription;
 
-import static org.hamcrest.AbstractMatcherTest.assertDescription;
 
 public final class CustomMatcherTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/CustomTypeSafeMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/CustomTypeSafeMatcherTest.java
@@ -1,8 +1,8 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.hamcrest.AbstractMatcherTest.*;
+import static org.hamcrest.test.MatcherAssertions.*;
 
 public final class CustomTypeSafeMatcherTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/FeatureMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/FeatureMatcherTest.java
@@ -1,10 +1,10 @@
 package org.hamcrest;
 
 import org.hamcrest.core.IsEqual;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.hamcrest.AbstractMatcherTest.*;
-import static org.junit.Assert.assertEquals;
+import static org.hamcrest.test.MatcherAssertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public final class FeatureMatcherTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/MatcherAssertTest.java b/hamcrest/src/test/java/org/hamcrest/MatcherAssertTest.java
@@ -1,10 +1,10 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.IsEqual.equalTo;
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 public final class MatcherAssertTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/NullDescriptionTest.java b/hamcrest/src/test/java/org/hamcrest/NullDescriptionTest.java
@@ -1,9 +1,9 @@
 package org.hamcrest;
 
 import org.hamcrest.Description.NullDescription;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 public final class NullDescriptionTest {
 

diff --git a/hamcrest/src/test/java/org/hamcrest/TypeSafeDiagnosingMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/TypeSafeDiagnosingMatcherTest.java
@@ -1,8 +1,8 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.hamcrest.AbstractMatcherTest.*;
+import static org.hamcrest.test.MatcherAssertions.*;
 
 /**
  * @author Steve Freeman 2016 http://www.hamcrest.com

diff --git a/hamcrest/src/test/java/org/hamcrest/TypeSafeMatcherTest.java b/hamcrest/src/test/java/org/hamcrest/TypeSafeMatcherTest.java
@@ -1,9 +1,9 @@
 package org.hamcrest;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.hamcrest.AbstractMatcherTest.assertMismatchDescription;
-import static org.junit.Assert.assertFalse;
+import static org.hamcrest.test.MatcherAssertions.assertMismatchDescription;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 
 @SuppressWarnings("WeakerAccess")
 public final class TypeSafeMatcherTest {

diff --git a/hamcrest/src/test/java/org/hamcrest/beans/HasPropertyTest.java b/hamcrest/src/test/java/org/hamcrest/beans/HasPropertyTest.java
@@ -1,9 +1,9 @@
 package org.hamcrest.beans;
 
 import org.hamcrest.Matcher;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
-import static org.hamcrest.AbstractMatcherTest.*;
+import static org.hamcrest.test.MatcherAssertions.*;
 import static org.hamcrest.beans.HasProperty.hasProperty;
 
 /**

diff --git a/hamcrest/src/test/java/org/hamcrest/beans/HasPropertyWithValueTest.java b/hamcrest/src/test/java/org/hamcrest/beans/HasPropertyWithValueTest.java
@@ -2,17 +2,21 @@
 
 import org.hamcrest.*;
 import org.hamcrest.core.IsEqual;
+import org.hamcrest.test.AbstractMatcherTest;
+import org.junit.jupiter.api.Test;
 
 import java.beans.IntrospectionException;
 import java.beans.PropertyDescriptor;
 import java.beans.SimpleBeanInfo;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.test.MatcherAssertions.*;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.beans.HasPropertyWithValue.hasProperty;
 import static org.hamcrest.beans.HasPropertyWithValue.hasPropertyAtPath;
 import static org.hamcrest.core.IsAnything.anything;
 import static org.hamcrest.core.IsEqual.equalTo;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
  * @author Iain McGinniss
@@ -33,36 +37,42 @@ protected Matcher<?> createMatcher() {
     return hasProperty("irrelevant", anything());
   }
 
+  @Test
   public void testMatchesBeanWithoutInfoWithMatchedNamedProperty() {
     final Matcher<BeanWithoutInfo> propertyMatcher = hasProperty("property", equalTo("is expected"));
 
     assertMatches("with property", propertyMatcher, shouldMatch);
     assertMismatchDescription("property 'property' was \"not expected\"", propertyMatcher, shouldNotMatch);
   }
 
+  @Test
   public void testMatchesBeanWithoutInfoWithMatchedNamedBooleanProperty() {
     final Matcher<BeanWithoutInfo> booleanPropertyMatcher = hasProperty("booleanProperty", is(true));
 
     assertMatches("with property", booleanPropertyMatcher, shouldMatch);
     assertMismatchDescription("property 'booleanProperty' was <false>", booleanPropertyMatcher, shouldNotMatch);
   }
 
+  @Test
   public void testMatchesBeanWithInfoWithMatchedNamedProperty() {
     assertMatches("with bean info", hasProperty("property", equalTo("with info")), beanWithInfo);
     assertMismatchDescription("property 'property' was \"with info\"",
         hasProperty("property", equalTo("without info")), beanWithInfo);
   }
 
+  @Test
   public void testDoesNotMatchBeanWithoutInfoOrMatchedNamedProperty() {
     assertMismatchDescription("No property \"nonExistentProperty\"",
                               hasProperty("nonExistentProperty", anything()), shouldNotMatch);
    }
 
+   @Test
   public void testDoesNotMatchWriteOnlyProperty() {
     assertMismatchDescription("property \"writeOnlyProperty\" is not readable",
                               hasProperty("writeOnlyProperty", anything()), shouldNotMatch);
   }
 
+  @Test
   public void testMatchesPath() {
     assertMatches("1-step path", hasPropertyAtPath("property", equalTo("is expected")), shouldMatch);
     assertMatches("2-step path", hasPropertyAtPath("inner.property", equalTo("is expected")), new BeanWithInner(shouldMatch));
@@ -72,31 +82,37 @@ public void testMatchesPath() {
     assertMismatchDescription("inner.inner.property.was \"not expected\"", hasPropertyAtPath("inner.inner.property", equalTo("something")), new BeanWithInner(new BeanWithInner(shouldNotMatch)));
   }
 
+  @Test
   public void testDescribeTo() {
     assertDescription("hasProperty(\"property\", <true>)", hasProperty("property", equalTo(true)));
   }
 
+  @Test
   public void testMatchesPropertyAndValue() {
     assertMatches("property with value", hasProperty("property", anything()), beanWithInfo);
   }
 
+  @Test
   public void testDoesNotWriteMismatchIfPropertyMatches() {
     Description description = new StringDescription();
     hasProperty( "property", anything()).describeMismatch(beanWithInfo, description);
-    assertEquals("Expected mismatch description", "", description.toString());
+    assertEquals("", description.toString(), "Expected mismatch description");
   }
 
+  @Test
   public void testDescribesMissingPropertyMismatch() {
     assertMismatchDescription("No property \"honk\"", hasProperty("honk", anything()), shouldNotMatch);
   }
 
+  @Test
   public void testExceptionsInBeanMethodsShouldBeReportedCorrectly() {
     assertMismatchDescription(
       "Calling 'public java.lang.String org.hamcrest.beans.HasPropertyWithValueTest$BeanWithBug.getBroken()': \"bean failed\"",
       hasProperty("broken", anything()),
       new BeanWithBug());
   }
 
+  @Test
   public void testCanAccessAnAnonymousInnerClass() {
     class X implements IX {
       @Override