You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tika.apache.org by ta...@apache.org on 2022/05/13 11:54:42 UTC

[tika] 03/10: TIKA-3761 - migrate to junit5 in tika-example

This is an automated email from the ASF dual-hosted git repository.

tallison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tika.git

commit 27b4273d05bf2fab5113a6a20d4272a4fd00dd33
Author: tallison <ta...@apache.org>
AuthorDate: Fri May 13 05:09:25 2022 -0400

    TIKA-3761 - migrate to junit5 in tika-example
---
 tika-example/pom.xml                               |  7 ----
 .../tika/example/AdvancedTypeDetectorTest.java     |  5 +--
 .../tika/example/ContentHandlerExampleTest.java    | 15 +++++----
 .../tika/example/DumpTikaConfigExampleTest.java    | 24 +++++++-------
 .../tika/example/ExtractEmbeddedFilesTest.java     | 12 +++----
 .../tika/example/LanguageDetectorExampleTest.java  |  8 ++---
 .../tika/example/SimpleTextExtractorTest.java      |  2 +-
 .../tika/example/SimpleTypeDetectorTest.java       |  2 +-
 .../apache/tika/example/TestParsingExample.java    | 37 ++++++++--------------
 .../tika/example/TextStatsFromTikaEvalTest.java    |  4 +--
 .../apache/tika/example/TranslatorExampleTest.java |  8 ++---
 11 files changed, 55 insertions(+), 69 deletions(-)

diff --git a/tika-example/pom.xml b/tika-example/pom.xml
index 301306f9b..ff5c7569a 100644
--- a/tika-example/pom.xml
+++ b/tika-example/pom.xml
@@ -120,13 +120,6 @@
       <artifactId>spring-context</artifactId>
       <version>${spring.version}</version>
     </dependency>
-    <!-- after we migrate everything to junit5, we can get rid of this -->
-    <dependency>
-      <groupId>org.junit.vintage</groupId>
-      <artifactId>junit-vintage-engine</artifactId>
-      <version>${junit5.version}</version>
-      <scope>test</scope>
-    </dependency>
   </dependencies>
 
   <description>This module contains examples of how to use Apache Tika.</description>
diff --git a/tika-example/src/test/java/org/apache/tika/example/AdvancedTypeDetectorTest.java b/tika-example/src/test/java/org/apache/tika/example/AdvancedTypeDetectorTest.java
index 0cf23218c..4f28f90d3 100755
--- a/tika-example/src/test/java/org/apache/tika/example/AdvancedTypeDetectorTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/AdvancedTypeDetectorTest.java
@@ -17,9 +17,10 @@
 
 package org.apache.tika.example;
 
-import static org.junit.Assert.assertEquals;
 
