Enable skipping network-based tests.

This commit works off of an environmental variable called
'FASTSIM_DISABLE_NETWORK_TESTS'. If this variable is set
(regardless of the value), then networking tests will be
skipped. Within the code, the environment variable is
referenced via the constant NETWORK_TEST_DISABLE_ENV_VAR_NAME.

If 'FASTSIM_DISABLE_NETWORK_TESTS' is set, the test will print
to console and exit (i.e., it will show as passing). A user
will need to run `cargo test -- --nocapture` to see the print
statements that the test has been skipped.

.github/workflows/tests.yaml

@@ -18,6 +18,7 @@ jobs:
 
       env:
         PYTHON: ${{ matrix.python-version }}
+        FASTSIM_DISABLE_NETWORK_TESTS: 1
       steps:
       - uses: actions/checkout@v3
 

rust/fastsim-core/src/utils.rs

@@ -694,6 +694,8 @@ pub use array_wrappers::*;
 #[cfg(test)]
 mod tests {
     use super::*;
+    use crate::vehicle_utils::NETWORK_TEST_DISABLE_ENV_VAR_NAME;
+    use std::env;
 
     #[test]
     fn test_diff() {
@@ -867,6 +869,10 @@ mod tests {
 
     #[test]
     fn test_clear_cache() {
+        if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+            println!("SKIPPING: test_clear_cache");
+            return;
+        }
         let temp_sub_dir = tempfile::TempDir::new_in(create_project_subdir("").unwrap()).unwrap();
         let sub_dir_path = temp_sub_dir.path().to_str().unwrap();
         let still_exists_before = std::fs::metadata(sub_dir_path).is_ok();

rust/fastsim-core/src/vehicle_import.rs

@@ -337,7 +337,7 @@ pub fn get_options_for_year_make_model(
 #[cfg_attr(feature = "pyo3", pyfunction)]
 pub fn get_vehicle_data_for_id(
     id: i32,
-    year: &str, 
+    year: &str,
     cache_url: Option<String>,
     data_dir: Option<String>,
 ) -> anyhow::Result<VehicleDataFE> {
@@ -348,16 +348,21 @@ pub fn get_vehicle_data_for_id(
         h.insert(y);
         h
     };
-    let ddpath = data_dir.and_then(|dd| Some(PathBuf::from(dd))).unwrap_or(create_project_subdir("fe_label_data")?);
+    let ddpath = data_dir
+        .and_then(|dd| Some(PathBuf::from(dd)))
+        .unwrap_or(create_project_subdir("fe_label_data")?);
     let cache_url = cache_url.unwrap_or_else(get_default_cache_url);
-    populate_cache_for_given_years_if_needed(ddpath.as_path(), &ys, &cache_url).with_context(|| format!("Unable to load or download cache data from {cache_url}"))?;
+    populate_cache_for_given_years_if_needed(ddpath.as_path(), &ys, &cache_url)
+        .with_context(|| format!("Unable to load or download cache data from {cache_url}"))?;
     let emissions_data = load_emissions_data_for_given_years(ddpath.as_path(), &ys)?;
     let fegov_data_by_year =
         load_fegov_data_for_given_years(ddpath.as_path(), &emissions_data, &ys)?;
-    let fegov_db = fegov_data_by_year.get(&y).context(format!("Could not get fueleconomy.gov data from year {y}"))?;
+    let fegov_db = fegov_data_by_year
+        .get(&y)
+        .context(format!("Could not get fueleconomy.gov data from year {y}"))?;
     for item in fegov_db.iter() {
         if item.id == id {
-            return Ok(item.clone())
+            return Ok(item.clone());
         }
     }
     bail!("Could not find ID in data {id}");
@@ -1498,6 +1503,8 @@ fn extract_file_from_zip(
 #[cfg(test)]
 mod tests {
     use super::*;
+    use crate::vehicle_utils::NETWORK_TEST_DISABLE_ENV_VAR_NAME;
+    use std::env;
 
     #[test]
     fn test_create_new_vehicle_from_input_data() {
@@ -1612,6 +1619,10 @@ mod tests {
 
     #[test]
     fn test_get_options_for_year_make_model() {
+        if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+            println!("SKIPPING: test_get_options_for_year_make_model");
+            return;
+        }
         let year = String::from("2020");
         let make = String::from("Toyota");
         let model = String::from("Corolla");
@@ -1621,6 +1632,10 @@ mod tests {
 
     #[test]
     fn test_import_robustness() {
+        if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+            println!("SKIPPING: test_import_robustness");
+            return;
+        }
         // Ensure 2019 data is cached
         let ddpath = create_project_subdir("fe_label_data").unwrap();
         let model_year = 2019;
@@ -1691,6 +1706,10 @@ mod tests {
 
     #[test]
     fn test_get_options_for_year_make_model_for_specified_cacheurl_and_data_dir() {
+        if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+            println!("SKIPPING: test_get_options_for_year_make_model_for_specified_cacheurl_and_data_dir");
+            return;
+        }
         let year = String::from("2020");
         let make = String::from("Toyota");
         let model = String::from("Corolla");

rust/fastsim-core/src/vehicle_utils.rs

@@ -21,6 +21,8 @@ use crate::simdrive::RustSimDrive;
 #[cfg(feature = "default")]
 use crate::vehicle::RustVehicle;
 
+pub const NETWORK_TEST_DISABLE_ENV_VAR_NAME: &str = "FASTSIM_DISABLE_NETWORK_TESTS";
+
 #[allow(non_snake_case)]
 #[cfg_attr(feature = "pyo3", pyfunction)]
 #[allow(clippy::too_many_arguments)]
@@ -311,6 +313,7 @@ pub fn fetch_github_list(repo_url: Option<String>) -> anyhow::Result<Vec<String>
 #[cfg(test)]
 mod tests {
     use super::*;
+    use std::env;
 
     #[test]
     fn test_get_error_val() {
@@ -357,6 +360,10 @@ mod tests {
     // there's any way to ensure the function succeeds 100% of the time.
     #[test]
     fn test_fetch_github_list() {
+        if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+            println!("SKIPPING: test_fetch_github_list");
+            return;
+        }
         let list = fetch_github_list(Some(
             "https://api.github.com/repos/NREL/fastsim-vehicles/contents".to_owned(),
         ))

rust/fastsim-core/tests/integration-tests.rs

@@ -1,6 +1,8 @@
+use std::env;
 use std::path::Path;
 
 use fastsim_core::traits::*;
+use fastsim_core::vehicle_utils::NETWORK_TEST_DISABLE_ENV_VAR_NAME;
 use fastsim_core::*;
 
 const REFERENCE_VEHICLE: &str = include_str!("assets/1110_2022_Tesla_Model_Y_RWD_opt45017.yaml");
@@ -38,6 +40,10 @@ fn test_to_cache() {
 
 #[test]
 fn test_url_to_cache() {
+    if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+        println!("SKIPPING: test_url_to_cache()");
+        return;
+    }
     utils::url_to_cache("https://raw.githubusercontent.com/NREL/fastsim-vehicles/main/assets/2022_Tesla_Model_Y_RWD_example.yaml", "vehicles").unwrap();
     let data_subdirectory = utils::create_project_subdir("vehicles").unwrap();
     let file_path = data_subdirectory.join("2022_Tesla_Model_Y_RWD_example.yaml");
@@ -51,6 +57,10 @@ fn test_url_to_cache() {
 
 #[test]
 fn test_from_github_or_url() {
+    if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+        println!("SKIPPING: test_from_github_or_url()");
+        return;
+    }
     let mut comparison_vehicle = vehicle::RustVehicle::from_yaml(REFERENCE_VEHICLE, false).unwrap();
     comparison_vehicle.doc = Some("Vehicle from https://raw.githubusercontent.com/NREL/fastsim-vehicles/main/assets/2022_Tesla_Model_Y_RWD_example.yaml".to_owned());
     // test no url provided
@@ -77,6 +87,10 @@ fn test_from_github_or_url() {
 
 #[test]
 fn test_from_url() {
+    if env::var(NETWORK_TEST_DISABLE_ENV_VAR_NAME).is_ok() {
+        println!("SKIPPING: test_from_url()");
+        return;
+    }
     let vehicle = vehicle::RustVehicle::from_url("https://raw.githubusercontent.com/NREL/fastsim-vehicles/main/assets/2022_Tesla_Model_Y_RWD_example.yaml", false).unwrap();
     let mut comparison_vehicle = vehicle::RustVehicle::from_yaml(REFERENCE_VEHICLE, false).unwrap();
     comparison_vehicle.doc = Some("Vehicle from https://raw.githubusercontent.com/NREL/fastsim-vehicles/main/assets/2022_Tesla_Model_Y_RWD_example.yaml".to_owned());