Skip to content

chore: improve stability of tests by copying SSM Parameter Value #830

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 8, 2025
+26 −18
Merged

chore: improve stability of tests by copying SSM Parameter Value #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ca7a35
chore: improve stability of tests by copying SSM Parameter Value
rix0rrr Sep 1, 2025
922c17e
Restore test
rix0rrr Sep 1, 2025
5f50cee
Explain location change in 2 places
rix0rrr Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions ...ib/test/api/bootstrap/external-id.test.ts → .../api/bootstrap/bootstrap-template.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@ import { Bootstrapper } from '../../../lib/api/bootstrap';
import type { IIoHost } from '../../../lib/api/io';
import { asIoHelper } from '../../../lib/api/io/private';

describe('ExternalId Protection Integration Test', () => {
let ioHost: IIoHost;
let ioHelper: any;
let ioHost: IIoHost;
let ioHelper: any;
let template: any;

beforeEach(() => {
ioHost = {
notify: jest.fn(),
requestResponse: jest.fn(),
};
ioHelper = asIoHelper(ioHost, 'bootstrap');
});

test('bootstrap template denies AssumeRole with ExternalId by default', async () => {
// GIVEN
const bootstrapper = new Bootstrapper({ source: 'default' }, ioHelper);
beforeEach(async () => {
ioHost = {
notify: jest.fn(),
requestResponse: jest.fn(),
};
ioHelper = asIoHelper(ioHost, 'bootstrap');

// WHEN
const template = await (bootstrapper as any).loadTemplate();
// GIVEN
const bootstrapper = new Bootstrapper({ source: 'default' }, ioHelper);
// WHEN
template = await (bootstrapper as any).loadTemplate();
});

describe('bootstrap template', () => {
test('denies AssumeRole with ExternalId by default', async () => {
// THEN
// Verify the parameter exists
expect(template.Parameters.DenyExternalId).toMatchObject({
Expand Down Expand Up @@ -70,4 +70,8 @@ describe('ExternalId Protection Integration Test', () => {
expect(stmt.Condition).toBeUndefined();
}
});

test('has the same values for BootstrapVersion Parameter and Output', async () => {
expect(template.Outputs.BootstrapVersion.Value).toEqual(template.Resources.CdkBootstrapVersion.Properties.Value);
});
});
8 changes: 6 additions & 2 deletions packages/aws-cdk/lib/api/bootstrap/bootstrap-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,7 @@ Resources:
Type: String
Name:
Fn::Sub: '/cdk-bootstrap/${Qualifier}/version'
# Also update this value below (see comment there)
Value: '29'
Outputs:
BucketName:
Expand Down Expand Up @@ -844,5 +845,8 @@ Outputs:
BootstrapVersion:
Description: The version of the bootstrap resources that are currently mastered
in this stack
Value:
Fn::GetAtt: [CdkBootstrapVersion, Value]
# This value is purposely duplicated here from the AWS::SSM::Parameter value we define above.
# {Fn::GetAtt} on an SSM Parameter is eventually consistent, and can fail with "parameter
# doesn't exist" even after just having been created. To reduce our deploy failure rate, we
# duplicate the value here and use a build-time test to ensure the two values are the same.
Value: '29'
Loading