Initial import: ICE-NET research docs and Rust workspace (v0.4)
Some checks failed
rust-ci / checks (push) Has been cancelled
Some checks failed
rust-ci / checks (push) Has been cancelled
- Rust workspace: 7 library crates, icenetd CLI, icenet-city (Slint GUI) - Sim: fix false Delivered after a route cut, derive traffic class from payload size, per-link airtime slots (link capacity, queueing) - Docs: single docs/STATUS.md for all figures, remove v0.2/egui leftovers, drop unimplemented seed claims, uncheck store-and-forward - License: LGPL-3.0-or-later (LICENSE, LICENSES/GPL-3.0.txt)
This commit is contained in:
commit
2e61688eb3
141 changed files with 13993 additions and 0 deletions
22
docs/guides/commands.md
Normal file
22
docs/guides/commands.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# Шпаргалка команд
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
python3 tools/check_layout.py # file <=250 lines, dir <=4 files
|
||||
cargo metadata --no-deps
|
||||
cargo fmt --all -- --check
|
||||
cargo clippy --workspace --all-targets -- -D warnings
|
||||
cargo test --workspace
|
||||
cargo run -p icenet-city
|
||||
cargo run -p icenetd -- help
|
||||
cargo run -p icenetd -- route --from 1 --to 3 --class bulk --size 5000000
|
||||
cargo run -p icenetd -- send --from 1 --to 3 --class text --ticks 1000
|
||||
cargo run -p icenetd -- sim --csv metrics.csv --json scenario.json
|
||||
cargo run -p icenetd -- policy --service 77777 --size 5 --allow 1
|
||||
cargo run -p icenetd -- wire-encode --service 7 --class text --text hello
|
||||
cargo run -p icenetd -- serve --bind 127.0.0.1:9000 --count 1 --timeout 5000
|
||||
cargo run -p icenetd -- send-udp --to 127.0.0.1:9000 --service 7 --class text --text hello
|
||||
```
|
||||
|
||||
Пакеты в `crates/*` — библиотеки, `apps/*` — исполняемые приложения.
|
||||
Cargo workspace использует общий `Cargo.lock` (коммитится) и закреплённый toolchain.
|
||||
18
docs/guides/contributing.md
Normal file
18
docs/guides/contributing.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# Contributing conventions
|
||||
|
||||
- Feature branch: `feat/<short-name>`; fix: `fix/<short-name>`.
|
||||
- PR начинается с проблемы и одного конкретного сценария, а не общих обещаний.
|
||||
- Прежде чем добавлять crate, проверь зависимость и альтернативу module.
|
||||
- Контракты в `docs/architecture/contracts.md`; тесты снаружи `src`.
|
||||
- Публичные Rust элементы используют `///` doc comments на **английском**.
|
||||
- Область изменения: краткая, отлаживаемая, 250 строк на файл максимум.
|
||||
- До реального радио — legal review и тесты аппаратуры.
|
||||
|
||||
## Suggested PR template
|
||||
|
||||
- **What / Why:** одна конкретная проблема.
|
||||
- **How:** какие crates и интерфейсы изменены.
|
||||
- **Tests:** команды и результаты.
|
||||
- **Metrics:** новые расходы CPU/RAM/airtime (если затронуты).
|
||||
- **Security:** новые доверенные данные/границы.
|
||||
- **Alternatives:** почему проще нельзя.
|
||||
57
docs/guides/quickstart.md
Normal file
57
docs/guides/quickstart.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
# Arch Linux: быстрый запуск разработчика
|
||||
|
||||
## Установить инструменты
|
||||
|
||||
```bash
|
||||
sudo pacman -S --needed rustup python git pkgconf clang
|
||||
rustup default stable
|
||||
rustup component add rustfmt clippy
|
||||
```
|
||||
|
||||
Для GUI могут потребоваться системные библиотеки графического backend (X11/Wayland,
|
||||
mesa, fontconfig и т.п.); точные пакеты зависят от Arch, X11/Wayland и версии Slint.
|
||||
|
||||
## Запуск
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
python3 tools/check_layout.py
|
||||
cargo test -p icenet-routing -p icenet-sim
|
||||
cargo run -p icenet-city
|
||||
```
|
||||
|
||||
В окне: выбрать From/To, отправить `Text`/`Photo`, менять состояние линков,
|
||||
шагать по времени. Это моделирование, не сетевое соединение.
|
||||
|
||||
## Отдельная библиотека
|
||||
|
||||
```bash
|
||||
cargo test -p icenet-routing --test routing
|
||||
cargo test -p icenet-sim --test city
|
||||
cargo doc --workspace --no-deps
|
||||
```
|
||||
|
||||
`icenetd` — headless CLI для проверки ядра без GUI и без сети:
|
||||
|
||||
```bash
|
||||
cargo run -p icenetd -- route --from 1 --to 3 --class bulk --size 5000000
|
||||
cargo run -p icenetd -- send --from 1 --to 3 --class text --ticks 1000
|
||||
cargo run -p icenetd -- sim --csv /tmp/metrics.csv --json /tmp/scenario.json
|
||||
```
|
||||
|
||||
Реальная UDP-передача между двумя процессами (локальный loopback, без crypto):
|
||||
|
||||
```bash
|
||||
# терминал 1
|
||||
cargo run -p icenetd -- serve --bind 127.0.0.1:9000 --count 1 --timeout 5000
|
||||
# терминал 2
|
||||
cargo run -p icenetd -- send-udp --to 127.0.0.1:9000 --service 7 --class text --text hello
|
||||
```
|
||||
|
||||
Это незащищённый черновой кадр: без криптографии, аутентификации и защиты от replay на уровне сети.
|
||||
|
||||
## Примечание по версиям
|
||||
|
||||
`Slint 1.18.1` требует Rust >=1.92; toolchain закреплён в `rust-toolchain.toml` (версия — в [STATUS](../STATUS.md)).
|
||||
Для ускоренной сборки не запускай `--workspace`, если сейчас тестируешь только
|
||||
алгоритмы. Для релиза нужны полноценные CI-проверки всех crates и GUI.
|
||||
42
docs/guides/testing.md
Normal file
42
docs/guides/testing.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Tests / CI
|
||||
|
||||
В Rust тесты лежат **только** в отдельной папке каждого крейта:
|
||||
`crates/<name>/tests/*.rs` и `apps/<name>/tests/*.rs`. Inline `#[cfg(test)]` в `src` запрещён.
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
python3 tools/check_layout.py
|
||||
cargo fmt --all -- --check
|
||||
cargo clippy --workspace --all-targets -- -D warnings
|
||||
cargo test --workspace
|
||||
cargo doc --workspace --no-deps
|
||||
```
|
||||
|
||||
## Пирамида
|
||||
|
||||
1. `core`: классы и логические ID.
|
||||
2. `wire`: roundtrip + отказ на malformed frame / oversize.
|
||||
3. `routing`: slow-only route for Text / forbidden for Bulk / oversized Text treated as Bulk / link-down.
|
||||
4. `guard`: deny unknown service, cap payload, no fake authentication.
|
||||
5. `sim`: node failure, in-flight state, queued retry, no false `Delivered` after a cut, link capacity (`tests/capacity/`).
|
||||
6. `city`: GUI smoke test вручную (позднее snapshot/interaction integration tests).
|
||||
|
||||
## Приёмка
|
||||
|
||||
- Все новые тесты воспроизводимы без сети/радио.
|
||||
- Каждый алгоритм не нуждается в реальном `sleep`; используется sim clock.
|
||||
- При дефекте добавить regression test отдельно от production module.
|
||||
- Маркеры `TODO`/`unimplemented!()` не прятать в ветки реальных пакетов.
|
||||
|
||||
Что проверено и сколько тестов проходит — в [STATUS](../STATUS.md).
|
||||
|
||||
## Быстрые и полные проверки
|
||||
|
||||
```bash
|
||||
cd workspace
|
||||
sh tools/check_all.sh # core routing/simulator, без Slint-сборки
|
||||
sh tools/check_all.sh --full # также Slint GUI и все integration tests
|
||||
```
|
||||
|
||||
`cargo fmt --all` форматирует в том числе GUI crate; `.slint` не проверяется
|
||||
`rustfmt` и проверяется компилятором Slint в `build.rs`.
|
||||
Loading…
Add table
Add a link
Reference in a new issue