/*
    * 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.io.input;
  
  import static org.apache.commons.lang3.ArrayUtils.EMPTY_BYTE_ARRAY;
  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.IOException;
  import java.io.InputStream;
  import java.nio.file.Files;
  import java.nio.file.Path;
  import java.util.Arrays;
  
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.lang3.RandomUtils;
  import org.junit.jupiter.api.AfterEach;
  import org.junit.jupiter.api.Assertions;
  import org.junit.jupiter.api.Test;
  import org.junit.jupiter.api.io.TempDir;
  import org.junit.jupiter.params.ParameterizedTest;
  import org.junit.jupiter.params.provider.MethodSource;
  import org.junit.jupiter.params.provider.ValueSource;
  
  /**
   * Tests {@link MemoryMappedFileInputStream}.
   */
  class MemoryMappedFileInputStreamTest {
  
      @TempDir
      Path tempDir;
  
      @AfterEach
      public void afterEach() {
          // Ask to run the garbage collector to clean up memory mapped buffers,
          // otherwise the temporary files won't be able to be removed when running on
          // Windows. Calling gc() is just a hint to the VM.
          System.gc();
          Thread.yield();
          System.runFinalization();
          Thread.yield();
          System.gc();
          Thread.yield();
          System.runFinalization();
          Thread.yield();
      }
  
      private Path createTestFile(final int size) throws IOException {
          return Files.write(Files.createTempFile(tempDir, null, null), RandomUtils.insecure().randomBytes(size));
      }
  
      private MemoryMappedFileInputStream newInputStream(final Path file) throws IOException {
          return MemoryMappedFileInputStream.builder().setPath(file).get();
      }
  
      private MemoryMappedFileInputStream newInputStream(final Path file, final int bufferSize) throws IOException {
          return MemoryMappedFileInputStream.builder().setPath(file).setBufferSize(bufferSize).get();
      }
  
      @Test
      void testAlternateBufferSize() throws IOException {
          // setup
          final Path file = createTestFile(1024 * 1024);
          final byte[] expectedData = Files.readAllBytes(file);
          // test
          try (InputStream inputStream = newInputStream(file, 1024)) {
              // verify
              assertArrayEquals(expectedData, IOUtils.toByteArray(inputStream));
          }
      }
  
      @SuppressWarnings("resource")
      @ParameterizedTest
      @MethodSource(AbstractInputStreamTest.ARRAY_LENGTHS_NAME)
      void testAvailableAfterClose(final int len) throws Exception {
          final Path file = createTestFile(len);
          final InputStream shadow;
          try (InputStream inputStream = newInputStream(file, 1024)) {
              // verify
              assertEquals(0, inputStream.available());
              shadow = inputStream;
          }
          assertEquals(0, shadow.available());
      }
 
     @ParameterizedTest
     @MethodSource(AbstractInputStreamTest.ARRAY_LENGTHS_NAME)
     void testAvailableAfterOpen(final int len) throws Exception {
         final Path file = createTestFile(len);
         try (InputStream inputStream = newInputStream(file, 1024)) {
             // verify
             assertEquals(0, inputStream.available());
             inputStream.read();
             assertEquals(Math.max(len - 1, 0), inputStream.available());
             IOUtils.toByteArray(inputStream);
             assertEquals(0, inputStream.available());
         }
     }
 
     @Test
     void testEmptyFile() throws IOException {
         // setup
         final Path file = createTestFile(0);
         // test
         try (InputStream inputStream = newInputStream(file)) {
             // verify
             assertArrayEquals(EMPTY_BYTE_ARRAY, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testLargerFile() throws IOException {
         // setup
         final Path file = createTestFile(1024 * 1024);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = newInputStream(file)) {
             // verify
             assertArrayEquals(expectedData, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testReadAfterClose() throws IOException {
         // setup
         final Path file = createTestFile(1 * 1024 * 1024);
         // test
         try (InputStream inputStream = newInputStream(file, 1024)) {
             inputStream.close();
             // verify
             Assertions.assertThrows(IOException.class, () -> IOUtils.toByteArray(inputStream));
         }
     }
 
     @ParameterizedTest
     @MethodSource(AbstractInputStreamTest.ARRAY_LENGTHS_NAME)
     void testReadAfterClose(final int len) throws Exception {
         final Path file = createTestFile(len);
         try (InputStream inputStream = newInputStream(file, 1024)) {
             inputStream.close();
             assertThrows(IOException.class, inputStream::read);
         }
     }
 
     @Test
     void testReadSingleByte() throws IOException {
         // setup
         final Path file = createTestFile(2);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = newInputStream(file, 1024)) {
             final int b1 = inputStream.read();
             final int b2 = inputStream.read();
             assertEquals(-1, inputStream.read());
             // verify
             assertArrayEquals(expectedData, new byte[] {(byte) b1, (byte) b2});
         }
     }
 
     @Test
     void testSkipAtStart() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = newInputStream(file, 10)) {
             assertEquals(1, inputStream.skip(1));
             final byte[] data = IOUtils.toByteArray(inputStream);
             // verify
             assertArrayEquals(Arrays.copyOfRange(expectedData, 1, expectedData.length), data);
         }
     }
 
     @Test
     void testSkipEmpty() throws IOException {
         // setup
         final Path file = createTestFile(0);
         // test
         try (InputStream inputStream = newInputStream(file)) {
             assertEquals(0, inputStream.skip(5));
             // verify
             assertArrayEquals(EMPTY_BYTE_ARRAY, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testSkipInCurrentBuffer() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = newInputStream(file, 10)) {
             IOUtils.toByteArray(inputStream, 5);
             assertEquals(3, inputStream.skip(3));
             final byte[] data = IOUtils.toByteArray(inputStream);
             // verify
             assertArrayEquals(Arrays.copyOfRange(expectedData, 8, expectedData.length), data);
         }
     }
 
     @ParameterizedTest
     @ValueSource(ints = {-5, -1, 0})
     void testSkipNoop(final int amountToSkip) throws IOException {
         // setup
         final Path file = createTestFile(10);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = newInputStream(file)) {
             assertEquals(0, inputStream.skip(amountToSkip));
             // verify
             assertArrayEquals(expectedData, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testSkipOutOfCurrentBuffer() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = newInputStream(file, 10)) {
             IOUtils.toByteArray(inputStream, 5);
             assertEquals(6, inputStream.skip(6));
             final byte[] data = IOUtils.toByteArray(inputStream);
             // verify
             assertArrayEquals(Arrays.copyOfRange(expectedData, 11, expectedData.length), data);
         }
     }
 
     @Test
     void testSkipPastEof() throws IOException {
         // setup
         final Path file = createTestFile(100);
         // test
         try (InputStream inputStream = newInputStream(file, 10)) {
             IOUtils.toByteArray(inputStream, 5);
             assertEquals(95, inputStream.skip(96));
             // verify
             assertArrayEquals(EMPTY_BYTE_ARRAY, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testSkipToEndOfCurrentBuffer() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
 
         // test
         try (InputStream inputStream = newInputStream(file, 10)) {
             IOUtils.toByteArray(inputStream, 5);
             assertEquals(5, inputStream.skip(5));
             final byte[] data = IOUtils.toByteArray(inputStream);
             // verify
             assertArrayEquals(Arrays.copyOfRange(expectedData, 10, expectedData.length), data);
         }
     }
 
     @Test
     void testSkipToEndOfCurrentBufferBuilder() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (MemoryMappedFileInputStream inputStream = MemoryMappedFileInputStream.builder().setPath(file).setBufferSize(10).get()) {
             assertEquals(10, inputStream.getBufferSize());
             IOUtils.toByteArray(inputStream, 5);
             assertEquals(5, inputStream.skip(5));
             final byte[] data = IOUtils.toByteArray(inputStream);
             // verify
             assertArrayEquals(Arrays.copyOfRange(expectedData, 10, expectedData.length), data);
         }
     }
 
     @Test
     void testSmallFileBuilder() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = MemoryMappedFileInputStream.builder().setFile(file.toFile()).get()) {
             // verify
             assertArrayEquals(expectedData, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testSmallPath() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
 
         // test
         try (InputStream inputStream = newInputStream(file)) {
             // verify
             assertArrayEquals(expectedData, IOUtils.toByteArray(inputStream));
         }
     }
 
     @Test
     void testSmallPathBuilder() throws IOException {
         // setup
         final Path file = createTestFile(100);
         final byte[] expectedData = Files.readAllBytes(file);
         // test
         try (InputStream inputStream = MemoryMappedFileInputStream.builder().setPath(file).get()) {
             // verify
             assertArrayEquals(expectedData, IOUtils.toByteArray(inputStream));
         }
     }
 
 }