2018-09-29 15:08:39 +00:00
|
|
|
|
.DEFAULT_GOAL := help
|
2019-06-06 19:58:21 +00:00
|
|
|
|
SRC_DIRS = ./tutor ./tests ./plugins ./bin
|
|
|
|
|
BLACK_OPTS = --exclude templates ${SRC_DIRS}
|
2018-09-29 15:08:39 +00:00
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Development
|
|
|
|
|
|
2019-01-22 20:25:04 +00:00
|
|
|
|
compile-requirements: ## Compile requirements files
|
|
|
|
|
pip-compile -o requirements/base.txt requirements/base.in
|
|
|
|
|
pip-compile -o requirements/dev.txt requirements/dev.in
|
2019-02-20 11:52:57 +00:00
|
|
|
|
pip-compile -o requirements/docs.txt requirements/docs.in
|
2019-06-19 10:14:49 +00:00
|
|
|
|
|
|
|
|
|
package: ## Build a package ready to upload to pypi
|
2019-06-19 10:38:26 +00:00
|
|
|
|
python3 setup.py sdist
|
2017-12-26 00:16:35 +00:00
|
|
|
|
|
2019-06-23 20:46:41 +00:00
|
|
|
|
package-plugins: ## Build packages for each plugin
|
|
|
|
|
cd plugins/minio && python3 setup.py sdist --dist-dir=../../dist/
|
2019-07-02 20:16:44 +00:00
|
|
|
|
cd plugins/xqueue && python3 setup.py sdist --dist-dir=../../dist/
|
2019-06-23 20:46:41 +00:00
|
|
|
|
|
|
|
|
|
test: test-lint test-unit test-format test-packages ## Run all tests by decreasing order or priority
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
|
|
|
|
test-format: ## Run code formatting tests
|
2019-06-03 10:23:05 +00:00
|
|
|
|
black --check --diff $(BLACK_OPTS)
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
|
|
|
|
test-lint: ## Run code linting tests
|
2019-07-02 20:16:44 +00:00
|
|
|
|
pylint --errors-only --ignore=templates ${SRC_DIRS}
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
2019-05-29 09:14:06 +00:00
|
|
|
|
test-unit: test-unit-core test-unit-plugins ## Run unit tests
|
|
|
|
|
|
2019-06-19 10:02:28 +00:00
|
|
|
|
test-unit-core: ## Run unit tests on core
|
2019-05-05 09:44:48 +00:00
|
|
|
|
python3 -m unittest discover tests
|
2019-03-23 23:16:03 +00:00
|
|
|
|
|
2019-06-19 10:02:28 +00:00
|
|
|
|
test-unit-plugins: ## Run unit tests on plugins
|
2019-05-29 09:14:06 +00:00
|
|
|
|
python3 -m unittest discover plugins/minio/tests
|
2019-07-02 20:16:44 +00:00
|
|
|
|
python3 -m unittest discover plugins/xqueue/tests
|
2019-05-29 09:14:06 +00:00
|
|
|
|
|
2019-06-23 20:46:41 +00:00
|
|
|
|
test-packages: package package-plugins ## Test that packages can be uploaded to pypi
|
|
|
|
|
twine check dist/tutor-*.tar.gz
|
2019-06-19 10:02:28 +00:00
|
|
|
|
|
2019-05-05 09:40:49 +00:00
|
|
|
|
format: ## Format code automatically
|
2019-06-03 10:23:05 +00:00
|
|
|
|
black $(BLACK_OPTS)
|
2019-05-05 09:40:49 +00:00
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Deployment
|
|
|
|
|
|
2019-01-22 20:25:04 +00:00
|
|
|
|
bundle: ## Bundle the tutor package in a single "dist/tutor" executable
|
2019-06-06 19:58:21 +00:00
|
|
|
|
pyinstaller --onefile --name=tutor --add-data=./tutor/templates:./tutor/templates ./bin/main.py
|
2019-02-24 19:14:25 +00:00
|
|
|
|
dist/tutor:
|
|
|
|
|
$(MAKE) bundle
|
|
|
|
|
|
2019-03-21 21:51:35 +00:00
|
|
|
|
nightly: ## Create a "nightly" release
|
|
|
|
|
$(MAKE) tag TAG=nightly
|
2019-02-18 08:22:41 +00:00
|
|
|
|
|
2019-04-22 11:29:53 +00:00
|
|
|
|
release: ## Create a release tag and push it to origin
|
2019-03-21 21:51:35 +00:00
|
|
|
|
$(MAKE) tag TAG=v$(shell make version)
|
|
|
|
|
|
|
|
|
|
tag:
|
2019-02-18 08:57:59 +00:00
|
|
|
|
@echo "=== Creating tag $(TAG)"
|
2019-02-18 08:22:41 +00:00
|
|
|
|
git tag -d $(TAG) || true
|
|
|
|
|
git tag $(TAG)
|
2019-06-23 15:01:28 +00:00
|
|
|
|
@echo "=== Pushing tag $(TAG) to origin"
|
2019-02-18 08:22:41 +00:00
|
|
|
|
git push origin :$(TAG) || true
|
|
|
|
|
git push origin $(TAG)
|
2019-06-23 15:01:28 +00:00
|
|
|
|
@echo "=== Pushing tag $(TAG) to overhangio"
|
|
|
|
|
git push overhangio :$(TAG) || true
|
|
|
|
|
git push overhangio $(TAG)
|
2019-02-18 08:22:41 +00:00
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Continuous integration tasks
|
|
|
|
|
|
2019-02-10 20:02:30 +00:00
|
|
|
|
ci-info: ## Print info about environment
|
|
|
|
|
python3 --version
|
|
|
|
|
pip3 --version
|
|
|
|
|
|
2019-06-23 20:46:41 +00:00
|
|
|
|
ci-install-dev: ## Install requirements
|
2019-06-23 15:01:28 +00:00
|
|
|
|
pip3 install -U setuptools twine
|
2019-02-10 20:02:30 +00:00
|
|
|
|
pip3 install -r requirements/dev.txt
|
2019-05-29 09:14:06 +00:00
|
|
|
|
pip3 install -r requirements/plugins.txt
|
2019-05-05 09:49:08 +00:00
|
|
|
|
|
2019-06-23 20:46:41 +00:00
|
|
|
|
ci-install:
|
|
|
|
|
pip3 install -U setuptools twine
|
|
|
|
|
pip3 install -r requirements/base.txt
|
|
|
|
|
pip3 install -r requirements/plugins.txt
|
|
|
|
|
|
2019-05-05 09:49:08 +00:00
|
|
|
|
ci-bundle: ## Create bundle and run basic tests
|
2019-02-10 20:02:30 +00:00
|
|
|
|
$(MAKE) bundle
|
2019-02-18 08:22:41 +00:00
|
|
|
|
mkdir -p releases/
|
2019-03-18 16:26:37 +00:00
|
|
|
|
./dist/tutor --version
|
|
|
|
|
./dist/tutor config printroot
|
2019-06-05 17:45:22 +00:00
|
|
|
|
yes "" | ./dist/tutor config save --interactive
|
|
|
|
|
./dist/tutor config save --set ACTIVATE_NOTES=true --set ACTIVATE_XQUEUE=true
|
2019-02-10 20:02:30 +00:00
|
|
|
|
|
2019-04-22 13:17:45 +00:00
|
|
|
|
./releases/github-release: ## Download github-release binary
|
|
|
|
|
cd releases/ \
|
|
|
|
|
&& curl -sSL -o ./github-release.tar.bz2 "https://github.com/aktau/github-release/releases/download/v0.7.2/$(shell uname -s | tr "[:upper:]" "[:lower:]")-amd64-github-release.tar.bz2" \
|
|
|
|
|
&& bzip2 -d -f ./github-release.tar.bz2 \
|
|
|
|
|
&& tar xf github-release.tar \
|
|
|
|
|
&& mv "bin/$(shell uname -s | tr "[:upper:]" "[:lower:]")/amd64/github-release" .
|
|
|
|
|
|
|
|
|
|
ci-github: ./releases/github-release ## Upload assets to github
|
|
|
|
|
sed "s/TUTOR_VERSION/v$(shell make version)/g" docs/_release_description.md > releases/description.md
|
2019-04-22 13:14:46 +00:00
|
|
|
|
git log -1 --pretty=format:%b >> releases/description.md
|
2019-04-22 13:17:45 +00:00
|
|
|
|
./releases/github-release release \
|
2019-06-23 17:56:15 +00:00
|
|
|
|
--user overhangio \
|
2019-04-22 13:14:46 +00:00
|
|
|
|
--repo tutor \
|
2019-04-22 13:17:45 +00:00
|
|
|
|
--tag "v$(shell make version)" \
|
|
|
|
|
--name "v$(shell make version)" \
|
2019-04-22 13:14:46 +00:00
|
|
|
|
--description "$$(cat releases/description.md)" || true
|
2019-04-22 13:17:45 +00:00
|
|
|
|
./releases/github-release upload \
|
2019-06-23 17:56:15 +00:00
|
|
|
|
--user overhangio \
|
2019-04-22 13:14:46 +00:00
|
|
|
|
--repo tutor \
|
2019-04-22 13:17:45 +00:00
|
|
|
|
--tag "v$(shell make version)" \
|
2019-04-22 13:14:46 +00:00
|
|
|
|
--name "tutor-$$(uname -s)_$$(uname -m)" \
|
2019-04-22 13:17:45 +00:00
|
|
|
|
--file ./dist/tutor \
|
2019-06-23 15:01:28 +00:00
|
|
|
|
--replace
|
|
|
|
|
|
|
|
|
|
ci-config-images:
|
2019-07-02 20:16:44 +00:00
|
|
|
|
tutor plugin enable xqueue
|
|
|
|
|
tutor config save --set ACTIVATE_NOTES=true
|
2019-04-22 13:14:46 +00:00
|
|
|
|
|
2019-06-23 15:01:28 +00:00
|
|
|
|
ci-build-images: ci-config-images ## Build docker images
|
2019-02-10 20:02:30 +00:00
|
|
|
|
tutor images build all
|
|
|
|
|
|
2019-06-23 15:01:28 +00:00
|
|
|
|
ci-push-images: ci-config-images ## Push docker images to hub.docker.com
|
|
|
|
|
docker login -u "$$DOCKER_USERNAME" -p "$$DOCKER_PASSWORD"
|
|
|
|
|
tutor images push all
|
|
|
|
|
|
2019-06-23 20:46:41 +00:00
|
|
|
|
ci-pypi: ## Push packages to pypi
|
|
|
|
|
twine upload --skip-existing dist/tutor-*.tar.gz
|
2019-02-10 20:02:30 +00:00
|
|
|
|
|
2019-03-18 16:26:37 +00:00
|
|
|
|
###### Additional commands
|
|
|
|
|
|
|
|
|
|
version: ## Print the current tutor version
|
|
|
|
|
@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutor", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
|
|
|
|
|
|
2018-09-29 15:22:55 +00:00
|
|
|
|
ESCAPE =
|
|
|
|
|
help: ## Print this help
|
|
|
|
|
@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
|
|
|
|
|
| sed 's/######* \(.*\)/\n $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' \
|
|
|
|
|
| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
|