|
| 1 | +// Copyright (c) 2021-2025 RBB S.r.l |
| 2 | +// opensource@mintlayer.org |
| 3 | +// SPDX-License-Identifier: MIT |
| 4 | +// Licensed under the MIT License; |
| 5 | +// you may not use this file except in compliance with the License. |
| 6 | +// You may obtain a copy of the License at |
| 7 | +// |
| 8 | +// https://github.com/mintlayer/mintlayer-core/blob/master/LICENSE |
| 9 | +// |
| 10 | +// Unless required by applicable law or agreed to in writing, software |
| 11 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +// See the License for the specific language governing permissions and |
| 14 | +// limitations under the License. |
| 15 | + |
| 16 | +pub fn get_from_env(var_name: &str) -> Result<Option<String>, Error> { |
| 17 | + Ok(logging::get_from_env(var_name)?) |
| 18 | +} |
| 19 | + |
| 20 | +pub fn bool_from_env(var_name: &str) -> Result<Option<bool>, Error> { |
| 21 | + let Some(val) = get_from_env(var_name)? else { |
| 22 | + return Ok(None); |
| 23 | + }; |
| 24 | + |
| 25 | + let true_vals = ["1", "yes", "true"]; |
| 26 | + let false_vals = ["0", "no", "false"]; |
| 27 | + |
| 28 | + if true_vals.iter().any(|true_val| val.eq_ignore_ascii_case(true_val)) { |
| 29 | + Ok(Some(true)) |
| 30 | + } else if false_vals.iter().any(|false_val| val.eq_ignore_ascii_case(false_val)) { |
| 31 | + Ok(Some(false)) |
| 32 | + } else { |
| 33 | + Err(Error::NonBoolValue { |
| 34 | + var_name: var_name.to_owned(), |
| 35 | + value: val, |
| 36 | + }) |
| 37 | + } |
| 38 | +} |
| 39 | + |
| 40 | +#[derive(thiserror::Error, Debug, Clone, PartialEq, Eq)] |
| 41 | +pub enum Error { |
| 42 | + #[error("Env var {var_name}'s value '{value}' cannot be interpreted as a bool")] |
| 43 | + NonBoolValue { var_name: String, value: String }, |
| 44 | + |
| 45 | + #[error("Error obtaining env var value: {0}")] |
| 46 | + GetFromEnvError(#[from] logging::GetFromEnvError), |
| 47 | +} |
| 48 | + |
| 49 | +#[cfg(test)] |
| 50 | +mod tests { |
| 51 | + use super::*; |
| 52 | + |
| 53 | + #[test] |
| 54 | + fn test_bool_from_env() { |
| 55 | + let var_name = "TEST_BOOL_FROM_ENV_TEST_VAR_NAME"; |
| 56 | + |
| 57 | + let result = bool_from_env(var_name); |
| 58 | + assert_eq!(result, Ok(None)); |
| 59 | + |
| 60 | + let true_vals = ["1", "yes", "yEs", "true", "TruE"]; |
| 61 | + let false_vals = ["0", "no", "nO", "false", "fALSE"]; |
| 62 | + let bad_vals = ["2", "noo", "yess"]; |
| 63 | + |
| 64 | + for val in true_vals { |
| 65 | + std::env::set_var(var_name, val); |
| 66 | + let result = bool_from_env(var_name); |
| 67 | + assert_eq!(result, Ok(Some(true))); |
| 68 | + } |
| 69 | + |
| 70 | + for val in false_vals { |
| 71 | + std::env::set_var(var_name, val); |
| 72 | + let result = bool_from_env(var_name); |
| 73 | + assert_eq!(result, Ok(Some(false))); |
| 74 | + } |
| 75 | + |
| 76 | + for val in bad_vals { |
| 77 | + std::env::set_var(var_name, val); |
| 78 | + let result = bool_from_env(var_name); |
| 79 | + assert_eq!( |
| 80 | + result, |
| 81 | + Err(Error::NonBoolValue { |
| 82 | + var_name: var_name.to_owned(), |
| 83 | + value: val.to_owned() |
| 84 | + }) |
| 85 | + ); |
| 86 | + } |
| 87 | + } |
| 88 | +} |
0 commit comments