Merge pull request #5749 from grondo/flux-job-eventlog-shorthand

flux-job: add shorthand paths for `flux job eventlog` and `wait-event`

Author: mergify[bot]

src/cmd/job/eventlog.c

@@ -41,8 +41,8 @@ struct optparse_option eventlog_opts[] =  {
                "(default if omitted), 'never', or 'auto' (default)."
     },
     { .name = "path", .key = 'p', .has_arg = 1, .arginfo = "PATH",
-      .usage = "Specify alternate eventlog path suffix "
-               "(e.g. \"guest.exec.eventlog\")",
+      .usage = "Specify alternate eventlog name or path suffix "
+               "(e.g. \"exec\", \"output\", or \"guest.exec.eventlog\")",
     },
     OPTPARSE_TABLE_END
 };
@@ -78,8 +78,8 @@ struct optparse_option wait_event_opts[] =  {
                "(default if omitted), 'never', or 'auto' (default)."
     },
     { .name = "path", .key = 'p', .has_arg = 1, .arginfo = "PATH",
-      .usage = "Specify alternate eventlog path suffix "
-               "(e.g. \"guest.exec.eventlog\")",
+      .usage = "Specify alternate eventlog name or path suffix "
+               "(e.g. \"exec\", \"output\", or \"guest.exec.eventlog\")",
     },
     { .name = "waitcreate", .key = 'W', .has_arg = 0,
       .usage = "If path does not exist, wait for its creation",
@@ -96,6 +96,31 @@ struct eventlog_ctx {
     struct eventlog_formatter *evf;
 };
 
+struct path_shortname {
+    const char *name;
+    const char *path;
+};
+
+/*  Set of shorthand names for common job eventlog paths:
+ */
+struct path_shortname eventlog_paths[] = {
+    { "exec",   "guest.exec.eventlog" },
+    { "output", "guest.output"        },
+    { "input",  "guest.input"         },
+    { NULL,     NULL                  },
+};
+
+const char *path_lookup (const char *name)
+{
+    const struct path_shortname *path = eventlog_paths;
+    while (path->name) {
+        if (streq (name, path->name))
+            return path->path;
+        path++;
+    }
+    return name;
+}
+
 static void formatter_parse_options (optparse_t *p,
                                      struct eventlog_formatter *evf)
 {
@@ -169,7 +194,7 @@ int cmd_eventlog (optparse_t *p, int argc, char **argv)
 
     ctx.jobid = argv[optindex++];
     ctx.id = parse_jobid (ctx.jobid);
-    ctx.path = optparse_get_str (p, "path", "eventlog");
+    ctx.path = path_lookup (optparse_get_str (p, "path", "eventlog"));
     ctx.p = p;
 
     if (!(ctx.evf = eventlog_formatter_create ()))
@@ -341,7 +366,7 @@ int cmd_wait_event (optparse_t *p, int argc, char **argv)
     ctx.id = parse_jobid (ctx.jobid);
     ctx.p = p;
     ctx.wait_event = argv[optindex++];
-    ctx.path = optparse_get_str (p, "path", "eventlog");
+    ctx.path = path_lookup (optparse_get_str (p, "path", "eventlog"));
     timeout = optparse_get_duration (p, "timeout", -1.0);
     if (optparse_hasopt (p, "waitcreate"))
         flags |= FLUX_JOB_EVENT_WATCH_WAITCREATE;

t/t2201-job-cmd.t

@@ -694,7 +694,7 @@ test_expect_success 'flux-job: load modules for live kill tests' '
 # N.B. SIGTERM == 15
 test_expect_success 'flux-job: kill basic works' '
 	id=$(flux submit --wait-event=start sleep 100) &&
-	flux job wait-event -vt 30 -p guest.exec.eventlog $id shell.start &&
+	flux job wait-event -vt 30 -p exec $id shell.start &&
 	flux job kill ${id} &&
 	flux job wait-event -t 30 ${id} finish > kill1.out &&
 	grep status=$((15+128<<8)) kill1.out
@@ -703,15 +703,15 @@ test_expect_success 'flux-job: kill basic works' '
 # N.B. SIGUSR1 == 10
 test_expect_success 'flux-job: kill --signal works' '
 	id=$(flux submit --wait-event=start sleep 100) &&
-	flux job wait-event -vt 30 -p guest.exec.eventlog $id shell.start &&
+	flux job wait-event -vt 30 -p exec $id shell.start &&
 	flux job kill --signal=SIGUSR1 ${id} &&
 	flux job wait-event -t 30 ${id} finish > kill2.out &&
 	grep status=$((10+128<<8)) kill2.out
 '
 
 test_expect_success 'flux job: killall -f kills one job' '
 	id=$(flux submit sleep 600) &&
-	flux job wait-event -vt 30 -p guest.exec.eventlog $id shell.init &&
+	flux job wait-event -vt 30 -p exec $id shell.init &&
 	flux job killall -f &&
 	run_timeout 60 flux queue drain
 '
@@ -720,7 +720,7 @@ test_expect_success 'flux job: cancel can operate on multiple jobs' '
 	ids=$(flux submit --bcc=1-3 sleep 600) &&
 	for id in ${ids}; do
 		flux job wait-event \
-			-vt 30 -p guest.exec.eventlog $id shell.init
+			-vt 30 -p exec $id shell.init
 	done &&
 	flux job cancel ${ids} cancel multiple jobs &&
 	for id in ${ids}; do
@@ -742,8 +742,7 @@ test_expect_success 'flux job: raise can operate on multiple jobs' '
 test_expect_success 'flux job: kill can operate on multiple jobs' '
 	ids=$(flux submit --wait-event=start --bcc=1-3 sleep 600) &&
 	for id in ${ids}; do
-		flux job wait-event \
-			-t 30 -p guest.exec.eventlog ${id} shell.init
+		flux job wait-event -t 30 -p exec ${id} shell.init
 	done &&
 	flux job kill ${ids} &&
 	for id in ${ids}; do

t/t2230-job-info-lookup.t

@@ -199,7 +199,21 @@ test_expect_success 'flux job eventlog -p works (guest.exec.eventlog)' '
 	flux job eventlog -p "guest.exec.eventlog" $jobid > eventlog_path2.out &&
 	grep done eventlog_path2.out
 '
-
+test_expect_success 'flux job eventlog -p works (exec)' '
+	jobid=$(submit_job) &&
+	flux job eventlog -p exec $jobid > eventlog_path3.out &&
+	grep done eventlog_path3.out
+'
+test_expect_success 'flux job eventlog -p works (output)' '
+	jobid=$(submit_job) &&
+	flux job eventlog -p output $jobid > eventlog_path4.out &&
+	grep encoding eventlog_path4.out
+'
+test_expect_success 'flux job eventlog -p works (output)' '
+	jobid=$(submit_job) &&
+	flux job eventlog -p input $jobid > eventlog_path5.out &&
+	grep encoding eventlog_path5.out
+'
 test_expect_success 'flux job eventlog -p fails on invalid path' '
 	jobid=$(submit_job) &&
 	test_must_fail flux job eventlog -p "foobar" $jobid

t/t2231-job-info-eventlog-watch.t

@@ -212,7 +212,10 @@ test_expect_success 'flux job wait-event -p works (guest.exec.eventlog)' '
 	fj_wait_event -p "guest.exec.eventlog" $jobid done > wait_event_path2.out &&
 	grep done wait_event_path2.out
 '
-
+test_expect_success 'flux job wait-event -p works (exec)' '
+	fj_wait_event -p exec $jobid done > wait_event_path2.1.out &&
+	grep done wait_event_path2.1.out
+'
 test_expect_success 'flux job wait-event -p works (non-guest eventlog)' '
 	jobid=$(submit_job) &&
 	kvsdir=$(flux job id --to=kvs $jobid) &&
@@ -236,9 +239,9 @@ test_expect_success 'flux job wait-event -p fails on path "guest."' '
 	test_must_fail fj_wait_event -p "guest." $jobid submit
 '
 
-test_expect_success 'flux job wait-event -p and --waitcreate works (guest.exec.eventlog)' '
+test_expect_success 'flux job wait-event -p and --waitcreate works (exec)' '
 	jobid=$(submit_job) &&
-	fj_wait_event --waitcreate -p "guest.exec.eventlog" $jobid done > wait_event_path4.out &&
+	fj_wait_event --waitcreate -p exec $jobid done > wait_event_path4.out &&
 	grep done wait_event_path4.out
 '
 
@@ -298,7 +301,8 @@ test_expect_success NO_CHAIN_LINT 'flux job wait-event -p invalid and --waitcrea
 
 test_expect_success 'flux job wait-event -p times out on no event (live job)' '
 	jobid=$(submit_job_live sleeplong.json) &&
-	test_expect_code 142 run_timeout -s ALRM 0.2 flux job wait-event -p "guest.exec.eventlog" $jobid foobar &&
+	test_expect_code 142 run_timeout -s ALRM 0.2 \
+	    flux job wait-event -p exec $jobid foobar &&
 	flux cancel $jobid
 '
 
@@ -351,10 +355,10 @@ test_expect_success 'job-info: generate jobspec to consume all resources' '
 	flux run --dry-run -n4 -c2 sleep 300 > sleeplong-all-rsrc.json
 '
 
-test_expect_success NO_CHAIN_LINT 'flux job wait-event -p guest.exec.eventlog works (wait job)' '
+test_expect_success NO_CHAIN_LINT 'flux job wait-event -p exec works (wait job)' '
 	jobidall=$(submit_job_live sleeplong-all-rsrc.json)
 	jobid=$(submit_job_wait)
-	fj_wait_event -v -p "guest.exec.eventlog" ${jobid} done > wait_event_path7.out &
+	fj_wait_event -v -p exec ${jobid} done > wait_event_path7.out &
 	waitpid=$! &&
 	wait_watchers_nonzero "watchers" &&
 	wait_watchers_nonzero "guest_watchers" &&
@@ -370,7 +374,8 @@ test_expect_success NO_CHAIN_LINT 'flux job wait-event -p guest.exec.eventlog wo
 test_expect_success 'flux job wait-event -p times out on no event (wait job)' '
 	jobidall=$(submit_job_live sleeplong-all-rsrc.json) &&
 	jobid=$(submit_job_wait) &&
-	test_expect_code 142 run_timeout -s ALRM 0.2 flux job wait-event -p "guest.exec.eventlog" $jobid foobar &&
+	test_expect_code 142 run_timeout -s ALRM 0.2 \
+	    flux job wait-event -p exec $jobid foobar &&
 	flux cancel $jobidall &&
 	flux cancel $jobid
 '
@@ -383,7 +388,7 @@ test_expect_success 'flux job wait-event -p times out on no event (wait job)' '
 test_expect_success NO_CHAIN_LINT 'flux job wait-event -p guest.exec.eventlog works (never start job)' '
 	jobidall=$(submit_job_live sleeplong-all-rsrc.json)
 	jobid=$(submit_job_wait)
-	fj_wait_event -v -p "guest.exec.eventlog" ${jobid} done > wait_event_path8.out &
+	fj_wait_event -v -p exec ${jobid} done > wait_event_path8.out &
 	waitpid=$! &&
 	wait_watchers_nonzero "watchers" &&
 	wait_watchers_nonzero "guest_watchers" &&

t/t2232-job-info-security.t

@@ -99,20 +99,20 @@ test_expect_success 'flux job eventlog fails on bad first event (user)' '
 
 test_expect_success 'flux job guest.exec.eventlog works via -p (owner)' '
 	jobid=$(submit_job) &&
-	flux job eventlog -p guest.exec.eventlog $jobid
+	flux job eventlog -p exec $jobid
 '
 
 test_expect_success 'flux job guest.exec.eventlog works via -p (user)' '
 	jobid=$(submit_job 9000) &&
 	set_userid 9000 &&
-	flux job eventlog -p guest.exec.eventlog $jobid &&
+	flux job eventlog -p exec $jobid &&
 	unset_userid
 '
 
 test_expect_success 'flux job guest.exec.eventlog fails via -p (wrong user)' '
 	jobid=$(submit_job 9000) &&
 	set_userid 9999 &&
-	! flux job eventlog -p guest.exec.eventlog $jobid &&
+	! flux job eventlog -p exec $jobid &&
 	unset_userid
 '
 
@@ -202,41 +202,41 @@ test_expect_success 'flux job wait-event fails (wrong user)' '
 
 test_expect_success 'flux job wait-event guest.exec.eventlog works via -p (owner)' '
 	jobid=$(submit_job) &&
-	flux job wait-event -p guest.exec.eventlog $jobid done
+	flux job wait-event -p exec $jobid done
 '
 
 test_expect_success 'flux job wait-event guest.exec.eventlog works via -p (user)' '
 	jobid=$(submit_job 9000) &&
 	set_userid 9000 &&
-	flux job wait-event -p guest.exec.eventlog $jobid done &&
+	flux job wait-event -p exec $jobid done &&
 	unset_userid
 '
 
 test_expect_success 'flux job wait-event guest.exec.eventlog fails via -p (wrong user)' '
 	jobid=$(submit_job 9000) &&
 	set_userid 9999 &&
-	! flux job wait-event -p guest.exec.eventlog $jobid done &&
+	! flux job wait-event -p exec $jobid done &&
 	unset_userid
 '
 
 test_expect_success 'flux job wait-event guest.exec.eventlog works via -p (live job, owner)' '
 	jobid=$(submit_job_live) &&
-	flux job wait-event -p guest.exec.eventlog $jobid init &&
+	flux job wait-event -p exec $jobid init &&
 	flux cancel $jobid
 '
 
 test_expect_success 'flux job wait-event guest.exec.eventlog works via -p (live job, user)' '
 	jobid=$(submit_job_live 9000) &&
 	set_userid 9000 &&
-	flux job wait-event -p guest.exec.eventlog $jobid init &&
+	flux job wait-event -p exec $jobid init &&
 	unset_userid &&
 	flux cancel $jobid
 '
 
 test_expect_success 'flux job wait-event guest.exec.eventlog fails via -p (live job, wrong user)' '
 	jobid=$(submit_job_live 9000) &&
 	set_userid 9999 &&
-	! flux job wait-event -p guest.exec.eventlog $jobid init &&
+	! flux job wait-event -p exec $jobid init &&
 	unset_userid &&
 	flux cancel $jobid
 '

t/t2402-job-exec-dummy.t

@@ -47,7 +47,7 @@ test_expect_success 'job-exec: status is maximum job shell exit codes' '
 test_expect_success 'job-exec: job exception kills job shells' '
 	id=$(flux submit -n4 -N4 sleep 300) &&
 	flux job wait-event -vt 5 $id start &&
-	flux job wait-event -vt 5 -p guest.exec.eventlog $id shell.start &&
+	flux job wait-event -vt 5 -p exec $id shell.start &&
 	flux cancel $id &&
 	flux job wait-event -vt 5 $id clean &&
 	flux job eventlog $id | grep -E "status=(15|36608)"

t/t2404-job-exec-multiuser.t

@@ -89,7 +89,7 @@ test_expect_success NO_ASAN 'job-exec: kill multiuser job uses the IMP' '
 		flux job submit --flags=signed sleep-job.signed) &&
 	flux job list-ids ${id} > ${id}.json &&
 	jq -e ".userid == 42" < ${id}.json &&
-	flux job wait-event -p guest.exec.eventlog -vt 30 ${id} shell.start &&
+	flux job wait-event -p exec -vt 30 ${id} shell.start &&
 	flux cancel ${id} &&
 	test_expect_code 143 run_timeout 30 flux job status -v ${id} &&
 	flux dmesg | grep "test-imp: Kill .*signal 15"

t/t2500-job-attach.t

@@ -132,7 +132,7 @@ test_expect_success NO_CHAIN_LINT 'attach: output appears before cancel' '
 	jobid=$(flux submit ${script})
 	flux job attach -E ${jobid} 1>attach5.out 2>attach5.err &
 	waitpid=$! &&
-	flux job wait-event --timeout=10.0 -p guest.exec.eventlog ${jobid} test-output-ready &&
+	flux job wait-event --timeout=10.0 -p exec ${jobid} test-output-ready &&
 	flux cancel ${jobid} &&
 	! wait ${waitpid} &&
 	grep before attach5.out &&

t/t2501-job-status.t

@@ -82,7 +82,7 @@ test_expect_success 'status: exit code ignores nonfatal exceptions' '
 	flux job status -vvv $jobid
 '
 test_expect_success 'status: returns 143 (SIGTERM) for canceled running job' '
-	flux job wait-event -p guest.exec.eventlog ${killed} shell.start &&
+	flux job wait-event -p exec ${killed} shell.start &&
 	flux cancel ${killed} &&
 	test_expect_code 143 flux job status -v ${killed}
 '

t/t2602-job-shell.t

@@ -201,32 +201,32 @@ test_expect_success 'create helper job submission script' '
 '
 test_expect_success 'job-shell: test shell kill event handling' '
 	id=$(flux submit -n4 -N4 ./sleepinf.sh) &&
-	flux job wait-event -p guest.exec.eventlog $id shell.init &&
-	flux job wait-event -p guest.output $id data &&
+	flux job wait-event -p exec $id shell.init &&
+	flux job wait-event -p output $id data &&
 	flux job kill $id &&
 	flux job wait-event $id finish >kill1.finish.out &&
 	grep status=$((15+128<<8)) kill1.finish.out
 '
 test_expect_success 'job-shell: test shell kill event handling: SIGKILL' '
 	id=$(flux submit -n4 -N4 ./sleepinf.sh) &&
-	flux job wait-event -p guest.exec.eventlog $id shell.init &&
-	flux job wait-event -p guest.output $id data &&
+	flux job wait-event -p exec $id shell.init &&
+	flux job wait-event -p output $id data &&
 	flux job kill -s SIGKILL $id &&
 	flux job wait-event $id finish >kill2.finish.out &&
 	grep status=$((9+128<<8)) kill2.finish.out
 '
 test_expect_success 'job-shell: test shell kill event handling: numeric signal' '
 	id=$(flux submit -n4 -N4 ./sleepinf.sh) &&
-	flux job wait-event -p guest.exec.eventlog $id shell.init &&
-	flux job wait-event -p guest.output $id data &&
+	flux job wait-event -p exec $id shell.init &&
+	flux job wait-event -p output $id data &&
 	flux job kill -s 2 $id &&
 	flux job wait-event $id finish >kill3.finish.out &&
 	grep status=$((2+128<<8)) kill3.finish.out
 '
 test_expect_success 'job-shell: mangled shell kill event logged' '
 	id=$(flux submit -n4 -N4 ./sleepinf.sh | flux job id) &&
-	flux job wait-event -p guest.exec.eventlog $id shell.init &&
-	flux job wait-event -p guest.output $id data &&
+	flux job wait-event -p exec $id shell.init &&
+	flux job wait-event -p output $id data &&
 	flux event pub shell-${id}.kill "{}" &&
 	flux job kill ${id} &&
 	flux job wait-event -vt 1 $id finish >kill4.finish.out &&
@@ -236,8 +236,8 @@ test_expect_success 'job-shell: mangled shell kill event logged' '
 '
 test_expect_success 'job-shell: shell kill event: kill(2) failure logged' '
 	id=$(flux submit -n4 -N4 ./sleepinf.sh | flux job id) &&
-	flux job wait-event -p guest.exec.eventlog $id shell.init &&
-	flux job wait-event -p guest.output $id data &&
+	flux job wait-event -p exec $id shell.init &&
+	flux job wait-event -p output $id data &&
 	flux event pub shell-${id}.kill "{\"signum\":199}" &&
 	flux job kill ${id} &&
 	flux job wait-event $id finish >kill5.finish.out &&