mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-12-07 14:09:47 +00:00
ffbd500600
Allows referencing the outputs of previously executed jobs in the `runs-on` field directly by a `${{ needs.some-job.outputs.some-output }}`, and also *indirectly* through the job's `strategy.matrix`. At its most complicated, supports a workflow with dynamic matrices like this:
```yaml
jobs:
define-matrix:
runs-on: docker
outputs:
array-value: ${{ steps.define.outputs.array }}
steps:
- id: define
run: |
echo 'array=["debian-bookworm", "debian-trixie"]' >> "$FORGEJO_OUTPUT"
runs-on-dynamic-matrix:
needs: define-matrix
strategy:
matrix:
my-runners: ${{ fromJSON(needs.define-matrix.outputs.array-value) }}
runs-on: ${{ matrix.my-runners }}
steps:
- run: uname -a
```
## 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.
- [x] I did not document these changes and I do not expect someone else to do it.
- Documentation already (incorrectly) states that `jobs.<job-id>.runs-on` can access the `needs` context. 😛 https://forgejo.org/docs/latest/user/actions/reference/#availability
### 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/10308): <!--number 10308 --><!--line 0 --><!--description ZmVhdChhY3Rpb25zKTogc3VwcG9ydCByZWZlcmVuY2luZyBgJHt7IG5lZWRzLi4uIH19YCB2YXJpYWJsZXMgaW4gYHJ1bnMtb25g-->feat(actions): support referencing `${{ needs... }}` variables in `runs-on`<!--description-->
<!--end release-notes-assistant-->
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10308
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
156 lines
6.8 KiB
Go
156 lines
6.8 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/unittest"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestActions_CancelOrApproveRun(t *testing.T) {
|
|
t.Run("run, job and task Running changes to run, job and task Cancelled", func(t *testing.T) {
|
|
defer unittest.OverrideFixtures("services/actions/TestActions_CancelOrApproveRun")()
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
taskID := int64(711900)
|
|
task := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: taskID})
|
|
require.Equal(t, actions_model.StatusRunning.String(), task.Status.String())
|
|
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: task.JobID})
|
|
require.Equal(t, actions_model.StatusRunning.String(), job.Status.String())
|
|
require.Zero(t, job.Stopped)
|
|
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
require.Equal(t, actions_model.StatusRunning.String(), run.Status.String())
|
|
|
|
require.NoError(t, CancelRun(t.Context(), run))
|
|
|
|
run = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
assert.Equal(t, actions_model.StatusCancelled.String(), run.Status.String())
|
|
job = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: task.JobID})
|
|
assert.Equal(t, actions_model.StatusCancelled.String(), job.Status.String())
|
|
assert.NotZero(t, job.Stopped)
|
|
task = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: taskID})
|
|
require.Equal(t, actions_model.StatusCancelled.String(), task.Status.String())
|
|
})
|
|
|
|
t.Run("run Running, job and task Success changes to run Cancelled", func(t *testing.T) {
|
|
defer unittest.OverrideFixtures("services/actions/TestActions_CancelOrApproveRun")()
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
taskID := int64(710900)
|
|
task := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: taskID})
|
|
require.Equal(t, actions_model.StatusSuccess.String(), task.Status.String())
|
|
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: task.JobID})
|
|
require.Equal(t, actions_model.StatusSuccess.String(), job.Status.String())
|
|
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
require.Equal(t, actions_model.StatusRunning.String(), run.Status.String())
|
|
|
|
require.NoError(t, CancelRun(t.Context(), run))
|
|
|
|
run = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
assert.Equal(t, actions_model.StatusCancelled.String(), run.Status.String())
|
|
job = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: task.JobID})
|
|
assert.Equal(t, actions_model.StatusSuccess, job.Status)
|
|
task = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionTask{ID: taskID})
|
|
require.Equal(t, actions_model.StatusSuccess, task.Status)
|
|
})
|
|
|
|
t.Run("run Waiting and job Blocked for Approval changes to run and job Cancelled", func(t *testing.T) {
|
|
defer unittest.OverrideFixtures("services/actions/TestActions_CancelOrApproveRun")()
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
jobID := int64(10800)
|
|
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: jobID})
|
|
require.Equal(t, actions_model.StatusBlocked.String(), job.Status.String())
|
|
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
require.Equal(t, actions_model.StatusWaiting.String(), run.Status.String())
|
|
require.True(t, run.NeedApproval)
|
|
|
|
require.NoError(t, CancelRun(t.Context(), run))
|
|
|
|
run = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
assert.Equal(t, actions_model.StatusCancelled.String(), run.Status.String())
|
|
assert.False(t, run.NeedApproval)
|
|
job = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: jobID})
|
|
assert.Equal(t, actions_model.StatusCancelled, job.Status)
|
|
})
|
|
|
|
t.Run("run Waiting and job Blocked for Approval changes to job Waiting", func(t *testing.T) {
|
|
defer unittest.OverrideFixtures("services/actions/TestActions_CancelOrApproveRun")()
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
jobID := int64(10800)
|
|
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: jobID})
|
|
require.Equal(t, actions_model.StatusBlocked.String(), job.Status.String())
|
|
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
require.Equal(t, actions_model.StatusWaiting.String(), run.Status.String())
|
|
require.True(t, run.NeedApproval)
|
|
|
|
doerID := int64(30)
|
|
require.NoError(t, ApproveRun(t.Context(), run, doerID))
|
|
|
|
run = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: job.RunID})
|
|
assert.Equal(t, actions_model.StatusWaiting.String(), run.Status.String())
|
|
assert.False(t, run.NeedApproval)
|
|
assert.Equal(t, doerID, run.ApprovedBy)
|
|
job = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: jobID})
|
|
assert.Equal(t, actions_model.StatusWaiting, job.Status)
|
|
})
|
|
}
|
|
|
|
func TestActions_consistencyCheckRun(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
runID int64
|
|
errContains string
|
|
consumed bool
|
|
runJobNames []string
|
|
preExecutionError actions_model.PreExecutionError
|
|
preExecutionErrorDetails []any
|
|
}{
|
|
{
|
|
name: "consistent: not incomplete_matrix",
|
|
runID: 900,
|
|
},
|
|
{
|
|
name: "consistent: incomplete_matrix all needs exist",
|
|
runID: 901,
|
|
},
|
|
{
|
|
name: "inconsistent: incomplete_matrix all needs exist",
|
|
runID: 902,
|
|
preExecutionError: actions_model.ErrorCodeIncompleteMatrixMissingJob,
|
|
preExecutionErrorDetails: []any{"job_1", "oops-something-wrong-here", "define-matrix"},
|
|
},
|
|
{
|
|
name: "inconsistent: static matrix missing dimension",
|
|
runID: 903,
|
|
preExecutionError: actions_model.ErrorCodeIncompleteRunsOnMissingMatrixDimension,
|
|
preExecutionErrorDetails: []any{"job_1", "platform-oops-wrong-dimension"},
|
|
},
|
|
{
|
|
name: "consistent: matrix missing dimension but matrix is dynamic",
|
|
runID: 904,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
defer unittest.OverrideFixtures("services/actions/TestActions_consistencyCheckRun")()
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
run := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: tt.runID})
|
|
|
|
err := consistencyCheckRun(t.Context(), run)
|
|
require.NoError(t, err)
|
|
|
|
run = unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRun{ID: tt.runID})
|
|
assert.Equal(t, tt.preExecutionError, run.PreExecutionErrorCode)
|
|
assert.Equal(t, tt.preExecutionErrorDetails, run.PreExecutionErrorDetails)
|
|
})
|
|
}
|
|
}
|