1 /* Test of execution of file name canonicalization.
2 Copyright (C) 2007-2021 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)
28 #include "signature.h"
29 SIGNATURE_CHECK (realpath, char *, (const char *, char *));
30 SIGNATURE_CHECK (canonicalize_file_name, char *, (const char *));
39 #include "same-inode.h"
40 #include "ignore-value.h"
42 #if GNULIB_defined_canonicalize_file_name
43 # include "null-ptr.h"
48 #define BASE "t-can-lgpl.tmp"
53 #if GNULIB_TEST_CANONICALIZE
54 /* No need to test canonicalize-lgpl module if canonicalize is also
59 /* Setup some hierarchy to be used by this test. Start by removing
60 any leftovers from a previous partial run. */
63 ignore_value (system ("rm -rf " BASE " ise"));
64 ASSERT (mkdir (BASE, 0700) == 0);
65 fd = creat (BASE "/tra", 0600);
67 ASSERT (close (fd) == 0);
70 /* Check // handling (the easy cases, without symlinks).
71 This // handling is not mandated by POSIX. However, many applications
72 expect that canonicalize_file_name "canonicalizes" the file name,
73 that is, that different results of canonicalize_file_name correspond
74 to different files (except for hard links). */
76 char *result0 = canonicalize_file_name ("/etc/passwd");
77 if (result0 != NULL) /* This file does not exist on native Windows. */
81 result = canonicalize_file_name ("/etc//passwd");
82 ASSERT (result != NULL && strcmp (result, result0) == 0);
84 result = canonicalize_file_name ("/etc///passwd");
85 ASSERT (result != NULL && strcmp (result, result0) == 0);
87 /* On Windows, the syntax //host/share/filename denotes a file
88 in a directory named 'share', exported from host 'host'.
89 See also m4/double-slash-root.m4. */
90 #if !(defined _WIN32 || defined __CYGWIN__)
91 result = canonicalize_file_name ("//etc/passwd");
92 ASSERT (result != NULL && strcmp (result, result0) == 0);
94 result = canonicalize_file_name ("//etc//passwd");
95 ASSERT (result != NULL && strcmp (result, result0) == 0);
97 result = canonicalize_file_name ("//etc///passwd");
98 ASSERT (result != NULL && strcmp (result, result0) == 0);
101 result = canonicalize_file_name ("///etc/passwd");
102 ASSERT (result != NULL && strcmp (result, result0) == 0);
104 result = canonicalize_file_name ("///etc//passwd");
105 ASSERT (result != NULL && strcmp (result, result0) == 0);
107 result = canonicalize_file_name ("///etc///passwd");
108 ASSERT (result != NULL && strcmp (result, result0) == 0);
112 /* Check for ., .., intermediate // handling, and for error cases. */
114 char *result = canonicalize_file_name (BASE "//./..//" BASE "/tra");
115 ASSERT (result != NULL);
116 ASSERT (strstr (result, "/" BASE "/tra")
117 == result + strlen (result) - strlen ("/" BASE "/tra"));
121 result = canonicalize_file_name ("");
122 ASSERT (result == NULL);
123 ASSERT (errno == ENOENT);
125 /* This test works only if the canonicalize_file_name implementation
126 comes from gnulib. If it comes from libc, we have no way to prevent
127 gcc from "optimizing" the null_ptr function in invalid ways. See
128 <https://gcc.gnu.org/bugzilla/show_bug.cgi?id=93156>. */
129 #if GNULIB_defined_canonicalize_file_name
131 result = canonicalize_file_name (null_ptr ());
132 ASSERT (result == NULL);
133 ASSERT (errno == EINVAL);
137 /* Check that a non-directory with trailing slash yields NULL. */
141 result = canonicalize_file_name (BASE "/tra/");
142 ASSERT (result == NULL);
143 ASSERT (errno == ENOTDIR);
146 /* Check that a missing directory yields NULL. */
150 result = canonicalize_file_name (BASE "/zzz/..");
151 ASSERT (result == NULL);
152 ASSERT (errno == ENOENT);
155 /* From here on out, tests involve symlinks. */
156 if (symlink (BASE "/ket", "ise") != 0)
158 ASSERT (remove (BASE "/tra") == 0);
159 ASSERT (rmdir (BASE) == 0);
160 fputs ("skipping test: symlinks not supported on this file system\n",
164 ASSERT (symlink ("bef", BASE "/plo") == 0);
165 ASSERT (symlink ("tra", BASE "/huk") == 0);
166 ASSERT (symlink ("lum", BASE "/bef") == 0);
167 ASSERT (symlink ("wum", BASE "/ouk") == 0);
168 ASSERT (symlink ("../ise", BASE "/ket") == 0);
169 ASSERT (mkdir (BASE "/lum", 0700) == 0);
170 ASSERT (symlink ("//.//../..", BASE "/droot") == 0);
172 /* Check that the symbolic link to a file can be resolved. */
174 char *result1 = canonicalize_file_name (BASE "/huk");
175 char *result2 = canonicalize_file_name (BASE "/tra");
176 ASSERT (result1 != NULL);
177 ASSERT (result2 != NULL);
178 ASSERT (strcmp (result1, result2) == 0);
179 ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/tra"),
180 "/" BASE "/tra") == 0);
185 /* Check that the symbolic link to a directory can be resolved. */
187 char *result1 = canonicalize_file_name (BASE "/plo");
188 char *result2 = canonicalize_file_name (BASE "/bef");
189 char *result3 = canonicalize_file_name (BASE "/lum");
190 ASSERT (result1 != NULL);
191 ASSERT (result2 != NULL);
192 ASSERT (result3 != NULL);
193 ASSERT (strcmp (result1, result2) == 0);
194 ASSERT (strcmp (result2, result3) == 0);
195 ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/lum"),
196 "/" BASE "/lum") == 0);
202 /* Check that a symbolic link to a nonexistent file yields NULL. */
206 result = canonicalize_file_name (BASE "/ouk");
207 ASSERT (result == NULL);
208 ASSERT (errno == ENOENT);
211 /* Check that a non-directory symlink with trailing slash yields NULL,
212 and likewise for other troublesome suffixes. */
214 char const *const file_name[]
226 BASE "/huk/././../x",
228 for (int i = 0; i < sizeof file_name / sizeof *file_name; i++)
231 ASSERT (!canonicalize_file_name (file_name[i]));
232 ASSERT (errno == ENOTDIR);
236 /* Check that a missing directory via symlink yields NULL. */
240 result = canonicalize_file_name (BASE "/ouk/..");
241 ASSERT (result == NULL);
242 ASSERT (errno == ENOENT);
245 /* Check that a loop of symbolic links is detected. */
249 result = canonicalize_file_name ("ise");
250 ASSERT (result == NULL);
251 ASSERT (errno == ELOOP);
254 /* Check that leading // within symlinks is honored correctly. */
258 char *result1 = canonicalize_file_name ("//.");
259 char *result2 = canonicalize_file_name (BASE "/droot");
262 ASSERT (stat ("/", &st1) == 0);
263 ASSERT (stat ("//", &st2) == 0);
264 /* On IBM z/OS, "/" and "//" are distinct, yet they both have
265 st_dev == st_ino == 1. */
267 if (SAME_INODE (st1, st2))
269 ASSERT (strcmp (result1, "/") == 0);
270 ASSERT (strcmp (result2, "/") == 0);
275 ASSERT (strcmp (result1, "//") == 0);
276 ASSERT (strcmp (result2, "//") == 0);
284 ASSERT (remove (BASE "/droot") == 0);
285 ASSERT (remove (BASE "/plo") == 0);
286 ASSERT (remove (BASE "/huk") == 0);
287 ASSERT (remove (BASE "/bef") == 0);
288 ASSERT (remove (BASE "/ouk") == 0);
289 ASSERT (remove (BASE "/ket") == 0);
290 ASSERT (remove (BASE "/lum") == 0);
291 ASSERT (remove (BASE "/tra") == 0);
292 ASSERT (remove (BASE) == 0);
293 ASSERT (remove ("ise") == 0);