New endpoint: job/:id/actions #18690

philrenaud · 2023-10-06T21:02:00Z

Adds a new endpoint: /job/:id/actions

It parses through a job's taskgroups' tasks, and extracts their actions up to a single flat array with the name of task and taskGroup included as fields.

$ nomad operator api '/v1/job/actions-demo/actions' | jq
[
  {
    "Args": [
      "parrot.live"
    ],
    "Command": "/usr/bin/curl",
    "Name": "party",
    "TaskGroupName": "group",
    "TaskName": "task"
  },
  {
    "Args": [
      "ipinfo.io"
    ],
    "Command": "/usr/bin/curl",
    "Name": "ipinfo",
    "TaskGroupName": "group",
    "TaskName": "task"
  },
  {
    "Args": [
      "parrot.live"
    ],
    "Command": "/usr/bin/curl",
    "Name": "party",
    "TaskGroupName": "group",
    "TaskName": "task2"
  },
...
]

Resolves #18680

tgross

Overall this looks pretty good @philrenaud. I've left some comments on a few areas we can clean things up or improve validation.

command/agent/job_endpoint.go

nomad/mock/job.go

nomad/job_endpoint.go

command/agent/job_endpoint_test.go

tgross · 2023-10-10T19:18:46Z

command/agent/job_endpoint_test.go

+			t.Fatalf("err: %v", err)
+		}
+
+		// Check the output


Something to consider for this set of assertions is that the slice of actions will always get returned in the same order. So you should be able to compare against a fix slice of outputs. Something like:

must.Len(t, 10, actionsResp3) must.Eq(t, []string{"date test", "echo test",....}, helper.ConvertSlice(actionsResp, func(a *Action) string { return a.Name })) must.Eq(t, []string{"", "g", "g", "",....}, helper.ConvertSlice(actionsResp, func(a *Action) string { return a.TaskGroupName }))

tgross

LGTM!

There's some outstanding comments still but they're basically about style.

command/agent/job_endpoint.go

* unused param in action converter * backing out of parse_job level and moved toward new endpoint level * Adds taskName and taskGroupName to actions at job level * Unmodified job mock actions tests * actionless job test * actionless job test * Multi group multi task actions test * HTTP method check for GET, cleaner errors in job_endpoint_test * decomment

