Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.35 KB
Raw

Integration Tests

Unit tests are automatically run as part of the regular build. Integration tests aren't run automatically since they have nontrivial requirements to run.

CLI integration tests

CLI tests will exercise a number of common CLI scenarios, and deploy actual stacks to your AWS account.

REQUIREMENTS

  • All packages have been compiled.
  • Shell has been preloaded with AWS credentials.

Run:

npm run integ-cli

Init template integration tests

Init template tests will initialize and compile the init templates that the CLI ships with.

REQUIREMENTS

  • Running on a machine that has all language tools available (JDK, .NET Core, Python installed).
  • All packages have been compiled.
  • All packages have been packaged to their respective languages (pack.sh).

Run:

npm run integ-init

Integration test modes

These two sets of integration tests have 3 running modes:

  • Developer mode, when called through npm run. Will use the source tree.
  • Integration test, when called from a directory with the build artifacts (the dist directory).
  • Canaries, when called with IS_CANARY=true. Will use the build artifacts up on the respective package managers.

The integration test and canary modes are used in the CDK publishing pipeline and the CDK canaries, respectively. You wouldn't normally need to run them directly that way.