Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 3.73 KB

development-guide.md

File metadata and controls

116 lines (84 loc) · 3.73 KB

Tools

  • Install Rust using rustup
  • Copy the pre-commit hook in the hooks folder to .git/hooks/pre-commit
  • Install docker, making sure your user has access to use it.
cp hooks/* .git/hooks/
  • For test coverage: cargo install cargo-tarpaulin
  • For smart release: cargo install cargo-smart-release
  • For workspaces: cargo install cargo-workspaces

Practices

  • We use rustfmt (triggered from cargo fmt) to format our source code
  • We try to keep to conventional-commits - This simplifies creating and keeping a changelog up to date as well as helping to decide which version to bump when releasing a new version
  • We will adhere to Semantic versioning
  • We use Clippy to ensure that our code follows a consistent format, you can run Clippy using cargo clippy --fix once it's installed
  • We try to stick to one feature per crate. The workspace is configured to automatically pick up any new crates under crates/*
    • If this causes circular dependencies, have a chat with @chriswk or @sighphyre before implementing your new feature.

Development Toolchain Installation

For a quicker build/test loop, we provide a just setup which takes around a tenth of the time of cargo build. You'll need to install a few tools for this to work correctly.

Just

Just can be installed with cargo:

cargo install just

Clang + LLD

Linux (Debian/Ubuntu-based):

sudo apt install clang lld

MacOS

xcode-select --install

Windows Install the "Desktop Development with C++" workload via the Visual Studio Installer. This typically includes clang and lld.

Cranelift

Ensure you're using a nightly Rust toolchain

rustup default nightly

Install cranelift with rustup:

rustup component add rustc-codegen-cranelift-preview --toolchain nightly

Using The Development Build

The just file provides fast build and test commands using the Cranelift backend and LLD linker. These steps skip integration tests and are typically ~10x faster than a full cargo build.

just build
just test

If you're unable to use LLD (due to system configuration, linker errors, or platform limitations), use the system linker instead:

just sysbuild
just systest

Common commands

  • cargo add ... - Add a dependency to the Cargo.toml file
  • cargo remove ... - Remove a dependency from the Cargo.toml file
  • cargo check - Checks a local package and all of its dependencies for errors
  • cargo clippy - Run Clippy to get code warnings
  • cargo fmt - Format the code using rustfmt
  • cargo test - Run the tests
  • cargo build - Build a debug build. The executable will be available in ./target/debug/unleash-edge once successful
  • cargo build --release - Build a release build. The executable will be available in ./target/release/unleash-edge once successful. - If you want to run loadtesting, you should really build in release mode. 10-20x faster than the debug build
  • cargo run -- edge --markdown-help -u http://localhost:4242 > CLI.md - Update the CLI.md file.
  • cargo run -- edge -h - Start here to run edge mode locally.
  • cargo run -- offline -h - Start here to run offline mode locally.

Testing

By default cargo test will run all the tests. If you want to exclude the expensive integration tests you can instead run cargo test --bin unleash-edge.

Docker requirement

In order for all tests to successfully build, you'll need Docker installed. We use testcontainers to spin up a redis container to test our redis feature. Testcontainers require docker to run