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