-
Notifications
You must be signed in to change notification settings - Fork 273
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[COMPRESS-692] Add support for zstd compression in zip archives
This is a simplified version of PR #634
- Loading branch information
1 parent
4e532d2
commit bf885f6
Showing
9 changed files
with
199 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
137 changes: 137 additions & 0 deletions
137
src/test/java/org/apache/commons/compress/archivers/zip/ZstdCompressorTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.commons.compress.archivers.zip; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertTrue; | ||
|
|
||
| import java.io.ByteArrayInputStream; | ||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.io.OutputStream; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
|
|
||
| import org.apache.commons.compress.AbstractTest; | ||
| import org.apache.commons.compress.compressors.zstandard.ZstdCompressorInputStream; | ||
| import org.apache.commons.compress.compressors.zstandard.ZstdCompressorOutputStream; | ||
| import org.apache.commons.compress.compressors.zstandard.ZstdUtils; | ||
| import org.apache.commons.io.IOUtils; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class ZstdCompressorTest extends AbstractTest { | ||
|
|
||
| /** | ||
| * Reads uncompressed data stream and writes it compressed to the output | ||
| * | ||
| * @param input the data stream with uncompressed data | ||
| * @param output the data stream for compressed output | ||
| * @throws IOException throws the exception which could be got from from IOUtils.copyLarge() or ZstdCompressorOutputStream constructor | ||
| */ | ||
| private static void compress(final InputStream input, final OutputStream output) throws IOException { | ||
| final ZstdCompressorOutputStream outputStream = new ZstdCompressorOutputStream(output, 3, true); | ||
| IOUtils.copyLarge(input, outputStream); | ||
| outputStream.flush(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testZstdDeprecatedMethod() throws IOException { | ||
| final String zipContentFile = "Name.txt"; | ||
| final byte[] simpleText = "This is a Simple Test File.".getBytes(); | ||
| final File file = Files.createTempFile("", ".zip").toFile(); | ||
| // Create the Zip File | ||
| try (ZipArchiveOutputStream zipOutputStream = new ZipArchiveOutputStream(file)) { | ||
| final ZipArchiveEntry archiveEntry = new ZipArchiveEntry(zipContentFile); | ||
| archiveEntry.setMethod(ZipMethod.ZSTD_DEPRECATED.getCode()); | ||
| archiveEntry.setSize(simpleText.length); | ||
| zipOutputStream.putArchiveEntry(archiveEntry); | ||
| ZstdCompressorTest.compress(new ByteArrayInputStream(simpleText), zipOutputStream); | ||
| zipOutputStream.closeArchiveEntry(); | ||
| } | ||
| // Read the Zip File | ||
| try (ZipFile zipFile = ZipFile.builder().setFile(file).get()) { | ||
| // Find the entry | ||
| final ZipArchiveEntry entry = zipFile.getEntry(zipContentFile); | ||
| // Check the Zstd compression method | ||
| assertEquals(entry.getMethod(), ZipMethod.ZSTD_DEPRECATED.getCode()); | ||
| final InputStream inputStream = zipFile.getInputStream(entry); | ||
| assertTrue("Input stream must be a ZstdInputStream", inputStream instanceof ZstdCompressorInputStream); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testZstdInputStream() throws IOException { | ||
| final Path file = getPath("COMPRESS-692/compress-962.zip"); | ||
| try (ZipFile zip = ZipFile.builder().setFile(file.toFile()).get()) { | ||
| final ZipArchiveEntry entry = zip.getEntries().nextElement(); | ||
| assertEquals("Unexpected first entry", "dolor.txt", entry.getName()); | ||
| assertTrue("entry can't be read", zip.canReadEntryData(entry)); | ||
| assertEquals("Unexpected method", ZipMethod.ZSTD.getCode(), entry.getMethod()); | ||
| try (InputStream inputStream = zip.getInputStream(entry)) { | ||
| final long uncompSize = entry.getSize(); | ||
| final byte[] buf = new byte[(int) uncompSize]; | ||
| inputStream.read(buf); | ||
| final String uncompData = new String(buf); | ||
| assertTrue(uncompData.startsWith("dolor sit amet")); | ||
| assertTrue(uncompData.endsWith("ex ea commodo")); | ||
| assertEquals(6066, uncompData.length()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testZstdMethodInZipFile() throws IOException { | ||
| final String zipContentFile = "Name.txt"; | ||
| final byte[] simpleText = "This is a Simple Test File.".getBytes(); | ||
| final File file = Files.createTempFile("", ".zip").toFile(); | ||
| // Create the Zip File | ||
| try (ZipArchiveOutputStream zipOutputStream = new ZipArchiveOutputStream(file)) { | ||
| final ZipArchiveEntry archiveEntry = new ZipArchiveEntry(zipContentFile); | ||
| archiveEntry.setMethod(ZipMethod.ZSTD.getCode()); | ||
| archiveEntry.setSize(simpleText.length); | ||
| zipOutputStream.putArchiveEntry(archiveEntry); | ||
| ZstdCompressorTest.compress(new ByteArrayInputStream(simpleText), zipOutputStream); | ||
| zipOutputStream.closeArchiveEntry(); | ||
| } | ||
| // Read the Zip File | ||
| try (ZipFile zipFile = ZipFile.builder().setFile(file).get()) { | ||
| // Find the entry | ||
| final ZipArchiveEntry entry = zipFile.getEntry(zipContentFile); | ||
| // Check the Zstd compression method | ||
| assertEquals(entry.getMethod(), ZipMethod.ZSTD.getCode()); | ||
| final InputStream inputStream = zipFile.getInputStream(entry); | ||
| assertTrue(inputStream instanceof ZstdCompressorInputStream); | ||
| final long dataOffset = entry.getDataOffset(); | ||
| final int uncompressedSize = (int) entry.getSize(); | ||
| assertEquals(simpleText.length, uncompressedSize); | ||
| final byte[] uncompressedData = new byte[uncompressedSize]; | ||
| inputStream.read(uncompressedData, 0, uncompressedSize); | ||
| // Check the uncompressed data | ||
| assertEquals(new String(simpleText), new String(uncompressedData)); | ||
| try (FileInputStream fileInputStream = new FileInputStream(file)) { | ||
| fileInputStream.skip(dataOffset); | ||
| final byte[] compressedData = new byte[4]; | ||
| fileInputStream.read(compressedData); | ||
| assertTrue("Compressed data must begin with the magic bytes of Zstd", ZstdUtils.matches(compressedData, 4)); | ||
| } | ||
| } | ||
| } | ||
| } |
Binary file not shown.