Merge pull request #214 from strangelookingnerd/migrate_junit5

Migrate tests to JUnit5

Author: garydgregory

pom.xml

@@ -59,7 +59,7 @@
       <email>ggregory at apache.org</email>
       <url>https://www.garygregory.com</url>
       <organization>The Apache Software Foundation</organization>
-      <organizationUrl>https://www.apache.org/</organizationUrl>      
+      <organizationUrl>https://www.apache.org/</organizationUrl>
       <roles>
         <role>PMC Member</role>
       </roles>
@@ -105,7 +105,7 @@
     <commons.jacoco.branchRatio>0.68</commons.jacoco.branchRatio>
     <commons.jacoco.lineRatio>0.77</commons.jacoco.lineRatio>
     <commons.jacoco.complexityRatio>0.64</commons.jacoco.complexityRatio>
-  </properties> 
+  </properties>
   <build>
     <defaultGoal>clean apache-rat:check verify japicmp:cmp checkstyle:check pmd:check javadoc:javadoc</defaultGoal>
     <plugins>
@@ -157,7 +157,7 @@
             <link>https://commons.apache.org/proper/commons-beanutils/apidocs</link>
             <link>https://commons.apache.org/proper/commons-lang/apidocs</link>
             <!-- http://www.jdom.org/docs/apidocs/ is not a secure link -->
-            <link>https://javadoc.io/doc/org.jdom/jdom/1.1</link> 
+            <link>https://javadoc.io/doc/org.jdom/jdom/1.1</link>
           </links>
         </configuration>
       </plugin>
@@ -215,9 +215,9 @@
       <optional>true</optional>
     </dependency>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.13.2</version>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>5.11.4</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -310,7 +310,7 @@
             <link>http://java.sun.com/j2se/1.3/docs/api/</link>
             <link>http://java.sun.com/javaee/5/docs/api/</link>
             <link>http://commons.apache.org/beanutils/apidocs/</link>
-            <link>http://www.jdom.org/docs/apidocs/</link> 
+            <link>http://www.jdom.org/docs/apidocs/</link>
           </links>
         </configuration>
       </plugin>

src/test/java/org/apache/commons/jxpath/AbstractJXPathTest.java

@@ -26,18 +26,24 @@
 import java.util.Set;
 
 import org.apache.commons.jxpath.ri.model.NodePointer;
+import org.junit.jupiter.api.BeforeEach;
 
-import junit.framework.TestCase;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 /**
  * Abstract superclass for various JXPath tests.
  */
