🧪 Modify emission metrics test

Uses raw metrics names request to determine when emission metrics have sent to the server

Author: kzscisoft

pyproject.toml

@@ -97,7 +97,6 @@ testpaths = [
 markers = [
     "eco: tests for emission metrics",
     "client: tests of Simvue client",
-    "converters: tests for Simvue object converters",
     "dispatch: test data dispatcher",
     "run: test the simvue Run class",
     "utilities: test simvue utilities module",

simvue/api/objects/base.py

@@ -477,7 +477,7 @@ def read_only(self, is_read_only: bool) -> None:
         if not self._read_only:
             self._staging = self._get_local_staged()
 
-    def commit(self) -> None:
+    def commit(self) -> dict | None:
         """Send updates to the server, or if offline, store locally."""
         if self._read_only:
             raise AttributeError("Cannot commit object in 'read-only' mode")
@@ -489,22 +489,26 @@ def commit(self) -> None:
             self._cache()
             return
 
+        _response: dict | None = None
+
         # Initial commit is creation of object
         # if staging is empty then we do not need to use PUT
         if not self._identifier or self._identifier.startswith("offline_"):
             self._logger.debug(
                 f"Posting from staged data for {self._label} '{self.id}': {self._staging}"
             )
-            self._post(**self._staging)
+            _response = self._post(**self._staging)
         elif self._staging:
             self._logger.debug(
                 f"Pushing updates from staged data for {self._label} '{self.id}': {self._staging}"
             )
-            self._put(**self._staging)
+            _response = self._put(**self._staging)
 
         # Clear staged changes
         self._clear_staging()
 
+        return _response
+
     @property
     def id(self) -> str | None:
         """The identifier for this object if applicable.

simvue/run.py

@@ -478,14 +478,14 @@ def _dispatch_callback(
                     offline=self._user_config.run.mode == "offline",
                     events=buffer,
                 )
-                _events.commit()
+                return _events.commit()
             else:
                 _metrics = Metrics.new(
                     run=self.id,
                     offline=self._user_config.run.mode == "offline",
                     metrics=buffer,
                 )
-                _metrics.commit()
+                return _metrics.commit()
 
         return _dispatch_callback
 

tests/conftest.py

@@ -53,7 +53,7 @@ def clear_out_files() -> None:
     for file_obj in out_files:
         file_obj.unlink()
 
-        
+
 @pytest.fixture()
 def offline_cache_setup(monkeypatch: monkeypatch.MonkeyPatch):
     # Will be executed before test
@@ -63,7 +63,8 @@ def offline_cache_setup(monkeypatch: monkeypatch.MonkeyPatch):
     # Will be executed after test
     cache_dir.cleanup()
     monkeypatch.setenv("SIMVUE_OFFLINE_DIRECTORY", None)
-    
+
+
 @pytest.fixture
 def mock_co2_signal(monkeypatch: monkeypatch.MonkeyPatch) -> dict[str, dict | str]:
     _mock_data = {
@@ -100,7 +101,7 @@ def _mock_location_info(self) -> None:
 
     monkeypatch.setattr(requests, "get", _mock_get)
     monkeypatch.setattr(sv_eco.APIClient, "_get_user_location_info", _mock_location_info)
-    
+
     _fetch = sv_cfg.SimvueConfiguration.fetch
     @classmethod
     def _mock_fetch(cls, *args, **kwargs) -> sv_cfg.SimvueConfiguration:

tests/functional/test_run_class.py

@@ -2,6 +2,7 @@
 import logging
 import os
 import pytest
+import requests
 import pytest_mock
 import time
 import typing
@@ -53,11 +54,20 @@ def test_check_run_initialised_decorator() -> None:
 @pytest.mark.run
 @pytest.mark.eco
 @pytest.mark.online
-def test_run_with_emissions_online(speedy_heartbeat, mock_co2_signal, create_plain_run) -> None:
+def test_run_with_emissions_online(speedy_heartbeat, mock_co2_signal, create_plain_run: tuple[sv_run.Run, ...], mocker) -> None:
     run_created, _ = create_plain_run
+    metric_interval = 1
     run_created._user_config.eco.co2_signal_api_token = "test_token"
-    run_created.config(enable_emission_metrics=True, system_metrics_interval=1)
-    time.sleep(5)
+    run_created.config(enable_emission_metrics=True, system_metrics_interval=metric_interval)
+    spy = mocker.spy(run_created, "_get_internal_metrics")
+    while (
+        "sustainability.emissions.total" not in requests.get(
+            url=f"{run_created._user_config.server.url}/metrics/names",
+            headers=run_created._headers,
+            params={"runs": json.dumps([run_created.id])}).json()
+        and spy.call_count < 4
+    ):
+        time.sleep(metric_interval)
     _run = RunObject(identifier=run_created.id)
     _metric_names = [item[0] for item in _run.metrics]
     client = sv_cl.Client()
@@ -75,7 +85,7 @@ def test_run_with_emissions_online(speedy_heartbeat, mock_co2_signal, create_pla
         # Check that total = previous total + latest delta
         _total_values = _metric_values[_total_metric_name].tolist()
         _delta_values = _metric_values[_delta_metric_name].tolist()
-        assert len(_total_values) > 1
+        assert len(_total_values) == spy.call_count
         for i in range(1, len(_total_values)):
             assert _total_values[i] == _total_values[i - 1] + _delta_values[i]