You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/10/01 14:19:41 UTC
(commons-compress) branch master updated: Make test more readable and maintainable, and less verbose
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
The following commit(s) were added to refs/heads/master by this push:
new 32e83a514 Make test more readable and maintainable, and less verbose
32e83a514 is described below
commit 32e83a514d11dc6fde8ae9d388920c3f7983c548
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Oct 1 10:19:35 2024 -0400
Make test more readable and maintainable, and less verbose
- Use JUnit 5 APIs
- Be consistent throughout tests
---
pom.xml | 6 ----
.../archivers/ar/ArArchiveInputStreamTest.java | 38 +++++++---------------
.../archivers/zip/ZipClassCoverageTest.java | 5 ++-
.../compress/archivers/zip/ZipEncodingTest.java | 5 ++-
.../lz4/FramedLZ4CompressorInputStreamTest.java | 34 +++++++++----------
.../utils/FixedLengthBlockOutputStreamTest.java | 4 +--
6 files changed, 33 insertions(+), 59 deletions(-)
diff --git a/pom.xml b/pom.xml
index 0beadf1f0..a76e3ab06 100644
--- a/pom.xml
+++ b/pom.xml
@@ -112,12 +112,6 @@ Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.
<artifactId>junit-vintage-engine</artifactId>
<scope>test</scope>
</dependency>
- <dependency>
- <groupId>org.hamcrest</groupId>
- <artifactId>hamcrest</artifactId>
- <version>3.0</version>
- <scope>test</scope>
- </dependency>
<dependency>
<groupId>com.github.luben</groupId>
<artifactId>zstd-jni</artifactId>
diff --git a/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java b/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
index 7d7c49fa4..b5b66b37c 100644
--- a/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
+++ b/src/test/java/org/apache/commons/compress/archivers/ar/ArArchiveInputStreamTest.java
@@ -17,10 +17,6 @@
package org.apache.commons.compress.archivers.ar;
-import static org.hamcrest.CoreMatchers.equalTo;
-import static org.hamcrest.CoreMatchers.not;
-import static org.hamcrest.CoreMatchers.nullValue;
-import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
@@ -153,28 +149,23 @@ public class ArArchiveInputStreamTest extends AbstractTest {
@Test
public void testSimpleInputStream() throws IOException {
try (InputStream fileInputStream = newInputStream("bla.ar");
-
// This default implementation of InputStream.available() always returns zero,
// and there are many streams in practice where the total length of the stream is not known.
-
InputStream simpleInputStream = new InputStream() {
@Override
public int read() throws IOException {
return fileInputStream.read();
}
}) {
-
try (ArArchiveInputStream archiveInputStream = new ArArchiveInputStream(simpleInputStream)) {
final ArArchiveEntry entry1 = archiveInputStream.getNextEntry();
- assertThat(entry1, not(nullValue()));
- assertThat(entry1.getName(), equalTo("test1.xml"));
- assertThat(entry1.getLength(), equalTo(610L));
-
+ assertNotNull(entry1);
+ assertEquals("test1.xml", entry1.getName());
+ assertEquals(610L, entry1.getLength());
final ArArchiveEntry entry2 = archiveInputStream.getNextEntry();
- assertThat(entry2.getName(), equalTo("test2.xml"));
- assertThat(entry2.getLength(), equalTo(82L));
-
- assertThat(archiveInputStream.getNextEntry(), nullValue());
+ assertEquals("test2.xml", entry2.getName());
+ assertEquals(82L, entry2.getLength());
+ assertNull(archiveInputStream.getNextEntry());
}
}
}
@@ -183,28 +174,23 @@ public class ArArchiveInputStreamTest extends AbstractTest {
@Test
public void testSimpleInputStreamDeprecated() throws IOException {
try (InputStream fileInputStream = newInputStream("bla.ar");
-
// This default implementation of InputStream.available() always returns zero,
// and there are many streams in practice where the total length of the stream is not known.
-
InputStream simpleInputStream = new InputStream() {
@Override
public int read() throws IOException {
return fileInputStream.read();
}
}) {
-
try (ArArchiveInputStream archiveInputStream = new ArArchiveInputStream(simpleInputStream)) {
final ArArchiveEntry entry1 = archiveInputStream.getNextArEntry();
- assertThat(entry1, not(nullValue()));
- assertThat(entry1.getName(), equalTo("test1.xml"));
- assertThat(entry1.getLength(), equalTo(610L));
-
+ assertNotNull(entry1);
+ assertEquals("test1.xml", entry1.getName());
+ assertEquals(610L, entry1.getLength());
final ArArchiveEntry entry2 = archiveInputStream.getNextArEntry();
- assertThat(entry2.getName(), equalTo("test2.xml"));
- assertThat(entry2.getLength(), equalTo(82L));
-
- assertThat(archiveInputStream.getNextArEntry(), nullValue());
+ assertEquals("test2.xml", entry2.getName());
+ assertEquals(82L, entry2.getLength());
+ assertNull(archiveInputStream.getNextArEntry());
}
}
}
diff --git a/src/test/java/org/apache/commons/compress/archivers/zip/ZipClassCoverageTest.java b/src/test/java/org/apache/commons/compress/archivers/zip/ZipClassCoverageTest.java
index dc9d722a5..2fe5bce50 100644
--- a/src/test/java/org/apache/commons/compress/archivers/zip/ZipClassCoverageTest.java
+++ b/src/test/java/org/apache/commons/compress/archivers/zip/ZipClassCoverageTest.java
@@ -18,15 +18,14 @@
*/
package org.apache.commons.compress.archivers.zip;
-import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
-import org.hamcrest.core.IsInstanceOf;
import org.junit.jupiter.api.Test;
public class ZipClassCoverageTest {
@@ -38,7 +37,7 @@ public class ZipClassCoverageTest {
assertFalse(constructor.isAccessible());
constructor.setAccessible(true);
final Object o = constructor.newInstance();
- assertThat(o, IsInstanceOf.instanceOf(clazz));
+ assertInstanceOf(clazz, o);
constructor.setAccessible(false);
}
diff --git a/src/test/java/org/apache/commons/compress/archivers/zip/ZipEncodingTest.java b/src/test/java/org/apache/commons/compress/archivers/zip/ZipEncodingTest.java
index 0dce5c049..82a3962e8 100644
--- a/src/test/java/org/apache/commons/compress/archivers/zip/ZipEncodingTest.java
+++ b/src/test/java/org/apache/commons/compress/archivers/zip/ZipEncodingTest.java
@@ -19,8 +19,8 @@
package org.apache.commons.compress.archivers.zip;
-import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
@@ -29,7 +29,6 @@ import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
-import org.hamcrest.core.IsInstanceOf;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
@@ -68,7 +67,7 @@ public class ZipEncodingTest {
private void doSimpleEncodingTest(final String name, byte[] testBytes) throws IOException {
final ZipEncoding enc = ZipEncodingHelper.getZipEncoding(name);
- assertThat(enc, IsInstanceOf.instanceOf(NioZipEncoding.class));
+ assertInstanceOf(NioZipEncoding.class, enc);
if (testBytes == null) {
testBytes = new byte[256];
diff --git a/src/test/java/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorInputStreamTest.java b/src/test/java/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorInputStreamTest.java
index 1f951efd0..3bf817747 100644
--- a/src/test/java/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorInputStreamTest.java
+++ b/src/test/java/org/apache/commons/compress/compressors/lz4/FramedLZ4CompressorInputStreamTest.java
@@ -18,8 +18,6 @@
*/
package org.apache.commons.compress.compressors.lz4;
-import static org.hamcrest.CoreMatchers.containsString;
-import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
@@ -248,7 +246,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("block checksum"));
+ assertTrue(ex.getMessage().contains("block checksum"));
}
@Test
@@ -261,7 +259,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
try (InputStream a = new FramedLZ4CompressorInputStream(new ByteArrayInputStream(input))) {
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("header checksum mismatch"));
+ assertTrue(ex.getMessage().contains("header checksum mismatch"));
}
@Test
@@ -274,7 +272,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
try (InputStream a = new FramedLZ4CompressorInputStream(new ByteArrayInputStream(input))) {
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("content size"));
+ assertTrue(ex.getMessage().contains("content size"));
}
@Test
@@ -286,7 +284,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
try (InputStream a = new FramedLZ4CompressorInputStream(new ByteArrayInputStream(input))) {
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("BD byte"));
+ assertTrue(ex.getMessage().contains("BD byte"));
}
@Test
@@ -297,7 +295,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
try (InputStream a = new FramedLZ4CompressorInputStream(new ByteArrayInputStream(input))) {
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("frame flags"));
+ assertTrue(ex.getMessage().contains("frame flags"));
}
@Test
@@ -310,7 +308,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
try (InputStream a = new FramedLZ4CompressorInputStream(new ByteArrayInputStream(input))) {
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("header checksum"));
+ assertTrue(ex.getMessage().contains("header checksum"));
}
@Test
@@ -322,7 +320,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
try (InputStream a = new FramedLZ4CompressorInputStream(new ByteArrayInputStream(input))) {
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("version"));
+ assertTrue(ex.getMessage().contains("version"));
}
@Test
@@ -349,7 +347,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("garbage"));
+ assertTrue(ex.getMessage().contains("garbage"));
}
@Test
@@ -371,7 +369,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("garbage"));
+ assertTrue(ex.getMessage().contains("garbage"));
}
@Test
@@ -391,7 +389,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
fail();
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("garbage"));
+ assertTrue(ex.getMessage().contains("garbage"));
}
@Test
@@ -410,7 +408,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("garbage"));
+ assertTrue(ex.getMessage().contains("garbage"));
}
@Test
@@ -431,7 +429,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("Premature end of stream while skipping frame"));
+ assertTrue(ex.getMessage().contains("Premature end of stream while skipping frame"));
}
@Test
@@ -451,7 +449,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("Premature end of data"));
+ assertTrue(ex.getMessage().contains("Premature end of data"));
}
@Test
@@ -469,7 +467,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("content checksum mismatch"));
+ assertTrue(ex.getMessage().contains("content checksum mismatch"));
}
@Test
@@ -487,7 +485,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("content checksum"));
+ assertTrue(ex.getMessage().contains("content checksum"));
}
@Test
@@ -506,7 +504,7 @@ public final class FramedLZ4CompressorInputStreamTest extends AbstractTest {
IOUtils.toByteArray(a);
}
}, "expected exception");
- assertThat(ex.getMessage(), containsString("garbage"));
+ assertTrue(ex.getMessage().contains("garbage"));
}
@Test
diff --git a/src/test/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStreamTest.java b/src/test/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStreamTest.java
index 02d1e17a9..48cfdd5df 100644
--- a/src/test/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStreamTest.java
+++ b/src/test/java/org/apache/commons/compress/utils/FixedLengthBlockOutputStreamTest.java
@@ -19,8 +19,6 @@
package org.apache.commons.compress.utils;
import static java.nio.charset.StandardCharsets.US_ASCII;
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.Matchers.greaterThanOrEqualTo;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
@@ -124,7 +122,7 @@ public class FixedLengthBlockOutputStreamTest {
}
private static void assertContainsAtOffset(final String msg, final byte[] expected, final int offset, final byte[] actual) {
- assertThat(actual.length, greaterThanOrEqualTo(offset + expected.length));
+ assertTrue(actual.length >= offset + expected.length);
for (int i = 0; i < expected.length; i++) {
assertEquals(expected[i], actual[i + offset], String.format("%s ([%d])", msg, i));
}