Makefile

#
# synse python client
#

PKG_NAME    := $(shell python setup.py --name)
PKG_VERSION := $(shell python setup.py --version)


.PHONY: clean
clean:  ## Clean up build artifacts
	rm -rf build/ dist/ *.egg-info htmlcov/ .coverage* .pytest_cache/ \
		synse/__pycache__ tests/__pycache__ site/

.PHONY: deps
deps:  ## Update the frozen pip dependencies (requirements.txt)
	tox -e deps

.PHONY: docs
docs:  ## Build project documentation locally
	@if [ ! -d "docs/_static" ]; then mkdir docs/_static; fi
	@if [ ! -d "docs/_templates" ]; then mkdir docs/_templates; fi
	tox -e docs

.PHONY: fmt
fmt:  ## Automatic source code formatting (isort, autopep8)
	tox -e fmt

.PHONY: github-tag
github-tag:  ## Create and push a GitHub tag with the current version
	git tag -a ${PKG_VERSION} -m "${PKG_NAME} version ${PKG_VERSION}"
	git push -u origin ${PKG_VERSION}

.PHONY: lint
lint:  ## Run linting checks on the project source code (isort, flake8, twine check)
	tox -e lint

.PHONY: test
test:  ## Run the project unit tests
	tox tests/unit

.PHONY: integration
integration:  ## Run the project integration tests
	-docker-compose -f compose/integration.yaml rm -fsv
	docker-compose -f compose/integration.yaml up -d
	sleep 5
	tox tests/integration || (docker-compose -f compose/integration.yaml stop; exit 1)
	docker-compose -f compose/integration.yaml down

.PHONY: version
version:  ## Print the package version
	@echo "${PKG_VERSION}"

.PHONY: help
help:  ## Print usage information
	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z0-9_-]+:.*?## / {printf "\033[36m%-16s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort


.DEFAULT_GOAL := help


# Jenkins CI Pipeline Targets

.PHONY: unit-test pypi-release

unit-test: test

pypi-release:
	tox -e publish