tests/test-canonicalize.c

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