Use test name for tag via fixture and add CI tag if relevant

Author: kzscisoft

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_run_class.py

@@ -64,8 +64,6 @@ def test_log_metrics(
         retention_period="1 hour",
     )
 
-    run.update_tags(["simvue_client_unit_tests", "test_log_metrics"])
-
     # Speed up the read rate for this test
     run._dispatcher._max_buffer_size = 10
     run._dispatcher._max_read_rate *= 10
@@ -110,31 +108,27 @@ def test_log_metrics(
 def test_log_metrics_offline(create_test_run_offline: tuple[sv_run.Run, dict]) -> None:
     METRICS = {"a": 10, "b": 1.2, "c": 2}
     run, _ = create_test_run_offline
-    run.update_tags(["simvue_client_unit_tests", "test_log_metrics"])
     run.log_metrics(METRICS)
 
 
 @pytest.mark.run
 def test_log_events(create_test_run: tuple[sv_run.Run, dict]) -> None:
     EVENT_MSG = "Hello world!"
     run, _ = create_test_run
-    run.update_tags(["simvue_client_unit_tests", "test_log_events"])
     run.log_event(EVENT_MSG)
 
 
 @pytest.mark.run
 def test_log_events_offline(create_test_run_offline: tuple[sv_run.Run, dict]) -> None:
     EVENT_MSG = "Hello world!"
     run, _ = create_test_run_offline
-    run.update_tags(["simvue_client_unit_tests", "test_log_events"])
     run.log_event(EVENT_MSG)
 
 
 @pytest.mark.run
 def test_update_metadata(create_test_run: tuple[sv_run.Run, dict]) -> None:
     METADATA = {"a": 10, "b": 1.2, "c": "word"}
     run, _ = create_test_run
-    run.update_tags(["simvue_client_unit_tests", "test_update_metadata"])
     run.update_metadata(METADATA)
 
 
@@ -144,7 +138,6 @@ def test_update_metadata_offline(
 ) -> None:
     METADATA = {"a": 10, "b": 1.2, "c": "word"}
     run, _ = create_test_run_offline
-    run.update_tags(["simvue_client_unit_tests", "test_update_metadata"])
     run.update_metadata(METADATA)