Create a test to run readme example

Author: pipex

examples/readme/Cargo.toml

@@ -14,3 +14,7 @@ tokio = { version = "1.44.2", default-features = false, features = [
   "rt-multi-thread",
   "time",
 ] }
+
+[dev-dependencies]
+assert_cmd = "2.0.17"
+predicates = "3.1.3"

examples/readme/src/main.rs

@@ -1,6 +1,6 @@
 use anyhow::{Context, Result};
 use serde::{Deserialize, Serialize};
-use std::collections::HashMap;
+use std::collections::BTreeMap;
 use std::time::Duration;
 use tokio::time::sleep;
 
@@ -12,7 +12,7 @@ use mahler::worker::{init_logging, Worker};
 // since the library uses JSON internally to access parts
 // of the state
 #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
-struct Counters(HashMap<String, i32>);
+struct Counters(BTreeMap<String, i32>);
 
 // `plus_one` defines a job that updates a counter if it is below some target.
 // The job makes use of two extractors:
@@ -72,7 +72,7 @@ async fn main() -> Result<()> {
         .job("/{counter}", update(plus_two))
         // We initialize the worker with two counters
         // `a` and `b` with value 0
-        .initial_state(Counters(HashMap::from([
+        .initial_state(Counters(BTreeMap::from([
             ("a".to_string(), 0),
             ("b".to_string(), 0),
         ])))
@@ -81,7 +81,7 @@ async fn main() -> Result<()> {
     // Tell the worker to find a plan from the initial state (a:0, b:0)
     // to the target state (a:1, b:2) and execute it
     let worker = worker
-        .seek_target(Counters(HashMap::from([
+        .seek_target(Counters(BTreeMap::from([
             ("a".to_string(), 1),
             ("b".to_string(), 2),
         ])))
@@ -98,7 +98,9 @@ async fn main() -> Result<()> {
 
     assert_eq!(
         state,
-        Counters(HashMap::from([("a".to_string(), 1), ("b".to_string(), 2),]))
+        Counters(BTreeMap::from(
+            [("a".to_string(), 1), ("b".to_string(), 2),]
+        ))
     );
 
     println!("The system state is now {:?}", state);

examples/readme/tests/cli.rs

@@ -0,0 +1,20 @@
+use anyhow::Result;
+use assert_cmd::prelude::*; // Add methods on commands
+use predicates::prelude::*;
+use std::process::{Command, Output}; // Run programs
+
+#[test]
+fn run_example() -> Result<()> {
+    let mut cmd = Command::cargo_bin(env!("CARGO_PKG_NAME"))?;
+    let assert = cmd.env("RUST_LOG", "debug").assert();
+
+    let Output { stdout, stderr, .. } = cmd.unwrap();
+    println!("{}", String::from_utf8_lossy(&stderr));
+    println!("{}", String::from_utf8_lossy(&stdout));
+
+    assert.success().stdout(predicate::str::diff(
+        "The system state is now Counters({\"a\": 1, \"b\": 2})\n",
+    ));
+
+    Ok(())
+}

examples/run-tests.sh

@@ -9,7 +9,7 @@ export RUST_LOG="${RUST_LOG},bollard=off,hyper=off"
 find ./examples -name 'Cargo.toml' | while read -r file; do
     dir=$(dirname "$file")
     echo "Running tests in $dir"
-    (cd "$dir" && cargo test -- --test-threads 1) || {
+    (cd "$dir" && cargo test -- --nocapture --test-threads 1) || {
         echo "Tests failed in $dir"
         exit 1
     }