✨ feat/added optional fuzzing statistics (#144)

* Optionaly show stats during fuzzing session * 🐛 (store failed txs): Store failex txs * 🩹 Simplified stats logging * 📝 Added fuzzing stats to docs * ✨ Added failed invariants check stats --------- Co-authored-by: Ikrk <ikrk@centrum.cz>
Ackee-Blockchain · Jun 7, 2024 · 8e0d235 · 8e0d235
1 parent 36664f1
commit 8e0d235
Show file tree

Hide file tree

Showing 22 changed files with 660 additions and 96 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 incremented upon a breaking change and the patch version will be incremented for features.
 
 ## [dev] - Unreleased
+- feat/fuzzer-stats-logging, an optional statistics output for fuzzing session ([#144](https://github.com/Ackee-Blockchain/trident/pull/144))
 
 ## [0.6.0] - 2024-05-20
 ### Added

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/client/Cargo.toml b/crates/client/Cargo.toml
@@ -80,3 +80,4 @@ solana-bpf-loader-program = "1.16"
 solana-program = "1.16"
 solana-sdk-macro = "1.16"
 solana-system-program = "1.16"
+prettytable = "0.10.0"
diff --git a/crates/client/derive/fuzz_test_executor/src/lib.rs b/crates/client/derive/fuzz_test_executor/src/lib.rs
@@ -47,27 +47,47 @@ pub fn fuzz_test_executor(input: TokenStream) -> TokenStream {
                         match duplicate_tx {
                             Some(_) => eprintln!("\x1b[1;93mWarning\x1b[0m: Skipping duplicate instruction `{}`", self.to_context_string()),
                             None => {
+                                #[cfg(fuzzing_with_stats)]
+                                let mut stats_logger = FuzzingStatistics::new();
+                                #[cfg(fuzzing_with_stats)]
+                                stats_logger.increase_invoked(self.to_context_string());
+
                                 let tx_result = client.process_transaction(transaction)
                                 .map_err(|e| e.with_origin(Origin::Instruction(self.to_context_string())));
-
                                 match tx_result {
-                                    Ok(_) => {
-                                        snaphot.capture_after(client).unwrap();
-                                        let (acc_before, acc_after) = snaphot.get_snapshot()
-                                            .map_err(|e| e.with_origin(Origin::Instruction(self.to_context_string())))
-                                            .expect("Snapshot deserialization expect"); // we want to panic if we cannot unwrap to cause a crash
+                                        Ok(_) => {
+                                            #[cfg(fuzzing_with_stats)]
+                                            stats_logger.increase_successful(self.to_context_string());
+
+                                            snaphot.capture_after(client).unwrap();
+                                            let (acc_before, acc_after) = snaphot.get_snapshot()
+                                                .map_err(|e| e.with_origin(Origin::Instruction(self.to_context_string())))
+                                                .expect("Snapshot deserialization expect"); // we want to panic if we cannot unwrap to cause a crash
+
+                                            if let Err(e) = ix.check(acc_before, acc_after, data).map_err(|e| e.with_origin(Origin::Instruction(self.to_context_string()))) {
+                                                #[cfg(fuzzing_with_stats)]
+                                                {
+                                                    stats_logger.increase_failed_check(self.to_context_string());
+                                                    stats_logger.output_serialized();
+                                                }
+                                                eprintln!(
+                                                    "\x1b[31mCRASH DETECTED!\x1b[0m Custom check after the {} instruction did not pass!",
+                                                    self.to_context_string());
+                                                panic!("{}", e)
+                                            }
+                                            #[cfg(fuzzing_with_stats)]
+                                            stats_logger.output_serialized();
 
-                                        if let Err(e) = ix.check(acc_before, acc_after, data).map_err(|e| e.with_origin(Origin::Instruction(self.to_context_string()))) {
-                                            eprintln!(
-                                                "\x1b[31mCRASH DETECTED!\x1b[0m Custom check after the {} instruction did not pass!",
-                                                self.to_context_string());
-                                            panic!("{}", e)
+                                        },
+                                        Err(e) => {
+                                            #[cfg(fuzzing_with_stats)]
+                                            {
+                                                stats_logger.increase_failed(self.to_context_string());
+                                                stats_logger.output_serialized();
+                                            }
+                                            let mut raw_accounts = snaphot.get_raw_pre_ix_accounts();
+                                            ix.tx_error_handler(e, data, &mut raw_accounts)?
                                         }
-                                    },
-                                    Err(e) => {
-                                        let mut raw_accounts = snaphot.get_raw_pre_ix_accounts();
-                                        ix.tx_error_handler(e, data, &mut raw_accounts)?
-                                    }
                                 }
                             }
                         }