-public abstract class AbstractJXPathTest extends TestCase {
+public abstract class AbstractJXPathTest {
 
     /**
      * Constructs a new instance of this test case.
+     *
+     * @throws Exception In case of errors during setup
      */
-    public AbstractJXPathTest() {
+    @BeforeEach
+    protected void setUp() throws Exception
+    {
         Locale.setDefault(Locale.US);
     }
 
@@ -46,15 +52,15 @@ protected void assertXPathValue(final JXPathContext ctx,
     {
         ctx.setLenient(false);
         final Object actual = ctx.getValue(xpath);
-        assertEquals("Evaluating <" + xpath + ">", expected, actual);
+        assertEquals(expected, actual, "Evaluating <" + xpath + ">");
     }
 
     protected void assertXPathValue(final JXPathContext ctx,
                 final String xpath, final Object expected, final Class resultType)
     {
         ctx.setLenient(false);
         final Object actual = ctx.getValue(xpath, resultType);
-        assertEquals("Evaluating <" + xpath + ">", expected, actual);
+        assertEquals(expected, actual, "Evaluating <" + xpath + ">");
     }
 
     protected void assertXPathValueLenient(final JXPathContext ctx,
@@ -63,7 +69,7 @@ protected void assertXPathValueLenient(final JXPathContext ctx,
         ctx.setLenient(true);
         final Object actual = ctx.getValue(xpath);
         ctx.setLenient(false);
-        assertEquals("Evaluating lenient <" + xpath + ">", expected, actual);
+        assertEquals(expected, actual, "Evaluating lenient <" + xpath + ">");
     }
 
     protected void assertXPathSetValue(final JXPathContext ctx,
@@ -77,37 +83,37 @@ protected void assertXPathSetValue(final JXPathContext ctx,
     {
         ctx.setValue(xpath, value);
         final Object actual = ctx.getValue(xpath);
-        assertEquals("Modifying <" + xpath + ">", expected, actual);
+        assertEquals(expected, actual, "Modifying <" + xpath + ">");
     }
 
     protected void assertXPathCreatePath(final JXPathContext ctx,
                 final String xpath,
                 final Object expectedValue, final String expectedPath)
     {
         final Pointer pointer = ctx.createPath(xpath);
-        assertEquals("Creating path <" + xpath + ">",
-                expectedPath, pointer.asPath());
+        assertEquals(expectedPath, pointer.asPath(),
+                "Creating path <" + xpath + ">");
 
-        assertEquals("Creating path (pointer value) <" + xpath + ">",
-                expectedValue, pointer.getValue());
+        assertEquals(expectedValue, pointer.getValue(),
+                "Creating path (pointer value) <" + xpath + ">");
 
-        assertEquals("Creating path (context value) <" + xpath + ">",
-                expectedValue, ctx.getValue(pointer.asPath()));
+        assertEquals(expectedValue, ctx.getValue(pointer.asPath()),
+                "Creating path (context value) <" + xpath + ">");
     }
 
     protected void assertXPathCreatePathAndSetValue(final JXPathContext ctx,
                 final String xpath, final Object value,
                 final String expectedPath)
     {
         final Pointer pointer = ctx.createPathAndSetValue(xpath, value);
-        assertEquals("Creating path <" + xpath + ">",
-                expectedPath, pointer.asPath());
+        assertEquals(expectedPath, pointer.asPath(),
+                "Creating path <" + xpath + ">");
 
-        assertEquals("Creating path (pointer value) <" + xpath + ">",
-                value, pointer.getValue());
+        assertEquals(value, pointer.getValue(),
+                "Creating path (pointer value) <" + xpath + ">");
 
-        assertEquals("Creating path (context value) <" + xpath + ">",
-                value, ctx.getValue(pointer.asPath()));
+        assertEquals(value, ctx.getValue(pointer.asPath()),
+                "Creating path (context value) <" + xpath + ">");
     }
 
     protected void assertXPathPointer(final JXPathContext ctx,
@@ -116,7 +122,7 @@ protected void assertXPathPointer(final JXPathContext ctx,
         ctx.setLenient(false);
         final Pointer pointer = ctx.getPointer(xpath);
         final String actual = pointer.toString();
-        assertEquals("Evaluating pointer <" + xpath + ">", expected, actual);
+        assertEquals(expected, actual, "Evaluating pointer <" + xpath + ">");
     }
 
     protected void assertXPathPointerLenient(final JXPathContext ctx,
@@ -125,7 +131,7 @@ protected void assertXPathPointerLenient(final JXPathContext ctx,
         ctx.setLenient(true);
         final Pointer pointer = ctx.getPointer(xpath);
         final String actual = pointer.toString();
-        assertEquals("Evaluating pointer <" + xpath + ">", expected, actual);
+        assertEquals(expected, actual, "Evaluating pointer <" + xpath + ">");
     }
 
     protected void assertXPathValueAndPointer(final JXPathContext ctx,
@@ -148,10 +154,12 @@ protected <E> void assertXPathValueIterator(final JXPathContext ctx,
         while (it.hasNext()) {
             actual.add(it.next());
         }
-        assertEquals(String.format("[hashCode()] Evaluating value iterator <%s>, expected.class %s(%,d): %s, actual.class %s(%,d): %s", xpath,
-                expected.getClass(), expected.size(), expected, actual.getClass(), actual.size(), actual), expected.hashCode(), actual.hashCode());
-        assertEquals(String.format("[equals()] Evaluating value iterator <%s>, expected.class %s(%,d): %s, actual.class %s(%,d): %s", xpath,
-                expected.getClass(), expected.size(), expected, actual.getClass(), actual.size(), actual), expected, actual);
+        assertEquals(expected.hashCode(), actual.hashCode(),
+                String.format("[hashCode()] Evaluating value iterator <%s>, expected.class %s(%,d): %s, actual.class %s(%,d): %s", xpath,
+                        expected.getClass(), expected.size(), expected, actual.getClass(), actual.size(), actual));
+        assertEquals(expected, actual,
+                String.format("[equals()] Evaluating value iterator <%s>, expected.class %s(%,d): %s, actual.class %s(%,d): %s", xpath,
+                        expected.getClass(), expected.size(), expected, actual.getClass(), actual.size(), actual));
     }
 
     protected void assertXPathPointerIterator(
@@ -172,9 +180,9 @@ protected void assertXPathPointerIterator(
             actual.add(pointer.toString());
         }
         assertEquals(
-            "Evaluating pointer iterator <" + xpath + ">",
             expected,
-            actual);
+            actual,
+            "Evaluating pointer iterator <" + xpath + ">");
     }
 
     protected void assertDocumentOrder(
@@ -193,9 +201,9 @@ else if (res > 0) {
             res = 1;
         }
         assertEquals(
-            "Comparing paths '" + path1 + "' and '" + path2 + "'",
             expected,
-            res);
+            res,
+            "Comparing paths '" + path1 + "' and '" + path2 + "'");
     }
 
     protected void assertXPathValueType(
@@ -205,8 +213,7 @@ protected void assertXPathValueType(
     {
         ctx.setLenient(false);
         final Object actual = ctx.getValue(xpath);
-        assertTrue("Evaluating <" + xpath + "> = " + actual.getClass(),
-                clazz.isAssignableFrom(actual.getClass()));
+        assertTrue(clazz.isAssignableFrom(actual.getClass()), "Evaluating <" + xpath + "> = " + actual.getClass());
     }
 
     protected void assertXPathNodeType(
@@ -216,8 +223,8 @@ protected void assertXPathNodeType(
     {
         ctx.setLenient(false);
         final Pointer actual = ctx.getPointer(xpath);
-        assertTrue("Evaluating <" + xpath + "> = " + actual.getNode().getClass(),
-                clazz.isAssignableFrom(actual.getNode().getClass()));
+        assertTrue(clazz.isAssignableFrom(actual.getNode().getClass()),
+                "Evaluating <" + xpath + "> = " + actual.getNode().getClass());
     }
 
     protected static List list() {

src/test/java/org/apache/commons/jxpath/BasicNodeSetTest.java

@@ -19,8 +19,12 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.w3c.dom.Element;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
 /**
  * Test BasicNodeSet
  */
@@ -33,6 +37,7 @@ public class BasicNodeSetTest extends AbstractJXPathTest {
     protected BasicNodeSet nodeSet;
 
     @Override
+    @BeforeEach
     protected void setUp() throws Exception {
         super.setUp();
         context = JXPathContext.newContext(new TestMixedModelBean());
@@ -75,10 +80,12 @@ protected void nudge() {
     /**
      * Test adding pointers.
      */
+    @Test
     public void testAdd() {
         addPointers("/bean/integers");
-        assertEquals(nodeSet.getPointers().toString(), list("/bean/integers[1]",
-                "/bean/integers[2]", "/bean/integers[3]", "/bean/integers[4]").toString());
+        assertEquals(list("/bean/integers[1]",
+                "/bean/integers[2]", "/bean/integers[3]", "/bean/integers[4]").toString(),
+                nodeSet.getPointers().toString());
         assertEquals(list(Integer.valueOf(1), Integer.valueOf(2), Integer.valueOf(3),
                 Integer.valueOf(4)), nodeSet.getValues());
         assertEquals(list(Integer.valueOf(1), Integer.valueOf(2), Integer.valueOf(3),
@@ -88,6 +95,7 @@ public void testAdd() {
     /**
      * Test removing a pointer.
      */
+    @Test
     public void testRemove() {
         addPointers("/bean/integers");
         removePointers("/bean/integers[4]");
@@ -102,6 +110,7 @@ public void testRemove() {
     /**
      * Demonstrate when nodes != values:  in XML models.
      */
+    @Test
     public void testNodes() {
         addPointers("/document/vendor/contact");
         assertEquals(list("/document/vendor[1]/contact[1]",

src/test/java/org/apache/commons/jxpath/issues/JXPath113Test.java

@@ -24,12 +24,14 @@
 
 import org.apache.commons.jxpath.JXPathContext;
 import org.apache.commons.jxpath.AbstractJXPathTest;
+import org.junit.jupiter.api.Test;
 import org.w3c.dom.Document;
 import org.xml.sax.InputSource;
 
 public class JXPath113Test extends AbstractJXPathTest
 {
 
+    @Test
     public void testIssue113() throws Exception
     {
         final Document doc = JAXP.getDocument("<xml/>");

src/test/java/org/apache/commons/jxpath/issues/JXPath118Test.java

@@ -21,23 +21,25 @@
 import org.apache.commons.jxpath.JXPathContext;
 import org.apache.commons.jxpath.Pointer;
 
-import junit.framework.Assert;
-import junit.framework.TestCase;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
  * Testcase proving JXPATH-118 issue with asPath() returning wrong names.
  */
-public class JXPath118Test extends TestCase
+public class JXPath118Test
 {
 
+    @Test
     public void testJXPATH118IssueWithAsPath() throws Exception
     {
         final Object contextBean = new SomeChildClass();
         final JXPathContext context = JXPathContext.newContext(contextBean);
         final Iterator<Pointer> iteratePointers = context.iteratePointers("//*");
-        Assert.assertEquals("/bar", iteratePointers.next().asPath());
-        Assert.assertEquals("/baz", iteratePointers.next().asPath());
-        Assert.assertEquals("/foo", iteratePointers.next().asPath());
+        assertEquals("/bar", iteratePointers.next().asPath());
+        assertEquals("/baz", iteratePointers.next().asPath());
+        assertEquals("/foo", iteratePointers.next().asPath());
     }
 
     public static class SomeChildClass

src/test/java/org/apache/commons/jxpath/issues/JXPath149Test.java

@@ -18,9 +18,11 @@
 
 import org.apache.commons.jxpath.JXPathContext;
 import org.apache.commons.jxpath.AbstractJXPathTest;
+import org.junit.jupiter.api.Test;
 
 public class JXPath149Test extends AbstractJXPathTest {
 
+    @Test
     public void testComplexOperationWithVariables() {
         final JXPathContext context = JXPathContext.newContext(null);
         context.getVariables().declareVariable("a", Integer.valueOf(0));