mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-12 22:10:25 +00:00
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/<pull request number>.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 <mfenniak@noreply.codeberg.org> Co-authored-by: Michael Kriese <michael.kriese@visualon.de> Co-committed-by: Michael Kriese <michael.kriese@visualon.de>
This commit is contained in:
Michael Kriese
Mathieu Fenniak
parent
d499c3b132
commit
e7d4ecadf3
6 changed files with 183 additions and 8 deletions
|
|
@ -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)
|
||||
|
|
|
|||
113
routers/api/v1/repo/action_test.go
Normal file
113
routers/api/v1/repo/action_test.go
Normal file
|
|
@ -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)
|
||||
})
|
||||
})
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue