feat: forge test snapshot flags #9710
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
turbocrime
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy,
yash-atreya and
zerosnacks
as code owners
turbocrime
force-pushed
the
snapshot-flags
branch
from
0cd7bd4 to
ab193b2
Compare
turbocrime
commented
Jan 18, 2025
Comment on lines
+126
to
+127
| #[arg(long, env = "FORGE_SNAPSHOT_EMIT", action = ArgAction::Set, default_value="true", default_missing_value = "true", require_equals=true, num_args = 0..=1)] | ||
| snapshot_emit: bool, |
There was a problem hiding this comment.
this is a little strange but it's the only way to get decent behavior out of clap
| @@ -662,7 +670,7 @@ impl TestArgs { | |||
| if !gas_snapshots.is_empty() { | |||
| // Check for differences in gas snapshots if `FORGE_SNAPSHOT_CHECK` is set. | |||
| // Exiting early with code 1 if differences are found. | |||
| if std::env::var("FORGE_SNAPSHOT_CHECK").is_ok() { | |||
| if self.snapshot_check { | |||
There was a problem hiding this comment.
direct env var access is now moved to another clap flag.
the behavior now supports 'false' values as well, instead of just conditioning on presence.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
fixes #9697
Solution
i've added command-line flags and an environment variable
FORGE_SNAPSHOT_EMITwhich allow a user to control snapshot generation.i also slightly refactored the use of environment variable
FORGE_SNAPSHOT_CHECK.existing default behaviors are maintained.