tests/test-canonicalize.c

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