Building

Prerequisites

• Go 1.26.3 or later
• Docker (for Docker image builds)
• golangci-lint (for linting)

Building

Binary

# Clone the repository
git clone https://github.com/jmrplens/cs-routeros-bouncer.git
cd cs-routeros-bouncer

# Build
CGO_ENABLED=0 go build -o cs-routeros-bouncer ./cmd/cs-routeros-bouncer

With version information:

CGO_ENABLED=0 go build -ldflags "-X github.com/jmrplens/cs-routeros-bouncer/internal/config.Version=1.4.4 -X github.com/jmrplens/cs-routeros-bouncer/internal/config.Commit=$(git rev-parse --short HEAD) -X github.com/jmrplens/cs-routeros-bouncer/internal/config.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ) -X github.com/crowdsecurity/go-cs-lib/version.Version=1.4.4" \
  -o cs-routeros-bouncer ./cmd/cs-routeros-bouncer

Docker

docker build -t cs-routeros-bouncer:local .

Cross-compile

Build for different architectures:

# ARM64 (e.g., Raspberry Pi 4, Apple Silicon)
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o cs-routeros-bouncer-arm64 ./cmd/cs-routeros-bouncer

# ARMv7 (e.g., Raspberry Pi 3)
CGO_ENABLED=0 GOOS=linux GOARCH=arm GOARM=7 go build -o cs-routeros-bouncer-armv7 ./cmd/cs-routeros-bouncer

# AMD64
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o cs-routeros-bouncer-amd64 ./cmd/cs-routeros-bouncer

Testing

Unit tests

# Run all tests
go test ./...

# With verbose output
go test -v ./...

# With coverage
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

Run a specific package:

go test -v ./internal/config/...
go test -v ./internal/routeros/...
go test -v ./internal/metrics/...

Coverage

# Generate coverage report
go test -coverprofile=coverage.out -covermode=atomic ./...

# View coverage in browser
go tool cover -html=coverage.out -o coverage.html

# Check coverage percentage
go tool cover -func=coverage.out | tail -1

Integration & functional tests

Integration tests are guarded by the integration build tag. The Bash functional suite runs black-box checks against a real installed bouncer.

# Go integration tests
go test -v -tags integration -count=1 -timeout 300s ./tests/integration/...

# Black-box functional suite
cp tests/functional/.env.example tests/functional/.env
tests/functional/run_tests.sh

Caution

Integration and functional tests create and delete firewall rules and address-list entries on the target router. Use a test router or ensure you understand the impact.

Testing Guide Unit, integration, and functional test suites in detail.

Benchmarking RouterOS API benchmark command and safety notes.

Linting

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

# Run linter
golangci-lint run

# Run with auto-fix
golangci-lint run --fix

# Go vet
go vet ./...

The project uses .golangci.yml for linter configuration.

CI/CD

| Workflow | Trigger | Purpose | | ------------- | ------------------------ | ---------------------------------------------------- | | ci.yml | Push, PR | Run linting, tests, docs analysis, and build checks | | docs.yml | Docs changes, manual run | Build and deploy the Astro documentation site | | release.yml | Tag push | Build binaries, Docker images, create GitHub release |

Release process

1. Update version in code

2. Create and push a git tag

   git tag v1.4.4
   git push origin v1.4.4

3. GitHub Actions automatically:

   • Builds binaries for linux/amd64, linux/arm64, linux/arm/v7
   • Builds and pushes Docker images (multi-arch)
   • Creates a GitHub release with binaries attached

Development workflow

1. Create a feature branch

   git checkout -b feat/my-feature

2. Make changes and test

   go test ./...
   golangci-lint run

3. Commit with a conventional message

   git commit -m "feat: add new feature"

4. Push and create PR