apache-rat-core/src/test/java/org/apache/rat/walker/DirectoryWalkerTest.java

/*
 * 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.rat.walker;

import static org.junit.jupiter.api.Assertions.assertEquals;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.io.filefilter.FalseFileFilter;
import org.apache.rat.api.Document;
import org.apache.rat.api.RatException;
import org.apache.rat.report.RatReport;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;

public class DirectoryWalkerTest {
    
    @TempDir
	private File toWalk;
    
    @Test
    public void walk() throws IOException, RatException {
        File regular = new File(toWalk, "regular");
        regular.mkdir();
        File regularFile = new File(regular, "test");
        try (FileWriter writer = new FileWriter(regularFile)) {
            writer.write("test");
            writer.flush();
        }

        File hidden = new File(toWalk, ".hidden");
        hidden.mkdir();
        File hiddenFile = new File(hidden, "test");

        try (FileWriter writer = new FileWriter(hiddenFile)) {
            writer.write("test");
            writer.flush();
        }

        DirectoryWalker walker = new DirectoryWalker(toWalk, NameBasedHiddenFileFilter.HIDDEN, null);
        List<String> scanned = new ArrayList<>();
        walker.run(new TestRatReport(scanned));

        assertEquals(1, scanned.size());

        walker = new DirectoryWalker(toWalk, FalseFileFilter.FALSE, null);
        scanned = new ArrayList<>();
        walker.run(new TestRatReport(scanned));

        assertEquals(2, scanned.size());
    }

    class TestRatReport implements RatReport {

        private List<String> scanned;

        public TestRatReport(List<String> scanned) {
            this.scanned = scanned;
        }

        @Override
        public void startReport() {
            // no-op
        }

        @Override
        public void report(Document document) throws RatException {
            scanned.add(document.getName());
        }

        @Override
        public void endReport() {
            // no-op
        }

    }

}