Merge pull request #19 from cytopia/release-0.9

Release 0.9

Author: cytopia

.travis.yml

@@ -9,7 +9,7 @@ sudo: required
 ###
 ### Language
 ###
-language: python
+language: minimal
 
 
 ###
@@ -39,18 +39,24 @@ env:
 ### Install requirements
 ###
 install:
-  # Get newer docker version
-  - while ! sudo apt-get update; do sleep 1; done
-  - while ! sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce; do sleep 1; done
-  - docker version
+  - retry() {
+      for ((n=0; n<10; n++)); do
+        echo "[${n}] ${*}";
+        if eval "${*}"; then
+          return 0;
+        fi;
+      done;
+      return 1;
+    }
 
 
 ###
 ### Check generation changes, build and test
 ###
 before_script:
-  - while ! make build TAG=${VERSION}; do sleep 1; done
-  - while ! make test TAG=${VERSION}; do sleep 1; done
+  - retry make lint
+  - retry make build TAG=${VERSION}
+  - retry make test  TAG=${VERSION}
   - git diff --quiet || { echo "Build Changes"; git diff; git status; false; }
 
 

Dockerfile

@@ -1,48 +1,62 @@
-FROM golang:stretch as builder
+FROM golang:alpine3.9 as builder
 
 # Install dependencies
 RUN set -x \
-	&& DEBIAN_FRONTEND=noninteractive apt-get update -qq \
-	&& DEBIAN_FRONTEND=noninteractive apt-get install -qq -y --no-install-recommends --no-install-suggests \
+	&& apk add --no-cache \
+		curl \
+		gcc \
 		git \
-		gox \
+		make \
+		musl-dev \
 	&& curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
 
 # Get and build terraform-docs
-ARG VERSION
+ARG VERSION=latest
 RUN set -x \
 	&& export GOPATH=/go \
 	&& mkdir -p /go/src/github.com/segmentio \
 	&& git clone https://github.com/segmentio/terraform-docs /go/src/github.com/segmentio/terraform-docs \
 	&& cd /go/src/github.com/segmentio/terraform-docs \
-	&& if [ ${VERSION} != "latest" ]; then \
+	&& if [ "${VERSION}" != "latest" ]; then \
 		git checkout v${VERSION}; \
 	fi \
 	# Build terraform-docs <= 0.3.0
 	&& if [ "${VERSION}" = "0.3.0" ] || [ "${VERSION}" = "0.2.0" ] || [ "${VERSION}" = "0.1.1" ] || [ "${VERSION}" = "0.1.0" ]; then \
 		go get github.com/hashicorp/hcl \
+		&& go get github.com/mitchellh/gox \
 		&& go get github.com/tj/docopt \
+		&& sed -i'' 's/darwin//g' Makefile \
+		&& sed -i'' 's/windows//g' Makefile \
 		&& make \
-		&& mkdir -p bin/linux-amd64 \
-		&& mv dist/terraform-docs_linux_amd64 bin/linux-amd64/terraform-docs; \
+		&& mv dist/terraform-docs_linux_amd64 /usr/local/bin/terraform-docs; \
 	# Build terraform-docs > 0.3.0
 	else \
 		make deps \
 		&& make test \
 		&& make build-linux-amd64 \
-		&& if [ ${VERSION} = "0.4.0" ]; then \
-			mkdir -p bin/linux-amd64 \
-			&& mv bin/terraform-docs-v${VERSION}-linux-amd64 bin/linux-amd64/terraform-docs; \
+		&& if [ "${VERSION}" = "0.4.0" ]; then \
+			mv bin/terraform-docs-v${VERSION}-linux-amd64 /usr/local/bin/terraform-docs; \
+		else \
+			mv bin/linux-amd64/terraform-docs /usr/local/bin/terraform-docs; \
 		fi \
 	fi \
-	&& chmod +x bin/linux-amd64/terraform-docs
+	&& chmod +x /usr/local/bin/terraform-docs
+
+# Version pre-check
+RUN set -x \
+	&& if [ "${VERSION}" != "latest" ]; then \
+		terraform-docs --version | grep "${VERSION}"; \
+	else \
+		terraform-docs --version | grep -E "(terraform-docs[[:space:]])?(version[[:space:]])?dev"; \
+	fi
+
 
 # Use a clean tiny image to store artifacts in
-FROM alpine:3.9
+FROM alpine:3.8
 LABEL \
 	maintainer="cytopia <cytopia@everythingcli.org>" \
 	repo="https://github.com/cytopia/docker-terraform-docs"
-COPY --from=builder /go/src/github.com/segmentio/terraform-docs/bin/linux-amd64/terraform-docs /usr/local/bin/terraform-docs
+COPY --from=builder /usr/local/bin/terraform-docs /usr/local/bin/terraform-docs
 COPY ./data/docker-entrypoint.sh /docker-entrypoint.sh
 COPY ./data/terraform-docs.awk /terraform-docs.awk
 

