Development Setup¶

Set up your local environment for developing external-dns-unifios-webhook.

Prerequisites¶

Go 1.25 or later
Git
Access to a UniFi controller (for integration testing)
Podman or Docker (for container builds)

Clone Repository¶

git clone https://github.com/lexfrei/external-dns-unifios-webhook.git
cd external-dns-unifios-webhook

Install Dependencies¶

go mod download

Build¶

Binary¶

go build -o webhook ./cmd/webhook

With Version Info¶

go build -ldflags "-s -w -X main.Version=dev -X main.Gitsha=$(git rev-parse HEAD)" \
  -trimpath -o webhook ./cmd/webhook

Run Locally¶

Set required environment variables:

export WEBHOOK_UNIFI_HOST="https://192.168.1.1"
export WEBHOOK_UNIFI_API_KEY="your-api-key"
export WEBHOOK_LOGGING_LEVEL="debug"

Run the webhook:

./webhook

The webhook will listen on:

localhost:8888 - Webhook API
0.0.0.0:8080 - Health/metrics endpoints

Testing¶

Run All Tests¶

go test ./...

With Race Detection¶

go test -race ./...

With Coverage¶

go test -race -coverprofile=coverage.out -covermode=atomic ./...
go tool cover -html=coverage.out

Specific Package¶

go test ./internal/provider/...

Linting¶

Install golangci-lint¶

go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest

Run Linter¶

golangci-lint run

Auto-fix¶

golangci-lint run --fix

Container Build¶

Build Image¶

podman build --tag external-dns-unifios-webhook:local --file Containerfile .

Run Container¶

podman run --rm \
  --env WEBHOOK_UNIFI_HOST="https://192.168.1.1" \
  --env WEBHOOK_UNIFI_API_KEY="your-api-key" \
  --publish 8888:8888 \
  --publish 8080:8080 \
  external-dns-unifios-webhook:local

IDE Setup¶

VS Code¶

Recommended extensions:

Go (golang.go)
EditorConfig for VS Code
YAML

Settings (.vscode/settings.json):

{
  "go.lintTool": "golangci-lint",
  "go.lintFlags": ["--fast"],
  "go.testFlags": ["-race"],
  "editor.formatOnSave": true
}

GoLand¶

Enable Go modules integration
Set Go to use golangci-lint as external linter
Enable "Format on save"

Environment Variables for Development¶

Variable	Description	Example
`WEBHOOK_UNIFI_HOST`	UniFi controller URL	`https://192.168.1.1`
`WEBHOOK_UNIFI_API_KEY`	API key	`abc123...`
`WEBHOOK_LOGGING_LEVEL`	Log level	`debug`
`WEBHOOK_LOGGING_FORMAT`	Log format	`text`

Debugging¶

Enable pprof¶

export WEBHOOK_DEBUG_PPROF_ENABLED=true
./webhook

Access pprof at http://localhost:6060/debug/pprof/

Debug Logging¶

export WEBHOOK_LOGGING_LEVEL=debug
export WEBHOOK_LOGGING_FORMAT=text
./webhook