Merge branch 'dev' into hotfix/add-missing-tests

Author: kzscisoft

.github/workflows/citation.yml

@@ -0,0 +1,23 @@
+name: Citation File Validation
+
+on:
+  push:
+    branches: [ "main", "dev", "hotfix/update-ci" ]
+  pull_request:
+    branches: [ "main", "dev", "hotfix/update-ci" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+    - name: Install Checker
+      run: python3 -m pip install cffconvert
+    - name: Check Citation File
+      run: cffconvert --validate

CITATION.cff

@@ -0,0 +1,44 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Simvue
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Andrew
+    family-names: Lahiff
+    affiliation: United Kingdom Atomic Energy Authority
+    orcid: 'https://orcid.org/0000-0002-2785-4116'
+  - given-names: Aby
+    family-names: Abraham
+    affiliation: United Kingdom Atomic Energy Authority
+  - given-names: Vignesh
+    family-names: Gopakumar
+    orcid: 'https://orcid.org/0000-0002-6773-1049'
+    affiliation: United Kingdom Atomic Energy Authority
+  - given-names: Kristian
+    family-names: Zarebski
+    affiliation: United Kingdom Atomic Energy Authority
+    orcid: 'https://orcid.org/0000-0002-6773-1049'
+  - given-names: Matthew
+    family-names: Field
+    affiliation: United Kingdom Atomic Energy Authority
+  - given-names: James
+    family-names: Panayis
+    affiliation: United Kingdom Atomic Energy Authority
+repository-code: 'https://github.com/simvue-io/client'
+url: 'https://simvue.io/'
+abstract: >-
+  Simvue allows users to organise and gain insights in simulations,
+  processing tasks and AI/ML training by capturing metadata and
+  data combined with real-time monitoring, logging and alerting.
+keywords:
+  - tracking
+  - monitoring
+  - metrics
+  - alerting
+  - simulation
+license: Apache-2.0

simvue/run.py

@@ -61,6 +61,22 @@
 logger = logging.getLogger(__name__)
 
 
+def check_run_initialised(
+    function: typing.Callable[..., typing.Any],
+) -> typing.Callable[..., typing.Any]:
+    def _wrapper(self: "Run", *args: typing.Any, **kwargs: typing.Any) -> typing.Any:
+        if not self._simvue:
+            raise RuntimeError(
+                "Simvue Run must be initialised before calling "
+                f"'{function.__name__}'"
+            )
+        return function(self, *args, **kwargs)
+
+    _wrapper.__name__ = f"{function.__name__}__init_locked"
+
+    return _wrapper
+
+
 class Run:
     """Track simulation details based on token and URL
 
@@ -823,6 +839,7 @@ def config(
 
         return True
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def update_metadata(self, metadata: dict[str, typing.Any]) -> bool:
@@ -848,6 +865,7 @@ def update_metadata(self, metadata: dict[str, typing.Any]) -> bool:
 
         return False
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def update_tags(self, tags: list[str]) -> bool:
@@ -868,6 +886,7 @@ def update_tags(self, tags: list[str]) -> bool:
 
         return False
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def log_event(self, message, timestamp: typing.Optional[str] = None) -> bool:
@@ -942,6 +961,7 @@ def _add_metrics_to_dispatch(
 
         return True
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def log_metrics(
@@ -960,6 +980,7 @@ def log_metrics(
         self._step += 1
         return add_dispatch
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def save_object(
@@ -1081,6 +1102,7 @@ def save_file(
         # Register file
         return self._simvue.save_file(data) is not None
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def save_directory(
@@ -1117,6 +1139,7 @@ def save_directory(
 
         return True
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def save_all(
@@ -1147,6 +1170,7 @@ def save_all(
 
         return True
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def set_status(
@@ -1216,6 +1240,7 @@ def close(self) -> bool:
 
         return True
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def set_folder_details(
@@ -1270,6 +1295,7 @@ def set_folder_details(
 
         return False
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def add_alerts(
@@ -1317,6 +1343,7 @@ def add_alerts(
 
         return False
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", None)
     @pydantic.validate_call
     def create_alert(
@@ -1478,6 +1505,7 @@ def create_alert(
 
         return alert_id
 
+    @check_run_initialised
     @skip_if_failed("_aborted", "_suppress_errors", False)
     @pydantic.validate_call
     def log_alert(

tests/functional/test_run_offline_folder.py

@@ -24,7 +24,7 @@ def test_basic_run_folder(self):
             pass
 
         name = "test-%s" % str(uuid.uuid4())
-        folder = "/test-%s" % str(uuid.uuid4())
+        folder = "/simvue_unit_testing"
         metadata = {str(uuid.uuid4()): 100 * random.random()}
         run = Run("offline")
         run.init(name, folder=folder)

tests/refactor/conftest.py

@@ -42,48 +42,53 @@ def log_messages(caplog):
 
 
 @pytest.fixture
-def create_test_run() -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
+def create_test_run(request) -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
     with sv_run.Run() as run:
-        yield run, setup_test_run(run, True)
+        yield run, setup_test_run(run, True, request)
 
 
 @pytest.fixture
-def create_test_run_offline(mocker: pytest_mock.MockerFixture) -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
+def create_test_run_offline(mocker: pytest_mock.MockerFixture, request) -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
     with tempfile.TemporaryDirectory() as temp_d:
         mocker.patch.object(simvue.utilities, "get_offline_directory", lambda *_: temp_d)
         with sv_run.Run("offline") as run:
-            yield run, setup_test_run(run, True)
+            yield run, setup_test_run(run, True, request)
 
 
 @pytest.fixture
-def create_plain_run() -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
+def create_plain_run(request) -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
     with sv_run.Run() as run:
-        yield run, setup_test_run(run, False)
+        yield run, setup_test_run(run, False, request)
 
 
 @pytest.fixture
-def create_plain_run_offline(mocker: pytest_mock.MockerFixture) -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
+def create_plain_run_offline(mocker: pytest_mock.MockerFixture, request) -> typing.Generator[typing.Tuple[sv_run.Run, dict], None, None]:
     with tempfile.TemporaryDirectory() as temp_d:
         mocker.patch.object(simvue.utilities, "get_offline_directory", lambda *_: temp_d)
         with sv_run.Run("offline") as run:
 
-            yield run, setup_test_run(run, False)
+            yield run, setup_test_run(run, False, request)
 
 
-def setup_test_run(run: sv_run.Run, create_objects: bool):
+def setup_test_run(run: sv_run.Run, create_objects: bool, request: pytest.FixtureRequest):
     fix_use_id: str = str(uuid.uuid4()).split('-', 1)[0]
     TEST_DATA = {
         "event_contains": "sent event",
         "metadata": {
             "test_engine": "pytest",
             "test_identifier": fix_use_id
         },
-        "folder": f"/simvue_unit_testing/{fix_use_id}"
+        "folder": f"/simvue_unit_testing/{fix_use_id}",
+        "tags": ["simvue_client_unit_tests", request.node.name]
     }
+
+    if os.environ.get("CI"):
+        TEST_DATA["tags"].append("ci")
+
     run.config(suppress_errors=False)
     run.init(
         name=f"test_run_{TEST_DATA['metadata']['test_identifier']}",
-        tags=["simvue_client_unit_tests"],
+        tags=TEST_DATA["tags"],
         folder=TEST_DATA["folder"],
         visibility="tenant",
         retention_period="1 hour"

tests/refactor/test_client.py

@@ -175,7 +175,6 @@ def test_run_deletion(create_test_run: tuple[sv_run.Run, dict]) -> None:
 @pytest.mark.client(depends=PRE_DELETION_TESTS)
 def test_runs_deletion(create_test_run: tuple[sv_run.Run, dict]) -> None:
     run, run_data = create_test_run
-    run.update_tags(["simvue_client_unit_tests", "test_runs_deletion"])
     run.close()
     client = svc.Client()
     assert len(client.delete_runs(run_data["folder"])) > 0
@@ -185,7 +184,6 @@ def test_runs_deletion(create_test_run: tuple[sv_run.Run, dict]) -> None:
 @pytest.mark.client(depends=PRE_DELETION_TESTS + ["test_runs_deletion"])
 def test_folder_deletion(create_test_run: tuple[sv_run.Run, dict]) -> None:
     run, run_data = create_test_run
-    run.update_tags(["simvue_client_unit_tests", "test_folder_deletion"])
     run.close()
     client = svc.Client()
     # This test is called last, one run created so expect length 1

tests/refactor/test_executor.py

@@ -8,14 +8,15 @@
 @pytest.mark.executor
 @pytest.mark.parametrize("successful", (True, False), ids=("successful", "failing"))
 def test_executor_add_process(
-    successful: bool
+    successful: bool,
+    request: pytest.FixtureRequest
 ) -> None:
     run = simvue.Run()
     completion_trigger = multiprocessing.Event()
     run.init(
         f"test_executor_{'success' if successful else 'fail'}",
-        tags=["simvue_client_unit_tests"],
-        folder="/simvue_unit_test_folder"
+        tags=["simvue_client_unit_tests", request.node.name],
+        folder="/simvue_unit_testing"
     )
 
     run.add_process(