Add basic test for coverage example and library (#3035)

The coverage code is not currently exercised by any test.

* Add a test to the `coverage` example so that it can run in PR builds.
* Specify `--all-targets` so that example tests are run.
* Install and use [`nextest`](https://nexte.st/) instead of the standard test runner.
  * This will parallelize test runs across binaries so the overall test run is faster.
* Make sleep duration of agent configurable and reduce it in the test run so that it doesn't wait for 30 seconds.

Author: Porges

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ env:
   CARGO_TERM_COLOR: always
   SCCACHE_DIR: ${{github.workspace}}/sccache/
   SCCACHE_CACHE_SIZE: 1G
-  ACTIONS_CACHE_KEY_DATE: 2022-11-21-02
+  ACTIONS_CACHE_KEY_DATE: 2023-04-19
   CI: true
 
 jobs:

src/agent/Cargo.lock

@@ -167,3 +167,28 @@ fn dump_cobertura(binary: &BinaryCoverage) -> Result<()> {
 
     Ok(())
 }
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn can_run_coverage() {
+        #[cfg(target_os = "linux")]
+        let cmd = command(&["ls"].map(str::to_string), None);
+
+        #[cfg(target_os = "windows")]
+        let cmd = command(&["cmd.exe", "/c", "dir"].map(str::to_string), None);
+
+        let recorded = CoverageRecorder::new(cmd)
+            .timeout(Duration::from_secs(5))
+            .record()
+            .unwrap();
+
+        assert_ne!("", recorded.output.stdout);
+
+        // only non-debuggable modules are found on Windows
+        #[cfg(target_os = "linux")]
+        assert!(recorded.coverage.modules.len() > 0);
+    }
+}

src/agent/coverage/examples/coverage.rs

@@ -2,6 +2,8 @@
 // Licensed under the MIT License.
 
 #![allow(clippy::too_many_arguments)]
+use std::time::Duration;
+
 use anyhow::{Error, Result};
 use tokio::time;
 
@@ -29,6 +31,7 @@ pub struct Agent {
     last_poll_command: Result<Option<NodeCommand>, PollCommandError>,
     managed: bool,
     machine_id: uuid::Uuid,
+    sleep_duration: Duration,
 }
 
 impl Agent {
@@ -59,6 +62,7 @@ impl Agent {
             last_poll_command,
             managed,
             machine_id,
+            sleep_duration: Duration::from_secs(30),
         }
     }
 
@@ -365,8 +369,7 @@ impl Agent {
     }
 
     async fn sleep(&self) {
-        let delay = time::Duration::from_secs(30);
-        time::sleep(delay).await;
+        time::sleep(self.sleep_duration).await;
     }
 }
 

src/agent/onefuzz-agent/src/agent.rs

@@ -84,7 +84,8 @@ impl Fixture {
 
 #[tokio::test]
 async fn test_update_free_no_work() {
-    let agent = Fixture.agent();
+    let mut agent = Fixture.agent();
+    agent.sleep_duration = Duration::from_secs(5);
 
     let (agent, done) = agent.update().await.unwrap();
     assert!(!done);

src/agent/onefuzz-agent/src/agent/tests.rs

@@ -61,7 +61,7 @@ export RUST_BACKTRACE=full
 
 # Run tests and collect coverage 
 # https://github.com/taiki-e/cargo-llvm-cov
-cargo llvm-cov --locked --workspace --lcov --output-path "$output_dir/lcov.info"
+cargo llvm-cov nextest --all-targets --locked --workspace --lcov --output-path "$output_dir/lcov.info"
 
 # TODO: re-enable integration tests.
 # cargo test --release --manifest-path ./onefuzz-task/Cargo.toml --features integration_test -- --nocapture

src/ci/agent.sh

@@ -5,7 +5,7 @@
 
 set -ex
 
-cargo install sccache cargo-license@0.4.2 cargo-llvm-cov cargo-deny cargo-insta
+cargo install sccache cargo-license@0.4.2 cargo-llvm-cov cargo-deny cargo-insta cargo-nextest
 
 # sccache --start-server
 # export RUSTC_WRAPPER=$(which sccache)