Allow Medusa to run init function (ex: setUp) once per fuzz run

[0xZRA]

Closes #611

I decided to follow existing pattern of TargetContracts and TargetContractsBalances sequential deployments. I think the core functionality is in place (and I hope it meets the requirements?), but the PR could be improved with more edge case testing.

@anishnaik @montyly please let me know your thoughts whenever you get a chance

[anishnaik]

@0xZRA appreciate the quick turnaround! I need a few days before I can get to reviewing it just FYI :)

[0xZRA]

@0xZRA appreciate the quick turnaround! I need a few days before I can get to reviewing it just FYI :)

Absolutely! And thanks for the opportunity ;)

[montyly]

My bad, I never noticed the progression on this PR. This is great thanks @0xZRA. I tested it on a larger codebase and it works

In term of usability, I am wondering it would make sense to add a flag to enable setUp() to be called by default on all the contract that implements it?

[0xZRA]

@montyly Thanks for your feedback! I can work on adding the flag, it may take me few days though

[CLAassistant]

All committers have signed the CLA.

[0xZRA]

@montyly Let me know if the latest commit delivers the intended improvement to devx. My assumption is that the default configuration values will still be processed downstream to address all contracts that implement it.
I couldn't find the test that covers flags so maybe it's a good opportunity to add it?

[montyly]

thanks for the quick work!

To be honest I would even go further, and have the flag <name> skip targetContractsInitFunctions and just enable setUp(). The flag name could be enableFoundrySetUp or something like that?

The reasoning is that all the foundry-based projects uses a setUp() function, so I think its fair to assume a majority of users just need the setUp for the init functions

[0xZRA]

@montyly let me know if the latest approach works.
I also added the UseInitFunctions to control whether init functions (via use-init-fns or enable-foundry-setup) should be processed at all.
Since you mentioned that the main functionality seemed to be working as expected, the initialization logic hasn't changed, it's just now controlled by the feature flag.

My main concern is the number of changes to fuzzing/fuzzer.go since I worked on this task and it might take me a while to get up to speed on those changes before I can resolve the conflicts.

These are possible scenarios that I can think of:
// ==============================================================
// Use case 1: Single init function with multiple target contracts
// Config:
fuzzer.config.Fuzzing.TargetContracts = ["ContractA", "ContractB", "ContractC"]
fuzzer.config.Fuzzing.TargetContractsInitFunctions = ["setUp"]
fuzzer.config.Fuzzing.UseInitFunctions = true

// Same can be achieved by passing enable-foundry-setup

// Result: initFunctions = ["setUp", "setUp", "setUp"]
// Actual calls: setUp called on all 3 contracts

// ================================================================
// Use case 2: Single "initialize" function with multiple contracts
// Config:
fuzzer.config.Fuzzing.TargetContracts = ["ContractA", "ContractB"]
fuzzer.config.Fuzzing.TargetContractsInitFunctions = ["initialize"]
fuzzer.config.Fuzzing.UseInitFunctions = true

// Result: initFunctions = ["initialize", "initialize"]
// Actual calls: initialize called on both contracts

// ================================================================
// Use case 3: Provided init functions for all contracts
// Config:
fuzzer.config.Fuzzing.TargetContracts = ["ContractA", "ContractB"]
fuzzer.config.Fuzzing.TargetContractsInitFunctions = ["setUp", "initialize"]
fuzzer.config.Fuzzing.UseInitFunctions = true

// Result: initFunctions = ["setUp", "initialize"]
// Actual calls: setUp on ContractA, initialize on ContractB

// ================================================================
// Use case 4: Multiple identical functions
// Config:
fuzzer.config.Fuzzing.TargetContracts = ["ContractA", "ContractB"]
fuzzer.config.Fuzzing.TargetContractsInitFunctions = ["setUp", "setUp"]
fuzzer.config.Fuzzing.UseInitFunctions = true

// Result: initFunctions = ["setUp", "setUp"]
// Actual calls: `setUp on both contracts

// ================================================================
// Use case 5: UseInitFunctions is false
// Config:
fuzzer.config.Fuzzing.TargetContracts = ["ContractA", "ContractB"]
fuzzer.config.Fuzzing.TargetContractsInitFunctions = ["setUp"]
fuzzer.config.Fuzzing.UseInitFunctions = false

// Result: initFunctions = ["", ""]
// Actual calls: No init functions called

// ================================================================
// Use case 6: Single empty string (edge case)
// Config:
fuzzer.config.Fuzzing.TargetContracts = ["ContractA", "ContractB"]
fuzzer.config.Fuzzing.TargetContractsInitFunctions = [""]
fuzzer.config.Fuzzing.UseInitFunctions = true

// Result: initFunctions = ["", ""]
// Actual calls: No init functions called (empty strings ignored)

[anishnaik]

Thanks for giving this a review @montyly! @0xZRA apologies for the massive delay. Will get this merged in the next few weeks.

[0xZRA]

Thanks for giving this a review @montyly! @0xZRA apologies for the massive delay. Will get this merged in the next few weeks.

@anishnaik are you still planning to look into this at some point?