Makefile

CARGO   ?= cargo
# Use the user-writable registry when the system CARGO_HOME is read-only.
# Override with: make CARGO_HOME=/path/to/cargo
export CARGO_HOME = $(HOME)/.cargo

# Wrap rustc with sccache when available for shared compilation caching across builds.
# Install with: cargo install sccache
# Override with: make RUSTC_WRAPPER=""  to disable.
ifneq ($(shell command -v sccache 2>/dev/null),)
export RUSTC_WRAPPER = sccache
endif

NPROC := $(shell nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || echo 4)
CARGO_FLAGS ?= --jobs $(NPROC)
VERSION := $(shell grep '^version' Cargo.toml | head -1 | sed 's/.*"\(.*\)".*/\1/')
TAG     := v$(VERSION)
DIST    ?= dist
DEB_OUT := target/debian
REPO    := swedishembedded/sven

.PHONY: all build release gui gui-release test tests/e2e tests/e2e/basic deb deb/debug deb/release clean help fmt check docs docs-pdf \
        relay relay-release p2p-client p2p-client-release p2p p2p-release p2p-test \
        release/build release/publish release/tag \
        release/patch release/minor release/major \
        _require-cargo-release \
        site/build site/publish site/serve \
        benchmark benchmark/build benchmark/terminal-bench benchmark/report

all: build

## build     – debug build (CLI + TUI + GUI)
build:
	$(CARGO) build $(CARGO_FLAGS)

## release   – optimised release build (CLI + TUI + GUI)
release:
	$(CARGO) build --release $(CARGO_FLAGS)

## gui       – debug build (GUI is `target/debug/sven --gui`, same binary as TUI)
gui:
	$(CARGO) build $(CARGO_FLAGS)
	@echo "Run the desktop GUI with: target/debug/sven --gui"

## gui-release – release build for desktop GUI (`target/release/sven --gui`)
gui-release:
	$(CARGO) build --release $(CARGO_FLAGS)
	@echo "Desktop GUI: target/release/sven --gui"

## test      – run all unit + integration tests
test:
	$(CARGO) test $(CARGO_FLAGS)

## tests/e2e/basic – run all basic end-to-end tests (requires bats-core)
## All tests use the mock model; hardware-gated tests in 07 self-skip without SVEN_TEST_JLINK=1.
tests/e2e/basic: build
	bats tests/e2e/basic/

## tests/e2e – run all end-to-end test suites (requires bats-core)
tests/e2e: tests/e2e/basic

# ── Benchmark targets ─────────────────────────────────────────────────────────
# Run sven against Terminal-Bench 2.0 via Harbor and generate a Markdown report.
#
# Prerequisites:
#   pip install -r benchmarks/requirements.txt   (installs harbor + jinja2)
#   OPENROUTER_API_KEY                           (required for the default free model)
#   ANTHROPIC_API_KEY / OPENAI_API_KEY / …       (whichever key the model needs)
#
# Override options:
#   MODEL                – model string (default: openrouter/openrouter/free)
#                          e.g.: make benchmark MODEL=anthropic/claude-sonnet-4-6
#   HARBOR_CONCURRENCY   – parallel Harbor workers (default: 4)
#   SVEN_BENCH_TIMEOUT   – per-task timeout in seconds (default: 1800)
#   HARBOR_FLAGS         – any extra flags passed verbatim to 'harbor run'

HARBOR_CONCURRENCY  ?= 4
SVEN_BENCH_TIMEOUT  ?= 1800
HARBOR_FLAGS        ?=
MUSL_TARGET         := x86_64-unknown-linux-musl
SVEN_BIN_PATH       := $(CURDIR)/target/$(MUSL_TARGET)/release/sven
MODEL               ?= openrouter/openrouter/free

## benchmark/build        – build a static musl binary for use inside benchmark containers
benchmark/build:
	@if ! rustup target list --installed | grep -q "$(MUSL_TARGET)"; then \
	    echo "Adding Rust target $(MUSL_TARGET)..."; \
	    sudo -E env PATH=$$PATH rustup target add $(MUSL_TARGET); \
	fi
	@if ! command -v musl-gcc >/dev/null 2>&1; then \
	    echo "musl-gcc not found. Installing musl-tools..."; \
	    sudo apt-get install -y musl-tools; \
	fi
	$(CARGO) build --release --target $(MUSL_TARGET) $(CARGO_FLAGS)
	@echo "Static binary: $(SVEN_BIN_PATH)"
	@file $(SVEN_BIN_PATH)

## benchmark              – build static binary, run all benchmarks, generate report
benchmark: benchmark/build benchmark/terminal-bench
	@python3 benchmarks/report.py target/benchmark > target/benchmark/report.md
	@echo ""
	@echo "Report written to target/benchmark/report.md"
	@echo "Preview:"; echo ""; head -40 target/benchmark/report.md

