Merge pull request #1056 from EnergySystemsModellingLab/add-more-tests

Add helpers for patching code and use in some new tests

Author: alexdewar

src/asset.rs

@@ -1295,9 +1295,11 @@ mod tests {
     use super::*;
     use crate::commodity::Commodity;
     use crate::fixture::{
-        assert_error, asset, process, process_activity_limits_map, process_flows_map,
-        process_parameter_map, region_id, svd_commodity, time_slice, time_slice_info,
+        assert_error, assert_patched_runs_ok_simple, assert_validate_fails_with_simple, asset,
+        process, process_activity_limits_map, process_flows_map, process_parameter_map, region_id,
+        svd_commodity, time_slice, time_slice_info,
     };
+    use crate::patch::FilePatch;
     use crate::process::{FlowType, Process, ProcessFlow, ProcessParameter};
     use crate::region::RegionID;
     use crate::time_slice::{TimeSliceID, TimeSliceInfo};
@@ -2018,4 +2020,53 @@ mod tests {
             Asset::new_candidate(process.into(), "GBR".into(), Capacity(1.0), 2020).unwrap();
         asset.decommission(2025, "");
     }
+
+    #[test]
+    fn commission_year_before_time_horizon() {
+        let processes_patch = FilePatch::new("processes.csv")
+            .with_deletion("GASDRV,Dry gas extraction,all,GASPRD,2020,2040,1.0")
+            .with_addition("GASDRV,Dry gas extraction,all,GASPRD,1980,2040,1.0");
+
+        // Check we can run model with asset commissioned before time horizon (simple starts in
+        // 2020)
+        let patches = vec![
+            processes_patch.clone(),
+            FilePatch::new("assets.csv").with_addition("GASDRV,GBR,A0_GEX,4002.26,1980"),
+        ];
+        assert_patched_runs_ok_simple!(patches);
+
+        // This should fail if it is not one of the years supported by the process, though
+        let patches = vec![
+            processes_patch,
+            FilePatch::new("assets.csv").with_addition("GASDRV,GBR,A0_GEX,4002.26,1970"),
+        ];
+        assert_validate_fails_with_simple!(
+            patches,
+            "Agent A0_GEX has asset with commission year 1970, not within process GASDRV commission years: 1980..=2040"
+        );
+    }
+
+    #[test]
+    fn commission_year_after_time_horizon() {
+        let processes_patch = FilePatch::new("processes.csv")
+            .with_deletion("GASDRV,Dry gas extraction,all,GASPRD,2020,2040,1.0")
+            .with_addition("GASDRV,Dry gas extraction,all,GASPRD,2020,2050,1.0");
+
+        // Check we can run model with asset commissioned after time horizon (simple ends in 2040)
+        let patches = vec![
+            processes_patch.clone(),
+            FilePatch::new("assets.csv").with_addition("GASDRV,GBR,A0_GEX,4002.26,2050"),
+        ];
+        assert_patched_runs_ok_simple!(patches);
+
+        // This should fail if it is not one of the years supported by the process, though
+        let patches = vec![
+            processes_patch,
+            FilePatch::new("assets.csv").with_addition("GASDRV,GBR,A0_GEX,4002.26,2060"),
+        ];
+        assert_validate_fails_with_simple!(
+            patches,
+            "Agent A0_GEX has asset with commission year 2060, not within process GASDRV commission years: 2020..=2050"
+        );
+    }
 }

src/fixture.rs

@@ -62,8 +62,32 @@ macro_rules! patch_and_validate_simple {
         })()
     }};
 }
-// Currently unused outside this file
-// pub(crate) use patch_and_validate_simple;
+pub(crate) use patch_and_validate_simple;
+
+/// Check whether validation succeeds for simple example with patches
+macro_rules! assert_validate_ok_simple {
+    ($file_patches:expr) => {
+        assert!(crate::fixture::patch_and_validate_simple!($file_patches).is_ok())
+    };
+}
+pub(crate) use assert_validate_ok_simple;
+
+/// Check whether validation fails with specific message
+macro_rules! assert_validate_fails_with_simple {
+    ($file_patches:expr, $expected_msg:expr) => {
+        let result = crate::fixture::patch_and_validate_simple!($file_patches);
+        let msg = result
+            .unwrap_err()
+            .chain()
+            .skip(1)
+            .next()
+            .unwrap()
+            .to_string();
+
+        assert_eq!(msg, $expected_msg);
+    };
+}
+pub(crate) use assert_validate_fails_with_simple;
 
 /// Check whether the simple example runs successfully after applying file patches
 macro_rules! patch_and_run_simple {
@@ -79,8 +103,15 @@ macro_rules! patch_and_run_simple {
         })()
     }};
 }
