Add integration test for assuming an API Key Role using a Buildkite OIDC token #5416
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…IDC token Until recently, Buildkite OIDC tokens did not contain a `jti` claim. At some point in early 2024 it was possible to assume an API Key Role using Buildkite OIDC tokens, but when testing in January 2025 we found the assume role request was failing with an error: > Missing/invalid jti Buildkite has addressed that by adding a `jti` claim to tokens - it's a good claim to include. However, to reduce the risk of regressions in the future, this proposes adding an integration test with a Buildkite-shaped OIDC token. The trait added to the OIDC::Provider factory is based on a real token that I generated then anonymized. I only test the happy path with this token - there's a buncha existing tests for various unhappy paths (expired token, etc) using the Github Actions shaped OIDC token and there's little value in replicating them. Most of the added test is copy-pasted from the happy-path Github Actions test further up the file. Fixes rubygems#5412
yob
commented
Jan 30, 2025
| context "with matching conditions" do | ||
| should "return API key" do | ||
| # remove the Github Actions shaped condition in the default fixture | ||
| @role.access_policy.statements.first.conditions.clear |
There was a problem hiding this comment.
This feels like a hack - would you prefer the test setup create just a Buildkite shaped policy? Maybe via a new trait?
| runner_environment | ||
| ] | ||
| } | ||
| end |
There was a problem hiding this comment.
This config was created based on https://agent.buildkite.com/.well-known/openid-configuration
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Until recently, Buildkite OIDC tokens did not contain a
jticlaim. At some point in early 2024 it was possible to assume an API Key Role using Buildkite OIDC tokens, but when testing in January 2025 we found the assume role request was failing with an error:Buildkite has addressed that by adding a
jticlaim to tokens - it's a good claim to include. However, to reduce the risk of regressions in the future, this PR proposes adding an integration test with a Buildkite-shaped OIDC token.The trait added to the OIDC::Provider factory is based on a real token that I generated then anonymized. I only test the happy path with this token - there's a buncha existing tests for various unhappy paths (expired token, etc) using the Github Actions shaped OIDC token and there's little value in replicating them.
Most of the added test is copy-pasted from the happy-path Github Actions test further up the file.
Fixes #5412