Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce JSON matrix workflow #3013

Merged
merged 4 commits into from
Dec 5, 2024
Merged

Introduce JSON matrix workflow #3013

merged 4 commits into from
Dec 5, 2024

Conversation

rnro
Copy link
Contributor

@rnro rnro commented Dec 3, 2024

Introduce and adopt a new method for defining test matrices, swift_test_matrix.yml.

⚠️ Any external adopters of the unit tests, Cxx interop and benchmarks workflows are automatically opted in to use the new infrastructure.

Motivation:

  • The current matrix workflow has the limitation that it only supports pre-defined sets of variables which are explored in the test matrix. At the moment this is a pre-defined set of Swift versions on Linux and Windows.
  • Adding more means hard-coding them at multiple levels of the workflow hierarchy.
  • Currently skipped Windows matrix jobs show up as successes in the GitHub UI leading to a misleading impression of good coverage.

Modifications:

Introduce and adopt a new method for defining test matrices, swift_test_matrix.yml. The new method is based around the approach of defining the test matrix via a JSON object which may be supplied via an input string from another workflow or from a file on-disk in a repository.

Taking this approach means that we have the ability to add new targets to the matrix simply by adding new elements to the JSON array, increasing flexibility and the scope for future growth.

The unit tests, Cxx interop and benchmarks workflows are all modified to use the new approach, this opts-in all downstream adopters. This should be transparent to all downstream adopters.

In order to unify the Linux and Windows jobs I removed the use of the container: GitHub Actions affordance in the Linux jobs which transparently means all steps are executed within the nested container. Instead we must manually call in to the docker container which complicates scripting a little. I tested to see if doing this slowed down the jobs (perhaps GitHub was caching the docker images more intelligently) but it does not.

This approach follows the pattern of @FranzBusch 's open PR #2942

Result:

  • More flexible test matrix definitions
  • No more false-passes for disabled Windows targets

@rnro rnro added the semver/none No version bump required. label Dec 3, 2024
@rnro rnro requested a review from FranzBusch December 3, 2024 14:50
@rnro rnro marked this pull request as ready for review December 3, 2024 14:50
Copy link
Contributor

@glbrntt glbrntt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my limited knowledge of how this all works, this looks good. I think it'll be a really beneficial change!

scripts/generate_matrix.sh Outdated Show resolved Hide resolved
rnro added 2 commits December 4, 2024 08:20
Introduce and adopt a new method for defining test matrices,
`swift_test_matrix.yml`.

⚠️ Any external adopters of the unit tests, Cxx interop and benchmarks
workflows are automatically opted in to use the new infrastructure.

Motivation:

* The current matrix workflow has the limitation that it only supports
  pre-defined sets of variables which are explored in the test matrix. At
  the moment this is a pre-defined set of Swift versions on Linux and
  Windows.
* Adding more means hard-coding them at multiple levels of the
  workflow hierarchy.
* Currently skipped Windows matrix jobs show up as successes in the
  GitHub UI leading to a misleading impression of good coverage.

Modifications:

Introduce and adopt a new method for defining test matrices,
`swift_test_matrix.yml`. The new method is based around the approach of
defining the test matrix via a JSON object which may be supplied via an
input string from another workflow or from a file on-disk in a
repository.

Taking this approach means that we have the ability to add new targets
to the matrix simply by adding new elements to the JSON array,
increasing flexibility and the scope for future growth.

The unit tests, Cxx interop and benchmarks workflows are all modified to
use the new approach, this opts-in all downstream adopters. This should
be transparent to all downstream adopters.

In order to unify the Linux and Windows jobs I removed the use of the
`container:` GitHub Actions affordance in the Linux jobs which
transparently means all steps are executed within the nested container.
Instead we must manually call in to the docker container which
complicates scripting a little. I tested to see if doing this slowed
down the jobs (perhaps GitHub was caching the docker images more
intelligently) but it does not.

Result:

* More flexible test matrix definitions
* No more false-passes for disabled Windows targets
@rnro rnro requested a review from glbrntt December 4, 2024 15:27
@rnro rnro merged commit d3e8c8c into main Dec 5, 2024
37 of 39 checks passed
@rnro rnro deleted the matrix_file branch December 5, 2024 08:23
@rnro rnro restored the matrix_file branch December 5, 2024 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants