-
Notifications
You must be signed in to change notification settings - Fork 1
/
Makefile
184 lines (136 loc) · 7.23 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
.DEFAULT_GOAL := help
.PHONY: help clean piptools requirements ci_requirements dev_requirements \
validation_requirements doc_requirements production-requirements static shell \
test coverage isort_check isort style lint quality pii_check validate \
migrate html_coverage upgrade extract_translation dummy_translations \
compile_translations fake_translations pull_translations \
push_translations start-devstack open-devstack pkg-devstack \
detect_changed_source_translations validate_translations check_keywords
define BROWSER_PYSCRIPT
import os, webbrowser, sys
try:
from urllib import pathname2url
except:
from urllib.request import pathname2url
webbrowser.open("file://" + pathname2url(os.path.abspath(sys.argv[1])))
endef
export BROWSER_PYSCRIPT
BROWSER := python -c "$$BROWSER_PYSCRIPT"
# Generates a help message. Borrowed from https://github.com/pydanny/cookiecutter-djangopackage.
help: ## display this help message
@echo "Please use \`make <target>\` where <target> is one of"
@awk -F ':.*?## ' '/^[a-zA-Z]/ && NF==2 {printf "\033[36m %-25s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
clean: ## delete generated byte code and coverage reports
find . -name '*.pyc' -delete
coverage erase
rm -rf assets
rm -rf pii_report
piptools: ## install pinned version of pip-compile and pip-sync
pip install -r requirements/pip.txt
pip install -r requirements/pip-tools.txt
requirements: piptools dev_requirements ## sync to default requirements
ci_requirements: validation_requirements ## sync to requirements needed for CI checks
dev_requirements: ## sync to requirements for local development
pip-sync -q requirements/dev.txt requirements/private.*
validation_requirements: ## sync to requirements for testing & code quality checking
pip-sync -q requirements/validation.txt
doc_requirements:
pip-sync -q requirements/doc.txt
production-requirements: ## install requirements for production
pip-sync -q requirements/production.txt
static: ## generate static files
python manage.py collectstatic --noinput
shell: ## run Django shell
python manage.py shell
test: clean ## run tests and generate coverage report
pytest
# To be run from CI context
coverage: clean
pytest --cov-report html
$(BROWSER) htmlcov/index.html
isort_check: ## check that isort has been run
isort --check-only program_intent_engagement/
isort: ## run isort to sort imports in all Python files
isort --recursive --atomic program_intent_engagement/
style: ## run Python style checker
pylint --rcfile=pylintrc program_intent_engagement *.py
lint: ## run Python code linting
pylint --rcfile=pylintrc program_intent_engagement *.py
quality:
tox -e quality
pii_check: ## check for PII annotations on all Django models
DJANGO_SETTINGS_MODULE=program_intent_engagement.settings.test \
code_annotations django_find_annotations --config_file .pii_annotations.yml --lint --report --coverage
check_keywords: ## Scan the Django models in all installed apps in this project for restricted field names
python manage.py check_reserved_keywords --override_file db_keyword_overrides.yml
validate: test quality pii_check check_keywords ## run tests, quality, and PII annotation checks
migrate: ## apply database migrations
python manage.py migrate
html_coverage: ## generate and view HTML coverage report
coverage html && open htmlcov/index.html
COMMON_CONSTRAINTS_TXT=requirements/common_constraints.txt
.PHONY: $(COMMON_CONSTRAINTS_TXT)
$(COMMON_CONSTRAINTS_TXT):
wget -O "$(@)" https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt || touch "$(@)"
echo "$(COMMON_CONSTRAINTS_TEMP_COMMENT)" | cat - $(@) > temp && mv temp $(@)
upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
upgrade: piptools $(COMMON_CONSTRAINTS_TXT) ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
sed 's/Django<4.0//g' requirements/common_constraints.txt > requirements/common_constraints.tmp
mv requirements/common_constraints.tmp requirements/common_constraints.txt
# Make sure to compile files after any other files they include!
pip-compile --upgrade --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
pip-compile --upgrade -o requirements/pip-tools.txt requirements/pip-tools.in
pip-compile --upgrade -o requirements/base.txt requirements/base.in
pip-compile --upgrade -o requirements/test.txt requirements/test.in
pip-compile --upgrade -o requirements/doc.txt requirements/doc.in
pip-compile --upgrade -o requirements/quality.txt requirements/quality.in
pip-compile --upgrade -o requirements/validation.txt requirements/validation.in
pip-compile --upgrade -o requirements/ci.txt requirements/ci.in
pip-compile --upgrade -o requirements/dev.txt requirements/dev.in
pip-compile --upgrade -o requirements/production.txt requirements/production.in
# Let tox control the Django version for tests
grep -e "^django==" requirements/base.txt > requirements/django.txt
sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
mv requirements/test.tmp requirements/test.txt
extract_translations: ## extract strings to be translated, outputting .mo files
python manage.py makemessages -l en -v1 -d django
python manage.py makemessages -l en -v1 -d djangojs
dummy_translations: ## generate dummy translation (.po) files
cd program_intent_engagement && i18n_tool dummy
compile_translations: # compile translation files, outputting .po files for each supported language
python manage.py compilemessages
fake_translations: ## generate and compile dummy translation files
pull_translations: ## pull translations from Transifex
tx pull -t -af --mode reviewed
push_translations: ## push source translation files (.po) from Transifex
tx push -s
start-devstack: ## run a local development copy of the server
docker-compose --x-networking up
open-devstack: ## open a shell on the server started by start-devstack
docker exec -it program_intent_engagement /edx/app/program-intent-engagement/devstack.sh open
detect_changed_source_translations: ## check if translation files are up-to-date
cd program_intent_engagement && i18n_tool changed
validate_translations: fake_translations detect_changed_source_translations ## install fake translations and check if translation files are up-to-date
travis_docker_auth:
echo "$$DOCKER_PASSWORD" | docker login -u "$$DOCKER_USERNAME" --password-stdin
# devstack-themed shortcuts
dev.up: # Starts all containers
docker-compose up -d
dev.down: # Kills containers and all of their data that isn't in volumes
docker-compose down
dev.stop: # Stops containers so they can be restarted
docker-compose stop
app-shell: # Run the app shell as root
docker exec -u 0 -it program_intent_engagement.app bash
db-shell: # Run the app shell as root, enter the app's database
docker exec -u 0 -it program_intent_engagement.db mysql -u root program_intent_engagement
%-logs: # View the logs of the specified service container
docker-compose logs -f --tail=500 $*
%-restart: # Restart the specified service container
docker-compose restart $*
%-attach:
docker attach program_intent_engagement.$*
github_docker_auth:
echo "$$DOCKERHUB_PASSWORD" | docker login -u "$$DOCKERHUB_USERNAME" --password-stdin
selfcheck: ## check that the Makefile is well-formed
@echo "The Makefile is well-formed."