PYTHON ?= python3 PY_FILES := $(shell git ls-files -- *.py | xargs) ROOT_DIR ?= $(shell git rev-parse --show-toplevel) # Color no_color = \033[0m black = \033[0;30m red = \033[0;31m green = \033[0;32m yellow = \033[0;33m blue = \033[0;34m purple = \033[0;35m cyan = \033[0;36m white = \033[0;37m # Version RELEASE_VERSION ?= $(shell git rev-parse --short HEAD)_$(shell date -u +%Y-%m-%dT%H:%M:%S%z) GIT_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD) GIT_COMMIT ?= $(shell git rev-parse --verify HEAD) # URL for skyline-console packages SKYLINE_CONSOLE_PACKAGE_URL ?= "https://tarballs.opendev.org/openstack/skyline-console/skyline-console-master.tar.gz" .PHONY: all all: install fmt lint test package .PHONY: help help: @echo "Skyline API server development makefile" @echo @echo "Usage: make " @echo @echo "Target:" @echo " git_config Initialize git configuration." @echo " venv Create virtualenvs." @echo " install Installs the project dependencies." @echo " package Build package from source code." @echo " build Build container image." @echo " lint Check python code." @echo " fmt Format python code style." @echo " test Run unit tests." @echo " db_revision Generate database alembic version revision with model." @echo " db_sync Sync database from alembic version revision." @echo " swagger Generate swagger json file." @echo " genconfig Generate sample config file." @echo " future_check Find python files without 'type annotations'.(Alpha)" @echo .PHONY: git_config user_name = $(shell git config --get user.name) user_email = $(shell git config --get user.email) commit_template = $(shell git config --get commit.template) git_config: ifeq ($(user_name),) @printf "$(cyan)\n" @read -p "Set your git user name: " user_name; \ git config --local user.name $$user_name; \ printf "$(green)User name was set.\n$(cyan)" endif ifeq ($(user_email),) @printf "$(cyan)\n" @read -p "Set your git email address: " user_email; \ git config --local user.email $$user_email; \ printf "$(green)User email address was set.\n$(no_color)" endif ifeq ($(commit_template),) @git config --local commit.template $(ROOT_DIR)/tools/git_config/commit_message.txt endif @printf "$(green)Project git config was successfully set.\n$(no_color)" @printf "${yellow}You may need to run 'pip install git-review' install git review tools.\n\n${no_color}" .PHONY: venv venv: poetry env use $(PYTHON) .PHONY: install install: venv poetry run pip install -U pip setuptools'<58.0.0' poetry install -vvv tools/post_install.sh .PHONY: package package: poetry build .PHONY: fmt fmt: poetry run isort $(PY_FILES) poetry run black --config pyproject.toml $(PY_FILES) poetry run add-trailing-comma --py36-plus --exit-zero-even-if-changed $(PY_FILES) .PHONY: lint lint: # poetry run mypy --strict --config-file=mypy.ini $(PY_FILES) poetry run isort --check-only --diff $(PY_FILES) poetry run black --check --diff --color --config pyproject.toml $(PY_FILES) poetry run flake8 --config .flake8 $(PY_FILES) .PHONY: test test: poetry run pytest .PHONY: clean clean: rm -rf .venv dist htmlcov .coverage log test_results.html .PHONY: build BUILD_ENGINE ?= docker BUILD_CONTEXT ?= . DOCKER_FILE ?= container/Dockerfile IMAGE ?= skyline IMAGE_TAG ?= latest ifeq ($(BUILD_ENGINE), docker) build_cmd = docker build else ifeq ($(BUILD_ENGINE), buildah) build_cmd = buildah bud else $(error Unsupported build engine $(BUILD_ENGINE)) endif build: GIT_CONSOLE_COMMIT=$(shell wget $(SKYLINE_CONSOLE_PACKAGE_URL) && tar -zxf skyline-console-master.tar.gz && cat skyline-console-0.1.0/skyline_console/static/commit_id.txt); \ $(build_cmd) --no-cache --pull --force-rm --build-arg RELEASE_VERSION=$(RELEASE_VERSION) --build-arg SKYLINE_CONSOLE_PACKAGE_URL=$(SKYLINE_CONSOLE_PACKAGE_URL) --build-arg GIT_BRANCH=$(GIT_BRANCH) --build-arg GIT_COMMIT=$(GIT_COMMIT) --build-arg GIT_CONSOLE_COMMIT=$$GIT_CONSOLE_COMMIT $(BUILD_ARGS) -f $(DOCKER_FILE) -t $(IMAGE):$(IMAGE_TAG) $(BUILD_CONTEXT) rm -rf skyline-console-* .PHONY: swagger swagger: poetry run swagger-generator -o $(ROOT_DIR)/docs/api/swagger.json .PHONY: genconfig genconfig: poetry run config-sample-generator -o $(ROOT_DIR)/etc/skyline.yaml.sample .PHONY: db_revision HEAD_REV ?= $(shell poetry run alembic -c skyline_apiserver/db/alembic/alembic.ini heads | awk '{print $$1}') NEW_REV ?= $(shell python3 -c 'import sys; print(f"{int(sys.argv[1])+1:03}")' $(HEAD_REV)) REV_MEG ?= db_revision: $(shell [ -z "$(REV_MEG)" ] && printf '$(red)Missing required message, use "make db_revision REV_MEG="$(no_color)') poetry run alembic -c skyline_apiserver/db/alembic/alembic.ini revision --autogenerate --rev-id $(NEW_REV) -m '$(REV_MEG)' .PHONY: db_sync db_sync: poetry run alembic -c skyline_apiserver/db/alembic/alembic.ini upgrade head # Find python files without "type annotations" future_check: @find skyline_apiserver ! -size 0 -type f -name *.py -exec grep -L 'from __future__ import annotations' {} \;