Merge pull request #6 from trussworks/barry-012

0.12'ify module

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   validate:
     docker:
-      - image: trussworks/circleci-docker-primary:a18ba9987556eec2e48354848a3c9fb4d5b69ac8
+      - image: trussworks/circleci-docker-primary:tf12-4c1fd54273446484259597ae3da9deb2806498ed
     steps:
       - checkout
       - restore_cache:

.dependabot/config.yml

@@ -0,0 +1,12 @@
+version: 1
+update_configs:
+  # Keep go modules up to date, batching pull requests weekly
+  - package_manager: "go:modules"
+    directory: "/"
+    update_schedule: "weekly"
+    # Apply default reviewer @trussworks/waddlers group to PRs
+    default_reviewers:
+      - "trussworks/waddlers"
+    # Apply dependencies label to PRs
+    default_labels:
+      - "dependencies"

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.terraform
+terraform.tfstate
+terraform.tfstate.backup
+terraform.tfstate.*.backup

.golangci.yml

@@ -0,0 +1,6 @@
+linters:
+  enable:
+     - gosec
+     - golint
+     - gofmt
+     - goimports

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: git://github.com/pre-commit/pre-commit-hooks
-    rev: v2.2.3
+    rev: v2.4.0
     hooks:
       - id: check-json
       - id: check-merge-conflict
@@ -12,13 +12,17 @@ repos:
       - id: trailing-whitespace
 
   - repo: git://github.com/igorshubovych/markdownlint-cli
-    rev: v0.17.0
+    rev: v0.19.0
     hooks:
       - id: markdownlint
 
   - repo: git://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.12.0
+    rev: v1.21.0
     hooks:
       - id: terraform_docs
       - id: terraform_fmt
-      - id: terraform_validate_no_variables
+
+  - repo: git://github.com/golangci/golangci-lint
+    rev: v1.21.0
+    hooks:
+      - id: golangci-lint

Makefile

@@ -0,0 +1,17 @@
+.PHONY: ensure_pre_commit
+ensure_pre_commit: .git/hooks/pre-commit ## Ensure pre-commit is installed
+.git/hooks/pre-commit: /usr/local/bin/pre-commit
+	pre-commit install
+	pre-commit install-hooks
+
+.PHONY: pre_commit_tests
+pre_commit_tests: ensure_pre_commit ## Run pre-commit tests
+	pre-commit run --all-files
+
+.PHONY: test
+test: pre_commit_tests
+	go test -count 1 -v -timeout 90m ./test/...
+
+.PHONY: clean
+clean:
+	rm -f .*.stamp

README.md

@@ -1,4 +1,3 @@
-<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 Creates an ECS cluster backed by an AutoScaling Group.
 
 The cluster is minimally configured and expects any ECS service added will
@@ -39,6 +38,14 @@ module "app_ecs_cluster" {
 }
 ```
 
+## Terraform Versions
+
+Terraform 0.12. Pin module version to ~> 2.0. Submit pull-requests to master branch.
+
+Terraform 0.11. Pin module version to ~> 1.0. Submit pull-requests to terraform011 branch.
+
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
@@ -50,7 +57,7 @@ module "app_ecs_cluster" {
 | max\_size | Maxmimum instance count. | string | `"2"` | no |
 | min\_size | Minimum instance count. | string | `"2"` | no |
 | name | The ECS cluster name this will launching instances for. | string | n/a | yes |
-| subnet\_ids | A list of subnet IDs to launch resources in. | list | n/a | yes |
+| subnet\_ids | A list of subnet IDs to launch resources in. | list(string) | n/a | yes |
 | use\_AmazonEC2ContainerServiceforEC2Role\_policy | Attaches the AWS managed AmazonEC2ContainerServiceforEC2Role policy to the ECS instance role. | string | `"true"` | no |
 | vpc\_id | The id of the VPC to launch resources in. | string | n/a | yes |
 
@@ -63,3 +70,29 @@ module "app_ecs_cluster" {
 | ecs\_instance\_role | The name of the ECS instance role. |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+
+## Developer Setup
+
+Install dependencies (macOS)
+
+```shell
+brew install pre-commit go terraform terraform-docs
+pre-commit install --install-hooks
+```
+
+### Testing
+
+[Terratest](https://github.com/gruntwork-io/terratest) is being used for
+automated testing with this module. Tests in the `test` folder can be run
+locally by running the following command:
+
+```text
+make test
+```
+
+Or with aws-vault:
+
+```text
+AWS_VAULT_KEYCHAIN_NAME=<NAME> aws-vault exec <PROFILE> -- make test
+```

examples/simple/main.tf

@@ -0,0 +1,39 @@
+data "aws_ami" "ecs_ami" {
+  most_recent = true
+  owners      = ["amazon"]
+
+  filter {
+    name   = "name"
+    values = ["amzn-ami-*-amazon-ecs-optimized"]
+  }
+}
+
+module "app_ecs_cluster" {
+  source = "../../"
+
+  name        = var.test_name
+  environment = "test"
+
+  image_id      = "${data.aws_ami.ecs_ami.image_id}"
+  instance_type = "t2.micro"
+
+  vpc_id           = module.vpc.vpc_id
+  subnet_ids       = module.vpc.private_subnets
+  desired_capacity = 1
+  max_size         = 1
+  min_size         = 1
+}
+
+module "vpc" {
+  source  = "terraform-aws-modules/vpc/aws"
+  version = "~> 2"
+
+  name            = var.test_name
+  cidr            = "10.0.0.0/16"
+  azs             = var.vpc_azs
+  private_subnets = ["10.0.101.0/24", "10.0.102.0/24", "10.0.103.0/24"]
+  public_subnets  = ["10.0.104.0/24", "10.0.105.0/24", "10.0.106.0/24"]
+
+  enable_nat_gateway = true
+  single_nat_gateway = true
+}

examples/simple/outputs.tf

@@ -0,0 +1,14 @@
+output "ecs_instance_role" {
+  description = "The ECS Instanc Role."
+  value       = module.app_ecs_cluster.ecs_instance_role
+}
+
+output "ecs_cluster_name" {
+  description = "The ECS Cluster Name."
+  value       = module.app_ecs_cluster.ecs_cluster_name
+}
+
+output "ecs_cluster_arn" {
+  description = "The ECS Cluster ARN."
+  value       = module.app_ecs_cluster.ecs_cluster_arn
+}

examples/simple/variables.tf

@@ -0,0 +1,7 @@
+variable "test_name" {
+  type = string
+}
+
+variable "vpc_azs" {
+  type = list(string)
+}

go.mod

@@ -0,0 +1,9 @@
+module github.com/trussworks/terraform-aws-ecs-cluster
+
+go 1.13
+
+require (
+	github.com/aws/aws-sdk-go v1.23.8
+	github.com/gruntwork-io/terratest v0.23.0
+	github.com/stretchr/testify v1.4.0
+)