t/helper/test-path-utils.c

   1 #include "test-tool.h"
   2 #include "cache.h"
   3 #include "string-list.h"
   4 #include "utf8.h"
   5
   6 /*
   7  * A "string_list_each_func_t" function that normalizes an entry from
   8  * GIT_CEILING_DIRECTORIES.  If the path is unusable for some reason,
   9  * die with an explanation.
  10  */
  11 static int normalize_ceiling_entry(struct string_list_item *item, void *unused)
  12 {
  13         char *ceil = item->string;
  14
  15         if (!*ceil)
  16                 die("Empty path is not supported");
  17         if (!is_absolute_path(ceil))
  18                 die("Path \"%s\" is not absolute", ceil);
  19         if (normalize_path_copy(ceil, ceil) < 0)
  20                 die("Path \"%s\" could not be normalized", ceil);
  21         return 1;
  22 }
  23
  24 static void normalize_argv_string(const char **var, const char *input)
  25 {
  26         if (!strcmp(input, "<null>"))
  27                 *var = NULL;
  28         else if (!strcmp(input, "<empty>"))
  29                 *var = "";
  30         else
  31                 *var = input;
  32
  33         if (*var && (**var == '<' || **var == '('))
  34                 die("Bad value: %s\n", input);
  35 }
  36
  37 struct test_data {
  38         const char *from;  /* input:  transform from this ... */
  39         const char *to;    /* output: ... to this.            */
  40         const char *alternative; /* output: ... or this.      */
  41 };
  42
  43 /*
  44  * Compatibility wrappers for OpenBSD, whose basename(3) and dirname(3)
  45  * have const parameters.
  46  */
  47 static char *posix_basename(char *path)
  48 {
  49         return basename(path);
  50 }
  51
  52 static char *posix_dirname(char *path)
  53 {
  54         return dirname(path);
  55 }
  56
  57 static int test_function(struct test_data *data, char *(*func)(char *input),
  58         const char *funcname)
  59 {
  60         int failed = 0, i;
  61         char buffer[1024];
  62         char *to;
  63
  64         for (i = 0; data[i].to; i++) {
  65                 if (!data[i].from)
  66                         to = func(NULL);
  67                 else {
  68                         xsnprintf(buffer, sizeof(buffer), "%s", data[i].from);
  69                         to = func(buffer);
  70                 }
  71                 if (!strcmp(to, data[i].to))
  72                         continue;
  73                 if (!data[i].alternative)
  74                         error("FAIL: %s(%s) => '%s' != '%s'\n",
  75                                 funcname, data[i].from, to, data[i].to);
  76                 else if (!strcmp(to, data[i].alternative))
  77                         continue;
  78                 else
  79                         error("FAIL: %s(%s) => '%s' != '%s', '%s'\n",
  80                                 funcname, data[i].from, to, data[i].to,
  81                                 data[i].alternative);
  82                 failed = 1;
  83         }
  84         return failed;
  85 }
  86
  87 static struct test_data basename_data[] = {
  88         /* --- POSIX type paths --- */
  89         { NULL,              "."    },
  90         { "",                "."    },
  91         { ".",               "."    },
  92         { "..",              ".."   },
  93         { "/",               "/"    },
  94         { "//",              "/", "//" },
  95         { "///",             "/", "//" },
  96         { "////",            "/", "//" },
  97         { "usr",             "usr"  },
  98         { "/usr",            "usr"  },
  99         { "/usr/",           "usr"  },
 100         { "/usr//",          "usr"  },
 101         { "/usr/lib",        "lib"  },
 102         { "usr/lib",         "lib"  },
 103         { "usr/lib///",      "lib"  },
 104
 105 #if defined(__MINGW32__) || defined(_MSC_VER)
 106         /* --- win32 type paths --- */
 107         { "\\usr",           "usr"  },
 108         { "\\usr\\",         "usr"  },
 109         { "\\usr\\\\",       "usr"  },
 110         { "\\usr\\lib",      "lib"  },
 111         { "usr\\lib",        "lib"  },
 112         { "usr\\lib\\\\\\",  "lib"  },
 113         { "C:/usr",          "usr"  },
 114         { "C:/usr",          "usr"  },
 115         { "C:/usr/",         "usr"  },
 116         { "C:/usr//",        "usr"  },
 117         { "C:/usr/lib",      "lib"  },
 118         { "C:usr/lib",       "lib"  },
 119         { "C:usr/lib///",    "lib"  },
 120         { "C:",              "."    },
 121         { "C:a",             "a"    },
 122         { "C:/",             "/"    },
 123         { "C:///",           "/"    },
 124         { "\\",              "\\", "/" },
 125         { "\\\\",            "\\", "/" },
 126         { "\\\\\\",          "\\", "/" },
 127 #endif
 128         { NULL,              NULL   }
 129 };
 130
 131 static struct test_data dirname_data[] = {
 132         /* --- POSIX type paths --- */
 133         { NULL,              "."      },
 134         { "",                "."      },
 135         { ".",               "."      },
 136         { "..",              "."      },
 137         { "/",               "/"      },
 138         { "//",              "/", "//" },
 139         { "///",             "/", "//" },
 140         { "////",            "/", "//" },
 141         { "usr",             "."      },
 142         { "/usr",            "/"      },
 143         { "/usr/",           "/"      },
 144         { "/usr//",          "/"      },
 145         { "/usr/lib",        "/usr"   },
 146         { "usr/lib",         "usr"    },
 147         { "usr/lib///",      "usr"    },
 148
 149 #if defined(__MINGW32__) || defined(_MSC_VER)
 150         /* --- win32 type paths --- */
 151         { "\\",              "\\"     },
 152         { "\\\\",            "\\\\"   },
 153         { "\\usr",           "\\"     },
 154         { "\\usr\\",         "\\"     },
 155         { "\\usr\\\\",       "\\"     },
 156         { "\\usr\\lib",      "\\usr"  },
 157         { "usr\\lib",        "usr"    },
 158         { "usr\\lib\\\\\\",  "usr"    },
 159         { "C:a",             "C:."    },
 160         { "C:/",             "C:/"    },
 161         { "C:///",           "C:/"    },
 162         { "C:/usr",          "C:/"    },
 163         { "C:/usr/",         "C:/"    },
 164         { "C:/usr//",        "C:/"    },
 165         { "C:/usr/lib",      "C:/usr" },
 166         { "C:usr/lib",       "C:usr"  },
 167         { "C:usr/lib///",    "C:usr"  },
 168         { "\\\\\\",          "\\"     },
 169         { "\\\\\\\\",        "\\"     },
 170         { "C:",              "C:.", "." },
 171 #endif
 172         { NULL,              NULL     }
 173 };
 174
 175 static int is_dotgitmodules(const char *path)
 176 {
 177         return is_hfs_dotgitmodules(path) || is_ntfs_dotgitmodules(path);
 178 }
 179
 180 /*
 181  * A very simple, reproducible pseudo-random generator. Copied from
 182  * `test-genrandom.c`.
 183  */
 184 static uint64_t my_random_value = 1234;
 185
 186 static uint64_t my_random(void)
 187 {
 188         my_random_value = my_random_value * 1103515245 + 12345;
 189         return my_random_value;
 190 }
 191
 192 /*
 193  * A fast approximation of the square root, without requiring math.h.
 194  *
 195  * It uses Newton's method to approximate the solution of 0 = x^2 - value.
 196  */
 197 static double my_sqrt(double value)
 198 {
 199         const double epsilon = 1e-6;
 200         double x = value;
 201
 202         if (value == 0)
 203                 return 0;
 204
 205         for (;;) {
 206                 double delta = (value / x - x) / 2;
 207                 if (delta < epsilon && delta > -epsilon)
 208                         return x + delta;
 209                 x += delta;
 210         }
 211 }
 212
 213 static int protect_ntfs_hfs_benchmark(int argc, const char **argv)
 214 {
 215         size_t i, j, nr, min_len = 3, max_len = 20;
 216         char **names;
 217         int repetitions = 15, file_mode = 0100644;
 218         uint64_t begin, end;
 219         double m[3][2], v[3][2];
 220         uint64_t cumul;
 221         double cumul2;
 222
 223         if (argc > 1 && !strcmp(argv[1], "--with-symlink-mode")) {
 224                 file_mode = 0120000;
 225                 argc--;
 226                 argv++;
 227         }
 228
 229         nr = argc > 1 ? strtoul(argv[1], NULL, 0) : 1000000;
 230         ALLOC_ARRAY(names, nr);
 231
 232         if (argc > 2) {
 233                 min_len = strtoul(argv[2], NULL, 0);
 234                 if (argc > 3)
 235                         max_len = strtoul(argv[3], NULL, 0);
 236                 if (min_len > max_len)
 237                         die("min_len > max_len");
 238         }
 239
 240         for (i = 0; i < nr; i++) {
 241                 size_t len = min_len + (my_random() % (max_len + 1 - min_len));
 242
 243                 names[i] = xmallocz(len);
 244                 while (len > 0)
 245                         names[i][--len] = (char)(' ' + (my_random() % ('\x7f' - ' ')));
 246         }
 247
 248         for (protect_ntfs = 0; protect_ntfs < 2; protect_ntfs++)
 249                 for (protect_hfs = 0; protect_hfs < 2; protect_hfs++) {
 250                         cumul = 0;
 251                         cumul2 = 0;
 252                         for (i = 0; i < repetitions; i++) {
 253                                 begin = getnanotime();
 254                                 for (j = 0; j < nr; j++)
 255                                         verify_path(names[j], file_mode);
 256                                 end = getnanotime();
 257                                 printf("protect_ntfs = %d, protect_hfs = %d: %lfms\n", protect_ntfs, protect_hfs, (end-begin) / (double)1e6);
 258                                 cumul += end - begin;
 259                                 cumul2 += (end - begin) * (end - begin);
 260                         }
 261                         m[protect_ntfs][protect_hfs] = cumul / (double)repetitions;
 262                         v[protect_ntfs][protect_hfs] = my_sqrt(cumul2 / (double)repetitions - m[protect_ntfs][protect_hfs] * m[protect_ntfs][protect_hfs]);
 263                         printf("mean: %lfms, stddev: %lfms\n", m[protect_ntfs][protect_hfs] / (double)1e6, v[protect_ntfs][protect_hfs] / (double)1e6);
 264                 }
 265
 266         for (protect_ntfs = 0; protect_ntfs < 2; protect_ntfs++)
 267                 for (protect_hfs = 0; protect_hfs < 2; protect_hfs++)
 268                         printf("ntfs=%d/hfs=%d: %lf%% slower\n", protect_ntfs, protect_hfs, (m[protect_ntfs][protect_hfs] - m[0][0]) * 100 / m[0][0]);
 269
 270         return 0;
 271 }
 272
 273 int cmd__path_utils(int argc, const char **argv)
 274 {
 275         if (argc == 3 && !strcmp(argv[1], "normalize_path_copy")) {
 276                 char *buf = xmallocz(strlen(argv[2]));
 277                 int rv = normalize_path_copy(buf, argv[2]);
 278                 if (rv)
 279                         buf = "++failed++";
 280                 puts(buf);
 281                 return 0;
 282         }
 283
 284         if (argc >= 2 && !strcmp(argv[1], "real_path")) {
 285                 while (argc > 2) {
 286                         puts(real_path(argv[2]));
 287                         argc--;
 288                         argv++;
 289                 }
 290                 return 0;
 291         }
 292
 293         if (argc >= 2 && !strcmp(argv[1], "absolute_path")) {
 294                 while (argc > 2) {
 295                         puts(absolute_path(argv[2]));
 296                         argc--;
 297                         argv++;
 298                 }
 299                 return 0;
 300         }
 301
 302         if (argc == 4 && !strcmp(argv[1], "longest_ancestor_length")) {
 303                 int len;
 304                 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
 305                 char *path = xstrdup(argv[2]);
 306
 307                 /*
 308                  * We have to normalize the arguments because under
 309                  * Windows, bash mangles arguments that look like
 310                  * absolute POSIX paths or colon-separate lists of
 311                  * absolute POSIX paths into DOS paths (e.g.,
 312                  * "/foo:/foo/bar" might be converted to
 313                  * "D:\Src\msysgit\foo;D:\Src\msysgit\foo\bar"),
 314                  * whereas longest_ancestor_length() requires paths
 315                  * that use forward slashes.
 316                  */
 317                 if (normalize_path_copy(path, path))
 318                         die("Path \"%s\" could not be normalized", argv[2]);
 319                 string_list_split(&ceiling_dirs, argv[3], PATH_SEP, -1);
 320                 filter_string_list(&ceiling_dirs, 0,
 321                                    normalize_ceiling_entry, NULL);
 322                 len = longest_ancestor_length(path, &ceiling_dirs);
 323                 string_list_clear(&ceiling_dirs, 0);
 324                 free(path);
 325                 printf("%d\n", len);
 326                 return 0;
 327         }
 328
 329         if (argc >= 4 && !strcmp(argv[1], "prefix_path")) {
 330                 const char *prefix = argv[2];
 331                 int prefix_len = strlen(prefix);
 332                 int nongit_ok;
 333                 setup_git_directory_gently(&nongit_ok);
 334                 while (argc > 3) {
 335                         puts(prefix_path(prefix, prefix_len, argv[3]));
 336                         argc--;
 337                         argv++;
 338                 }
 339                 return 0;
 340         }
 341
 342         if (argc == 4 && !strcmp(argv[1], "strip_path_suffix")) {
 343                 char *prefix = strip_path_suffix(argv[2], argv[3]);
 344                 printf("%s\n", prefix ? prefix : "(null)");
 345                 return 0;
 346         }
 347
 348         if (argc == 3 && !strcmp(argv[1], "print_path")) {
 349                 puts(argv[2]);
 350                 return 0;
 351         }
 352
 353         if (argc == 4 && !strcmp(argv[1], "relative_path")) {
 354                 struct strbuf sb = STRBUF_INIT;
 355                 const char *in, *prefix, *rel;
 356                 normalize_argv_string(&in, argv[2]);
 357                 normalize_argv_string(&prefix, argv[3]);
 358                 rel = relative_path(in, prefix, &sb);
 359                 if (!rel)
 360                         puts("(null)");
 361                 else
 362                         puts(strlen(rel) > 0 ? rel : "(empty)");
 363                 strbuf_release(&sb);
 364                 return 0;
 365         }
 366
 367         if (argc == 2 && !strcmp(argv[1], "basename"))
 368                 return test_function(basename_data, posix_basename, argv[1]);
 369
 370         if (argc == 2 && !strcmp(argv[1], "dirname"))
 371                 return test_function(dirname_data, posix_dirname, argv[1]);
 372
 373         if (argc > 2 && !strcmp(argv[1], "is_dotgitmodules")) {
 374                 int res = 0, expect = 1, i;
 375                 for (i = 2; i < argc; i++)
 376                         if (!strcmp("--not", argv[i]))
 377                                 expect = !expect;
 378                         else if (expect != is_dotgitmodules(argv[i]))
 379                                 res = error("'%s' is %s.gitmodules", argv[i],
 380                                             expect ? "not " : "");
 381                         else
 382                                 fprintf(stderr, "ok: '%s' is %s.gitmodules\n",
 383                                         argv[i], expect ? "" : "not ");
 384                 return !!res;
 385         }
 386
 387         if (argc > 1 && !strcmp(argv[1], "protect_ntfs_hfs"))
 388                 return !!protect_ntfs_hfs_benchmark(argc - 1, argv + 1);
 389
 390         if (argc > 1 && !strcmp(argv[1], "is_valid_path")) {
 391                 int res = 0, expect = 1, i;
 392
 393                 for (i = 2; i < argc; i++)
 394                         if (!strcmp("--not", argv[i]))
 395                                 expect = 0;
 396                         else if (expect != is_valid_path(argv[i]))
 397                                 res = error("'%s' is%s a valid path",
 398                                             argv[i], expect ? " not" : "");
 399                         else
 400                                 fprintf(stderr,
 401                                         "'%s' is%s a valid path\n",
 402                                         argv[i], expect ? "" : " not");
 403
 404                 return !!res;
 405         }
 406
 407         fprintf(stderr, "%s: unknown function name: %s\n", argv[0],
 408                 argv[1] ? argv[1] : "(there was none)");
 409         return 1;
 410 }