This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Check validity of keys in hash passed as first argument.
[perl5.git] / ext / File-Find / t / find.t
1 #!./perl
2 use strict;
3 use Cwd;
4
5 my $warn_msg;
6
7 BEGIN {
8     require File::Spec;
9     if ($ENV{PERL_CORE}) {
10         # May be doing dynamic loading while @INC is all relative
11         @INC = map { $_ = File::Spec->rel2abs($_); /(.*)/; $1 } @INC;
12     }
13     $SIG{'__WARN__'} = sub { $warn_msg = $_[0]; warn "# $_[0]"; };
14
15     if ($^O eq 'MSWin32' || $^O eq 'cygwin' || $^O eq 'VMS') {
16         # This is a hack - at present File::Find does not produce native names
17         # on Win32 or VMS, so force File::Spec to use Unix names.
18         # must be set *before* importing File::Find
19         require File::Spec::Unix;
20         @File::Spec::ISA = 'File::Spec::Unix';
21     }
22     require File::Find;
23     import File::Find;
24 }
25
26 my $symlink_exists = eval { symlink("",""); 1 };
27 my $test_count = 109;
28 $test_count += 127 if $symlink_exists;
29 $test_count += 26 if $^O eq 'MSWin32';
30 $test_count += 2 if $^O eq 'MSWin32' and $symlink_exists;
31
32 use Test::More;
33 plan tests => $test_count;
34 use lib qw( ./t/lib );
35 use Testing qw(
36     create_file_ok
37     mkdir_ok
38     symlink_ok
39     dir_path
40     file_path
41 );
42
43 my %Expect_File = (); # what we expect for $_
44 my %Expect_Name = (); # what we expect for $File::Find::name/fullname
45 my %Expect_Dir  = (); # what we expect for $File::Find::dir
46 my (@files);
47
48 my $orig_dir = cwd();
49
50 # Uncomment this to see where File::Find is chdir-ing to.  Helpful for
51 # debugging its little jaunts around the filesystem.
52 # BEGIN {
53 #     use Cwd;
54 #     *CORE::GLOBAL::chdir = sub ($) {
55 #         my($file, $line) = (caller)[1,2];
56 #
57 #         printf "# cwd:      %s\n", cwd();
58 #         print "# chdir: @_ from $file at $line\n";
59 #         my($return) = CORE::chdir($_[0]);
60 #         printf "# newcwd:   %s\n", cwd();
61 #
62 #         return $return;
63 #     };
64 # }
65
66 cleanup();
67
68 ##### Sanity checks #####
69 # Do find() and finddepth() work correctly in the directory
70 # from which we start?  (Test presumes the presence of 'taint.t' in same
71 # directory as this test file.)
72
73 $::count_taint = 0;
74 find({wanted => sub { ++$::count_taint if $_ eq 'taint.t'; } },
75    File::Spec->curdir);
76 is($::count_taint, 1, "'find' found exactly 1 file named 'taint.t'");
77
78 $::count_taint = 0;
79 finddepth({wanted => sub { ++$::count_taint if $_ eq 'taint.t'; } },
80     File::Spec->curdir);
81 is($::count_taint, 1, "'finddepth' found exactly 1 file named 'taint.t'");
82
83 ##### RT #122547 #####
84 # Do find() and finddepth() correctly warn on invalid options?
85 {
86     my $bad_option = 'foobar';
87     my $second_bad_option = 'really_foobar';
88
89     $::count_taint = 0;
90     local $SIG{__WARN__} = sub { $warn_msg = $_[0]; };
91     {
92         find(
93             {
94                 wanted => sub { ++$::count_taint if $_ eq 'taint.t'; },
95                 $bad_option => undef,
96             },
97             File::Spec->curdir
98         );
99     };
100     like($warn_msg, qr/Invalid option/s, "Got warning for invalid option");
101     like($warn_msg, qr/$bad_option/s, "Got warning for $bad_option");
102     is($::count_taint, 1, "count_taint incremented");
103     undef $warn_msg;
104
105     $::count_taint = 0;
106     {
107         finddepth(
108             {
109                 wanted => sub { ++$::count_taint if $_ eq 'taint.t'; },
110                 $bad_option => undef,
111                 $second_bad_option => undef,
112             },
113             File::Spec->curdir
114         );
115     };
116     like($warn_msg, qr/Invalid option/s, "Got warning for invalid option");
117     like($warn_msg, qr/$bad_option/s, "Got warning for $bad_option");
118     like($warn_msg, qr/$second_bad_option/s, "Got warning for $second_bad_option");
119     is($::count_taint, 1, "count_taint incremented");
120     undef $warn_msg;
121 }
122
123 my $FastFileTests_OK = 0;
124
125 sub cleanup {
126     chdir($orig_dir);
127     my $need_updir = 0;
128     if (-d dir_path('for_find')) {
129         $need_updir = 1 if chdir(dir_path('for_find'));
130     }
131     if (-d dir_path('fa')) {
132     unlink file_path('fa', 'fa_ord'),
133            file_path('fa', 'fsl'),
134            file_path('fa', 'faa', 'faa_ord'),
135            file_path('fa', 'fab', 'fab_ord'),
136            file_path('fa', 'fab', 'faba', 'faba_ord'),
137            file_path('fa', 'fac', 'faca'),
138            file_path('fb', 'fb_ord'),
139            file_path('fb', 'fba', 'fba_ord'),
140            file_path('fb', 'fbc', 'fbca'),
141            file_path('fa', 'fax', 'faz'),
142            file_path('fa', 'fay');
143     rmdir dir_path('fa', 'faa');
144     rmdir dir_path('fa', 'fab', 'faba');
145     rmdir dir_path('fa', 'fab');
146     rmdir dir_path('fa', 'fac');
147     rmdir dir_path('fa', 'fax');
148     rmdir dir_path('fa');
149     rmdir dir_path('fb', 'fba');
150     rmdir dir_path('fb', 'fbc');
151     rmdir dir_path('fb');
152     }
153     if (-d dir_path('fc')) {
154         unlink (
155             file_path('fc', 'fca', 'match_alpha'),
156             file_path('fc', 'fca', 'match_beta'),
157             file_path('fc', 'fcb', 'match_gamma'),
158             file_path('fc', 'fcb', 'delta'),
159             file_path('fc', 'fcc', 'match_epsilon'),
160             file_path('fc', 'fcc', 'match_zeta'),
161             file_path('fc', 'fcc', 'eta'),
162         );
163         rmdir dir_path('fc', 'fca');
164         rmdir dir_path('fc', 'fcb');
165         rmdir dir_path('fc', 'fcc');
166         rmdir dir_path('fc');
167     }
168     if ($need_updir) {
169         my $updir = $^O eq 'VMS' ? File::Spec::VMS->updir() : File::Spec->updir;
170         chdir($updir);
171     }
172     if (-d dir_path('for_find')) {
173         rmdir dir_path('for_find') or print "# Can't rmdir for_find: $!\n";
174     }
175 }
176
177 END {
178     cleanup();
179 }
180
181 sub wanted_File_Dir {
182     print "# \$File::Find::dir => '$File::Find::dir'\t\$_ => '$_'\n";
183     s#\.$## if ($^O eq 'VMS' && $_ ne '.'); #
184     s/(.dir)?$//i if ($^O eq 'VMS' && -d _);
185     ok( $Expect_File{$_}, "found $_ for \$_, as expected" );
186     if ( $FastFileTests_OK ) {
187         delete $Expect_File{$_}
188           unless ( $Expect_Dir{$_} && ! -d _ );
189     }
190     else {
191         delete $Expect_File{$_}
192           unless ( $Expect_Dir{$_} && ! -d $_ );
193     }
194 }
195
196 sub wanted_File_Dir_prune {
197     &wanted_File_Dir;
198     $File::Find::prune = 1 if  $_ eq 'faba';
199 }
200
201 sub wanted_Name {
202     my $n = $File::Find::name;
203     $n =~ s#\.$## if ($^O eq 'VMS' && $n ne '.'); #
204     print "# \$File::Find::name => '$n'\n";
205     my $i = rindex($n,'/');
206     my $OK = exists($Expect_Name{$n});
207     if ( $OK ) {
208         $OK= exists($Expect_Name{substr($n,0,$i)})  if $i >= 0;
209     }
210     ok( $OK, "found $n for \$File::Find::name, as expected" );
211     delete $Expect_Name{$n};
212 }
213
214 sub wanted_File {
215     print "# \$_ => '$_'\n";
216     s#\.$## if ($^O eq 'VMS' && $_ ne '.'); #
217     my $i = rindex($_,'/');
218     my $OK = exists($Expect_File{ $_});
219     if ( $OK ) {
220         $OK= exists($Expect_File{ substr($_,0,$i)})  if $i >= 0;
221     }
222     ok( $OK, "found $_ for \$_, as expected" );
223     delete $Expect_File{ $_};
224 }
225
226 sub simple_wanted {
227     print "# \$File::Find::dir => '$File::Find::dir'\n";
228     print "# \$_ => '$_'\n";
229 }
230
231 sub noop_wanted {}
232
233 sub my_preprocess {
234     @files = @_;
235     print "# --preprocess--\n";
236     print "#   \$File::Find::dir => '$File::Find::dir' \n";
237     foreach my $file (@files) {
238         $file =~ s/\.(dir)?$//i if $^O eq 'VMS';
239         print "#   $file \n";
240         delete $Expect_Dir{ $File::Find::dir }->{$file};
241     }
242     print "# --end preprocess--\n";
243     is(scalar(keys %{$Expect_Dir{ $File::Find::dir }}), 0,
244         "my_preprocess: got 0, as expected");
245     if (scalar(keys %{$Expect_Dir{ $File::Find::dir }}) == 0) {
246         delete $Expect_Dir{ $File::Find::dir }
247     }
248     return @files;
249 }
250
251 sub my_postprocess {
252     print "# postprocess: \$File::Find::dir => '$File::Find::dir' \n";
253     delete $Expect_Dir{ $File::Find::dir};
254 }
255
256 # Use topdir() to specify a directory path that you want to pass to
257 # find/finddepth. Historically topdir() differed on Mac OS classic.
258
259 *topdir = \&dir_path;
260
261 # Use file_path_name() to specify a file path that is expected for
262 # $File::Find::Name (%Expect_Name). Note: When the no_chdir => 1
263 # option is in effect, $_ is the same as $File::Find::Name. In that
264 # case, also use this function to specify a file path that is expected
265 # for $_.
266 #
267 # Historically file_path_name differed on Mac OS classic.
268
269 *file_path_name = \&file_path;
270
271 ##### Create directories, files and symlinks used in testing #####
272
273 mkdir_ok( dir_path('for_find'), 0770 );
274 ok( chdir( dir_path('for_find')), "Able to chdir to 'for_find'")
275     or die("Unable to chdir to 'for_find'");
276 mkdir_ok( dir_path('fa'), 0770 );
277 mkdir_ok( dir_path('fb'), 0770  );
278 create_file_ok( file_path('fb', 'fb_ord') );
279 mkdir_ok( dir_path('fb', 'fba'), 0770  );
280 create_file_ok( file_path('fb', 'fba', 'fba_ord') );
281 if ($symlink_exists) {
282     symlink_ok('../fb','fa/fsl');
283 }
284 create_file_ok( file_path('fa', 'fa_ord') );
285
286 mkdir_ok( dir_path('fa', 'faa'), 0770  );
287 create_file_ok( file_path('fa', 'faa', 'faa_ord') );
288 mkdir_ok( dir_path('fa', 'fab'), 0770  );
289 create_file_ok( file_path('fa', 'fab', 'fab_ord') );
290 mkdir_ok( dir_path('fa', 'fab', 'faba'), 0770  );
291 create_file_ok( file_path('fa', 'fab', 'faba', 'faba_ord') );
292
293 ##### Basic tests for find() #####
294 # Set up list of files we expect to find.
295 # Run find(), removing a file from the list once we have found it.
296 # The list should be empty once we are done.
297
298 %Expect_File = (File::Spec->curdir => 1, file_path('fsl') => 1,
299                 file_path('fa_ord') => 1, file_path('fab') => 1,
300                 file_path('fab_ord') => 1, file_path('faba') => 1,
301                 file_path('faa') => 1, file_path('faa_ord') => 1);
302
303 delete $Expect_File{ file_path('fsl') } unless $symlink_exists;
304 %Expect_Name = ();
305
306 %Expect_Dir = ( dir_path('fa') => 1, dir_path('faa') => 1,
307                 dir_path('fab') => 1, dir_path('faba') => 1,
308                 dir_path('fb') => 1, dir_path('fba') => 1);
309
310 delete @Expect_Dir{ dir_path('fb'), dir_path('fba') } unless $symlink_exists;
311 File::Find::find( {wanted => \&wanted_File_Dir_prune}, topdir('fa') );
312 is( scalar(keys %Expect_File), 0, "COMPLETE: Basic test of find()" );
313
314 ##### Re-entrancy #####
315
316 print "# check re-entrancy\n";
317
318 %Expect_File = (File::Spec->curdir => 1, file_path('fsl') => 1,
319                 file_path('fa_ord') => 1, file_path('fab') => 1,
320                 file_path('fab_ord') => 1, file_path('faba') => 1,
321                 file_path('faa') => 1, file_path('faa_ord') => 1);
322
323 delete $Expect_File{ file_path('fsl') } unless $symlink_exists;
324 %Expect_Name = ();
325
326 %Expect_Dir = ( dir_path('fa') => 1, dir_path('faa') => 1,
327                 dir_path('fab') => 1, dir_path('faba') => 1,
328                 dir_path('fb') => 1, dir_path('fba') => 1);
329
330 delete @Expect_Dir{ dir_path('fb'), dir_path('fba') } unless $symlink_exists;
331
332 File::Find::find( {wanted => sub { wanted_File_Dir_prune();
333                                     File::Find::find( {wanted => sub
334                                     {} }, File::Spec->curdir ); } },
335                                     topdir('fa') );
336
337 is( scalar(keys %Expect_File), 0, "COMPLETE: Test of find() for re-entrancy" );
338
339 ##### 'no_chdir' option #####
340 # no_chdir is in effect, hence we use file_path_name to specify the expected paths for %Expect_File
341
342 %Expect_File = (file_path_name('fa') => 1,
343         file_path_name('fa', 'fsl') => 1,
344         file_path_name('fa', 'fa_ord') => 1,
345         file_path_name('fa', 'fab') => 1,
346         file_path_name('fa', 'fab', 'fab_ord') => 1,
347         file_path_name('fa', 'fab', 'faba') => 1,
348         file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
349         file_path_name('fa', 'faa') => 1,
350         file_path_name('fa', 'faa', 'faa_ord') => 1,);
351
352 delete $Expect_File{ file_path_name('fa', 'fsl') } unless $symlink_exists;
353 %Expect_Name = ();
354
355 %Expect_Dir = (dir_path('fa') => 1,
356         dir_path('fa', 'faa') => 1,
357         dir_path('fa', 'fab') => 1,
358         dir_path('fa', 'fab', 'faba') => 1,
359         dir_path('fb') => 1,
360         dir_path('fb', 'fba') => 1);
361
362 delete @Expect_Dir{ dir_path('fb'), dir_path('fb', 'fba') }
363     unless $symlink_exists;
364
365 File::Find::find( {wanted => \&wanted_File_Dir, no_chdir => 1},
366           topdir('fa') );
367 is( scalar(keys %Expect_File), 0, "COMPLETE: Test of 'no_chdir' option" );
368
369 ##### Test for $File::Find::name #####
370
371 %Expect_File = ();
372
373 %Expect_Name = (File::Spec->curdir => 1,
374         file_path_name('.', 'fa') => 1,
375         file_path_name('.', 'fa', 'fsl') => 1,
376         file_path_name('.', 'fa', 'fa_ord') => 1,
377         file_path_name('.', 'fa', 'fab') => 1,
378         file_path_name('.', 'fa', 'fab', 'fab_ord') => 1,
379         file_path_name('.', 'fa', 'fab', 'faba') => 1,
380         file_path_name('.', 'fa', 'fab', 'faba', 'faba_ord') => 1,
381         file_path_name('.', 'fa', 'faa') => 1,
382         file_path_name('.', 'fa', 'faa', 'faa_ord') => 1,
383         file_path_name('.', 'fb') => 1,
384         file_path_name('.', 'fb', 'fba') => 1,
385         file_path_name('.', 'fb', 'fba', 'fba_ord') => 1,
386         file_path_name('.', 'fb', 'fb_ord') => 1);
387
388 delete $Expect_Name{ file_path('.', 'fa', 'fsl') } unless $symlink_exists;
389 %Expect_Dir = ();
390 File::Find::finddepth( {wanted => \&wanted_Name}, File::Spec->curdir );
391 is( scalar(keys %Expect_Name), 0, "COMPLETE: Test for \$File::Find::name" );
392
393
394 ##### #####
395 # no_chdir is in effect, hence we use file_path_name to specify the
396 # expected paths for %Expect_File
397
398 %Expect_File = (File::Spec->curdir => 1,
399         file_path_name('.', 'fa') => 1,
400         file_path_name('.', 'fa', 'fsl') => 1,
401         file_path_name('.', 'fa', 'fa_ord') => 1,
402         file_path_name('.', 'fa', 'fab') => 1,
403         file_path_name('.', 'fa', 'fab', 'fab_ord') => 1,
404         file_path_name('.', 'fa', 'fab', 'faba') => 1,
405         file_path_name('.', 'fa', 'fab', 'faba', 'faba_ord') => 1,
406         file_path_name('.', 'fa', 'faa') => 1,
407         file_path_name('.', 'fa', 'faa', 'faa_ord') => 1,
408         file_path_name('.', 'fb') => 1,
409         file_path_name('.', 'fb', 'fba') => 1,
410         file_path_name('.', 'fb', 'fba', 'fba_ord') => 1,
411         file_path_name('.', 'fb', 'fb_ord') => 1);
412
413 delete $Expect_File{ file_path_name('.', 'fa', 'fsl') } unless $symlink_exists;
414 %Expect_Name = ();
415 %Expect_Dir = ();
416
417 File::Find::finddepth( {wanted => \&wanted_File, no_chdir => 1},
418              File::Spec->curdir );
419
420 is( scalar(keys %Expect_File), 0,
421     "COMPLETE: Equivalency of \$_ and \$File::Find::Name with 'no_chdir'" );
422
423 ##### #####
424
425 print "# check preprocess\n";
426 %Expect_File = ();
427 %Expect_Name = ();
428 %Expect_Dir = (
429          File::Spec->curdir                 => {fa => 1, fb => 1},
430          dir_path('.', 'fa')                => {faa => 1, fab => 1, fa_ord => 1},
431          dir_path('.', 'fa', 'faa')         => {faa_ord => 1},
432          dir_path('.', 'fa', 'fab')         => {faba => 1, fab_ord => 1},
433          dir_path('.', 'fa', 'fab', 'faba') => {faba_ord => 1},
434          dir_path('.', 'fb')                => {fba => 1, fb_ord => 1},
435          dir_path('.', 'fb', 'fba')         => {fba_ord => 1}
436          );
437
438 File::Find::find( {wanted => \&noop_wanted,
439          preprocess => \&my_preprocess}, File::Spec->curdir );
440
441 is( scalar(keys %Expect_Dir), 0, "Got no files, as expected" );
442
443 ##### #####
444
445 print "# check postprocess\n";
446 %Expect_File = ();
447 %Expect_Name = ();
448 %Expect_Dir = (
449          File::Spec->curdir                 => 1,
450          dir_path('.', 'fa')                => 1,
451          dir_path('.', 'fa', 'faa')         => 1,
452          dir_path('.', 'fa', 'fab')         => 1,
453          dir_path('.', 'fa', 'fab', 'faba') => 1,
454          dir_path('.', 'fb')                => 1,
455          dir_path('.', 'fb', 'fba')         => 1
456          );
457
458 File::Find::find( {wanted => \&noop_wanted,
459          postprocess => \&my_postprocess}, File::Spec->curdir );
460
461 is( scalar(keys %Expect_Dir), 0, "Got no files, as expected" );
462
463 ##### #####
464 {
465     print "# checking argument localization\n";
466
467     ### this checks the fix of perlbug [19977] ###
468     my @foo = qw( a b c d e f );
469     my %pre = map { $_ => } @foo;
470
471     File::Find::find( sub {  } , 'fa' ) for @foo;
472     delete $pre{$_} for @foo;
473
474     is( scalar(keys %pre), 0, "Got no files, as expected" );
475 }
476
477 ##### #####
478 # see thread starting
479 # http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2004-02/msg00351.html
480 {
481     print "# checking that &_ and %_ are still accessible and that\n",
482     "# tie magic on \$_ is not triggered\n";
483
484     my $true_count;
485     my $sub = 0;
486     sub _ {
487         ++$sub;
488     }
489     my $tie_called = 0;
490
491     package Foo;
492     sub STORE {
493         ++$tie_called;
494     }
495     sub FETCH {return 'N'};
496     sub TIESCALAR {bless []};
497     package main;
498
499     is( scalar(keys %_), 0, "Got no files, as expected" );
500     my @foo = 'n';
501     tie $foo[0], "Foo";
502
503     File::Find::find( sub { $true_count++; $_{$_}++; &_; } , 'fa' ) for @foo;
504     untie $_;
505
506     is( $tie_called, 0, "Got no files tie_called, as expected" );
507     is( scalar(keys %_), $true_count, "Got true count, as expected" );
508     is( $sub, $true_count, "Got true count, as expected" );
509     is( scalar( @foo), 1, "Got one file, as expected" );
510     is( $foo[0], 'N', "Got 'N', as expected" );
511 }
512
513 ##### #####
514 if ( $symlink_exists ) {
515     print "# --- symbolic link tests --- \n";
516     $FastFileTests_OK= 1;
517
518     # 'follow', 'follow_fast' and 'follow_skip' options only apply when a
519     # platform supports symlinks.
520
521     ##### #####
522
523     # Verify that File::Find::find will call wanted even if the topdir
524     # is a symlink to a directory, and it should not follow the link
525     # unless follow is set, which it is not in this case
526     %Expect_File = ( file_path('fsl') => 1 );
527     %Expect_Name = ();
528     %Expect_Dir = ();
529     File::Find::find( {wanted => \&wanted_File_Dir}, topdir('fa', 'fsl') );
530     is( scalar(keys %Expect_File), 0,
531         "COMPLETE: top dir can be symlink to dir; link not followed without 'follow' option" );
532
533     ##### #####
534
535     %Expect_File = (File::Spec->curdir => 1, file_path('fa_ord') => 1,
536                     file_path('fsl') => 1, file_path('fb_ord') => 1,
537                     file_path('fba') => 1, file_path('fba_ord') => 1,
538                     file_path('fab') => 1, file_path('fab_ord') => 1,
539                     file_path('faba') => 1, file_path('faa') => 1,
540                     file_path('faa_ord') => 1);
541
542     %Expect_Name = ();
543
544     %Expect_Dir = (File::Spec->curdir => 1, dir_path('fa') => 1,
545                    dir_path('faa') => 1, dir_path('fab') => 1,
546                    dir_path('faba') => 1, dir_path('fb') => 1,
547                    dir_path('fba') => 1);
548
549     File::Find::find( {wanted => \&wanted_File_Dir_prune,
550                follow_fast => 1}, topdir('fa') );
551
552     is( scalar(keys %Expect_File), 0,
553         "COMPLETE: test of 'follow_fast' option: \$_ case" );
554
555     ##### #####
556
557     # no_chdir is in effect, hence we use file_path_name to specify
558     # the expected paths for %Expect_File
559
560     %Expect_File = (file_path_name('fa') => 1,
561             file_path_name('fa', 'fa_ord') => 1,
562             file_path_name('fa', 'fsl') => 1,
563             file_path_name('fa', 'fsl', 'fb_ord') => 1,
564             file_path_name('fa', 'fsl', 'fba') => 1,
565             file_path_name('fa', 'fsl', 'fba', 'fba_ord') => 1,
566             file_path_name('fa', 'fab') => 1,
567             file_path_name('fa', 'fab', 'fab_ord') => 1,
568             file_path_name('fa', 'fab', 'faba') => 1,
569             file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
570             file_path_name('fa', 'faa') => 1,
571             file_path_name('fa', 'faa', 'faa_ord') => 1);
572
573     %Expect_Name = ();
574
575     %Expect_Dir = (dir_path('fa') => 1,
576             dir_path('fa', 'faa') => 1,
577             dir_path('fa', 'fab') => 1,
578             dir_path('fa', 'fab', 'faba') => 1,
579             dir_path('fb') => 1,
580             dir_path('fb', 'fba') => 1);
581
582     File::Find::find( {wanted => \&wanted_File_Dir, follow_fast => 1,
583                no_chdir => 1}, topdir('fa') );
584
585     is( scalar(keys %Expect_File), 0,
586         "COMPLETE: Test of 'follow_fast' and 'no_chdir' options together: \$_ case" );
587
588     ##### #####
589
590     %Expect_File = ();
591
592     %Expect_Name = (file_path_name('fa') => 1,
593             file_path_name('fa', 'fa_ord') => 1,
594             file_path_name('fa', 'fsl') => 1,
595             file_path_name('fa', 'fsl', 'fb_ord') => 1,
596             file_path_name('fa', 'fsl', 'fba') => 1,
597             file_path_name('fa', 'fsl', 'fba', 'fba_ord') => 1,
598             file_path_name('fa', 'fab') => 1,
599             file_path_name('fa', 'fab', 'fab_ord') => 1,
600             file_path_name('fa', 'fab', 'faba') => 1,
601             file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
602             file_path_name('fa', 'faa') => 1,
603             file_path_name('fa', 'faa', 'faa_ord') => 1);
604
605     %Expect_Dir = ();
606
607     File::Find::finddepth( {wanted => \&wanted_Name,
608             follow_fast => 1}, topdir('fa') );
609
610     is( scalar(keys %Expect_Name), 0,
611         "COMPLETE: test of 'follow_fast' option: \$File::Find::name case" );
612
613     ##### #####
614
615     # no_chdir is in effect, hence we use file_path_name to specify
616     # the expected paths for %Expect_File
617
618     %Expect_File = (file_path_name('fa') => 1,
619             file_path_name('fa', 'fa_ord') => 1,
620             file_path_name('fa', 'fsl') => 1,
621             file_path_name('fa', 'fsl', 'fb_ord') => 1,
622             file_path_name('fa', 'fsl', 'fba') => 1,
623             file_path_name('fa', 'fsl', 'fba', 'fba_ord') => 1,
624             file_path_name('fa', 'fab') => 1,
625             file_path_name('fa', 'fab', 'fab_ord') => 1,
626             file_path_name('fa', 'fab', 'faba') => 1,
627             file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
628             file_path_name('fa', 'faa') => 1,
629             file_path_name('fa', 'faa', 'faa_ord') => 1);
630
631     %Expect_Name = ();
632     %Expect_Dir = ();
633
634     File::Find::finddepth( {wanted => \&wanted_File, follow_fast => 1,
635             no_chdir => 1}, topdir('fa') );
636
637     is( scalar(keys %Expect_File), 0,
638         "COMPLETE: Test of 'follow_fast' and 'no_chdir' options together: \$File::Find::name case" );
639
640     ##### #####
641
642     print "# check dangling symbolic links\n";
643     mkdir_ok( dir_path('dangling_dir'), 0770 );
644     symlink_ok( dir_path('dangling_dir'), file_path('dangling_dir_sl'),
645         "Check dangling directory" );
646     rmdir dir_path('dangling_dir');
647     create_file_ok(file_path('dangling_file'));
648     symlink_ok('../dangling_file','fa/dangling_file_sl',
649         "Check dangling file" );
650     unlink file_path('dangling_file');
651
652     {
653         # these tests should also emit a warning
654     use warnings;
655
656         %Expect_File = (File::Spec->curdir => 1,
657             file_path('dangling_file_sl') => 1,
658             file_path('fa_ord') => 1,
659             file_path('fsl') => 1,
660             file_path('fb_ord') => 1,
661             file_path('fba') => 1,
662             file_path('fba_ord') => 1,
663             file_path('fab') => 1,
664             file_path('fab_ord') => 1,
665             file_path('faba') => 1,
666             file_path('faba_ord') => 1,
667             file_path('faa') => 1,
668             file_path('faa_ord') => 1);
669
670         %Expect_Name = ();
671         %Expect_Dir = ();
672         undef $warn_msg;
673
674         File::Find::find( {wanted => \&wanted_File, follow => 1,
675                dangling_symlinks =>
676                    sub { $warn_msg = "$_[0] is a dangling symbolic link" }
677                            },
678                            topdir('dangling_dir_sl'), topdir('fa') );
679
680         is( scalar(keys %Expect_File), 0,
681             "COMPLETE: test of 'follow' and 'dangling_symlinks' options" );
682         like( $warn_msg, qr/dangling_file_sl is a dangling symbolic link/,
683             "Got expected warning message re dangling symbolic link" );
684         unlink file_path('fa', 'dangling_file_sl'),
685             file_path('dangling_dir_sl');
686
687     }
688
689     ##### #####
690
691     print "# check recursion\n";
692     symlink_ok('../faa','fa/faa/faa_sl');
693     undef $@;
694     eval {File::Find::find( {wanted => \&simple_wanted, follow => 1,
695                              no_chdir => 1}, topdir('fa') ); };
696     like(
697         $@,
698         qr{for_find[:/]fa[:/]faa[:/]faa_sl is a recursive symbolic link}i,
699         "Got expected error message for recursive symbolic link"
700     );
701     unlink file_path('fa', 'faa', 'faa_sl');
702
703
704     print "# check follow_skip (file)\n";
705     symlink_ok('./fa_ord','fa/fa_ord_sl');
706     undef $@;
707
708     eval {File::Find::finddepth( {wanted => \&simple_wanted,
709                                   follow => 1,
710                                   follow_skip => 0, no_chdir => 1},
711                                   topdir('fa') );};
712
713     like(
714         $@,
715         qr{for_find[:/]fa[:/]fa_ord encountered a second time}i,
716         "'follow_skip==0': got error message when file encountered a second time"
717     );
718
719     ##### #####
720
721     # no_chdir is in effect, hence we use file_path_name to specify
722     # the expected paths for %Expect_File
723
724     %Expect_File = (file_path_name('fa') => 1,
725             file_path_name('fa', 'fa_ord') => 2,
726             # We may encounter the symlink first
727             file_path_name('fa', 'fa_ord_sl') => 2,
728             file_path_name('fa', 'fsl') => 1,
729             file_path_name('fa', 'fsl', 'fb_ord') => 1,
730             file_path_name('fa', 'fsl', 'fba') => 1,
731             file_path_name('fa', 'fsl', 'fba', 'fba_ord') => 1,
732             file_path_name('fa', 'fab') => 1,
733             file_path_name('fa', 'fab', 'fab_ord') => 1,
734             file_path_name('fa', 'fab', 'faba') => 1,
735             file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
736             file_path_name('fa', 'faa') => 1,
737             file_path_name('fa', 'faa', 'faa_ord') => 1);
738
739     %Expect_Name = ();
740
741     %Expect_Dir = (dir_path('fa') => 1,
742             dir_path('fa', 'faa') => 1,
743             dir_path('fa', 'fab') => 1,
744             dir_path('fa', 'fab', 'faba') => 1,
745             dir_path('fb') => 1,
746             dir_path('fb','fba') => 1);
747
748     File::Find::finddepth( {wanted => \&wanted_File_Dir, follow => 1,
749                            follow_skip => 1, no_chdir => 1},
750                            topdir('fa') );
751     is( scalar(keys %Expect_File), 0,
752         "COMPLETE: Test of 'follow', 'follow_skip==1' and 'no_chdir' options" );
753     unlink file_path('fa', 'fa_ord_sl');
754
755     ##### #####
756     print "# check follow_skip (directory)\n";
757     symlink_ok('./faa','fa/faa_sl');
758     undef $@;
759
760     eval {File::Find::find( {wanted => \&simple_wanted, follow => 1,
761                             follow_skip => 0, no_chdir => 1},
762                             topdir('fa') );};
763
764     like(
765         $@,
766         qr{for_find[:/]fa[:/]faa[:/]? encountered a second time}i,
767         "'follow_skip==0': got error message when directory encountered a second time"
768     );
769
770
771     undef $@;
772
773     eval {File::Find::find( {wanted => \&simple_wanted, follow => 1,
774                             follow_skip => 1, no_chdir => 1},
775                             topdir('fa') );};
776
777     like(
778         $@,
779         qr{for_find[:/]fa[:/]faa[:/]? encountered a second time}i,
780         "'follow_skip==1': got error message when directory encountered a second time"
781      );
782
783     ##### #####
784
785     # no_chdir is in effect, hence we use file_path_name to specify
786     # the expected paths for %Expect_File
787
788     %Expect_File = (file_path_name('fa') => 1,
789             file_path_name('fa', 'fa_ord') => 1,
790             file_path_name('fa', 'fsl') => 1,
791             file_path_name('fa', 'fsl', 'fb_ord') => 1,
792             file_path_name('fa', 'fsl', 'fba') => 1,
793             file_path_name('fa', 'fsl', 'fba', 'fba_ord') => 1,
794             file_path_name('fa', 'fab') => 1,
795             file_path_name('fa', 'fab', 'fab_ord') => 1,
796             file_path_name('fa', 'fab', 'faba') => 1,
797             file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
798             file_path_name('fa', 'faa') => 1,
799             file_path_name('fa', 'faa', 'faa_ord') => 1,
800             # We may actually encounter the symlink first.
801             file_path_name('fa', 'faa_sl') => 1,
802             file_path_name('fa', 'faa_sl', 'faa_ord') => 1);
803
804     %Expect_Name = ();
805
806     %Expect_Dir = (dir_path('fa') => 1,
807             dir_path('fa', 'faa') => 1,
808             dir_path('fa', 'fab') => 1,
809             dir_path('fa', 'fab', 'faba') => 1,
810             dir_path('fb') => 1,
811             dir_path('fb', 'fba') => 1);
812
813     File::Find::find( {wanted => \&wanted_File_Dir, follow => 1,
814                follow_skip => 2, no_chdir => 1}, topdir('fa') );
815
816     ##### #####
817
818     # If we encountered the symlink first, then the entries corresponding to
819     # the real name remain, if the real name first then the symlink
820     my @names = sort keys %Expect_File;
821     is( scalar(@names), 1,
822         "'follow_skip==2'" );
823     # Normalise both to the original name
824     s/_sl// foreach @names;
825     is(
826         $names[0],
827         file_path_name('fa', 'faa', 'faa_ord'),
828         "Got file_path_name, as expected"
829     );
830     unlink file_path('fa', 'faa_sl');
831
832 }
833
834 ##### Win32 checks  - [perl #41555] #####
835
836 if ($^O eq 'MSWin32') {
837     require File::Spec::Win32;
838     my ($volume) = File::Spec::Win32->splitpath($orig_dir, 1);
839     print STDERR "VOLUME = $volume\n";
840
841     ##### #####
842
843     # with chdir
844     %Expect_File = (File::Spec->curdir => 1,
845                     file_path('fsl') => 1,
846                     file_path('fa_ord') => 1,
847                     file_path('fab') => 1,
848                     file_path('fab_ord') => 1,
849                     file_path('faba') => 1,
850                     file_path('faba_ord') => 1,
851                     file_path('faa') => 1,
852                     file_path('faa_ord') => 1);
853
854     delete $Expect_File{ file_path('fsl') } unless $symlink_exists;
855     %Expect_Name = ();
856
857     %Expect_Dir = (dir_path('fa') => 1,
858                    dir_path('faa') => 1,
859                    dir_path('fab') => 1,
860                    dir_path('faba') => 1,
861                    dir_path('fb') => 1,
862                    dir_path('fba') => 1);
863
864     File::Find::find( {wanted => \&wanted_File_Dir}, topdir('fa'));
865     is( scalar(keys %Expect_File), 0, "Got no files, as expected" );
866
867     ##### #####
868
869     # no_chdir
870     %Expect_File = ($volume . file_path_name('fa') => 1,
871                     $volume . file_path_name('fa', 'fsl') => 1,
872                     $volume . file_path_name('fa', 'fa_ord') => 1,
873                     $volume . file_path_name('fa', 'fab') => 1,
874                     $volume . file_path_name('fa', 'fab', 'fab_ord') => 1,
875                     $volume . file_path_name('fa', 'fab', 'faba') => 1,
876                     $volume . file_path_name('fa', 'fab', 'faba', 'faba_ord') => 1,
877                     $volume . file_path_name('fa', 'faa') => 1,
878                     $volume . file_path_name('fa', 'faa', 'faa_ord') => 1);
879
880
881     delete $Expect_File{ $volume . file_path_name('fa', 'fsl') } unless $symlink_exists;
882     %Expect_Name = ();
883
884     %Expect_Dir = ($volume . dir_path('fa') => 1,
885                    $volume . dir_path('fa', 'faa') => 1,
886                    $volume . dir_path('fa', 'fab') => 1,
887                    $volume . dir_path('fa', 'fab', 'faba') => 1);
888
889     File::Find::find( {wanted => \&wanted_File_Dir, no_chdir => 1}, $volume . topdir('fa'));
890     is( scalar(keys %Expect_File), 0, "Got no files, as expected" );
891 }
892
893
894 ##### Issue 68260 #####
895
896 if ($symlink_exists) {
897     print "# BUG  68260\n";
898     mkdir_ok(dir_path ('fa', 'fac'), 0770);
899     mkdir_ok(dir_path ('fb', 'fbc'), 0770);
900     create_file_ok(file_path ('fa', 'fac', 'faca'));
901     symlink_ok('..////../fa/fac/faca', 'fb/fbc/fbca',
902         "RT 68260: able to symlink");
903
904     use warnings;
905     my $dangling_symlink;
906     local $SIG {__WARN__} = sub {
907         local $" = " ";         # "
908         $dangling_symlink ++ if "@_" =~ /dangling symbolic link/;
909     };
910
911     File::Find::find (
912         {
913             wanted            => sub {1;},
914             follow            => 1,
915             follow_skip       => 2,
916             dangling_symlinks => 1,
917         },
918         File::Spec -> curdir
919     );
920
921     ok(!$dangling_symlink, "Found no dangling symlink");
922 }
923
924 if ($symlink_exists) {  # perl #120388
925     print "# BUG  120388\n";
926     mkdir_ok(dir_path ('fa', 'fax'), 0770);
927     create_file_ok(file_path ('fa', 'fax', 'faz'));
928     symlink_ok( file_path ('..', 'fa', 'fax', 'faz'), file_path ('fa', 'fay') );
929     my @seen;
930     File::Find::find( {wanted => sub {
931         if (/^fa[yz]$/) {
932             push @seen, $_;
933             ok(-e $File::Find::fullname,
934                 "file identified by 'fullname' exists");
935             my $subdir = file_path qw/for_find fa fax faz/;
936             like(
937                 $File::Find::fullname,
938                 qr/\Q$subdir\E$/,
939                 "fullname matches expected path"
940             );
941         }
942     }, follow => 1}, topdir('fa'));
943     # make sure "fay"(symlink) found before "faz"(real file);
944     # otherwise test invalid
945     is(join(',', @seen), 'fay,faz',
946         "symlink found before real file, as expected");
947 }
948
949 ##### Issue 59750 #####
950
951 print "# RT 59750\n";
952 mkdir_ok( dir_path('fc'), 0770 );
953 mkdir_ok( dir_path('fc', 'fca'), 0770 );
954 mkdir_ok( dir_path('fc', 'fcb'), 0770 );
955 mkdir_ok( dir_path('fc', 'fcc'), 0770 );
956 create_file_ok( file_path('fc', 'fca', 'match_alpha') );
957 create_file_ok( file_path('fc', 'fca', 'match_beta') );
958 create_file_ok( file_path('fc', 'fcb', 'match_gamma') );
959 create_file_ok( file_path('fc', 'fcb', 'delta') );
960 create_file_ok( file_path('fc', 'fcc', 'match_epsilon') );
961 create_file_ok( file_path('fc', 'fcc', 'match_zeta') );
962 create_file_ok( file_path('fc', 'fcc', 'eta') );
963
964 my @files_from_mixed = ();
965 sub wantmatch {
966     if ( $File::Find::name =~ m/match/ ) {
967         push @files_from_mixed, $_;
968         print "# \$_ => '$_'\n";
969     }
970 }
971 find( \&wantmatch, (
972     dir_path('fc', 'fca'),
973     dir_path('fc', 'fcb'),
974     dir_path('fc', 'fcc'),
975 ) );
976 is( scalar(@files_from_mixed), 5,
977     "Prepare test for RT #59750: got 5 'match' files as expected" );
978
979 @files_from_mixed = ();
980 find( \&wantmatch, (
981     dir_path('fc', 'fca'),
982     dir_path('fc', 'fcb'),
983     file_path('fc', 'fcc', 'match_epsilon'),
984     file_path('fc', 'fcc', 'eta'),
985 ) );
986 is( scalar(@files_from_mixed), 4,
987     "Can mix directories and (non-directory) files in list of directories searched by wanted()" );
988
989 ##### More Win32 checks#####
990
991 if ($^O eq 'MSWin32') {
992     # Check F:F:f correctly handles a root directory path.
993     # Rather than processing the entire drive (!), simply test that the
994     # first file passed to the wanted routine is correct and then bail out.
995     $orig_dir =~ /^(\w:)/ or die "expected a drive: $orig_dir";
996     my $drive = $1;
997
998     # Determine the file in the root directory which would be
999     # first if processed in sorted order. Create one if necessary.
1000     my $expected_first_file;
1001     opendir(my $ROOT_DIR, "/") or die "cannot opendir /: $!\n";
1002     foreach my $f (sort readdir $ROOT_DIR) {
1003         if (-f "/$f") {
1004             $expected_first_file = $f;
1005             last;
1006         }
1007     }
1008     closedir $ROOT_DIR;
1009     my $created_file;
1010     unless (defined $expected_first_file) {
1011         $expected_first_file = '__perl_File_Find_test.tmp';
1012         open(F, ">", "/$expected_first_file") && close(F)
1013             or die "cannot create file in root directory: $!\n";
1014         $created_file = 1;
1015     }
1016
1017     # Run F:F:f with/without no_chdir for each possible style of root path.
1018     # NB. If HOME were "/", then an inadvertent chdir('') would fluke the
1019     # expected result, so ensure it is something else:
1020     local $ENV{HOME} = $orig_dir;
1021     foreach my $no_chdir (0, 1) {
1022         foreach my $root_dir ("/", "\\", "$drive/", "$drive\\") {
1023             eval {
1024                 File::Find::find({
1025                     'no_chdir' => $no_chdir,
1026                     'preprocess' => sub { return sort @_ },
1027                     'wanted' => sub {
1028                         -f or return; # the first call is for $root_dir itself.
1029                         my $got = $File::Find::name;
1030                         my $exp = "$root_dir$expected_first_file";
1031                         print "# no_chdir=$no_chdir $root_dir '$got'\n";
1032                         is($got, $exp,
1033                             "Win32: Run 'find' with 'no_chdir' set to $no_chdir" );
1034                         die "done"; # do not process the entire drive!
1035                     },
1036                 }, $root_dir);
1037             };
1038             # If F:F:f did not die "done" then it did not Check() either.
1039             unless ($@ and $@ =~ /done/) {
1040                 print "# no_chdir=$no_chdir $root_dir ",
1041                     ($@ ? "error: $@" : "no files found"), "\n";
1042                 ok(0, "Win32: 0");
1043             }
1044         }
1045     }
1046     if ($created_file) {
1047         unlink("/$expected_first_file")
1048             or warn "can't unlink /$expected_first_file: $!\n";
1049     }
1050 }
1051
1052 {
1053     local $@;
1054     eval { File::Find::find( 'foobar' ); };
1055     like($@, qr/no &wanted subroutine given/,
1056         "find() correctly died for lack of &wanted via either coderef or hashref");
1057 }
1058
1059 {
1060     local $@;
1061     eval { File::Find::find( { follow => 1 } ); };
1062     like($@, qr/no &wanted subroutine given/,
1063         "find() correctly died for lack of &wanted via hashref");
1064 }
1065
1066 {
1067     local $@;
1068     eval { File::Find::find( { wanted => 1 } ); };
1069     like($@, qr/no &wanted subroutine given/,
1070         "find() correctly died: lack of coderef as value of 'wanted' element");
1071 }
1072
1073 {
1074     local $@;
1075     my $wanted = sub { print "hello world\n"; };
1076     eval { File::Find::find( $wanted, ( undef ) ); };
1077     like($@, qr/invalid top directory/,
1078         "find() correctly died due to undefined top directory");
1079 }