1 # Path.t -- tests for module File::Path
5 use Test::More tests => 93;
9 use_ok('File::Spec::Functions');
12 eval "use Test::Output";
13 my $has_Test_Output = $@ ? 0 : 1;
15 # first check for stupid permissions second for full, so we clean up
17 for my $perm (0111,0777) {
18 my $path = catdir(curdir(), "mhx", "bar");
20 chmod $perm, "mhx", $path;
22 my $oct = sprintf('0%o', $perm);
23 ok(-d "mhx", "mkdir parent dir $oct");
24 ok(-d $path, "mkdir child dir $oct");
27 ok(! -e "mhx", "mhx does not exist $oct");
30 # find a place to work
31 my ($error, $list, $file, $message);
32 my $tmp_base = catdir(
34 sprintf( 'test-%x-%x-%x', time, $$, rand(99999) ),
39 catdir($tmp_base, qw(a b)),
40 catdir($tmp_base, qw(a c)),
41 catdir($tmp_base, qw(z b)),
42 catdir($tmp_base, qw(z c)),
46 my @created = mkpath(@dir);
48 is(scalar(@created), 7, "created list of directories");
50 # pray for no race conditions blowing them out from under us
51 @created = mkpath([$tmp_base]);
52 is(scalar(@created), 0, "skipped making existing directory")
53 or diag("unexpectedly recreated @created");
55 @created = mkpath('');
56 is(scalar(@created), 0, "Can't create a directory named ''");
62 $dir = catdir($tmp_base, 'B');
63 $dir2 = catdir($dir, updir());
64 # IOW: File::Spec->catdir( qw(foo bar), File::Spec->updir ) eq 'foo'
65 # rather than foo/bar/..
66 skip "updir() canonicalises path on this platform", 2
70 @created = mkpath($dir2, {mask => 0700});
71 is(scalar(@created), 1, "make directory with trailing parent segment");
72 is($created[0], $dir, "made parent");
75 my $count = rmtree({error => \$error});
76 is( $count, 0, 'rmtree of nothing, count of zero' );
77 is( scalar(@$error), 0, 'no diagnostic captured' );
79 @created = mkpath($tmp_base, 0);
80 is(scalar(@created), 0, "skipped making existing directories (old style 1)")
81 or diag("unexpectedly recreated @created");
83 $dir = catdir($tmp_base,'C');
84 # mkpath returns unix syntax filespecs on VMS
85 $dir = VMS::Filespec::unixify($dir) if $^O eq 'VMS';
86 @created = mkpath($tmp_base, $dir);
87 is(scalar(@created), 1, "created directory (new style 1)");
88 is($created[0], $dir, "created directory (new style 1) cross-check");
90 @created = mkpath($tmp_base, 0, 0700);
91 is(scalar(@created), 0, "skipped making existing directories (old style 2)")
92 or diag("unexpectedly recreated @created");
94 $dir2 = catdir($tmp_base,'D');
95 # mkpath returns unix syntax filespecs on VMS
96 $dir2 = VMS::Filespec::unixify($dir2) if $^O eq 'VMS';
97 @created = mkpath($tmp_base, $dir, $dir2);
98 is(scalar(@created), 1, "created directory (new style 2)");
99 is($created[0], $dir2, "created directory (new style 2) cross-check");
101 $count = rmtree($dir, 0);
102 is($count, 1, "removed directory (old style 1)");
104 $count = rmtree($dir2, 0, 1);
105 is($count, 1, "removed directory (old style 2)");
109 # existence of E is neither here nor there
110 $dir = catdir($tmp_base, 'E', updir(), 'Y');
111 @created =mkpath($dir);
112 cmp_ok(scalar(@created), '>=', 1, "made one or more dirs because of ..");
113 cmp_ok(scalar(@created), '<=', 2, "made less than two dirs because of ..");
114 ok( -d catdir($tmp_base, 'Y'), "directory after parent" );
116 @created = mkpath(catdir(curdir(), $tmp_base));
117 is(scalar(@created), 0, "nothing created")
120 $dir = catdir($tmp_base, 'a');
121 $dir2 = catdir($tmp_base, 'z');
131 is(scalar(@$error), 0, "no errors unlinking a and z");
132 is(scalar(@$list), 4, "list contains 4 elements")
135 ok(-d $dir, "dir a still exists");
136 ok(-d $dir2, "dir z still exists");
138 $dir = catdir($tmp_base,'F');
139 # mkpath returns unix syntax filespecs on VMS
140 $dir = VMS::Filespec::unixify($dir) if $^O eq 'VMS';
142 @created = mkpath($dir, undef, 0770);
143 is(scalar(@created), 1, "created directory (old style 2 verbose undef)");
144 is($created[0], $dir, "created directory (old style 2 verbose undef) cross-check");
145 is(rmtree($dir, undef, 0), 1, "removed directory 2 verbose undef");
147 @created = mkpath($dir, undef);
148 is(scalar(@created), 1, "created directory (old style 2a verbose undef)");
149 is($created[0], $dir, "created directory (old style 2a verbose undef) cross-check");
150 is(rmtree($dir, undef), 1, "removed directory 2a verbose undef");
152 @created = mkpath($dir, 0, undef);
153 is(scalar(@created), 1, "created directory (old style 3 mode undef)");
154 is($created[0], $dir, "created directory (old style 3 mode undef) cross-check");
155 is(rmtree($dir, 0, undef), 1, "removed directory 3 verbose undef");
157 $dir = catdir($tmp_base,'G');
158 $dir = VMS::Filespec::unixify($dir) if $^O eq 'VMS';
160 @created = mkpath($dir, undef, 0200);
161 is(scalar(@created), 1, "created write-only dir");
162 is($created[0], $dir, "created write-only directory cross-check");
163 is(rmtree($dir), 1, "removed write-only dir");
165 # borderline new-style heuristics
166 if (chdir $tmp_base) {
167 pass("chdir to temp dir");
170 fail("chdir to temp dir: $!");
173 $dir = catdir('a', 'd1');
174 $dir2 = catdir('a', 'd2');
176 @created = mkpath( $dir, 0, $dir2 );
177 is(scalar @created, 3, 'new-style 3 dirs created');
179 $count = rmtree( $dir, 0, $dir2, );
180 is($count, 3, 'new-style 3 dirs removed');
182 @created = mkpath( $dir, $dir2, 1 );
183 is(scalar @created, 3, 'new-style 3 dirs created (redux)');
185 $count = rmtree( $dir, $dir2, 1 );
186 is($count, 3, 'new-style 3 dirs removed (redux)');
188 @created = mkpath( $dir, $dir2 );
189 is(scalar @created, 2, 'new-style 2 dirs created');
191 $count = rmtree( $dir, $dir2 );
192 is($count, 2, 'new-style 2 dirs removed');
195 pass("chdir parent");
198 fail("chdir parent: $!");
201 # see what happens if a file exists where we want a directory
203 my $entry = catdir($tmp_base, "file");
204 skip "Cannot create $entry", 4 unless open OUT, "> $entry";
205 print OUT "test file, safe to delete\n", scalar(localtime), "\n";
207 ok(-e $entry, "file exists in place of directory");
209 mkpath( $entry, {error => \$error} );
210 is( scalar(@$error), 1, "caught error condition" );
211 ($file, $message) = each %{$error->[0]};
212 is( $entry, $file, "and the message is: $message");
214 eval {@created = mkpath($entry, 0, 0700)};
216 chomp $error; # just to remove silly # in TAP output
217 cmp_ok( $error, 'ne', "", "no directory created (old-style) err=$error" )
221 my $extra = catdir(curdir(), qw(EXTRA 1 a));
224 skip "extra scenarios not set up, see eg/setup-extra-tests", 9
228 $dir = catdir( 'EXTRA', '1' );
229 rmtree( $dir, {result => \$list, error => \$err} );
230 is(scalar(@$list), 2, "extra dir $dir removed");
231 is(scalar(@$err), 1, "one error encountered");
233 $dir = catdir( 'EXTRA', '3', 'N' );
234 rmtree( $dir, {result => \$list, error => \$err} );
235 is( @$list, 1, q{remove a symlinked dir} );
236 is( @$err, 0, q{with no errors} );
238 $dir = catdir('EXTRA', '3', 'S');
239 rmtree($dir, {error => \$error});
240 is( scalar(@$error), 1, 'one error for an unreadable dir' );
242 $dir = catdir('EXTRA', '3', 'T');
243 rmtree($dir, {error => \$error});
244 is( scalar(@$error), 1, 'one error for an unreadable dir' );
246 $dir = catdir( 'EXTRA', '4' );
247 rmtree($dir, {result => \$list, error => \$err} );
248 is( @$list, 0, q{don't follow a symlinked dir} );
249 is( @$err, 2, q{two errors when removing a symlink in r/o dir} );
250 eval { ($file, $message) = each %{$err->[0]} };
251 is( $file, $dir, 'symlink reported in error' );
255 $dir = catdir($tmp_base, 'ZZ');
256 @created = mkpath($dir);
257 is(scalar(@created), 1, "create a ZZ directory");
259 local @ARGV = ($dir);
260 rmtree( [grep -e $_, @ARGV], 0, 0 );
261 ok(!-e $dir, "blow it away via \@ARGV");
265 skip 'Test::Output not available', 14
266 unless $has_Test_Output;
269 $dir = catdir('EXTRA', '3');
270 skip "extra scenarios not set up, see eg/setup-extra-tests", 3
273 $dir = catdir('EXTRA', '3', 'U');
275 sub {rmtree($dir, {verbose => 0})},
276 qr{\Acannot make child directory read-write-exec for [^:]+: .* at \S+ line \d+},
277 q(rmtree can't chdir into root dir)
280 $dir = catdir('EXTRA', '3');
282 sub {rmtree($dir, {})},
283 qr{\Acannot make child directory read-write-exec for [^:]+: .* at (\S+) line (\d+)
284 cannot make child directory read-write-exec for [^:]+: .* at \1 line \2
285 cannot make child directory read-write-exec for [^:]+: .* at \1 line \2
286 cannot remove directory for [^:]+: .* at \1 line \2},
287 'rmtree with file owned by root'
291 sub {rmtree('EXTRA', {})},
292 qr{\Acannot remove directory for [^:]+: .* at (\S+) line (\d+)
293 cannot remove directory for [^:]+: .* at \1 line \2
294 cannot make child directory read-write-exec for [^:]+: .* at \1 line \2
295 cannot make child directory read-write-exec for [^:]+: .* at \1 line \2
296 cannot make child directory read-write-exec for [^:]+: .* at \1 line \2
297 cannot remove directory for [^:]+: .* at \1 line \2
298 cannot unlink file for [^:]+: .* at \1 line \2
299 cannot restore permissions to \d+ for [^:]+: .* at \1 line \2
300 cannot make child directory read-write-exec for [^:]+: .* at \1 line \2
301 cannot remove directory for [^:]+: .* at \1 line \2
302 cannot restore permissions to \d+ for [^:]+: .* at \1 line \2},
303 'rmtree with insufficient privileges'
307 my $base = catdir($tmp_base,'output');
308 $dir = catdir($base,'A');
309 $dir2 = catdir($base,'B');
312 sub { rmtree( undef, 1 ) },
313 qr/\ANo root path\(s\) specified\b/,
314 "rmtree of nothing carps sensibly"
318 sub { rmtree( '', 1 ) },
319 qr/\ANo root path\(s\) specified\b/,
320 "rmtree of empty dir carps sensibly"
323 stderr_is( sub { mkpath() }, '', "mkpath no args does not carp" );
324 stderr_is( sub { rmtree() }, '', "rmtree no args does not carp" );
327 sub {@created = mkpath($dir, 1)},
328 "mkdir $base\nmkdir $dir\n",
329 'mkpath verbose (old style 1)'
333 sub {@created = mkpath([$dir2], 1)},
335 'mkpath verbose (old style 2)'
339 sub {$count = rmtree([$dir, $dir2], 1, 1)},
340 "rmdir $dir\nrmdir $dir2\n",
341 'rmtree verbose (old style)'
345 sub {@created = mkpath($dir, {verbose => 1, mask => 0750})},
347 'mkpath verbose (new style 1)'
351 sub {@created = mkpath($dir2, 1, 0771)},
353 'mkpath verbose (new style 2)'
357 $file = catdir($dir2, "file");
358 skip "Cannot create $file", 2 unless open OUT, "> $file";
359 print OUT "test file, safe to delete\n", scalar(localtime), "\n";
362 ok(-e $file, "file created in directory");
365 sub {$count = rmtree($dir, $dir2, {verbose => 1, safe => 1})},
366 "rmdir $dir\nunlink $file\nrmdir $dir2\n",
367 'rmtree safe verbose (new style)'
373 skip "extra scenarios not set up, see eg/setup-extra-tests", 11
374 unless -d catdir(qw(EXTRA 1));
376 rmtree 'EXTRA', {safe => 0, error => \$error};
377 is( scalar(@$error), 11, 'seven deadly sins' ); # well there used to be 7
379 rmtree 'EXTRA', {safe => 1, error => \$error};
380 is( scalar(@$error), 9, 'safe is better' );
382 ($file, $message) = each %$_;
383 if ($file =~ /[123]\z/) {
384 is(index($message, 'cannot remove directory: '), 0, "failed to remove $file with rmdir")
388 like($message, qr(\Acannot (?:restore permissions to \d+|chdir to child|unlink file): ), "failed to remove $file with unlink")
394 rmtree($tmp_base, {result => \$list} );
395 is(ref($list), 'ARRAY', "received a final list of results");
396 ok( !(-d $tmp_base), "test base directory gone" );