Functional testing framework for AVR firmware, powered by simavr.
tl;dr get your microcontroller's firmware black-box-tested in seconds!
Create a crate dedicated to your project's tests:
$ cargo new yourproject-tests --lib... add avr-tester as its dependency:
# yourproject-tests/Cargo.toml
[dependencies]
avr-tester = "0.2"... and, just like that, start writing tests:
// yourproject-tests/src/lib.rs
use avr_tester::*;
fn avr() -> AvrTester {
AvrTester::atmega328p()
.with_clock_of_16_mhz()
.load("../../yourproject/target/atmega328p/release/yourproject.elf")
}
// Assuming `yourproject` implements a ROT-13 encoder:
#[test]
fn short_text() {
let mut avr = avr();
// Let's give our firmware a moment to initialize:
avr.run_for_ms(1);
// Now, let's send the string:
avr.uart0().write("Hello, World!");
// ... give the AVR a moment to retrieve it & send back, encoded:
avr.run_for_ms(1);
// ... and, finally, let's assert the outcome:
assert_eq!("Uryyb, Jbeyq!", avr.uart0().read::<String>());
}
#[test]
fn long_text() {
let mut avr = avr();
avr.run_for_ms(1);
avr.uart0().write("Lorem ipsum dolor sit amet, consectetur adipiscing elit");
avr.run_for_ms(10);
assert_eq!(
"Yberz vcfhz qbybe fvg nzrg, pbafrpgrghe nqvcvfpvat ryvg",
avr.uart0().read::<String>(),
);
}... having the tests ready, just run cargo test inside yourproject-tests :-)
Note that because AvrTester simulates an actual AVR, you don't have to modify
yourproject at all - it's free to use timers, GPIOs etc. and everything
should just work ™.
In fact, yourproject doesn't even have to be written in Rust - you can create
Rust-based tests for a firmware written in C, Zig or anything else!
See: simavr-ffi.
Following features seem to be supported by simavr, but haven't been yet exposed in AvrTester:
- interrupts,
- EEPROM,
- I2C,
- watchdog,
- TWI,
- https://lib.rs/crates/simavr-section,
- USB.
(your firmware can use those features, but you just won't be able to test them.)
- Triggering AVR's sleep mode will cause the Rust code to panic, because the only way to wake an AVR is to trigger an interrupt and those are not yet supported.
Pull requests are very much welcome!
AvrTester's integration tests lay in avr-tester/tests - you can run them with:
$ cd avr-tester
$ cargo testNote that for those tests to work, you might need some additional dependencies:
$ nix-shell
# and then `cargo test`$ sudo apt install avr-libc gcc-avr
# and then `cargo test`Copyright (c) 2022 Patryk Wychowaniec [email protected].
Licensed under the MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent