harness-cli 0.0.9

Precise and reproducible benchmarking
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use crate::helper::TestCrate;

mod helper;

const BENCH_DUMP_GIT_COMMIT: &str = r#"
#[harness::bench]
fn bench(bencher: &harness::Bencher) {
    bencher.time(|| {});
    println!("GIT[{}]", git_info2::get().head.last_commit_hash.unwrap().as_str());
}
"#;

const CARGO_TOML_COMMON: &str = r#"
[package]
name = "harness-test"
version = "0.1.0"
edition = "2021"

[dev-dependencies]
harness = "0.0.4"
git_info2 = "0.1.2"

[[bench]]
name = "foo"
harness = false
"#;

#[test]
fn test_default_build_targets() -> anyhow::Result<()> {
    let _guard = helper::SYNC.lock().unwrap();
    let mut test_crate = TestCrate::new(None)?.enter()?;
    test_crate.file("benches/foo.rs", BENCH_DUMP_GIT_COMMIT)?;
    test_crate.file("Cargo.toml", CARGO_TOML_COMMON)?;
    let commit1 = test_crate.commit()?;
    // Make some changes to Cargo.lock
    test_crate.add_dep("structopt")?;
    let commit2 = test_crate.commit()?;
    // Run benchmark
    test_crate.harness_run(&["-i", "1", "-n", "1"])?;
    // Check output
    let output1 = test_crate.get_harness_log("foo", "HEAD~1")?;
    assert!(output1.contains(&format!("GIT[{commit1}]")));
    let output2 = test_crate.get_harness_log("foo", "HEAD")?;
    assert!(output2.contains(&format!("GIT[{commit2}]")));
    assert_eq!(test_crate.get_current_branch(), Some("main".to_owned()));
    Ok(())
}

#[test]
fn test_empty_build_targets() -> anyhow::Result<()> {
    let _guard = helper::SYNC.lock().unwrap();
    let mut test_crate = TestCrate::new(None)?.enter()?;
    test_crate.file("benches/foo.rs", BENCH_DUMP_GIT_COMMIT)?;
    test_crate.file(
        "Cargo.toml",
        format!(
            r#"
            {CARGO_TOML_COMMON}
            [package.metadata.harness.profiles.default.builds]
            build_a = {{}}
            build_b = {{}}
        "#
        ),
    )?;
    let commit = test_crate.commit()?;
    // Run benchmark
    test_crate.harness_run(&["-i", "1", "-n", "1"])?;
    // Check output
    let output1 = test_crate.get_harness_log("foo", "build_a")?;
    assert!(output1.contains(&format!("GIT[{commit}]")));
    let output2 = test_crate.get_harness_log("foo", "build_b")?;
    assert!(output2.contains(&format!("GIT[{commit}]")));
    assert_eq!(test_crate.get_current_branch(), Some("main".to_owned()));
    Ok(())
}

#[test]
fn test_build_targets_with_different_commits() -> anyhow::Result<()> {
    let _guard = helper::SYNC.lock().unwrap();
    let mut test_crate = TestCrate::new(None)?.enter()?;
    test_crate.file("benches/foo.rs", BENCH_DUMP_GIT_COMMIT)?;
    test_crate.file("Cargo.toml", CARGO_TOML_COMMON)?;
    let commit1 = test_crate.commit()?;
    test_crate.file(
        "Cargo.toml",
        format!(
            r#"
            {CARGO_TOML_COMMON}
            [package.metadata.harness.profiles.default.builds]
            build_a = {{}}
            build_b = {{ commit = "{commit1}" }}
        "#
        ),
    )?;
    let commit2 = test_crate.commit()?;
    // Run benchmark
    test_crate.harness_run(&["-i", "1", "-n", "1"])?;
    // Check output
    let output1 = test_crate.get_harness_log("foo", "build_a")?;
    assert!(output1.contains(&format!("GIT[{commit2}]")));
    let output2 = test_crate.get_harness_log("foo", "build_b")?;
    assert!(output2.contains(&format!("GIT[{commit1}]")));
    assert_eq!(test_crate.get_current_branch(), Some("main".to_owned()));
    Ok(())
}