Development

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Go (version declared in go.mod)
Docker (required for shell-lint and npm-depcheck)
kubectl
GNU sed (macOS: brew install gnu-sed)

Running lint

Run Go linting across all modules:

Running and debugging tests

Mon, 01 Jan 0001 00:00:00 +0000

Quick start

The most common development workflows:

# Unit tests
make test

# Integration tests
make test-integration

# E2E: build image and run
# Note: PLATFORM=linux/arm64 is only needed on Apple Silicon (arm64).
# On amd64, run: make kind-image-build test-e2e-baseline
PLATFORM=linux/arm64 make kind-image-build test-e2e-baseline

# E2E: build, run, and keep the kind cluster alive between runs
E2E_MODE=dev PLATFORM=linux/arm64 make kind-image-build test-e2e-baseline

Quick filter reference

# Focus on tests matching a name pattern
GINKGO_ARGS="--focus=Scheduler" make test-integration
GINKGO_ARGS="--focus='Creating a Pod requesting TAS'" make test-e2e-baseline

# Filter integration tests by label
INTEGRATION_FILTERS="--label-filter=controller:workload" make test-integration
INTEGRATION_FILTERS="--label-filter=area:jobs" make test-integration

# Filter e2e tests by label
GINKGO_ARGS="--label-filter=feature:jobset" make test-e2e-extended

# Run only a specific integration test directory
INTEGRATION_TARGET='test/integration/singlecluster/scheduler' make test-integration

For the full label taxonomy and more examples, see Running a subset of tests.

Contribution Guidelines on Kueue

Development

Prerequisites

Running lint

Running and debugging tests

Quick start

Quick filter reference