-import org.junit.Test;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.jupiter.api.Test;
 
 @SuppressWarnings("deprecation")
 public class AdvancedTypeDetectorTest {
diff --git a/tika-example/src/test/java/org/apache/tika/example/ContentHandlerExampleTest.java b/tika-example/src/test/java/org/apache/tika/example/ContentHandlerExampleTest.java
index 5a92bb4e9..d36e55a12 100644
--- a/tika-example/src/test/java/org/apache/tika/example/ContentHandlerExampleTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/ContentHandlerExampleTest.java
@@ -19,14 +19,14 @@ package org.apache.tika.example;
 
 import static org.apache.tika.TikaTest.assertContains;
 import static org.apache.tika.TikaTest.assertNotContained;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.io.IOException;
 import java.util.List;
 
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.xml.sax.SAXException;
 
 import org.apache.tika.exception.TikaException;
@@ -34,7 +34,7 @@ import org.apache.tika.exception.TikaException;
 public class ContentHandlerExampleTest {
     ContentHandlerExample example;
 
-    @Before
+    @BeforeEach
     public void setUp() {
         example = new ContentHandlerExample();
     }
@@ -42,7 +42,7 @@ public class ContentHandlerExampleTest {
     @Test
     public void testParseToPlainText() throws IOException, SAXException, TikaException {
         String result = example.parseToPlainText().trim();
-        assertEquals("Expected 'test', but got '" + result + "'", "test", result);
+        assertEquals("test", result, "Expected 'test', but got '" + result + "'");
     }
 
     @Test
@@ -91,7 +91,8 @@ public class ContentHandlerExampleTest {
 
         assertEquals(3, result.size());
         for (String chunk : result) {
-            assertTrue("Chunk under max size", chunk.length() <= example.MAXIMUM_TEXT_CHUNK_SIZE);
+            assertTrue(chunk.length() <= example.MAXIMUM_TEXT_CHUNK_SIZE,
+                    "Chunk under max size");
         }
 
         assertContains("This is in the header", result.get(0));
diff --git a/tika-example/src/test/java/org/apache/tika/example/DumpTikaConfigExampleTest.java b/tika-example/src/test/java/org/apache/tika/example/DumpTikaConfigExampleTest.java
index 7138edfd7..e10e06f35 100644
--- a/tika-example/src/test/java/org/apache/tika/example/DumpTikaConfigExampleTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/DumpTikaConfigExampleTest.java
@@ -18,8 +18,8 @@ package org.apache.tika.example;
 
 import static java.nio.charset.StandardCharsets.UTF_16LE;
 import static java.nio.charset.StandardCharsets.UTF_8;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.io.File;
 import java.io.FileOutputStream;
@@ -28,9 +28,9 @@ import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
 
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 import org.apache.tika.config.TikaConfig;
 import org.apache.tika.config.TikaConfigSerializer;
@@ -42,7 +42,7 @@ import org.apache.tika.parser.Parser;
 public class DumpTikaConfigExampleTest {
     private File configFile;
 
-    @Before
+    @BeforeEach
     public void setUp() {
         try {
             configFile = File.createTempFile("tmp", ".xml");
@@ -51,7 +51,7 @@ public class DumpTikaConfigExampleTest {
         }
     }
 
-    @After
+    @AfterEach
     public void tearDown() {
         if (configFile != null && configFile.exists()) {
             configFile.delete();
@@ -73,15 +73,15 @@ public class DumpTikaConfigExampleTest {
                 writer.close();
 
                 TikaConfig c = new TikaConfig(configFile);
-                assertTrue(c.getParser().toString(), c.getParser() instanceof CompositeParser);
-                assertTrue(c.getDetector().toString(),
-                        c.getDetector() instanceof CompositeDetector);
+                assertTrue(c.getParser() instanceof CompositeParser, c.getParser().toString());
+                assertTrue(c.getDetector() instanceof CompositeDetector,
+                        c.getDetector().toString());
 
                 CompositeParser p = (CompositeParser) c.getParser();
-                assertTrue("enough parsers?", p.getParsers().size() > 130);
+                assertTrue(p.getParsers().size() > 130, "enough parsers?");
 
                 CompositeDetector d = (CompositeDetector) c.getDetector();
-                assertTrue("enough detectors?", d.getDetectors().size() > 3);
+                assertTrue(d.getDetectors().size() > 3, "enough detectors?");
 
                 //just try to load it into autodetect to make sure no errors are thrown
                 Parser auto = new AutoDetectParser(c);
diff --git a/tika-example/src/test/java/org/apache/tika/example/ExtractEmbeddedFilesTest.java b/tika-example/src/test/java/org/apache/tika/example/ExtractEmbeddedFilesTest.java
index a9b48cca8..b4aec1484 100644
--- a/tika-example/src/test/java/org/apache/tika/example/ExtractEmbeddedFilesTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/ExtractEmbeddedFilesTest.java
@@ -17,7 +17,7 @@
 
 package org.apache.tika.example;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.io.IOException;
 import java.nio.file.DirectoryStream;
@@ -25,22 +25,22 @@ import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.List;
 
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 public class ExtractEmbeddedFilesTest {
 
     ParsingExample parsingExample;
     Path outputPath;
 
-    @Before
+    @BeforeEach
     public void setUp() throws IOException {
         parsingExample = new ParsingExample();
         outputPath = Files.createTempDirectory("tika-ext-emb-example-");
     }
 
-    @After
+    @AfterEach
     public void tearDown() throws IOException {
         //this does not act recursively, this only assumes single level directory
         try (DirectoryStream<Path> dirStream = Files.newDirectoryStream(outputPath)) {
diff --git a/tika-example/src/test/java/org/apache/tika/example/LanguageDetectorExampleTest.java b/tika-example/src/test/java/org/apache/tika/example/LanguageDetectorExampleTest.java
index 6ff1ce8b1..af0655199 100644
--- a/tika-example/src/test/java/org/apache/tika/example/LanguageDetectorExampleTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/LanguageDetectorExampleTest.java
@@ -17,17 +17,17 @@
 
 package org.apache.tika.example;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.io.IOException;
 
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 public class LanguageDetectorExampleTest {
     LanguageDetectorExample languageDetectorExample;
 
-    @Before
+    @BeforeEach
     public void setUp() {
         languageDetectorExample = new LanguageDetectorExample();
     }
diff --git a/tika-example/src/test/java/org/apache/tika/example/SimpleTextExtractorTest.java b/tika-example/src/test/java/org/apache/tika/example/SimpleTextExtractorTest.java
index e2db107c7..8ca4050af 100755
--- a/tika-example/src/test/java/org/apache/tika/example/SimpleTextExtractorTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/SimpleTextExtractorTest.java
@@ -24,7 +24,7 @@ import java.io.File;
 import java.io.PrintStream;
 
 import org.apache.commons.io.FileUtils;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import org.apache.tika.TikaTest;
 
diff --git a/tika-example/src/test/java/org/apache/tika/example/SimpleTypeDetectorTest.java b/tika-example/src/test/java/org/apache/tika/example/SimpleTypeDetectorTest.java
index f73eae2e4..b92ab60e8 100755
--- a/tika-example/src/test/java/org/apache/tika/example/SimpleTypeDetectorTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/SimpleTypeDetectorTest.java
@@ -22,7 +22,7 @@ import static java.nio.charset.StandardCharsets.UTF_8;
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import org.apache.tika.TikaTest;
 
diff --git a/tika-example/src/test/java/org/apache/tika/example/TestParsingExample.java b/tika-example/src/test/java/org/apache/tika/example/TestParsingExample.java
index e266e456a..bf9a4b774 100644
--- a/tika-example/src/test/java/org/apache/tika/example/TestParsingExample.java
+++ b/tika-example/src/test/java/org/apache/tika/example/TestParsingExample.java
@@ -17,35 +17,26 @@
 
 package org.apache.tika.example;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.io.IOException;
 import java.io.StringReader;
 import java.util.List;
 
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 import org.xml.sax.SAXException;
 
+import org.apache.tika.TikaTest;
 import org.apache.tika.exception.TikaException;
 import org.apache.tika.metadata.Metadata;
 import org.apache.tika.metadata.serialization.JsonMetadataList;
 
-public class TestParsingExample {
+public class TestParsingExample extends TikaTest {
     ParsingExample parsingExample;
 
-    public static void assertContains(String needle, String haystack) {
-        assertTrue("Should have found " + needle + " in: " + haystack, haystack.contains(needle));
-    }
-
-    public static void assertNotContains(String needle, String haystack) {
-        assertFalse("Should not have found " + needle + " in: " + haystack,
-                haystack.contains(needle));
-    }
-
-    @Before
+    @BeforeEach
     public void setUp() {
         parsingExample = new ParsingExample();
     }
@@ -53,22 +44,22 @@ public class TestParsingExample {
     @Test
     public void testParseToStringExample() throws IOException, SAXException, TikaException {
         String result = parsingExample.parseToStringExample().trim();
-        assertEquals("Expected 'test', but got '" + result + "'", "test", result);
+        assertEquals("test", result, "enough detectors?");
     }
 
     @Test
     public void testParseExample() throws IOException, SAXException, TikaException {
         String result = parsingExample.parseExample().trim();
-        assertEquals("Expected 'test', but got '" + result + "'", "test", result);
+        assertEquals("test", result, "Expected 'test', but got '" + result + "'");
     }
 
     @Test
     public void testNoEmbeddedExample() throws IOException, SAXException, TikaException {
         String result = parsingExample.parseNoEmbeddedExample();
         assertContains("embed_0", result);
-        assertNotContains("embed1/embed1a.txt", result);
-        assertNotContains("embed3/embed3.txt", result);
-        assertNotContains("When in the Course", result);
+        assertNotContained("embed1/embed1a.txt", result);
+        assertNotContained("embed3/embed3.txt", result);
+        assertNotContained("When in the Course", result);
     }
 
     @Test
@@ -84,8 +75,8 @@ public class TestParsingExample {
     public void testRecursiveParserWrapperExample()
             throws IOException, SAXException, TikaException {
         List<Metadata> metadataList = parsingExample.recursiveParserWrapperExample();
-        assertEquals("Number of embedded documents + 1 for the container document", 12,
-                metadataList.size());
+        assertEquals(12, metadataList.size(),
+                "Number of embedded documents + 1 for the container document");
         Metadata m = metadataList.get(6);
         //this is the location the embed3.txt text file within the outer .docx
         assertEquals("/embed1.zip/embed2.zip/embed3.zip/embed3.txt",
diff --git a/tika-example/src/test/java/org/apache/tika/example/TextStatsFromTikaEvalTest.java b/tika-example/src/test/java/org/apache/tika/example/TextStatsFromTikaEvalTest.java
index 273fb60f2..30f52ce5e 100644
--- a/tika-example/src/test/java/org/apache/tika/example/TextStatsFromTikaEvalTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/TextStatsFromTikaEvalTest.java
@@ -16,9 +16,9 @@
  */
 package org.apache.tika.example;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class TextStatsFromTikaEvalTest {
 
diff --git a/tika-example/src/test/java/org/apache/tika/example/TranslatorExampleTest.java b/tika-example/src/test/java/org/apache/tika/example/TranslatorExampleTest.java
index bd869e5a0..4ca556c32 100644
--- a/tika-example/src/test/java/org/apache/tika/example/TranslatorExampleTest.java
+++ b/tika-example/src/test/java/org/apache/tika/example/TranslatorExampleTest.java
@@ -17,17 +17,17 @@
 
 package org.apache.tika.example;
 
-import static org.junit.Assert.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.util.Locale;
 
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 public class TranslatorExampleTest {
     TranslatorExample translatorExample;
 
-    @Before
+    @BeforeEach
     public void setUp() {
         translatorExample = new TranslatorExample();
     }