Makefile

# Copyright 2025 The Kubeflow Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Setting SHELL to bash allows bash commands to be executed by recipes.
# This is a requirement for 'setup-envtest.sh' in the test target.
# Options are set to exit when a recipe line exits non-zero or a piped command fails.
SHELL = /usr/bin/env bash -o pipefail
.SHELLFLAGS = -ec

PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
VENV_DIR := $(PROJECT_DIR)/.venv

# Setting SED for compatibility with macos
ifeq ($(shell command -v gsed 2>/dev/null),)
    SED ?= $(shell command -v sed)
else
    SED ?= $(shell command -v gsed)
endif
ifeq ($(shell ${SED} --version 2>&1 | grep -q GNU; echo $$?),1)
    $(error !!! GNU sed is required. If on OS X, use 'brew install gnu-sed'.)
endif

##@ General

# The help target prints out all targets with their descriptions organized
# beneath their categories. The categories are represented by '##@' and the
# target descriptions by '##'. The awk commands is responsible for reading the
# entire set of makefiles included in this invocation, looking for lines of the
# file as xyz: ## something, and then pretty-format the target and help. Then,
# if there's a line with ##@ something, that gets pretty-printed as a category.
# More info on the usage of ANSI control characters for terminal formatting:
# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
# More info on the awk command:
# http://linuxcommand.org/lc3_adv_awk.php

help: ## Display this help.
	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

.PHONY: uv
uv: ## Install UV
	@command -v uv &> /dev/null || { \
	  curl -LsSf https://astral.sh/uv/install.sh | sh; \
	  echo "✅ uv has been installed."; \
	}

.PHONY: ruff
ruff: ## Install Ruff
	@uv run ruff --help &> /dev/null || uv tool install ruff

.PHONY: verify
verify: install-dev  ## install all required tools
	@uv lock --check
	@uv run ruff check --show-fixes --output-format=github .
	@uv run ruff format --check kubeflow
	@uv run ty check kubeflow/hub

.PHONY: uv-venv
uv-venv:  ## Create uv virtual environment
	@if [ ! -d "$(VENV_DIR)" ]; then \
		echo "Creating uv virtual environment in $(VENV_DIR)..."; \
		uv venv; \
	else \
		echo "uv virtual environment already exists in $(VENV_DIR)."; \
	fi

.PHONY: release
release: install-dev
	@if [ -z "$(VERSION)" ] || ! echo "$(VERSION)" | grep -E -q '^[0-9]+\.[0-9]+\.[0-9]+$$'; then \
		echo "Error: VERSION must be set in X.Y.Z format. Usage: make release VERSION=X.Y.Z"; \
		exit 1; \
	fi
	@$(SED) -i 's/^__version__ = ".*"/__version__ = "$(VERSION)"/' kubeflow/__init__.py
	@MAJOR_MINOR=$$(echo "$(VERSION)" | cut -d. -f1,2); \
	CHANGELOG_PATH="CHANGELOG/CHANGELOG-$$MAJOR_MINOR.md"; \
	echo "Generating changelog for $(VERSION) (unreleased)"; \
	CLIFF_CMD="uv run git-cliff --unreleased --tag $(VERSION)"; \
	if [ -f "$$CHANGELOG_PATH" ]; then \
		$$CLIFF_CMD --prepend "$$CHANGELOG_PATH"; \
	else \
		$$CLIFF_CMD -o "$$CHANGELOG_PATH"; \
	fi; \
	echo "Changelog generated at $$CHANGELOG_PATH"


 # make test-python will produce html coverage by default. Run with `make test-python report=xml` to produce xml report.
.PHONY: test-python
test-python: uv-venv  ## Run Python unit tests
	@uv sync --extra spark
	@uv run coverage run --source=kubeflow -m pytest ./kubeflow/
	@uv run coverage report --omit='*_test.py' --skip-covered --skip-empty
ifeq ($(report),xml)
	@uv run coverage xml
else
	@uv run coverage html
endif

##@ E2E Testing

.PHONY: test-e2e-setup-cluster
test-e2e-setup-cluster:  ## Setup Kind cluster for Spark E2E tests
	@echo "Setting up E2E test cluster..."
	@K8S_VERSION=$(K8S_VERSION) \
	 SPARK_TEST_CLUSTER=$(SPARK_TEST_CLUSTER) \
	 SPARK_TEST_NAMESPACE=$(SPARK_TEST_NAMESPACE) \
	 SPARK_OPERATOR_VERSION=$(SPARK_OPERATOR_VERSION) \
	 KIND=$(KIND) \
	 ./hack/e2e-setup-cluster.sh
.PHONY: test-scripts
test-scripts: uv-venv  ## Run GitHub Actions script tests
	@uv sync
	@uv run pytest .github/scripts/test_scripts.py -v


.PHONY: install-dev
install-dev: uv uv-venv ruff  ## Install uv, create .venv, sync deps.
	@echo "Using virtual environment at: $(VENV_DIR)"
	@echo "Syncing dependencies with uv..."
	@uv sync
	@echo "Environment is ready."

## Documentation

.PHONY: docs
docs:  ## Build documentation
	@uv sync --group docs
	@uv run sphinx-build -b html docs/source docs/_build/html

.PHONY: docs-clean
docs-clean:  ## Clean documentation build
	@rm -rf docs/_build

.PHONY: docs-serve
docs-serve:  ## Build and serve docs with live reload
	@uv sync --group docs
	@uv pip install sphinx-autobuild
	@uv run sphinx-autobuild docs/source docs/_build/html