-
Notifications
You must be signed in to change notification settings - Fork 83
/
Makefile
352 lines (289 loc) · 10.9 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
# Richie's Makefile
#
# /!\ /!\ /!\ /!\ /!\ /!\ /!\ DISCLAIMER /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\
#
# This Makefile is only meant to be used for DEVELOPMENT purpose as we are
# changing the user id that will run in the container.
#
# PLEASE DO NOT USE IT FOR YOUR CI/PRODUCTION/WHATEVER...
#
# /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\ /!\
#
# Note to developpers:
#
# While editing this file, please respect the following statements:
#
# 1. Every variable should be defined in the ad hoc VARIABLES section with a
# relevant subsection
# 2. Every new rule should be defined in the ad hoc RULES section with a
# relevant subsection depending on the targeted service
# 3. Rules should be sorted alphabetically within their section
# 4. When a rule has multiple dependencies, you should:
# - duplicate the rule name to add the help string (if required)
# - write one dependency per line to increase readability and diffs
# 5. .PHONY rule statement should be written after the corresponding rule
# ==============================================================================
# VARIABLES
# -- Database
# Database engine switch: if the DB_HOST=mysql environment variable is defined,
# we'll use the mysql docker compose service as a database backend instead of
# postgresql (default).
ifeq ($(DB_HOST), mysql)
DB_PORT = 3306
else
DB_HOST = postgresql
DB_PORT = 5432
endif
# -- Docker
# Get the current user ID to use for docker run and docker exec commands
DOCKER_UID = $(shell id -u)
DOCKER_GID = $(shell id -g)
DOCKER_USER = $(DOCKER_UID):$(DOCKER_GID)
COMPOSE = DOCKER_USER=$(DOCKER_USER) DB_HOST=$(DB_HOST) DB_PORT=$(DB_PORT) docker compose -f docker-compose.yml -f docker-compose-$(DB_HOST).yml
SSL_ENV = NGINX_CONF=ssl DEV_ENV_FILE=dev-ssl
COMPOSE_RUN = $(COMPOSE) run --rm
COMPOSE_EXEC = $(COMPOSE) exec
COMPOSE_UP_WAIT = $(COMPOSE) up --wait --wait-timeout 60
COMPOSE_EXEC_APP = $(COMPOSE_EXEC) app
COMPOSE_EXEC_FRONTEND= $(COMPOSE_EXEC) frontend
COMPOSE_RUN_APP = $(COMPOSE_RUN) app
COMPOSE_RUN_CROWDIN = $(COMPOSE_RUN) crowdin crowdin
COMPOSE_TEST_RUN = $(COMPOSE) run --rm -e DJANGO_CONFIGURATION=Test
COMPOSE_TEST_RUN_APP = $(COMPOSE_TEST_RUN) app
PYTHON_FILES = src/richie/apps src/richie/plugins sandbox
# -- Frontend
# We must run frontend with a /home because yarn tries to write to ~/.yarnrc. If the
# ID of our host user (with which we run the container) does not exist in the
# container (e.g. 1000 exists but 1009 does not exist by default), then yarn
# will try to write to "/.yarnrc" at the root of the system and will fail with a
# permission error.
COMPOSE_RUN_FRONTEND = $(COMPOSE_RUN) -e HOME="/tmp" frontend
YARN = $(COMPOSE_RUN_FRONTEND) yarn
# -- Django
MANAGE = $(COMPOSE_RUN_APP) python sandbox/manage.py
# ==============================================================================
# RULES
default: help
# -- Project
bootstrap: ## install development dependencies
bootstrap: \
env.d/development/common \
env.d/development/dev \
env.d/development/dev-ssl \
env.d/development/crowdin \
data/media/.keep \
data/smedia/.keep \
data/static/.keep \
build-front \
build \
run \
migrate \
superuser
.PHONY: bootstrap
# -- Docker/compose
build: ## build the app container
@$(COMPOSE) build app
.PHONY: build
down: ## remove stack (warning: it removes the database container)
@$(COMPOSE) down
.PHONY: down
logs: ## display app logs (follow mode)
@$(COMPOSE) logs -f app
.PHONY: logs
run: ## start the development server
@echo "Start and wait for ${DB_HOST}, elasticsearch and app to be up..."
@$(COMPOSE_UP_WAIT) -d nginx $(DB_HOST) elasticsearch app
.PHONY: run
run-ssl: ## start the development server over TLS
@echo "Start and wait for services to be up..."
@$(SSL_ENV) $(COMPOSE_UP_WAIT) -d nginx $(DB_HOST) elasticsearch app
.PHONY: run-ssl
status: ## an alias for "docker compose ps"
@$(COMPOSE) ps
.PHONY: status
stop: ## stop the development server
@$(COMPOSE) stop
.PHONY: stop
# -- Front-end
build-front: ## build front-end application
build-front: \
install-front \
build-ts \
build-sass
.PHONY: build-front
build-sass: ## build Sass files to CSS
@$(YARN) build-sass
.PHONY: build-sass
build-ts: ## build TypeScript application
@$(YARN) compile-translations
@$(YARN) build-ts
.PHONY: build-ts
install-front: ## install front-end dependencies
@$(YARN) install
.PHONY: install-front
lint-front: ## run all front-end "linters"
lint-front: \
lint-front-eslint \
lint-front-prettier
.PHONY: lint-front
lint-front-prettier: ## run prettier over js/jsx/json/ts/tsx files -- beware! overwrites files
@$(YARN) prettier-write
.PHONY: lint-front-prettier
lint-front-eslint: ## lint TypeScript sources
@$(YARN) lint
.PHONY: lint-front-eslint
run-storybook: ## Run front-end's storybook
@$(COMPOSE) up -d storybook
.PHONY: run-storybook
stop-storybook: ## Stop front-end's storybook
@$(COMPOSE) stop storybook
.PHONY: stop-storybook
test-front: ## run front-end tests, or specific test like `make test-front js/components/CourseRunEnrollment`
@args="$(filter-out $@,$(MAKECMDGOALS))" && \
$(YARN) test $${args:-${1}}
.PHONY: test-front
watch-sass: ## watch changes in Sass files
@$(YARN) watch-sass
.PHONY: watch-sass
watch-ts: ## watch changes in TypeScript files
@$(YARN) watch-ts
.PHONY: watch-ts
# -- Back-end
compilemessages: ## compile the gettext files
@$(COMPOSE_RUN) -w /app/src/richie app python /app/sandbox/manage.py compilemessages
.PHONY: compilemessages
demo-site: ## create a demo site if app container is running
@echo "Check app container is running..."
@if [ $(shell docker container inspect -f '{{.State.Running}}' "$(shell $(COMPOSE) ps -q app)") = "false" ] ; then\
echo "❌ App must be up and running to create demo site.";\
exit 1;\
fi
@$(MANAGE) flush
@$(COMPOSE_EXEC_APP) python sandbox/manage.py create_demo_site
@${MAKE} search-index
@${MAKE} superuser
.PHONY: demo-site
# Nota bene: Black should come after isort just in case they don't agree...
lint-back: ## lint back-end python sources
lint-back: \
lint-back-isort \
lint-back-black \
lint-back-flake8 \
lint-back-pylint \
lint-back-bandit
.PHONY: lint-back
lint-back-diff: ## lint back-end python sources, but only what has changed since master
@bin/lint-back-diff
.PHONY: lint-back-diff
lint-back-black: ## lint back-end python sources with black
@echo 'lint:black started…'
@$(COMPOSE_TEST_RUN_APP) black .
.PHONY: lint-back-black
lint-back-flake8: ## lint back-end python sources with flake8
@echo 'lint:flake8 started…'
@$(COMPOSE_TEST_RUN_APP) flake8 ${PYTHON_FILES} tests
.PHONY: lint-back-flake8
lint-back-isort: ## automatically re-arrange python imports in back-end code base
@echo 'lint:isort started…'
@$(COMPOSE_TEST_RUN_APP) isort --atomic ${PYTHON_FILES} tests
.PHONY: lint-back-isort
lint-back-pylint: ## lint back-end python sources with pylint
@echo 'lint:pylint started…'
@$(COMPOSE_TEST_RUN_APP) pylint ${PYTHON_FILES} tests
.PHONY: lint-back-pylint
lint-back-bandit: ## lint back-end python sources with bandit
@echo 'lint:bandit started…'
@$(COMPOSE_TEST_RUN_APP) bandit -qr ${PYTHON_FILES}
.PHONY: lint-back-bandit
messages: ## create the .po files used for i18n
@$(COMPOSE_RUN) -w /app/src/richie app python /app/sandbox/manage.py makemessages -a --keep-pot
.PHONY: messages
migrate: ## perform database migrations
@echo "Start and wait for ${DB_HOST} to be up..."
@$(COMPOSE_UP_WAIT) -d ${DB_HOST}
@$(MANAGE) migrate
.PHONY: migrate
search-index: ## (re)generate the Elasticsearch index
@echo "Start and wait for ${DB_HOST} & elasticsearch to be up..."
@$(COMPOSE_UP_WAIT) -d ${DB_HOST} elasticsearch
@$(MANAGE) bootstrap_elasticsearch
.PHONY: search-index
superuser: ## Create an admin user with password "admin"
@echo "Start and wait for ${DB_HOST} to be up..."
@$(COMPOSE_UP_WAIT) -d ${DB_HOST}
@$(MANAGE) shell -c "from django.contrib.auth.models import User; not User.objects.filter(username='admin').exists() and User.objects.create_superuser('admin', '[email protected]', 'admin')"
.PHONY: superuser
test-back: ## run back-end tests, or specific test like `make test-back tests/apps/core/test_web_analytics.py`
@args="$(filter-out $@,$(MAKECMDGOALS))" && \
DB_PORT=$(DB_PORT) bin/pytest $${args:-${1}}
.PHONY: test-back
# -- Internationalization
crowdin-download: ## download translated message from Crowdin
@$(COMPOSE_RUN_CROWDIN) download -c crowdin/config.yml
.PHONY: crowdin-download
crowdin-upload: ## upload source translations to Crowdin
@$(COMPOSE_RUN_CROWDIN) upload sources -c crowdin/config.yml
.PHONY: crowdin-upload
i18n-compile: ## compile translated messages to be used by all applications
i18n-compile: \
i18n-compile-back \
i18n-compile-front
.PHONY: i18n-compile
i18n-compile-back:
@$(COMPOSE_RUN) -w /app/src/richie app python /app/sandbox/manage.py compilemessages
.PHONY: i18n-compile-back
i18n-compile-front:
@$(YARN) compile-translations
.PHONY: i18n-compile-front
i18n-download-and-compile: ## download all translated messages and compile them to be used by all applications
i18n-download-and-compile: \
crowdin-download \
i18n-compile
.PHONY: i18n-download-and-compile
i18n-generate: ## generate source translations files for all applications
i18n-generate: \
i18n-generate-back \
i18n-generate-front ## generate source translations files for all applications
.PHONY: i18n-generate
i18n-generate-and-upload: ## generate source translations for all applications and upload then to crowdin
i18n-generate-and-upload: \
i18n-generate \
crowdin-upload
.PHONY: i18n-generate-and-upload
i18n-generate-back:
@$(COMPOSE_RUN) -w /app/src/richie app python /app/sandbox/manage.py makemessages --ignore "venv/**/*" --keep-pot --all
.PHONY: i18n-generate-back
i18n-generate-front: build-ts
@$(YARN) extract-translations
.PHONY: i18n-generate-front
# -- Database
dbshell: ## connect to database shell
@$(COMPOSE) exec app python sandbox/manage.py dbshell
.PHONY: dbshell
# -- Misc
clean: ## restore repository state as it was freshly cloned
git clean -idx
.PHONY: clean
env.d/development/common:
cp env.d/development/common.dist env.d/development/common
env.d/development/dev:
cp env.d/development/dev.dist env.d/development/dev
env.d/development/dev-ssl:
cp env.d/development/dev-ssl.dist env.d/development/dev-ssl
env.d/development/crowdin:
cp env.d/development/crowdin.dist env.d/development/crowdin
data/media/.keep:
@echo 'Preparing media volume...'
@mkdir -p data/media/
@touch data/media/.keep
data/smedia/.keep:
@echo 'Preparing secure media volume...'
@mkdir -p data/smedia/
@touch data/smedia/.keep
data/static/.keep:
@echo 'Preparing static volume...'
@mkdir -p data/static
@touch data/static/.keep
help:
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
.PHONY: help