-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
Makefile
360 lines (336 loc) · 12.2 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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
ifneq (,)
.error This Makefile requires GNU Make.
endif
# Ensure additional Makefiles are present
MAKEFILES = Makefile.docker Makefile.lint
$(MAKEFILES): URL=https://raw.githubusercontent.com/devilbox/makefiles/master/$(@)
$(MAKEFILES):
@if ! (curl --fail -sS -o $(@) $(URL) || wget -O $(@) $(URL)); then \
echo "Error, curl or wget required."; \
echo "Exiting."; \
false; \
fi
include $(MAKEFILES)
# Set default Target
.DEFAULT_GOAL := help
# -------------------------------------------------------------------------------------------------
# Default configuration
# -------------------------------------------------------------------------------------------------
# Own vars
TAG = latest
# Makefile.docker overwrites
NAME = tfdocs
VERSION = latest
IMAGE = cytopia/terraform-docs
FLAVOUR = latest
FILE = Dockerfile
ifeq ($(strip $(VERSION)),0.1.0)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.1.1)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.2.0)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.3.0)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.4.0)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.4.5)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.5.0)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.6.0)
FILE = Dockerfile-0.11
else
ifeq ($(strip $(VERSION)),0.7.0)
FILE = Dockerfile-0.11
endif
endif
endif
endif
endif
endif
endif
endif
endif
DIR = Dockerfiles
# Building from master branch: Tag == 'latest'
ifeq ($(strip $(TAG)),latest)
ifeq ($(strip $(VERSION)),latest)
DOCKER_TAG = $(FLAVOUR)
else
ifeq ($(strip $(FLAVOUR)),latest)
DOCKER_TAG = $(VERSION)
else
DOCKER_TAG = $(FLAVOUR)-$(VERSION)
endif
endif
# Building from any other branch or tag: Tag == '<REF>'
else
ifeq ($(strip $(FLAVOUR)),latest)
DOCKER_TAG = $(VERSION)-$(TAG)
else
DOCKER_TAG = $(FLAVOUR)-$(VERSION)-$(TAG)
endif
endif
# Makefile.lint overwrites
FL_IGNORES = .git/,.github/,tests/,Dockerfiles/data/
SC_IGNORES = .git/,.github/,tests/
JL_IGNORES = .git/,.github/
# -------------------------------------------------------------------------------------------------
# Default Target
# -------------------------------------------------------------------------------------------------
.PHONY: help
help:
@echo "lint Lint project files and repository"
@echo
@echo "build [ARCH=...] [TAG=...] Build Docker image"
@echo "rebuild [ARCH=...] [TAG=...] Build Docker image without cache"
@echo "push [ARCH=...] [TAG=...] Push Docker image to Docker hub"
@echo
@echo "manifest-create [ARCHES=...] [TAG=...] Create multi-arch manifest"
@echo "manifest-push [TAG=...] Push multi-arch manifest"
@echo
@echo "test [ARCH=...] Test built Docker image"
@echo
# -------------------------------------------------------------------------------------------------
# Docker Targets
# -------------------------------------------------------------------------------------------------
.PHONY: build
build: ARGS=--build-arg VERSION=$(VERSION)
build: docker-arch-build
.PHONY: rebuild
rebuild: ARGS=--build-arg VERSION=$(VERSION)
rebuild: docker-arch-rebuild
.PHONY: push
push: docker-arch-push
# -------------------------------------------------------------------------------------------------
# Manifest Targets
# -------------------------------------------------------------------------------------------------
.PHONY: manifest-create
manifest-create: docker-manifest-create
.PHONY: manifest-push
manifest-push: docker-manifest-push
# --------------------------------------------------------------------------------------------------
# Test Targets
# --------------------------------------------------------------------------------------------------
.PHONY: test
test: _test-version
test: _test-run-generate-one
test: _test-run-generate-two
test: _test-run-replace-one
test: _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|beta)"; \
if ! docker run --rm --platform $(ARCH) $(IMAGE):$(DOCKER_TAG) | grep -E "^(terraform-docs[[:space:]])?(version[[:space:]])?(v?[.0-9]+)?-?(dev|latest|beta)?"; then \
echo "Failed"; \
exit 1; \
fi; \
else \
echo "Testing for version: $(VERSION)"; \
if ! docker run --rm --platform $(ARCH) $(IMAGE):$(DOCKER_TAG) | 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 --platform $(ARCH) -v $(PWD)/tests:/data $(IMAGE):$(DOCKER_TAG) 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 --platform $(ARCH) -v $(PWD)/tests:/data $(IMAGE):$(DOCKER_TAG) terraform-docs $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/generate/default/ > tests/output/generate/default/TEST-$(VERSION).md; then \
echo "Failed 1"; \
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 2"; \
exit 1; \
fi;
@#
@# ---- Test Terraform >= 0.12 ----
if ! docker run --platform $(ARCH) --rm -v $(PWD)/tests:/data $(IMAGE):$(DOCKER_TAG) 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 3"; \
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 4"; \
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 --platform $(ARCH) -v $(PWD)/tests:/data $(IMAGE):$(DOCKER_TAG) terraform-docs-replace md /data/output/replace/basic/TEST-$(VERSION).md; then \
echo "Failed 1"; \
exit 1; \
fi;
@if ! grep '## Inputs' tests/output/replace/basic/TEST-$(VERSION).md; then \
echo "Failed 2"; \
exit 1; \
fi; \
if ! grep 'test description' tests/output/replace/basic/TEST-$(VERSION).md; then \
echo "Failed 3"; \
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 4"; \
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 --platform $(ARCH) -v $(PWD)/tests:/data $(IMAGE):$(DOCKER_TAG) terraform-docs-replace $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/replace/default/TEST-$(VERSION).md; then \
echo "Failed 1"; \
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 2"; \
exit 1; \
fi;
@#
@# ---- Test Terraform >= 0.12 ----
if ! docker run --rm --platform $(ARCH) -v $(PWD)/tests:/data $(IMAGE):$(DOCKER_TAG) 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 3"; \
exit 1; \
fi; \
echo "Success";