Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PLT-1041 added flags to manage the stack provisioning, updated provid… #11

Merged
merged 2 commits into from
Dec 3, 2024
Merged

PLT-1041 added flags to manage the stack provisioning, updated provid… #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a19e503
PLT-1041 added flags to manage the stack provisioning, updated provid…
vselcuk Dec 3, 2024
dbeabf2
PLT-1041 updated github action workflows according to the updated Mak…
vselcuk Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/linting.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ jobs:

- name: Files lint
run: |
make "lint-files"
make "lint"
2 changes: 1 addition & 1 deletion .github/workflows/terraform-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ jobs:

- name: terraform-docs
run: |
make terraform-docs
make gen
git diff --quiet || { echo "Build Changes"; git diff; git status; false; }
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@

# .tfvars files
*.tfvars

.idea
305 changes: 226 additions & 79 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,95 +2,242 @@ ifneq (,)
.error This Makefile requires GNU Make.
endif

.PHONY: help gen lint test _gen-main _gen-examples _gen-modules _lint-files _lint-fmt _lint-json _pull-tf _pull-tfdocs _pull-fl _pull-jl

CURRENT_DIR = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
TF_EXAMPLES = $(sort $(dir $(wildcard $(CURRENT_DIR)examples/*/)))
TF_MODULES = $(sort $(dir $(wildcard $(CURRENT_DIR)modules/*/)))

# -------------------------------------------------------------------------------------------------
# Default configuration
# Container versions
# -------------------------------------------------------------------------------------------------
.PHONY: help lint lint-files terraform-docs terraform-fmt _pull-tf _pull-tfdocs
CURRENT_DIR = $(PWD)
TF_VERSION = 1.5.7
TFDOCS_VERSION = 0.16.0-0.34
FL_VERSION = latest-0.8
JL_VERSION = 1.6.0-0.14


# -------------------------------------------------------------------------------------------------
# Docker image versions
# Enable linter (file-lint, terraform fmt, jsonlint)
# -------------------------------------------------------------------------------------------------
TF_VERSION = 0.13.7
FL_VERSION = 0.4
LINT_FL_ENABLE = 1
LINT_TF_ENABLE = 1
LINT_JL_ENABLE = 1

FL_IGNORE_PATHS = .git/,.github/,.idea/
FL_IGNORE_PATHS = .git/,.github/,.terraform/,.idea

# -------------------------------------------------------------------------------------------------
# Terraform-docs configuration
# terraform-docs defines
# -------------------------------------------------------------------------------------------------
TFDOCS_VERSION = 0.15.0-0.29

# Adjust your delimiter here or overwrite via make arguments
TFDOCS_DELIM_START = <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
TFDOCS_DELIM_CLOSE = <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
DELIM_START = <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
DELIM_CLOSE = <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
# What arguments to append to terraform-docs command
TFDOCS_ARGS = --sort=false


# -------------------------------------------------------------------------------------------------
# Meta Targets
# Default target
# -------------------------------------------------------------------------------------------------

help:
@echo
@echo "Meta targets"
@echo "--------------------------------------------------------------------------------"
@echo " help Show this help screen"
@echo
@echo "Read-only targets"
@echo "--------------------------------------------------------------------------------"
@echo " lint Lint basics as well as *.tf and *.tfvars files"
@echo " lint-files Lint basics"
@echo
@echo "Writing targets"
@echo "--------------------------------------------------------------------------------"
@echo " terraform-docs Run terraform-docs against all README.md"
@echo " terraform-fmt Run terraform-fmt against *.tf and *.tfvars files"
@echo "gen Generate terraform-docs output and replace in README.md's"
@echo "lint Static source code analysis"
@echo "test Integration tests"


# -------------------------------------------------------------------------------------------------
# Read-only Targets
# Standard targets
# -------------------------------------------------------------------------------------------------
gen: _pull-tfdocs
@echo "################################################################################"
@echo "# Terraform-docs generate"
@echo "################################################################################"
@$(MAKE) --no-print-directory _gen-main
@$(MAKE) --no-print-directory _gen-examples
@$(MAKE) --no-print-directory _gen-modules

lint:
@$(MAKE) --no-print-directory terraform-fmt _WRITE=false
@$(MAKE) --no-print-directory lint-files
@if [ "$(LINT_FL_ENABLE)" = "1" ]; then \
$(MAKE) --no-print-directory _lint-files; \
fi
@if [ "$(LINT_TF_ENABLE)" = "1" ]; then \
$(MAKE) --no-print-directory _lint-fmt; \
fi
@if [ "$(LINT_JL_ENABLE)" = "1" ]; then \
$(MAKE) --no-print-directory _lint-json; \
fi

