https://github.com/selfhoster1312/yunohost-rs
YOLO rewrite not serious
https://github.com/selfhoster1312/yunohost-rs
ldap riir rust yunohost
Last synced: 5 months ago
JSON representation
YOLO rewrite not serious
- Host: GitHub
- URL: https://github.com/selfhoster1312/yunohost-rs
- Owner: selfhoster1312
- Created: 2024-05-18T20:55:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T18:02:28.000Z (over 1 year ago)
- Last Synced: 2024-05-22T19:01:37.477Z (over 1 year ago)
- Topics: ldap, riir, rust, yunohost
- Language: Rust
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# yunohost-rs
**WARNING:** DO NOT USE FOR ANYTHING SERIOUS!
This is a reimplementation of [Yunohost](https://yunohost.org/) structures and algorithms in Rust. This way you can Rewrite It In Rust and make it perfectly fast and correct and never have any bug again (<-- sarcasm included).
## Documentation
The documentation can be found online at **[selfhoster1312.github.io/yunohost-rs/doc/](https://selfhoster1312.github.io/yunohost-rs/doc/)**.
## Why
It's not the first time i rewrite parts of Yunohost in Rust to make it faster. Another crime against my own sanity i committed was the [ssowat-rs experiment](https://kl.netlib.re/gitea/selfhoster1312/ssowat-rs) which gave me greater understanding to [make the actual new branch of ssowat faster](https://github.com/YunoHost/SSOwat/pull/220). All in all, there's two reasons to rewrite parts of Yunohost in Rust:
- better understand the algorithms and how they can be optimized upstream
- showcase a faster implementation to serve as a benchmark
I also believe the Yunohost project would benefit from writing many things in Rust, in general, but that's not the goal here.
## Architecture
You will find:
- `hooks`: for now only regen-conf hooks in there
- `src/cmd/`: the yunohost CLI subcommands
- `src/helpers/`: high-level utilities to make your life easier
- `src/lib.rs`: the top of the library
- `src/main.rs`: the entry-point of the yunohost binary
- `tests/compat/*.sh`: each file contains tests for a specific yunohost command
- `test.sh`: the main script triggering the test suite
## Try me out
To build the yunohost binary, you can do `cargo build --release`. The binaries are found in `target/x86_64-unknown-linux-musl`. They are targeting the [musl](https://en.wikipedia.org/wiki/Musl) so that they work magically across [glibc](https://en.wikipedia.org/wiki/Glibc) versions, for example when compiling from Archlinux or Debian Bookworm.
**Warning:** Don't forget the `--release` flag. Using rust binaries in debug mode can lead to very slow code and crashes.
To compile the regen-conf hooks, use the `hooks` feature flag, like this: `cargo build --release --features hooks`.
## Test me
To run the unit tests (there aren't a lot yet), run `cargo test --release`. The `--release` so that you don't have to recompile everything when trying the binaries for real.
To run the integration test, give access for your machine's SSH key to a remote Yunohost server, then run `./test.sh SERVERNAME`. It will produce an output like this:
```
Server kl.netlib.re is ready for tests
__runner.sh hook.sh settings.sh tools.sh user.sh
DIFF PYTHON RUST COMMAND
OK OK (0.17s) OK (0.00s) yunohost hook list --json conf_regen
OK OK (0.18s) OK (0.00s) yunohost settings get --json security
OK OK (0.17s) OK (0.00s) yunohost settings get --full --json security
OK OK (0.17s) OK (0.00s) yunohost settings get --export --json security
OK OK (0.20s) OK (0.00s) yunohost settings get --json security.webadmin
OK OK (0.19s) OK (0.00s) yunohost settings get --full --json security.webadmin
OK OK (0.18s) OK (0.00s) yunohost settings get --export --json security.webadmin
OK OK (0.17s) OK (0.00s) yunohost settings get --json security.webadmin.webadmin_allowlist_enabled
OK OK (0.20s) OK (0.00s) yunohost settings get --full --json security.webadmin.webadmin_allowlist_enabled
OK OK (0.17s) OK (0.00s) yunohost settings get --export --json security.webadmin.webadmin_allowlist_enabled
OK OK (0.17s) OK (0.00s) yunohost settings list --json
OK OK (0.17s) OK (0.00s) yunohost settings list --full --json
OK OK (0.24s) OK (0.00s) yunohost tools regen-conf --list-pending --json
DIFF - /tmp/tmp.W0n6TCjHtL OK (0.27s) OK (0.00s) yunohost tools regen-conf --list-pending --with-diff --json
OK OK (0.18s) OK (0.00s) yunohost user list --json
OK OK (0.51s) OK (0.00s) yunohost user info --json test2
```
Run the `./update_readme.sh SERVERNAME` script to update the test output automatically.
Some notes about integration tests:
- for now we only test read-only operations
- it requires that an account named `test2` exists on the Yunohost server
- it compares success/timing between python and rust version ; an error in execution will show the path to the logged command output
- it compares JSON output between python and rust version ; if the outputs don't match after normalization (via jq) then it shows a path to the logged (normalized) diff
Just one note about Rust execution speed: **YES IT IS THAT FAST**. Sometimes when the server is busy it will climb to 0.03s for one command, otherwise `time -f %e` is not capable to time it properly. I'm fine with that, this is not a scientific benchmark it's just to make sure it's not horribly slow because of a mistake.
Some other benchmarks from an actual Raspberry Pi:
```
Server raspberrypi.lan is ready for tests
__runner.sh hook.sh settings.sh tools.sh user.sh
DIFF PYTHON RUST COMMAND
OK OK (5.48s) OK (0.02s) yunohost hook list --json conf_regen
OK OK (7.71s) OK (0.04s) yunohost settings get --json security
OK OK (7.84s) OK (0.05s) yunohost settings get --full --json security
OK OK (7.61s) OK (0.03s) yunohost settings get --export --json security
OK OK (7.98s) OK (0.04s) yunohost settings get --json security.webadmin
OK OK (7.77s) OK (0.05s) yunohost settings get --full --json security.webadmin
OK OK (7.89s) OK (0.03s) yunohost settings get --export --json security.webadmin
OK OK (7.83s) OK (0.03s) yunohost settings get --json security.webadmin.webadmin_allowlist_enabled
OK OK (7.77s) OK (0.04s) yunohost settings get --full --json security.webadmin.webadmin_allowlist_enabled
OK OK (7.70s) OK (0.03s) yunohost settings get --export --json security.webadmin.webadmin_allowlist_enabled
OK OK (7.66s) OK (0.05s) yunohost settings list --json
OK OK (7.77s) OK (0.06s) yunohost settings list --full --json
OK OK (10.82s) OK (0.02s) yunohost tools regen-conf --list-pending --json
DIFF - /tmp/tmp.NHzApAa0N8 OK (10.63s) OK (0.02s) yunohost tools regen-conf --list-pending --with-diff --json
OK OK (8.13s) OK (0.03s) yunohost user list --json
OK OK (11.10s) OK (0.04s) yunohost user info --json test2
```
To run the tests on your own Raspberry pi:
- from bullseye or a distro with an equivalent glibc version
- run the following script:
```
apt install curl gcc-arm-linux-gnueabi gcc git
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env
rustup target add arm-unknown-linux-gnueabi
```
- cross-compile and test directly from this cloned repository with `./test.sh root@SERVER raspberrypi`, where you have public key access to the raspberry pi as root
## Test something about the Python version
It's complicated because it's all very interconnected. However, if you'd like to get a small subsystem, you can do something like this:
```
#! /usr/bin/env python3
from moulinette import m18n
from yunohost.settings import SettingsConfigPanel
m18n.set_locales_dir("/usr/share/yunohost/locales")
m18n.set_locale("en")
settings = SettingsConfigPanel()
print(settings.get("", "classic"))
```
**Note:** If you don't initialize the localization, nothing will work! So this snippet may prove useful.
## TODO
- [x] proper error management
- [ ] paste.yunohost.org integration on error
- [x] rewrite one regen-conf in Rust ([done](src/hooks/01-yunohost.rs))
- [x] rewrite `yunohost user list` in Rust (TODO: `--fields` argument)
- [ ] rewrite the regen-conf engine in Rust
- [ ] rewrite all regen-conf engine/hooks in Rust
- [x] rewrite `yunohost settings get` in Rust (full/export/classic modes)
- [x] output comparison in integration tests
- [x] timing information in integration tests
- [x] Github Pages crate documentation
- [x] Utf8Path (camino) integration for easier Path<->str interop
- [ ] publish Debian repo on Github pages so people can test it without compiling
- [x] rewrite moulinette.i18n for translations, see [helpers/i18n](helpers/i18n/mod.rs)
- [ ] rewrite moulinette actionsmap parser and integrate with real Yunohost