Skip to content

Docs: [AEA-0000] - couple of suggestions after cdk work #11

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

Open
tstephen-nhs wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Docs: [AEA-0000] - couple of suggestions after cdk work #11

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
a7d73d8
docs: suggestions after cdk work
tstephen-nhs Apr 10, 2026
e040551
docs: suggestions after cdk work
tstephen-nhs Apr 13, 2026
e23fbe9
docs: tweak
tstephen-nhs Apr 13, 2026
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
16 changes: 16 additions & 0 deletions .github/instructions/languages/cdk.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,27 @@ export class CptsApiAppStack extends Stack {
- Prefer VPC endpoints for private connectivity
- Minimize resource creation in test environments

## Unit Testing

- Write unit tests for CDK stacks and constructs using synthesis-based assertions.
- Prefer in-process tests that instantiate CDK `App` and `Stack` objects directly and assert on synthesized templates.
- Keep assertions light-touch and stable, such as resource counts and a small number of important properties.
- Avoid mocking AWS resources or writing tests that attempt to exercise live AWS behaviour.
- CDK constructs suitable for reuse should be placed in `eps-cdk-utils` repo.
- Smaller CDK constructs may be included here and should have associated tests.
Copy link
Copy Markdown
Collaborator

@anthony-nhs anthony-nhs Apr 13, 2026

Choose a reason for hiding this comment

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

This gets copied to all repos so saying 'Smaller CDK constructs may be included here' does not make sense when this file will also be in eps-cdk-utils repo

- Do not test AWS implementation details owned by the CDK library. Test the resources and properties your code is responsible for declaring.

### Recommended Test Styles

- Smoke tests for `bin/` files: execute the entrypoint and assert that synthesis completes without throwing.
- In-process synth tests for stacks and constructs: instantiate the stack directly and assert resource counts or key CloudFormation properties with `Template.fromStack(...)`.


## Validation and Verification

- Build: `make cdk-synth`
- Lint: `npm run lint --workspace packages/cdk`
- Test: `npm test --workspace packages/cdk`

## Maintenance

Expand Down
2 changes: 2 additions & 0 deletions .github/instructions/languages/typescript.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ This document provides instructions for generating, reviewing, and maintaining T
- Use destructuring for objects and arrays to improve readability.
- Avoid magic numbers and hardcoded values; use named constants.
- Keep functions pure and side-effect free when possible.
- Do not use the `void` operator to silence unused-value warnings; prefer code that makes usage explicit.

## Code Standards

Expand Down Expand Up @@ -92,6 +93,7 @@ This document provides instructions for generating, reviewing, and maintaining T
### Type Safety

- Prefer interfaces and types. You MUST NOT use `any`.
- Prefer `Array<T>` over `T[]` for array type annotations.
- Use type guards and assertions when necessary.
- Example:

Expand Down
Loading