Makefile

include .env.dist

LIB_NAME                   := imgtests
# Docker
DOCKER_PREFIX              := ${LIB_NAME}
DOCKER_TAG                 := ${DOCKER_PREFIX}-yocto-builder
DOCKER_SUSE_TAG            := ${DOCKER_PREFIX}-open-suse-env
DOCKER_PYTHON_TAG          := ${DOCKER_PREFIX}-analyzer
DOCKER_BUILD_VOLUME        := ${DOCKER_PREFIX}-yocto-build
DOCKER_DOWNLOADS_VOLUME    := ${DOCKER_PREFIX}-yocto-downloads
DOCKER_SSTATE_VOLUME       := ${DOCKER_PREFIX}-yocto-sstate
DOCKER_OPENSUSE_VOLUME     := ${DOCKER_PREFIX}-open-suse-files
DOCKER_POSTGRES_VOLUME	   := ${DOCKER_PREFIX}-postgres-data
BENCHER_API_CONF_VOLUME    := ${DOCKER_PREFIX}-bencher-conf
BENCHER_API_DB_VOLUME      := ${DOCKER_PREFIX}-bencher-database
BENCHER_API_LOGS_VOLUME    := ${DOCKER_PREFIX}-bencher-logs
VMETRICS_DATA_VOLUME	   := ${DOCKER_PREFIX}-vmetrics-data

# Paths
HOST_LAYERS_PATH           := ${CURDIR}/layers
HOST_CONF_PATH             := ${CURDIR}/conf
HOST_SCRIPTS_PATH          := ${CURDIR}/scripts
TESTS_DIR                  := ${CURDIR}/tests

# Python
define get_python_required_libs
	python3 -c "import sys; \
		sys.exit(1) if sys.version_info < (3,11) else None;
		import tomllib; from pathlib import Path; \
		print(' '.join(tomllib.loads(Path('pyproject.toml').read_text())['project']['dependencies']))"
endef

PACKAGE_MGR                := uv
PYTHON_REQUIRED_LIBS       := $(shell $(call get_python_required_libs))
PYTHONDONTWRITEBYTECODE    := 1
PY_LIB_NAME                := $(shell grep -Po 'name\s*=\s*"\K(\w+)' pyproject.toml)

.PHONY: ensure-python-dependencies
ensure-python-dependencies:
	@if [ -z "${PYTHON_REQUIRED_LIBS}" ]; then \
		echo "ERROR: PYTHON_REQUIRED_LIBS is empty."; \
		echo "This might be because you're using Python < 3.11 which doesn't have tomllib module."; \
		echo "Please use Python 3.11 or higher."; \
		echo "You are using $(shell python --version)."; \
		exit 1; \
	fi

.PHONY: docker
docker: ensure-python-dependencies init-submodule
	docker build \
		--tag ${DOCKER_TAG} \
		--build-arg USER="${USER}" \
		--build-arg GROUP="${GROUP}" \
		--build-arg LIB_NAME="${LIB_NAME}" \
		--build-arg PYTHON_REQUIRED_LIBS="${PYTHON_REQUIRED_LIBS}" \
		--build-arg PASSWORD="${PASSWORD}" \
		--build-arg POKY_DIR="${POKY_DIR}" \
		--file docker/image_builder.dockerfile .

.PHONY: docker-compose-up
docker-compose-up: ensure-python-dependencies ensure-volumes
	docker compose --file docker/compose.yml --project-directory ./ up --detach --build

.PHONY: docker-compose-down
docker-compose-down:
	docker compose --file docker/compose.yml --project-directory ./ down

.PHONY: ensure-volumes
ensure-volumes: docker
	@for volume in ${DOCKER_OPENSUSE_VOLUME} ${BENCHER_API_CONF_VOLUME} ${BENCHER_API_DB_VOLUME} \
	                ${BENCHER_API_LOGS_VOLUME} ${VMETRICS_DATA_VOLUME} ${DOCKER_POSTGRES_VOLUME}; do \
		if ! docker volume inspect $$volume > /dev/null 2>&1; then \
			docker volume create $$volume; \
		fi \
	done;
	@for volume in ${DOCKER_BUILD_VOLUME} ${DOCKER_DOWNLOADS_VOLUME} ${DOCKER_SSTATE_VOLUME}; do \
		if ! docker volume inspect $$volume > /dev/null 2>&1; then \
			docker volume create $$volume; \
			docker run --rm --user root \
				--entrypoint "" \
				--volume $$volume:/data \
				${DOCKER_TAG} bash -c "chown -R ${USER}:${GROUP} /data"; \
		fi \
	done

.PHONY: init-submodule
init-submodule:
	git submodule update --init --recursive

.PHONY: ${PACKAGE_MGR}
${PACKAGE_MGR}:
	@which ${PACKAGE_MGR} || \
		(echo "Failed to find '${PACKAGE_MGR}'. Required to install '${PACKAGE_MGR}' first." && exit 1)
	@${PACKAGE_MGR} sync

.PHONY: pre-commit-check
pre-commit-check: ${PACKAGE_MGR}
	@uvx pre-commit run --all-files

.PHONY: unit-test
unit-test: ${PACKAGE_MGR}
	@echo "Running tests for the library '${PY_LIB_NAME}''..."
	@COVERAGE_FILE=${TESTS_DIR}/.coverage uv run --with pytest --with pytest-cov pytest ${TESTS_DIR}/unit ${TESTS_DIR}/misc

.PHONY: help
help:
	@echo "Usage:"
	@echo "  make [targets] [arguments]"
	@echo
	@echo "  docker                             Builds a docker image;"
	@echo "  docker-compose-up                  Run tests stand with analysis container and target containers;"
	@echo "  docker-compose-down                Stop all containers;"
	@echo -n "  ${PACKAGE_MGR}"
	@echo     "                                 Updates the project's Python environment with the '${PACKAGE_MGR}';"
	@echo "  ensure-volumes                     Creates volumes if missing and changes ownership;"
	@echo "  ensure-python-dependencies         Checks that Python 3.11+ is available and required dependencies can be extracted;"
	@echo "  init-submodule                     Recursive initialization git submodules;"
	@echo "  pre-commit-check                   Check source code with pre-commit hooks;"
	@echo "  unit-test                          Run unit tests for the Python library '${PY_LIB_NAME}';"
	@echo "  help                               Displays information about all available targets."

.EXPORT_ALL_VARIABLES: