developments.md

Piccolo

• Development
  • Environment Setup
  • Code Style
  • Linting
  • Structure
  • Build
  • Static Code Analysis
  • Unit Tests
  • Integration Tests
  • Running
    • Using Ports
• Documentation

Development

Environment Setup

For detail, refer to installation.

Code Style

rustfmt is used.

# in src directory
cargo fmt

Linting

Clippy is used.

# in src directory
cargo clippy

Structure (Deprecated)

For detail, refer to Structure.

Build

The first priority is to use Containers, but direct build is also possible. (However, build errors may occur depending on the system.)
The project is using cargo as its build system and command is wrapped in Makefile.

The binaries and other artifacts (such as the man pages) can be built via:

make build
# same as
cd src/ && cargo build

After successfully compiling the binaries, they will be in ./src/target.

You can use these directly, but it is recommended to use containers.

make image
make install

For more details, refer to the Getting started

Static Code Analysis

TBD

Unit tests

Unit tests can be executed using following commands:

# in src directory
cargo test

Integration tests

TBD

Running

The following sections describe how to run the built application(s) locally on one machine.
Refer to Getting Started.

Using Ports

gRPC
apiserver : 47001
gateway : 47002
statemanager: 47003

REST
apiserver : 47099

etcd : 2379, 2380

Documentation

Files for documentation of this project are located in the doc directory comprising:

• Examples: directory containing all files and guides for performing example
• piccolo.drawio file containing all diagrams used for Piccolo