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 2023/08/29 19:23:03 UTC

[commons-compress] branch master updated (be63e111 -> 5ff8af5f)

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

ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git


    from be63e111 Use try-with-resources
     new ba7a337d Use try-with-resources
     new b5e93bb5 Use try-with-resources
     new 2b00b7f8 Use try-with-resources
     new 5ff8af5f Use try-with-resources

The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../CompressorStreamFactoryRoundtripTest.java      | 23 +++----
 .../compressors/DetectCompressorTestCase.java      | 73 ++++++++++++----------
 .../commons/compress/compressors/GZipTestCase.java | 36 +++++------
 .../bzip2/BZip2CompressorInputStreamTest.java      | 40 ++++++------
 .../bzip2/PythonTruncatedBzip2Test.java            |  6 +-
 5 files changed, 90 insertions(+), 88 deletions(-)


[commons-compress] 04/04: Use try-with-resources

Posted by gg...@apache.org.
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

commit 5ff8af5fdffb355c57d1e83a8c8a1bd288546a00
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 29 15:22:55 2023 -0400

    Use try-with-resources
---
 .../bzip2/BZip2CompressorInputStreamTest.java      | 40 ++++++++++------------
 .../bzip2/PythonTruncatedBzip2Test.java            |  6 ++--
 2 files changed, 21 insertions(+), 25 deletions(-)

