mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-12-08 06:29:47 +00:00
Three fixes are presented together in this PR:
- When a `strategy.matrix` entry in an Action job contains `${{ needs.some-job.outputs.some-output }}`, if that output *never* becomes available, different error messages will be presented if `some-job` isn't found or if `some-output` isn't found. This clarifies an error message that was previously "it could be this, or it could be this".
- In the error case described in the previous point, other jobs in the workflow could continue running or could be left "blocked" forever. A centralized `FailRunPreExecutionError` function ensures that all incomplete jobs in the run are failed in this case.
- In a rare error case when a job referenced another job in `strategy.matrix` but no other jobs were defined in the workflow, the job would be marked as blocked forever because the `job_emitter` code would never be invoked to detect this case. A new `consistencyCheckRun` function for a newly created `ActionRun` adds a location to perform a pre-execution check for this case so that the run can be failed.
These fixes are all interconnected around the refactor for the `FailRunPreExecutionError`, causing them to be bundled rather than individual PRs.
## 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.
### Release notes
- [x] I do not want this change to show in the release notes.
- These are fixes to an unreleased feature and don't require release notes.
- [ ] 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.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10298
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>
80 lines
2.5 KiB
Go
80 lines
2.5 KiB
Go
// Copyright 2025 The Forgejo Authors. All rights reserved.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
package actions
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"forgejo.org/modules/translation"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestTranslatePreExecutionError(t *testing.T) {
|
|
translation.InitLocales(t.Context())
|
|
lang := translation.NewLocale("en-US")
|
|
|
|
tests := []struct {
|
|
name string
|
|
run *ActionRun
|
|
expected string
|
|
}{
|
|
{
|
|
name: "legacy",
|
|
run: &ActionRun{PreExecutionError: "legacy message"},
|
|
expected: "legacy message",
|
|
},
|
|
{
|
|
name: "no error",
|
|
run: &ActionRun{},
|
|
expected: "",
|
|
},
|
|
{
|
|
name: "ErrorCodeEventDetectionError",
|
|
run: &ActionRun{
|
|
PreExecutionErrorCode: ErrorCodeEventDetectionError,
|
|
PreExecutionErrorDetails: []any{"inner error message"},
|
|
},
|
|
expected: "Unable to parse supported events in workflow: inner error message",
|
|
},
|
|
{
|
|
name: "ErrorCodeJobParsingError",
|
|
run: &ActionRun{
|
|
PreExecutionErrorCode: ErrorCodeJobParsingError,
|
|
PreExecutionErrorDetails: []any{"inner error message"},
|
|
},
|
|
expected: "Unable to parse jobs in workflow: inner error message",
|
|
},
|
|
{
|
|
name: "ErrorCodePersistentIncompleteMatrix",
|
|
run: &ActionRun{
|
|
PreExecutionErrorCode: ErrorCodePersistentIncompleteMatrix,
|
|
PreExecutionErrorDetails: []any{"blocked_job", "needs-1, needs-2"},
|
|
},
|
|
expected: "Unable to evaluate `strategy.matrix` of job blocked_job due to a `needs` expression that was invalid. It may reference a job that is not in it's 'needs' list (needs-1, needs-2), or an output that doesn't exist on one of those jobs.",
|
|
},
|
|
{
|
|
name: "ErrorCodeIncompleteMatrixMissingOutput",
|
|
run: &ActionRun{
|
|
PreExecutionErrorCode: ErrorCodeIncompleteMatrixMissingOutput,
|
|
PreExecutionErrorDetails: []any{"blocked_job", "other_job", "some_output"},
|
|
},
|
|
expected: "Unable to evaluate `strategy.matrix` of job blocked_job: job other_job does not have an output some_output.",
|
|
},
|
|
{
|
|
name: "ErrorCodeIncompleteMatrixMissingJob",
|
|
run: &ActionRun{
|
|
PreExecutionErrorCode: ErrorCodeIncompleteMatrixMissingJob,
|
|
PreExecutionErrorDetails: []any{"blocked_job", "other_job", "needs-1, needs-2"},
|
|
},
|
|
expected: "Unable to evaluate `strategy.matrix` of job blocked_job: job other_job is not in the `needs` list of job blocked_job (needs-1, needs-2).",
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
err := TranslatePreExecutionError(lang, tt.run)
|
|
assert.Equal(t, tt.expected, err)
|
|
})
|
|
}
|
|
}
|