Add codefresh (#57)

osterman · web-flow · commit 90ca5cfd7f4d · 2019-06-17T18:52:19.000-07:00
* Add tests

* Update README
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 
 [![Cloud Posse][logo]](https://cpco.io/homepage)
 
-# terraform-aws-dynamic-subnets [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-dynamic-subnets.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-dynamic-subnets) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-dynamic-subnets.svg)](https://github.com/cloudposse/terraform-aws-dynamic-subnets/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
+# terraform-aws-dynamic-subnets [![Codefresh Build Status](https://g.codefresh.io/api/badges/pipeline/cloudposse/cloudposse%2Fterraform-aws-dynamic-subnets%2Ftest?type=cf-1)](https://g.codefresh.io/public/accounts/cloudposse/pipelines/cloudposse/terraform-aws-dynamic-subnets/test) [![Build Status](https://travis-ci.org/cloudposse/terraform-aws-dynamic-subnets.svg?branch=master)](https://travis-ci.org/cloudposse/terraform-aws-dynamic-subnets) [![Latest Release](https://img.shields.io/github/release/cloudposse/terraform-aws-dynamic-subnets.svg)](https://github.com/cloudposse/terraform-aws-dynamic-subnets/releases/latest) [![Slack Community](https://slack.cloudposse.com/badge.svg)](https://slack.cloudposse.com)
 
 
 Terraform module to provision public and private [`subnets`](http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html) in an existing [`VPC`](https://aws.amazon.com/vpc)
@@ -53,6 +53,9 @@ Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest re
 ```hcl
 module "subnets" {
   source              = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=master"
+  providers           = {
+    aws = "aws"
+  }
   namespace           = "cp"
   stage               = "prod"
   name                = "app"
@@ -64,6 +67,8 @@ module "subnets" {
 }
 ```
 
+Learn about [using providers](https://www.terraform.io/docs/configuration-0-11/modules.html#providers-within-modules) with terraform modules. 
+
 
 
 
@@ -174,7 +179,6 @@ Available targets:
 | private_network_acl_id | Network ACL ID that will be added to private subnets. If empty, a new ACL will be created | string | `` | no |
 | public_network_acl_id | Network ACL ID that will be added to public subnets. If empty, a new ACL will be created | string | `` | no |
 | regex_replace_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed | string | `/[^a-zA-Z0-9-]/` | no |
-| region | AWS Region (e.g. `us-east-1`) | string | - | yes |
 | stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | `` | no |
 | subnet_type_tag_key | Key for subnet type tag to provide information about the type of subnets, e.g. `cpco.io/subnet/type=private` or `cpco.io/subnet/type=public` | string | `cpco.io/subnet/type` | no |
 | subnet_type_tag_value_format | This is using the format interpolation symbols to allow the value of the subnet_type_tag_key to be modified. | string | `%s` | no |
diff --git a/README.yaml b/README.yaml
@@ -32,6 +32,9 @@ github_repo: cloudposse/terraform-aws-dynamic-subnets
 
 # Badges to display
 badges:
+  - name: "Codefresh Build Status"
+    image: "https://g.codefresh.io/api/badges/pipeline/cloudposse/cloudposse%2Fterraform-aws-dynamic-subnets%2Ftest?type=cf-1"
+    url: "https://g.codefresh.io/public/accounts/cloudposse/pipelines/cloudposse/terraform-aws-dynamic-subnets/test"
   - name: "Build Status"
     image: "https://travis-ci.org/cloudposse/terraform-aws-dynamic-subnets.svg?branch=master"
     url: "https://travis-ci.org/cloudposse/terraform-aws-dynamic-subnets"
@@ -68,6 +71,9 @@ usage: |-
   ```hcl
   module "subnets" {
     source              = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=master"
+    providers           = {
+      aws = "aws"
+    }
     namespace           = "cp"
     stage               = "prod"
     name                = "app"
@@ -79,6 +85,8 @@ usage: |-
   }
   ```
 
+  Learn about [using providers](https://www.terraform.io/docs/configuration-0-11/modules.html#providers-within-modules) with terraform modules. 
+
 include:
   - "docs/design.md"
   - "docs/targets.md"
@@ -102,3 +110,4 @@ contributors:
     github: "ivan-pinatti"
   - name: "Oscar Sullivan"
     github: "osulli"
+
diff --git a/codefresh/test.yml b/codefresh/test.yml
@@ -0,0 +1,73 @@
+version: '1.0'
+
+stages:
+- Prepare
+- Test
+
+steps:
+  wait:
+    title: Wait
+    stage: Prepare
+    image: codefresh/cli:latest
+    commands:
+      - codefresh get builds --pipeline=${{CF_REPO_NAME}} --status running --limit 1000 -o json | jq --arg id ${{CF_BUILD_ID}} -ser 'flatten|.[-1].id==$id'
+    retry:
+      maxAttempts: 10
+      delay: 20
+      exponentialFactor: 1.1
+
+  main_clone:
+    title: "Clone repository"
+    type: git-clone
+    stage: Prepare
+    description: "Initialize"
+    repo: ${{CF_REPO_OWNER}}/${{CF_REPO_NAME}}
+    git: CF-default
+    revision: ${{CF_REVISION}}
+
+  clean_init:
+    title: Prepare build-harness and test-harness
+    image: ${{TEST_IMAGE}}
+    stage: Prepare
+    commands:
+    - cf_export PATH="/usr/local/terraform/0.11/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+    - make init
+    - git -C build-harness checkout master
+    - make -C test/ clean init TEST_HARNESS_BRANCH=master
+    - make -C test/src clean init
+    - find test/src -name '*.tf' -delete
+
+  test:
+    type: "parallel"
+    title: "Run tests"
+    description: "Run all tests in parallel"
+    stage: Test
+    steps:
+      test_readme_lint:
+        title: "Test README.md updated"
+        stage: "Test"
+        image: ${{TEST_IMAGE}}
+        description: Test "readme/lint"
+        commands:
+        - make readme/lint
+
+      test_module:
+        title: Test module with bats
+        image: ${{TEST_IMAGE}}
+        stage: Test
+        commands:
+        - make -C test/ module
+
+      test_examples_complete:
+        title: Test "examples/complete" with bats
+        image: ${{TEST_IMAGE}}
+        stage: Test
+        commands:
+        - make -C test/ examples/complete
+
+      test_examples_complete_terratest:
+        title: Test "examples/complete" with terratest
+        image: ${{TEST_IMAGE}}
+        stage: Test
+        commands:
+        - make -C test/src
diff --git a/docs/terraform.md b/docs/terraform.md
@@ -21,7 +21,6 @@
 | private_network_acl_id | Network ACL ID that will be added to private subnets. If empty, a new ACL will be created | string | `` | no |
 | public_network_acl_id | Network ACL ID that will be added to public subnets. If empty, a new ACL will be created | string | `` | no |
 | regex_replace_chars | Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. By default only hyphens, letters and digits are allowed, all other chars are removed | string | `/[^a-zA-Z0-9-]/` | no |
-| region | AWS Region (e.g. `us-east-1`) | string | - | yes |
 | stage | Stage, e.g. 'prod', 'staging', 'dev', or 'test' | string | `` | no |
 | subnet_type_tag_key | Key for subnet type tag to provide information about the type of subnets, e.g. `cpco.io/subnet/type=private` or `cpco.io/subnet/type=public` | string | `cpco.io/subnet/type` | no |
 | subnet_type_tag_value_format | This is using the format interpolation symbols to allow the value of the subnet_type_tag_key to be modified. | string | `%s` | no |
diff --git a/examples/complete/fixtures.us-west-1.tfvars b/examples/complete/fixtures.us-west-1.tfvars
@@ -0,0 +1,11 @@
+max_availability_zones = 2
+
+region = "us-west-1"
+
+availability_zones = ["us-west-1b", "us-west-1c"]
+
+namespace = "eg"
+
+name = "vpc"
+
+stage = "test"
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -0,0 +1,29 @@
+module "vpc" {
+  source = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.3.4"
+
+  providers = {
+    aws = "aws"
+  }
+
+  namespace  = "${var.namespace}"
+  stage      = "${var.stage}"
+  name       = "${var.name}"
+  cidr_block = "172.16.0.0/16"
+}
+
+module "subnets" {
+  source = "../../"
+
+  providers = {
+    aws = "aws"
+  }
+
+  availability_zones  = "${var.availability_zones}"
+  namespace           = "${var.namespace}"
+  stage               = "${var.stage}"
+  name                = "${var.name}"
+  vpc_id              = "${module.vpc.vpc_id}"
+  igw_id              = "${module.vpc.igw_id}"
+  cidr_block          = "${module.vpc.vpc_cidr_block}"
+  nat_gateway_enabled = "true"
+}
diff --git a/examples/complete/outputs.tf b/examples/complete/outputs.tf
@@ -0,0 +1,7 @@
+output "public_subnet_cidrs" {
+  value = "${module.subnets.public_subnet_cidrs}"
+}
+
+output "private_subnet_cidrs" {
+  value = "${module.subnets.private_subnet_cidrs}"
+}
diff --git a/examples/complete/provider.tf b/examples/complete/provider.tf
@@ -0,0 +1,3 @@
+provider "aws" {
+  region = "${var.region}"
+}
diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf
@@ -0,0 +1,13 @@
+variable "max_availability_zones" {}
+
+variable "region" {}
+
+variable "availability_zones" {
+  type = "list"
+}
+
+variable "namespace" {}
+
+variable "name" {}
+
+variable "stage" {}
diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
@@ -0,0 +1,3 @@
+terraform {
+  required_version = "~> 0.11.7"
+}
diff --git a/test/.gitignore b/test/.gitignore
@@ -0,0 +1 @@
+.test-harness
diff --git a/test/Makefile b/test/Makefile
@@ -0,0 +1,43 @@
+TEST_HARNESS ?= https://github.com/cloudposse/test-harness.git
+TEST_HARNESS_BRANCH ?= master
+TEST_HARNESS_PATH = $(realpath .test-harness)
+BATS_ARGS ?= --tap
+BATS_LOG ?= test.log
+
+# Define a macro to run the tests
+define RUN_TESTS 
+@echo "Running tests in $(1)"
+@cd $(1) && bats $(BATS_ARGS) $(addsuffix .bats,$(addprefix $(TEST_HARNESS_PATH)/test/terraform/,$(TESTS)))
+endef
+
+default: all
+
+-include Makefile.*
+
+## Provision the test-harnesss
+.test-harness:
+	git clone --depth=1 -b $(TEST_HARNESS_BRANCH) $(TEST_HARNESS) $@
+
+## Initialize the tests
+init: .test-harness
+
+## Install all dependencies (OS specific)
+deps::
+	@exit 0
+
+## Clean up the test harness
+clean:
+	[ "$(TEST_HARNESS_PATH)" == "/" ] || rm -rf $(TEST_HARNESS_PATH)
+  
+## Run all tests
+all: module examples/complete
+
+## Run basic sanity checks against the module itself
+module: export TESTS ?= installed lint get-modules module-pinning get-plugins provider-pinning validate terraform-docs input-descriptions output-descriptions
+module: deps
+	$(call RUN_TESTS, ../)
+
+## Run tests against example
+examples/complete: export TESTS ?= installed lint get-modules get-plugins validate
+examples/complete: deps
+	$(call RUN_TESTS, ../$@)
diff --git a/test/Makefile.alpine b/test/Makefile.alpine
@@ -0,0 +1,5 @@
+ifneq (,$(wildcard /sbin/apk))
+## Install all dependencies for alpine
+deps:: init
+	@apk add --update terraform-docs@cloudposse json2hcl@cloudposse
+endif
diff --git a/test/src/.gitignore b/test/src/.gitignore
@@ -0,0 +1,2 @@
+.gopath
+vendor/
diff --git a/test/src/Gopkg.lock b/test/src/Gopkg.lock
diff --git a/test/src/Gopkg.toml b/test/src/Gopkg.toml
@@ -0,0 +1,7 @@
+[[constraint]]
+  name = "github.com/stretchr/testify"
+  version = "1.2.2"
+
+[prune]
+  go-tests = true
+  unused-packages = true
diff --git a/test/src/Makefile b/test/src/Makefile
diff --git a/test/src/examples_complete_test.go b/test/src/examples_complete_test.go
diff --git a/variables.tf b/variables.tf

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+provider "aws" {`
	`2`	`+ region = "${var.region}"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+terraform {`
	`2`	`+ required_version = "~> 0.11.7"`
	`3`	`+}`