Skip to content

development.md

Latest commit

 

History

History
124 lines (90 loc) · 3.92 KB

development.md

File metadata and controls

124 lines (90 loc) · 3.92 KB

Development Guide

Setup

git clone https://github.com/openshift-hyperfleet/hyperfleet-adapter.git
cd hyperfleet-adapter
make mod-tidy
make build        # → bin/hyperfleet-adapter

Verification

make fmt              # Format code + imports (golangci-lint fmt with gci)
make lint             # golangci-lint (config: .golangci.yml)
make test             # Unit tests with race detection
make test-integration # Integration tests via testcontainers (needs Docker/Podman)
make test-all         # All of the above + make test-helm

Make Targets

Target Description
make build Build binary
make test Run unit tests
make test-integration Run integration tests with envtest (unprivileged)
make test-integration-k3s Run integration tests with K3s (faster, may need privileges)
make test-all Run all tests (unit + integration + helm)
make test-coverage Generate test coverage report
make lint Run golangci-lint
make fmt Format code
make image Build container image
make image-push Build and push container image
make image-dev Build and push to personal Quay registry
make mod-tidy Tidy Go module dependencies
make clean Clean build artifacts

Use make help to see all available targets.

Integration Tests

Setup and run integration tests

Integration tests use Testcontainers with envtest — works in any CI/CD platform without privileged containers.

Prerequisites

  • Docker or Podman must be running (both supported)
  • The Makefile automatically detects and configures your container runtime
  • Podman users: Corporate proxy settings are auto-detected from Podman machine. Define and export the environment variable :
DOCKER_HOST=unix://$XDG_RUNTIME_DIR/podman/podman.sock

Run

make test-integration       # envtest (default, unprivileged)
make test-integration-k3s   # K3s (faster, may need privileges)

The first run downloads golang:alpine and installs envtest (~20-30 seconds). Subsequent runs are cached.

Tool Dependencies (Bingo)

Build tools are pinned via bingo in .bingo/ manifests:

bingo get           # Install all tools
bingo list          # List managed tools

Container Image

# Build container image
make image

# Build with custom tag
make image IMAGE_TAG=v1.0.0

# Build and push to default registry
make image-push

# Build and push to personal Quay registry (for development)
QUAY_USER=myuser make image-dev

Default image: quay.io/openshift-hyperfleet/hyperfleet-adapter:latest

The container build embeds version metadata (version, git commit, build date) into the binary.

Dry-Run Mode

Dry-run mode simulates the full execution pipeline locally without connecting to any real infrastructure. It processes a single CloudEvent from a JSON file and produces a detailed trace.

hyperfleet-adapter serve \
  --config ./adapter-config.yaml \
  --task-config ./task-config.yaml \
  --dry-run-event ./event.json
Dry-run flags
Flag Required Description
--dry-run-event <path> Yes Path to a CloudEvent JSON file to process
--dry-run-api-responses <path> No Path to mock API responses JSON file (defaults to 200 OK for all requests)
--dry-run-discovery <path> No Path to mock discovery overrides JSON file (simulates server-populated fields)
--dry-run-verbose No Show rendered manifests and API request/response bodies in output
--dry-run-output <format> No Output format: text (default) or json

For mock file formats and a step-by-step development workflow, see Adapter Authoring Guide — Dry-Run Mode. Example input files are in test/testdata/dryrun/.