Merge pull request #7058 from garlick/issue#7034

flux-job: remove cancel[all] subcommands

Author: mergify[bot]

src/cmd/Makefile.am

@@ -160,7 +160,7 @@ flux_job_SOURCES = \
 	job/id.c \
 	job/namespace.c \
 	job/urgency.c \
-	job/cancel.c \
+	job/kill.c \
 	job/eventlog.c \
 	job/info.c \
 	job/stats.c \

src/cmd/job/cancel.c src/cmd/job/kill.csrc/cmd/job/cancel.c renamed to src/cmd/job/kill.c

@@ -8,7 +8,7 @@
  * SPDX-License-Identifier: LGPL-3.0
 \************************************************************/
 
-/* flux-job raise/cancel/kill */
+/* flux-job raise/kill */
 
 #if HAVE_CONFIG_H
 #include "config.h"
@@ -26,30 +26,6 @@
 #include "ccan/str/str.h"
 #include "common.h"
 
-struct optparse_option cancel_opts[] =  {
-    { .name = "message", .key = 'm', .has_arg = 1, .arginfo = "NOTE",
-      .usage = "Set cancel exception note",
-    },
-    OPTPARSE_TABLE_END
-};
-
-struct optparse_option cancelall_opts[] =  {
-    { .name = "user", .key = 'u', .has_arg = 1, .arginfo = "USER",
-      .usage = "Set target user or 'all' (instance owner only)",
-    },
-    { .name = "states", .key = 'S', .has_arg = 1, .arginfo = "STATES",
-      .flags = OPTPARSE_OPT_AUTOSPLIT,
-      .usage = "Set target job states (default=ACTIVE)",
-    },
-    { .name = "force", .key = 'f', .has_arg = 0,
-      .usage = "Confirm the command",
-    },
-    { .name = "quiet", .key = 'q', .has_arg = 0,
-      .usage = "Suppress output if no jobs match",
-    },
-    OPTPARSE_TABLE_END
-};
-
 struct optparse_option raise_opts[] =  {
     { .name = "severity", .key = 's', .has_arg = 1, .arginfo = "N",
       .usage = "Set exception severity [0-7] (default=0)",
@@ -449,98 +425,5 @@ int cmd_killall (optparse_t *p, int argc, char **argv)
     return 0;
 }
 
-int cmd_cancel (optparse_t *p, int argc, char **argv)
-{
-    int optindex = optparse_option_index (p);
-    flux_t *h;
-    char *note = NULL;
-    zlistx_t *args;
-    struct jobid_arg *arg;
-    flux_future_t *f;
-    int rc = 0;
-
-    if (argc - optindex < 1) {
-        optparse_print_usage (p);
-        exit (1);
-    }
-
-    parse_jobids_and_note (p, argv + optindex, &args, &note);
-
-    fprintf (stderr,
-             "WARNING: this command is deprecated.  Use flux-cancel(1).\n");
-
-    if (!(h = flux_open (NULL, 0)))
-        log_err_exit ("flux_open");
-
-    if (!(f = flux_future_wait_all_create ()))
-        log_err_exit ("flux_future_wait_all_create");
-    flux_future_set_flux (f, h);
-
-    arg = zlistx_first (args);
-    while (arg) {
-        flux_future_t *rf = flux_job_cancel (h, arg->id, note);
-        if (!rf || flux_future_push (f, arg->arg, rf) < 0)
-            log_err_exit ("flux_job_cancel");
-        arg = zlistx_next (args);
-    }
-    rc = wait_all_check (f, "cancel");
-
-    zlistx_destroy (&args);
-    flux_future_destroy (f);
-    flux_close (h);
-    free (note);
-    return rc;
-}
-
-int cmd_cancelall (optparse_t *p, int argc, char **argv)
-{
-    int optindex = optparse_option_index (p);
-    uint32_t userid;
-    int state_mask;
-    flux_t *h;
-    char *note = NULL;
-    int dry_run = 1;
-    int count;
-    int errors;
-
-    if (optindex < argc)
-        note = parse_arg_message (argv + optindex, "message");
-    if (optparse_hasopt (p, "states")) {
-        state_mask = parse_arg_states (p, "states");
-        if ((state_mask & FLUX_JOB_STATE_INACTIVE))
-            log_msg_exit ("Inactive jobs cannot be canceled");
-    }
-    else
-        state_mask = FLUX_JOB_STATE_ACTIVE;
-    if (optparse_hasopt (p, "user"))
-        userid = parse_arg_userid (p, "user");
-    else
-        userid = getuid ();
-    if (optparse_hasopt (p, "force"))
-        dry_run = 0;
-    fprintf (stderr,
-             "WARNING: this command is deprecated.  Use flux-cancel(1).\n");
-    if (!(h = flux_open (NULL, 0)))
-        log_err_exit ("flux_open");
-    count = raiseall (h,
-                      dry_run,
-                      userid,
-                      state_mask,
-                      0,
-                      "cancel",
-                      note,
-                      &errors);
-    if (count > 0 && dry_run)
-        log_msg ("Command matched %d jobs (-f to confirm)", count);
-    else if (count > 0 && !dry_run)
-        log_msg ("Canceled %d jobs (%d errors)", count, errors);
-    else if (!optparse_hasopt (p, "quiet"))
-        log_msg ("Command matched 0 jobs");
-    flux_close (h);
-    free (note);
-    return 0;
-}
-
-
 /* vi: ts=4 sw=4 expandtab
  */

src/cmd/job/main.c

@@ -46,12 +46,6 @@ extern int cmd_namespace (optparse_t *p, int argc, char **argv);
 extern int cmd_urgency (optparse_t *p, int argc, char **argv);
 extern struct optparse_option urgency_opts[];
 
-extern int cmd_cancel (optparse_t *p, int argc, char **argv);
-extern struct optparse_option cancel_opts[];
-
-extern int cmd_cancelall (optparse_t *p, int argc, char **argv);
-extern struct optparse_option cancelall_opts[];
-
 extern int cmd_raise (optparse_t *p, int argc, char **argv);
 extern struct optparse_option raise_opts[];
 
@@ -128,20 +122,6 @@ static struct optparse_subcommand subcommands[] = {
       0,
       urgency_opts,
     },
-    { "cancel",
-      "[OPTIONS] ids... [--] [message ...]",
-      "Cancel one or more jobs",
-      cmd_cancel,
-      OPTPARSE_SUBCMD_HIDDEN,
-      cancel_opts,
-    },
-    { "cancelall",
-      "[OPTIONS] [message ...]",
-      "Cancel multiple jobs",
-      cmd_cancelall,
-      OPTPARSE_SUBCMD_HIDDEN,
-      cancelall_opts,
-    },
     { "raise",
       "[OPTIONS] ids... [--] [message ...]",
       "Raise exception on one or more jobs",

t/t2201-job-cmd.t

@@ -286,7 +286,7 @@ test_expect_success 'flux-job: raise --severity works' '
 	flux job raise --severity=5 ${id} &&
 	flux job wait-event -t 30 ${id} exception >raise3.out &&
 	grep "severity\=5" raise3.out &&
-	flux job cancel ${id}
+	flux cancel ${id}
 '
 
 test_expect_success 'flux-job: raise --message works' '
@@ -303,56 +303,6 @@ test_expect_success ' flux-job: raise message works (cmdline)' '
 	grep "eep ork ook" raise5.out
 '
 
-test_expect_success 'flux-job: cancel fails with bad FLUX_URI' '
-	(FLUX_URI=/wrong test_must_fail flux job cancel ${validjob})
-'
-
-test_expect_success 'flux-job: cancel fails with unknown job id' '
-	test_must_fail flux job cancel 0
-'
-
-test_expect_success 'flux-job: cancel fails with unknown job ids' '
-	test_must_fail flux job cancel 0 f123
-'
-
-test_expect_success 'flux-job: cancel fails if note set twice' '
-	test_must_fail flux job cancel --message=hi ${validjob} -- hello
-'
-
-test_expect_success 'flux-job: cancel fails with no args' '
-	test_must_fail flux job cancel
-'
-
-test_expect_success 'flux-job: cancel fails with invalid jobid' '
-	test_must_fail flux job cancel foo
-'
-
-test_expect_success 'flux-job: cancel fails with invalid option' '
-	test_must_fail flux job cancel --meep foo
-'
-
-test_expect_success 'flux-job: cancel basic works' '
-	id=$(flux submit sleep 100) &&
-	flux job cancel ${id} &&
-	flux job wait-event -t 30 ${id} exception >cancel1.out &&
-	grep "cancel" cancel1.out &&
-	grep "severity\=0" cancel1.out
-'
-
-test_expect_success 'flux-job: cancel --message works' '
-	id=$(flux submit sleep 100) &&
-	flux job cancel --message=meepmessage ${id} &&
-	flux job wait-event -t 30 ${id} exception >cancel2.out &&
-	grep "meepmessage" cancel2.out
-'
-
-test_expect_success ' flux-job: cancel message works (cmdline)' '
-	id=$(flux submit sleep 100) &&
-	flux job cancel ${id} -- foo loo moo &&
-	flux job wait-event -t 30 ${id} exception >cancel3.out &&
-	grep "foo loo moo" cancel3.out
-'
-
 test_expect_success 'flux-job: list fails with bad FLUX_URI' '
 	(FLUX_URI=/wrong test_must_fail flux job list)
 '
@@ -499,65 +449,11 @@ test_expect_success 'flux job: the queue contains active jobs' '
 	test ${count} -gt 0
 '
 
-test_expect_success 'flux job: cancelall with no args works' '
-	count=$(flux job list | wc -l) &&
-	flux job cancelall 2>cancelall.tmp &&
-	grep -v WARNING cancelall.tmp >cancelall.err &&
-	cat <<-EOT >cancelall.exp &&
-	flux-job: Command matched ${count} jobs (-f to confirm)
-	EOT
-	test_cmp cancelall.exp cancelall.err
-'
-
-test_expect_success 'flux-job: cancelall with bad broker connection fails' '
-	(FLUX_URI=/wrong test_must_fail flux job cancelall)
-'
-
-test_expect_success 'flux job: cancelall with reason works' '
-	flux job cancelall this is a reason 2>cancelall_reason.tmp &&
-	grep -v WARNING cancelall_reason.tmp >cancelall_reason.err &&
-	test_cmp cancelall.exp cancelall_reason.err
-'
-
-test_expect_success 'flux job: cancelall --force works' '
-	count=$(flux job list | wc -l) &&
-	flux job cancelall --force 2>cancelall_f.tmp &&
-	grep -v WARNING cancelall_f.tmp >cancelall_f.err &&
-	cat <<-EOT >cancelall_f.exp &&
-	flux-job: Canceled ${count} jobs (0 errors)
-	EOT
-	test_cmp cancelall_f.exp cancelall_f.err
-'
-
-test_expect_success 'flux job: the queue is empty' '
+test_expect_success 'clear out the queue' '
+	flux cancel --all &&
 	run_timeout 60 flux queue drain
 '
 
-test_expect_success 'flux-job: cancelall --user all fails for guest' '
-	id=$(($(id -u)+1)) &&
-	test_must_fail runas ${id} \
-		flux job cancelall --user all 2> cancelall_all_guest.tmp &&
-	grep -v WARNING cancelall_all_guest.tmp >cancelall_all_guest.err &&
-	cat <<-EOF >cancelall_all_guest.exp &&
-	flux-job: raiseall: guests can only raise exceptions on their own jobs
-	EOF
-	test_cmp cancelall_all_guest.exp cancelall_all_guest.err
-'
-
-test_expect_success 'flux-job: cancelall --user <guest uid> works for guest' '
-	id=$(($(id -u)+1)) &&
-	runas ${id} \
-		flux job cancelall --user ${id} 2> cancelall_guest.err
-'
-
-test_expect_success 'flux job: cancelall with unknown state fails' '
-	test_must_fail flux job cancelall --states=FOO 2>cancelall_bs.err &&
-	cat <<-EOT >cancelall_bs.exp &&
-	flux-job: error parsing --states: FOO is unknown
-	EOT
-	test_cmp cancelall_bs.exp cancelall_bs.err
-'
-
 test_expect_success 'flux job: raiseall with no args prints Usage' '
 	test_must_fail flux job raiseall 2>raiseall_na.err &&
 	grep Usage: raiseall_na.err
@@ -667,16 +563,8 @@ test_expect_success 'flux-job: raiseall -f returns correct count' '
 	test_cmp raiseall_testf.exp raiseall_testf.err
 '
 
-test_expect_success 'flux-job: cancelall -f returns correct count' '
-	flux job cancelall -f 2>cancelall_testf.tmp &&
-	grep -v WARNING cancelall_testf.tmp >cancelall_testf.err &&
-	cat <<-EOT >cancelall_testf.exp &&
-	flux-job: Canceled 3 jobs (0 errors)
-	EOT
-	test_cmp cancelall_testf.exp cancelall_testf.err
-'
-
-test_expect_success 'flux job: the queue is empty' '
+test_expect_success 'empty the queue' '
+	flux cancel --all &&
 	run_timeout 60 flux queue drain
 '
 test_expect_success 'flux job: retrieve eventlogs' '
@@ -727,19 +615,6 @@ test_expect_success 'flux job: killall -f kills one job' '
 	run_timeout 60 flux queue drain
 '
 
-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 exec $id shell.init
-	done &&
-	flux job cancel ${ids} cancel multiple jobs &&
-	for id in ${ids}; do
-		flux job wait-event -t 30 ${id} exception >exception.out &&
-		grep multiple exception.out
-	done
-'
-
 test_expect_success 'flux job: raise can operate on multiple jobs' '
 	ids=$(flux submit --bcc=1-3 sleep 600) &&
 	flux job raise ${ids} raise multiple jobs &&