* Scaffolding actions (#18639) * Task-level actions for job submissions and retrieval * FIXME: Temporary workaround to get ember dev server to pass exec through to 4646 * Update api/tasks.go Co-authored-by: Tim Gross <tgross@hashicorp.com> * Update command/agent/job_endpoint.go Co-authored-by: Tim Gross <tgross@hashicorp.com> * Diff and copy implementations * Action structs get their own file, diff updates to behave like our other diffs * Test to observe actions changes in a version update * Tests migrated into structs/diff_test and modified with PR comments in mind * APIActionToSTructsAction now returns a new value * de-comment some plain parts, remove unused action lookup * unused param in action converter --------- Co-authored-by: Tim Gross <tgross@hashicorp.com> * New endpoint: job/:id/actions (#18690) * unused param in action converter * backing out of parse_job level and moved toward new endpoint level * Adds taskName and taskGroupName to actions at job level * Unmodified job mock actions tests * actionless job test * actionless job test * Multi group multi task actions test * HTTP method check for GET, cleaner errors in job_endpoint_test * decomment * Actions aggregated at job model level (#18733) * Removal of temporary fix to proxy to 4646 * Run Action websocket endpoint (#18760) * Working demo for review purposes * removal of cors passthru for websockets * Remove job_endpoint-specific ws handlers and aimed at existing alloc exec handlers instead * PR comments adressed, no need for taskGroup pass, better group and task lookups from alloc * early return in action validate and removed jobid from req args per PR comments * todo removal, we're checking later in the rpc * boolean style change on tty * Action CLI command (#18778) * Action command init and stuck-notes * Conditional reqpath to aim at Job action endpoint * De-logged * General CLI command cleanup, observe namespace, pass action as string, get random alloc w group adherence * tab and varname cleanup * Remove action param from Allocations().Exec calls * changelog * dont nil-check acl --------- Co-authored-by: Tim Gross <tgross@hashicorp.com>

* Scaffolding actions (hashicorp#18639) * Task-level actions for job submissions and retrieval * FIXME: Temporary workaround to get ember dev server to pass exec through to 4646 * Update api/tasks.go Co-authored-by: Tim Gross <tgross@hashicorp.com> * Update command/agent/job_endpoint.go Co-authored-by: Tim Gross <tgross@hashicorp.com> * Diff and copy implementations * Action structs get their own file, diff updates to behave like our other diffs * Test to observe actions changes in a version update * Tests migrated into structs/diff_test and modified with PR comments in mind * APIActionToSTructsAction now returns a new value * de-comment some plain parts, remove unused action lookup * unused param in action converter --------- Co-authored-by: Tim Gross <tgross@hashicorp.com> * New endpoint: job/:id/actions (hashicorp#18690) * unused param in action converter * backing out of parse_job level and moved toward new endpoint level * Adds taskName and taskGroupName to actions at job level * Unmodified job mock actions tests * actionless job test * actionless job test * Multi group multi task actions test * HTTP method check for GET, cleaner errors in job_endpoint_test * decomment * Actions aggregated at job model level (hashicorp#18733) * Removal of temporary fix to proxy to 4646 * Run Action websocket endpoint (hashicorp#18760) * Working demo for review purposes * removal of cors passthru for websockets * Remove job_endpoint-specific ws handlers and aimed at existing alloc exec handlers instead * PR comments adressed, no need for taskGroup pass, better group and task lookups from alloc * early return in action validate and removed jobid from req args per PR comments * todo removal, we're checking later in the rpc * boolean style change on tty * Action CLI command (hashicorp#18778) * Action command init and stuck-notes * Conditional reqpath to aim at Job action endpoint * De-logged * General CLI command cleanup, observe namespace, pass action as string, get random alloc w group adherence * tab and varname cleanup * Remove action param from Allocations().Exec calls * changelog * dont nil-check acl --------- Co-authored-by: Tim Gross <tgross@hashicorp.com>

philrenaud self-assigned this Oct 6, 2023

vercel bot deployed to Preview – nomad-storybook-and-ui October 6, 2023 21:04 View deployment

vercel bot deployed to Preview – nomad-storybook-and-ui October 7, 2023 01:27 View deployment

philrenaud force-pushed the 18680-action-at-job-level-go branch from 594bf60 to 5cd0765 Compare October 7, 2023 01:30

vercel bot deployed to Preview – nomad-storybook-and-ui October 7, 2023 01:33 View deployment

philrenaud force-pushed the 18680-action-at-job-level-go branch from 5cd0765 to ae8f15e Compare October 10, 2023 17:23

vercel bot deployed to Preview – nomad-storybook-and-ui October 10, 2023 17:26 View deployment

vercel bot deployed to Preview – nomad-storybook-and-ui October 10, 2023 18:46 View deployment

philrenaud marked this pull request as ready for review October 10, 2023 18:47

tgross reviewed Oct 10, 2023

View reviewed changes

philrenaud requested a review from angrycub October 11, 2023 13:44

philrenaud force-pushed the 18680-action-at-job-level-go branch from af295bc to 0b66706 Compare October 11, 2023 13:47

philrenaud requested a review from tgross October 11, 2023 13:48

vercel bot deployed to Preview – nomad-storybook-and-ui October 11, 2023 13:53 View deployment

philrenaud force-pushed the 18680-action-at-job-level-go branch from 0b66706 to 572cc21 Compare October 11, 2023 13:55

vercel bot deployed to Preview – nomad-storybook-and-ui October 11, 2023 13:59 View deployment

philrenaud force-pushed the 18680-action-at-job-level-go branch from 572cc21 to e4be6fd Compare October 11, 2023 14:27

vercel bot deployed to Preview – nomad-storybook-and-ui October 11, 2023 14:29 View deployment

philrenaud force-pushed the 18627-scaffolding-task-actions branch from f5de743 to 817667b Compare October 11, 2023 14:37

Base automatically changed from 18627-scaffolding-task-actions to 18627-task-actions October 11, 2023 20:36

philrenaud changed the base branch from 18627-task-actions to 18627-scaffolding-task-actions October 11, 2023 20:46

philrenaud added 8 commits October 11, 2023 16:48

unused param in action converter

a466d3d

backing out of parse_job level and moved toward new endpoint level

3a68e95

Adds taskName and taskGroupName to actions at job level

0195c4d

Unmodified job mock actions tests

654940f

actionless job test

075e446

actionless job test

526eae5

Multi group multi task actions test

7e2e647

HTTP method check for GET, cleaner errors in job_endpoint_test

2aa840c

philrenaud changed the base branch from 18627-scaffolding-task-actions to 18627-task-actions October 11, 2023 20:49

philrenaud force-pushed the 18680-action-at-job-level-go branch from e4be6fd to 2aa840c Compare October 11, 2023 20:49

vercel bot deployed to Preview – nomad-storybook-and-ui October 11, 2023 20:52 View deployment

tgross approved these changes Oct 12, 2023

View reviewed changes

command/agent/job_endpoint.go Outdated Show resolved Hide resolved

decomment

5954731

philrenaud merged commit ae4e343 into 18627-task-actions Oct 12, 2023
7 of 8 checks passed

philrenaud deleted the 18680-action-at-job-level-go branch October 12, 2023 22:41

vercel bot deployed to Preview – nomad-storybook-and-ui October 12, 2023 22:42 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New endpoint: job/:id/actions #18690

New endpoint: job/:id/actions #18690

philrenaud commented Oct 6, 2023 •

edited

Loading

tgross left a comment

tgross Oct 10, 2023

tgross left a comment

New endpoint: job/:id/actions #18690

New endpoint: job/:id/actions #18690

Conversation

philrenaud commented Oct 6, 2023 • edited Loading

tgross left a comment

Choose a reason for hiding this comment

tgross Oct 10, 2023

Choose a reason for hiding this comment

tgross left a comment

Choose a reason for hiding this comment

philrenaud commented Oct 6, 2023 •

edited

Loading