bzr 0.2.0

A CLI for Bugzilla, inspired by gh
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

CARGO ?= cargo
RUST_MIN_VERSION := 1.84.0

.PHONY: setup check-rust ensure-components ensure-coverage-prereqs ensure-mutants-prereq install-hooks \
        build release test coverage fmt clippy lint clean help man \
        mutants mutants-fast mutants-list audit-mutant-skips \
        functional-build functional-start functional-test functional-stop \
        functional-test-bz52 functional-test-bz53 functional-test-all functional-stop-all \
        functional-test-keyring

## Setup & Environment

setup: check-rust ensure-components ensure-coverage-prereqs install-hooks build ## Set up the development environment
	@echo
	@echo "Setup complete. You're ready to develop bzr."

check-rust:
	@printf "Checking for Rust toolchain... "
	@command -v rustc >/dev/null 2>&1 || { echo "MISSING"; echo "  Install Rust: https://rustup.rs"; exit 1; }
	@command -v cargo >/dev/null 2>&1 || { echo "MISSING"; echo "  Install Rust: https://rustup.rs"; exit 1; }
	@RUST_VER=$$(rustc --version | sed 's/rustc \([^ ]*\).*/\1/'); \
	printf "%s " "$$RUST_VER"; \
	LOWEST=$$(printf '%s\n%s\n' "$(RUST_MIN_VERSION)" "$$RUST_VER" | sort -V | head -n1); \
	if [ "$$LOWEST" != "$(RUST_MIN_VERSION)" ]; then \
		echo "(need >= $(RUST_MIN_VERSION))"; exit 1; \
	fi
	@echo "ok"

ensure-components:
	@printf "Checking for rustfmt... "
	@rustup component list --installed 2>/dev/null | grep -q rustfmt || { \
		echo "installing"; \
		rustup component add rustfmt; \
	}
	@printf "Checking for rustfmt... ok\n"
	@printf "Checking for clippy... "
	@rustup component list --installed 2>/dev/null | grep -q clippy || { \
		echo "installing"; \
		rustup component add clippy; \
	}
	@printf "Checking for clippy... ok\n"

ensure-coverage-prereqs:
	@printf "Checking for cargo-llvm-cov... "
	@command -v cargo-llvm-cov >/dev/null 2>&1 || { \
		echo "installing"; \
		$(CARGO) install cargo-llvm-cov; \
	}
	@printf "Checking for cargo-llvm-cov... ok\n"
	@printf "Checking for llvm-tools-preview... "
	@rustup component list --installed 2>/dev/null | grep -q '^llvm-tools-' || { \
		echo "installing"; \
		rustup component add llvm-tools-preview; \
	}
	@printf "Checking for llvm-tools-preview... ok\n"

install-hooks: ## Install git pre-commit and pre-push hooks
	@echo "Installing git hooks..."
	@HOOKS_DIR=$$(git rev-parse --git-path hooks) && \
	mkdir -p "$$HOOKS_DIR" && \
	printf '#!/bin/sh\nset -eu\ncargo fmt -- --check || { echo "Run cargo fmt before committing."; exit 1; }\ncargo clippy -- -D warnings\n' > "$$HOOKS_DIR/pre-commit" && \
	chmod +x "$$HOOKS_DIR/pre-commit" && \
	printf '#!/bin/sh\nset -eu\ncargo test\n' > "$$HOOKS_DIR/pre-push" && \
	chmod +x "$$HOOKS_DIR/pre-push" && \
	echo "Installed pre-commit (fmt + clippy) and pre-push (test) hooks."

## Development

build: ## Build in debug mode
	$(CARGO) build

release: ## Build in release mode
	$(CARGO) build --release

test: ## Run tests
	$(CARGO) test

