Optionaly show stats during fuzzing session

Ackee-Blockchain · Mar 22, 2024 · 7eb533f · 7eb533f
1 parent f9f2a41
commit 7eb533f
Show file tree

Hide file tree

Showing 21 changed files with 557 additions and 82 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ incremented upon a breaking change and the patch version will be incremented for
 
 ## [Unreleased]
 ### Added
+- feat/fuzzer-stats-logging, an optional statistics output for fuzzing session ([#144](https://github.com/Ackee-Blockchain/trident/pull/144))
 - fix/allow to process duplicate transactions ([#147](https://github.com/Ackee-Blockchain/trident/pull/147))
 - feat/possibility to implement custom transaction error handling ([#145](https://github.com/Ackee-Blockchain/trident/pull/145))
 - feat/support of automatically obtaining fully qualified paths of Data Accounts Custom types for `accounts_snapshots.rs` ([#141](https://github.com/Ackee-Blockchain/trident/pull/141))

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/client/Cargo.toml b/crates/client/Cargo.toml
@@ -71,3 +71,4 @@ pathdiff = "0.2.1"
 solana-banks-client = "<1.18"
 indicatif = "0.17.8"
 regex = "1.10.3"
+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
@@ -13,6 +13,12 @@ pub fn fuzz_test_executor(input: TokenStream) -> TokenStream {
                 let variant_name = &variant.ident;
                 quote! {
                     #enum_name::#variant_name (ix) => {
+                        #[cfg(fuzzing_with_stats)]
+                        let mut stats_logger = FuzzingStatistics::new();
+                        #[cfg(fuzzing_with_stats)]
+                        stats_logger.increase_invoked(self.to_context_string());
+
+
                         let (mut signers, metas) = ix.get_accounts(client, &mut accounts.borrow_mut())
                             .map_err(|e| e.with_origin(Origin::Instruction(self.to_context_string())))
                             .expect("Accounts calculation expect");
@@ -49,25 +55,31 @@ pub fn fuzz_test_executor(input: TokenStream) -> TokenStream {
                             None => {
                                 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_successfully_invoked(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()))) {
-                                            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.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)?
-                                    }
                                 }
                             }
                         }