tests: add a helper to stress test argument quoting
[git] / t / helper / test-run-command.c
1 /*
2  * test-run-command.c: test run command API.
3  *
4  * (C) 2009 Ilari Liusvaara <ilari.liusvaara@elisanet.fi>
5  *
6  * This code is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10
11 #include "git-compat-util.h"
12 #include "run-command.h"
13 #include "argv-array.h"
14 #include "strbuf.h"
15 #include "gettext.h"
16 #include "parse-options.h"
17
18 static int number_callbacks;
19 static int parallel_next(struct child_process *cp,
20                          struct strbuf *err,
21                          void *cb,
22                          void **task_cb)
23 {
24         struct child_process *d = cb;
25         if (number_callbacks >= 4)
26                 return 0;
27
28         argv_array_pushv(&cp->args, d->argv);
29         strbuf_addstr(err, "preloaded output of a child\n");
30         number_callbacks++;
31         return 1;
32 }
33
34 static int no_job(struct child_process *cp,
35                   struct strbuf *err,
36                   void *cb,
37                   void **task_cb)
38 {
39         strbuf_addstr(err, "no further jobs available\n");
40         return 0;
41 }
42
43 static int task_finished(int result,
44                          struct strbuf *err,
45                          void *pp_cb,
46                          void *pp_task_cb)
47 {
48         strbuf_addstr(err, "asking for a quick stop\n");
49         return 1;
50 }
51
52 static uint64_t my_random_next = 1234;
53
54 static uint64_t my_random(void)
55 {
56         uint64_t res = my_random_next;
57         my_random_next = my_random_next * 1103515245 + 12345;
58         return res;
59 }
60
61 static int quote_stress_test(int argc, const char **argv)
62 {
63         /*
64          * We are running a quote-stress test.
65          * spawn a subprocess that runs quote-stress with a
66          * special option that echoes back the arguments that
67          * were passed in.
68          */
69         char special[] = ".?*\\^_\"'`{}()[]<>@~&+:;$%"; // \t\r\n\a";
70         int i, j, k, trials = 100;
71         struct strbuf out = STRBUF_INIT;
72         struct argv_array args = ARGV_ARRAY_INIT;
73         struct option options[] = {
74                 OPT_INTEGER('n', "trials", &trials, "Number of trials"),
75                 OPT_END()
76         };
77         const char * const usage[] = {
78                 "test-run-command quote-stress-test <options>",
79                 NULL
80         };
81
82         argc = parse_options(argc, argv, NULL, options, usage, 0);
83
84         for (i = 0; i < trials; i++) {
85                 struct child_process cp = CHILD_PROCESS_INIT;
86                 size_t arg_count = 1 + (my_random() % 5), arg_offset;
87                 int ret = 0;
88
89                 argv_array_clear(&args);
90                 argv_array_pushl(&args, "test-run-command",
91                                  "quote-echo", NULL);
92                 arg_offset = args.argc;
93                 for (j = 0; j < arg_count; j++) {
94                         char buf[20];
95                         size_t min_len = 1;
96                         size_t arg_len = min_len +
97                                 (my_random() % (ARRAY_SIZE(buf) - min_len));
98
99                         for (k = 0; k < arg_len; k++)
100                                 buf[k] = special[my_random() %
101                                         ARRAY_SIZE(special)];
102                         buf[arg_len] = '\0';
103
104                         argv_array_push(&args, buf);
105                 }
106
107                 cp.argv = args.argv;
108                 strbuf_reset(&out);
109                 if (pipe_command(&cp, NULL, 0, &out, 0, NULL, 0) < 0)
110                         return error("Failed to spawn child process");
111
112                 for (j = 0, k = 0; j < arg_count; j++) {
113                         const char *arg = args.argv[j + arg_offset];
114
115                         if (strcmp(arg, out.buf + k))
116                                 ret = error("incorrectly quoted arg: '%s', "
117                                             "echoed back as '%s'",
118                                              arg, out.buf + k);
119                         k += strlen(out.buf + k) + 1;
120                 }
121
122                 if (k != out.len)
123                         ret = error("got %d bytes, but consumed only %d",
124                                      (int)out.len, (int)k);
125
126                 if (ret) {
127                         fprintf(stderr, "Trial #%d failed. Arguments:\n", i);
128                         for (j = 0; j < arg_count; j++)
129                                 fprintf(stderr, "arg #%d: '%s'\n",
130                                         (int)j, args.argv[j + arg_offset]);
131
132                         strbuf_release(&out);
133                         argv_array_clear(&args);
134
135                         return ret;
136                 }
137
138                 if (i && (i % 100) == 0)
139                         fprintf(stderr, "Trials completed: %d\n", (int)i);
140         }
141
142         strbuf_release(&out);
143         argv_array_clear(&args);
144
145         return 0;
146 }
147
148 static int quote_echo(int argc, const char **argv)
149 {
150         while (argc > 1) {
151                 fwrite(argv[1], strlen(argv[1]), 1, stdout);
152                 fputc('\0', stdout);
153                 argv++;
154                 argc--;
155         }
156
157         return 0;
158 }
159
160 int cmd_main(int argc, const char **argv)
161 {
162         struct child_process proc = CHILD_PROCESS_INIT;
163         int jobs;
164
165         if (argc >= 2 && !strcmp(argv[1], "quote-stress-test"))
166                 return !!quote_stress_test(argc - 1, argv + 1);
167
168         if (argc >= 2 && !strcmp(argv[1], "quote-echo"))
169                 return !!quote_echo(argc - 1, argv + 1);
170
171         if (argc < 3)
172                 return 1;
173         proc.argv = (const char **)argv + 2;
174
175         if (!strcmp(argv[1], "start-command-ENOENT")) {
176                 if (start_command(&proc) < 0 && errno == ENOENT)
177                         return 0;
178                 fprintf(stderr, "FAIL %s\n", argv[1]);
179                 return 1;
180         }
181         if (!strcmp(argv[1], "run-command"))
182                 exit(run_command(&proc));
183
184         jobs = atoi(argv[2]);
185         proc.argv = (const char **)argv + 3;
186
187         if (!strcmp(argv[1], "run-command-parallel"))
188                 exit(run_processes_parallel(jobs, parallel_next,
189                                             NULL, NULL, &proc));
190
191         if (!strcmp(argv[1], "run-command-abort"))
192                 exit(run_processes_parallel(jobs, parallel_next,
193                                             NULL, task_finished, &proc));
194
195         if (!strcmp(argv[1], "run-command-no-jobs"))
196                 exit(run_processes_parallel(jobs, no_job,
197                                             NULL, task_finished, &proc));
198
199         fprintf(stderr, "check usage\n");
200         return 1;
201 }