run_processes_parallel periodically collects output from its child
processes, prints it, and then resets the buffers for each child.
Add run_processes_parallel_pipe_output variable so output can be
collected and fed to task_finished. When set, the function referenced
by task_finished should parse the output of each child process.
Signed-off-by: Calvin Wan <calvinwan@xxxxxxxxxx>
---
run-command.c | 6 +++++-
run-command.h | 9 +++++++++
t/helper/test-run-command.c | 31 ++++++++++++++++++++++++++++---
t/t0061-run-command.sh | 26 ++++++++++++++++++++++++++
4 files changed, 68 insertions(+), 4 deletions(-)
diff --git a/run-command.c b/run-command.c
index 14f17830f5..893bc1d294 100644
--- a/run-command.c
+++ b/run-command.c
@@ -1474,6 +1474,7 @@ enum child_state {
};
int run_processes_parallel_ungroup;
+int run_processes_parallel_pipe_output;
struct parallel_processes {
void *data;
@@ -1770,10 +1771,12 @@ int run_processes_parallel(int n,
int output_timeout = 100;
int spawn_cap = 4;
int ungroup = run_processes_parallel_ungroup;
+ int pipe_output = run_processes_parallel_pipe_output;
struct parallel_processes pp;
/* unset for the next API user */
run_processes_parallel_ungroup = 0;
+ run_processes_parallel_pipe_output = 0;
pp_init(&pp, n, get_next_task, start_failure, task_finished, pp_cb,
ungroup);
@@ -1800,7 +1803,8 @@ int run_processes_parallel(int n,
pp.children[i].state = GIT_CP_WAIT_CLEANUP;
} else {
pp_buffer_stderr(&pp, output_timeout);
- pp_output(&pp);
+ if (!pipe_output)
+ pp_output(&pp);
}
code = pp_collect_finished(&pp);
if (code) {
diff --git a/run-command.h b/run-command.h
index 0e85e5846a..a5b1d63f49 100644
--- a/run-command.h
+++ b/run-command.h
@@ -483,8 +483,17 @@ typedef int (*task_finished_fn)(int result,
* "run_processes_parallel_ungroup" to "1" before invoking
* run_processes_parallel(), it will be set back to "0" as soon as the
* API reads that setting.
+ *
+ * If the "pipe_output" option is specified, the output will be piped
+ * to task_finished_fn in the "struct strbuf *out" variable. The output
+ * will still be printed unless the callback resets the strbuf. The
+ * "pipe_output" option can be enabled by setting the global
+ * "run_processes_parallel_pipe_output" to "1" before invoking
+ * run_processes_parallel(), it will be set back to "0" as soon as the
+ * API reads that setting.
*/
extern int run_processes_parallel_ungroup;
+extern int run_processes_parallel_pipe_output;
int run_processes_parallel(int n,
get_next_task_fn,
start_failure_fn,
diff --git a/t/helper/test-run-command.c b/t/helper/test-run-command.c
index c9283b47af..030e533c6b 100644
--- a/t/helper/test-run-command.c
+++ b/t/helper/test-run-command.c
@@ -20,6 +20,7 @@
#include "wildmatch.h"
#include "gettext.h"
+static int pipe_output = 0;
static int number_callbacks;
static int parallel_next(struct child_process *cp,
struct strbuf *err,
@@ -52,15 +53,32 @@ static int no_job(struct child_process *cp,
return 0;
}
+static int task_finished_pipe_output(int result,
+ struct strbuf *err,
+ void *pp_cb,
+ void *pp_task_cb)
+{
+ if (err && pipe_output) {
+ fprintf(stderr, "%s", err->buf);
+ strbuf_reset(err);
+ }
+ return 0;
+}
+
static int task_finished(int result,
struct strbuf *err,
void *pp_cb,
void *pp_task_cb)
{
- if (err)
+ if (err) {
strbuf_addstr(err, "asking for a quick stop\n");
- else
+ if (pipe_output) {
+ fprintf(stderr, "%s", err->buf);
+ strbuf_reset(err);
+ }
+ } else {
fprintf(stderr, "asking for a quick stop\n");
+ }
return 1;
}
@@ -423,13 +441,20 @@ int cmd__run_command(int argc, const char **argv)
run_processes_parallel_ungroup = 1;
}
+ if (!strcmp(argv[1], "--pipe-output")) {
+ argv += 1;
+ argc -= 1;
+ run_processes_parallel_pipe_output = 1;
+ pipe_output = 1;
+ }
+
jobs = atoi(argv[2]);
strvec_clear(&proc.args);
strvec_pushv(&proc.args, (const char **)argv + 3);
if (!strcmp(argv[1], "run-command-parallel"))
exit(run_processes_parallel(jobs, parallel_next,
- NULL, NULL, &proc));
+ NULL, task_finished_pipe_output, &proc));
if (!strcmp(argv[1], "run-command-abort"))
exit(run_processes_parallel(jobs, parallel_next,
diff --git a/t/t0061-run-command.sh b/t/t0061-run-command.sh
index 7b5423eebd..97ca942a74 100755
--- a/t/t0061-run-command.sh
+++ b/t/t0061-run-command.sh
@@ -140,6 +140,11 @@ test_expect_success 'run_command runs ungrouped in parallel with more jobs avail
test_line_count = 4 err
'
+test_expect_success 'run_command runs pipe_output in parallel with more jobs available than tasks' '
+ test-tool run-command --pipe-output run-command-parallel 5 sh -c "printf \"%s\n%s\n\" Hello World" 2>actual &&
+ test_cmp expect actual
+'
+
test_expect_success 'run_command runs in parallel with as many jobs as tasks' '
test-tool run-command run-command-parallel 4 sh -c "printf \"%s\n%s\n\" Hello World" 2>actual &&
test_cmp expect actual
@@ -151,6 +156,11 @@ test_expect_success 'run_command runs ungrouped in parallel with as many jobs as
test_line_count = 4 err
'
+test_expect_success 'run_command runs pipe_output in parallel with as many jobs as tasks' '
+ test-tool run-command --pipe-output run-command-parallel 4 sh -c "printf \"%s\n%s\n\" Hello World" 2>actual &&
+ test_cmp expect actual
+'
+
test_expect_success 'run_command runs in parallel with more tasks than jobs available' '
test-tool run-command run-command-parallel 3 sh -c "printf \"%s\n%s\n\" Hello World" 2>actual &&
test_cmp expect actual
@@ -162,6 +172,12 @@ test_expect_success 'run_command runs ungrouped in parallel with more tasks than
test_line_count = 4 err
'
+test_expect_success 'run_command runs pipe_output in parallel with more tasks than jobs available' '
+ test-tool run-command --pipe-output run-command-parallel 3 sh -c "printf \"%s\n%s\n\" Hello World" 2>actual &&
+ test_cmp expect actual
+'
+
+
cat >expect <<-EOF
preloaded output of a child
asking for a quick stop
@@ -182,6 +198,11 @@ test_expect_success 'run_command is asked to abort gracefully (ungroup)' '
test_line_count = 6 err
'
+test_expect_success 'run_command is asked to abort gracefully (pipe_output)' '
+ test-tool run-command --pipe-output run-command-abort 3 false 2>actual &&
+ test_cmp expect actual
+'
+
cat >expect <<-EOF
no further jobs available
EOF
@@ -197,6 +218,11 @@ test_expect_success 'run_command outputs (ungroup) ' '
test_cmp expect err
'
+test_expect_success 'run_command outputs (pipe_output) ' '
+ test-tool run-command --pipe-output run-command-no-jobs 3 sh -c "printf \"%s\n%s\n\" Hello World" 2>actual &&
+ test_cmp expect actual
+'
+
test_trace () {
expect="$1"
shift
--
2.37.3.998.g577e59143f-goog
