devmarks/makefile at main · leggettc18/devmarks · GitHub

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
#!make
NETWORKS="$(shell docker network ls)"
VOLUMES="$(shell docker volume ls)"
POSTGRES_DB="$(shell cat ./secrets/postgres_db)"
POSTGRES_USER="$(shell cat ./secrets/postgres_user)"
POSTGRES_PASSWORD="$(shell cat ./secrets/postgres_passwd)"
SUCCESS=[ done "\xE2\x9C\x94" ]

# default arguments
user ?= root
service ?= api

all: traefik-network postgres-network postgres-devmarks-volume
	@echo [ starting client '&' api... ]
	docker-compose up --build traefik api client db

traefik-network:
ifeq (,$(findstring traefik-public,$(NETWORKS)))
	@echo [ creating traefik network... ]
	docker network create traefik-public
	@echo $(SUCCESS)
endif

postgres-network:
ifeq (,$(findstring postgres-net,$(NETWORKS)))
	@echo [ creating postgres network... ]
	docker network create postgres-net
	@echo $(SUCCESS)
endif

postgres-devmarks-volume:
ifeq (,$(findstring postgres-devmarks-db,$(VOLUMES)))
	@echo [ creating postgres volume... ]
	docker volume create postgres-devmarks-db
	@echo $(SUCCESS)
endif

api: traefik-network postgres-network postgres-devmarks-volume
	@echo [ starting api... ]
	docker-compose up traefik api db

down:
	@echo [ teardown all containers... ]
	docker-compose down
	@echo $(SUCCESS)

tidy:
	@echo [ cleaning up unused $(service) dependencies... ]
	@make exec service="api" cmd="go mod tidy"

exec:
	@echo [ executing $(cmd) in $(service) ]
	docker-compose exec -u $(user) $(service) $(cmd)
	@echo $(SUCCESS)

test-api:
	@echo [ running api tests... ]
	docker-compose run api go test -coverprofile coverage.out -v ./...
	@echo [ outputting coverage.html... ]
	docker-compose run api go tool cover -html=coverage.out -o coverage.html

test-client:
	@echo [ running web client tests... ]
	docker-compose run client yarn test

api-docs-build:
	@echo [ building api documentation ]
	@docker run -ti --rm -v $(shell pwd):/tmp broothie/redoc-cli bundle /tmp/api/openapi.yml -o /tmp/api/redoc.html

api-client-build:
	@echo [ building typescript-fetch api client ]
	@docker run --rm -u $(shell id -u):$(shell id -g) -v "$(shell pwd):/local" openapitools/openapi-generator-cli generate -i /local/api/openapi.yml -g typescript-axios -o /local/web/src/api/client --additional-properties=typescriptThreePlus=true

debug-api:
	@echo [ debugging api... ]
	docker-compose up traefik debug-api db redis

debug-db:
	@# advanced command line interface for postgres
	@# includes auto-completion and syntax highlighting
	@# https://www.pgcli.com/
	@docker run -it --rm --net postgres-net dencold/pgcli postgresql://$(POSTGRES_USER):$(POSTGRES_PASSWORD)@db:5432/$(POSTGRES_DB)

dump:
	@echo [ dumping postgres backup for $(POSTGRES_DB)... ]
	@docker exec -it db pg_dump --username $(POSTGRES_USER) $(POSTGRES_DB) > ./api/scripts/backup.sql
	@echo $(SUCCESS)

.PHONY: all
.PHONY: traefik-network
.PHONY: postgres-network
.PHONY: redis-network
.PHONY: postgres-volume
.PHONY: api
.PHONY: down
.PHONY: tidy
.PHONY: exec
.PHONY: test-api
.PHONY: debug-api
.PHONY: debug-db
.PHONY: dump