fuzz: Consolidate fuzzing TestingSetup initialization

dongcarl · dongcarl · commit 713314abfa22 · 2021-01-21T09:29:42.000-05:00
Previously, the {Basic,}TestingSetup for fuzzers were set up in many ways:

1. Calling InitializeFuzzingContext, which implicitly constructs a static
   const BasicTestingSetup
2. Directly constructing a static const BasicTestingSetup in the initialize_*
   function
3. Directly constructing a static TestingSetup and reproducing the
   initialization arguments (I'm assuming because
   InitializeFuzzingContext only initializes a BasicTestingSetup)

The new, relatively-simple MakeFuzzingContext function allows us to
consolidate these methods of initialization by being flexible enough to
be used in all situations. It:

1. Is templated so that we can choose to initialize any of
   the *TestingSetup classes
2. Has sane defaults which are often used in fuzzers but are also
   easily overridable
3. Returns a unique_ptr, explicitly transferring ownership to the caller
   to deal with according to its situation
diff --git a/src/test/fuzz/banman.cpp b/src/test/fuzz/banman.cpp
@@ -26,7 +26,7 @@ int64_t ConsumeBanTimeOffset(FuzzedDataProvider& fuzzed_data_provider) noexcept
 
 void initialize_banman()
 {
-    InitializeFuzzingContext();
+    static const auto testing_setup = MakeFuzzingContext<>();
 }
 
 FUZZ_TARGET_INIT(banman, initialize_banman)
diff --git a/src/test/fuzz/connman.cpp b/src/test/fuzz/connman.cpp
@@ -17,7 +17,7 @@
 
 void initialize_connman()
 {
-    InitializeFuzzingContext();
+    static const auto testing_setup = MakeFuzzingContext<>();
 }
 
 FUZZ_TARGET_INIT(connman, initialize_connman)
diff --git a/src/test/fuzz/data_stream.cpp b/src/test/fuzz/data_stream.cpp
@@ -13,7 +13,7 @@
 
 void initialize_data_stream_addr_man()
 {
-    InitializeFuzzingContext();
+    static const auto testing_setup = MakeFuzzingContext<>();
 }
 
 FUZZ_TARGET_INIT(data_stream_addr_man, initialize_data_stream_addr_man)
diff --git a/src/test/fuzz/load_external_block_file.cpp b/src/test/fuzz/load_external_block_file.cpp
@@ -15,7 +15,7 @@
 
 void initialize_load_external_block_file()
 {
-    InitializeFuzzingContext();
+    static const auto testing_setup = MakeFuzzingContext<>();
 }
 
 FUZZ_TARGET_INIT(load_external_block_file, initialize_load_external_block_file)
diff --git a/src/test/fuzz/net.cpp b/src/test/fuzz/net.cpp
@@ -22,7 +22,7 @@
 
 void initialize_net()
 {
-    static const BasicTestingSetup basic_testing_setup;
+    static const auto testing_setup = MakeFuzzingContext<>(CBaseChainParams::MAIN);
 }
 
 FUZZ_TARGET_INIT(net, initialize_net)
diff --git a/src/test/fuzz/policy_estimator.cpp b/src/test/fuzz/policy_estimator.cpp
@@ -16,7 +16,7 @@
 
 void initialize_policy_estimator()
 {
-    InitializeFuzzingContext();
+    static const auto testing_setup = MakeFuzzingContext<>();
 }
 
 FUZZ_TARGET_INIT(policy_estimator, initialize_policy_estimator)
diff --git a/src/test/fuzz/policy_estimator_io.cpp b/src/test/fuzz/policy_estimator_io.cpp
@@ -12,7 +12,7 @@
 
 void initialize_policy_estimator_io()
 {
-    InitializeFuzzingContext();
+    static const auto testing_setup = MakeFuzzingContext<>();
 }
 
 FUZZ_TARGET_INIT(policy_estimator_io, initialize_policy_estimator_io)
