Improved ecoclient tests, changed token to Secretstr

Author: wk9874

simvue/eco/emissions_monitor.py

@@ -47,7 +47,7 @@ class CO2Monitor(pydantic.BaseModel):
     local_data_directory: pydantic.DirectoryPath
     intensity_refresh_interval: int | None | str
     co2_intensity: float | None
-    co2_signal_api_token: str | None
+    co2_signal_api_token: pydantic.SecretStr | None
     offline: bool = False
 
     def now(self) -> str:
@@ -252,7 +252,6 @@ def estimate_co2_emissions(
             )
             _current_co2_intensity = self._current_co2_data.data.carbon_intensity
             _co2_units = self._current_co2_data.carbon_intensity_units
-
         _process.gpu_percentage = gpu_percent
         _process.cpu_percentage = cpu_percent
         _previous_energy: float = _process.total_energy
@@ -271,8 +270,6 @@ def estimate_co2_emissions(
         # Measured value is in g/kWh, convert to kg/kWs
         _carbon_intensity_kgpws: float = _current_co2_intensity / (60 * 60 * 1e3)
 
-        _previous_emission: float = _process.co2_emission
-
         _process.co2_delta = (
             _process.power_usage * _carbon_intensity_kgpws * measure_interval
         )

tests/unit/test_ecoclient.py

@@ -55,7 +55,7 @@ def test_outdated_data_check(
         time.sleep(3)
         _ems_monitor.estimate_co2_emissions(**_measure_params)
 
-        assert _spy.call_count == 2 if refresh else 1, f"{_spy.call_count} != {2 if refresh else 1}"
+        assert _spy.call_count == (2 if refresh else 1), f"{_spy.call_count} != {2 if refresh else 1}"
 
 
 def test_co2_monitor_properties(mock_co2_signal) -> None:
@@ -65,20 +65,37 @@ def test_co2_monitor_properties(mock_co2_signal) -> None:
             thermal_design_power_per_gpu=130,
             local_data_directory=tempd,
             intensity_refresh_interval=None,
-            co2_intensity=None,
+            co2_intensity=40,
             co2_signal_api_token=None
         )   
         _measure_params = {
             "process_id": "test_co2_monitor_properties",
             "cpu_percent": 20,
             "gpu_percent": 40,
-            "measure_interval": 1
+            "measure_interval": 2
         }
+        
         _ems_monitor.estimate_co2_emissions(**_measure_params)
+
         assert _ems_monitor.current_carbon_intensity
+        assert _ems_monitor.n_cores_per_cpu == 4
         assert _ems_monitor.process_data["test_co2_monitor_properties"]
-        assert _ems_monitor.total_power_usage
-        assert _ems_monitor.total_co2_emission
-        assert _ems_monitor.total_co2_delta
-        assert _ems_monitor.total_energy
-        assert _ems_monitor.total_energy_delta
+        
+        # Will use this equation
+        # Power used = (TDP_cpu * cpu_percent / num_cores) + (TDP_gpu * gpu_percent)
+        assert _ems_monitor.total_power_usage == (80 * 0.2 * 1 / 4) + (130 * 0.4 * 1)
+        
+        # Energy used = power used * measure interval
+        assert _ems_monitor.total_energy == _ems_monitor.total_power_usage * 2
+        
+        # CO2 emission = energy * CO2 intensity
+        # Need to convert CO2 intensity from g/kWh to kg/kWs
+        # So divide by 1000 (g -> kg)
+        # And divide by 60*60 (kWh -> kws)
+        assert _ems_monitor.total_co2_emission == _ems_monitor.total_energy * 40 / (60*60*1000)
+        
+        _ems_monitor.estimate_co2_emissions(**_measure_params)
+        # Check delta is half of total, since we've now called this twice
+        assert _ems_monitor.total_co2_delta == _ems_monitor.total_co2_emission / 2
+        assert _ems_monitor.total_energy_delta == _ems_monitor.total_energy / 2
+