Update example to upload directly to AWS Lambda

ericmatte · ericmatte · commit 94f923112c6d · 2020-11-20T10:12:07.000-05:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -2,54 +2,61 @@ name: Release
 
 on:
   release:
-    types: [prereleased, edited]
+    types: [published]
 
 jobs:
-  build:
-    name: Build GitHub action and AWS lambda function
+  test:
+    name: Test lambda function
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-        with:
-          ref: "main"
 
       - name: Install dependencies
         run: yarn install
 
-      - name: Get release tag
-        id: ref
-        run: |
-          TAG=${REF#"$PREFIX"}
-          echo "::set-output name=tag::$TAG"
-        env:
-          REF: ${{ github.ref }}
-          PREFIX: "refs/tags/"
+      - name: Test
+        run: yarn test
 
-      - name: Update package.json version
-        run: |
-          tmp=$(mktemp)
-          VERSION=${TAG#"v"}
-          jq ".version = \"$VERSION\"" package.json > "$tmp"
-          mv "$tmp" package.json
-        env:
-          TAG: ${{ steps.ref.outputs.tag }}
+  build-and-upload:
+    name: Build GitHub action and AWS lambda function
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: yarn install
 
       - name: Build lambda distribution
         run: yarn dist
 
-      - name: Setup GitHub git user
-        run: |
-          git config user.name github-actions
-          git config user.email github-actions@github.com
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
 
-      - name: Push build
+      - name: Upload new build to AWS lambda
         run: |
-          git add package.json ping-slack/dist/index.js terraform/lambda.zip
-          git commit -m "Build app for release"
-          git push
+          aws lambda update-function-code --function-name "$FUNCTION_ARN" --zip-file "fileb://$(pwd)/out/lambda.zip"
+        env:
+          FUNCTION_ARN: ${{ secrets.LAMBDA_FUNCTION_ARN }}
 
-      - name: Move release tag to latest commit
-        run: |
-          git tag --force "${{ steps.ref.outputs.tag }}" $(git rev-parse HEAD)
-          git push --force --tags
+  test-new-version:
+    name: Test uploaded lambda
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Integration tests
+        run: yarn test
+        env:
+          LAMBDA_URL: ${{ secrets.LAMBDA_URL }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -34,8 +34,8 @@ jobs:
         env:
           AWS_DEFAULT_REGION: ca-central-1 # https://github.com/hashicorp/terraform/issues/21408#issuecomment-495746582
 
-  build:
-    name: Build lambda function
+  test:
+    name: Test lambda function
     runs-on: ubuntu-latest
 
     steps:
@@ -44,11 +44,11 @@ jobs:
       - name: Install dependencies
         run: yarn install
 
-      - name: Build lambda distribution
-        run: yarn dist
+      - name: Test
+        run: yarn test
 
-  test:
-    name: Test lambda function
+  build:
+    name: Build lambda function
     runs-on: ubuntu-latest
 
     steps:
@@ -57,5 +57,5 @@ jobs:
       - name: Install dependencies
         run: yarn install
 
-      - name: Test
-        run: yarn test
+      - name: Build lambda distribution
+        run: yarn dist
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 node_modules
 /dist
+/out
 .terraform
 yarn-error.log
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,10 +2,9 @@
 
 ## Publish a new release
 
+- Bump [`package.json`](./package.json) version (ie.: 1.0.0)
 - Create a new release (ie.: v1.0.0)
-- Check `This is a pre-release`
-- A GitHub workflow will run and build the code and update the release.
-- Once the build is completed, publish the release.
+- A GitHub workflow will automatically run, build and upload the new code to AWS Lambda.
 
 ## Testing
 
@@ -20,4 +19,4 @@ yarn test
 
 From the [Building Lambda functions with Node.js](https://docs.aws.amazon.com/lambda/latest/dg/lambda-nodejs.html) documentation:
 
-> Your code runs in an environment that includes the AWS SDK for JavaScript, with credentials from an AWS Identity and Access Management (IAM) role that you manage.
+> Your code runs in an environment that includes the AWS SDK for JavaScript, with credentials from an AWS Identity and Access Management (IAM) role that you manage.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Add the module to your [Terraform](https://www.terraform.io/) project:
 
 ```terraform
 module "terraform_aws_lambda" {
-  source      = "git@github.com:agendrix/terraform-aws-lambda.git//terraform?ref=v0.1.0"
+  source      = "git@github.com:agendrix/terraform-aws-lambda.git//terraform?ref=v0.2.0"
   lambda_name = "my-typescript-lambda"
   role_arn    = aws_iam_role.iam_for_lambda.role_arn
 }
diff --git a/lambda/index.ts b/lambda/index.ts
@@ -1,5 +1,6 @@
-import { APIGatewayEvent, APIGatewayProxyStructuredResultV2, Handler } from "aws-lambda";
+import { APIGatewayEvent, APIGatewayProxyStructuredResultV2 } from "aws-lambda";
 import AWS from "aws-sdk";
+import { Handler } from "./types";
 
 const handler: Handler<APIGatewayEvent, APIGatewayProxyStructuredResultV2> = async (event, context) => {
   const s3 = new AWS.S3();
@@ -14,7 +15,7 @@ const handler: Handler<APIGatewayEvent, APIGatewayProxyStructuredResultV2> = asy
   return {
     statusCode: 200,
     body: JSON.stringify(data),
-    headers: { "Content-Type": "text/html; charset=utf-8" },
+    headers: { "content-type": "application/json" },
     isBase64Encoded: false,
   };
 };
diff --git a/lambda/types.d.ts b/lambda/types.d.ts
@@ -0,0 +1,3 @@
+import { Context } from "aws-lambda";
+
+export type Handler<TEvent = any, TResult = any> = (event: TEvent, context: Context) => Promise<TResult>;
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
   "name": "terraform-aws-lambda",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "scripts": {
     "test": "mocha -r ts-node/register test/**/*.spec.ts",
     "test:watch": "yarn test --watch --watch-extensions ts",
     "build": "rm -rf ./dist && yarn tsc",
     "postbuild": "cp package.json yarn.lock LICENSE README.md ./dist && cd dist && yarn install --production",
-    "zip": "cd dist && zip -q -FSr ../terraform/lambda .",
+    "zip": "cd dist && mkdir -p ../out && zip -q -FSr ../out/lambda .",
     "dist": "yarn build && yarn zip"
   },
   "devDependencies": {
@@ -16,6 +16,7 @@
     "aws-sdk": "^2.785.0",
     "mocha": "^6.2.0",
     "prettier": "^2.1.2",
+    "request": "^2.88.2",
     "ts-node": "^9.0.0",
     "typescript": "^4.0.3"
   },
diff --git a/terraform/lambda.zip b/terraform/lambda.zip
diff --git a/terraform/main.tf b/terraform/main.tf
@@ -1,20 +1,23 @@
-locals {
-  zip_path = "${path.module}/lambda.zip"
+data "archive_file" "dummy" {
+  type        = "zip"
+  output_path = "${path.module}/.terraform/dummy_lambda.zip"
+
+  source {
+    content  = "hello"
+    filename = "dummy.txt"
+  }
 }
 
 resource "aws_lambda_function" "lambda" {
-  filename      = local.zip_path
+  filename      = data.archive_file.dummy.output_path
   function_name = var.lambda_name
   role          = var.role_arn
   handler       = "index.handler"
 
-  source_code_hash = filebase64sha256(local.zip_path)
+  timeout     = var.timeout
+  memory_size = var.memory_size
 
   runtime = "nodejs12.x"
-
-  environment {
-    variables = {}
-  }
 }
 
 resource "aws_cloudwatch_log_group" "log_group" {
diff --git a/terraform/variables.tf b/terraform/variables.tf
@@ -3,6 +3,18 @@ variable "lambda_name" {
   type        = string
 }
 
+variable "timeout" {
+  description = "Lambda timeout"
+  type        = number
+  default     = 3
+}
+
+variable "memory_size" {
+  description = "Lambda memory size"
+  type        = number
+  default     = 128
+}
+
 variable "role_arn" {
   description = "Lambda IAM role"
   type        = string
diff --git a/terraform/versions.tf b/terraform/versions.tf
@@ -4,5 +4,8 @@ terraform {
     aws = {
       source = "hashicorp/aws"
     }
+    archive = {
+      source = "hashicorp/archive"
+    }
   }
 }
diff --git a/test/helpers/post-request.ts b/test/helpers/post-request.ts
@@ -0,0 +1,12 @@
+import { post, RequestCallback, Response } from "request";
+
+export async function postRequest<Payload>(url: string, payload: Payload) {
+  return new Promise<Response>((resolve, reject) => {
+    const callBack: RequestCallback = (error, response) => {
+      if (error) return reject(error);
+      return resolve(response);
+    };
+
+    post(url, { json: payload, headers: { "content-type": "application/json" } }, callBack);
+  });
+}
diff --git a/test/index.spec.ts b/test/index.spec.ts
@@ -3,33 +3,49 @@ import assert from "assert";
 import "./mocks";
 
 import { __test__ } from "../lambda/index";
-import { APIGatewayProxyStructuredResultV2 } from "aws-lambda";
 import { S3 } from "aws-sdk";
 import { MOCKED_BUCKETS, MOCKED_OWNER } from "./mocks/libs/aws-sdk";
+import { postRequest } from "./helpers/post-request";
 
 const handler = __test__.handler;
 
-describe("exports.handler", () => {
-  const fakeEvent: any = {};
-  const fakeContext: any = {};
-  const fakeCallback = () => {};
+const LAMBDA_URL = process.env.LAMBDA_URL;
 
-  it("returns 200 with Hello World", async () => {
-    const response = (await handler(fakeEvent, fakeContext, fakeCallback)) as APIGatewayProxyStructuredResultV2;
+if (LAMBDA_URL !== undefined) {
+  /* Integration tests with the deployed lambda */
+  describe("lambda POST call", () => {
+    it("returns 200 with Hello World", async () => {
+      const response = await postRequest(LAMBDA_URL, {});
 
-    assert.strictEqual(response.statusCode, 200);
-    assert.strictEqual(JSON.parse(response.body || "").text, "Hello World");
+      assert.strictEqual(response.statusCode, 200);
+      assert.strictEqual(response.headers?.["content-type"], "application/json");
+    });
   });
-
-  it("returns a list of S3 buckets", async () => {
-    const response = (await handler(fakeEvent, fakeContext, fakeCallback)) as APIGatewayProxyStructuredResultV2;
-    const listBucketsOutput: S3.ListBucketsOutput = JSON.parse(response.body || "").listBuckets;
-
-    assert.strictEqual(response.statusCode, 200);
-    assert.strictEqual(listBucketsOutput.Owner?.DisplayName, MOCKED_OWNER);
-    assert.deepStrictEqual(
-      listBucketsOutput.Buckets?.map(b => b.Name),
-      MOCKED_BUCKETS
-    );
+} else {
+  /* Local tests */
+  describe("exports.handler", () => {
+    const fakeEvent: any = {};
+    const fakeContext: any = {};
+
+    it("returns 200 with Hello World", async () => {
+      const response = await handler(fakeEvent, fakeContext);
+
+      assert.strictEqual(response.statusCode, 200);
+      assert.strictEqual(response.headers?.["content-type"], "application/json");
+      assert.strictEqual(JSON.parse(response.body || "").text, "Hello World");
+    });
+
+    it("returns a list of S3 buckets", async () => {
+      const response = await handler(fakeEvent, fakeContext);
+      const listBucketsOutput: S3.ListBucketsOutput = JSON.parse(response.body || "").listBuckets;
+
+      assert.strictEqual(response.statusCode, 200);
+      assert.strictEqual(response.headers?.["content-type"], "application/json");
+      assert.strictEqual(listBucketsOutput.Owner?.DisplayName, MOCKED_OWNER);
+      assert.deepStrictEqual(
+        listBucketsOutput.Buckets?.map(b => b.Name),
+        MOCKED_BUCKETS
+      );
+    });
   });
-});
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ Add the module to your [Terraform](https://www.terraform.io/) project:`
`10`	`10`
`11`	`11`	```terraform
`12`	`12`	`module "terraform_aws_lambda" {`
`13`		`- source = "[email protected]:agendrix/terraform-aws-lambda.git//terraform?ref=v0.1.0"`
	`13`	`+ source = "[email protected]:agendrix/terraform-aws-lambda.git//terraform?ref=v0.2.0"`
`14`	`14`	`lambda_name = "my-typescript-lambda"`
`15`	`15`	`role_arn = aws_iam_role.iam_for_lambda.role_arn`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { Context } from "aws-lambda";`
	`2`	`+`
	`3`	`+export type Handler<TEvent = any, TResult = any> = (event: TEvent, context: Context) => Promise<TResult>;`