1 /* Test of execution of file name canonicalization.
2 Copyright (C) 2007-2024 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17 /* Written by Bruno Haible <bruno@clisp.org>, 2007. */
19 /* Don't use __attribute__ __nonnull__ in this compilation unit. Otherwise gcc
20 may "optimize" the null_ptr function, when its result gets passed to a
21 function that has an argument declared as _GL_ARG_NONNULL. */
22 #define _GL_ARG_NONNULL(params)
26 #include "canonicalize.h"
36 #include "same-inode.h"
37 #include "ignore-value.h"
39 #if GNULIB_defined_canonicalize_file_name
40 # include "null-ptr.h"
45 #define BASE "t-can.tmp"
50 /* Setup some hierarchy to be used by this test. Start by removing
51 any leftovers from a previous partial run. */
54 ignore_value (system ("rm -rf " BASE
" ise"));
55 ASSERT (mkdir (BASE
, 0700) == 0);
56 fd
= creat (BASE
"/tra", 0600);
58 ASSERT (close (fd
) == 0);
61 /* Check // handling (the easy cases, without symlinks).
62 This // handling is not mandated by POSIX. However, many applications
63 expect that canonicalize_filename_mode "canonicalizes" the file name,
64 that is, that different results of canonicalize_filename_mode correspond
65 to different files (except for hard links). */
67 char *result0
= canonicalize_file_name ("/etc/passwd");
68 if (result0
!= NULL
) /* This file does not exist on native Windows. */
72 result
= canonicalize_filename_mode ("/etc/passwd", CAN_MISSING
);
73 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
75 result
= canonicalize_filename_mode ("/etc//passwd", CAN_MISSING
);
76 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
78 result
= canonicalize_filename_mode ("/etc///passwd", CAN_MISSING
);
79 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
81 /* On Windows, the syntax //host/share/filename denotes a file
82 in a directory named 'share', exported from host 'host'.
83 See also m4/double-slash-root.m4. */
84 #if !(defined _WIN32 || defined __CYGWIN__)
85 result
= canonicalize_filename_mode ("//etc/passwd", CAN_MISSING
);
86 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
88 result
= canonicalize_filename_mode ("//etc//passwd", CAN_MISSING
);
89 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
91 result
= canonicalize_filename_mode ("//etc///passwd", CAN_MISSING
);
92 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
95 result
= canonicalize_filename_mode ("///etc/passwd", CAN_MISSING
);
96 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
98 result
= canonicalize_filename_mode ("///etc//passwd", CAN_MISSING
);
99 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
101 result
= canonicalize_filename_mode ("///etc///passwd", CAN_MISSING
);
102 ASSERT (result
!= NULL
&& strcmp (result
, result0
) == 0);
106 /* Check for ., .., intermediate // handling, and for error cases. */
108 char *result1
= canonicalize_file_name (BASE
"//./..//" BASE
"/tra");
109 char *result2
= canonicalize_filename_mode (BASE
"//./..//" BASE
"/tra",
111 ASSERT (result1
!= NULL
);
112 ASSERT (result2
!= NULL
);
113 ASSERT (strcmp (result1
, result2
) == 0);
114 ASSERT (strstr (result1
, "/" BASE
"/tra")
115 == result1
+ strlen (result1
) - strlen ("/" BASE
"/tra"));
120 result1
= canonicalize_file_name ("");
121 ASSERT (result1
== NULL
);
122 ASSERT (errno
== ENOENT
);
125 result2
= canonicalize_filename_mode ("", CAN_EXISTING
);
126 ASSERT (result2
== NULL
);
127 ASSERT (errno
== ENOENT
);
129 /* This test works only if the canonicalize_file_name implementation
130 comes from gnulib. If it comes from libc, we have no way to prevent
131 gcc from "optimizing" the null_ptr function in invalid ways. See
132 <https://gcc.gnu.org/bugzilla/show_bug.cgi?id=93156>. */
133 #if GNULIB_defined_canonicalize_file_name
135 result1
= canonicalize_file_name (null_ptr ());
136 ASSERT (result1
== NULL
);
137 ASSERT (errno
== EINVAL
);
141 result2
= canonicalize_filename_mode (NULL
, CAN_EXISTING
);
142 ASSERT (result2
== NULL
);
143 ASSERT (errno
== EINVAL
);
146 result2
= canonicalize_filename_mode (".", CAN_MISSING
| CAN_ALL_BUT_LAST
);
147 ASSERT (result2
== NULL
);
148 ASSERT (errno
== EINVAL
);
151 /* Check that a non-directory with trailing slash yields NULL. */
156 result1
= canonicalize_file_name (BASE
"/tra/");
157 ASSERT (result1
== NULL
);
158 ASSERT (errno
== ENOTDIR
);
160 result2
= canonicalize_filename_mode (BASE
"/tra/", CAN_EXISTING
);
161 ASSERT (result2
== NULL
);
162 ASSERT (errno
== ENOTDIR
);
165 /* Check that a missing directory yields NULL. */
170 result1
= canonicalize_file_name (BASE
"/zzz/..");
171 ASSERT (result1
== NULL
);
172 ASSERT (errno
== ENOENT
);
174 result2
= canonicalize_filename_mode (BASE
"/zzz/..", CAN_EXISTING
);
175 ASSERT (result2
== NULL
);
176 ASSERT (errno
== ENOENT
);
179 /* From here on out, tests involve symlinks. */
180 if (symlink (BASE
"/ket", "ise") != 0)
182 ASSERT (remove (BASE
"/tra") == 0);
183 ASSERT (rmdir (BASE
) == 0);
184 if (test_exit_status
!= EXIT_SUCCESS
)
185 return test_exit_status
;
186 fputs ("skipping test: symlinks not supported on this file system\n",
190 ASSERT (symlink ("bef", BASE
"/plo") == 0);
191 ASSERT (symlink ("tra", BASE
"/huk") == 0);
192 ASSERT (symlink ("lum", BASE
"/bef") == 0);
193 ASSERT (symlink ("wum", BASE
"/ouk") == 0);
194 ASSERT (symlink ("../ise", BASE
"/ket") == 0);
195 ASSERT (mkdir (BASE
"/lum", 0700) == 0);
196 ASSERT (symlink ("s", BASE
"/p") == 0);
197 ASSERT (symlink ("d", BASE
"/s") == 0);
198 ASSERT (mkdir (BASE
"/d", 0700) == 0);
199 ASSERT (close (creat (BASE
"/d/2", 0600)) == 0);
200 ASSERT (symlink ("../s/2", BASE
"/d/1") == 0);
201 ASSERT (symlink ("//.//../..", BASE
"/droot") == 0);
203 /* Check that symbolic links are not resolved, with CAN_NOLINKS. */
205 char *result1
= canonicalize_filename_mode (BASE
"/huk", CAN_NOLINKS
);
206 ASSERT (result1
!= NULL
);
207 ASSERT (strcmp (result1
+ strlen (result1
) - strlen ("/" BASE
"/huk"),
208 "/" BASE
"/huk") == 0);
212 /* Check that the symbolic link to a file can be resolved. */
214 char *result1
= canonicalize_file_name (BASE
"/huk");
215 char *result2
= canonicalize_file_name (BASE
"/tra");
216 char *result3
= canonicalize_filename_mode (BASE
"/huk", CAN_EXISTING
);
217 ASSERT (result1
!= NULL
);
218 ASSERT (result2
!= NULL
);
219 ASSERT (result3
!= NULL
);
220 ASSERT (strcmp (result1
, result2
) == 0);
221 ASSERT (strcmp (result2
, result3
) == 0);
222 ASSERT (strcmp (result1
+ strlen (result1
) - strlen ("/" BASE
"/tra"),
223 "/" BASE
"/tra") == 0);
229 /* Check that the symbolic link to a directory can be resolved. */
231 char *result1
= canonicalize_file_name (BASE
"/plo");
232 char *result2
= canonicalize_file_name (BASE
"/bef");
233 char *result3
= canonicalize_file_name (BASE
"/lum");
234 char *result4
= canonicalize_filename_mode (BASE
"/plo", CAN_EXISTING
);
235 ASSERT (result1
!= NULL
);
236 ASSERT (result2
!= NULL
);
237 ASSERT (result3
!= NULL
);
238 ASSERT (result4
!= NULL
);
239 ASSERT (strcmp (result1
, result2
) == 0);
240 ASSERT (strcmp (result2
, result3
) == 0);
241 ASSERT (strcmp (result3
, result4
) == 0);
242 ASSERT (strcmp (result1
+ strlen (result1
) - strlen ("/" BASE
"/lum"),
243 "/" BASE
"/lum") == 0);
250 /* Check that a symbolic link to a nonexistent file yields NULL. */
255 result1
= canonicalize_file_name (BASE
"/ouk");
256 ASSERT (result1
== NULL
);
257 ASSERT (errno
== ENOENT
);
259 result2
= canonicalize_filename_mode (BASE
"/ouk", CAN_EXISTING
);
260 ASSERT (result2
== NULL
);
261 ASSERT (errno
== ENOENT
);
264 /* Check that a non-directory symlink with trailing slash yields NULL,
265 and likewise for other troublesome suffixes. */
267 char const *const file_name
[]
279 BASE
"/huk/././../x",
281 for (int i
= 0; i
< sizeof file_name
/ sizeof *file_name
; i
++)
284 ASSERT (!canonicalize_file_name (file_name
[i
]));
285 ASSERT (errno
== ENOTDIR
);
287 ASSERT (!canonicalize_filename_mode (file_name
[i
], CAN_EXISTING
));
288 ASSERT (errno
== ENOTDIR
);
292 /* Check that a missing directory via symlink yields NULL. */
297 result1
= canonicalize_file_name (BASE
"/ouk/..");
298 ASSERT (result1
== NULL
);
299 ASSERT (errno
== ENOENT
);
301 result2
= canonicalize_filename_mode (BASE
"/ouk/..", CAN_EXISTING
);
302 ASSERT (result2
== NULL
);
303 ASSERT (errno
== ENOENT
);
306 /* Check that a loop of symbolic links is detected. */
311 result1
= canonicalize_file_name ("ise");
312 ASSERT (result1
== NULL
);
313 ASSERT (errno
== ELOOP
);
315 result2
= canonicalize_filename_mode ("ise", CAN_EXISTING
);
316 ASSERT (result2
== NULL
);
317 ASSERT (errno
== ELOOP
);
320 /* Check that alternate modes can resolve missing basenames. */
322 char *result1
= canonicalize_filename_mode (BASE
"/zzz", CAN_ALL_BUT_LAST
);
323 char *result2
= canonicalize_filename_mode (BASE
"/zzz", CAN_MISSING
);
324 char *result3
= canonicalize_filename_mode (BASE
"/zzz/", CAN_ALL_BUT_LAST
);
325 char *result4
= canonicalize_filename_mode (BASE
"/zzz/", CAN_MISSING
);
326 ASSERT (result1
!= NULL
);
327 ASSERT (result2
!= NULL
);
328 ASSERT (result3
!= NULL
);
329 ASSERT (result4
!= NULL
);
330 ASSERT (strcmp (result1
, result2
) == 0);
331 ASSERT (strcmp (result2
, result3
) == 0);
332 ASSERT (strcmp (result3
, result4
) == 0);
333 ASSERT (strcmp (result1
+ strlen (result1
) - strlen ("/" BASE
"/zzz"),
334 "/" BASE
"/zzz") == 0);
341 /* Check that alternate modes can resolve broken symlink basenames. */
343 char *result1
= canonicalize_filename_mode (BASE
"/ouk", CAN_ALL_BUT_LAST
);
344 char *result2
= canonicalize_filename_mode (BASE
"/ouk", CAN_MISSING
);
345 char *result3
= canonicalize_filename_mode (BASE
"/ouk/", CAN_ALL_BUT_LAST
);
346 char *result4
= canonicalize_filename_mode (BASE
"/ouk/", CAN_MISSING
);
347 ASSERT (result1
!= NULL
);
348 ASSERT (result2
!= NULL
);
349 ASSERT (result3
!= NULL
);
350 ASSERT (result4
!= NULL
);
351 ASSERT (strcmp (result1
, result2
) == 0);
352 ASSERT (strcmp (result2
, result3
) == 0);
353 ASSERT (strcmp (result3
, result4
) == 0);
354 ASSERT (strcmp (result1
+ strlen (result1
) - strlen ("/" BASE
"/wum"),
355 "/" BASE
"/wum") == 0);
362 /* Check that alternate modes can handle missing dirnames. */
364 char *result1
= canonicalize_filename_mode ("t-can.zzz/zzz", CAN_ALL_BUT_LAST
);
365 char *result2
= canonicalize_filename_mode ("t-can.zzz/zzz", CAN_MISSING
);
366 ASSERT (result1
== NULL
);
367 ASSERT (result2
!= NULL
);
368 ASSERT (strcmp (result2
+ strlen (result2
) - 14, "/t-can.zzz/zzz") == 0);
372 /* Ensure that the following is resolved properly.
373 Before 2007-09-27, it would mistakenly report a loop. */
375 char *result1
= canonicalize_filename_mode (BASE
, CAN_EXISTING
);
376 char *result2
= canonicalize_filename_mode (BASE
"/p/1", CAN_EXISTING
);
377 ASSERT (result1
!= NULL
);
378 ASSERT (result2
!= NULL
);
379 ASSERT (strcmp (result2
+ strlen (result1
), "/d/2") == 0);
384 /* Check that leading // within symlinks is honored correctly. */
388 char *result1
= canonicalize_file_name ("//.");
389 char *result2
= canonicalize_filename_mode ("//.", CAN_EXISTING
);
390 char *result3
= canonicalize_file_name (BASE
"/droot");
391 char *result4
= canonicalize_filename_mode (BASE
"/droot", CAN_EXISTING
);
396 ASSERT (stat ("/", &st1
) == 0);
397 ASSERT (stat ("//", &st2
) == 0);
398 bool same
= psame_inode (&st1
, &st2
);
400 /* On IBM z/OS, "/" and "//" both canonicalize to themselves, yet they both
401 have st_dev == st_ino == 1. */
406 ASSERT (strcmp (result1
, "/") == 0);
407 ASSERT (strcmp (result2
, "/") == 0);
408 ASSERT (strcmp (result3
, "/") == 0);
409 ASSERT (strcmp (result4
, "/") == 0);
413 ASSERT (strcmp (result1
, "//") == 0);
414 ASSERT (strcmp (result2
, "//") == 0);
415 ASSERT (strcmp (result3
, "//") == 0);
416 ASSERT (strcmp (result4
, "//") == 0);
424 #if !(defined _WIN32 && !defined __CYGWIN__)
425 /* Check a device file. */
427 char *result1
= canonicalize_file_name ("/dev/null");
428 char *result2
= canonicalize_filename_mode ("/dev/null", CAN_ALL_BUT_LAST
);
429 ASSERT (result1
!= NULL
);
430 ASSERT (result2
!= NULL
);
431 ASSERT (strcmp (result1
, result2
) == 0);
436 ASSERT (remove (BASE
"/droot") == 0);
437 ASSERT (remove (BASE
"/d/1") == 0);
438 ASSERT (remove (BASE
"/d/2") == 0);
439 ASSERT (remove (BASE
"/d") == 0);
440 ASSERT (remove (BASE
"/s") == 0);
441 ASSERT (remove (BASE
"/p") == 0);
442 ASSERT (remove (BASE
"/plo") == 0);
443 ASSERT (remove (BASE
"/huk") == 0);
444 ASSERT (remove (BASE
"/bef") == 0);
445 ASSERT (remove (BASE
"/ouk") == 0);
446 ASSERT (remove (BASE
"/ket") == 0);
447 ASSERT (remove (BASE
"/lum") == 0);
448 ASSERT (remove (BASE
"/tra") == 0);
449 ASSERT (remove (BASE
) == 0);
450 ASSERT (remove ("ise") == 0);
452 return test_exit_status
;