Merge pull request #318 from tzemanovic/tomas/env-vars-config-override

allow env vars to override non-default config
proptest-rs · May 22, 2023 · b88e9ff · b88e9ff
2 parents 18ca1af + 22672a6
commit b88e9ff
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/proptest/CHANGELOG.md b/proptest/CHANGELOG.md
@@ -1,5 +1,10 @@
 ## Unreleased
 
+### Breaking Changes
+
+- `PROPTEST_` environment variables now take precedence over tests' non-default
+  configuration.
+
 ### Bug Fixes
 
 - Don't implement Arbitrary for NonZeroU128 and NonZeroI128 on wasm targets where

diff --git a/proptest/src/sugar.rs b/proptest/src/sugar.rs
@@ -157,7 +157,7 @@ macro_rules! proptest {
         $(
             $(#[$meta])*
             fn $test_name() {
-                let mut config = $config.clone();
+                let mut config = $crate::test_runner::contextualize_config($config.clone());
                 config.test_name = Some(
                     concat!(module_path!(), "::", stringify!($test_name)));
                 $crate::proptest_helper!(@_BODY config ($($parm in $strategy),+) [] $body);
@@ -172,7 +172,7 @@ macro_rules! proptest {
         $(
             $(#[$meta])*
             fn $test_name() {
-                let mut config = $config.clone();
+                let mut config = $crate::test_runner::contextualize_config($config.clone());
                 config.test_name = Some(
                     concat!(module_path!(), "::", stringify!($test_name)));
                 $crate::proptest_helper!(@_BODY2 config ($($arg)+) [] $body);
@@ -223,25 +223,25 @@ macro_rules! proptest {
     };
 
     ($config:expr, |($($parm:pat in $strategy:expr),+ $(,)?)| $body:expr) => { {
-        let mut config = $config.__sugar_to_owned();
+        let mut config = $crate::test_runner::contextualize_config($config.__sugar_to_owned());
         $crate::sugar::force_no_fork(&mut config);
         $crate::proptest_helper!(@_BODY config ($($parm in $strategy),+) [] $body)
     } };
 
     ($config:expr, move |($($parm:pat in $strategy:expr),+ $(,)?)| $body:expr) => { {
-        let mut config = $config.__sugar_to_owned();
+        let mut config = $crate::test_runner::contextualize_config($config.__sugar_to_owned());
         $crate::sugar::force_no_fork(&mut config);
         $crate::proptest_helper!(@_BODY config ($($parm in $strategy),+) [move] $body)
     } };
 
     ($config:expr, |($($arg:tt)+)| $body:expr) => { {
-        let mut config = $config.__sugar_to_owned();
+        let mut config = $crate::test_runner::contextualize_config($config.__sugar_to_owned());
         $crate::sugar::force_no_fork(&mut config);
         $crate::proptest_helper!(@_BODY2 config ($($arg)+) [] $body);
     } };
 
     ($config:expr, move |($($arg:tt)+)| $body:expr) => { {
-        let mut config = $config.__sugar_to_owned();
+        let mut config = $crate::test_runner::contextualize_config($config.__sugar_to_owned());
         $crate::sugar::force_no_fork(&mut config);
         $crate::proptest_helper!(@_BODY2 config ($($arg)+) [move] $body);
     } };

diff --git a/proptest/src/test_runner/config.rs b/proptest/src/test_runner/config.rs
@@ -49,8 +49,10 @@ const RNG_ALGORITHM: &str = "PROPTEST_RNG_ALGORITHM";
 const DISABLE_FAILURE_PERSISTENCE: &str =
     "PROPTEST_DISABLE_FAILURE_PERSISTENCE";
 
+/// Override the config fields from environment variables, if any are set.
+/// Without the `std` feature this function returns config unchanged.
 #[cfg(feature = "std")]
-fn contextualize_config(mut result: Config) -> Config {
+pub fn contextualize_config(mut result: Config) -> Config {
     fn parse_or_warn<T: FromStr + fmt::Display>(
         src: &OsString,
         dst: &mut T,
@@ -141,8 +143,9 @@ fn contextualize_config(mut result: Config) -> Config {
     result
 }
 
+/// Without the `std` feature this function returns config unchanged.
 #[cfg(not(feature = "std"))]
-fn contextualize_config(result: Config) -> Config {
+pub fn contextualize_config(result: Config) -> Config {
     result
 }