Makefile

@@ -2,7 +2,7 @@ ifneq (,)
 .error This Makefile requires GNU Make.
 endif
 
-.PHONY: build rebuild lint test _test_version _test_run tag pull login push enter
+.PHONY: build rebuild lint test _test-version _test-run-one _test-run-two tag pull login push enter
 
 CURRENT_DIR = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 
@@ -26,10 +26,11 @@ lint:
 	@docker run --rm -v $(CURRENT_DIR):/data cytopia/file-lint file-utf8-bom --text --ignore '.git/,.github/,tests/' --path .
 
 test:
-	@$(MAKE) --no-print-directory _test_version
-	@$(MAKE) --no-print-directory _test_run
+	@$(MAKE) --no-print-directory _test-version
+	@$(MAKE) --no-print-directory _test-run-one
+	@$(MAKE) --no-print-directory _test-run-two
 
-_test_version:
+_test-version:
 	@echo "------------------------------------------------------------"
 	@echo "- Testing correct version"
 	@echo "------------------------------------------------------------"
@@ -42,8 +43,8 @@ _test_version:
 				| head -1 \
 				| sed 's/.*v//g' \
 		)"; \
-		echo "Testing for latest: $${LATEST}"; \
-		if ! docker run --rm $(IMAGE) | grep -E "^v?$${LATEST}$$"; then \
+		echo "Testing for latest: dev"; \
+		if ! docker run --rm $(IMAGE) | grep -E "^(terraform-docs[[:space:]])?(version[[:space:]])?dev"; then \
 			echo "Failed"; \
 			exit 1; \
 		fi; \
@@ -56,9 +57,30 @@ _test_version:
 	fi; \
 	echo "Success"; \
 
-_test_run:
+_test-run-one:
 	@echo "------------------------------------------------------------"
-	@echo "- Testing terraform-docs"
+	@echo "- Testing terraform-docs (1/2)"
+	@echo "------------------------------------------------------------"
+	@echo '<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->' > tests/basic/TEST-$(TAG).md
+	@echo >> tests/basic/TEST-$(TAG).md
+	@echo '<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->' >> tests/basic/TEST-$(TAG).md
+	@if ! docker run --rm -v $(CURRENT_DIR)/tests/basic:/data $(IMAGE) terraform-docs-replace md TEST-$(TAG).md; then \
+		echo "Failed"; \
+		exit 1; \
+	fi; \
+	if ! grep '## Inputs' tests/basic/TEST-$(TAG).md; then \
+		echo "Failed"; \
+		exit 1; \
+	fi; \
+	if ! grep 'test description' tests/basic/TEST-$(TAG).md; then \
+		echo "Failed"; \
+		exit 1; \
+	fi; \
+	echo "Success";
+
+_test-run-two:
+	@echo "------------------------------------------------------------"
+	@echo "- Testing terraform-docs (2/2)"
 	@echo "------------------------------------------------------------"
 	$(eval TFDOC_ARG_SORT = $(shell \
 		if [ "$(TAG)" = "latest" ] || [ "$(TAG)" = "0.6.0" ] || [ "$(TAG)" = "0.5.0" ]; then \
@@ -70,10 +92,12 @@ _test_run:
 			echo "--with-aggregate-type-defaults"; \
 		fi; \
 	))
+	@# ---- Test Terraform < 0.12 ----
 	@if ! docker run --rm -v $(CURRENT_DIR)/tests/default:/data $(IMAGE) terraform-docs-replace $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md TEST-$(TAG).md; then \
 		echo "Failed"; \
 		exit 1; \
 	fi
+	@# ---- Test Terraform >= 0.12 ----
 	@if ! docker run --rm -v $(CURRENT_DIR)/tests/0.12:/data $(IMAGE) terraform-docs-replace-012 $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md TEST-$(TAG).md; then \
 		echo "Failed"; \
 		exit 1; \

README.md