coverage: ## Run tests with coverage via cargo-llvm-cov
	@command -v cargo-llvm-cov >/dev/null 2>&1 || { echo "cargo-llvm-cov not installed"; echo "  Run: cargo install cargo-llvm-cov"; exit 1; }
	@rustup component list --installed 2>/dev/null | grep -q '^llvm-tools-' || { echo "llvm-tools-preview not installed"; echo "  Run: rustup component add llvm-tools-preview"; exit 1; }
	cargo llvm-cov --locked --workspace --all-features --summary-only

fmt: ## Format source code
	$(CARGO) fmt

clippy: ## Run clippy lints
	$(CARGO) clippy -- -D warnings

lint: fmt clippy ## Run all linters (fmt + clippy)

clean: ## Remove build artifacts
	$(CARGO) clean
	rm -rf man

man: ## Generate manpages into man/man1/
	$(CARGO) run -p xtask --no-default-features --release --quiet -- man --out man/man1

## Mutation Testing
#
# MUTANTS_JOBS caps how many cargo build+test pipelines run in parallel.
# Each one can spawn many compile threads, so values >8 risk overwhelming the
# host (cargo-mutants warns above 8). Default 4 leaves headroom for other work
# on the same machine. Override with: MUTANTS_JOBS=N make mutants
MUTANTS_JOBS ?= 4

ensure-mutants-prereq:
	@command -v cargo-mutants >/dev/null 2>&1 || { echo "cargo-mutants not installed"; echo "  Run: cargo install cargo-mutants --locked"; exit 1; }

mutants: ensure-mutants-prereq ## Run cargo-mutants across the whole crate (slow; hours). MUTANTS_JOBS=N to override parallelism (default 4)
	cargo mutants --jobs $(MUTANTS_JOBS)

mutants-fast: ensure-mutants-prereq ## Run cargo-mutants only on lines changed vs. origin/main
	git diff origin/main...HEAD > /tmp/bzr-mutants.diff
	cargo mutants --in-diff /tmp/bzr-mutants.diff --jobs $(MUTANTS_JOBS)

mutants-list: ensure-mutants-prereq ## List all mutants without running tests
	cargo mutants --list

audit-mutant-skips: ## Print every `mutants::skip` site with surrounding context
	@if command -v rg >/dev/null 2>&1; then \
		rg --line-number --context 2 'mutants::skip' src/ || echo "No mutants::skip annotations found."; \
	else \
		grep -rn --include='*.rs' --context=2 'mutants::skip' src/ || echo "No mutants::skip annotations found."; \
	fi

## Functional Tests

functional-build: ## Build the Bugzilla container image
	tests/functional/setup-bugzilla.sh build

functional-start: ## Start the Bugzilla container
	tests/functional/setup-bugzilla.sh start

functional-test: functional-start ## Run functional tests against real Bugzilla
	tests/functional/run-tests.sh

functional-stop: ## Stop and remove the Bugzilla container
	tests/functional/setup-bugzilla.sh stop

functional-test-bz52: ## Run functional tests against Bugzilla 5.2
	BZR_BZ_VERSION=bz52 tests/functional/setup-bugzilla.sh start
	BZR_BZ_VERSION=bz52 tests/functional/run-tests.sh

functional-test-bz53: ## Run functional tests against Bugzilla 5.3 (master)
	BZR_BZ_VERSION=bz53 tests/functional/setup-bugzilla.sh start
	BZR_BZ_VERSION=bz53 tests/functional/run-tests.sh

functional-test-all: ## Run functional tests against all Bugzilla versions
	tests/functional/run-all-versions.sh

functional-stop-all: ## Stop all Bugzilla test containers
	BZR_BZ_VERSION=bz50 tests/functional/setup-bugzilla.sh stop
	BZR_BZ_VERSION=bz52 tests/functional/setup-bugzilla.sh stop
	BZR_BZ_VERSION=bz53 tests/functional/setup-bugzilla.sh stop

functional-test-keyring: ## Run keyring functional test against real OS keychain
	tests/functional/keyring-test.sh

## Help

help: ## Show this help
	@grep -E '^[a-zA-Z_-]+:.*##' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*## "}; {printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2}'