-// Currently unused outside this file
-// pub(crate) use patch_and_run_simple;
+pub(crate) use patch_and_run_simple;
+
+/// Check whether the simple example runs successfully after applying file patches
+macro_rules! assert_patched_runs_ok_simple {
+    ($file_patches:expr) => {
+        assert!(crate::fixture::patch_and_run_simple!($file_patches).is_ok())
+    };
+}
+pub(crate) use assert_patched_runs_ok_simple;
 
 #[fixture]
 pub fn region_id() -> RegionID {

src/input/process/flow.rs

@@ -338,7 +338,11 @@ fn validate_secondary_flows(
 mod tests {
     use super::*;
     use crate::commodity::Commodity;
-    use crate::fixture::{assert_error, process, sed_commodity, svd_commodity};
+    use crate::fixture::{
+        assert_error, assert_validate_fails_with_simple, assert_validate_ok_simple, process,
+        sed_commodity, svd_commodity,
+    };
+    use crate::patch::FilePatch;
     use crate::process::{FlowType, Process, ProcessFlow, ProcessMap};
     use crate::units::{FlowPerActivity, MoneyPerFlow};
     use indexmap::IndexMap;
@@ -518,4 +522,53 @@ mod tests {
         validate_flows_and_update_primary_output(&mut processes, &flows_map, &milestone_years)
             .unwrap();
     }
+
+    #[test]
+    fn flows_different_direction_different_years() {
+        let patch = FilePatch::new("process_flows.csv")
+            .with_deletion("GASPRC,GASPRD,all,all,-1.05,fixed,")
+            .with_addition("GASPRC,GASPRD,all,2020;2030,-1.05,fixed,")
+            .with_addition("GASPRC,GASPRD,all,2040,1.05,fixed,");
+        assert_validate_fails_with_simple!(
+            vec![patch],
+            "Flow of commodity GASPRD in region GBR for process GASPRC behaves as input or output in different years."
+        );
+    }
+
+    #[test]
+    fn missing_flow() {
+        let patch = FilePatch::new("process_flows.csv")
+            .with_deletion("GASPRC,GASPRD,all,all,-1.05,fixed,")
+            .with_addition("GASPRC,GASPRD,all,2020;2030,-1.05,fixed,");
+        assert_validate_fails_with_simple!(
+            vec![patch],
+            "Flow of commodity GASPRD in region GBR for process GASPRC does not cover all milestone years within the process range of activity."
+        );
+    }
+
+    #[test]
+    fn coeff_zero() {
+        let patch = FilePatch::new("process_flows.csv")
+            .with_deletion("GASPRC,GASPRD,all,all,-1.05,fixed,")
+            .with_addition("GASPRC,GASPRD,all,2020;2030,-1.05,fixed,")
+            .with_addition("GASPRC,GASPRD,all,2040,0,fixed,");
+        assert_validate_ok_simple!(vec![patch]);
+    }
+
+    #[test]
+    fn flows_not_needed_before_time_horizon() {
+        // NB: Time horizon starts at 2020 for simple example
+        //
+        // Flows are only needed for milestone years. Check that users can omit them for
+        // non-milestone years.
+        let patches = vec![
+            FilePatch::new("processes.csv")
+                .with_deletion("GASDRV,Dry gas extraction,all,GASPRD,2020,2040,1.0")
+                .with_addition("GASDRV,Dry gas extraction,all,GASPRD,1980,2040,1.0"),
+            FilePatch::new("process_flows.csv")
+                .with_deletion("GASPRC,GASPRD,all,all,-1.05,fixed,")
+                .with_addition("GASPRC,GASPRD,all,2020;2030;2040,-1.05,fixed,"),
+        ];
+        assert_validate_ok_simple!(patches);
+    }
 }

src/patch.rs

@@ -110,7 +110,7 @@ impl ModelPatch {
 }
 
 /// Structure to hold patches for a model csv file.
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct FilePatch {
     /// The file that this patch applies to (e.g. "agents.csv")
     filename: String,