https://github.com/horietakehiro/aws-cdk-utul
https://github.com/horietakehiro/aws-cdk-utul
aws aws-cdk cloudformation infrastructure-as-code typescript unittest
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/horietakehiro/aws-cdk-utul
- Owner: horietakehiro
- License: mit
- Created: 2024-09-23T00:52:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-25T15:04:18.000Z (5 months ago)
- Last Synced: 2026-01-26T07:58:00.071Z (5 months ago)
- Topics: aws, aws-cdk, cloudformation, infrastructure-as-code, typescript, unittest
- Language: TypeScript
- Homepage:
- Size: 1.02 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AWS CDK Unit Test Utility Library
**aws-cdk-utul(unit test utility library) makes it faster, more efficient with less mistakes for you to code AWS CDK unit tests.**
---
## Features
---
### TypedTemplate
`TypedTemplate` class provides you proper type definitions for (almost) all AWS CloudFormation resource types. So you can easily and quickly code AWS CDK unit tests without trivial mistakes and googling.
- You can use all methods implemented by AWS CDK's `Template` class with proper type definitions.
- Return values of some methods - e.g. `findResources` - are changed from original ones, so that succeeding processes can handle and access them more easily.
- You can still use AWS CDK's `Matcher` class and other arbitrary objects too.
```js
import { Stack } from "aws-cdk-lib";
import { TypedTemplate } from "@horietakehiro/aws-cdk-utul/lib/assertions";
import { AWS_EC2_SUBNET, AWS_EC2_VPC } from "@horietakehiro/aws-cdk-utul/lib/types/cfn-resource-types";
const stack = new Stack()
const template = TypedTemplate.fromStack(stack)
// you can execute all method implemented in original `Template` instance
template.hasResource(AWS_EC2_VPC({Properties: {
CidrBlock: "10.0.0.0/16"
}}))
// you can still use original `Matcher` class too.
const subnets = template.findResources(AWS_EC2_SUBNET({Properties: {
Tags: Match.arrayWith([
{Key: "Name", Value: Match.stringLikeRegexp("Public")}
])
}}))
// you can access resources with more efficient way
subnets.forEach((sn) => {
expect(sn.def.Properties?.CidrBlock?.endsWith("/24")).toBe(true)
})
```
---
### ExtraMatch
`ExtraMatch` class provides you some kind of a syntax sugar for AWS CDK's `Match` class.
```js
import { ExtraMatch } from "@horietakehiro/aws-cdk-utul/lib/assertions"
// get just vpc's logical id
const [{id}] = template.findResources(AWS_EC2_VPC({}))
template.allResources(AWS_EC2_SUBNET({
// Equals to {VpcId: {Ref: id}}
Properties: {VpcId: ExtraMatch.ref(id)}
}))
template.hasOutput("VPCARN", {
// Equals to {Value: {"Fn::GetAtt": [id, "Arn"]}}
Value: ExtraMatch.getAttArn(id)
})
```
`ExtraMatch.iamPolicyLike` method provides schemas for [IAM Policy document](https://docs.aws.amazon.com/ja_jp/IAM/latest/UserGuide/reference_policies_grammar.html) - it's useful when defining tests for `AWS::IAM::Policy` and `AWS::IAM::Role`
---
`ExtraMatch.{arrayWith,arrayLike,objectLike,objectEquals,not,exact}` are same method as those of `Match` class but additionally provide type hints. These are useful to type-safely use `Matcher`
---
## Install
```bash
npm install @horietakehiro/aws-cdk-utul
```
By default, you may feel difficult to use this library because import path is too long for type hits to fit in IDE dialog box like below.
So I recommend that you add module alias settings in your `tsconfig.json` file like below.
```json
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/cfn-types": ["node_modules/@horietakehiro/aws-cdk-utul/lib/types/cfn-resource-types"],
"@/cfn-types/*": ["node_modules/@horietakehiro/aws-cdk-utul/lib/types/cfn-resource-types/*"]
}
}
}
```
---
## Release policy
This package will be released new version every 3 days, so that catching up updates of AWS CloudFormation resource types and those schemas which will be happened frequently and irregularly.
---
## Some other notes
- Schemas of AWS CloudFormation resource types used in this library are based on [those at `us-east-1`](https://docs.aws.amazon.com/ja_jp/AWSCloudFormation/latest/UserGuide/resource-type-schemas.html)
- Compatible with AWS CDK v2.0.0 or greater.