@@ -17,13 +17,17 @@
 > [eslint](https://github.com/cytopia/docker-eslint) **•**
 > [file-lint](https://github.com/cytopia/docker-file-lint) **•**
 > [gofmt](https://github.com/cytopia/docker-gofmt) **•**
+> [goimports](https://github.com/cytopia/docker-goimports) **•**
 > [golint](https://github.com/cytopia/docker-golint) **•**
 > [jsonlint](https://github.com/cytopia/docker-jsonlint) **•**
+> [phpcbf](https://github.com/cytopia/docker-phpcbf) **•**
 > [phpcs](https://github.com/cytopia/docker-phpcs) **•**
+> [php-cs-fixer](https://github.com/cytopia/docker-php-cs-fixer) **•**
 > [pycodestyle](https://github.com/cytopia/docker-pycodestyle) **•**
 > [pylint](https://github.com/cytopia/docker-pylint) **•**
 > [terraform-docs](https://github.com/cytopia/docker-terraform-docs) **•**
 > [terragrunt](https://github.com/cytopia/docker-terragrunt) **•**
+> [terragrunt-fmt](https://github.com/cytopia/docker-terragrunt-fmt) **•**
 > [yamllint](https://github.com/cytopia/docker-yamllint)
 
 
@@ -314,9 +318,9 @@ output is always up-to-date and will fail otherwise (due to git changes):
 ```yml
 ---
 sudo: required
+language: minimal
 services:
   - docker
-before_install: true
 install: true
 script:
   - make gen
@@ -344,20 +348,26 @@ linter below for reproducible local or remote CI tests:
 |--------------|------|-------------|
 | [awesome-ci](https://github.com/cytopia/awesome-ci) | Basic | Tools for git, file and static source code analysis |
 | [file-lint](https://github.com/cytopia/docker-file-lint) | Basic | Baisc source code analysis |
-| [jsonlint](https://github.com/cytopia/docker-jsonlint) | Basic | Lint JSON files |
+| [jsonlint](https://github.com/cytopia/docker-jsonlint) | Basic | Lint JSON files **<sup>[1]</sup>** |
 | [yamllint](https://github.com/cytopia/docker-yamllint) | Basic | Lint Yaml files |
 | [ansible](https://github.com/cytopia/docker-ansible) | Ansible | Multiple versoins of Ansible |
 | [ansible-lint](https://github.com/cytopia/docker-ansible-lint) | Ansible | Lint  Ansible |
-| [gofmt](https://github.com/cytopia/docker-gofmt) | Go | Format Go source code |
+| [gofmt](https://github.com/cytopia/docker-gofmt) | Go | Format Go source code **<sup>[1]</sup>** |
+| [goimports](https://github.com/cytopia/docker-goimports) | Go | Format Go source code **<sup>[1]</sup>** |
 | [golint](https://github.com/cytopia/docker-golint) | Go | Lint Go code |
 | [eslint](https://github.com/cytopia/docker-eslint) | Javascript | Lint Javascript code |
 | [checkmake](https://github.com/cytopia/docker-checkmake) | Make | Lint Makefiles |
-| [phpcs](https://github.com/cytopia/docker-phpcs) | PHP | PHPCodeSniffer and Code Beautifier and Fixer |
+| [phpcbf](https://github.com/cytopia/docker-phpcbf) | PHP | PHP Code Beautifier and Fixer |
+| [phpcs](https://github.com/cytopia/docker-phpcs) | PHP | PHP Code Sniffer |
+| [php-cs-fixer](https://github.com/cytopia/docker-php-cs-fixer) | PHP | PHP Coding Standards Fixer |
 | [black](https://github.com/cytopia/docker-black) | Python | The uncompromising Python code formatter |
 | [pycodestyle](https://github.com/cytopia/docker-pycodestyle) | Python | Python style guide checker |
 | [pylint](https://github.com/cytopia/docker-pylint) | Python | Python source code, bug and quality checker |
-| [terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Terraform | Terraform doc generator (TF 0.12 ready) |
+| [terraform-docs](https://github.com/cytopia/docker-terraform-docs) | Terraform | Terraform doc generator (TF 0.12 ready) **<sup>[1]</sup>** |
 | [terragrunt](https://github.com/cytopia/docker-terragrunt) | Terraform | Terragrunt and Terraform |
+| [terragrunt-fmt](https://github.com/cytopia/docker-terragrunt-fmt) | Terraform | `terraform fmt` for Terragrunt files **<sup>[1]</sup>** |
+
+> **<sup>[1]</sup>** Uses a shell wrapper to add **enhanced functionality** not available by original project.
 
 
 ### Makefiles

tests/basic/TEST-0.1.0.md

@@ -0,0 +1,9 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## Inputs
+
+| Name | Description | Default | Required |
+|------|-------------|:-----:|:-----:|
+| test | test description | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.1.1.md

@@ -0,0 +1,9 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.2.0.md

@@ -0,0 +1,9 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.3.0.md

@@ -0,0 +1,9 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.4.0.md

@@ -0,0 +1,9 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.4.5.md

@@ -0,0 +1,8 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.5.0.md

@@ -0,0 +1,8 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | - | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-0.6.0.md

@@ -0,0 +1,8 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | n/a | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/TEST-latest.md

@@ -0,0 +1,8 @@
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|:----:|:-----:|:-----:|
+| test | test description | string | n/a | yes |
+
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

tests/basic/main.tf

@@ -0,0 +1,3 @@
+variable "test" {
+  description = "test description"
+}