justfile

#
# Config
#

proxy-init-image := "test.l5d.io/linkerd/proxy-init:test"
_test-image := "test.l5d.io/linkerd/iptables-tester:test"
cni-plugin-image := "test.l5d.io/linkerd/cni-plugin:test"
_cni-plugin-test-image := "test.l5d.io/linkerd/cni-plugin-tester:test"

##
## Recipes
##

default: lint test

lint: sh-lint md-lint rs-clippy action-lint action-dev-check

go-lint *flags: (proxy-init-lint flags) (cni-plugin-lint flags)

test: rs-test proxy-init-test-unit proxy-init-test-integration cni-repair-controller-integration

# Check whether the Go code is formatted.
go-fmt-check:
    out=$(gofmt -d .) ; [ -z "$out" ] || (echo "$out" ; exit 1)

##
## rust
##

# By default we compile in development mode because it's faster
rs-profile := "debug"

rs-target := "x86_64-unknown-linux-gnu"

# Overrides the default Rust toolchain version
rs-toolchain := ""

_cargo := 'just-cargo profile=' + rs-profile + ' target='  + rs-target + ' toolchain=' + rs-toolchain

# Fetch Rust dependencies
rs-fetch:
    {{ _cargo }} fetch --locked

# Format Rust code
rs-fmt-check:
    {{ _cargo }} fmt --all -- --check

# Lint Rust code
rs-clippy:
    {{ _cargo }} clippy --all-targets --no-deps

# Audit Rust dependencies
rs-audit-deps:
    cargo-deny --all-features check

# Build Rust unit and integration tests
rs-test-build:
    {{ _cargo }} test-build --workspace

# Run unit tests in whole Rust workspace
rs-test *flags:
    {{ _cargo }} test --workspace {{ flags }}

# Check a specific Rust crate
rs-check-dir dir *flags:
    cd {{ dir }} \
        && {{ _cargo }} check {{ flags }}

##
## validator
##

validator *args:
    TARGETCRATE=linkerd-network-validator \
      {{ just_executable() }} --justfile=justfile-rust {{ args }}

##
## cni-repair-controller
##

cni-repair-controller *args:
    TARGETCRATE=linkerd-cni-repair-controller \
      {{ just_executable() }} --justfile=justfile-rust {{ args }}

# The K3S_IMAGES_JSON file used instructs the creation of a cluster on version
# v1.27.6-k3s1, because after that Calico won't work.
# See https://github.com/k3d-io/k3d/issues/1375
cni-repair-controller-integration $K3S_IMAGES_JSON='./cni-plugin/integration/calico-k3s-images.json': build-cni-plugin-image
    @{{ just_executable() }} K3D_CREATE_FLAGS='{{ _K3D_CREATE_FLAGS_NO_CNI }}' _k3d-cni-create
    @just-k3d use
    @just-k3d import {{ cni-plugin-image }}
    ./cni-repair-controller/integration/run.sh {{ cni-plugin-image }}

##
## cni-plugin
##

cni-plugin-lint *flags:
    golangci-lint run ./cni-plugin/... {{ flags }}

##
## proxy-init
##

proxy-init-build:
    go build -o target/linkerd2-proxy-init ./proxy-init

proxy-init-lint *flags:
    golangci-lint run ./proxy-init/... {{ flags }}

# Run proxy-init unit tests
proxy-init-test-unit:
    go test -v ./proxy-init/...
    go test -v ./pkg/...

# Run proxy-init integration tests after preparing dependencies
proxy-init-test-integration: proxy-init-test-integration-deps proxy-init-test-integration-run

# Build and load images
proxy-init-test-integration-deps: build-proxy-init-image build-proxy-init-test-image _k3d-ready
    @just-k3d import {{ _test-image }} {{ proxy-init-image }}

# Run integration tests without preparing dependencies
proxy-init-test-integration-run:
    TEST_CTX="k3d-$(just-k3d --evaluate K3D_CLUSTER_NAME)" ./proxy-init/integration/run.sh

# Build docker image for proxy-init (Development)
build-proxy-init-image *args='--load':
    docker buildx build . --tag={{ proxy-init-image }} {{ args }}

# Build docker image for iptables-tester (Development)
build-proxy-init-test-image *args='--load':
    docker buildx build . \
        --file=proxy-init/integration/iptables/Dockerfile-tester \
        --tag={{ _test-image }} \
        {{ args }}

##
## cni-plugin
##

cni-plugin-build:
    go build -o target/linkerd2-cni-plugin ./cni-plugin

cni-plugin-test-unit:
    go test -v ./cni-plugin/...

# Build docker image for cni-plugin (Development)
build-cni-plugin-image *args='--load':
    docker buildx build . \
        --file=Dockerfile-cni-plugin \
        --tag={{ cni-plugin-image }} \
        {{ args }}

# Build docker image for cni-plugin-tester (Development)
build-cni-plugin-test-image *args='--load':
    docker buildx build . \
        --file=cni-plugin/integration/Dockerfile-tester \
        --tag={{ _cni-plugin-test-image }} \
        {{ args }}

##
## CNI plugin integration
##


# Run cni-plugin integration tests after preparing dependencies By default,
# runs "flannel" scenario, behavior can be overridden through
# `CNI_TEST_SCENARIO` env variable
# To run all scenarios see: `cni-plugin-test-integration-all`
cni-plugin-test-integration: _cni-plugin-test-integration-deps _cni-plugin-test-integration

# An alternate target is needed here so we can insert cilium-specific setup
cni-plugin-test-integration-with-cilium: _cni-plugin-test-integration-deps _cni-plugin-setup-cilium _cni-plugin-test-integration

