1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.commons.io;
18
19 import static org.junit.jupiter.api.Assertions.assertEquals;
20 import static org.junit.jupiter.api.Assertions.assertFalse;
21 import static org.junit.jupiter.api.Assertions.assertThrows;
22 import static org.junit.jupiter.api.Assertions.assertTrue;
23 import static org.junit.jupiter.api.Assertions.fail;
24
25 import java.io.File;
26 import java.io.FileFilter;
27 import java.io.IOException;
28 import java.util.ArrayList;
29 import java.util.Collection;
30 import java.util.List;
31
32 import org.apache.commons.io.filefilter.FileFilterUtils;
33 import org.apache.commons.io.filefilter.IOFileFilter;
34 import org.apache.commons.io.filefilter.NameFileFilter;
35 import org.apache.commons.io.filefilter.OrFileFilter;
36 import org.junit.jupiter.api.Test;
37
38
39
40
41
42
43 @SuppressWarnings({"unchecked", "rawtypes"})
44 public class DirectoryWalkerTestCaseJava4 {
45
46
47
48
49
50 static class TestCancelWalker extends DirectoryWalker {
51 private final String cancelFileName;
52 private final boolean suppressCancel;
53
54 TestCancelWalker(final String cancelFileName, final boolean suppressCancel) {
55 this.cancelFileName = cancelFileName;
56 this.suppressCancel = suppressCancel;
57 }
58
59
60
61
62 protected List find(final File startDirectory) throws IOException {
63 final List results = new ArrayList();
64 walk(startDirectory, results);
65 return results;
66 }
67
68
69
70
71 @Override
72 protected void handleCancelled(final File startDirectory, final Collection results,
73 final CancelException cancel) throws IOException {
74 if (!suppressCancel) {
75 super.handleCancelled(startDirectory, results, cancel);
76 }
77 }
78
79
80
81
82 @Override
83 protected void handleDirectoryEnd(final File directory, final int depth, final Collection results) throws IOException {
84 results.add(directory);
85 if (cancelFileName.equals(directory.getName())) {
86 throw new CancelException(directory, depth);
87 }
88 }
89
90
91
92
93 @Override
94 protected void handleFile(final File file, final int depth, final Collection results) throws IOException {
95 results.add(file);
96 if (cancelFileName.equals(file.getName())) {
97 throw new CancelException(file, depth);
98 }
99 }
100 }
101
102
103
104
105 private static final class TestFalseFileFinder extends TestFileFinder {
106
107 protected TestFalseFileFinder(final FileFilter filter, final int depthLimit) {
108 super(filter, depthLimit);
109 }
110
111
112
113
114 @Override
115 protected boolean handleDirectory(final File directory, final int depth, final Collection results) {
116 return false;
117 }
118 }
119
120
121
122
123 private static class TestFileFinder extends DirectoryWalker {
124
125 protected TestFileFinder(final FileFilter filter, final int depthLimit) {
126 super(filter, depthLimit);
127 }
128
129 protected TestFileFinder(final IOFileFilter dirFilter, final IOFileFilter fileFilter, final int depthLimit) {
130 super(dirFilter, fileFilter, depthLimit);
131 }
132
133
134
135
136 protected List<File> find(final File startDirectory) {
137 final List<File> results = new ArrayList<>();
138 try {
139 walk(startDirectory, results);
140 } catch (final IOException ex) {
141 fail(ex.toString());
142 }
143 return results;
144 }
145
146
147
148
149 @Override
150 protected void handleDirectoryEnd(final File directory, final int depth, final Collection results) {
151 results.add(directory);
152 }
153
154
155
156
157 @Override
158 protected void handleFile(final File file, final int depth, final Collection results) {
159 results.add(file);
160 }
161 }
162
163
164
165
166 static class TestMultiThreadCancelWalker extends DirectoryWalker {
167 private final String cancelFileName;
168 private final boolean suppressCancel;
169 private boolean cancelled;
170 public List results;
171
172 TestMultiThreadCancelWalker(final String cancelFileName, final boolean suppressCancel) {
173 this.cancelFileName = cancelFileName;
174 this.suppressCancel = suppressCancel;
175 }
176
177
178
179
180 protected List find(final File startDirectory) throws IOException {
181 results = new ArrayList();
182 walk(startDirectory, results);
183 return results;
184 }
185
186
187
188
189 @Override
190 protected void handleCancelled(final File startDirectory, final Collection results,
191 final CancelException cancel) throws IOException {
192 if (!suppressCancel) {
193 super.handleCancelled(startDirectory, results, cancel);
194 }
195 }
196
197
198
199
200 @Override
201 protected void handleDirectoryEnd(final File directory, final int depth, final Collection results) throws IOException {
202 results.add(directory);
203 assertFalse(cancelled);
204 if (cancelFileName.equals(directory.getName())) {
205 cancelled = true;
206 }
207 }
208
209
210
211
212 @Override
213 protected void handleFile(final File file, final int depth, final Collection results) throws IOException {
214 results.add(file);
215 assertFalse(cancelled);
216 if (cancelFileName.equals(file.getName())) {
217 cancelled = true;
218 }
219 }
220
221
222
223
224 @Override
225 protected boolean handleIsCancelled(final File file, final int depth, final Collection results) throws IOException {
226 return cancelled;
227 }
228 }
229
230 private static final File current = FileUtils.current();
231 private static final File javaDir = new File("src/main/java");
232 private static final File orgDir = new File(javaDir, "org");
233 private static final File apacheDir = new File(orgDir, "apache");
234
235 private static final File commonsDir = new File(apacheDir, "commons");
236 private static final File ioDir = new File(commonsDir, "io");
237 private static final File outputDir = new File(ioDir, "output");
238 private static final File[] dirs = {orgDir, apacheDir, commonsDir, ioDir, outputDir};
239
240 private static final File fileNameUtils = new File(ioDir, "FilenameUtils.java");
241 private static final File ioUtils = new File(ioDir, "IOUtils.java");
242
243 private static final File proxyWriter = new File(outputDir, "ProxyWriter.java");
244 private static final File nullStream = new File(outputDir, "NullOutputStream.java");
245 private static final File[] ioFiles = {fileNameUtils, ioUtils};
246 private static final File[] outputFiles = {proxyWriter, nullStream};
247
248 private static final IOFileFilter dirsFilter = createNameFilter(dirs);
249
250 private static final IOFileFilter ioFilesFilter = createNameFilter(ioFiles);
251
252 private static final IOFileFilter outputFilesFilter = createNameFilter(outputFiles);
253
254 private static final IOFileFilter ioDirAndFilesFilter = new OrFileFilter(dirsFilter, ioFilesFilter);
255
256 private static final IOFileFilter dirsAndFilesFilter = new OrFileFilter(ioDirAndFilesFilter, outputFilesFilter);
257
258
259 private static final IOFileFilter NOT_SVN = FileFilterUtils.makeSVNAware(null);
260
261
262
263
264
265 private static IOFileFilter createNameFilter(final File[] files) {
266 final String[] names = new String[files.length];
267 for (int i = 0; i < files.length; i++) {
268 names[i] = files[i].getName();
269 }
270 return new NameFileFilter(names);
271 }
272
273
274
275
276 private void checkContainsFiles(final String prefix, final File[] files, final Collection results) {
277 for (int i = 0; i < files.length; i++) {
278 assertTrue(results.contains(files[i]), prefix + "[" + i + "] " + files[i]);
279 }
280 }
281
282
283
284
285 private List directoriesOnly(final Collection<File> results) {
286 final List list = new ArrayList(results.size());
287 for (final File file : results) {
288 if (file.isDirectory()) {
289 list.add(file);
290 }
291 }
292 return list;
293 }
294
295
296
297
298 private List filesOnly(final Collection<File> results) {
299 final List list = new ArrayList(results.size());
300 for (final File file : results) {
301 if (file.isFile()) {
302 list.add(file);
303 }
304 }
305 return list;
306 }
307
308
309
310
311
312 @Test
313 public void testCancel() throws IOException {
314 String cancelName = null;
315
316
317 try {
318 cancelName = "DirectoryWalker.java";
319 new TestCancelWalker(cancelName, false).find(javaDir);
320 fail("CancelException not thrown for '" + cancelName + "'");
321 } catch (final DirectoryWalker.CancelException cancel) {
322 assertEquals(cancelName, cancel.getFile().getName(), "File: " + cancelName);
323 assertEquals(5, cancel.getDepth(), "Depth: " + cancelName);
324 }
325
326
327 try {
328 cancelName = "commons";
329 new TestCancelWalker(cancelName, false).find(javaDir);
330 fail("CancelException not thrown for '" + cancelName + "'");
331 } catch (final DirectoryWalker.CancelException cancel) {
332 assertEquals(cancelName, cancel.getFile().getName(), "File: " + cancelName);
333 assertEquals(3, cancel.getDepth(), "Depth: " + cancelName);
334 }
335
336
337 final List results = new TestCancelWalker(cancelName, true).find(javaDir);
338 final File lastFile = (File) results.get(results.size() - 1);
339 assertEquals(cancelName, lastFile.getName(), "Suppress: " + cancelName);
340 }
341
342
343
344
345 @Test
346 public void testFilter() {
347 final List<File> results = new TestFileFinder(dirsAndFilesFilter, -1).find(javaDir);
348 assertEquals(1 + dirs.length + ioFiles.length + outputFiles.length, results.size(), "Result Size");
349 assertTrue(results.contains(javaDir), "Start Dir");
350 checkContainsFiles("Dir", dirs, results);
351 checkContainsFiles("IO File", ioFiles, results);
352 checkContainsFiles("Output File", outputFiles, results);
353 }
354
355
356
357
358 @Test
359 public void testFilterAndLimitA() {
360 final List<File> results = new TestFileFinder(NOT_SVN, 0).find(javaDir);
361 assertEquals(1, results.size(), "[A] Result Size");
362 assertTrue(results.contains(javaDir), "[A] Start Dir");
363 }
364
365
366
367
368 @Test
369 public void testFilterAndLimitB() {
370 final List<File> results = new TestFileFinder(NOT_SVN, 1).find(javaDir);
371 assertEquals(2, results.size(), "[B] Result Size");
372 assertTrue(results.contains(javaDir), "[B] Start Dir");
373 assertTrue(results.contains(orgDir), "[B] Org Dir");
374 }
375
376
377
378
379 @Test
380 public void testFilterAndLimitC() {
381 final List<File> results = new TestFileFinder(NOT_SVN, 3).find(javaDir);
382 assertEquals(4, results.size(), "[C] Result Size");
383 assertTrue(results.contains(javaDir), "[C] Start Dir");
384 assertTrue(results.contains(orgDir), "[C] Org Dir");
385 assertTrue(results.contains(apacheDir), "[C] Apache Dir");
386 assertTrue(results.contains(commonsDir), "[C] Commons Dir");
387 }
388
389
390
391
392 @Test
393 public void testFilterAndLimitD() {
394 final List<File> results = new TestFileFinder(dirsAndFilesFilter, 5).find(javaDir);
395 assertEquals(1 + dirs.length + ioFiles.length, results.size(), "[D] Result Size");
396 assertTrue(results.contains(javaDir), "[D] Start Dir");
397 checkContainsFiles("[D] Dir", dirs, results);
398 checkContainsFiles("[D] File", ioFiles, results);
399 }
400
401
402
403
404 @Test
405 public void testFilterDirAndFile1() {
406 final List<File> results = new TestFileFinder(dirsFilter, ioFilesFilter, -1).find(javaDir);
407 assertEquals(1 + dirs.length + ioFiles.length, results.size(), "[DirAndFile1] Result Size");
408 assertTrue(results.contains(javaDir), "[DirAndFile1] Start Dir");
409 checkContainsFiles("[DirAndFile1] Dir", dirs, results);
410 checkContainsFiles("[DirAndFile1] File", ioFiles, results);
411 }
412
413
414
415
416 @Test
417 public void testFilterDirAndFile2() {
418 final List<File> results = new TestFileFinder(null, null, -1).find(javaDir);
419 assertTrue(results.size() > 1 + dirs.length + ioFiles.length, "[DirAndFile2] Result Size");
420 assertTrue(results.contains(javaDir), "[DirAndFile2] Start Dir");
421 checkContainsFiles("[DirAndFile2] Dir", dirs, results);
422 checkContainsFiles("[DirAndFile2] File", ioFiles, results);
423 }
424
425
426
427
428 @Test
429 public void testFilterDirAndFile3() {
430 final List<File> results = new TestFileFinder(dirsFilter, null, -1).find(javaDir);
431 final List resultDirs = directoriesOnly(results);
432 assertEquals(1 + dirs.length, resultDirs.size(), "[DirAndFile3] Result Size");
433 assertTrue(results.contains(javaDir), "[DirAndFile3] Start Dir");
434 checkContainsFiles("[DirAndFile3] Dir", dirs, resultDirs);
435 }
436
437
438
439
440 @Test
441 public void testFilterDirAndFile4() {
442 final List<File> results = new TestFileFinder(null, ioFilesFilter, -1).find(javaDir);
443 final List resultFiles = filesOnly(results);
444 assertEquals(ioFiles.length, resultFiles.size(), "[DirAndFile4] Result Size");
445 assertTrue(results.contains(javaDir), "[DirAndFile4] Start Dir");
446 checkContainsFiles("[DirAndFile4] File", ioFiles, resultFiles);
447 }
448
449
450
451
452 @Test
453 public void testHandleStartDirectoryFalse() {
454
455 final List<File> results = new TestFalseFileFinder(null, -1).find(current);
456 assertEquals(0, results.size(), "Result Size");
457
458 }
459
460
461
462
463 @Test
464 public void testLimitToCurrent() {
465 final List<File> results = new TestFileFinder(null, 0).find(current);
466 assertEquals(1, results.size(), "Result Size");
467 assertTrue(results.contains(FileUtils.current()), "Current Dir");
468 }
469
470
471
472
473 @Test
474 public void testMissingStartDirectory() {
475
476
477 final File invalidDir = new File("invalid-dir");
478 final List<File> results = new TestFileFinder(null, -1).find(invalidDir);
479 assertEquals(1, results.size(), "Result Size");
480 assertTrue(results.contains(invalidDir), "Current Dir");
481
482 assertThrows(NullPointerException.class, () -> new TestFileFinder(null, -1).find(null));
483 }
484
485
486
487
488
489 @Test
490 public void testMultiThreadCancel() throws IOException {
491 String cancelName = "DirectoryWalker.java";
492 TestMultiThreadCancelWalker walker = new TestMultiThreadCancelWalker(cancelName, false);
493
494 try {
495 walker.find(javaDir);
496 fail("CancelException not thrown for '" + cancelName + "'");
497 } catch (final DirectoryWalker.CancelException cancel) {
498 final File last = (File) walker.results.get(walker.results.size() - 1);
499 assertEquals(cancelName, last.getName());
500 assertEquals(5, cancel.getDepth(), "Depth: " + cancelName);
501 }
502
503
504 try {
505 cancelName = "commons";
506 walker = new TestMultiThreadCancelWalker(cancelName, false);
507 walker.find(javaDir);
508 fail("CancelException not thrown for '" + cancelName + "'");
509 } catch (final DirectoryWalker.CancelException cancel) {
510 assertEquals(cancelName, cancel.getFile().getName(), "File: " + cancelName);
511 assertEquals(3, cancel.getDepth(), "Depth: " + cancelName);
512 }
513
514
515 walker = new TestMultiThreadCancelWalker(cancelName, true);
516 final List results = walker.find(javaDir);
517 final File lastFile = (File) results.get(results.size() - 1);
518 assertEquals(cancelName, lastFile.getName(), "Suppress: " + cancelName);
519
520 }
521
522 }