phink 0.1.5

🐙 Phink, a ink! smart-contract property-based and coverage-guided fuzzer
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

extern crate phink_lib;
pub mod shared;

#[cfg(test)]
mod tests {
    use super::*;
    use crate::shared::{
        instrument,
        is_compiled,
        is_instrumented,
        samples::Sample,
        with_modified_phink_config,
        DEFAULT_TEST_PHINK_TOML,
    };
    use anyhow::ensure;
    use assert_cmd::Command as CommandAssertCmd;
    use phink_lib::{
        cli::config::Configuration,
        instrumenter::path::InstrumentedPath,
        EmptyResult,
    };
    use predicates::prelude::predicate;
    use std::fs;
    use tempfile::tempdir;
    use walkdir::WalkDir;

    #[test]
    fn test_instrument_respects_configuration() -> EmptyResult {
        let path_instrumented_contract = InstrumentedPath::from(tempdir()?.into_path());

        let config = Configuration {
            instrumented_contract_path: Some(path_instrumented_contract.clone()),
            fuzz_output: Some(tempdir()?.into_path()),
            ..Default::default()
        };

        let test = with_modified_phink_config(&config, || {
            let _ = instrument(Sample::MultiContractCaller);

            ensure!(
                fs::exists(path_instrumented_contract.path.clone()).is_ok(),
                "Instrumented contract not found"
            );

            // Verify that a Cargo.toml exists somewhere under
            // `path_instrumented_contract`
            let cargo_toml_exists = WalkDir::new(&path_instrumented_contract.path)
                .into_iter()
                .filter_map(Result::ok) // Filter out errors
                .any(|entry| {
                    entry.file_name() == "Cargo.toml"
                });

            ensure!(
                cargo_toml_exists,
                "Cargo.toml not found in the instrumented contract path"
            );

            ensure!(
                is_compiled(&path_instrumented_contract.path),
                "Target wasn't compiled properly"
            );

            Ok(())
        });
        assert!(test.is_ok(), "{}", test.err().unwrap().to_string());
        Ok(())
    }
    #[test]
    fn test_instrumentation_multifile_contract() -> EmptyResult {
        let path_instrumented_contract = InstrumentedPath::from(tempdir()?.into_path());

        let config = Configuration {
            instrumented_contract_path: Some(path_instrumented_contract.clone()),
            fuzz_output: Some(tempdir()?.into_path()),
            ..Default::default()
        };

        let test = with_modified_phink_config(&config, || {
            let _ = instrument(Sample::MultiContractCaller);

            ensure!(
                fs::exists(path_instrumented_contract.path.clone()).is_ok(),
                "Instrumented contract not found"
            );

            let accu = &path_instrumented_contract.path.join("accumulator");
            ensure!(
                is_instrumented(accu),
                "Expected to find a trace of instrumentation in Accumulator"
            );

            let subber = &path_instrumented_contract.path.join("subber");
            ensure!(
                is_instrumented(subber),
                "Expected to find a trace of instrumentation in Subber"
            );

            let adder = &path_instrumented_contract.path.join("adder");

            ensure!(
                is_instrumented(adder),
                "Expected to find a trace of instrumentation in Adder"
            );

            ensure!(
                is_compiled(&path_instrumented_contract.path),
                "Target wasn't compiled properly"
            );

            Ok(())
        });
        assert!(test.is_ok(), "{}", test.err().unwrap().to_string());
        Ok(())
    }

    #[test]
    fn test_instrument_contains_instrumented_code() -> EmptyResult {
        let path_instrumented_contract = InstrumentedPath::from(tempdir()?.into_path());

        let config = Configuration {
            instrumented_contract_path: Some(path_instrumented_contract.clone()),
            fuzz_output: Some(tempdir()?.into_path()),
            ..Default::default()
        };

        let test = with_modified_phink_config(&config, || {
            let _ = instrument(Sample::Dummy);

            ensure!(
                is_instrumented(&path_instrumented_contract.path),
                "Expected to find a trace of instrumentation in at least one .rs file"
            );
            Ok(())
        });

        assert!(test.is_ok(), "{}", test.err().unwrap().to_string());
        Ok(())
    }

    #[test]
    fn test_instrument_help_terminates_correctly() -> EmptyResult {
        CommandAssertCmd::cargo_bin("phink")?
            .args(["--config", DEFAULT_TEST_PHINK_TOML])
            .arg("instrument")
            .arg(Sample::Dummy.path())
            .arg("--help")
            .assert()
            .stdout(predicate::str::contains(
                "Usage: phink instrument <CONTRACT_PATH>",
            ));
        Ok(())
    }
}