jojo/tests/integration/actions_run_test.go
Andreas Ahlenstorf 03312e4f46 feat: make it possible to remove workflow runs (#12478)
Add the ability to remove workflow runs, either using the UI or the HTTP API. Workflow runs can only be removed once a workflow run has completed. For security reasons, only a repository administrator or a token with `write:repository` permissions can remove runs.

Resolves https://codeberg.org/forgejo/forgejo/issues/2184.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). 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.
  - [x] 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.
- [x] 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.

<!--start release-notes-assistant-->

## Release notes
<!--URL:https://codeberg.org/forgejo/forgejo-->
- Features
  - [PR](https://codeberg.org/forgejo/forgejo/pulls/12478): <!--number 12478 --><!--line 0 --><!--description bWFrZSBpdCBwb3NzaWJsZSB0byByZW1vdmUgd29ya2Zsb3cgcnVucw==-->make it possible to remove workflow runs<!--description-->
<!--end release-notes-assistant-->

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12478
Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
2026-05-11 16:02:36 +02:00

123 lines
4.8 KiB
Go

// Copyright 2026 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: GPL-3.0-or-later
package integration
import (
"fmt"
"net/http"
"testing"
actions_model "forgejo.org/models/actions"
repo_model "forgejo.org/models/repo"
"forgejo.org/models/unittest"
user_model "forgejo.org/models/user"
"forgejo.org/tests"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestActionRunDeletion(t *testing.T) {
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1, OwnerID: user2.ID})
user5 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 5})
repo62 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 62, OwnerID: user2.ID})
sessUser2 := loginUser(t, user2.Name)
sessUser5 := loginUser(t, user5.Name)
t.Run("Run removed", func(t *testing.T) {
defer unittest.OverrideFixtures("tests/integration/fixtures/TestActionRunDeletion")()
defer tests.PrepareTestEnv(t)()
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: 34901})
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{RunID: run.ID})
unittest.AssertCount(t, &actions_model.ActionArtifact{RunID: run.ID}, 2)
runner := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunner{ID: 41601})
requestURL := fmt.Sprintf("/%s/actions/runs/%d/delete", repo1.FullName(), run.Index)
request := NewRequest(t, "POST", requestURL)
response := sessUser2.MakeRequest(t, request, http.StatusOK)
assert.JSONEq(t, `{"ok":true}`, response.Body.String())
unittest.AssertNotExistsBean(t, &actions_model.ActionRun{ID: run.ID})
unittest.AssertNotExistsBean(t, &actions_model.ActionRunJob{ID: job.ID})
unittest.AssertCount(t, &actions_model.ActionArtifact{
RunID: run.ID,
Status: int64(actions_model.ArtifactStatusPendingDeletion),
}, 2)
unittest.AssertNotExistsBean(t, &actions_model.ActionRunner{ID: runner.ID})
})
t.Run("Error if run has not completed", func(t *testing.T) {
defer unittest.OverrideFixtures("tests/integration/fixtures/TestActionRunDeletion")()
defer tests.PrepareTestEnv(t)()
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: 34902})
requestURL := fmt.Sprintf("/%s/actions/runs/%d/delete", repo1.FullName(), run.Index)
request := NewRequest(t, "POST", requestURL)
response := sessUser2.MakeRequest(t, request, http.StatusInternalServerError)
assert.JSONEq(t, `{"message":"Could not delete run."}`, response.Body.String())
// Verify that the run still exists.
unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: run.ID})
})
t.Run("Nothing happens if run does not belong to repository", func(t *testing.T) {
defer unittest.OverrideFixtures("tests/integration/fixtures/TestActionRunDeletion")()
defer tests.PrepareTestEnv(t)()
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: 34901})
requestURL := fmt.Sprintf("/%s/actions/runs/%d/delete", repo62.FullName(), run.Index)
request := NewRequest(t, "POST", requestURL)
response := sessUser2.MakeRequest(t, request, http.StatusOK)
assert.JSONEq(t, `{"ok":true}`, response.Body.String())
// Verify that the run still exists.
unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: run.ID})
})
t.Run("Nothing happens if run does not exist", func(t *testing.T) {
defer tests.PrepareTestEnv(t)()
unittest.AssertNotExistsBean(t, &actions_model.ActionRun{Index: 260871})
requestURL := fmt.Sprintf("/%s/actions/runs/%d/delete", repo1.FullName(), 260871)
request := NewRequest(t, "POST", requestURL)
response := sessUser2.MakeRequest(t, request, http.StatusOK)
assert.JSONEq(t, `{"ok":true}`, response.Body.String())
})
t.Run("Removal requires ownership", func(t *testing.T) {
defer unittest.OverrideFixtures("tests/integration/fixtures/TestActionRunDeletion")()
defer tests.PrepareTestEnv(t)()
isCollaborator, err := repo_model.IsCollaborator(t.Context(), repo1.ID, user5.ID)
require.NoError(t, err)
require.True(t, isCollaborator)
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: 34901})
requestURL := fmt.Sprintf("/%s/actions/runs/%d/delete", repo1.FullName(), run.Index)
request := NewRequest(t, "POST", requestURL)
MakeRequest(t, request, http.StatusNotFound)
// Verify that run still exists
unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: run.ID})
request = NewRequest(t, "POST", requestURL)
sessUser5.MakeRequest(t, request, http.StatusNotFound)
// Verify that run still exists
unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: run.ID})
request = NewRequest(t, "POST", requestURL)
sessUser2.MakeRequest(t, request, http.StatusOK)
// Verify that run no longer exists
unittest.AssertNotExistsBean(t, &actions_model.ActionRun{ID: run.ID})
})
}