mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-03-22 04:42:03 +00:00
0c2648dae2
Currently, the type hierarchy within `tunnel_test` is already quite nested: We have a `Host` that wraps a `SimNode` which wraps a `ClientState` or `GatewayState`. Additionally, a lot of state that is actually _per_ client or _per_ gateway is tracked in the root of `ReferenceState` and `TunnelTest`. That makes it difficult to introduce multiple gateways / clients to this test. To fix this, we introduce dedicated `RefClient` and `RefGateway` states. Those track the expected state of a particular client / gateway. Similarly, we introduce dedicated `SimClient` and `SimGateway` structs that track the simulation state by wrapping the corresponding system-under-test: `ClientState` a `GatewayState`. This ends up moving a lot of code around but has the great benefit that all the state is now scoped to a particular instance of a client or a gateway, paving the way for creating multiple clients & gateways in a single test.
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null