Makefile

SHELL:=/usr/bin/env bash

APP_NAME        := censys-cloud-connector
REGISTRY_NAME   := gcr.io/censys-io
DOCKER_TAG      := $$(git rev-parse HEAD)
DOCKER_IMG      := ${REGISTRY_NAME}/${APP_NAME}

REQUIREMENTS	:= requirements.txt
VENV 			:= .venv
POETRY 			:= $(shell command -v poetry 2> /dev/null)

.PHONY: all
all: help

.PHONY: install
install:  ## Install the connector dependencies
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install

.PHONY: install-aws
install-aws:  ## Install the connector with aws dependencies
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install --with aws

.PHONY: install-gcp
install-gcp:  ## Install the connector with gcp dependencies
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install --with gcp

.PHONY: install-azure
install-azure:  ## Install the connector with azure dependencies
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install --with azure

.PHONY: install-all
install-all:  ## Install the connector with all provider dependency groups
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install --with aws,gcp,azure

.PHONY: docs
docs:  ## Build the documentation
	@if [ -z $(POETRY) ]; then echo "Poetry could not be found. See https://python-poetry.org/docs/"; exit 2; fi
	$(POETRY) install --with docs
	cd docs && $(POETRY) run make html

.PHONY: clean
clean:
	find . -type d -name "__pycache__" | xargs rm -rf {};
	rm -rf .coverage .mypy_cache .venv

.PHONY: lock
lock:
	$(POETRY) lock --no-update

.PHONY: requirements
requirements: $(REQUIREMENTS)  ## Builds python requirements.txt
${REQUIREMENTS}: $(INSTALL_STAMP)
	$(POETRY) export -f $(REQUIREMENTS) -o $(REQUIREMENTS) --without-hashes

.PHONY: format
format:
	$(POETRY) run black .
	$(POETRY) run isort .

.PHONY: lint
lint:
	$(POETRY) run flake8 .
	$(POETRY) run mypy -p censys.cloud_connectors

.PHONY: test
test:  ## Runs tests
	$(POETRY) run pytest --no-cov

.PHONY: test-cov
test-cov:  ## Runs tests and generates coverage report
	$(POETRY) run pytest --cov --cov-report html

.PHONY: build-image
build-image:  ## Builds docker image
	docker build -t $(DOCKER_IMG):$(DOCKER_TAG) .

# via https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
.PHONY: help
help: ## Show make help
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'