2025-11-30 13:16:41 +01:00
// 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." ,
} ,
2025-12-05 17:17:37 +01:00
{
name : "ErrorCodeIncompleteMatrixMissingOutput" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteMatrixMissingOutput ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "other_job" , "some_output" } ,
} ,
feat: support reusable workflow expansion when `with` or `strategy.matrix` contains ${{ needs... }} (#10647)
This change allows the `with:` field of a reusable workflow to reference a previous job, such as `with: { some-input: "${{ needs.other-job.outputs.other-output }}" }`. `strategy.matrix` can also reference `${{ needs... }}`.
When a job is parsed and encounters this situation, the outer job of the workflow is marked with a field `incomplete_with` (or `incomplete_matrix`), indicating to Forgejo that it can't be executed as-is and the other jobs in its `needs` list need to be completed first. And then in `job_emitter.go` when one job is completed, it checks if other jobs had a `needs` reference to it and unblocks those jobs -- but if they're marked with `incomplete_with` then they can be sent back through the job parser, with the now-available job outputs, to be expanded into the correct definition of the job.
The core functionality for this already exists to allow `runs-on` and `strategy.matrix` to reference the outputs of other jobs, but it is expanded upon here to include `with` for reusable workflows.
There is one known defect in this implementation, but it has a limited scope -- if this code path is used to expand a nested reusable workflow, then the `${{ input.... }}` context will be incorrect. This will require an update to the jobparser in runner version 12.4.0, and so it is out-of-scope of this PR.
## 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)).
- **end-to-end test:** will require the noted "known defect" to be resolved, but tests are authored at https://code.forgejo.org/forgejo/end-to-end/compare/main...mfenniak:expand-reusable-workflows-needs
### 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
- [ ] 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.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10647
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
2025-12-31 19:04:35 +01:00
expected : "Unable to evaluate `strategy.matrix` of job blocked_job: job other_job is missing output some_output." ,
2025-12-05 17:17:37 +01:00
} ,
{
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)." ,
} ,
2025-12-05 18:14:43 +01:00
{
name : "ErrorCodeIncompleteMatrixUnknownCause" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteMatrixUnknownCause ,
PreExecutionErrorDetails : [ ] any { "blocked_job" } ,
} ,
expected : "Unable to evaluate `strategy.matrix` of job blocked_job: unknown error." ,
} ,
{
name : "ErrorCodeIncompleteRunsOnMissingOutput" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteRunsOnMissingOutput ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "other_job" , "some_output" } ,
} ,
feat: support reusable workflow expansion when `with` or `strategy.matrix` contains ${{ needs... }} (#10647)
This change allows the `with:` field of a reusable workflow to reference a previous job, such as `with: { some-input: "${{ needs.other-job.outputs.other-output }}" }`. `strategy.matrix` can also reference `${{ needs... }}`.
When a job is parsed and encounters this situation, the outer job of the workflow is marked with a field `incomplete_with` (or `incomplete_matrix`), indicating to Forgejo that it can't be executed as-is and the other jobs in its `needs` list need to be completed first. And then in `job_emitter.go` when one job is completed, it checks if other jobs had a `needs` reference to it and unblocks those jobs -- but if they're marked with `incomplete_with` then they can be sent back through the job parser, with the now-available job outputs, to be expanded into the correct definition of the job.
The core functionality for this already exists to allow `runs-on` and `strategy.matrix` to reference the outputs of other jobs, but it is expanded upon here to include `with` for reusable workflows.
There is one known defect in this implementation, but it has a limited scope -- if this code path is used to expand a nested reusable workflow, then the `${{ input.... }}` context will be incorrect. This will require an update to the jobparser in runner version 12.4.0, and so it is out-of-scope of this PR.
## 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)).
- **end-to-end test:** will require the noted "known defect" to be resolved, but tests are authored at https://code.forgejo.org/forgejo/end-to-end/compare/main...mfenniak:expand-reusable-workflows-needs
### 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
- [ ] 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.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10647
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
2025-12-31 19:04:35 +01:00
expected : "Unable to evaluate `runs-on` of job blocked_job: job other_job is missing output some_output." ,
2025-12-05 18:14:43 +01:00
} ,
{
name : "ErrorCodeIncompleteRunsOnMissingJob" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteRunsOnMissingJob ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "other_job" , "needs-1, needs-2" } ,
} ,
expected : "Unable to evaluate `runs-on` of job blocked_job: job other_job is not in the `needs` list of job blocked_job (needs-1, needs-2)." ,
} ,
{
name : "ErrorCodeIncompleteRunsOnMissingMatrixDimension" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteRunsOnMissingMatrixDimension ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "platfurm" } ,
} ,
expected : "Unable to evaluate `runs-on` of job blocked_job: matrix dimension platfurm does not exist." ,
} ,
{
name : "ErrorCodeIncompleteRunsOnUnknownCause" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteRunsOnUnknownCause ,
PreExecutionErrorDetails : [ ] any { "blocked_job" } ,
} ,
expected : "Unable to evaluate `runs-on` of job blocked_job: unknown error." ,
} ,
feat: support reusable workflow expansion when `with` or `strategy.matrix` contains ${{ needs... }} (#10647)
This change allows the `with:` field of a reusable workflow to reference a previous job, such as `with: { some-input: "${{ needs.other-job.outputs.other-output }}" }`. `strategy.matrix` can also reference `${{ needs... }}`.
When a job is parsed and encounters this situation, the outer job of the workflow is marked with a field `incomplete_with` (or `incomplete_matrix`), indicating to Forgejo that it can't be executed as-is and the other jobs in its `needs` list need to be completed first. And then in `job_emitter.go` when one job is completed, it checks if other jobs had a `needs` reference to it and unblocks those jobs -- but if they're marked with `incomplete_with` then they can be sent back through the job parser, with the now-available job outputs, to be expanded into the correct definition of the job.
The core functionality for this already exists to allow `runs-on` and `strategy.matrix` to reference the outputs of other jobs, but it is expanded upon here to include `with` for reusable workflows.
There is one known defect in this implementation, but it has a limited scope -- if this code path is used to expand a nested reusable workflow, then the `${{ input.... }}` context will be incorrect. This will require an update to the jobparser in runner version 12.4.0, and so it is out-of-scope of this PR.
## 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)).
- **end-to-end test:** will require the noted "known defect" to be resolved, but tests are authored at https://code.forgejo.org/forgejo/end-to-end/compare/main...mfenniak:expand-reusable-workflows-needs
### 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
- [ ] 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.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10647
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
2025-12-31 19:04:35 +01:00
{
name : "ErrorCodeIncompleteWithMissingOutput" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteWithMissingOutput ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "other_job" , "some_output" } ,
} ,
expected : "Unable to evaluate `with` of job blocked_job: job other_job is missing output some_output." ,
} ,
{
name : "ErrorCodeIncompleteWithMissingJob" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteWithMissingJob ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "other_job" , "needs-1, needs-2" } ,
} ,
expected : "Unable to evaluate `with` of job blocked_job: job other_job is not in the `needs` list of job blocked_job (needs-1, needs-2)." ,
} ,
{
name : "ErrorCodeIncompleteWithMissingMatrixDimension" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteWithMissingMatrixDimension ,
PreExecutionErrorDetails : [ ] any { "blocked_job" , "platfurm" } ,
} ,
expected : "Unable to evaluate `with` of job blocked_job: matrix dimension platfurm does not exist." ,
} ,
{
name : "ErrorCodeIncompleteWithUnknownCause" ,
run : & ActionRun {
PreExecutionErrorCode : ErrorCodeIncompleteWithUnknownCause ,
PreExecutionErrorDetails : [ ] any { "blocked_job" } ,
} ,
expected : "Unable to evaluate `with` of job blocked_job: unknown error." ,
} ,
2025-11-30 13:16:41 +01:00
}
for _ , tt := range tests {
t . Run ( tt . name , func ( t * testing . T ) {
err := TranslatePreExecutionError ( lang , tt . run )
assert . Equal ( t , tt . expected , err )
} )
}
}