cytopia/terragrunt-fmt repository overview

⁠Docker image for terragrunt-fmt

View Dockerfiles⁠ on GitHub.

Available Architectures: amd64, i386, arm64, arm/v7, arm/v6, ppc64le, s390x

Tiny Alpine-based multistage-build dockerized version of Terraform⁠^[1] with the ability to do terraform fmt on Terragrunt files (.hcl). This is achieved by creating a temporary file within the container with an .tf extension and then running terraform fmt on it. Additionally the wrapper has been extended with a -ignore argument to be able to ignore files and directory or wildcards. The image is built nightly against multiple stable versions and pushed to Dockerhub.

_{[1] Official project: https://github.com/hashicorp/terraform⁠}

⁠:whale: Available Docker image versions

⁠Rolling releaess

The following Docker image tags are rolling releases and are built and updated every night.

⁠Point in time releases

The following Docker image tags are built once and can be used for reproducible builds. Its version never changes so you will have to update tags in your pipelines from time to time in order to stay up-to-date.

⁠:open_file_folder: Docker mounts

The working directory inside the Docker container is /data/ and should be mounted locally to the root of your project.

⁠:computer: Usage

Ignore all directories named dev/ and testing/ and everything inside.

$ docker run --rm -v $(pwd):/data cytopia/terragrunt-fmt -recursive -ignore=*/dev/,*/testing/

[INFO] Finding files: find . -not \( -path "./*/dev/*" -o -path "./*/testing/*" \) -name '*.hcl' -type f
terraform fmt -list=true -write=false ./prod/eu-central-1/microservice/terragrunt.hcl
../tmp/terragrunt.hcl.tf
terraform fmt -list=true -write=false ./prod/eu-central-1/infra/terragrunt.hcl
../tmp/terragrunt.hcl.tf

⁠Project and CI integration

⁠Makefile

You can add the following Makefile to your project for easy linting anf fixing of Terragrunt .hcl files.

ifneq (,)
.error This Makefile requires GNU Make.
endif

.PHONY: help lint fix _pull

CURRENT_DIR = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))

# Adjust according to your needs
IGNORE      = */.terragrunt-cache/,*/.terraform/
FMT_VERSION = latest

help:
	@echo "help    Show this help"
	@echo "lint    Exit > 0 if any files have wrong formatting"
	@echo "fix     Fix all .hcl files"

lint: _pull
	docker run --rm -v $(CURRENT_DIR):/data cytopia/terragrunt-fmt:$(FMT_VERSION) \
		-check -diff -recursive -ignore='$(IGNORE)'

fix: _pull
	docker run --rm -v $(CURRENT_DIR):/data cytopia/terragrunt-fmt:$(FMT_VERSION) \
		-write -diff -recursive -ignore='$(IGNORE)'

_pull:
	docker pull cytopia/terragrunt-fmt:$(FMT_VERSION)

⁠Travis CI integration

With the above Makefile in place, you can easily add a Travis CI rule to ensure the Terragrunt code uses correct coding style.

---
sudo: required
language: minimal
services:
  - docker
script:
  - make lint

⁠:arrows_counterclockwise: Related #awesome-ci⁠ projects

⁠Docker images

Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite linter below for reproducible local or remote CI tests:

GitHub	DockerHub	Type	Description
awesome-ci⁠		Basic	Tools for git, file and static source code analysis
file-lint⁠		Basic	Baisc source code analysis
linkcheck⁠		Basic	Search for URLs in files and validate their HTTP status code
ansible⁠		Ansible	Multiple versions and flavours of Ansible
ansible-lint⁠		Ansible	Lint Ansible
gofmt⁠		Go	Format Go source code [1]
goimports⁠		Go	Format Go source code [1]
golint⁠		Go	Lint Go code
eslint⁠		Javascript	Lint Javascript code
jsonlint⁠		JSON	Lint JSON files [1]
kubeval⁠		K8s	Lint Kubernetes files
checkmake⁠		Make	Lint Makefiles
phpcbf⁠		PHP	PHP Code Beautifier and Fixer
phpcs⁠		PHP	PHP Code Sniffer
phplint⁠		PHP	PHP Code Linter [1]
php-cs-fixer⁠		PHP	PHP Coding Standards Fixer
bandit⁠		Python	A security linter from PyCQA
black⁠		Python	The uncompromising Python code formatter
mypy⁠		Python	Static source code analysis
pycodestyle⁠		Python	Python style guide checker
pydocstyle⁠		Python	Python docstyle checker
pylint⁠		Python	Python source code, bug and quality checker
terraform-docs⁠		Terraform	Terraform doc generator (TF 0.12 ready) [1]
terragrunt⁠		Terraform	Terragrunt and Terraform
terragrunt-fmt⁠		Terraform	terraform fmt for Terragrunt files [1]
yamlfmt⁠		Yaml	Format Yaml files [1]
yamllint⁠		Yaml	Lint Yaml files

⁠Makefiles

Visit cytopia/makefiles⁠ for dependency-less, seamless project integration and minimum required best-practice code linting for CI. The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.

⁠:page_facing_up: License

MIT License⁠

Copyright (c) 2019 cytopia⁠