tests/test-canonicalize.c

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