Add template project

ericmatte · ericmatte · commit ee65d1f0d0a2 · 2020-11-10T17:52:22.000-05:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,52 @@
+name: Release
+
+on:
+  release:
+    types: [prereleased, edited]
+
+jobs:
+  build:
+    name: Build GitHub action and AWS 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: Update package.json version
+        run: |
+          tmp=$(mktemp)
+          jq '.version = "${{ steps.ref.outputs.tag }}"' package.json > "$tmp"
+          mv "$tmp" package.json
+
+      - 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: Push build
+        run: |
+          git add package.json ping-slack/dist/index.js terraform/lambda.zip
+          git commit -m "Build app for release"
+          git push
+
+      - name: Move release tag to latest commit
+        run: |
+          git tag --force "${{ steps.ref.outputs.tag }}" $(git rev-parse HEAD)
+          git push --force --tags
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,61 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  terraform:
+    name: Validate Terraform code
+    runs-on: ubuntu-latest
+
+    env:
+      TERRAFORM_VERSION: 0.13.5
+      TERRAFORM_WORK_DIR: ./terraform
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Terraform
+        uses: hashicorp/setup-terraform@v1
+        with:
+          terraform_version: ${{ env.TERRAFORM_VERSION }}
+
+      - name: Terraform Init
+        working-directory: ${{ env.TERRAFORM_WORK_DIR }}
+        run: terraform init
+
+      - name: Terraform Validate
+        working-directory: ${{ env.TERRAFORM_WORK_DIR }}
+        run: terraform validate
+        env:
+          AWS_DEFAULT_REGION: ca-central-1 # https://github.com/hashicorp/terraform/issues/21408#issuecomment-495746582
+
+  build:
+    name: Build lambda function
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build lambda distribution
+        run: yarn dist
+
+  test:
+    name: Test lambda function
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Test
+        run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+node_modules
+/dist
+.terraform
+yarn-error.log
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,6 @@
+{
+  "arrowParens": "avoid",
+  "printWidth": 120,
+  "singleQuote": false,
+  "quoteProps": "consistent"
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "hashicorp.terraform", "annsk.alignment"]
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,25 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Mocha Current File",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+      "args": ["--no-timeouts", "--colors", "${file}", "--require", "ts-node/register"],
+      "console": "integratedTerminal",
+      "sourceMaps": true,
+      "internalConsoleOptions": "neverOpen"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug File",
+      "program": "${workspaceFolder}/node_modules/.bin/ts-node",
+      "args": ["${file}"]
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+  "editor.formatOnSave": true,
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,23 @@
+# Contributing
+
+## Publish a new release
+
+- 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.
+
+## Testing
+
+```bash
+yarn install
+yarn test
+```
+
+## Note about `aws-sdk`
+
+`aws-sdk` is placed as a devDependency in the projet in order to build smaller zip file for the distribution.
+
+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.
diff --git a/README.md b/README.md
@@ -1,2 +1,32 @@
-# terraform-aws-lambda
-Template repository for creating a TypeScript AWS Lambda with Terraform
+# Terraform AWS Lambda Template Repository
+
+_Template repository for creating a TypeScript AWS Lambda with Terraform_
+
+![Release](https://github.com/agendrix/terraform-aws-lambda/workflows/Release/badge.svg) ![Tests](https://github.com/agendrix/terraform-aws-lambda/workflows/Tests/badge.svg?branch=main)
+
+## How to use with Terraform
+
+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=v1.0.0"
+  lambda_name = "my-typescript-lambda"
+  role_arn    = aws_iam_role.iam_for_lambda.role_arn
+}
+```
+
+See [Resource: aws_lambda_function](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function) for more information about the required `aws_iam_role`.
+
+In order to be able to receive http requests to the lambda, you will need to hook it up with an AWS API Gateway.
+You can do so by following this guide: [Serverless Applications with AWS Lambda and API Gateway](https://learn.hashicorp.com/tutorials/terraform/lambda-api-gateway).
+
+---
+
+Your AWS lambda should now be available at https://console.aws.amazon.com/lambda/.
+
+Logs from the lambda will be available in AWS CloudWatch `/aws/lambda/${yourLambdaName}` log group.
+
+## Release a new version of the Terraform module
+
+See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more info.
diff --git a/lambda/index.ts b/lambda/index.ts
@@ -0,0 +1,26 @@
+import { APIGatewayEvent, APIGatewayProxyStructuredResultV2, Handler } from "aws-lambda";
+import AWS from "aws-sdk";
+
+const handler: Handler<APIGatewayEvent, APIGatewayProxyStructuredResultV2> = async (event, context) => {
+  const s3 = new AWS.S3();
+
+  const data = {
+    text: "Hello World",
+    event,
+    context,
+    listBuckets: await s3.listBuckets().promise(),
+  };
+
+  return {
+    statusCode: 200,
+    body: JSON.stringify(data),
+    headers: { "Content-Type": "text/html; charset=utf-8" },
+    isBase64Encoded: false,
+  };
+};
+
+exports.handler = handler;
+
+export const __test__ = {
+  handler,
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,24 @@
+{
+  "name": "terraform-aws-lambda",
+  "version": "v0.0.0",
+  "description": "",
+  "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 .",
+    "dist": "yarn build && yarn zip"
+  },
+  "devDependencies": {
+    "@types/aws-lambda": "^8.10.64",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^14.11.2",
+    "aws-sdk": "^2.785.0",
+    "mocha": "^6.2.0",
+    "prettier": "^2.1.2",
+    "ts-node": "^9.0.0",
+    "typescript": "^4.0.3"
+  },
+  "dependencies": {}
+}
diff --git a/terraform/lambda.zip b/terraform/lambda.zip
diff --git a/terraform/main.tf b/terraform/main.tf
@@ -0,0 +1,23 @@
+locals {
+  zip_path = "${path.module}/lambda.zip"
+}
+
+resource "aws_lambda_function" "lambda" {
+  filename      = local.zip_path
+  function_name = var.lambda_name
+  role          = var.role_arn
+  handler       = "index.handler"
+
+  source_code_hash = filebase64sha256(local.zip_path)
+
+  runtime = "nodejs12.x"
+
+  environment {
+    variables = {}
+  }
+}
+
+resource "aws_cloudwatch_log_group" "log_group" {
+  name              = "/aws/lambda/${aws_lambda_function.lambda.function_name}"
+  retention_in_days = 14
+}
diff --git a/terraform/outputs.tf b/terraform/outputs.tf
@@ -0,0 +1,3 @@
+output "lambda_function" {
+  value = aws_lambda_function.lambda
+}
diff --git a/terraform/variables.tf b/terraform/variables.tf
@@ -0,0 +1,9 @@
+variable "lambda_name" {
+  description = "Lambda function name"
+  type        = string
+}
+
+variable "role_arn" {
+  description = "Lambda IAM role"
+  type        = string
+}
diff --git a/terraform/versions.tf b/terraform/versions.tf
@@ -0,0 +1,8 @@
+terraform {
+  required_version = ">= 0.13"
+  required_providers {
+    aws = {
+      source = "hashicorp/aws"
+    }
+  }
+}
diff --git a/test/index.spec.ts b/test/index.spec.ts
@@ -0,0 +1,35 @@
+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";
+
+const handler = __test__.handler;
+
+describe("exports.handler", () => {
+  const fakeEvent: any = {};
+  const fakeContext: any = {};
+  const fakeCallback = () => {};
+
+  it("returns 200 with Hello World", async () => {
+    const response = (await handler(fakeEvent, fakeContext, fakeCallback)) as APIGatewayProxyStructuredResultV2;
+
+    assert.strictEqual(response.statusCode, 200);
+    assert.strictEqual(JSON.parse(response.body || "").text, "Hello World");
+  });
+
+  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
+    );
+  });
+});
diff --git a/test/mocks/index.ts b/test/mocks/index.ts
@@ -0,0 +1 @@
+import "./libs/aws-sdk";
diff --git a/test/mocks/libs/aws-sdk.spec.ts b/test/mocks/libs/aws-sdk.spec.ts
@@ -0,0 +1,19 @@
+import { MOCKED_BUCKETS, MOCKED_OWNER } from "./aws-sdk";
+import assert from "assert";
+import AWS from "aws-sdk";
+
+describe("Mock aws-sdk", () => {
+  describe("S3", () => {
+    it("listBuckets", async () => {
+      const s3 = new AWS.S3();
+
+      const listBucketsOutput = await s3.listBuckets().promise();
+
+      assert.strictEqual(listBucketsOutput.Owner?.DisplayName, MOCKED_OWNER);
+      assert.deepStrictEqual(
+        listBucketsOutput.Buckets?.map(b => b.Name),
+        MOCKED_BUCKETS
+      );
+    });
+  });
+});
diff --git a/test/mocks/libs/aws-sdk.ts b/test/mocks/libs/aws-sdk.ts
diff --git a/test/tsconfig.json b/test/tsconfig.json
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "recommendations": ["esbenp.prettier-vscode", "hashicorp.terraform", "annsk.alignment"]`
	`3`	`+}`