device-checkout-rs

Reimplementation/Distant ancestor of https://github.com/tismith/deviceCheckout. Written in rust. The HTTP API endpoints could use some more breadth, but the form based web ui is functional.

We use diesel-migrations to automatically build and migrate the database. No need to seed the database manually.

We are using:

• rocket for the web framework.
• diesel as the database abstraction and orm.
• serde for json serialization/deserialization.
• log and stderrlog for configurable logging macros.
• clap for commandline argument processing.
• failure for error handling.
• assert_cli for integration testing.
• reqwest to get information from slack.

Installation:

Using cargo:

Install rustup and cargo: https://www.rust-lang.org/tools/install

cargo build
cargo run

Access help via command line args: cargo run -- -h

Using snap:

We're using snapcraft to automatically build snaps of device-checkout.

sudo snap install device-checkout

Using docker:

#Runs device-checkout on port 1234 with the database at /var/lib/devices.db
docker run -p 1234:8000 -v /var/lib:/var/lib/device-checkout tismith/device-checkout-rs

Development:

These need to be run whenever the toolchain is modified or the latest nightly is needed.

• Update rust toolchain: rustup update
• Update dependencies: cargo update

Build dependencies, run the app and tests.

• Build dependencies: cargo build
• Run application cargo run
• Run all tests: cargo test

Database Migration:

If you are adding database tables, a migration needs to be added. These are created and generated with the Rust ORM Diesel.

• Install sqlite-dev on your system sudo dnf install sqlite-devel
• Install diesel CLI: cargo install diesel_cli --no-default-features --features sqlite
• Setup diesel with database in repo (stored in .env): diesel setup
• Create migration files for new tables: diesel migration generate <new_feature>
• Modify the migration files and schema
• Test the migration applies with diesel migration run and that it can be rolled back with diesel migration redo

Troubleshooting:

• Run with backtrace enabled: RUST_BACKTRACE=1 cargo <command>
• Increase logging: cargo run -- -v (Repeat for each log level)
  • Log levels: error, warning, info, debug, trace