From e7d4ecadf32a7a789b42b1e28e87748a7f1f49ba Mon Sep 17 00:00:00 2001 From: Michael Kriese Date: Tue, 10 Mar 2026 01:20:00 +0100 Subject: [PATCH] feat: add more filters to actions run and tasks api (#11584) The new filters are especially useful for status monotoring like kuma to have more relevant results. The wrong status check seems to be a regression of #6300 ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests for Go changes (can be removed for JavaScript changes) - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I ran... - [x] `make pr-go` before pushing ### Tests for JavaScript changes (can be removed for Go changes) - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [ ] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11584 Reviewed-by: Mathieu Fenniak Co-authored-by: Michael Kriese Co-committed-by: Michael Kriese --- models/actions/task_list.go | 3 +- models/fixtures/action_run.yml | 14 ++-- routers/api/v1/repo/action.go | 27 ++++++ routers/api/v1/repo/action_test.go | 113 ++++++++++++++++++++++++++ services/contexttest/context_tests.go | 9 ++ templates/swagger/v1_json.tmpl | 25 ++++++ 6 files changed, 183 insertions(+), 8 deletions(-) create mode 100644 routers/api/v1/repo/action_test.go diff --git a/models/actions/task_list.go b/models/actions/task_list.go index 6c565410d9..f85e17b41b 100644 --- a/models/actions/task_list.go +++ b/models/actions/task_list.go @@ -1,4 +1,5 @@ // Copyright 2022 The Gitea Authors. All rights reserved. +// Copyright 2026 The Forgejo Authors. All rights reserved. // SPDX-License-Identifier: MIT package actions @@ -70,7 +71,7 @@ func (opts FindTaskOptions) ToConds() builder.Cond { if opts.CommitSHA != "" { cond = cond.And(builder.Eq{"commit_sha": opts.CommitSHA}) } - if opts.Status != nil { + if len(opts.Status) > 0 { cond = cond.And(builder.In("status", opts.Status)) } if opts.UpdatedBefore > 0 { diff --git a/models/fixtures/action_run.yml b/models/fixtures/action_run.yml index 41559ef788..e37fb2f955 100644 --- a/models/fixtures/action_run.yml +++ b/models/fixtures/action_run.yml @@ -2,7 +2,7 @@ id: 791 title: "update actions" repo_id: 4 - owner_id: 1 + owner_id: 5 workflow_id: "artifact.yaml" index: 187 trigger_user_id: 1 @@ -210,7 +210,7 @@ id: 792 title: "update actions" repo_id: 4 - owner_id: 1 + owner_id: 5 workflow_id: "artifact.yaml" index: 188 trigger_user_id: 1 @@ -417,7 +417,7 @@ id: 793 title: "job output" repo_id: 4 - owner_id: 1 + owner_id: 5 workflow_id: "test.yaml" index: 189 trigger_user_id: 1 @@ -436,7 +436,7 @@ id: 794 title: "job output" repo_id: 4 - owner_id: 1 + owner_id: 5 workflow_id: "test.yaml" index: 190 trigger_user_id: 1 @@ -455,7 +455,7 @@ id: 891 title: "update actions" repo_id: 1 - owner_id: 1 + owner_id: 5 workflow_id: "artifact.yaml" index: 187 trigger_user_id: 1 @@ -538,7 +538,7 @@ id: 895 title: "job output" repo_id: 4 - owner_id: 1 + owner_id: 5 workflow_id: "test.yaml" index: 191 trigger_user_id: 1 @@ -558,7 +558,7 @@ id: 896 title: "job output" repo_id: 4 - owner_id: 1 + owner_id: 5 workflow_id: "test.yaml" index: 192 trigger_user_id: 1 diff --git a/routers/api/v1/repo/action.go b/routers/api/v1/repo/action.go index 85726c72a1..ab049e4383 100644 --- a/routers/api/v1/repo/action.go +++ b/routers/api/v1/repo/action.go @@ -1,4 +1,5 @@ // Copyright 2023 The Gitea Authors. All rights reserved. +// Copyright 2026 The Forgejo Authors. All rights reserved. // SPDX-License-Identifier: MIT package repo @@ -710,6 +711,15 @@ func ListActionTasks(ctx *context.APIContext) { // in: query // description: page size of results, default maximum page size is 50 // type: integer + // - name: status + // in: query + // description: | + // Returns workflow tasks with the check run status or conclusion that is specified. + // For example, a conclusion can be success or a status can be in_progress. + // type: array + // items: + // type: string + // enum: [unknown, waiting, running, success, failure, cancelled, skipped, blocked] // responses: // "200": // "$ref": "#/responses/TasksList" @@ -724,9 +734,21 @@ func ListActionTasks(ctx *context.APIContext) { // "422": // "$ref": "#/responses/validationError" + statusStrs := ctx.FormStrings("status") + statuses := make([]actions_model.Status, len(statusStrs)) + for i, s := range statusStrs { + if status, exists := actions_model.StatusFromString(s); exists { + statuses[i] = status + } else { + ctx.Error(http.StatusBadRequest, "StatusFromString", fmt.Sprintf("unknown status: %s", s)) + return + } + } + tasks, total, err := db.FindAndCount[actions_model.ActionTask](ctx, &actions_model.FindTaskOptions{ ListOptions: utils.GetListOptions(ctx), RepoID: ctx.Repo.Repository.ID, + Status: statuses, }) if err != nil { ctx.Error(http.StatusInternalServerError, "ListActionTasks", err) @@ -886,6 +908,10 @@ func ListActionRuns(ctx *context.APIContext) { // in: query // description: Only return workflow runs that involve the given Git reference, for example, `refs/heads/main`. // type: string + // - name: workflow_id + // in: query + // description: Only return workflow runs that involve the given workflow ID. + // type: string // responses: // "200": // "$ref": "#/responses/ActionRunList" @@ -914,6 +940,7 @@ func ListActionRuns(ctx *context.APIContext) { RunNumber: ctx.FormInt64("run_number"), CommitSHA: ctx.FormString("head_sha"), Ref: ctx.FormString("ref"), + WorkflowID: ctx.FormString("workflow_id"), }) if err != nil { ctx.Error(http.StatusInternalServerError, "ListActionRuns", err) diff --git a/routers/api/v1/repo/action_test.go b/routers/api/v1/repo/action_test.go new file mode 100644 index 0000000000..80391ef640 --- /dev/null +++ b/routers/api/v1/repo/action_test.go @@ -0,0 +1,113 @@ +// Copyright 2026 The Forgejo Authors. All rights reserved. +// SPDX-License-Identifier: GPL-3.0-or-later + +package repo + +import ( + "net/http" + "testing" + + "forgejo.org/models/unittest" + api "forgejo.org/modules/structs" + "forgejo.org/services/contexttest" + + "github.com/stretchr/testify/assert" +) + +func TestActions(t *testing.T) { + unittest.PrepareTestEnv(t) + + t.Run("ListActionRuns", func(t *testing.T) { + t.Run("paging", func(t *testing.T) { + var runResp api.ListActionRunResponse + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/runs") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("limit", "1") + ctx.SetFormString("page", "1") + + ListActionRuns(ctx) + assert.Equal(t, http.StatusOK, resp.Code) + contexttest.DecodeJSON(t, resp, &runResp) + assert.Len(t, runResp.Entries, 1) + assert.Equal(t, int64(6), runResp.TotalCount) + }) + + t.Run("invalid status filter", func(t *testing.T) { + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/runs") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("status", "some-invalid-value") + ListActionRuns(ctx) + assert.Equal(t, http.StatusBadRequest, resp.Code) + }) + + t.Run("filtered by status", func(t *testing.T) { + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/runs") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("status", "failure") + + ListActionRuns(ctx) + assert.Equal(t, http.StatusOK, resp.Code) + var runResp api.ListActionRunResponse + contexttest.DecodeJSON(t, resp, &runResp) + assert.Len(t, runResp.Entries, 2) + assert.Equal(t, int64(2), runResp.TotalCount) + }) + + t.Run("filtered by workflow_id", func(t *testing.T) { + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/runs") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("workflow_id", "some.yml") + + ListActionRuns(ctx) + assert.Equal(t, http.StatusOK, resp.Code) + var runResp api.ListActionRunResponse + contexttest.DecodeJSON(t, resp, &runResp) + assert.Empty(t, runResp.Entries) + assert.Equal(t, int64(0), runResp.TotalCount) + }) + }) + + t.Run("ListActionTasks", func(t *testing.T) { + t.Run("paging", func(t *testing.T) { + var taskResp api.ActionTaskResponse + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/tasks") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("limit", "1") + ctx.SetFormString("page", "1") + + ListActionTasks(ctx) + assert.Equal(t, http.StatusOK, resp.Code) + contexttest.DecodeJSON(t, resp, &taskResp) + assert.Len(t, taskResp.Entries, 1) + assert.Equal(t, int64(12), taskResp.TotalCount) + }) + + t.Run("invalid status filter", func(t *testing.T) { + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/tasks") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("status", "some-invalid-value") + ListActionTasks(ctx) + assert.Equal(t, http.StatusBadRequest, resp.Code) + }) + + t.Run("filtered by status", func(t *testing.T) { + ctx, resp := contexttest.MockAPIContext(t, "user5/repo4/actions/tasks") + contexttest.LoadRepo(t, ctx, 4) + + ctx.SetFormString("status", "failure") + + ListActionTasks(ctx) + assert.Equal(t, http.StatusOK, resp.Code) + var taskResp api.ActionTaskResponse + contexttest.DecodeJSON(t, resp, &taskResp) + assert.Len(t, taskResp.Entries, 2) + assert.Equal(t, int64(2), taskResp.TotalCount) + }) + }) +} diff --git a/services/contexttest/context_tests.go b/services/contexttest/context_tests.go index a4e674a896..0da87ca35c 100644 --- a/services/contexttest/context_tests.go +++ b/services/contexttest/context_tests.go @@ -1,4 +1,5 @@ // Copyright 2017 The Gitea Authors. All rights reserved. +// Copyright 2026 The Forgejo Authors. All rights reserved. // SPDX-License-Identifier: MIT // Package contexttest provides utilities for testing Web/API contexts with models. @@ -21,6 +22,7 @@ import ( "forgejo.org/models/unittest" user_model "forgejo.org/models/user" "forgejo.org/modules/gitrepo" + "forgejo.org/modules/json" "forgejo.org/modules/templates" "forgejo.org/modules/translation" "forgejo.org/modules/web/middleware" @@ -206,3 +208,10 @@ func (tr *MockRender) HTML(w io.Writer, status int, _ string, _ any, _ gocontext } return nil } + +func DecodeJSON(t testing.TB, resp *httptest.ResponseRecorder, v any) { + t.Helper() + + decoder := json.NewDecoder(resp.Body) + require.NoError(t, decoder.Decode(v)) +} diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index d72142016a..7a800cc171 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -5787,6 +5787,12 @@ "description": "Only return workflow runs that involve the given Git reference, for example, `refs/heads/main`.", "name": "ref", "in": "query" + }, + { + "type": "string", + "description": "Only return workflow runs that involve the given workflow ID.", + "name": "workflow_id", + "in": "query" } ], "responses": { @@ -6042,6 +6048,25 @@ "description": "page size of results, default maximum page size is 50", "name": "limit", "in": "query" + }, + { + "type": "array", + "items": { + "enum": [ + "unknown", + "waiting", + "running", + "success", + "failure", + "cancelled", + "skipped", + "blocked" + ], + "type": "string" + }, + "description": "Returns workflow tasks with the check run status or conclusion that is specified.\n For example, a conclusion can be success or a status can be in_progress.\n", + "name": "status", + "in": "query" } ], "responses": {