garydgregory commented on code in PR #548: URL: https://github.com/apache/commons-io/pull/548#discussion_r1442921573
########## src/test/java/org/apache/commons/io/input/ChecksumInputStreamTest.java: ########## @@ -0,0 +1,163 @@ +/* + * 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 + * + * http://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.io.input; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.zip.Adler32; +import java.util.zip.CRC32; + +import org.junit.jupiter.api.Test; + +/** + * Tests {@link ChecksumInputStream}. + */ +public class ChecksumInputStreamTest { + + @Test + public void testDefaultThresholdFailure() throws IOException { + final byte[] byteArray = new byte[3]; + final Adler32 adler32 = new Adler32(); + try (ChecksumInputStream checksum = ChecksumInputStream.builder() + // @formatter:off + .setByteArray(byteArray) + .setChecksum(adler32) + .setExpectedChecksumValue((byte) -68) + .get()) { + // @formatter:on + assertEquals(0, checksum.getByteCount()); + assertEquals(-1, checksum.getRemaining()); + // Ask to read one more byte than there is, we get the correct byte count. + assertEquals(byteArray.length, checksum.read(new byte[byteArray.length + 1])); + // Next read is at EOF + assertThrows(IOException.class, () -> checksum.read(new byte[1])); + assertEquals(byteArray.length, checksum.getByteCount()); + assertEquals(-4, checksum.getRemaining()); + } + } + + @Test + public void testDefaultThresholdSuccess() throws IOException { + // sanity-check + final Adler32 sanityCheck = new Adler32(); + final byte[] byteArray = new byte[3]; + sanityCheck.update(byteArray); + final long expectedChecksum = sanityCheck.getValue(); + // actual + final Adler32 adler32 = new Adler32(); + try (ChecksumInputStream checksum = ChecksumInputStream.builder() + // @formatter:off + .setByteArray(byteArray) + .setChecksum(adler32) + .setExpectedChecksumValue(expectedChecksum) + .get()) { + // @formatter:on + assertEquals(0, checksum.getByteCount()); + assertEquals(-1, checksum.getRemaining()); + assertEquals(3, checksum.read(byteArray)); + assertEquals(byteArray.length, checksum.getByteCount()); + assertEquals(-4, checksum.getRemaining()); + assertEquals(-1, checksum.read(byteArray)); + assertEquals(byteArray.length, checksum.getByteCount()); + assertEquals(-4, checksum.getRemaining()); + } + } + + @Test + public void testReadTakingByteArrayThrowsException() throws IOException { + final Adler32 adler32 = new Adler32(); + final byte[] byteArray = new byte[3]; + final long sizeThreshold = -1859L; + try (ChecksumInputStream checksum = ChecksumInputStream.builder() + // @formatter:off + .setByteArray(byteArray) + .setChecksum(adler32) + .setExpectedChecksumValue((byte) -68) + .setCountThreshold(sizeThreshold) + .get()) { + // @formatter:on + assertEquals(0, checksum.getByteCount()); + assertEquals(sizeThreshold, checksum.getRemaining()); + // Ask to read one more byte than there is. + assertEquals(byteArray.length, checksum.read(new byte[byteArray.length + 1])); + // Next read is at EOF + assertThrows(IOException.class, () -> checksum.read(new byte[1])); + assertEquals(byteArray.length, checksum.getByteCount()); + assertEquals(sizeThreshold - byteArray.length, checksum.getRemaining()); + } + } + + @Test + public void testReadTakingNoArgumentsThrowsException() throws IOException { + final CRC32 crc32 = new CRC32(); + final byte[] byteArray = new byte[9]; + try (ChecksumInputStream checksum = ChecksumInputStream.builder() + // @formatter:off + .setByteArray(byteArray) + .setChecksum(crc32) + .setExpectedChecksumValue((byte) 1) + .setCountThreshold(1) + .get()) { + // @formatter:on + assertEquals(0, checksum.getByteCount()); + assertEquals(1, checksum.getRemaining()); + assertThrows(IOException.class, () -> checksum.read()); + assertEquals(1, checksum.getByteCount()); + assertEquals(0, checksum.getRemaining()); + } + } + + @Test + public void testSkip() throws IOException { + // sanity-check + final CRC32 sanityCheck = new CRC32(); + final byte[] byteArray = new byte[4]; + sanityCheck.update(byteArray); + final long expectedChecksum = sanityCheck.getValue(); + // actual + final CRC32 crc32 = new CRC32(); + final InputStream byteArrayInputStream = new ByteArrayInputStream(byteArray); + try (ChecksumInputStream checksum = ChecksumInputStream.builder() + // @formatter:off + .setInputStream(byteArrayInputStream) + .setChecksum(crc32) + .setExpectedChecksumValue(expectedChecksum) + .setCountThreshold(33) + .get()) { + // @formatter:on + assertEquals(0, checksum.getByteCount()); + @SuppressWarnings("unused") Review Comment: I replaced the suppression with an an assertion. Some static analysis tools flag ignored read() values as a problem because it can indicate a lack of EOF detection. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
