forked from openedx/credentials
/
Makefile
200 lines (153 loc) · 9.01 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
.DEFAULT_GOAL := help
NODE_BIN=./node_modules/.bin
TOX = ''
.PHONY: help clean \
production-requirements all-requirements requirements piptools upgrade \
quality quality_fix isort isort_check format format_check quality-js \
tests js-tests \
static static.dev static.watch \
extract_translations dummy_translations compile_translations fake_translations pull_translations push_translations \
detect_changed_source_translations validate_translations check_translations_up_to_date \
check_keywords pii_check coverage \
quality_and_translations_tests_suite unit_tests_suite docs
ifdef TOXENV
TOX := tox -- #to isolate each tox environment if TOXENV is defined
endif
# 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: ## Remove all generated files
coverage erase
find . -path '*/__pycache__/*' -delete
find . -name \*.pyc -o -name \*.pyo -o -name __pycache__ -delete
rm -rf credentials/assets/ credentials/static/bundles/ credentials/static/jsi18n/ coverage htmlcov test_root/uploads reports
git clean -fd credentials/conf/locale
### Requirements commands ###
production-requirements: piptools ## Install requirements for production
npm install --no-save
pip-sync requirements/production.txt
all-requirements: piptools ## Install local and prod requirements
npm install
npm install --production --no-save
pip-sync requirements/all.txt
requirements: piptools ## Install requirements for local development
npm install --also=dev
pip-sync requirements/dev.txt
piptools:
pip install -q -r requirements/pip_tools.txt
define COMMON_CONSTRAINTS_TEMP_COMMENT
# This is a temporary solution to override the real common_constraints.txt\n# In edx-lint, until the pyjwt constraint in edx-lint has been removed.\n# See BOM-2721 for more details.\n# Below is the copied and edited version of common_constraints\n
endef
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 $(@)
export CUSTOM_COMPILE_COMMAND = make upgrade
upgrade: piptools $(COMMON_CONSTRAINTS_TXT) ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
sed '/^django-simple-history==/d' requirements/common_constraints.txt > requirements/common_constraints.tmp
mv requirements/common_constraints.tmp requirements/common_constraints.txt
sed 's/Django<4.0//g' requirements/common_constraints.txt > requirements/common_constraints.tmp
mv requirements/common_constraints.tmp requirements/common_constraints.txt
pip-compile --allow-unsafe --rebuild --upgrade -o requirements/pip.txt requirements/pip.in
pip-compile --rebuild --upgrade -o requirements/pip_tools.txt requirements/pip_tools.in
pip install -qr requirements/pip.txt
pip install -qr requirements/pip_tools.txt
pip-compile --rebuild --upgrade -o requirements/base.txt requirements/base.in
pip-compile --rebuild --upgrade -o requirements/test.txt requirements/test.in
pip-compile --rebuild --upgrade -o requirements/docs.txt requirements/docs.in
pip-compile --rebuild --upgrade -o requirements/dev.txt requirements/dev.in
pip-compile --rebuild --upgrade -o requirements/production.txt requirements/production.in
pip-compile --rebuild --upgrade -o requirements/all.txt requirements/all.in
pip-compile --rebuild --upgrade -o requirements/translations.txt requirements/translations.in
# Let tox control the Django version for tests
grep -e "^django==" requirements/production.txt > requirements/django.txt
sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
mv requirements/test.tmp requirements/test.txt
### Quality commands ###
quality: isort_check quality-js format_check ## Run linters
PYTHONPATH=. pylint --django-settings-module=credentials.settings.test --rcfile=pylintrc credentials *.py
quality_fix: isort format
isort: ## Run isort to sort imports in all Python files
isort --recursive --atomic credentials/
isort_check: ## Check that isort has been run
isort --check-only credentials/
format: ## format code
black .
format_check: ## check that code is formatted correctly
black --check credentials/
quality-js: ## Run JavaScript linter
npm run lint
### Testing commands ###
tests: ## Run tests and generate coverage report
$(TOX)coverage run -m pytest --ds credentials.settings.test --durations=25
$(TOX)coverage report
test-karma: ## Run JS tests through Karma & install firefox. This command needs to be ran manually in the devstack container before submitting a pull request. It can not be run in CI as of APER-2136.
sudo apt-get update
sudo apt-get install --no-install-recommends -y firefox xvfb
xvfb-run $(NODE_BIN)/karma start
### Frontend commands ###
static: ## Gather all static assets for production (minimized)
$(NODE_BIN)/webpack --config webpack.config.js
$(TOX)python manage.py compilejsi18n
$(TOX)python manage.py collectstatic --noinput -i *.scss
static.dev: ## Gather all static assets for development (not minimized)
$(NODE_BIN)/webpack --config webpack.config.js
$(TOX)python manage.py compilejsi18n
$(TOX)python manage.py collectstatic --noinput -i *.scss
static.watch: ## Gather static assets when they change (not minimized)
$(NODE_BIN)/webpack --config webpack.config.js --watch
python manage.py compilejsi18n
python manage.py collectstatic --noinput -i *.scss
## Apply database migrations
migrate:
python manage.py migrate --noinput
### Translation commands
extract_translations: ## Extract strings to be translated, outputting .po files
cd credentials && PYTHONPATH=.. i18n_tool extract -v
dummy_translations: ## Generate dummy translation (.po) files
cd credentials && i18n_tool dummy
compile_translations: ## Compile translation files, outputting .mo files for each supported language
cd credentials && PYTHONPATH=.. i18n_tool generate
fake_translations: extract_translations dummy_translations compile_translations ## Generate and compile dummy translation files
# This Make target should not be removed since it is relied on by a Jenkins job (`edx-internal/tools-edx-jenkins/translation-jobs.yml`), using `ecommerce-scripts/transifex`.
ifeq ($(OPENEDX_ATLAS_PULL),)
pull_translations: ## Pull translations from Transifex
tx pull -t -a -f --mode reviewed --minimum-perc=1
else
# Experimental: OEP-58 Pulls translations using atlas
pull_translations:
find credentials/conf/locale -mindepth 1 -maxdepth 1 -type d -exec rm -r {} \;
atlas pull $(OPENEDX_ATLAS_ARGS) translations/credentials/credentials/conf/locale:credentials/conf/locale
python manage.py compilemessages
@echo "Translations have been pulled via Atlas and compiled."
@echo "'make static' or 'make static.dev' is required to update the js i18n files."
endif
# This Make target should not be removed since it is relied on by a Jenkins job (`edx-internal/tools-edx-jenkins/translation-jobs.yml`), using `ecommerce-scripts/transifex`.
push_translations: ## Push source translation files (.po) to Transifex
tx push -s
detect_changed_source_translations: ## Check if translation files are up-to-date
cd credentials && i18n_tool changed
validate_translations: ## Test translations files
cd credentials && i18n_tool validate -v --check-all
check_translations_up_to_date: fake_translations detect_changed_source_translations ## Install fake translations and check if translation files are up-to-date
### Additonal linting commands
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
pii_check: ## Check for PII annotations on all Django models
DJANGO_SETTINGS_MODULE=credentials.settings.test \
code_annotations django_find_annotations --config_file .pii_annotations.yml --lint --report --coverage
coverage:
coverage xml
### Local testing suite commands ###
build_test_image: # Builds Docker image used for testing so devs don't need to install requirements locally (useful for firefox / xvfb)
docker build -t credentials:local -f Dockerfile-testing .
# This should be ran locally, not inside of the devstack container
quality_and_translations_tests_suite: build_test_image
docker run -e "TERM=xterm-256color" -v /edx/app/credentials/node_modules/ -v `pwd`:/edx/app/credentials/ credentials:local bash -c 'cd /edx/app/credentials/ && make check_translations_up_to_date && make validate_translations && make quality && make check_keywords && make pii_check'
# This should be ran locally, not inside of the devstack container
unit_tests_suite: build_test_image
docker run -e "TERM=xterm-256color" -v /edx/app/credentials/node_modules/ -v `pwd`:/edx/app/credentials/ credentials:local bash -c 'cd /edx/app/credentials/ && make static && make tests && make coverage'
docs:
tox -e docs