lint-files:
@echo "################################################################################"
@echo "# file-lint"
@echo "################################################################################"
@docker run --rm -v $(PWD):/data cytopia/file-lint:$(FL_VERSION) file-cr --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint:$(FL_VERSION) file-crlf --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint:$(FL_VERSION) file-trailing-single-newline --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint:$(FL_VERSION) file-trailing-space --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint:$(FL_VERSION) file-utf8 --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint:$(FL_VERSION) file-utf8-bom --text --ignore '$(FL_IGNORE_PATHS)' --path .
test: _pull-tf
@$(foreach example,\
$(TF_EXAMPLES),\
DOCKER_PATH="/t/examples/$(notdir $(patsubst %/,%,$(example)))"; \
echo "################################################################################"; \
echo "# examples/$$( basename $${DOCKER_PATH} )"; \
echo "################################################################################"; \
echo; \
echo "------------------------------------------------------------"; \
echo "# Terraform init"; \
echo "------------------------------------------------------------"; \
if docker run $$(tty -s && echo "-it" || echo) --rm --network host -v "$(CURRENT_DIR):/t" --workdir "$${DOCKER_PATH}" hashicorp/terraform:$(TF_VERSION) \
init \
-lock=false \
-upgrade \
-reconfigure \
-input=false \
-get=true; \
then \
echo "OK"; \
else \
echo "Failed"; \
docker run $$(tty -s && echo "-it" || echo) --rm -v "$(CURRENT_DIR):/t" --workdir "$${DOCKER_PATH}" --entrypoint=rm hashicorp/terraform:$(TF_VERSION) -rf .terraform/ || true; \
exit 1; \
fi; \
echo; \
echo "------------------------------------------------------------"; \
echo "# Terraform validate"; \
echo "------------------------------------------------------------"; \
if docker run $$(tty -s && echo "-it" || echo) --rm -v "$(CURRENT_DIR):/t" --workdir "$${DOCKER_PATH}" hashicorp/terraform:$(TF_VERSION) \
validate \
$(ARGS) \
.; then \
echo "OK"; \
docker run $$(tty -s && echo "-it" || echo) --rm -v "$(CURRENT_DIR):/t" --workdir "$${DOCKER_PATH}" --entrypoint=rm hashicorp/terraform:$(TF_VERSION) -rf .terraform/ || true; \
else \
echo "Failed"; \
docker run $$(tty -s && echo "-it" || echo) --rm -v "$(CURRENT_DIR):/t" --workdir "$${DOCKER_PATH}" --entrypoint=rm hashicorp/terraform:$(TF_VERSION) -rf .terraform/ || true; \
exit 1; \
fi; \
echo; \
)


# -------------------------------------------------------------------------------------------------
# Writing Targets
# Helper Targets
# -------------------------------------------------------------------------------------------------
_gen-main:
@echo "------------------------------------------------------------"
@echo "# Main module"
@echo "------------------------------------------------------------"
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='<!-- TFDOCS_HEADER_START -->' \
-e DELIM_CLOSE='<!-- TFDOCS_HEADER_END -->' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --show header markdown tbl --indent 2 --sort README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='<!-- TFDOCS_PROVIDER_START -->' \
-e DELIM_CLOSE='<!-- TFDOCS_PROVIDER_END -->' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --show providers markdown tbl --indent 2 --sort README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='<!-- TFDOCS_REQUIREMENTS_START -->' \
-e DELIM_CLOSE='<!-- TFDOCS_REQUIREMENTS_END -->' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --show requirements markdown tbl --indent 2 --sort README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='<!-- TFDOCS_MODULES_START -->' \
-e DELIM_CLOSE='<!-- TFDOCS_MODULES_END -->' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --show modules markdown tbl --indent 2 --sort README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='<!-- TFDOCS_INPUTS_START -->' \
-e DELIM_CLOSE='<!-- TFDOCS_INPUTS_END -->' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --show inputs markdown doc --indent 2 $(TFDOCS_ARGS) README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='<!-- TFDOCS_OUTPUTS_START -->' \
-e DELIM_CLOSE='<!-- TFDOCS_OUTPUTS_END -->' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --show outputs markdown tbl --indent 2 --sort README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi

terraform-docs: _pull-tfdocs
_gen-examples:
@$(foreach example,\
$(TF_EXAMPLES),\
DOCKER_PATH="examples/$(notdir $(patsubst %/,%,$(example)))"; \
echo "------------------------------------------------------------"; \
echo "# $${DOCKER_PATH}"; \
echo "------------------------------------------------------------"; \
if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='$(DELIM_START)' \
-e DELIM_CLOSE='$(DELIM_CLOSE)' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace $(TFDOCS_ARGS) markdown $${DOCKER_PATH}/README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi; \
)

_gen-modules:
@$(foreach module,\
$(TF_MODULES),\
DOCKER_PATH="modules/$(notdir $(patsubst %/,%,$(module)))"; \
echo "------------------------------------------------------------"; \
echo "# $${DOCKER_PATH}"; \
echo "------------------------------------------------------------"; \
if docker run $$(tty -s && echo "-it" || echo) --rm \
-v $(CURRENT_DIR):/data \
-e DELIM_START='$(DELIM_START)' \
-e DELIM_CLOSE='$(DELIM_CLOSE)' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace $(TFDOCS_ARGS) markdown $${DOCKER_PATH}/README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi; \
)

