mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-18 00:36:35 +00:00
Partial backport of #9434. Fixes a bug: it was intended that pushes to a branch and pushes to a pull request would cancel any previous running job from the same workflow, however this functionality only worked on a `on: push` workflow. This PR fixes it for an `on: pull_request` workflow. Adds a feature: `concurrency.cancel-in-progress` can be used to override the automatic cancellation behaviour and disable it. It can be disabled unconditionally in a workflow: ```yaml concurrency: cancel-in-progress: false ``` Or it can be disabled with some logic; for example, keeping the cancel behaviour on PRs but disabling it otherwise: ```yaml concurrency: cancel-in-progress: ${{ github.event_name == 'pull_request' }} ``` Only a small subset of automated tests were applicable for backport, so I supplemented with manual testing in these cases: | | Expected | Actual | | ------------------------------------------------------------------ | ------------- | ------------- | | Default behaviour: | | | | on: pull_request -- push to a PR when it's already running | Cancelled | Cancelled | | on: push -- push to a branch (eg. main) when it's already running | Cancelled | Cancelled | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | | | | | | Set cancel-in-progress: true | | | | on: pull_request -- push to a PR when it's already running | Cancelled | Cancelled | | on: push -- push to a branch (eg. main) when it's already running | Cancelled | Cancelled | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | | | | | | Set cancel-in-progress: false | | | | on: pull_request -- push to a PR when it's already running | Multiple Runs | Multiple Runs | | on: push -- push to a branch (eg. main) when it's already running | Multiple Runs | Multiple Runs | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | | | | | | Set cancel-in-progress: ${{ github.event_name == 'pull_request' }} | | | | on: pull_request -- push to a PR when it's already running | Cancelled | Cancelled | | on: push -- push to a branch (eg. main) when it's already running | Multiple Runs | Multiple Runs | | on: workflow_dispatch -- run again when it is already running | Multiple Runs | Multiple Runs | ## 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 - 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 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. - **TODO:** Will backport the relevant documentation. - [ ] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/9797): <!--number 9797 --><!--line 0 --><!--description ZmVhdDogYWxsb3cgd29ya2Zsb3dzIHRvIGNvbnRyb2wgY2FuY2VsbGF0aW9uIG9mIGV4aXN0aW5nIGpvYnM=-->feat: allow workflows to control cancellation of existing jobs<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9797 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
100 lines
3.3 KiB
Go
100 lines
3.3 KiB
Go
// Copyright 2025 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
package actions
|
|
|
|
import (
|
|
"testing"
|
|
|
|
actions_model "forgejo.org/models/actions"
|
|
"forgejo.org/models/repo"
|
|
"forgejo.org/modules/webhook"
|
|
|
|
act_model "code.forgejo.org/forgejo/runner/v11/act/model"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestConfigureActionRunConcurrency(t *testing.T) {
|
|
for _, tc := range []struct {
|
|
name string
|
|
concurrency *act_model.RawConcurrency
|
|
vars map[string]string
|
|
inputs map[string]any
|
|
runEvent webhook.HookEventType
|
|
expectedConcurrencyType actions_model.ConcurrencyMode
|
|
}{
|
|
// Before the introduction of concurrency groups, push & pull_request_sync would cancel runs on the same repo,
|
|
// reference, workflow, and event -- these cases cover undefined concurrency group and backwards compatibility
|
|
// checks.
|
|
{
|
|
name: "backwards compatibility push",
|
|
runEvent: webhook.HookEventPush,
|
|
expectedConcurrencyType: actions_model.CancelInProgress,
|
|
},
|
|
{
|
|
name: "backwards compatibility pull_request_sync",
|
|
runEvent: webhook.HookEventPullRequestSync,
|
|
expectedConcurrencyType: actions_model.CancelInProgress,
|
|
},
|
|
{
|
|
name: "backwards compatibility other event",
|
|
runEvent: webhook.HookEventWorkflowDispatch,
|
|
expectedConcurrencyType: actions_model.UnlimitedConcurrency,
|
|
},
|
|
|
|
{
|
|
name: "fully-specified cancel-in-progress",
|
|
concurrency: &act_model.RawConcurrency{
|
|
Group: "abc",
|
|
CancelInProgress: "true",
|
|
},
|
|
runEvent: webhook.HookEventPullRequestSync,
|
|
expectedConcurrencyType: actions_model.CancelInProgress,
|
|
},
|
|
{
|
|
name: "no concurrency group, cancel-in-progress: false",
|
|
concurrency: &act_model.RawConcurrency{
|
|
CancelInProgress: "false",
|
|
},
|
|
runEvent: webhook.HookEventPullRequestSync,
|
|
expectedConcurrencyType: actions_model.UnlimitedConcurrency,
|
|
},
|
|
|
|
{
|
|
name: "interpreted values",
|
|
concurrency: &act_model.RawConcurrency{
|
|
Group: "${{ github.workflow }}-${{ github.ref }}",
|
|
CancelInProgress: "${{ !contains(github.ref, 'release/')}}",
|
|
},
|
|
runEvent: webhook.HookEventPullRequestSync,
|
|
expectedConcurrencyType: actions_model.CancelInProgress,
|
|
},
|
|
{
|
|
name: "interpreted values with inputs and vars",
|
|
concurrency: &act_model.RawConcurrency{
|
|
Group: "${{ inputs.abc }}-${{ vars.def }}",
|
|
},
|
|
inputs: map[string]any{"abc": "123"},
|
|
vars: map[string]string{"def": "456"},
|
|
runEvent: webhook.HookEventPullRequestSync,
|
|
expectedConcurrencyType: actions_model.CancelInProgress,
|
|
},
|
|
} {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
workflow := &act_model.Workflow{RawConcurrency: tc.concurrency}
|
|
run := &actions_model.ActionRun{
|
|
Ref: "refs/head/main",
|
|
WorkflowID: "testing.yml",
|
|
Event: tc.runEvent,
|
|
TriggerEvent: string(tc.runEvent),
|
|
Repo: &repo.Repository{},
|
|
}
|
|
|
|
err := ConfigureActionRunConcurrency(workflow, run, tc.vars, tc.inputs)
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, tc.expectedConcurrencyType, run.ConcurrencyType)
|
|
})
|
|
}
|
|
}
|