forked from cytopia/docker-terraform-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMakefile
273 lines (247 loc) · 12.7 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
ifneq (,)
.error This Makefile requires GNU Make.
endif
.PHONY: lint build rebuild lint test tag pull-base-image login push enter
# --------------------------------------------------------------------------------------------------
# Variables
# --------------------------------------------------------------------------------------------------
DIR = .
FILE_012 = Dockerfile-0.12
FILE_011 = Dockerfile-0.11
IMAGE = cytopia/terraform-docs
TAG = latest
VERSION = latest
NO_CACHE =
# --------------------------------------------------------------------------------------------------
# Default Target
# --------------------------------------------------------------------------------------------------
help:
@echo "lint Lint project files and repository"
@echo "build [VERSION=...] Build terraform-docs docker image"
@echo "rebuild [VERSION=...] Build terraform-docs docker image without cache"
@echo "test [VERSION=...] Test built terraform-docs docker image"
@echo "tag TAG=... Retag Docker image"
@echo "login USER=... PASS=... Login to Docker hub"
@echo "push [TAG=...] Push Docker image to Docker hub"
# --------------------------------------------------------------------------------------------------
# Lint Targets
# --------------------------------------------------------------------------------------------------
lint: lint-workflow
lint: lint-files
.PHONY: lint-workflow
lint-workflow:
@echo "################################################################################"
@echo "# Lint Workflow"
@echo "################################################################################"
@\
GIT_CURR_MAJOR="$$( git tag | sort -V | tail -1 | sed 's|\.[0-9]*$$||g' )"; \
GIT_CURR_MINOR="$$( git tag | sort -V | tail -1 | sed 's|^[0-9]*\.||g' )"; \
GIT_NEXT_TAG="$${GIT_CURR_MAJOR}.$$(( GIT_CURR_MINOR + 1 ))"; \
if ! grep 'refs:' -A 100 .github/workflows/nightly.yml \
| grep " - '$${GIT_NEXT_TAG}'" >/dev/null; then \
echo "[ERR] New Tag required in .github/workflows/nightly.yml: $${GIT_NEXT_TAG}"; \
exit 1; \
else \
echo "[OK] Git Tag present in .github/workflows/nightly.yml: $${GIT_NEXT_TAG}"; \
fi
@echo
.PHONY: lint-files
lint-files:
@echo "################################################################################"
@echo "# Lint Files"
@echo "################################################################################"
@docker run --rm -v $(PWD):/data cytopia/file-lint file-cr --text --ignore '.git/,.github/,tests/' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint file-crlf --text --ignore '.git/,.github/,tests/' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint file-trailing-single-newline --text --ignore '.git/,.github/,tests/' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint file-trailing-space --text --ignore '.git/,.github/,tests/' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint file-utf8 --text --ignore '.git/,.github/,tests/' --path .
@docker run --rm -v $(PWD):/data cytopia/file-lint file-utf8-bom --text --ignore '.git/,.github/,tests/' --path .
@echo
# --------------------------------------------------------------------------------------------------
# Build Targets
# --------------------------------------------------------------------------------------------------
build:
if [ "$(VERSION)" = "0.1.0" ] \
|| [ "$(VERSION)" = "0.1.1" ] \
|| [ "$(VERSION)" = "0.2.0" ] \
|| [ "$(VERSION)" = "0.3.0" ] \
|| [ "$(VERSION)" = "0.4.0" ] \
|| [ "$(VERSION)" = "0.4.5" ] \
|| [ "$(VERSION)" = "0.5.0" ] \
|| [ "$(VERSION)" = "0.6.0" ] \
|| [ "$(VERSION)" = "0.7.0" ]; then \
docker build $(NO_CACHE) --build-arg VERSION=$(VERSION) -t $(IMAGE) -f $(DIR)/$(FILE_011) $(DIR); \
else \
docker build $(NO_CACHE) --build-arg VERSION=$(VERSION) -t $(IMAGE) -f $(DIR)/$(FILE_012) $(DIR); \
fi
rebuild: NO_CACHE=--no-cache
rebuild: pull-base-image
rebuild: build
# --------------------------------------------------------------------------------------------------
# Test Targets
# --------------------------------------------------------------------------------------------------
test:
@$(MAKE) --no-print-directory _test-version
@$(MAKE) --no-print-directory _test-run-generate-one
@$(MAKE) --no-print-directory _test-run-generate-two
@$(MAKE) --no-print-directory _test-run-replace-one
@$(MAKE) --no-print-directory _test-run-replace-two
.PHONY: _test-version
_test-version:
@echo "------------------------------------------------------------"
@echo "- Testing correct version"
@echo "------------------------------------------------------------"
@if [ "$(VERSION)" = "latest" ]; then \
echo "Fetching latest version from GitHub"; \
LATEST="$$( \
curl -L -sS https://github.com/terraform-docs/terraform-docs/releases/latest/ \
| tac | tac \
| grep -Eo "terraform-docs/terraform-docs/releases/tag/v[.0-9]+" \
| head -1 \
| sed 's/.*v//g' \
)"; \
echo "Testing for latest: (dev|latest)"; \
if ! docker run --rm $(IMAGE) | grep -E "^(terraform-docs[[:space:]])?(version[[:space:]])?(dev|latest)"; then \
echo "Failed"; \
exit 1; \
fi; \
else \
echo "Testing for version: $(VERSION)"; \
if ! docker run --rm $(IMAGE) | grep -E "^(terraform-docs version)?\s?v?$(VERSION)(\s.*)?$$"; then \
echo "Failed"; \
exit 1; \
fi; \
fi; \
echo "Success"; \
.PHONY: _test-run-generate-one
_test-run-generate-one:
@echo "------------------------------------------------------------"
@echo "- Testing terraform-docs (1/2)"
@echo "------------------------------------------------------------"
@if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs md /data/output/generate/basic/ > tests/output/generate/basic/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep '## Inputs' tests/output/generate/basic/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep -E '^variable.*$$' tests/output/generate/basic/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/generate/basic/TEST-$(VERSION).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \
echo "Failed"; \
exit 1; \
fi; \
echo "Success";
.PHONY: _test-run-generate-two
_test-run-generate-two:
@echo "------------------------------------------------------------"
@echo "- Testing terraform-docs (2/2)"
@echo "------------------------------------------------------------"
$(eval TFDOC_ARG_SORT = $(shell \
if [ "$(VERSION)" = "0.5.0" ] || [ "$(VERSION)" = "0.6.0" ] || [ "$(VERSION)" = "0.7.0" ] || [ "$(VERSION)" = "0.8.0" ] || [ "$(VERSION)" = "0.8.1" ] || [ "$(VERSION)" = "0.8.2" ] || [ "$(VERSION)" = "0.9.0" ] || [ "$(VERSION)" = "0.9.1" ]; then \
echo "--sort-inputs-by-required"; \
fi; \
))
$(eval TFDOC_ARG_AGGREGATE = $(shell \
if [ "$(VERSION)" = "0.4.0" ] ||[ "$(VERSION)" = "0.4.5" ] || [ "$(VERSION)" = "0.5.0" ] || [ "$(VERSION)" = "0.6.0" ] || [ "$(VERSION)" = "0.7.0" ] || [ "$(VERSION)" = "0.8.0" ] || [ "$(VERSION)" = "0.8.1" ] || [ "$(VERSION)" = "0.8.2" ] || [ "$(VERSION)" = "0.9.0" ] || [ "$(VERSION)" = "0.9.1" ]; then \
echo "--with-aggregate-type-defaults"; \
fi; \
))
@# ---- Test Terraform < 0.12 ----
@if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/generate/default/ > tests/output/generate/default/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep -E '^variable.*$$' tests/output/generate/default/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/generate/default/TEST-$(VERSION).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \
echo "Failed"; \
exit 1; \
fi
@# ---- Test Terraform >= 0.12 ----
@if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-012 $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/generate/0.12/ > tests/output/generate/0.12/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep -E '^variable.*$$' tests/output/generate/0.12/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/generate/0.12/TEST-$(VERSION).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \
echo "Failed"; \
exit 1; \
fi
@echo "Success";
.PHONY: _test-run-replace-one
_test-run-replace-one:
@echo "------------------------------------------------------------"
@echo "- Testing terraform-docs-replace (1/2)"
@echo "------------------------------------------------------------"
@echo '<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->' > tests/output/replace/basic/TEST-$(VERSION).md
@echo >> tests/output/replace/basic/TEST-$(VERSION).md
@echo '<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->' >> tests/output/replace/basic/TEST-$(VERSION).md
@if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-replace md /data/output/replace/basic/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep '## Inputs' tests/output/replace/basic/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep 'test description' tests/output/replace/basic/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep -E '^variable.*$$' tests/output/replace/basic/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/replace/basic/TEST-$(VERSION).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \
echo "Failed"; \
exit 1; \
fi; \
echo "Success";
.PHONY: _test-run-replace-two
_test-run-replace-two:
@echo "------------------------------------------------------------"
@echo "- Testing terraform-docs-replace (2/2)"
@echo "------------------------------------------------------------"
$(eval TFDOC_ARG_SORT = $(shell \
if [ "$(VERSION)" = "0.5.0" ] || [ "$(VERSION)" = "0.6.0" ] || [ "$(VERSION)" = "0.7.0" ] || [ "$(VERSION)" = "0.8.0" ] || [ "$(VERSION)" = "0.8.1" ] || [ "$(VERSION)" = "0.8.2" ] || [ "$(VERSION)" = "0.9.0" ] || [ "$(VERSION)" = "0.9.1" ]; then \
echo "--sort-inputs-by-required"; \
fi; \
))
$(eval TFDOC_ARG_AGGREGATE = $(shell \
if [ "$(VERSION)" = "0.4.0" ] ||[ "$(VERSION)" = "0.4.5" ] || [ "$(VERSION)" = "0.5.0" ] || [ "$(VERSION)" = "0.6.0" ] || [ "$(VERSION)" = "0.7.0" ] || [ "$(VERSION)" = "0.8.0" ] || [ "$(VERSION)" = "0.8.1" ] || [ "$(VERSION)" = "0.8.2" ] || [ "$(VERSION)" = "0.9.0" ] || [ "$(VERSION)" = "0.9.1" ]; then \
echo "--with-aggregate-type-defaults"; \
fi; \
))
@# ---- Test Terraform < 0.12 ----
@if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-replace $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/replace/default/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep -E '^variable.*$$' tests/output/replace/default/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/replace/default/TEST-$(VERSION).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \
echo "Failed"; \
exit 1; \
fi
@# ---- Test Terraform >= 0.12 ----
@if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-replace-012 $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/replace/0.12/TEST-$(VERSION).md; then \
echo "Failed"; \
exit 1; \
fi; \
if ! grep -E '^variable.*$$' tests/output/replace/0.12/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/replace/0.12/TEST-$(VERSION).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \
echo "Failed"; \
exit 1; \
fi; \
echo "Success";
# -------------------------------------------------------------------------------------------------
# Deploy Targets
# -------------------------------------------------------------------------------------------------
tag:
docker tag $(IMAGE) $(IMAGE):$(TAG)
login:
yes | docker login --username $(USER) --password $(PASS)
push:
docker push $(IMAGE):$(TAG)
# --------------------------------------------------------------------------------------------------
# Helper Targets
# --------------------------------------------------------------------------------------------------
pull-base-image:
@grep -E '^\s*FROM' Dockerfile-0.11 \
| sed -e 's/^FROM//g' -e 's/[[:space:]]*as[[:space:]]*.*$$//g' \
| xargs -n1 docker pull;
@grep -E '^\s*FROM' Dockerfile-0.12 \
| sed -e 's/^FROM//g' -e 's/[[:space:]]*as[[:space:]]*.*$$//g' \
| xargs -n1 docker pull;
enter:
docker run --rm --name $(subst /,-,$(IMAGE)) -it --entrypoint=/bin/sh $(ARG) $(IMAGE):$(VERSION)