aws / aws/aws-cdk

integ-runner: Allow specifying stack tags via CLI

Open
#21,689 1 comment 2 reactions 1 assignee Claimed by @rix0rrr View on GitHub
cli effort/medium feature-request p2 package/tools
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the feature

`integ-runner` would allow passing Stack tags or even would allow for handling `cdk.json`-related CLI arguments more generally when building/updating stacks during integration test execution. Ideally, this would function similarly to the same `--tags` argument in the CDK Toolkit CLI itself.

### Use Case

Some users may wish to contribute to projects that require running integration tests that leverage `integ-runner` (such as the AWS CDK); however, those contributors may only have access to AWS accounts that, per organizational policy, require using stack tags for tracking cost (or for any of the reasons an org may require tags).

### Proposed Solution

Executing integration tests could support passing all data supported by the CDK CLI, or at least some subset of that data (that includes Tags).

If this functionality is already supported, it should be documented in the README for `integ-runner` and the `--help` text for the CLI.

### Other Information

Adding this code to the stacks/apps (`Tags.of(node)`) would be suboptimal as it would require making code modifications to run tests in different environments (and the snapshots would therefore necessarily differ). Though, it’s also not optimal that with this feature changes outside the CDK app code could impact the built resources’ configuration, today it’s actually (I think) impossible to test `--tags` etc without a full `cdk deploy` so this would add the ability to test additional configurations as well.

Manually changing `cdk.json` (if one exists) prior to running tests is suboptimal as it modifies a version-controlled file and may result in accidental commits of those changes.

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CDK version used

2.38.1

### Environment details (OS name and version, etc.)

Any

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.