Automate testing info tag removal bug in recceiver

jacomago · jacomago · commit f6584ec0b4aa · 2025-03-20T15:49:21.000+01:00
Bug can be reproduced manually as follows

1. Create recceiver with infotag (X) set to be updated in channelfinder.
2. Add IOC with PV with infotag X set to A
3. Channelfinder has PV with X=A
4. Reboot recceiver with  infotag X removed
5. Channelfinder has PV with X=A still even after IOC update

Or by

1. Create recceiver with infotag (X) set to be updated in channelfinder.
2. Add IOC with PV with infotag X set to A
3. Channelfinder has PV with X=A
4. Reboot IOC with PV with infotag X removed
5. Channelfinder has PV with X=A still
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "server"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}
diff --git a/client/.dockerignore b/client/.dockerignore
@@ -13,3 +13,4 @@ configure/*.local
 
 *~
 .*.swp
+.ci
diff --git a/client/Dockerfile b/client/Dockerfile
@@ -50,8 +50,9 @@ RUN mv docker/RELEASE.local configure/RELEASE.local
 ENV EPICS_ROOT=/epics
 ENV EPICS_BASE=${EPICS_ROOT}/base
 RUN make
-WORKDIR /recsync/iocBoot/iocdemo
 
 FROM recsync-base AS ioc-runner
 
-CMD /recsync/bin/${EPICS_HOST_ARCH}/demo st.cmd
+WORKDIR /recsync/bin/${EPICS_HOST_ARCH}
+
+CMD ./demo /recsync/iocBoot/iocdemo/st.cmd
diff --git a/client/demoApp/Db/Makefile b/client/demoApp/Db/Makefile
@@ -11,7 +11,8 @@ include $(TOP)/configure/CONFIG
 # Create and install (or just install) into <top>/db
 # databases, templates, substitutions like this
 DB += somerecords.db
-
+DB += archive.db
+DB += archive_bugtest.db
 #----------------------------------------------------
 # If <anyname>.db template is not named <anyname>*.template add
 # <anyname>_template = <templatename>
diff --git a/client/demoApp/Db/archive_bugtest.db b/client/demoApp/Db/archive_bugtest.db
@@ -0,0 +1,10 @@
+
+record(ai, "$(P)ai:archive") {
+  info("test", "testing")
+}
+
+record(longout, "$(P)lo:archive") {
+  info("test", "testing")
+  info("hello", "world")
+  info("archive", "default")
+}
diff --git a/client/iocBoot/iocdemo/st.cmd b/client/iocBoot/iocdemo/st.cmd
@@ -26,5 +26,6 @@ addReccasterEnvVars("BUILDING")
 ## Load record instances
 dbLoadRecords("../../db/reccaster.db", "P=$(IOCSH_NAME):")
 dbLoadRecords("../../db/somerecords.db","P=$(IOCSH_NAME):")
+dbLoadRecords("../../db/archive.db", "P=$(IOCSH_NAME):")
 
 iocInit()
diff --git a/client/iocBoot/iocdemo/st_bugtest.cmd b/client/iocBoot/iocdemo/st_bugtest.cmd
@@ -0,0 +1,31 @@
+#!../../bin/linux-x86_64-debug/demo
+
+## You may have to change demo to something else
+## everywhere it appears in this file
+
+< envPaths
+
+## Register all support components
+dbLoadDatabase("../../dbd/demo.dbd",0,0)
+demo_registerRecordDeviceDriver(pdbbase)
+
+var(reccastTimeout, 5.0)
+var(reccastMaxHoldoff, 5.0)
+
+epicsEnvSet("IOCNAME", "$(IOCSH_NAME)")
+epicsEnvSet("ENGINEER", "myself")
+epicsEnvSet("LOCATION", "myplace")
+
+epicsEnvSet("CONTACT", "mycontact")
+epicsEnvSet("BUILDING", "mybuilding")
+epicsEnvSet("SECTOR", "mysector")
+
+addReccasterEnvVars("CONTACT", "SECTOR")
+addReccasterEnvVars("BUILDING")
+
+## Load record instances
+dbLoadRecords("../../db/reccaster.db", "P=$(IOCSH_NAME):")
+dbLoadRecords("../../db/somerecords.db","P=$(IOCSH_NAME):")
+dbLoadRecords("../../db/archive_bugtest.db", "P=$(IOCSH_NAME):")
+
+iocInit()
diff --git a/server/test-compose.yml b/server/test-compose.yml
@@ -1,3 +1,4 @@
+name: recceiver-test-compose
 services:
   cf:
     image: ghcr.io/channelfinder/channelfinderservice:master
@@ -42,8 +43,6 @@ services:
       interval: 10s
       timeout: 60s
       retries: 5
-    volumes:
-      - channelfinder-es-data:/usr/share/elasticsearch/data
 
   recc1:
     build: .
@@ -143,10 +142,6 @@ services:
         condition: service_healthy
         restart: true
 
-volumes:
-  channelfinder-es-data:
-    driver: local
-
 networks:
   net-2-cf:
     driver: bridge
diff --git a/server/test-remove-compose.yml b/server/test-remove-compose.yml
@@ -0,0 +1,88 @@
+name: recceiver-test-remove-compose
+services:
+  cf:
+    image: ghcr.io/channelfinder/channelfinderservice:master
+    hostname: cf
+    networks:
+      - net-2-cf
+    ports:
+      - "8080:8080"
+    depends_on:
+      elasticsearch:
+        condition: service_healthy
+        restart: true
+    environment:
+      ELASTICSEARCH_NETWORK_HOST: elasticsearch-cf
+      ELASTICSEARCH_QUERY_SIZE: 10000
+      demo_auth.enabled: true
+      demo_auth.users: admin
+      demo_auth.pwds: password
+      demo_auth.roles: ADMIN
+      EPICS_PVAS_INTF_ADDR_LIST: "0.0.0.0"
+      aa.enabled: false
+      logging.level.org.springframework.web: INFO
+    healthcheck:
+      test: curl -s -f http://cf:8080/ChannelFinder
+      interval: 10s
+      timeout: 60s
+      retries: 5
+
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:8.11.4
+    hostname: elasticsearch-cf
+    networks:
+      - net-2-cf
+    environment:
+      cluster.name: channelfinder
+      discovery.type: single-node
+      bootstrap.memory_lock: "true"
+      xpack.security.enabled: "false"
+      logger.level: WARN
+    healthcheck:
+      test: curl -s -f http://localhost:9200/_cluster/health
+      interval: 10s
+      timeout: 60s
+      retries: 5
+
+  recc1:
+    build: .
+    hostname: recc1
+    networks:
+      - net-0-recc-1
+      - net-2-cf
+    depends_on:
+      cf:
+        condition: service_healthy
+        restart: true
+    healthcheck:
+      test: netstat | grep cf
+      interval: 10s
+      timeout: 30s
+      retries: 3
+    volumes:
+      - type: bind
+        source: docker/config/cf1.conf
+        target: /home/recceiver/cf.conf
+        read_only: true
+      - type: bind
+        source: docker/config/cf1.conf
+        target: /home/recceiver/channelfinderapi.conf
+        read_only: true
+  ioc1-1:
+    build: ../client
+    hostname: ioc1-1
+    command: bash
+    tty: true
+    environment:
+      - IOCSH_NAME=IOC1-1
+    networks:
+      - net-0-recc-1
+    depends_on:
+      recc1:
+        condition: service_healthy
+        restart: true
+networks:
+  net-2-cf:
+    driver: bridge
+  net-0-recc-1:
+    driver: bridge
diff --git a/server/tests/__init__.py b/server/tests/__init__.py
@@ -0,0 +1,7 @@
+import logging
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    encoding="utf-8",
+)
diff --git a/server/tests/client_checks.py b/server/tests/client_checks.py
@@ -0,0 +1,74 @@
+import logging
+import time
+from typing import Callable
+
+from channelfinder import ChannelFinderClient
+from testcontainers.compose import DockerCompose
+
+LOG: logging.Logger = logging.getLogger(__name__)
+
+ACTIVE_PROPERTY = {"name": "pvStatus", "owner": "admin", "value": "Active", "channels": []}
+INACTIVE_PROPERTY = {"name": "pvStatus", "owner": "admin", "value": "Inactive", "channels": []}
+MAX_WAIT_SECONDS = 180
+TIME_PERIOD_INCREMENT = 2
+
+
+def channel_match(channel0, channel1, properties_to_match: list[str]):
+    if channel0["name"] != channel1["name"]:
+        assert False, f"Channel names do not match: {channel0['name']} != {channel1['name']}"
+    if channel0["owner"] != channel1["owner"]:
+        assert False, f"Channel owners do not match: {channel0['owner']} != {channel1['owner']}"
+    for prop in channel0["properties"]:
+        if prop["name"] in properties_to_match:
+            if prop not in channel1["properties"]:
+                assert False, f"Property {prop} not found in channel {channel1['name']}"
+    assert True
+
+
+def channels_match(channels_begin, channels_end, properties_to_match: list[str]):
+    for channel_index, channel in enumerate(channels_begin):
+        channel_match(channel, channels_end[channel_index], properties_to_match)
+
+
+def check_channel_count(cf_client: ChannelFinderClient, name="*", expected_channels=24):
+    channels = cf_client.find(name=name)
+    LOG.debug("Found %s channels", len(channels))
+    return len(channels) == expected_channels
+
+
+def check_channel_property(cf_client: ChannelFinderClient, name="*", prop=ACTIVE_PROPERTY):
+    channels = cf_client.find(name=name)
+    for channel in channels:
+        if prop not in channel["properties"]:
+            return False
+    return True
+
+
+def wait_for_sync(cf_client: ChannelFinderClient, check: Callable[[ChannelFinderClient], bool]) -> bool:
+    time_period_to_wait_seconds = 1
+    total_seconds_waited = 0
+    while total_seconds_waited < MAX_WAIT_SECONDS:
+        if check(cf_client):
+            return True
+        time.sleep(time_period_to_wait_seconds)
+        total_seconds_waited += time_period_to_wait_seconds
+        time_period_to_wait_seconds += TIME_PERIOD_INCREMENT
+    return False
+
+
+def create_client_and_wait(compose: DockerCompose, expected_channel_count=24) -> ChannelFinderClient:
+    LOG.info("Waiting for channels to sync")
+    cf_client = create_client_from_compose(compose)
+    assert wait_for_sync(
+        cf_client, lambda cf_client: check_channel_count(cf_client, expected_channels=expected_channel_count)
+    )
+    return cf_client
+
+
+def create_client_from_compose(compose: DockerCompose) -> ChannelFinderClient:
+    cf_host, cf_port = compose.get_service_host_and_port("cf")
+    cf_url = f"http://{cf_host if cf_host else 'localhost'}:{cf_port}/ChannelFinder"
+    # wait for channels to sync
+    LOG.info("CF URL: %s", cf_url)
+    cf_client = ChannelFinderClient(BaseURL=cf_url, username="admin", password="password")
+    return cf_client
diff --git a/server/tests/docker.py b/server/tests/docker.py
@@ -9,12 +9,12 @@
 LOG: logging.Logger = logging.getLogger(__name__)
 
 
-def test_compose() -> DockerCompose:
+def test_compose(compose_file="test-compose.yml") -> DockerCompose:
     current_path = pathlib.Path(__file__).parent.resolve()
 
     return DockerCompose(
         str(current_path.parent.resolve()),
-        compose_file_name=str(current_path.parent.joinpath("test-compose.yml").resolve()),
+        compose_file_name=str(current_path.parent.joinpath(compose_file).resolve()),
         build=True,
     )
 
@@ -40,3 +40,10 @@ def setup_compose():
     if LOG.level <= logging.DEBUG:
         fetch_containers_and_log_logs(compose)
     compose.stop()
+
+
+def restart_container(compose: DockerCompose, host_name: str) -> None:
+    container = compose.get_container(host_name)
+    docker_client = DockerClient()
+    docker_client.containers.get(container.ID).stop()
+    docker_client.containers.get(container.ID).start()
diff --git a/server/tests/test_e2e.py b/server/tests/test_e2e.py
diff --git a/server/tests/test_remove_property.py b/server/tests/test_remove_property.py
diff --git a/server/tests/test_restart.py b/server/tests/test_restart.py

Original file line number	Diff line number	Diff line change
`@@ -13,3 +13,4 @@ configure/*.local`
`13`	`13`
`14`	`14`	`*~`
`15`	`15`	`.*.swp`
	`16`	`+.ci`