Git 2.32
[git] / 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 check_dotfile(const char *x, const char **argv,
176                          int (*is_hfs)(const char *),
177                          int (*is_ntfs)(const char *))
178 {
179         int res = 0, expect = 1;
180         for (; *argv; argv++) {
181                 if (!strcmp("--not", *argv))
182                         expect = !expect;
183                 else if (expect != (is_hfs(*argv) || is_ntfs(*argv)))
184                         res = error("'%s' is %s.git%s", *argv,
185                                     expect ? "not " : "", x);
186                 else
187                         fprintf(stderr, "ok: '%s' is %s.git%s\n",
188                                 *argv, expect ? "" : "not ", x);
189         }
190         return !!res;
191 }
192
193 static int cmp_by_st_size(const void *a, const void *b)
194 {
195         intptr_t x = (intptr_t)((struct string_list_item *)a)->util;
196         intptr_t y = (intptr_t)((struct string_list_item *)b)->util;
197
198         return x > y ? -1 : (x < y ? +1 : 0);
199 }
200
201 /*
202  * A very simple, reproducible pseudo-random generator. Copied from
203  * `test-genrandom.c`.
204  */
205 static uint64_t my_random_value = 1234;
206
207 static uint64_t my_random(void)
208 {
209         my_random_value = my_random_value * 1103515245 + 12345;
210         return my_random_value;
211 }
212
213 /*
214  * A fast approximation of the square root, without requiring math.h.
215  *
216  * It uses Newton's method to approximate the solution of 0 = x^2 - value.
217  */
218 static double my_sqrt(double value)
219 {
220         const double epsilon = 1e-6;
221         double x = value;
222
223         if (value == 0)
224                 return 0;
225
226         for (;;) {
227                 double delta = (value / x - x) / 2;
228                 if (delta < epsilon && delta > -epsilon)
229                         return x + delta;
230                 x += delta;
231         }
232 }
233
234 static int protect_ntfs_hfs_benchmark(int argc, const char **argv)
235 {
236         size_t i, j, nr, min_len = 3, max_len = 20;
237         char **names;
238         int repetitions = 15, file_mode = 0100644;
239         uint64_t begin, end;
240         double m[3][2], v[3][2];
241         uint64_t cumul;
242         double cumul2;
243
244         if (argc > 1 && !strcmp(argv[1], "--with-symlink-mode")) {
245                 file_mode = 0120000;
246                 argc--;
247                 argv++;
248         }
249
250         nr = argc > 1 ? strtoul(argv[1], NULL, 0) : 1000000;
251         ALLOC_ARRAY(names, nr);
252
253         if (argc > 2) {
254                 min_len = strtoul(argv[2], NULL, 0);
255                 if (argc > 3)
256                         max_len = strtoul(argv[3], NULL, 0);
257                 if (min_len > max_len)
258                         die("min_len > max_len");
259         }
260
261         for (i = 0; i < nr; i++) {
262                 size_t len = min_len + (my_random() % (max_len + 1 - min_len));
263
264                 names[i] = xmallocz(len);
265                 while (len > 0)
266                         names[i][--len] = (char)(' ' + (my_random() % ('\x7f' - ' ')));
267         }
268
269         for (protect_ntfs = 0; protect_ntfs < 2; protect_ntfs++)
270                 for (protect_hfs = 0; protect_hfs < 2; protect_hfs++) {
271                         cumul = 0;
272                         cumul2 = 0;
273                         for (i = 0; i < repetitions; i++) {
274                                 begin = getnanotime();
275                                 for (j = 0; j < nr; j++)
276                                         verify_path(names[j], file_mode);
277                                 end = getnanotime();
278                                 printf("protect_ntfs = %d, protect_hfs = %d: %lfms\n", protect_ntfs, protect_hfs, (end-begin) / (double)1e6);
279                                 cumul += end - begin;
280                                 cumul2 += (end - begin) * (end - begin);
281                         }
282                         m[protect_ntfs][protect_hfs] = cumul / (double)repetitions;
283                         v[protect_ntfs][protect_hfs] = my_sqrt(cumul2 / (double)repetitions - m[protect_ntfs][protect_hfs] * m[protect_ntfs][protect_hfs]);
284                         printf("mean: %lfms, stddev: %lfms\n", m[protect_ntfs][protect_hfs] / (double)1e6, v[protect_ntfs][protect_hfs] / (double)1e6);
285                 }
286
287         for (protect_ntfs = 0; protect_ntfs < 2; protect_ntfs++)
288                 for (protect_hfs = 0; protect_hfs < 2; protect_hfs++)
289                         printf("ntfs=%d/hfs=%d: %lf%% slower\n", protect_ntfs, protect_hfs, (m[protect_ntfs][protect_hfs] - m[0][0]) * 100 / m[0][0]);
290
291         return 0;
292 }
293
294 int cmd__path_utils(int argc, const char **argv)
295 {
296         if (argc == 3 && !strcmp(argv[1], "normalize_path_copy")) {
297                 char *buf = xmallocz(strlen(argv[2]));
298                 int rv = normalize_path_copy(buf, argv[2]);
299                 if (rv)
300                         buf = "++failed++";
301                 puts(buf);
302                 return 0;
303         }
304
305         if (argc >= 2 && !strcmp(argv[1], "real_path")) {
306                 struct strbuf realpath = STRBUF_INIT;
307                 while (argc > 2) {
308                         strbuf_realpath(&realpath, argv[2], 1);
309                         puts(realpath.buf);
310                         argc--;
311                         argv++;
312                 }
313                 strbuf_release(&realpath);
314                 return 0;
315         }
316
317         if (argc >= 2 && !strcmp(argv[1], "absolute_path")) {
318                 while (argc > 2) {
319                         puts(absolute_path(argv[2]));
320                         argc--;
321                         argv++;
322                 }
323                 return 0;
324         }
325
326         if (argc == 4 && !strcmp(argv[1], "longest_ancestor_length")) {
327                 int len;
328                 struct string_list ceiling_dirs = STRING_LIST_INIT_DUP;
329                 char *path = xstrdup(argv[2]);
330
331                 /*
332                  * We have to normalize the arguments because under
333                  * Windows, bash mangles arguments that look like
334                  * absolute POSIX paths or colon-separate lists of
335                  * absolute POSIX paths into DOS paths (e.g.,
336                  * "/foo:/foo/bar" might be converted to
337                  * "D:\Src\msysgit\foo;D:\Src\msysgit\foo\bar"),
338                  * whereas longest_ancestor_length() requires paths
339                  * that use forward slashes.
340                  */
341                 if (normalize_path_copy(path, path))
342                         die("Path \"%s\" could not be normalized", argv[2]);
343                 string_list_split(&ceiling_dirs, argv[3], PATH_SEP, -1);
344                 filter_string_list(&ceiling_dirs, 0,
345                                    normalize_ceiling_entry, NULL);
346                 len = longest_ancestor_length(path, &ceiling_dirs);
347                 string_list_clear(&ceiling_dirs, 0);
348                 free(path);
349                 printf("%d\n", len);
350                 return 0;
351         }
352
353         if (argc >= 4 && !strcmp(argv[1], "prefix_path")) {
354                 const char *prefix = argv[2];
355                 int prefix_len = strlen(prefix);
356                 int nongit_ok;
357                 setup_git_directory_gently(&nongit_ok);
358                 while (argc > 3) {
359                         puts(prefix_path(prefix, prefix_len, argv[3]));
360                         argc--;
361                         argv++;
362                 }
363                 return 0;
364         }
365
366         if (argc == 4 && !strcmp(argv[1], "strip_path_suffix")) {
367                 char *prefix = strip_path_suffix(argv[2], argv[3]);
368                 printf("%s\n", prefix ? prefix : "(null)");
369                 return 0;
370         }
371
372         if (argc == 3 && !strcmp(argv[1], "print_path")) {
373                 puts(argv[2]);
374                 return 0;
375         }
376
377         if (argc == 4 && !strcmp(argv[1], "relative_path")) {
378                 struct strbuf sb = STRBUF_INIT;
379                 const char *in, *prefix, *rel;
380                 normalize_argv_string(&in, argv[2]);
381                 normalize_argv_string(&prefix, argv[3]);
382                 rel = relative_path(in, prefix, &sb);
383                 if (!rel)
384                         puts("(null)");
385                 else
386                         puts(strlen(rel) > 0 ? rel : "(empty)");
387                 strbuf_release(&sb);
388                 return 0;
389         }
390
391         if (argc == 2 && !strcmp(argv[1], "basename"))
392                 return test_function(basename_data, posix_basename, argv[1]);
393
394         if (argc == 2 && !strcmp(argv[1], "dirname"))
395                 return test_function(dirname_data, posix_dirname, argv[1]);
396
397         if (argc > 2 && !strcmp(argv[1], "is_dotgitmodules")) {
398                 return check_dotfile("modules", argv + 2,
399                                      is_hfs_dotgitmodules,
400                                      is_ntfs_dotgitmodules);
401         }
402         if (argc > 2 && !strcmp(argv[1], "is_dotgitignore")) {
403                 return check_dotfile("ignore", argv + 2,
404                                      is_hfs_dotgitignore,
405                                      is_ntfs_dotgitignore);
406         }
407         if (argc > 2 && !strcmp(argv[1], "is_dotgitattributes")) {
408                 return check_dotfile("attributes", argv + 2,
409                                      is_hfs_dotgitattributes,
410                                      is_ntfs_dotgitattributes);
411         }
412         if (argc > 2 && !strcmp(argv[1], "is_dotmailmap")) {
413                 return check_dotfile("mailmap", argv + 2,
414                                      is_hfs_dotmailmap,
415                                      is_ntfs_dotmailmap);
416         }
417
418         if (argc > 2 && !strcmp(argv[1], "file-size")) {
419                 int res = 0, i;
420                 struct stat st;
421
422                 for (i = 2; i < argc; i++)
423                         if (stat(argv[i], &st))
424                                 res = error_errno("Cannot stat '%s'", argv[i]);
425                         else
426                                 printf("%"PRIuMAX"\n", (uintmax_t)st.st_size);
427                 return !!res;
428         }
429
430         if (argc == 4 && !strcmp(argv[1], "skip-n-bytes")) {
431                 int fd = open(argv[2], O_RDONLY), offset = atoi(argv[3]);
432                 char buffer[65536];
433
434                 if (fd < 0)
435                         die_errno("could not open '%s'", argv[2]);
436                 if (lseek(fd, offset, SEEK_SET) < 0)
437                         die_errno("could not skip %d bytes", offset);
438                 for (;;) {
439                         ssize_t count = read(fd, buffer, sizeof(buffer));
440                         if (count < 0)
441                                 die_errno("could not read '%s'", argv[2]);
442                         if (!count)
443                                 break;
444                         if (write(1, buffer, count) < 0)
445                                 die_errno("could not write to stdout");
446                 }
447                 close(fd);
448                 return 0;
449         }
450
451         if (argc > 5 && !strcmp(argv[1], "slice-tests")) {
452                 int res = 0;
453                 long offset, stride, i;
454                 struct string_list list = STRING_LIST_INIT_NODUP;
455                 struct stat st;
456
457                 offset = strtol(argv[2], NULL, 10);
458                 stride = strtol(argv[3], NULL, 10);
459                 if (stride < 1)
460                         stride = 1;
461                 for (i = 4; i < argc; i++)
462                         if (stat(argv[i], &st))
463                                 res = error_errno("Cannot stat '%s'", argv[i]);
464                         else
465                                 string_list_append(&list, argv[i])->util =
466                                         (void *)(intptr_t)st.st_size;
467                 QSORT(list.items, list.nr, cmp_by_st_size);
468                 for (i = offset; i < list.nr; i+= stride)
469                         printf("%s\n", list.items[i].string);
470
471                 return !!res;
472         }
473
474         if (argc > 1 && !strcmp(argv[1], "protect_ntfs_hfs"))
475                 return !!protect_ntfs_hfs_benchmark(argc - 1, argv + 1);
476
477         if (argc > 1 && !strcmp(argv[1], "is_valid_path")) {
478                 int res = 0, expect = 1, i;
479
480                 for (i = 2; i < argc; i++)
481                         if (!strcmp("--not", argv[i]))
482                                 expect = 0;
483                         else if (expect != is_valid_path(argv[i]))
484                                 res = error("'%s' is%s a valid path",
485                                             argv[i], expect ? " not" : "");
486                         else
487                                 fprintf(stderr,
488                                         "'%s' is%s a valid path\n",
489                                         argv[i], expect ? "" : " not");
490
491                 return !!res;
492         }
493
494         fprintf(stderr, "%s: unknown function name: %s\n", argv[0],
495                 argv[1] ? argv[1] : "(there was none)");
496         return 1;
497 }