BAZEL.md

Bazel Developer Reference

Quick reference for common developer workflows. Bazel is the primary build system for unit tests, linting, formatting, and type checking. See CONTRIBUTING.md for the full contribution guide and the Introduction to Bazel wiki page for deeper background. See How to run Bazel for more in depth commands.

Core subcommands

Command	What it does
bazel test	Builds and executes test targets; reports pass/fail per test.
bazel run	Builds a single executable/script target and immediately runs it.
bazel lint	Aspect-lint wrapper: enforces language rules, runs static analysis, and sorts Python imports; generates fix patches applied with --fix.

Quick start

Bazel is always run against a target. A target is a folder containing a BUILD file which defines the parts of that target.

Targets in this repo are e.g. //tests/unit or //cmk/

# Run all unit tests
$ bazel test //tests/unit/...

# Format files (layout only — does not sort imports)
$ bazel run //:format path/to/file.py

# Lint and autofix (includes import sorting)
$ bazel lint --fix //packages/cmk-ccc/...

# Type-check the whole repo with mypy
$ bazel build --config=mypy //...

Running tests

Unit tests

# All unit tests
$ bazel test //tests/unit/...

# A specific package, with full output on failure
$ bazel test --test_output=errors //tests/unit/cmk/gui/...

Edition-specific tests

Edition-aware targets are used when code is gated behind --cmk_edition. Pass the flag to run all unit tests for that edition:

$ bazel test --cmk_edition=pro //tests/unit/...
$ bazel test --cmk_edition=ultimate //tests/unit/...

For GUI tests that live under nonfree/, use the explicit targets:

$ bazel test //tests/unit/cmk/gui/nonfree/pro:all
$ bazel test //tests/unit/cmk/gui/nonfree/ultimate:all
$ bazel test //tests/unit/editions/...

Available editions: community, pro, ultimate, ultimatemt, cloud.

Integration, composition, and GUI E2E tests

These still use Make:

$ tests/run_tests.sh test-integration
$ tests/run_tests.sh test-composition
$ tests/run_tests.sh test-gui-e2e

Formatting and linting

Formatting and linting are intentionally kept separate. Each step is predictable and has no hidden side effects. This model applies consistently across all supported languages.

Formatting

# Apply formatting to specific files
$ bazel run //:format path/to/file.py other/file.py

# Check formatting without modifying (CI-safe)
$ bazel run //:format.check path/to/file.py

Formatting only adjusts layout: whitespace, indentation, line breaks. It does not enforce coding rules, run static analysis, or sort Python imports.

//:format handles multiple languages based on file extension (Python via ruff, shell via shfmt, etc.).

Linting

# Lint a specific package
$ bazel lint //packages/cmk-ccc/...
$ bazel lint //packages/cmk-ccc:all

# Autofix where supported (applies ruff patches to the working tree)
$ bazel lint --fix //packages/cmk-ccc/...

# Lint the whole repo (slow on the first run)
$ bazel lint ...

Linting enforces language rules and best practices, runs static analysis, and sorts Python imports. Import ordering is a linting concern in ruff, not a formatting one — so if your imports are unsorted after bazel run //:format, run bazel lint --fix next.

Type checking (mypy)

mypy runs selectively on targets declared as py_{library,binary,test}.

# Type-check a specific package
$ bazel build --config=mypy //packages/cmk-agent-based:all

# Type-check everything under cmk (edition-aware)
$ bazel build --config=mypy //cmk/...

Key CLI flags

Flag	Default	Description
--cmk_edition=<ed>	community	Edition: community, pro, ultimate, ultimatemt, cloud
--cmk_version=<ver>	—	Version string injected into builds
--cmk_distro=<distro>	ubuntu-24.04	Target Linux distribution
--config=ci	off	CI settings: no color, upload results, verbose fail
--config=debug	off	Verbose output and gRPC stack traces
--config=mypy	off	Enable the mypy aspect for type checking
--test_output=errors	summary	Show full test output only on failures

Personal settings

For user-global settings that apply across all worktrees, use ~/.bazelrc.

A good default to reign in bazel is

# --- 1. Prevent Disk/CPU priority hogging (The "Browser Savers") ---
startup --io_nice_level=7
startup --batch_cpu_scheduling

# --- 2. Cap the Server itself ---
startup --host_jvm_args=-Xmx4g

# --- 3. Existing Limits (Accumulated is fine!) ---
common --local_resources=cpu=HOST_CPUS*.5
common --local_resources=memory=HOST_RAM*.5

# --- 4. The Hidden CPU hog (Analysis Phase) ---
common --loading_phase_threads=HOST_CPUS*.5