Skip to content

A cli tool to parse yml/cdk cloudformation stacks definitions and converts it into json properties to simplify local instance replications

Notifications You must be signed in to change notification settings

masrimohammad/testify

Repository files navigation

AWS Cloudformation Template Stacks Testifier (YML/CDK)

A cli tool to read aws cloudformation template yml stack files from a specific directory and converts it into aws-sdk compatible definitions to simplify replication.

Setup Instructions

  • make sure that npm is installed on your machine
  • run npm install . in the cloned repo root directory
  • run npm install -g . in the cloned repo root directory. (if you face any permission errors, please prepend sudo to this command)

ENV

Make sure to set all required env params properly to ensure the success of replication

  • AWS_REGION
  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • AWS_DYNAMODB_ENDPOINT_URL

Usage

Below is an example about how to use the parser cli command.

testify --type=cdk --directory=stacks --filter=someKeyword

  • type: cdk / yml
  • directory: directory path containing the stack files (for cdk type, use the cdk build output directory)
  • filter: any keyword you wish to filter directory files (endsWith)

You can always call the below command to get a descriptive usage hints. testify --help

Examples

Under examples directory we managed to add an integration test interacting with a dynamoDb table, in order to run it first please make sure that you have docker installed (up and running on your machine)

Once everything is set, navigate to dynamoDb directory under examples and trigger docker-composer up --build

Support

Supported cloudformation templates:

  • DynamoDB Tables
  • SQS Queues
  • SNS Notifications

(more coming soon)

Inspired by https://github.com/wassilygraf/testify-dynamodb

About

A cli tool to parse yml/cdk cloudformation stacks definitions and converts it into json properties to simplify local instance replications

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published