Better hardware integration tests

[TroyNeubauer]

Larger suite of tests that only run when a radio is connected (ie: not ci)

maybe discuss how we want to setup the testing with regards to naming tests so we can ignore hardware tests. @QuantumEF

[QuantumEF]

This reddit comment mentioned an interesting approach:

I set this up a couple weeks ago for a project I'm working on. Some tests require a proprietary tool that not all dev machines have and some tests require external test hardware, so I wrapped those tests in a feature to make them optional. It may not be the correct solution, but it works for our project.

Sorry for the poor feature names, I renamed them to be more generic for this post.

In Cargo.toml:

[features]
default=[]
use_proprietary_tools=[]
use_test_hw=[]

Then for each test that needs proprietary tools:

#[test]
#[cfg(feature = "use_proprietary_tools")]
fn test_one() {
  assert_eq!(1 + 1, 2);
}

And for each test that requires interfacing with external hardware:

#[test]
#[cfg(feature = "use_test_hw")]
fn test_two() {
  assert_eq!(2 + 2, 4);
}

Now, cargo test ignores those tests by default. They can be tested using cargo test --features "use_proprietary_tools use_test_hw".

Alternatively, we name tests like hw_test_[brf1,brf2,any]_<blah>() and then filter them like cargo test hw_test_brf1 hw_test_any for example.

All hardware tests of course should be marked with #[ignore]

[QuantumEF]

Also adding this here: https://docs.rs/serial_test/latest/serial_test/

[TroyNeubauer]

Yeah I think feature flags make the most sense for this. Naming the tests like hw_test_[brf1,brf2,any]_<blah>() is clever, however someone who clones the repo and runs cargo t should be able to expect all the tests to work without jumping through hoops.

As long as we have no default features (like above), we should be set

[QuantumEF]

Note for myself.
Need to add a test for disabling and reenabling a rx or tx module since there seems to be issues with that.
Also need to add transmit and receive tests under a feature flag (since they will require additional setup beyond just connecting a radio.