Makefile

# SPDX-FileCopyrightText: (C) 2025 Intel Corporation
# SPDX-License-Identifier: Apache-2.0

SHELL := bash -eu -o pipefail

# default goal to show help
.DEFAULT_GOAL := help
.PHONY: all lint build mdlint ruff fix-linter format pyright run build-dev run-dev test \
	shell shell-vippet shell-models shell-collector shell-videogenerator stop clean clean-output-videos help \
	build-videogenerator build-models build-onvif-discovery docker-build env-setup \
	install-models-once install-models-force install-models-all \
	test-smoke test-full

# Project Variables
PROJECT_NAME := vippet
PROJECT_DIR := $(shell pwd)

# Docker Compose Variables
COMPOSE_FILE := compose.yml
DEV_COMPOSE_FILE := compose.dev.yml

# Python venv Target
VENV_DIR := .venv

$(VENV_DIR): $(PROJECT_NAME)/requirements.txt ## Create Python venv
	python3 -m venv $@ ;\
	set +u; . ./$@/bin/activate; set -u ;\
	python -m pip install --upgrade pip ;\
	python -m pip install -r $(PROJECT_NAME)/requirements-dev.txt ;\
	python -m pip install -r video_generator/requirements.txt # needed for pyright checks

all: lint build run test ## Run lint, build, run and test

lint: $(VENV_DIR) mdlint ruff pyright ## Run all linters

MD_FILES := $(shell find . -type f \( -name '*.md' \) -not -path './.*' -print )
mdlint: ## Lint MD files
# download tool from https://github.com/igorshubovych/markdownlint-cli
	markdownlint --version
	markdownlint $(MD_FILES)

ruff: $(VENV_DIR) ## Run ruff linter
	set +u; . ./$</bin/activate; set -u ;\
	ruff --version ;\
	# Exclude shared/scripts/ to avoid formatting user created scripts ;\
	ruff check --exclude shared/scripts/ ;\
	ruff format --check --exclude shared/scripts/ 

fix-linter: $(VENV_DIR) ## Fix linter issues using ruff
	set +u; . ./$</bin/activate; set -u ;\
	# Exclude shared/scripts/ to avoid formatting user created scripts ;\
	ruff check --fix --exclude shared/scripts/ 

format: $(VENV_DIR) ## Format code using ruff
	set +u; . ./$</bin/activate; set -u ;\
	# Exclude shared/scripts/ to avoid formatting user created scripts ;\
	ruff format --exclude shared/scripts/ 

pyright: $(VENV_DIR) ## Run pyright type checker
	set +u; . ./$</bin/activate; set -u ;\
	pyright --version ;\
	pyright .

generate_openapi: $(VENV_DIR) ## Generate OpenAPI schema file
	set +u; . ./$</bin/activate; set -u ;\
	cd $(PROJECT_NAME) ;\
	PYTHONPATH=. SUPPORTED_MODELS_FILE=../shared/models/supported_models.yaml INPUT_VIDEO_DIR=../shared/videos/input python ../generate_openapi.py

env-setup: ## Environment setup target: always run before build/run targets that need .env and shared dirs
	mkdir -p shared/collector-signals && chmod o+w shared/collector-signals
	mkdir -p shared/models/output && chmod o+w shared/models/output
	mkdir -p shared/videos/input && chmod o+w shared/videos/input
	mkdir -p shared/videos/output && chmod o+w shared/videos/output
	mkdir -p shared/videos/video-generator && chmod o+w shared/videos/video-generator
	./setup_env.sh

build: env-setup ## Build core images (vippet-app, vippet-collector, vippet-ui)
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build

build-dev: env-setup ## Build core dev images (vippet-app, vippet-collector, vippet-ui)
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml -f $(DEV_COMPOSE_FILE) build

build-videogenerator: env-setup ## Build videogenerator image
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build videogenerator

build-models: env-setup ## Build model image
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build models

build-onvif-discovery: env-setup ## Build onvif discovery image
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml build onvif-discovery

docker-build: build build-videogenerator build-models ## Build all images

run: env-setup install-models-once ## Run the docker compose services
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml up -d

run-videogenerator: env-setup build-videogenerator ## Run only the videogenerator service
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml up -d videogenerator

run-dev: env-setup install-models-once ## Run the docker compose services for development
	. .env && docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml -f $(DEV_COMPOSE_FILE) up -d

test: env-setup ## Run unit tests and generate coverage report
    # Run tests using the cpu profile (tests are device agnostic)
    # Override DOCKER_TAG with '-test' suffix only for this docker compose run
	. .env && TARGET=test DOCKER_TAG="test" docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run \
	--build --rm --no-deps --volume $(PROJECT_DIR):/home/dlstreamer/vippet vippet bash -c "\
		cd $(PROJECT_NAME) && \
		INPUT_VIDEO_DIR=/tmp \
		OUTPUT_VIDEO_DIR=/tmp \
		python -m coverage run --source=./ --data-file=/tmp/.vippet-coverage -m unittest discover -v -s ./tests/unit -p '*_test.py' && \
		python -m coverage report --data-file=/tmp/.vippet-coverage --omit=*/config-3.py,*/config.py,*_test.py"

test-smoke: $(VENV_DIR) ## Run smoke functional tests
	set +u; . ./$</bin/activate; set -u ;\
	python -m pytest --log-cli-level=INFO -m smoke vippet/tests/functional/

test-full: $(VENV_DIR) ## Run full functional tests
	set +u; . ./$</bin/activate; set -u ;\
	python -m pytest --log-cli-level=INFO vippet/tests/functional/

install-models-once: env-setup ## Handle models download and installation (once)
	. .env && MODEL_INSTALLATION=once docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run --rm -it models

install-models-force: env-setup ## Handle models download and installation (force)
	. .env && MODEL_INSTALLATION=force docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run --rm -it models

install-models-all: env-setup ## Install all models automatically (no dialog)
	. .env && MODEL_INSTALLATION=all docker compose -f $(COMPOSE_FILE) -f compose.$$COMPOSE_PROFILES.yml run --rm -it models

shell: env-setup ## Open shell in specified container (i.e. make shell SERVICE=vippet)
	docker exec -it $(SERVICE) bash

shell-vippet: ## Open shell in vippet container
	$(MAKE) shell SERVICE=vippet

shell-models: ## Open shell in models container
	$(MAKE) shell SERVICE=models

shell-collector: ## Open shell in collector container
	$(MAKE) shell SERVICE=collector

shell-videogenerator: ## Open shell in videogenerator container
	$(MAKE) shell SERVICE=videogenerator

stop: ## Stop the docker compose services
	docker compose down models collector videogenerator mediamtx vippet-ui vippet onvif-discovery

clean: ## Clean all build artifacts
	rm -rf shared/collector-signals shared/models/output/ shared/onvif/onvif_cameras.json shared/videos/input shared/videos/output shared/videos/video-generator

clean-output-videos: ## Clean only output videos
	rm -rf shared/videos/output/*

help: ## Print help for each target
	@echo ViPPET make targets
	@echo "Target               Makefile:Line    Description"
	@echo "-------------------- ---------------- -----------------------------------------"
	@grep -H -n '^[[:alnum:]_-]*:.* ##' $(MAKEFILE_LIST) \
    | sort -t ":" -k 3 \
    | awk 'BEGIN  {FS=":"}; {sub(".* ## ", "", $$4)}; {printf "%-20s %-16s %s\n", $$3, $$1 ":" $$2, $$4};'