Use a default name constant

Author: jacomago

server/tests/client_checks.py

@@ -11,6 +11,7 @@
 INACTIVE_PROPERTY = {"name": "pvStatus", "owner": "admin", "value": "Inactive", "channels": []}
 MAX_WAIT_SECONDS = 180
 TIME_PERIOD_INCREMENT = 2
+DEFAULT_CHANNEL_NAME = "IOC1-1:ai:archive"
 
 
 def channel_match(channel0, channel1, properties_to_match: list[str]):

server/tests/test_bash_ioc.py

@@ -7,7 +7,13 @@
 from docker import DockerClient
 from docker.models.containers import Container
 
-from .client_checks import INACTIVE_PROPERTY, check_channel_property, create_client_and_wait, wait_for_sync
+from .client_checks import (
+    DEFAULT_CHANNEL_NAME,
+    INACTIVE_PROPERTY,
+    check_channel_property,
+    create_client_and_wait,
+    wait_for_sync,
+)
 from .docker import ComposeFixtureFactory
 
 LOG: logging.Logger = logging.getLogger(__name__)
@@ -54,29 +60,28 @@ def test_remove_property(self, setup_compose: DockerCompose) -> None:  # noqa: F
 
         # Check ioc1-1 has ai:archive with info tag "archive"
         LOG.debug('Checking ioc1-1 has ai:archive with info tag "archive"')
-        archive_channel_name = "IOC1-1:ai:archive"
-        archive_channel = cf_client.find(name=archive_channel_name)
+        channel = cf_client.find(name=DEFAULT_CHANNEL_NAME)
 
-        def get_len_archive_properties(archive_channel):
-            return len([prop for prop in archive_channel[0]["properties"] if prop["name"] == "archive"])
+        def get_len_archive_properties(channel):
+            return len([prop for prop in channel[0]["properties"] if prop["name"] == "archive"])
 
-        assert get_len_archive_properties(archive_channel) == 1
+        assert get_len_archive_properties(channel) == 1
 
         docker_ioc.stop()
         LOG.info("Waiting for channels to go inactive")
         assert wait_for_sync(
             cf_client,
-            lambda cf_client: check_channel_property(cf_client, name=archive_channel_name, prop=INACTIVE_PROPERTY),
+            lambda cf_client: check_channel_property(cf_client, name=DEFAULT_CHANNEL_NAME, prop=INACTIVE_PROPERTY),
         )
         docker_ioc.start()
 
         docker_exec_new_command(docker_ioc, "DB_FILE=archiver_bug_test.db ./demo /ioc/st_bugtest.cmd")
         # Detach by not waiting for the thread to finish
 
         LOG.debug("ioc1-1 restart")
-        assert wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, name=archive_channel_name))
+        assert wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, name=DEFAULT_CHANNEL_NAME))
         LOG.debug("ioc1-1 has restarted and synced")
 
-        archive_channel = cf_client.find(name=archive_channel_name)
-        LOG.debug("archive channel: %s", archive_channel)
-        assert get_len_archive_properties(archive_channel) == 0
+        channel = cf_client.find(name=DEFAULT_CHANNEL_NAME)
+        LOG.debug("archive channel: %s", channel)
+        assert get_len_archive_properties(channel) == 0

server/tests/test_multiple_recceiver.py

@@ -5,7 +5,7 @@
 from channelfinder import ChannelFinderClient
 from testcontainers.compose import DockerCompose
 
-from .client_checks import create_client_and_wait
+from .client_checks import DEFAULT_CHANNEL_NAME, create_client_and_wait
 from .docker import ComposeFixtureFactory
 
 LOG: logging.Logger = logging.getLogger(__name__)
@@ -27,16 +27,16 @@ class TestMultipleRecceiver:
     def test_number_of_channels_and_channel_name(self, cf_client: ChannelFinderClient) -> None:
         channels = cf_client.find(name="*")
         assert len(channels) == EXPECTED_DEFAULT_CHANNEL_COUNT
-        assert channels[0]["name"] == "IOC1-1:ai:archive"
+        assert channels[0]["name"] == DEFAULT_CHANNEL_NAME
 
     # Smoke Test Default Properties
     def test_number_of_aliases_and_alais_property(self, cf_client: ChannelFinderClient) -> None:
         channels = cf_client.find(property=[("alias", "*")])
         assert len(channels) == 8