# Run all integration test scenarios, in different environments
cni-plugin-test-integration-all: cni-plugin-test-integration-flannel cni-plugin-test-integration-calico

# Build and load images for cni-plugin
_cni-plugin-test-integration-deps: build-cni-plugin-image build-cni-plugin-test-image _k3d-cni-create
    @just-k3d import {{ _cni-plugin-test-image }} {{ cni-plugin-image }}

# Run an integration test without preparing any dependencies
_cni-plugin-test-integration:
    TEST_CTX="k3d-$(just-k3d --evaluate K3D_CLUSTER_NAME)" ./cni-plugin/integration/run.sh

# Run cni-plugin integration tests using calico, in a dedicated k3d environment
# NOTE: we have to rely on a different set of dependencies here; specifically
# `k3d-create` instead of `_k3d-ready`, since without a CNI DNS pods won't
# start.
# The K3S_IMAGES_JSON file used instructs the creation of a cluster on version
# v1.27.6-k3s1, because after that Calico won't work.
# See https://github.com/k3d-io/k3d/issues/1375
cni-plugin-test-integration-calico $K3S_IMAGES_JSON='./cni-plugin/integration/calico-k3s-images.json':
    @{{ just_executable() }} \
        CNI_TEST_SCENARIO='calico' \
        K3D_CLUSTER_NAME='l5d-calico-test' \
        K3D_CREATE_FLAGS='{{ _K3D_CREATE_FLAGS_NO_CNI }}' \
        cni-plugin-test-integration

cni-plugin-test-integration-cilium:
    @{{ just_executable() }} \
        CNI_TEST_SCENARIO='cilium' \
        K3D_CLUSTER_NAME='l5d-cilium-test' \
        K3D_CREATE_FLAGS='{{ _K3D_CREATE_FLAGS_NO_CNI_NO_POLICY_ENFORCER }}' \
        cni-plugin-test-integration-with-cilium

cni-plugin-test-ordering: build-cni-plugin-image
    @{{ just_executable() }} K3D_CLUSTER_NAME='l5d-calico-ordering-test' _cni-plugin-test-ordering-run

_cni-plugin-test-ordering-run $K3S_IMAGES_JSON='./cni-plugin/integration/calico-k3s-images.json':
    @{{ just_executable() }} K3D_CREATE_FLAGS='{{ _K3D_CREATE_FLAGS_NO_CNI }}' _k3d-cni-create
    @just-k3d import {{ cni-plugin-image }}
    ./cni-plugin/integration/run-ordering.sh

_cni-plugin-setup-cilium:
    #!/usr/bin/env bash
    set -euxo pipefail
    docker exec k3d-l5d-cilium-test-server-0 mount bpffs /sys/fs/bpf -t bpf
    docker exec k3d-l5d-cilium-test-server-0 mount --make-shared /sys/fs/bpf
    docker exec k3d-l5d-cilium-test-server-0 mkdir -p /run/cilium/cgroupv2
    docker exec k3d-l5d-cilium-test-server-0 mount -t cgroup2 none /run/cilium/cgroupv2
    docker exec k3d-l5d-cilium-test-server-0 mount --make-shared /run/cilium/cgroupv2/
    echo "Mounted /sys/fs/bpf to cilium-test-server cluster"
    helm repo add cilium https://helm.cilium.io/
    helm install cilium cilium/cilium --version 1.13.0 \
        --kube-context k3d-l5d-cilium-test \
        --namespace kube-system \
        --set kubeProxyReplacement=partial \
        --set hostServices.enabled=false \
        --set externalIPs.enabled=true \
        --set nodePort.enabled=true \
        --set hostPort.enabled=true \
        --set bpf.masquerade=false \
        --set image.pullPolicy=IfNotPresent \
        --set ipam.mode=kubernetes
    echo "cilium has been installed"

# Run cni-plugin integration tests using flannel, in a dedicated k3d
# environment
cni-plugin-test-integration-flannel:
    @{{ just_executable() }} \
        K3D_CLUSTER_NAME='l5d-flannel-test' \
        cni-plugin-test-integration

# TODO(stevej): add a k3d-create-debug
export K3D_CLUSTER_NAME := env_var_or_default("K3D_CLUSTER_NAME", "l5d")
export K3S_DISABLE := "local-storage,traefik,servicelb,metrics-server@server:*"
export K3D_CREATE_FLAGS := '--no-lb --k3s-arg "--debug@server:*"'

# Scenario to use for integration tests
export CNI_TEST_SCENARIO := env_var_or_default("CNI_TEST_SCENARIO", "flannel")
_K3D_CREATE_FLAGS_NO_CNI := '--no-lb --k3s-arg --debug@server:* --k3s-arg --flannel-backend=none@server:*'
_K3D_CREATE_FLAGS_NO_CNI_NO_POLICY_ENFORCER := '--no-lb --k3s-arg --debug@server:* --k3s-arg --flannel-backend=none@server:* --k3s-arg --disable-network-policy'

# Creates a k3d cluster that can be used for testing.
k3d-create:
    @just-k3d create

# Deletes the test cluster.
k3d-delete:
    @just-k3d delete

# Print information the test cluster's detailed status.
k3d-info:
    @just-k3d info

_k3d-ready:
    @just-k3d ready

_k3d-cni-create:
    @just-k3d _create
##
## CI utilities
##

# Lints all GitHub Actions workflows
action-lint:
    @just-dev lint-actions

action-dev-check:
    @just-dev check-action-images

md-lint:
    @just-md lint

# Lints all shell scripts in the repo.
sh-lint:
    @just-sh lint