added Jest Tests to lib Template (#3948)

aws · Sep 9, 2019 · 9db7fff · 9db7fff
1 parent 77105ab
commit 9db7fff
Show file tree

Hide file tree

Showing 13 changed files with 102 additions and 1 deletion.
diff --git a/packages/aws-cdk/lib/init-templates/app/typescript/README.md b/packages/aws-cdk/lib/init-templates/app/typescript/README.md
@@ -2,6 +2,7 @@
 
  * `npm run build`   compile typescript to js
  * `npm run watch`   watch for changes and compile
+ * `npm run test`    perform the jest unit tests
  * `cdk deploy`      deploy this stack to your default AWS account/region
  * `cdk diff`        compare deployed stack with current state
  * `cdk synth`       emits the synthesized CloudFormation template
diff --git a/packages/aws-cdk/lib/init-templates/app/typescript/jest.config.js b/packages/aws-cdk/lib/init-templates/app/typescript/jest.config.js
@@ -0,0 +1,9 @@
+module.exports = {
+    "roots": [
+      "<rootDir>/test"
+    ],
+    testMatch: [ '**/*.test.ts'],
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+  }
diff --git a/packages/aws-cdk/lib/init-templates/app/typescript/package.template.json b/packages/aws-cdk/lib/init-templates/app/typescript/package.template.json
@@ -7,9 +7,14 @@
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
+    "test": "jest",
     "cdk": "cdk"
   },
   "devDependencies": {
+    "@aws-cdk/assert": "^%cdk-version%",
+    "@types/jest": "^24.0.18",
+    "jest": "^24.9.0",
+    "ts-jest": "^24.0.2",
     "aws-cdk": "^%cdk-version%",
     "ts-node": "^8.1.0",
     "typescript": "~3.6.2"

diff --git a/packages/aws-cdk/lib/init-templates/app/typescript/test/%name%.test.template.ts b/packages/aws-cdk/lib/init-templates/app/typescript/test/%name%.test.template.ts
@@ -0,0 +1,13 @@
+import { expect as expectCDK, matchTemplate, MatchStyle } from '@aws-cdk/assert';
+import cdk = require('@aws-cdk/core');
+import %name.PascalCased% = require('../lib/%name%-stack');
+
+test('Empty Stack', () => {
+    const app = new cdk.App();
+    // WHEN
+    const stack = new %name.PascalCased%.%name.PascalCased%Stack(app, 'MyTestStack');
+    // THEN
+    expectCDK(stack).to(matchTemplate({
+      "Resources": {}
+    }, MatchStyle.EXACT))
+});
diff --git a/packages/aws-cdk/lib/init-templates/lib/typescript/README.md b/packages/aws-cdk/lib/init-templates/lib/typescript/README.md
@@ -1,4 +1,5 @@
 # Useful commands
 
  * `npm run build`   compile typescript to js
+ * `npm run test`    perform the jest unit tests
  * `npm run watch`   watch for changes and compile
diff --git a/packages/aws-cdk/lib/init-templates/lib/typescript/jest.config.js b/packages/aws-cdk/lib/init-templates/lib/typescript/jest.config.js
@@ -0,0 +1,9 @@
+module.exports = {
+    "roots": [
+      "<rootDir>/test"
+    ],
+    testMatch: [ '**/*.test.ts'],
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+  }
diff --git a/packages/aws-cdk/lib/init-templates/lib/typescript/package.template.json b/packages/aws-cdk/lib/init-templates/lib/typescript/package.template.json
@@ -5,9 +5,14 @@
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "watch": "tsc -w"
+    "watch": "tsc -w",
+    "test": "jest"
   },
   "devDependencies": {
+    "@aws-cdk/assert": "^%cdk-version%",
+    "@types/jest": "^24.0.18",
+    "jest": "^24.9.0",
+    "ts-jest": "^24.0.2",
     "typescript": "~3.6.2"
   },
   "peerDependencies": {

diff --git a/packages/aws-cdk/lib/init-templates/lib/typescript/test/%name%.test.template.ts b/packages/aws-cdk/lib/init-templates/lib/typescript/test/%name%.test.template.ts
@@ -0,0 +1,21 @@
+import { expect as expectCDK, haveResource, SynthUtils } from '@aws-cdk/assert';
+import cdk = require('@aws-cdk/core');
+import %name.PascalCased% = require('../lib/index');
+
+test('SQS Queue Created', () => {
+    const app = new cdk.App();
+    const stack = new cdk.Stack(app, "TestStack");
+    // WHEN
+    new %name.PascalCased%.%name.PascalCased%(stack, 'MyTestConstruct');
+    // THEN
+    expectCDK(stack).to(haveResource("AWS::SQS::Queue"));
+});
+
+test('SNS Topic Created', () => {
+  const app = new cdk.App();
+  const stack = new cdk.Stack(app, "TestStack");
+  // WHEN
+  new %name.PascalCased%.%name.PascalCased%(stack, 'MyTestConstruct');
+  // THEN
+  expectCDK(stack).to(haveResource("AWS::SNS::Topic"));
+});
diff --git a/packages/aws-cdk/lib/init-templates/sample-app/typescript/README.md b/packages/aws-cdk/lib/init-templates/sample-app/typescript/README.md
@@ -2,6 +2,7 @@
 
  * `npm run build`   compile typescript to js
  * `npm run watch`   watch for changes and compile
+ * `npm run test`    perform the jest unit tests
  * `cdk deploy`      deploy this stack to your default AWS account/region
  * `cdk diff`        compare deployed stack with current state
  * `cdk synth`       emits the synthesized CloudFormation template
diff --git a/packages/aws-cdk/lib/init-templates/sample-app/typescript/jest.config.js b/packages/aws-cdk/lib/init-templates/sample-app/typescript/jest.config.js
@@ -0,0 +1,9 @@
+module.exports = {
+    "roots": [
+      "<rootDir>/test"
+    ],
+    testMatch: [ '**/*.test.ts'],
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+  }
diff --git a/packages/aws-cdk/lib/init-templates/sample-app/typescript/package.template.json b/packages/aws-cdk/lib/init-templates/sample-app/typescript/package.template.json
@@ -7,10 +7,15 @@
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
+    "test": "jest",
     "cdk": "cdk"
   },
   "devDependencies": {
     "aws-cdk": "^%cdk-version%",
+    "@aws-cdk/assert": "^1.6.1",
+    "@types/jest": "^24.0.18",
+    "jest": "^24.9.0",
+    "ts-jest": "^24.0.2",
     "ts-node": "^8.1.0",
     "typescript": "~3.6.2"
   },

