Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
184 lines (121 loc) · 4.23 KB

DEVELOPMENT.md

File metadata and controls

184 lines (121 loc) · 4.23 KB
Raw

Development

This guide covers how to build, test, and contribute to this project.

Prerequisites

Project Structure

The project consists of two main components:

  • Containerd shim (cmd/containerd-shim-remoteproc-v1/) - Integration with containerd-based runtimes
  • Container runtime (cmd/remoteproc-runtime/) - Standalone OCI runtime

Building

Build all components

go build ./cmd/containerd-shim-remoteproc-v1
go build ./cmd/remoteproc-runtime

⚠️ This runtime specifically targets Linux; building on other platforms requires setting GOOS=linux. If cross-compiling, specify the target architecture with GOARCH=arm64.

Linting

The project uses golangci-lint for Go code quality checks.

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

# Run linter
golangci-lint run

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

Testing

Fast tests

go test -v -race ./internal/...

Slow tests

Slow tests require LimaVM to be installed. They create temporary VMs to test the shim with Docker.

# Install Lima first
brew install lima  # macOS
# or follow instructions at https://lima-vm.io/docs/installation/

# Run tests
go test -v ./e2e/...

Manual testing with Remoteproc Simulator

Useful for development without access to hardware with Remoteproc support.

ℹ️ Remoteproc Simulator's arguments aren't arbitrary:

  • Custom root directory, set via --root-dir needs to match custom root set via -ldflags
  • Remoteproc name set via --name needs to match the remoteproc.name annotation

Testing with Docker

⚠️ Docker network must be set to 'Host' (--network=host), as the proxy runs in the host's network namespace.

  1. Build and install the shim and runtime with custom root

    go build ./cmd/containerd-shim-remoteproc-v1
    go build -ldflags "-X github.com/arm/remoteproc-runtime/internal/rootpath.prefix=/tmp/test-root" \
    ./cmd/remoteproc-runtime

    See "Install the shim and runtime" in Usage Guide.

  2. Build the test image

    The repository includes a Dockerfile in testdata/ for testing.

    docker build ./testdata -t test-remoteproc-image

  3. Setup Remoteproc Simulator

    # Create test root directory
mkdir -p /tmp/test-root

# Run simulator
remoteproc-simulator --root-dir /tmp/test-root --name test-processor

  4. Run the container

    docker run \
    --runtime io.containerd.remoteproc.v1 \
    --annotation remoteproc.name="test-processor" \
    --network=host \
    test-remoteproc-image

Testing with standalone runtime

  1. Build the runtime with custom root

    go build -ldflags "-X github.com/arm/remoteproc-runtime/internal/rootpath.prefix=/tmp/test-root" \
    ./cmd/remoteproc-runtime

  2. Setup Remoteproc Simulator

    # Create test root directory
mkdir -p /tmp/test-root

# Run simulator
remoteproc-simulator --root-dir /tmp/test-root --name fancy-mcu

  3. Use the test bundle The repository includes a test OCI bundle in e2e/testdata/bundle/.

    # Create container
./remoteproc-runtime create --bundle testdata/bundle my-container

# Start container
./remoteproc-runtime start my-container

# Check state
./remoteproc-runtime state my-container

# Cleanup
./remoteproc-runtime kill my-container
./remoteproc-runtime delete my-container

CI/CD

Continuous Integration

The CI pipeline runs on every push and pull request to main.

Pull Request Checks

PRs must have semantic commit titles (enforced by GitHub Actions).

Releases

Releases are automated using GoReleaser when a new tag is pushed:

# Create and push a new version tag
git tag v0.1.0
git push origin v0.1.0

The release workflow will:

  1. Run the full CI test suite

  2. Build binaries for multiple platforms

  3. Create a GitHub release with artifacts