Blog postman draft (#69)

* basic newman generator

* delete original item id

.gitignore

@@ -35,6 +35,8 @@ jspm_packages/
 .yarn-integrity
 # parcel-bundler cache (https://parceljs.org/)
 .cache
+src/newman/newman-*
+src/newman/customized.json
 /lib
 /dist
 /coverage

.projenrc.js

@@ -1,7 +1,7 @@
 const { AwsCdkTypeScriptApp } = require("projen");
 
 const project = new AwsCdkTypeScriptApp({
-  cdkVersion: "1.71.0",
+  cdkVersion: "1.88.0",
   name: "blog-cdk-openapi",
   authorName: "Matt Martz",
   authorUrl: "https://matt.martz.codes",
@@ -16,7 +16,25 @@ const project = new AwsCdkTypeScriptApp({
   },
   devDependencies: {
     "@types/aws-lambda": "8.10.63",
+    "@types/newman": "5.1.2",
+    "@types/postman-collection": "3.5.5",
+    "esbuild": "0.8.34",
+    "newman": "5.2.1",
+    "openapi-to-postmanv2": "2.2.0",
+    "postman-collection": "3.6.9",
   },
+  gitignore: [
+    "src/newman/newman-*",
+    "src/newman/customized.json"
+  ]
 });
 
+project.addScriptCommand(
+  "newman:convert",
+  "openapi2postmanv2 -s openapigenerated.json -o src/newman/api.json -p -c src/newman/config.json"
+);
+
+project.addScriptCommand("newman:pr", "ts-node src/newman/newman.ts -- 1");
+project.addScriptCommand("newman:test", "ts-node src/newman/newman.ts");
+
 project.synth();

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Matt Martz
+   Copyright 2021 Matt Martz
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

openapigenerated.json

@@ -2,10 +2,10 @@
   "openapi": "3.0.1",
   "info": {
     "title": "OpenApi",
-    "version": "2020-11-05T04:33:45.699Z"
+    "version": "2021-02-07T04:47:28.606Z"
   },
   "paths": {
-    "/{hello}/basic": {
+    "/example/{hello}/basic": {
       "post": {
         "parameters": [
           {
@@ -63,7 +63,7 @@
         }
       }
     },
-    "/{hello}/advanced": {
+    "/example/{hello}/advanced": {
       "post": {
         "parameters": [
           {

package.json

@@ -19,7 +19,10 @@
     "synth": "cdk synth",
     "deploy": "cdk deploy",
     "diff": "cdk diff",
-    "destroy": "cdk destroy"
+    "destroy": "cdk destroy",
+    "newman:convert": "openapi2postmanv2 -s openapigenerated.json -o src/newman/api.json -p -c src/newman/config.json",
+    "newman:pr": "ts-node src/newman/newman.ts -- 1",
+    "newman:test": "ts-node src/newman/newman.ts"
   },
   "author": {
     "name": "Matt Martz",
@@ -29,16 +32,22 @@
   "devDependencies": {
     "@types/aws-lambda": "8.10.63",
     "@types/jest": "^26.0.7",
+    "@types/newman": "5.1.2",
     "@types/node": "^10.17.0",
+    "@types/postman-collection": "3.5.5",
     "@typescript-eslint/eslint-plugin": "^4.3.0",
     "@typescript-eslint/parser": "^4.3.0",
-    "aws-cdk": "^1.71.0",
+    "aws-cdk": "^1.88.0",
+    "esbuild": "0.8.34",
     "eslint": "^7.12.1",
     "eslint-import-resolver-node": "^0.3.4",
     "eslint-import-resolver-typescript": "^2.3.0",
     "eslint-plugin-import": "^2.22.1",
     "jest": "^26.4.2",
     "json-schema": "^0.2.5",
+    "newman": "5.2.1",
+    "openapi-to-postmanv2": "2.2.0",
+    "postman-collection": "3.6.9",
     "projen": "^0.3.138",
     "standard-version": "^9.0.0",
     "ts-jest": "^26.1.0",
@@ -47,11 +56,11 @@
   },
   "peerDependencies": {},
   "dependencies": {
-    "@aws-cdk/assert": "^1.71.0",
-    "@aws-cdk/aws-apigateway": "^1.71.0",
-    "@aws-cdk/aws-lambda": "^1.71.0",
-    "@aws-cdk/aws-lambda-nodejs": "^1.71.0",
-    "@aws-cdk/core": "^1.71.0",
+    "@aws-cdk/assert": "^1.88.0",
+    "@aws-cdk/aws-apigateway": "^1.88.0",
+    "@aws-cdk/aws-lambda": "^1.88.0",
+    "@aws-cdk/aws-lambda-nodejs": "^1.88.0",
+    "@aws-cdk/core": "^1.88.0",
     "ts-json-schema-generator": "0.77.0"
   },
   "bundledDependencies": [],
@@ -148,18 +157,5 @@
         "tsconfig": "tsconfig.jest.json"
       }
     }
-  },
-  "targets": {
-    "cdk-lambda": {
-      "context": "node",
-      "includeNodeModules": {
-        "aws-sdk": false
-      },
-      "sourceMap": false,
-      "minify": false,
-      "engines": {
-        "node": ">= 12"
-      }
-    }
   }
 }

src/lambdas/authorizer.ts

@@ -28,5 +28,5 @@ export const handler = async (event: APIGatewayTokenAuthorizerEvent): Promise<AP
 
   const token = event.authorizationToken.replace('Bearer ', '');
 
-  return generatePolicy(token, event.methodArn);
+  return generatePolicy(token, '*');
 };

src/main.ts

@@ -2,7 +2,7 @@ import { join } from 'path';
 import { TokenAuthorizer } from '@aws-cdk/aws-apigateway';
 import { Runtime } from '@aws-cdk/aws-lambda';
 import { NodejsFunction } from '@aws-cdk/aws-lambda-nodejs';
-import { App, Construct, Stack, StackProps } from '@aws-cdk/core';
+import { App, Construct, Duration, Stack, StackProps } from '@aws-cdk/core';
 import { OpenApiConstruct, OpenApiSpec } from './api';
 
 interface MyStackProps extends StackProps {
@@ -35,6 +35,7 @@ export class MyStack extends Stack {
 
     const auth = new TokenAuthorizer(this, 'blogAuthorizer', {
       handler: authorizerLambda,
+      resultsCacheTtl: Duration.millis(0),
     });
 
     const methodResponses = [
@@ -64,7 +65,7 @@ export class MyStack extends Stack {
       models: `${__dirname}/interfaces`,
     });
 
-    api.addEndpoint('/{hello}/basic', 'POST', {
+    api.addEndpoint('/example/{hello}/basic', 'POST', {
       lambda: basicLambda,
       requiredParameters: ['hello'],
       requestModels: {
@@ -73,7 +74,7 @@ export class MyStack extends Stack {
       methodResponses,
     });
 
-    api.addEndpoint('/{hello}/advanced', 'POST', {
+    api.addEndpoint('/example/{hello}/advanced', 'POST', {
       lambda: advancedLambda,
       requiredParameters: ['hello'],
       requestModels: {

src/newman/ApiTestConfig.ts

@@ -0,0 +1,10 @@
+export interface ApiTestConfig {
+  name: string;
+  description?: string;
+  path: string;
+  method: string;
+  status: number;
+  pathParams: Record<string, string>;
+  body?: any;
+  responseValues?: Record<string, string>;
+}