Developing Uncloud

A short guide on setting up your local development environment.

Prerequisites

mise (development environment setup tool)
Docker (for running end-to-end tests)

Setup

Uncloud uses mise to install and manage development tools and dependencies. It makes it easy to create reproducible development environments on developer machines and CI.

Follow the Installing Mise guide to get it set up on your machine.

Mark the project as trusted and install all required tools (Go, protoc, golangci-lint, etc.) by running from the project root:

mise trust
mise install

This reads mise.toml and installs the exact versions of tools specified there. They will be available in your PATH when you are in the project directory, so you can run go or golangci-lint directly. The tools won't be available outside the project, so they don't interfere with system packages.

Building

Build the CLI:

go build -o uc ./cmd/uncloud

Or build and run the CLI with a single command:

go run ./cmd/uncloud --help

The Uncloud daemon (uncloudd) only supports Linux, so you need to cross-compile it if you're developing on macOS or Windows:

GOOS=linux GOARCH=amd64 go build -o uncloudd ./cmd/uncloudd

Testing

Run all tests (unit and e2e):

make test

End-to-end tests

E2e tests run inside Docker using the ucind (Uncloud-in-Docker) image. Build it first:

make ucind-image

⚠️ NOTE: You need to rebuild the ucind image every time you make changes to the daemon code if you want to test them in e2e tests.

Then run the tests:

make test-e2e

If tests leave leftover containers, clean them up with:

make test-clean

Linting and formatting

Lint and format the code:

make lint-and-fix

Code generation

Update the generated Go code for the machine gRPC API after modifying .proto files:

mise run proto

Regenerate mocks:

make mocks

2.1 KiB Raw Blame History