## benchmark/terminal-bench – run Terminal-Bench 2.0 via Harbor (requires harbor)
benchmark/terminal-bench: benchmark/build
	@command -v harbor >/dev/null 2>&1 || { \
	    echo "harbor not found."; \
	    echo "Install it with: pip install -r benchmarks/requirements.txt"; \
	    exit 1; }
	@mkdir -p target/benchmark
	@# Create a 'docker' shim that calls 'sudo docker', placed first on PATH
	@# so Harbor's hardcoded "docker compose ..." invocations go through sudo.
	@mkdir -p target/benchmark/.bin
	@printf '#!/bin/sh\nexec sudo -E docker "$$@"\n' > target/benchmark/.bin/docker
	@chmod +x target/benchmark/.bin/docker
	PATH=$(CURDIR)/target/benchmark/.bin:$$PATH \
	SVEN_BIN_PATH=$(SVEN_BIN_PATH) \
	SVEN_BENCH_TIMEOUT=$(SVEN_BENCH_TIMEOUT) \
	SVEN_MODEL=$(MODEL) \
	harbor run \
	    -d terminal-bench@2.0 \
	    --agent-import-path benchmarks.sven_agent:SvenInstalledAgent \
	    -o target/benchmark/terminal-bench \
	    -n $(HARBOR_CONCURRENCY) \
	    -k 1 \
	    $(HARBOR_FLAGS)

## benchmark/report        – regenerate report from existing result files
benchmark/report:
	@[ -d target/benchmark ] || { \
	    echo "No benchmark results found. Run 'make benchmark' first."; \
	    exit 1; }
	@python3 benchmarks/report.py target/benchmark > target/benchmark/report.md
	@cat target/benchmark/report.md

# ── Debian package targets ─────────────────────────────────────────────────────
## deb         – build optimised release Debian package (default; output in target/debian/)
deb: deb/release

## deb/debug   – build debug Debian package (no optimizations, fast build)
deb/debug: build
	@bash scripts/build-deb.sh --binary target/debug/sven --out-dir $(DEB_OUT)

## deb/release – build fully optimised release Debian package
deb/release: release
	@if command -v cargo-deb >/dev/null 2>&1; then \
		echo "Using cargo-deb..."; \
		mkdir -p target/completions; \
		target/release/sven completions bash > target/completions/sven.bash; \
		target/release/sven completions zsh  > target/completions/_sven; \
		target/release/sven completions fish > target/completions/sven.fish; \
		$(CARGO) deb --output $(DEB_OUT) $(CARGO_FLAGS); \
	else \
		echo "cargo-deb not found, using scripts/build-deb.sh..."; \
		bash scripts/build-deb.sh --out-dir $(DEB_OUT); \
	fi

## docs      – build single-file markdown user guide (output: target/docs/sven-user-guide.md)
docs:
	@mkdir -p target/docs
	@printf '' > target/docs/sven-user-guide.md
	@for f in docs/00-introduction.md \
	           docs/01-installation.md \
	           docs/02-quickstart.md \
	           docs/03-user-guide.md \
	           docs/04-ci-pipeline.md \
	           docs/05-configuration.md \
	           docs/06-examples.md \
	           docs/07-troubleshooting.md; do \
		if [ -f "$$f" ]; then \
			cat "$$f" >> target/docs/sven-user-guide.md; \
			printf '\n---\n\n' >> target/docs/sven-user-guide.md; \
		fi; \
	done
	@echo "User guide written to target/docs/sven-user-guide.md"

## docs-pdf  – build PDF user guide (requires pandoc + a LaTeX distribution)
docs-pdf: docs
	@command -v pandoc >/dev/null 2>&1 || { \
		echo "Error: pandoc is not installed."; \
		echo "Install it with: sudo apt install pandoc texlive-xetex texlive-fonts-recommended"; \
		exit 1; \
	}
	pandoc target/docs/sven-user-guide.md \
		--metadata-file=docs/metadata.yaml \
		--pdf-engine=xelatex \
		--toc \
		--toc-depth=2 \
		--number-sections \
		--highlight-style=tango \
		-o target/docs/sven-user-guide.pdf
	@echo "PDF guide written to target/docs/sven-user-guide.pdf"

## fmt       – format all code
fmt:
	$(CARGO) fmt --all

## check     – lint without building
check:
	$(CARGO) clippy --all-targets $(CARGO_FLAGS) -- -D warnings

## relay     – build the sven-relay server (requires git-discovery feature)
relay:
	$(CARGO) build -p sven-p2p --bin sven-relay --features git-discovery $(CARGO_FLAGS)
	@echo "Binary: target/debug/sven-relay"
	@echo "Usage:  sven-relay --listen /ip4/0.0.0.0/tcp/4001 --repo /path/to/git/repo"

## relay-release – release-optimised relay binary
relay-release:
	$(CARGO) build -p sven-p2p --bin sven-relay --features git-discovery --release $(CARGO_FLAGS)
	@echo "Binary: target/release/sven-relay"

