tests/test-canonicalize.c

   1 /* Test of execution of file name canonicalization.
   2    Copyright (C) 2007-2019 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>.  */
  16
  17 /* Written by Bruno Haible <bruno@clisp.org>, 2007.  */
  18
  19 #include <config.h>
  20
  21 #include "canonicalize.h"
  22
  23 #include <errno.h>
  24 #include <fcntl.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <sys/stat.h>
  29 #include <unistd.h>
  30
  31 #include "same-inode.h"
  32 #include "ignore-value.h"
  33
  34 #include "null-ptr.h"
  35 #include "macros.h"
  36
  37 #define BASE "t-can.tmp"
  38
  39 int
  40 main (void)
  41 {
  42   /* Setup some hierarchy to be used by this test.  Start by removing
  43      any leftovers from a previous partial run.  */
  44   {
  45     int fd;
  46     ignore_value (system ("rm -rf " BASE " ise"));
  47     ASSERT (mkdir (BASE, 0700) == 0);
  48     fd = creat (BASE "/tra", 0600);
  49     ASSERT (0 <= fd);
  50     ASSERT (close (fd) == 0);
  51   }
  52
  53   /* Check for ., .., intermediate // handling, and for error cases.  */
  54   {
  55     char *result1 = canonicalize_file_name (BASE "//./..//" BASE "/tra");
  56     char *result2 = canonicalize_filename_mode (BASE "//./..//" BASE "/tra",
  57                                                 CAN_EXISTING);
  58     ASSERT (result1 != NULL);
  59     ASSERT (result2 != NULL);
  60     ASSERT (strcmp (result1, result2) == 0);
  61     ASSERT (strstr (result1, "/" BASE "/tra")
  62             == result1 + strlen (result1) - strlen ("/" BASE "/tra"));
  63     free (result1);
  64     free (result2);
  65     errno = 0;
  66     result1 = canonicalize_file_name ("");
  67     ASSERT (result1 == NULL);
  68     ASSERT (errno == ENOENT);
  69     errno = 0;
  70     result2 = canonicalize_filename_mode ("", CAN_EXISTING);
  71     ASSERT (result2 == NULL);
  72     ASSERT (errno == ENOENT);
  73     errno = 0;
  74     result1 = canonicalize_file_name (null_ptr ());
  75     ASSERT (result1 == NULL);
  76     ASSERT (errno == EINVAL);
  77     errno = 0;
  78     result2 = canonicalize_filename_mode (NULL, CAN_EXISTING);
  79     ASSERT (result2 == NULL);
  80     ASSERT (errno == EINVAL);
  81     result2 = canonicalize_filename_mode (".", CAN_MISSING | CAN_ALL_BUT_LAST);
  82     ASSERT (result2 == NULL);
  83     ASSERT (errno == EINVAL);
  84   }
  85
  86   /* Check that a non-directory with trailing slash yields NULL.  */
  87   {
  88     char *result1;
  89     char *result2;
  90     errno = 0;
  91     result1 = canonicalize_file_name (BASE "/tra/");
  92     ASSERT (result1 == NULL);
  93     ASSERT (errno == ENOTDIR);
  94     errno = 0;
  95     result2 = canonicalize_filename_mode (BASE "/tra/", CAN_EXISTING);
  96     ASSERT (result2 == NULL);
  97     ASSERT (errno == ENOTDIR);
  98   }
  99
 100   /* Check that a missing directory yields NULL.  */
 101   {
 102     char *result1;
 103     char *result2;
 104     errno = 0;
 105     result1 = canonicalize_file_name (BASE "/zzz/..");
 106     ASSERT (result1 == NULL);
 107     ASSERT (errno == ENOENT);
 108     errno = 0;
 109     result2 = canonicalize_filename_mode (BASE "/zzz/..", CAN_EXISTING);
 110     ASSERT (result2 == NULL);
 111     ASSERT (errno == ENOENT);
 112   }
 113
 114   /* From here on out, tests involve symlinks.  */
 115   if (symlink (BASE "/ket", "ise") != 0)
 116     {
 117       ASSERT (remove (BASE "/tra") == 0);
 118       ASSERT (rmdir (BASE) == 0);
 119       fputs ("skipping test: symlinks not supported on this file system\n",
 120              stderr);
 121       return 77;
 122     }
 123   ASSERT (symlink ("bef", BASE "/plo") == 0);
 124   ASSERT (symlink ("tra", BASE "/huk") == 0);
 125   ASSERT (symlink ("lum", BASE "/bef") == 0);
 126   ASSERT (symlink ("wum", BASE "/ouk") == 0);
 127   ASSERT (symlink ("../ise", BASE "/ket") == 0);
 128   ASSERT (mkdir (BASE "/lum", 0700) == 0);
 129   ASSERT (symlink ("s", BASE "/p") == 0);
 130   ASSERT (symlink ("d", BASE "/s") == 0);
 131   ASSERT (mkdir (BASE "/d", 0700) == 0);
 132   ASSERT (close (creat (BASE "/d/2", 0600)) == 0);
 133   ASSERT (symlink ("../s/2", BASE "/d/1") == 0);
 134   ASSERT (symlink ("//.//../..", BASE "/droot") == 0);
 135
 136   /* Check that symbolic links are not resolved, with CAN_NOLINKS.  */
 137   {
 138     char *result1 = canonicalize_filename_mode (BASE "/huk", CAN_NOLINKS);
 139     ASSERT (result1 != NULL);
 140     ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/huk"),
 141                     "/" BASE "/huk") == 0);
 142     free (result1);
 143   }
 144
 145   /* Check that the symbolic link to a file can be resolved.  */
 146   {
 147     char *result1 = canonicalize_file_name (BASE "/huk");
 148     char *result2 = canonicalize_file_name (BASE "/tra");
 149     char *result3 = canonicalize_filename_mode (BASE "/huk", CAN_EXISTING);
 150     ASSERT (result1 != NULL);
 151     ASSERT (result2 != NULL);
 152     ASSERT (result3 != NULL);
 153     ASSERT (strcmp (result1, result2) == 0);
 154     ASSERT (strcmp (result2, result3) == 0);
 155     ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/tra"),
 156                     "/" BASE "/tra") == 0);
 157     free (result1);
 158     free (result2);
 159     free (result3);
 160   }
 161
 162   /* Check that the symbolic link to a directory can be resolved.  */
 163   {
 164     char *result1 = canonicalize_file_name (BASE "/plo");
 165     char *result2 = canonicalize_file_name (BASE "/bef");
 166     char *result3 = canonicalize_file_name (BASE "/lum");
 167     char *result4 = canonicalize_filename_mode (BASE "/plo", CAN_EXISTING);
 168     ASSERT (result1 != NULL);
 169     ASSERT (result2 != NULL);
 170     ASSERT (result3 != NULL);
 171     ASSERT (result4 != NULL);
 172     ASSERT (strcmp (result1, result2) == 0);
 173     ASSERT (strcmp (result2, result3) == 0);
 174     ASSERT (strcmp (result3, result4) == 0);
 175     ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/lum"),
 176                     "/" BASE "/lum") == 0);
 177     free (result1);
 178     free (result2);
 179     free (result3);
 180     free (result4);
 181   }
 182
 183   /* Check that a symbolic link to a nonexistent file yields NULL.  */
 184   {
 185     char *result1;
 186     char *result2;
 187     errno = 0;
 188     result1 = canonicalize_file_name (BASE "/ouk");
 189     ASSERT (result1 == NULL);
 190     ASSERT (errno == ENOENT);
 191     errno = 0;
 192     result2 = canonicalize_filename_mode (BASE "/ouk", CAN_EXISTING);
 193     ASSERT (result2 == NULL);
 194     ASSERT (errno == ENOENT);
 195   }
 196
 197   /* Check that a non-directory symlink with trailing slash yields NULL.  */
 198   {
 199     char *result1;
 200     char *result2;
 201     errno = 0;
 202     result1 = canonicalize_file_name (BASE "/huk/");
 203     ASSERT (result1 == NULL);
 204     ASSERT (errno == ENOTDIR);
 205     errno = 0;
 206     result2 = canonicalize_filename_mode (BASE "/huk/", CAN_EXISTING);
 207     ASSERT (result2 == NULL);
 208     ASSERT (errno == ENOTDIR);
 209   }
 210
 211   /* Check that a missing directory via symlink yields NULL.  */
 212   {
 213     char *result1;
 214     char *result2;
 215     errno = 0;
 216     result1 = canonicalize_file_name (BASE "/ouk/..");
 217     ASSERT (result1 == NULL);
 218     ASSERT (errno == ENOENT);
 219     errno = 0;
 220     result2 = canonicalize_filename_mode (BASE "/ouk/..", CAN_EXISTING);
 221     ASSERT (result2 == NULL);
 222     ASSERT (errno == ENOENT);
 223   }
 224
 225   /* Check that a loop of symbolic links is detected.  */
 226   {
 227     char *result1;
 228     char *result2;
 229     errno = 0;
 230     result1 = canonicalize_file_name ("ise");
 231     ASSERT (result1 == NULL);
 232     ASSERT (errno == ELOOP);
 233     errno = 0;
 234     result2 = canonicalize_filename_mode ("ise", CAN_EXISTING);
 235     ASSERT (result2 == NULL);
 236     ASSERT (errno == ELOOP);
 237   }
 238
 239   /* Check that alternate modes can resolve missing basenames.  */
 240   {
 241     char *result1 = canonicalize_filename_mode (BASE "/zzz", CAN_ALL_BUT_LAST);
 242     char *result2 = canonicalize_filename_mode (BASE "/zzz", CAN_MISSING);
 243     char *result3 = canonicalize_filename_mode (BASE "/zzz/", CAN_ALL_BUT_LAST);
 244     char *result4 = canonicalize_filename_mode (BASE "/zzz/", CAN_MISSING);
 245     ASSERT (result1 != NULL);
 246     ASSERT (result2 != NULL);
 247     ASSERT (result3 != NULL);
 248     ASSERT (result4 != NULL);
 249     ASSERT (strcmp (result1, result2) == 0);
 250     ASSERT (strcmp (result2, result3) == 0);
 251     ASSERT (strcmp (result3, result4) == 0);
 252     ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/zzz"),
 253                     "/" BASE "/zzz") == 0);
 254     free (result1);
 255     free (result2);
 256     free (result3);
 257     free (result4);
 258   }
 259
 260   /* Check that alternate modes can resolve broken symlink basenames.  */
 261   {
 262     char *result1 = canonicalize_filename_mode (BASE "/ouk", CAN_ALL_BUT_LAST);
 263     char *result2 = canonicalize_filename_mode (BASE "/ouk", CAN_MISSING);
 264     char *result3 = canonicalize_filename_mode (BASE "/ouk/", CAN_ALL_BUT_LAST);
 265     char *result4 = canonicalize_filename_mode (BASE "/ouk/", CAN_MISSING);
 266     ASSERT (result1 != NULL);
 267     ASSERT (result2 != NULL);
 268     ASSERT (result3 != NULL);
 269     ASSERT (result4 != NULL);
 270     ASSERT (strcmp (result1, result2) == 0);
 271     ASSERT (strcmp (result2, result3) == 0);
 272     ASSERT (strcmp (result3, result4) == 0);
 273     ASSERT (strcmp (result1 + strlen (result1) - strlen ("/" BASE "/wum"),
 274                     "/" BASE "/wum") == 0);
 275     free (result1);
 276     free (result2);
 277     free (result3);
 278     free (result4);
 279   }
 280
 281   /* Check that alternate modes can handle missing dirnames.  */
 282   {
 283     char *result1 = canonicalize_filename_mode ("t-can.zzz/zzz", CAN_ALL_BUT_LAST);
 284     char *result2 = canonicalize_filename_mode ("t-can.zzz/zzz", CAN_MISSING);
 285     ASSERT (result1 == NULL);
 286     ASSERT (result2 != NULL);
 287     ASSERT (strcmp (result2 + strlen (result2) - 14, "/t-can.zzz/zzz") == 0);
 288     free (result2);
 289   }
 290
 291   /* Ensure that the following is resolved properly.
 292      Before 2007-09-27, it would mistakenly report a loop.  */
 293   {
 294     char *result1 = canonicalize_filename_mode (BASE, CAN_EXISTING);
 295     char *result2 = canonicalize_filename_mode (BASE "/p/1", CAN_EXISTING);
 296     ASSERT (result1 != NULL);
 297     ASSERT (result2 != NULL);
 298     ASSERT (strcmp (result2 + strlen (result1), "/d/2") == 0);
 299     free (result1);
 300     free (result2);
 301   }
 302
 303   /* Check that leading // is honored correctly.  */
 304   {
 305     struct stat st1;
 306     struct stat st2;
 307     char *result1 = canonicalize_file_name ("//.");
 308     char *result2 = canonicalize_filename_mode ("//.", CAN_EXISTING);
 309     char *result3 = canonicalize_file_name (BASE "/droot");
 310     char *result4 = canonicalize_filename_mode (BASE "/droot", CAN_EXISTING);
 311     ASSERT (result1);
 312     ASSERT (result2);
 313     ASSERT (result3);
 314     ASSERT (result4);
 315     ASSERT (stat ("/", &st1) == 0);
 316     ASSERT (stat ("//", &st2) == 0);
 317     if (SAME_INODE (st1, st2))
 318       {
 319         ASSERT (strcmp (result1, "/") == 0);
 320         ASSERT (strcmp (result2, "/") == 0);
 321         ASSERT (strcmp (result3, "/") == 0);
 322         ASSERT (strcmp (result4, "/") == 0);
 323       }
 324     else
 325       {
 326         ASSERT (strcmp (result1, "//") == 0);
 327         ASSERT (strcmp (result2, "//") == 0);
 328         ASSERT (strcmp (result3, "//") == 0);
 329         ASSERT (strcmp (result4, "//") == 0);
 330       }
 331     free (result1);
 332     free (result2);
 333     free (result3);
 334     free (result4);
 335   }
 336
 337   /* Cleanup.  */
 338   ASSERT (remove (BASE "/droot") == 0);
 339   ASSERT (remove (BASE "/d/1") == 0);
 340   ASSERT (remove (BASE "/d/2") == 0);
 341   ASSERT (remove (BASE "/d") == 0);
 342   ASSERT (remove (BASE "/s") == 0);
 343   ASSERT (remove (BASE "/p") == 0);
 344   ASSERT (remove (BASE "/plo") == 0);
 345   ASSERT (remove (BASE "/huk") == 0);
 346   ASSERT (remove (BASE "/bef") == 0);
 347   ASSERT (remove (BASE "/ouk") == 0);
 348   ASSERT (remove (BASE "/ket") == 0);
 349   ASSERT (remove (BASE "/lum") == 0);
 350   ASSERT (remove (BASE "/tra") == 0);
 351   ASSERT (remove (BASE) == 0);
 352   ASSERT (remove ("ise") == 0);
 353
 354   return 0;
 355 }