feat(@whook/example): add AWS build to @whook/example

nfroidure · May 19, 2020 · 79f70b3 · 79f70b3
1 parent 21adf4d
commit 79f70b3
Show file tree

Hide file tree

Showing 23 changed files with 4,875 additions and 14 deletions.
diff --git a/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap b/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap
diff --git a/packages/whook-create/src/services/createWhook.test.ts b/packages/whook-create/src/services/createWhook.test.ts
@@ -182,6 +182,7 @@ Mr Bean
         },
         "dependencies": Object {
           "@whook/authorization": "<current_version>",
+          "@whook/aws-lambda": "^3.1.3",
           "@whook/cli": "<current_version>",
           "@whook/cors": "<current_version>",
           "@whook/http-router": "<current_version>",
@@ -213,6 +214,7 @@ Mr Bean
           "@typescript-eslint/parser": "^2.33.0",
           "axios": "^0.19.2",
           "babel-eslint": "^10.1.0",
+          "babel-loader": "^8.0.6",
           "babel-plugin-knifecycle": "^1.2.0",
           "eslint": "^7.0.0",
           "eslint-plugin-prettier": "^3.1.3",
@@ -222,6 +224,7 @@ Mr Bean
           "prettier": "^2.0.5",
           "rimraf": "^3.0.2",
           "typescript": "^3.9.2",
+          "webpack": "4.41.5",
         },
         "engines": Object {
           "node": ">=10.19.0",
@@ -445,6 +448,7 @@ Mr Bean
         },
         "dependencies": Object {
           "@whook/authorization": "<current_version>",
+          "@whook/aws-lambda": "^3.1.3",
           "@whook/cli": "<current_version>",
           "@whook/cors": "<current_version>",
           "@whook/http-router": "<current_version>",
@@ -476,6 +480,7 @@ Mr Bean
           "@typescript-eslint/parser": "^2.33.0",
           "axios": "^0.19.2",
           "babel-eslint": "^10.1.0",
+          "babel-loader": "^8.0.6",
           "babel-plugin-knifecycle": "^1.2.0",
           "eslint": "^7.0.0",
           "eslint-plugin-prettier": "^3.1.3",
@@ -485,6 +490,7 @@ Mr Bean
           "prettier": "^2.0.5",
           "rimraf": "^3.0.2",
           "typescript": "^3.9.2",
+          "webpack": "4.41.5",
         },
         "engines": Object {
           "node": ">=10.19.0",
@@ -693,6 +699,7 @@ Mr Bean
         },
         "dependencies": Object {
           "@whook/authorization": "<current_version>",
+          "@whook/aws-lambda": "^3.1.3",
           "@whook/cli": "<current_version>",
           "@whook/cors": "<current_version>",
           "@whook/http-router": "<current_version>",
@@ -724,6 +731,7 @@ Mr Bean
           "@typescript-eslint/parser": "^2.33.0",
           "axios": "^0.19.2",
           "babel-eslint": "^10.1.0",
+          "babel-loader": "^8.0.6",
           "babel-plugin-knifecycle": "^1.2.0",
           "eslint": "^7.0.0",
           "eslint-plugin-prettier": "^3.1.3",
@@ -733,6 +741,7 @@ Mr Bean
           "prettier": "^2.0.5",
           "rimraf": "^3.0.2",
           "typescript": "^3.9.2",
+          "webpack": "4.41.5",
         },
         "engines": Object {
           "node": ">=10.19.0",

diff --git a/packages/whook-example/README.md b/packages/whook-example/README.md
@@ -40,6 +40,52 @@ List available commands:
 ```sh
 npx whook ls
 ```
+## Deploying with AWS Lambda
+
+First install Terraform:
+```sh
+wget https://releases.hashicorp.com/terraform/0.12.24/terraform_0.12.24_linux_amd64.zip
+mkdir .bin
+unzip -d .bin terraform_0.12.24_linux_amd64.zip
+rm terraform_0.12.24_linux_amd64.zip
+```
+
+Then initialize the Terraform configuration:
+```sh
+.bin/terraform init ./terraform;
+```
+
+Create a new workspace:
+```sh
+.bin/terraform workspace new staging
+```
+
+Build the lambdas:
+```sh
+NODE_ENV=staging npm run build
+```
+
+Build the commands Terraform depends on:
+```sh
+npm run compile
+```
+
+Plan the deployment:
+```sh
+.bin/terraform plan -out=terraform.plan terraform
+```
+
+Apply changes:
+```sh
+.bin/terraform apply terraform.plan
+```
+
+Finally retrieve the API URL and add and enjoy!
+```sh
+.bin/terraform output api_url
+curl "$(.bin/terraform output api_url)staging/v3/ping"
+# {"pong":"pong"}
+```
 
 ## Debug
 Execute a handler in isolation:
@@ -57,6 +103,18 @@ Debug `knifecycle` internals (dependency injection issues):
 DEBUG=knifecycle npm run dev
 ```
 
+Debug built lambdas:
+```sh
+## HTTP
+NODE_ENV=staging npx whook testHTTPLambda --name putEcho \
+ --parameters '{ "body": { "echo": "Hey!" } }'
+## Cron
+NODE_ENV=staging npx whook testCronLambda --name handleMinutes
+## Consumer
+NODE_ENV=staging npx whook testConsumerLambda --name handleMessages \
+ --event '{ "Records": [{ "test": "test" }] }'
+```
+
 [//]: # (::contents:end)
 
 # Authors