diff --git a/src/test/fuzz/process_message.cpp b/src/test/fuzz/process_message.cpp
@@ -38,14 +38,8 @@ const TestingSetup* g_setup;
 
 void initialize_process_message()
 {
-    static TestingSetup setup{
-        CBaseChainParams::REGTEST,
-        {
-            "-nodebuglogfile",
-        },
-    };
-    g_setup = &setup;
-
+    static const auto testing_setup = MakeFuzzingContext<const TestingSetup>();
+    g_setup = testing_setup.get();
     for (int i = 0; i < 2 * COINBASE_MATURITY; i++) {
         MineBlock(g_setup->m_node, CScript() << OP_TRUE);
     }
diff --git a/src/test/fuzz/process_messages.cpp b/src/test/fuzz/process_messages.cpp
@@ -17,18 +17,14 @@
 #include <validation.h>
 #include <validationinterface.h>
 
+namespace {
 const TestingSetup* g_setup;
+} // namespace
 
 void initialize_process_messages()
 {
-    static TestingSetup setup{
-        CBaseChainParams::REGTEST,
-        {
-            "-nodebuglogfile",
-        },
-    };
-    g_setup = &setup;
-
+    static const auto testing_setup = MakeFuzzingContext<const TestingSetup>();
+    g_setup = testing_setup.get();
     for (int i = 0; i < 2 * COINBASE_MATURITY; i++) {
         MineBlock(g_setup->m_node, CScript() << OP_TRUE);
     }
diff --git a/src/test/fuzz/signet.cpp b/src/test/fuzz/signet.cpp
@@ -17,7 +17,7 @@
 
 void initialize_signet()
 {
-    InitializeFuzzingContext(CBaseChainParams::SIGNET);
+    static const auto testing_setup = MakeFuzzingContext<>(CBaseChainParams::SIGNET);
 }
 
 FUZZ_TARGET_INIT(signet, initialize_signet)
diff --git a/src/test/fuzz/util.h b/src/test/fuzz/util.h
@@ -27,6 +27,7 @@
 #include <txmempool.h>
 #include <uint256.h>
 #include <util/time.h>
+#include <util/vector.h>
 #include <version.h>
 
 #include <algorithm>
@@ -338,9 +339,17 @@ inline void FillNode(FuzzedDataProvider& fuzzed_data_provider, CNode& node, cons
     }
 }
 
-inline void InitializeFuzzingContext(const std::string& chain_name = CBaseChainParams::REGTEST)
+template <class T = const BasicTestingSetup>
+std::unique_ptr<T> MakeFuzzingContext(const std::string& chain_name = CBaseChainParams::REGTEST, const std::vector<const char*>& extra_args = {})
 {
-    static const BasicTestingSetup basic_testing_setup{chain_name, {"-nodebuglogfile"}};
+    // Prepend default arguments for fuzzing
+    const std::vector<const char*> arguments = Cat(
+        {
+            "-nodebuglogfile",
+        },
+        extra_args);
+
+    return MakeUnique<T>(chain_name, arguments);
 }
 
 class FuzzedFileProvider

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ int64_t ConsumeBanTimeOffset(FuzzedDataProvider& fuzzed_data_provider) noexcept`
`26`	`26`
`27`	`27`	`void initialize_banman()`
`28`	`28`	`{`
`29`		`- InitializeFuzzingContext();`
	`29`	`+ static const auto testing_setup = MakeFuzzingContext<>();`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`FUZZ_TARGET_INIT(banman, initialize_banman)`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`
`18`	`18`	`void initialize_connman()`
`19`	`19`	`{`
`20`		`- InitializeFuzzingContext();`
	`20`	`+ static const auto testing_setup = MakeFuzzingContext<>();`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`FUZZ_TARGET_INIT(connman, initialize_connman)`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`void initialize_data_stream_addr_man()`
`15`	`15`	`{`
`16`		`- InitializeFuzzingContext();`
	`16`	`+ static const auto testing_setup = MakeFuzzingContext<>();`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`FUZZ_TARGET_INIT(data_stream_addr_man, initialize_data_stream_addr_man)`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`
`16`	`16`	`void initialize_load_external_block_file()`
`17`	`17`	`{`
`18`		`- InitializeFuzzingContext();`
	`18`	`+ static const auto testing_setup = MakeFuzzingContext<>();`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`FUZZ_TARGET_INIT(load_external_block_file, initialize_load_external_block_file)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`
`23`	`23`	`void initialize_net()`
`24`	`24`	`{`
`25`		`- static const BasicTestingSetup basic_testing_setup;`
	`25`	`+ static const auto testing_setup = MakeFuzzingContext<>(CBaseChainParams::MAIN);`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`FUZZ_TARGET_INIT(net, initialize_net)`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`
`17`	`17`	`void initialize_policy_estimator()`
`18`	`18`	`{`
`19`		`- InitializeFuzzingContext();`
	`19`	`+ static const auto testing_setup = MakeFuzzingContext<>();`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`FUZZ_TARGET_INIT(policy_estimator, initialize_policy_estimator)`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`
`13`	`13`	`void initialize_policy_estimator_io()`
`14`	`14`	`{`
`15`		`- InitializeFuzzingContext();`
	`15`	`+ static const auto testing_setup = MakeFuzzingContext<>();`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`FUZZ_TARGET_INIT(policy_estimator_io, initialize_policy_estimator_io)`