diff --git a/src/test/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStreamTest.java b/src/test/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStreamTest.java
index 7c32c828..57c62bd2 100644
--- a/src/test/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStreamTest.java
+++ b/src/test/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStreamTest.java
@@ -54,13 +54,11 @@ public class BZip2CompressorInputStreamTest extends AbstractTestCase {
     public void multiByteReadConsistentlyReturnsMinusOneAtEof() throws IOException {
         final File input = getFile("bla.txt.bz2");
         final byte[] buf = new byte[2];
-        try (InputStream is = Files.newInputStream(input.toPath())) {
-            final BZip2CompressorInputStream in =
-                    new BZip2CompressorInputStream(is);
+        try (InputStream is = Files.newInputStream(input.toPath());
+                final BZip2CompressorInputStream in = new BZip2CompressorInputStream(is)) {
             IOUtils.toByteArray(in);
             assertEquals(-1, in.read(buf));
             assertEquals(-1, in.read(buf));
-            in.close();
         }
     }
 
@@ -71,27 +69,27 @@ public class BZip2CompressorInputStreamTest extends AbstractTestCase {
     public void readOfLength0ShouldReturn0() throws Exception {
         // Create a big random piece of data
         final byte[] rawData = new byte[1048576];
-        for (int i=0; i < rawData.length; ++i) {
-            rawData[i] = (byte) Math.floor(Math.random()*256);
+        for (int i = 0; i < rawData.length; ++i) {
+            rawData[i] = (byte) Math.floor(Math.random() * 256);
         }
 
         // Compress it
         final ByteArrayOutputStream baos = new ByteArrayOutputStream();
-        final BZip2CompressorOutputStream bzipOut = new BZip2CompressorOutputStream(baos);
-        bzipOut.write(rawData);
-        bzipOut.flush();
-        bzipOut.close();
-        baos.flush();
-        baos.close();
+        try (BZip2CompressorOutputStream bzipOut = new BZip2CompressorOutputStream(baos)) {
+            bzipOut.write(rawData);
+            bzipOut.flush();
+            bzipOut.close();
+            baos.flush();
+        }
 
         // Try to read it back in
         final ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
-        final BZip2CompressorInputStream bzipIn = new BZip2CompressorInputStream(bais);
-        final byte[] buffer = new byte[1024];
-        assertEquals(1024, bzipIn.read(buffer, 0, 1024));
-        assertEquals(0, bzipIn.read(buffer, 1024, 0));
-        assertEquals(1024, bzipIn.read(buffer, 0, 1024));
-        bzipIn.close();
+        try (BZip2CompressorInputStream bzipIn = new BZip2CompressorInputStream(bais)) {
+            final byte[] buffer = new byte[1024];
+            assertEquals(1024, bzipIn.read(buffer, 0, 1024));
+            assertEquals(0, bzipIn.read(buffer, 1024, 0));
+            assertEquals(1024, bzipIn.read(buffer, 0, 1024));
+        }
     }
 
     @Test
@@ -150,13 +148,11 @@ public class BZip2CompressorInputStreamTest extends AbstractTestCase {
     @Test
     public void singleByteReadConsistentlyReturnsMinusOneAtEof() throws IOException {
         final File input = getFile("bla.txt.bz2");
-        try (InputStream is = Files.newInputStream(input.toPath())) {
-            final BZip2CompressorInputStream in =
-                    new BZip2CompressorInputStream(is);
+        try (InputStream is = Files.newInputStream(input.toPath());
+                final BZip2CompressorInputStream in = new BZip2CompressorInputStream(is)) {
             IOUtils.toByteArray(in);
             assertEquals(-1, in.read());
             assertEquals(-1, in.read());
-            in.close();
         }
     }
 }
diff --git a/src/test/java/org/apache/commons/compress/compressors/bzip2/PythonTruncatedBzip2Test.java b/src/test/java/org/apache/commons/compress/compressors/bzip2/PythonTruncatedBzip2Test.java
index 1bfe717b..376d5b96 100644
--- a/src/test/java/org/apache/commons/compress/compressors/bzip2/PythonTruncatedBzip2Test.java
+++ b/src/test/java/org/apache/commons/compress/compressors/bzip2/PythonTruncatedBzip2Test.java
@@ -57,9 +57,9 @@ public class PythonTruncatedBzip2Test {
     @BeforeAll
     public static void initializeTestData() throws IOException {
         final ByteArrayOutputStream out = new ByteArrayOutputStream();
-        final BZip2CompressorOutputStream bz2out = new BZip2CompressorOutputStream(out);
-        bz2out.write(TEXT.getBytes(), 0, TEXT.getBytes().length);
-        bz2out.close();
+        try (BZip2CompressorOutputStream bz2out = new BZip2CompressorOutputStream(out)) {
+            bz2out.write(TEXT.getBytes(), 0, TEXT.getBytes().length);
+        }
         DATA = out.toByteArray();
 
         // Drop the eos_magic field (6 bytes) and CRC (4 bytes).


[commons-compress] 01/04: Use try-with-resources

Posted by gg...@apache.org.
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

commit ba7a337dd17ccb44b9a0ad5e05455bb8729a2a70
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 29 10:58:24 2023 -0400

    Use try-with-resources
---
 .../commons/compress/compressors/GZipTestCase.java | 36 ++++++++++------------
 1 file changed, 16 insertions(+), 20 deletions(-)

diff --git a/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java b/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
index 83bcfb8c..1aa2da23 100644
--- a/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
+++ b/src/test/java/org/apache/commons/compress/compressors/GZipTestCase.java
@@ -47,26 +47,22 @@ public final class GZipTestCase extends AbstractTestCase {
     public void multiByteReadConsistentlyReturnsMinusOneAtEof() throws IOException {
         final File input = getFile("bla.tgz");
         final byte[] buf = new byte[2];
-        try (InputStream is = Files.newInputStream(input.toPath())) {
-            final GzipCompressorInputStream in =
-                    new GzipCompressorInputStream(is);
+        try (InputStream is = Files.newInputStream(input.toPath());
+                final GzipCompressorInputStream in = new GzipCompressorInputStream(is)) {
             IOUtils.toByteArray(in);
             assertEquals(-1, in.read(buf));
             assertEquals(-1, in.read(buf));
-            in.close();
         }
     }
 
     @Test
     public void singleByteReadConsistentlyReturnsMinusOneAtEof() throws IOException {
         final File input = getFile("bla.tgz");
-        try (InputStream is = Files.newInputStream(input.toPath())) {
-            final GzipCompressorInputStream in =
-                    new GzipCompressorInputStream(is);
+        try (InputStream is = Files.newInputStream(input.toPath());
+                final GzipCompressorInputStream in = new GzipCompressorInputStream(is)) {
             IOUtils.toByteArray(in);
             assertEquals(-1, in.read());
             assertEquals(-1, in.read());
-            in.close();
         }
     }
 
@@ -176,15 +172,15 @@ public final class GZipTestCase extends AbstractTestCase {
         parameters.setFilename("test3.xml");
         parameters.setComment("Test file");
         parameters.setModificationTime(System.currentTimeMillis());
-        final GzipCompressorOutputStream out = new GzipCompressorOutputStream(bout, parameters);
-        out.write(content);
-        out.flush();
-        out.close();
-
-        final GzipCompressorInputStream in = new GzipCompressorInputStream(new ByteArrayInputStream(bout.toByteArray()));
-        final byte[] content2 = IOUtils.toByteArray(in);
+        try (GzipCompressorOutputStream out = new GzipCompressorOutputStream(bout, parameters)) {
+            out.write(content);
+            out.flush();
+        }
 
-        assertArrayEquals(content, content2, "uncompressed content");
+        try (GzipCompressorInputStream in = new GzipCompressorInputStream(new ByteArrayInputStream(bout.toByteArray()))) {
+            final byte[] content2 = IOUtils.toByteArray(in);
+            assertArrayEquals(content, content2, "uncompressed content");
+        }
     }
 
     @Test
@@ -202,10 +198,10 @@ public final class GZipTestCase extends AbstractTestCase {
         parameters.setFilename("test3.xml");
         parameters.setComment("Test file");
         parameters.setModificationTime(System.currentTimeMillis());
-        final GzipCompressorOutputStream out = new GzipCompressorOutputStream(bout, parameters);
-        out.write(content);
-        out.flush();
-        out.close();
+        try (GzipCompressorOutputStream out = new GzipCompressorOutputStream(bout, parameters)) {
+            out.write(content);
+            out.flush();
+        }
 
         final GZIPInputStream in = new GZIPInputStream(new ByteArrayInputStream(bout.toByteArray()));
         final byte[] content2 = IOUtils.toByteArray(in);


[commons-compress] 03/04: Use try-with-resources

Posted by gg...@apache.org.
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

commit 2b00b7f8ee5476c5f9e42a58b20140394304c6a8
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 29 11:05:01 2023 -0400

    Use try-with-resources
---
 .../CompressorStreamFactoryRoundtripTest.java      | 23 +++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/src/test/java/org/apache/commons/compress/compressors/CompressorStreamFactoryRoundtripTest.java b/src/test/java/org/apache/commons/compress/compressors/CompressorStreamFactoryRoundtripTest.java
index c73c9e0b..8f1500d8 100644
--- a/src/test/java/org/apache/commons/compress/compressors/CompressorStreamFactoryRoundtripTest.java
+++ b/src/test/java/org/apache/commons/compress/compressors/CompressorStreamFactoryRoundtripTest.java
@@ -53,19 +53,20 @@ public class CompressorStreamFactoryRoundtripTest {
     public void testCompressorStreamFactoryRoundtrip(final String compressorName) throws Exception {
         final CompressorStreamProvider factory = new CompressorStreamFactory();
         final ByteArrayOutputStream compressedOs = new ByteArrayOutputStream();
-        final CompressorOutputStream compressorOutputStream = factory.createCompressorOutputStream(compressorName, compressedOs);
         final String fixture = "The quick brown fox jumps over the lazy dog";
-        compressorOutputStream.write(fixture.getBytes(UTF_8));
-        compressorOutputStream.flush();
-        compressorOutputStream.close();
+        try (CompressorOutputStream compressorOutputStream = factory.createCompressorOutputStream(compressorName, compressedOs)) {
+            compressorOutputStream.write(fixture.getBytes(UTF_8));
+            compressorOutputStream.flush();
+        }
         final ByteArrayInputStream is = new ByteArrayInputStream(compressedOs.toByteArray());
-        final CompressorInputStream compressorInputStream = factory.createCompressorInputStream(compressorName, is, false);
-        final ByteArrayOutputStream decompressedOs = new ByteArrayOutputStream();
-        IOUtils.copy(compressorInputStream, decompressedOs);
-        compressorInputStream.close();
-        decompressedOs.flush();
-        decompressedOs.close();
-        assertEquals(fixture, decompressedOs.toString("UTF-8"));
+        try (CompressorInputStream compressorInputStream = factory.createCompressorInputStream(compressorName, is, false)) {
+            final ByteArrayOutputStream decompressedOs = new ByteArrayOutputStream();
+            IOUtils.copy(compressorInputStream, decompressedOs);
+            compressorInputStream.close();
+            decompressedOs.flush();
+            decompressedOs.close();
+            assertEquals(fixture, decompressedOs.toString("UTF-8"));
+        }
     }
 
 }


[commons-compress] 02/04: Use try-with-resources

Posted by gg...@apache.org.
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

commit b5e93bb58d6112cd1e1ab56689e590509ed10c6e
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Tue Aug 29 11:00:07 2023 -0400

    Use try-with-resources
---
 .../compressors/DetectCompressorTestCase.java      | 73 ++++++++++++----------
 1 file changed, 41 insertions(+), 32 deletions(-)

diff --git a/src/test/java/org/apache/commons/compress/compressors/DetectCompressorTestCase.java b/src/test/java/org/apache/commons/compress/compressors/DetectCompressorTestCase.java
index 20310206..85c3f838 100644
--- a/src/test/java/org/apache/commons/compress/compressors/DetectCompressorTestCase.java
+++ b/src/test/java/org/apache/commons/compress/compressors/DetectCompressorTestCase.java
@@ -102,21 +102,23 @@ public final class DetectCompressorTestCase {
         }
     }
 
-    private CompressorInputStream getStreamFor(final String resource)
+    @SuppressWarnings("resource") // Caller closes.
+    private CompressorInputStream createStreamFor(final String resource)
             throws CompressorException, IOException {
         return factory.createCompressorInputStream(
                    new BufferedInputStream(Files.newInputStream(
                        getFile(resource).toPath())));
     }
 
-    private CompressorInputStream getStreamFor(final String resource, final CompressorStreamFactory factory)
+    @SuppressWarnings("resource") // Caller closes.
+    private CompressorInputStream createStreamFor(final String resource, final CompressorStreamFactory factory)
             throws CompressorException, IOException {
         return factory.createCompressorInputStream(
                    new BufferedInputStream(Files.newInputStream(
                        getFile(resource).toPath())));
     }
 
-    private InputStream getStreamFor(final String fileName, final int memoryLimitInKb) throws Exception {
+    private InputStream createStreamFor(final String fileName, final int memoryLimitInKb) throws Exception {
         final CompressorStreamFactory fac = new CompressorStreamFactory(true,
                 memoryLimitInKb);
         final InputStream is = new BufferedInputStream(
@@ -163,52 +165,59 @@ public final class DetectCompressorTestCase {
 
     @Test
     public void testDetection() throws Exception {
-        final CompressorInputStream bzip2 = getStreamFor("bla.txt.bz2");
-        assertNotNull(bzip2);
-        assertTrue(bzip2 instanceof BZip2CompressorInputStream);
+        try (CompressorInputStream bzip2 = createStreamFor("bla.txt.bz2")) {
+            assertNotNull(bzip2);
+            assertTrue(bzip2 instanceof BZip2CompressorInputStream);
+        }
 
-        final CompressorInputStream gzip = getStreamFor("bla.tgz");
-        assertNotNull(gzip);
-        assertTrue(gzip instanceof GzipCompressorInputStream);
+        try (CompressorInputStream gzip = createStreamFor("bla.tgz")) {
+            assertNotNull(gzip);
+            assertTrue(gzip instanceof GzipCompressorInputStream);
+        }
 
-        final CompressorInputStream pack200 = getStreamFor("bla.pack");
-        assertNotNull(pack200);
-        assertTrue(pack200 instanceof Pack200CompressorInputStream);
+        try (CompressorInputStream pack200 = createStreamFor("bla.pack")) {
+            assertNotNull(pack200);
+            assertTrue(pack200 instanceof Pack200CompressorInputStream);
+        }
 
-        final CompressorInputStream xz = getStreamFor("bla.tar.xz");
-        assertNotNull(xz);
-        assertTrue(xz instanceof XZCompressorInputStream);
+        try (CompressorInputStream xz = createStreamFor("bla.tar.xz")) {
+            assertNotNull(xz);
+            assertTrue(xz instanceof XZCompressorInputStream);
+        }
 
-        final CompressorInputStream zlib = getStreamFor("bla.tar.deflatez");
-        assertNotNull(zlib);
-        assertTrue(zlib instanceof DeflateCompressorInputStream);
+        try (CompressorInputStream zlib = createStreamFor("bla.tar.deflatez")) {
+            assertNotNull(zlib);
+            assertTrue(zlib instanceof DeflateCompressorInputStream);
+        }
 
-        final CompressorInputStream zstd = getStreamFor("bla.tar.zst");
-        assertNotNull(zstd);
-        assertTrue(zstd instanceof ZstdCompressorInputStream);
+        try (CompressorInputStream zstd = createStreamFor("bla.tar.zst")) {
+            assertNotNull(zstd);
+            assertTrue(zstd instanceof ZstdCompressorInputStream);
+        }
 
         assertThrows(CompressorException.class, () -> factory.createCompressorInputStream(new ByteArrayInputStream(ByteUtils.EMPTY_BYTE_ARRAY)));
     }
 
     @Test
     public void testLZMAMemoryLimit() throws Exception {
-        assertThrows(MemoryLimitException.class, () -> getStreamFor("COMPRESS-382", 100));
+        assertThrows(MemoryLimitException.class, () -> createStreamFor("COMPRESS-382", 100));
     }
 
     @Test
     public void testMultiples() throws Exception {
-        for(int i=0; i <tests.length; i++) {
+        for (int i = 0; i < tests.length; i++) {
             final TestData test = tests[i];
             final CompressorStreamFactory fac = test.factory;
             assertNotNull(fac, "Test entry " + i);
             assertEquals(test.concat, fac.getDecompressConcatenated(), "Test entry " + i);
-            final CompressorInputStream in = getStreamFor(test.fileName, fac);
-            assertNotNull(in, "Test entry " + i);
-            for (final char entry : test.entryNames) {
-                assertEquals(entry, in.read(), "Test entry" + i);
+            try (CompressorInputStream in = createStreamFor(test.fileName, fac)) {
+                assertNotNull(in, "Test entry " + i);
+                for (final char entry : test.entryNames) {
+                    assertEquals(entry, in.read(), "Test entry" + i);
+                }
+                assertEquals(0, in.available());
+                assertEquals(-1, in.read());
             }
-            assertEquals(0, in.available());
-            assertEquals(-1, in.read());
         }
     }
 
@@ -239,20 +248,20 @@ public final class DetectCompressorTestCase {
         //This is triggered on read(); not during initialization.
         //This test is here instead of the xz unit test to make sure
         //that the parameter is properly passed via the CompressorStreamFactory
-        try (InputStream compressorIs = getStreamFor("bla.tar.xz", 100)) {
+        try (InputStream compressorIs = createStreamFor("bla.tar.xz", 100)) {
             assertThrows(MemoryLimitException.class, () -> compressorIs.read());
         }
     }
 
     @Test
     public void testXZMemoryLimitOnSkip() throws Exception {
-        try (InputStream compressorIs = getStreamFor("bla.tar.xz", 100)) {
+        try (InputStream compressorIs = createStreamFor("bla.tar.xz", 100)) {
             assertThrows(MemoryLimitException.class, () -> compressorIs.skip(10));
         }
     }
 
     @Test
     public void testZMemoryLimit() throws Exception {
-        assertThrows(MemoryLimitException.class, () -> getStreamFor("COMPRESS-386", 100));
+        assertThrows(MemoryLimitException.class, () -> createStreamFor("COMPRESS-386", 100));
     }
 }