feat: add envExists cheatcode to check if a environment variable exists #7744
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
0xtekgrinder
requested review from
DaniPopes,
mattsse,
klkvr and
Evalir
as code owners
DaniPopes
approved these changes
Apr 20, 2024
| impl Cheatcode for envExistsCall { | ||
| fn apply(&self, _state: &mut Cheatcodes) -> Result { | ||
| let Self { name } = self; | ||
| Ok(env::var(name).is_ok().abi_encode()) |
There was a problem hiding this comment.
Note that env::var returns Err if it exists but is not valid unicode (see fn get_env). This is probably fine since we error on that as well in getEnv
There was a problem hiding this comment.
should I handle this error to still returns true or not then ?
mattsse
approved these changes
Apr 20, 2024
There was a problem hiding this comment.
reasonable
needs forge-std followup foundry-rs/forge-std#545
This was referenced Apr 26, 2024
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
Inside some of my tests I need to have a pretty advanced environment configuration with potential forks yet I cannot just do it in a clean way as if I load a environment variable that doesn't exists it will reverts. So currently I am using a vm.ffi to bypass this problem and use bash instead to check if the environment variable exists.
Solution
Add a cheatcode that can tell if a environment variable exists or not