View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.io.filefilter;
18  
19  import static org.junit.jupiter.api.Assertions.assertEquals;
20  
21  import java.io.File;
22  import java.util.Objects;
23  import java.util.stream.Stream;
24  
25  public abstract class AbstractIOFileFilterTest {
26  
27      final class TesterFalseFileFilter extends FalseFileFilter {
28  
29          private static final long serialVersionUID = -3603047664010401872L;
30          private boolean invoked;
31  
32          @Override
33          public boolean accept(final File file) {
34              setInvoked(true);
35              return super.accept(file);
36          }
37  
38          @Override
39          public boolean accept(final File file, final String str) {
40              setInvoked(true);
41              return super.accept(file, str);
42          }
43  
44          public boolean isInvoked() {
45              return this.invoked;
46          }
47  
48          public void reset() {
49              setInvoked(false);
50          }
51  
52          public void setInvoked(final boolean invoked) {
53              this.invoked = invoked;
54          }
55      }
56  
57      final class TesterTrueFileFilter extends TrueFileFilter {
58  
59          private static final long serialVersionUID = 1828930358172422914L;
60          private boolean invoked;
61  
62          @Override
63          public boolean accept(final File file) {
64              setInvoked(true);
65              return super.accept(file);
66          }
67  
68          @Override
69          public boolean accept(final File file, final String str) {
70              setInvoked(true);
71              return super.accept(file, str);
72          }
73  
74          public boolean isInvoked() {
75              return this.invoked;
76          }
77  
78          public void reset() {
79              setInvoked(false);
80          }
81  
82          public void setInvoked(final boolean invoked) {
83              this.invoked = invoked;
84          }
85      }
86  
87      public static void assertFalseFiltersInvoked(final int testNumber, final TesterFalseFileFilter[] filters, final boolean[] invoked) {
88          for (int i = 1; i < filters.length; i++) {
89              assertEquals(invoked[i - 1], filters[i].isInvoked(), "test " + testNumber + " filter " + i + " invoked");
90          }
91      }
92  
93      public static void assertFileFiltering(final int testNumber, final IOFileFilter filter, final File file, final boolean expected) {
94          assertEquals(expected, filter.accept(file),
95                  "test " + testNumber + " Filter(File) " + filter.getClass().getName() + " not " + expected + " for " + file);
96          assertEquals(expected, filter.matches(file.toPath()),
97                  "test " + testNumber + " Filter(File) " + filter.getClass().getName() + " not " + expected + " for " + file);
98      }
99  
100     public static void assertFilenameFiltering(final int testNumber, final IOFileFilter filter, final File file, final boolean expected) {
101         // Assumes file has a parent and is not passed as null
102         assertEquals(expected, filter.accept(file.getParentFile(), file.getName()),
103                 "test " + testNumber + " Filter(File, String) " + filter.getClass().getName() + " not " + expected + " for " + file);
104     }
105 
106     public static void assertFiltering(final int testNumber, final IOFileFilter filter, final File file, final boolean expected) {
107         // Note. This only tests the (File, String) version if the parent of
108         //       the File passed in is not null
109         assertEquals(expected, filter.accept(file),
110             "test " + testNumber + " Filter(File) " + filter.getClass().getName() + " not " + expected + " for " + file);
111         assertEquals(expected, filter.accept(file.toPath(), null),
112                 "test " + testNumber + " Filter(File) " + filter.getClass().getName() + " not " + expected + " for " + file);
113 
114         if (file.getParentFile() != null) {
115             assertEquals(expected, filter.accept(file.getParentFile(), file.getName()),
116                     "test " + testNumber + " Filter(File, String) " + filter.getClass().getName() + " not " + expected + " for " + file);
117             assertEquals(expected, filter.matches(file.toPath()),
118                     "test " + testNumber + " Filter(File) " + filter.getClass().getName() + " not " + expected + " for " + file);
119         }
120     }
121 
122     public static void assertTrueFiltersInvoked(final int testNumber, final TesterTrueFileFilter[] filters, final boolean[] invoked) {
123         for (int i = 1; i < filters.length; i++) {
124             assertEquals(invoked[i - 1], filters[i].isInvoked(), "test " + testNumber + " filter " + i + " invoked");
125         }
126     }
127 
128     public static File determineWorkingDirectoryPath(final String key, final String defaultPath) {
129         // Look for a system property to specify the working directory
130         final String workingPathName = System.getProperty(key, defaultPath);
131         return new File(workingPathName);
132     }
133 
134     public static void resetFalseFilters(final TesterFalseFileFilter[] filters) {
135         Stream.of(filters).filter(Objects::nonNull).forEach(TesterFalseFileFilter::reset);
136     }
137 
138     public static void resetTrueFilters(final TesterTrueFileFilter[] filters) {
139         Stream.of(filters).filter(Objects::nonNull).forEach(TesterTrueFileFilter::reset);
140     }
141 }