Skip to content

Commit

Permalink
Merge pull request #2137 from chu11/issue2083
Browse files Browse the repository at this point in the history 
flux-job: Add context test in wait-event
  • Loading branch information
@garlick
garlick committed Apr 24, 2019
2 parents 881f236 + 51e3d58 commit a6852e3
Show file tree
Hide file tree
Showing 4 changed files with 119 additions and 9 deletions.
74 changes: 67 additions & 7 deletions src/cmd/flux-job.c
View file
Expand Up @@ -29,6 +29,7 @@
#if HAVE_FLUX_SECURITY
#include <flux/security/sign.h>
#endif
#include "src/common/libutil/xzmalloc.h"
#include "src/common/libutil/log.h"
#include "src/common/libutil/fluid.h"
#include "src/common/libjob/job.h"
Expand Down Expand Up @@ -116,6 +117,9 @@ static struct optparse_option wait_event_opts[] = {
{ .name = "timeout", .key = 't', .has_arg = 1, .arginfo = "DURATION",
.usage = "timeout after DURATION",
},
{ .name = "match-context", .key = 'm', .has_arg = 1, .arginfo = "KEY=VAL",
.usage = "match key=val in context",
},
{ .name = "quiet", .key = 'q', .has_arg = 0,
.usage = "Do not output matched event",
},
Expand Down Expand Up @@ -183,7 +187,7 @@ static struct optparse_subcommand subcommands[] = {
eventlog_opts
},
{ "wait-event",
"[-c text|json] [-t seconds] id event",
"[-c text|json] [-t seconds] [-m key=val] id event",
"Wait for an event ",
cmd_wait_event,
0,
Expand Down Expand Up @@ -763,12 +767,62 @@ struct wait_event_ctx {
flux_jobid_t id;
bool got_event;
const char *format;
char *context_key;
char *context_value;
};

bool wait_event_test_context (struct wait_event_ctx *ctx, json_t *context)
{
void *iter;
bool match = false;

iter = json_object_iter (context);
while (iter && !match) {
const char *key = json_object_iter_key (iter);
json_t *value = json_object_iter_value (iter);
if (!strcmp (key, ctx->context_key)) {
char *str = json_dumps (value, JSON_ENCODE_ANY|JSON_COMPACT);
if (!strcmp (str, ctx->context_value))
match = true;
free (str);
}
/* special case, json_dumps() will put quotes around string
* values. Consider the case when user does not surround
* string value with quotes */
if (!match && json_is_string (value)) {
const char *str = json_string_value (value);
if (!strcmp (str, ctx->context_value))
match = true;
}
iter = json_object_iter_next (context, iter);
}
return match;
}

bool wait_event_test (struct wait_event_ctx *ctx, json_t *event)
{
const char *name;
json_t *context = NULL;
bool match = false;

if (eventlog_entry_parse (event, NULL, &name, &context) < 0)
log_err_exit ("eventlog_entry_parse");

if (!strcmp (name, ctx->wait_event)) {
if (ctx->context_key) {
if (context)
match = wait_event_test_context (ctx, context);
}
else
match = true;
}

return match;
}

void wait_event_continuation (flux_future_t *f, void *arg)
{
struct wait_event_ctx *ctx = arg;
const char *name;
json_t *o = NULL;
const char *event;

Expand Down Expand Up @@ -798,10 +852,7 @@ void wait_event_continuation (flux_future_t *f, void *arg)
if (!(o = eventlog_entry_decode (event)))
log_err_exit ("eventlog_entry_decode");

if (eventlog_entry_parse (o, NULL, &name, NULL) < 0)
log_err_exit ("eventlog_entry_parse");

if (!strcmp (name, ctx->wait_event)) {
if (wait_event_test (ctx, o)) {
ctx->got_event = true;
if (!optparse_hasopt (ctx->p, "quiet"))
output_event (o, ctx->format);
Expand All @@ -827,11 +878,12 @@ int cmd_wait_event (optparse_t *p, int argc, char **argv)
int optindex = optparse_option_index (p);
flux_future_t *f;
struct wait_event_ctx ctx = {0};
const char *str;

if (!(h = flux_open (NULL, 0)))
log_err_exit ("flux_open");

if (argc - optindex != 2) {
if ((argc - optindex) != 2) {
optparse_print_usage (p);
exit (1);
}
Expand All @@ -843,6 +895,13 @@ int cmd_wait_event (optparse_t *p, int argc, char **argv)
if (strcasecmp (ctx.format, "text")
&& strcasecmp (ctx.format, "json"))
log_msg_exit ("invalid format type");
if ((str = optparse_get_str (p, "match-context", NULL))) {
ctx.context_key = xstrdup (str);
ctx.context_value = strchr (ctx.context_key, '=');
if (!ctx.context_value)
log_msg_exit ("must specify a context test as key=value");
*ctx.context_value++ = '\0';
}

if (!(f = flux_job_event_watch (h, ctx.id)))
log_err_exit ("flux_job_event_watch");
Expand All @@ -851,6 +910,7 @@ int cmd_wait_event (optparse_t *p, int argc, char **argv)
if (flux_reactor_run (flux_get_reactor (h), 0) < 0)
log_err_exit ("flux_reactor_run");

free (ctx.context_key);
flux_close (h);
return (0);
}
Expand Down
14 changes: 14 additions & 0 deletions src/common/libeventlog/test/eventlog.c
View file
Expand Up @@ -40,6 +40,20 @@ void eventlog_entry_parsing (void)
"eventlog_entry_parse fails with EINVAL on bad event");
json_decref (event);

event = json_pack ("{ s:f s:s s:[s] }",
"timestamp", 52.0,
"name", "bar",
"context",
"foo", "bar");
if (!event)
BAIL_OUT ("Error creating test json object");

errno = 0;
ok (eventlog_entry_parse (event, NULL, NULL, NULL) < 0
&& errno == EINVAL,
"eventlog_entry_parse fails with EINVAL on bad context");
json_decref (event);

event = json_pack ("{ s:f s:s }",
"timestamp", 42.0,
"name", "foo");
Expand Down
4 changes: 2 additions & 2 deletions t/t2202-job-manager.t
View file
Expand Up @@ -62,7 +62,7 @@ test_expect_success 'job-manager: queue list job with correct priority' '
test_expect_success 'job-manager: raise non-fatal exception on job' '
jobid=$(cat list1_jobid.out) &&
flux job raise --severity=1 --type=testing ${jobid} Mumble grumble &&
flux job wait-event --timeout=5.0 ${jobid} exception &&
flux job wait-event --timeout=5.0 --match-context=type=testing ${jobid} exception &&
flux job eventlog $jobid \
| grep exception >list1_exception.out &&
grep -q "type=\"testing\"" list1_exception.out &&
Expand All @@ -82,7 +82,7 @@ test_expect_success 'job-manager: queue contains 1 jobs' '
test_expect_success 'job-manager: cancel job' '
jobid=$(cat list1_jobid.out) &&
flux job cancel ${jobid} &&
flux job wait-event --timeout=5.0 ${jobid} exception &&
flux job wait-event --timeout=5.0 --match-context=type=cancel ${jobid} exception &&
flux job eventlog $jobid | grep exception \
| grep severity=0 | grep "type=\"cancel\""
'
Expand Down
36 changes: 36 additions & 0 deletions t/t2204-job-info.t
View file
Expand Up @@ -252,6 +252,42 @@ test_expect_success 'flux job wait-event --format=invalid fails' '
! flux job wait-event --format=invalid $jobid submit
'

test_expect_success 'flux job wait-event w/ match-context works (string w/ quotes)' '
jobid=$(submit_job) &&
flux job wait-event --match-context="type=\"cancel\"" $jobid exception > wait_event_context1.out &&
grep -q "exception" wait_event_context1.out &&
grep -q "type=\"cancel\"" wait_event_context1.out
'

test_expect_success 'flux job wait-event w/ match-context works (string w/o quotes)' '
jobid=$(submit_job) &&
flux job wait-event --match-context=type=cancel $jobid exception > wait_event_context2.out &&
grep -q "exception" wait_event_context2.out &&
grep -q "type=\"cancel\"" wait_event_context2.out
'

test_expect_success 'flux job wait-event w/ match-context works (int)' '
jobid=$(submit_job) &&
flux job wait-event --match-context=flags=0 $jobid submit > wait_event_context3.out &&
grep -q "submit" wait_event_context3.out &&
grep -q "flags=0" wait_event_context3.out
'

test_expect_success 'flux job wait-event w/ bad match-context fails (invalid key)' '
jobid=$(submit_job) &&
! run_timeout 0.2 flux job wait-event --match-context=foo=bar $jobid exception
'

test_expect_success 'flux job wait-event w/ bad match-context fails (invalid value)' '
jobid=$(submit_job) &&
! run_timeout 0.2 flux job wait-event --match-context=type=foo $jobid exception
'

test_expect_success 'flux job wait-event w/ bad match-context fails (invalid input)' '
jobid=$(submit_job) &&
! flux job wait-event --match-context=foo $jobid exception
'

#
# job info tests
#
Expand Down

0 comments on commit a6852e3

Please sign in to comment.