_lint-files: _pull-fl
@# Basic file linting
@echo "################################################################################"
@echo "# Terraform-docs generate"
@echo "# File-lint"
@echo "################################################################################"
@echo
@if docker run --rm $$(tty -s && echo "-it" || echo) \
-v "$(CURRENT_DIR):/data" \
-e TFDOCS_DELIM_START='$(TFDOCS_DELIM_START)' \
-e TFDOCS_DELIM_CLOSE='$(TFDOCS_DELIM_CLOSE)' \
cytopia/terraform-docs:$(TFDOCS_VERSION) \
terraform-docs-replace --sort-by required markdown README.md; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi;
@echo
@docker run $$(tty -s && echo "-it" || echo) --rm -v $(CURRENT_DIR):/data cytopia/file-lint:$(FL_VERSION) file-cr --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run $$(tty -s && echo "-it" || echo) --rm -v $(CURRENT_DIR):/data cytopia/file-lint:$(FL_VERSION) file-crlf --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run $$(tty -s && echo "-it" || echo) --rm -v $(CURRENT_DIR):/data cytopia/file-lint:$(FL_VERSION) file-trailing-single-newline --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run $$(tty -s && echo "-it" || echo) --rm -v $(CURRENT_DIR):/data cytopia/file-lint:$(FL_VERSION) file-trailing-space --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run $$(tty -s && echo "-it" || echo) --rm -v $(CURRENT_DIR):/data cytopia/file-lint:$(FL_VERSION) file-utf8 --text --ignore '$(FL_IGNORE_PATHS)' --path .
@docker run $$(tty -s && echo "-it" || echo) --rm -v $(CURRENT_DIR):/data cytopia/file-lint:$(FL_VERSION) file-utf8-bom --text --ignore '$(FL_IGNORE_PATHS)' --path .

terraform-fmt: _WRITE=true
terraform-fmt: _pull-tf
_lint-fmt: _pull-tf
@# Lint all Terraform files
@echo "################################################################################"
@echo "# Terraform fmt"
Expand All @@ -99,13 +246,8 @@ terraform-fmt: _pull-tf
@echo "------------------------------------------------------------"
@echo "# *.tf files"
@echo "------------------------------------------------------------"
@if docker run $$(tty -s && echo "-it" || echo) --rm \
-v "$(PWD):/data" hashicorp/terraform:$(TF_VERSION) fmt \
$$(test "$(_WRITE)" = "false" && echo "-check" || echo "-write=true") \
-diff \
-list=true \
-recursive \
/data; then \
@if docker run $$(tty -s && echo "-it" || echo) --rm -v "$(CURRENT_DIR):/t:ro" --workdir "/t" hashicorp/terraform:$(TF_VERSION) \
fmt -recursive -check=true -diff=true -write=false -list=true .; then \
echo "OK"; \
else \
echo "Failed"; \
Expand All @@ -115,29 +257,34 @@ terraform-fmt: _pull-tf
@echo "------------------------------------------------------------"
@echo "# *.tfvars files"
@echo "------------------------------------------------------------"
@if docker run $$(tty -s && echo "-it" || echo) --rm --entrypoint=/bin/sh \
-v "$(PWD):/data" hashicorp/terraform:$(TF_VERSION) \
-c "find . -not \( -path './*/.terragrunt-cache/*' -o -path './*/.terraform/*' \) \
-name '*.tfvars' -type f -print0 \
| xargs -0 -n1 terraform fmt \
$$(test '$(_WRITE)' = 'false' && echo '-check' || echo '-write=true') \
-diff \
-list=true"; then \
@if docker run $$(tty -s && echo "-it" || echo) --rm --entrypoint=/bin/sh -v "$(CURRENT_DIR):/t:ro" --workdir "/t" hashicorp/terraform:$(TF_VERSION) \
-c "find . -name '*.tfvars' -type f -print0 | xargs -0 -n1 terraform fmt -check=true -write=false -diff=true -list=true"; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi;
@echo

_lint-json: _pull-jl
@# Lint all JSON files
@echo "################################################################################"
@echo "# Jsonlint"
@echo "################################################################################"
@if docker run $$(tty -s && echo "-it" || echo) --rm -v "$(CURRENT_DIR):/data:ro" cytopia/jsonlint:$(JL_VERSION) \
-t ' ' -i '*.terraform/*' '*.json'; then \
echo "OK"; \
else \
echo "Failed"; \
exit 1; \
fi;
@echo

# -------------------------------------------------------------------------------------------------
# Helper Targets
# -------------------------------------------------------------------------------------------------

# Ensure to always have the latest Terraform version
_pull-tf:
docker pull hashicorp/terraform:$(TF_VERSION)

_pull-tfdocs:
docker pull cytopia/terraform-docs:$(TFDOCS_VERSION)

_pull-fl:
docker pull cytopia/file-lint:$(FL_VERSION)
Loading
Loading