-        assert channels[0]["name"] == "IOC1-1:ai:archive:alias"
+        assert channels[0]["name"] == DEFAULT_CHANNEL_NAME + ":alias"
         assert {
             "name": "alias",
-            "value": "IOC1-1:ai:archive",
+            "value": DEFAULT_CHANNEL_NAME,
             "owner": "admin",
             "channels": [],
         } in channels[0]["properties"]

server/tests/test_single_ioc.py

@@ -7,6 +7,7 @@
 from testcontainers.compose import DockerCompose
 
 from .client_checks import (
+    DEFAULT_CHANNEL_NAME,
     INACTIVE_PROPERTY,
     channels_match,
     check_channel_property,
@@ -39,7 +40,7 @@ class TestRestartIOC:
     def test_channels_same_after_restart(self, setup_compose: DockerCompose, cf_client: ChannelFinderClient) -> None:  # noqa: F811
         channels_begin = cf_client.find(name="*")
         restart_container(setup_compose, "ioc1-1")
-        assert wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, "IOC1-1:ai:archive"))
+        assert wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, DEFAULT_CHANNEL_NAME))
         channels_end = cf_client.find(name="*")
         assert len(channels_begin) == len(channels_end)
         channels_match(channels_begin, channels_end, PROPERTIES_TO_MATCH)
@@ -52,12 +53,12 @@ def test_manual_channels_same_after_restart(
         test_property = {"name": "test_property", "owner": "testowner"}
         cf_client.set(properties=[test_property])
         test_property_value = test_property | {"value": "test_value"}
-        channels = cf_client.find(name="IOC1-1:ai:archive")
+        channels = cf_client.find(name=DEFAULT_CHANNEL_NAME)
         channels[0]["properties"] = [test_property_value]
         cf_client.set(property=test_property)
         channels_begin = cf_client.find(name="*")
         restart_container(setup_compose, "ioc1-1")
-        assert wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, "IOC1-1:ai:archive"))
+        assert wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, DEFAULT_CHANNEL_NAME))
         channels_end = cf_client.find(name="*")
         assert len(channels_begin) == len(channels_end)
         channels_match(channels_begin, channels_end, PROPERTIES_TO_MATCH + ["test_property"])
@@ -85,7 +86,7 @@ def test_status_property_works_after_cf_restart(
         # Assert
         shutdown_container(setup_compose, "ioc1-1")
         assert wait_for_sync(
-            cf_client, lambda cf_client: check_channel_property(cf_client, "IOC1-1:ai:archive", INACTIVE_PROPERTY)
+            cf_client, lambda cf_client: check_channel_property(cf_client, DEFAULT_CHANNEL_NAME, INACTIVE_PROPERTY)
         )
         channels_inactive = cf_client.find(property=[("iocName", "IOC1-1")])
         assert all(INACTIVE_PROPERTY in ch["properties"] for ch in channels_inactive)
@@ -109,7 +110,7 @@ def test_status_property_works_between_cf_down(
 
         # Assert
         assert wait_for_sync(
-            cf_client, lambda cf_client: check_channel_property(cf_client, "IOC1-1:ai:archive", INACTIVE_PROPERTY)
+            cf_client, lambda cf_client: check_channel_property(cf_client, DEFAULT_CHANNEL_NAME, INACTIVE_PROPERTY)
         )
         channels_inactive = cf_client.find(property=[("iocName", "IOC1-1")])
         assert all(INACTIVE_PROPERTY in ch["properties"] for ch in channels_inactive)
@@ -123,6 +124,6 @@ def test_move_ioc_host(
     ) -> None:
         channels_begin = cf_client.find(name="*")
         clone_container(setup_compose, "ioc1-1-new", host_name="ioc1-1")
-        wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, "IOC1-1:ai:archive"))
+        wait_for_sync(cf_client, lambda cf_client: check_channel_property(cf_client, DEFAULT_CHANNEL_NAME))
         channels_end = cf_client.find(name="*")
         assert len(channels_begin) == len(channels_end)