diff --git a/packages/aws-cdk/lib/init-templates/sample-app/typescript/test/%name%.test.template.ts b/packages/aws-cdk/lib/init-templates/sample-app/typescript/test/%name%.test.template.ts
@@ -0,0 +1,21 @@
+import { expect as expectCDK, haveResource } from '@aws-cdk/assert';
+import cdk = require('@aws-cdk/core');
+import %name.PascalCased% = require('../lib/%name%-stack');
+
+test('SQS Queue Created', () => {
+    const app = new cdk.App();
+    // WHEN
+    const stack = new %name.PascalCased%.%name.PascalCased%Stack(app, 'MyTestStack');
+    // THEN
+    expectCDK(stack).to(haveResource("AWS::SQS::Queue",{
+      VisibilityTimeout: 300
+    }));
+});
+
+test('SNS Topic Created', () => {
+  const app = new cdk.App();
+  // WHEN
+  const stack = new %name.PascalCased%.%name.PascalCased%Stack(app, 'MyTestStack');
+  // THEN
+  expectCDK(stack).to(haveResource("AWS::SNS::Topic"));
+});
diff --git a/packages/aws-cdk/test/integ/init/test-typescript.sh b/packages/aws-cdk/test/integ/init/test-typescript.sh
@@ -18,5 +18,6 @@ for template in app sample-app lib; do
     cdk init -l typescript -t $template
     npm ls # this will fail if we have unmet peer dependencies
     npm run build
+    npm run test
     cdk synth
 done