/*
    * 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.file;
  
  import static org.apache.commons.io.file.CounterAssertions.assertCounts;
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertNotEquals;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.io.IOException;
  import java.nio.charset.StandardCharsets;
  import java.nio.file.Files;
  import java.nio.file.Path;
  import java.nio.file.Paths;
  
  import org.apache.commons.io.file.Counters.PathCounters;
  import org.junit.jupiter.api.Assertions;
  import org.junit.jupiter.api.Test;
  import org.junit.jupiter.params.ParameterizedTest;
  import org.junit.jupiter.params.provider.MethodSource;
  
  /**
   * Tests {@link DeletingPathVisitor}.
   */
  public class DeletingPathVisitorTest extends AbstractTempDirTest {
  
      private static final String ARGS = "org.apache.commons.io.file.TestArguments#";
  
      private void applyDeleteEmptyDirectory(final DeletingPathVisitor visitor) throws IOException {
          Files.walkFileTree(tempDirPath, visitor);
          assertCounts(1, 0, 0, visitor);
      }
  
      /**
       * Tests an empty folder.
       */
      @ParameterizedTest
      @MethodSource(ARGS + "deletingPathVisitors")
      public void testDeleteEmptyDirectory(final DeletingPathVisitor visitor) throws IOException {
          applyDeleteEmptyDirectory(visitor);
          // This will throw if not empty.
          Files.deleteIfExists(tempDirPath);
      }
  
      /**
       * Tests an empty folder.
       */
      @ParameterizedTest
      @MethodSource(ARGS + "pathCounters")
      public void testDeleteEmptyDirectoryNullCtorArg(final PathCounters pathCounters) throws IOException {
          applyDeleteEmptyDirectory(new DeletingPathVisitor(pathCounters, (String[]) null));
          // This will throw if not empty.
          Files.deleteIfExists(tempDirPath);
      }
  
      /**
       * Tests a directory with one file of size 0.
       */
      @ParameterizedTest
      @MethodSource(ARGS + "deletingPathVisitors")
      public void testDeleteFolders1FileSize0(final DeletingPathVisitor visitor) throws IOException {
          PathUtils.copyDirectory(Paths.get("src/test/resources/org/apache/commons/io/dirs-1-file-size-0"), tempDirPath);
          assertCounts(1, 1, 0, PathUtils.visitFileTree(visitor, tempDirPath));
          // This will throw if not empty.
          Files.deleteIfExists(tempDirPath);
      }
  
      /**
       * Tests a directory with one file of size 1.
       */
      @ParameterizedTest
      @MethodSource(ARGS + "deletingPathVisitors")
      public void testDeleteFolders1FileSize1(final DeletingPathVisitor visitor) throws IOException {
          PathUtils.copyDirectory(Paths.get("src/test/resources/org/apache/commons/io/dirs-1-file-size-1"), tempDirPath);
          assertCounts(1, 1, 1, PathUtils.visitFileTree(visitor, tempDirPath));
          // This will throw if not empty.
          Files.deleteIfExists(tempDirPath);
      }
  
      /**
       * Tests a directory with one file of size 1 but skip that file.
       */
      @ParameterizedTest
     @MethodSource(ARGS + "pathCounters")
     public void testDeleteFolders1FileSize1Skip(final PathCounters pathCounters) throws IOException {
         PathUtils.copyDirectory(Paths.get("src/test/resources/org/apache/commons/io/dirs-1-file-size-1"), tempDirPath);
         final String skipFileName = "file-size-1.bin";
         final CountingPathVisitor visitor = new DeletingPathVisitor(pathCounters, skipFileName);
         assertCounts(1, 1, 1, PathUtils.visitFileTree(visitor, tempDirPath));
         final Path skippedFile = tempDirPath.resolve(skipFileName);
         Assertions.assertTrue(Files.exists(skippedFile));
         Files.delete(skippedFile);
     }
 
     /**
      * Tests a directory with two subdirectories, each containing one file of size 1.
      */
     @ParameterizedTest
     @MethodSource(ARGS + "deletingPathVisitors")
     public void testDeleteFolders2FileSize2(final DeletingPathVisitor visitor) throws IOException {
         PathUtils.copyDirectory(Paths.get("src/test/resources/org/apache/commons/io/dirs-2-file-size-2"), tempDirPath);
         assertCounts(3, 2, 2, PathUtils.visitFileTree(visitor, tempDirPath));
         // This will throw if not empty.
         Files.deleteIfExists(tempDirPath);
     }
 
     @Test
     public void testEqualsHashCode() {
         final DeletingPathVisitor visitor0 = DeletingPathVisitor.withLongCounters();
         final DeletingPathVisitor visitor1 = DeletingPathVisitor.withLongCounters();
         assertEquals(visitor0, visitor0);
         assertEquals(visitor0, visitor1);
         assertEquals(visitor1, visitor0);
         assertEquals(visitor0.hashCode(), visitor0.hashCode());
         assertEquals(visitor0.hashCode(), visitor1.hashCode());
         assertEquals(visitor1.hashCode(), visitor0.hashCode());
         visitor0.getPathCounters().getByteCounter().increment();
         assertEquals(visitor0, visitor0);
         assertNotEquals(visitor0, visitor1);
         assertNotEquals(visitor1, visitor0);
         assertEquals(visitor0.hashCode(), visitor0.hashCode());
         assertNotEquals(visitor0.hashCode(), visitor1.hashCode());
         assertNotEquals(visitor1.hashCode(), visitor0.hashCode());
     }
 
     /**
      * Tests https://issues.apache.org/jira/browse/IO-850
      */
     @Test
     public void testIO850DirectoriesAndFiles() throws IOException {
         final Path rootDir = Files.createDirectory(managedTempDirPath.resolve("IO850"));
         createTempSymlinkedRelativeDir(rootDir);
         final Path targetDir = rootDir.resolve(SUB_DIR);
         final Path symlinkDir = rootDir.resolve(SYMLINKED_DIR);
         Files.write(targetDir.resolve("file0.txt"), "Hello".getBytes(StandardCharsets.UTF_8));
         final Path subDir0 = Files.createDirectory(targetDir.resolve("subDir0"));
         Files.write(subDir0.resolve("file1.txt"), "Hello".getBytes(StandardCharsets.UTF_8));
         final DeletingPathVisitor visitor = DeletingPathVisitor.withLongCounters();
         Files.walkFileTree(rootDir, visitor);
         assertFalse(Files.exists(targetDir));
         assertFalse(Files.exists(symlinkDir));
         assertFalse(Files.exists(rootDir));
         assertTrue(visitor.getPathCounters().getDirectoryCounter().get() > 0);
         assertTrue(visitor.getPathCounters().getFileCounter().get() > 0);
     }
 
     /**
      * Tests https://issues.apache.org/jira/browse/IO-850
      */
     @Test
     public void testIO850DirectoriesOnly() throws IOException {
         final Path rootDir = Files.createDirectory(managedTempDirPath.resolve("IO850"));
         createTempSymlinkedRelativeDir(rootDir);
         final Path targetDir = rootDir.resolve(SUB_DIR);
         final Path symlinkDir = rootDir.resolve(SYMLINKED_DIR);
         final DeletingPathVisitor visitor = DeletingPathVisitor.withLongCounters();
         Files.walkFileTree(rootDir, visitor);
         assertFalse(Files.exists(targetDir));
         assertFalse(Files.exists(symlinkDir));
         assertFalse(Files.exists(rootDir));
         assertTrue(visitor.getPathCounters().getDirectoryCounter().get() > 0);
     }
 }