## p2p-client – build the sven-p2p-client TUI/chat client
p2p-client:
	$(CARGO) build -p sven-p2p --bin sven-p2p-client $(CARGO_FLAGS)
	@echo "Binary: target/debug/sven-p2p-client"
	@echo "Usage:  sven-p2p-client --repo . --room <room> --name <name>"
	@echo "        sven-p2p-client --repo . --room <room> --name <name> -m '@peer hello'"

## p2p-client-release – release-optimised client binary
p2p-client-release:
	$(CARGO) build -p sven-p2p --bin sven-p2p-client --release $(CARGO_FLAGS)
	@echo "Binary: target/release/sven-p2p-client"

## p2p      – build both relay and client debug binaries
p2p: relay p2p-client

## p2p-release – build both relay and client release binaries
p2p-release: relay-release p2p-client-release

## p2p-test – run sven-p2p unit and integration tests
p2p-test:
	$(CARGO) test -p sven-p2p $(CARGO_FLAGS)

## clean     – remove build artefacts
clean:
	$(CARGO) clean
	rm -rf target/debian target/debian-staging target/completions target/docs target/benchmark $(DIST)

## help      – show this message
help:
	@grep -E '^##' Makefile | sed 's/^## /  /'
	@echo ""
	@echo "  Site targets:"
	@grep -E '^##' site/Makefile 2>/dev/null | sed 's/^## /    /' || true

# ── Release targets ───────────────────────────────────────────────────────────
## release/build   – build release artifacts for current platform into dist/
release/build:
	@bash scripts/release-build.sh --out-dir $(DIST)

## release/tag     – create an annotated git tag for current version and push
release/tag:
	@echo "Current version: $(VERSION)"
	@if git rev-parse "$(TAG)" >/dev/null 2>&1; then \
	    echo "error: tag $(TAG) already exists. Bump the version first."; \
	    exit 1; \
	fi
	@if [ -n "$$(git status --porcelain)" ]; then \
	    echo "error: working tree is dirty. Commit your changes before tagging."; \
	    git status --short; \
	    exit 1; \
	fi
	@echo "Tagging $(TAG) on $$(git rev-parse --short HEAD)..."
	@git tag -a "$(TAG)" -m "Release $(TAG)"
	@git push origin "$(TAG)"
	@echo ""
	@echo "Tag $(TAG) pushed → GitHub Actions release workflow will start."
	@echo "Watch: https://github.com/$(REPO)/actions"

## release/publish – create a GitHub Release and upload dist/ artifacts via gh CLI
release/publish:
	@if [ -z "$$(ls $(DIST)/sven-* 2>/dev/null)" ]; then \
	    echo "error: no artifacts found in $(DIST)/"; \
	    echo "       Run 'make release/build' first."; \
	    exit 1; \
	fi
	@if ! command -v gh >/dev/null 2>&1; then \
	    echo "error: gh CLI not found."; \
	    echo "       Install from https://cli.github.com/"; \
	    exit 1; \
	fi
	@echo "Publishing $(TAG) to github.com/$(REPO)..."
	@ARTIFACTS=$$(find $(DIST) -maxdepth 1 -type f | sort | tr '\n' ' '); \
	gh release create "$(TAG)" \
	    --repo "$(REPO)" \
	    --title "sven $(TAG)" \
	    --generate-notes \
	    $$ARTIFACTS
	@echo ""
	@echo "Release: https://github.com/$(REPO)/releases/tag/$(TAG)"

## release/patch   – bump patch version (0.1.x→0.1.x+1), tag, push → triggers CI
release/patch: _require-cargo-release test tests/e2e/basic
	@cargo release patch -p sven --execute --no-confirm
	@git push origin main --follow-tags

## release/minor   – bump minor version (0.x.0→0.x+1.0), tag, push → triggers CI
release/minor: _require-cargo-release test tests/e2e/basic
	@cargo release minor -p sven --execute --no-confirm
	@git push origin main --follow-tags

## release/major   – bump major version (x.0.0→x+1.0.0), tag, push → triggers CI
release/major: _require-cargo-release test tests/e2e/basic
	@cargo release major -p sven --execute --no-confirm
	@git push origin main --follow-tags

# ── Site targets ─────────────────────────────────────────────────────────────
## site/build   – build the sven-site Docker image
site/build:
	$(MAKE) -C site build

## site/publish – upload the Docker image to swedishembedded.com via SSH
site/publish:
	$(MAKE) -C site publish

## site/serve   – serve the site locally on http://localhost:3000
site/serve:
	$(MAKE) -C site serve

# Install cargo-release if not already present.
.PHONY: _require-cargo-release
_require-cargo-release:
	@if ! cargo release --version >/dev/null 2>&1; then \
	    echo "cargo-release not found — installing..."; \
	    cargo install cargo-release --locked; \
	fi