Enable CI tests for discovery node

.github/workflows/integration.yaml

@@ -4,6 +4,8 @@ on:
   push:
     tags:
       - '**'
+    branches:
+      - '**'
   workflow_dispatch:
 
 jobs:
@@ -148,13 +150,53 @@ jobs:
     env:
       IMAGE_NAME: ${{ github.repository }}
       REF_NAME: ${{ github.ref_name }}
+      DEVICE_ID: ${{'AHU-1'}}
     steps:
-      - name: Execute discovery node
+      - name: Setup Environment
+        run: |
+          sudo apt-get install moreutils
+          git clone https://github.com/faucetsdn/udmi_site_model.git
+          ln -s udmi_site_model/ site_model
+          (cd site_model; git log -n 1)
+          jq ".device_id = \"$DEVICE_ID\"" site_model/cloud_iot_config.json | sponge site_model/cloud_iot_config.json
+          jq . site_model/cloud_iot_config.json
+          docker network create udminet --subnet 192.168.99.0/24
+      - name: Start UDMIS container
+        run: |
+          export IMAGE_TAG=ghcr.io/$IMAGE_NAME:udmis-$REF_NAME
+          docker run $IMAGE_TAG cat bin/actualize > /tmp/actualize.sh
+          cat /tmp/actualize.sh && bash /tmp/actualize.sh
+      - name: Generate keys
+        run: |
+          docker run --net udminet --name keygen -v $(realpath site_model):/root/site_model \
+            ghcr.io/$IMAGE_NAME:validator-$REF_NAME bin/keygen CERT site_model/devices/$DEVICE_ID
+      - name: Registrar run
+        run: |
+          docker run --net udminet --name registrar -v $(realpath site_model):/root/site_model \
+            ghcr.io/$IMAGE_NAME:validator-$REF_NAME bin/registrar site_model/cloud_iot_config.json
+      - name: Start discoverynode
         run: |
           export IMAGE_TAG=ghcr.io/$IMAGE_NAME:misc-$REF_NAME
           # This currently fails (no config), but just check that it actually runs.
-          docker run $IMAGE_TAG discoverynode/bin/run | fgrep "Loading config"
-
+            docker run -d \
+              --net udminet \
+              -v $(realpath site_model):/var/site_model \
+              --name discoverynode \
+              $IMAGE_TAG \
+              bin/run /var/site_model //mqtt/udmis AHU-1 vendor.range=0x65,28179023,20231,,,,,,,,,,,,,,,,
+      - name: Sequencer run
+        run: |
+          docker run --net udminet --name sequencer -v $(realpath site_model):/root/site_model \
+            ghcr.io/$IMAGE_NAME:validator-$REF_NAME bin/sequencer site_model/cloud_iot_config.json \
+            scan_single_future
+      - name: Sequencer results
+        run: |
+          cat site_model/out/devices/$DEVICE_ID/results.md
+          [[ $(cat site_model/out/devices/$DEVICE_ID/results.md | grep -Ec ".*discovery.* pass") == 1 ]]
+      - name: Discoverynode logs
+        if: ${{ !cancelled() }}
+        run: docker logs discoverynode
+
   udmif:
     name: UDMIF unit tests
     runs-on: ubuntu-latest

.github/workflows/testing.yml

@@ -394,4 +394,4 @@ jobs:
           done
           ls -l var/tmp/pod_ready.txt 2>&1
       - name: Run Tests
-        run: misc/discoverynode/testing/e2e/test_local site_model || true
+        run: misc/discoverynode/testing/e2e/test_local site_model

misc/Dockerfile.misc

@@ -1,12 +1,11 @@
 FROM debian:12-slim
 
-WORKDIR /root
+COPY discoverynode/ /root/discoverynode/
+WORKDIR /root/discoverynode
 
 RUN apt-get update && \
-    apt-get install --no-install-suggests --no-install-recommends --yes python3-venv gcc libpython3-dev sudo && \
+    apt-get install --no-install-suggests --no-install-recommends --yes python3-venv gcc libpython3-dev sudo jq moreutils && \
     python3 -m venv venv && \
     venv/bin/pip install --upgrade pip setuptools wheel
 
-ADD discoverynode/src/requirements.txt /tmp/
-RUN venv/bin/pip install --disable-pip-version-check -r /tmp/requirements.txt
-ADD discoverynode/ discoverynode/
+RUN venv/bin/pip install --disable-pip-version-check -r src/requirements.txt

misc/discoverynode/bin/run

@@ -11,8 +11,8 @@ ROOT_DIR=$(realpath $(dirname $0)/..)
 BASE_CONFIG=$(realpath $ROOT_DIR/etc/base_config.json)
 TMP_CONFIG="/tmp/discoverynode_config.json"
 
-if [[ $# -ne 3 ]]; then
-  error Usage: $0 SITE_MODEL TARGET DEVICE_ID
+if (( $# -le 4 )); then
+  error Usage: $0 SITE_MODEL TARGET DEVICE_ID [OPTIONS]
 fi
 
 site_model=$1
@@ -65,12 +65,8 @@ EOF
   )
 
 elif [[ $provider == mqtt ]]; then
-  if [[ $project != localhost ]]; then
-    error only localhost supported
-  fi
-
   substitutions=$(cat <<EOF
-    .mqtt.host|="localhost" |
+    .mqtt.host|="$project" |
     .mqtt.port|=8883 |
     .mqtt.region|="$region" |
     .mqtt.project_id|="$project" |
@@ -88,6 +84,13 @@ else
   exit
 fi
 
+shift 3
 
 cat $TMP_CONFIG | jq -r  "$substitutions" | sponge $TMP_CONFIG
+
+for option in "$@"
+do
+  cat $TMP_CONFIG | jq -r ".${option/=/|=\"}\"" | sponge $TMP_CONFIG
+done
+
 $ROOT_DIR/venv/bin/python3 $ROOT_DIR/src/main.py --config_file=$TMP_CONFIG

misc/discoverynode/src/udmi/core.py

@@ -144,7 +144,7 @@ def enable_discovery(self,*,bacnet=True,vendor=True,ipv4=True,ether=True):
 
     if vendor:
       number_discovery = udmi.discovery.numbers.NumberDiscovery(
-          self.state, self.publish_discovery
+          self.state, self.publish_discovery, range=self.config.get("vendor", {}).get("range"),
       )
 
       self.add_config_route(

misc/discoverynode/src/udmi/discovery/numbers.py

@@ -11,9 +11,10 @@ class NumberDiscovery(discovery.DiscoveryController):
 
   scan_family = "vendor"
 
-  def __init__(self, state, publisher):
+  def __init__(self, state, publisher, *, range):
     self.cancelled = None
     self.task_thread = None
+    self.range = range
     super().__init__(state, publisher)
 
   def start_discovery(self):
@@ -26,13 +27,19 @@ def start_discovery(self):
   @discovery.catch_exceptions_to_state
   @discovery.main_task
   def discoverer(self):
-    for i in itertools.count(1):
+    if self.range:
+      iterator = self.range.split(",")
+    else:
+      iterator = itertools.count(1)
+
+    for i in iterator:
       if self.cancelled:
         return
-      result = DiscoveryEvent(
-          generation=self.generation, scan_family=self.scan_family, scan_addr=str(i)
-      )
-      self.publish(result)
+      if i:
+        result = DiscoveryEvent(
+            generation=self.generation, scan_family=self.scan_family, scan_addr=str(i)
+        )
+        self.publish(result)
       time.sleep(1)
 
   def stop_discovery(self):

misc/discoverynode/testing/e2e/test_local.py

@@ -109,7 +109,7 @@ def run(cmd: str) -> subprocess.CompletedProcess:
   execution_time_seconds = time.monotonic() - start
   info("completed with result code %s in %s seconds", str(result.returncode), str(execution_time_seconds))
   # print not log, so they are captured when there is a failure
-  print(result.stdout.decode("utf-8"))
+  # print(result.stdout.decode("utf-8"))
   return result
 
 
@@ -134,7 +134,9 @@ def _docker_devices(*, devices):
       )
 
   yield _docker_devices
+
   result = run("docker logs discoverynode-test-device1")
+  print("discovery node logs")
   print(result.stdout.decode("utf-8"))
   run(
       "docker ps -a | grep 'discoverynode-test-device' | awk '{print $1}' |"
@@ -278,17 +280,19 @@ def test_sequencer(new_site_model, docker_devices, discovery_node):
 
   run(f"bin/registrar {SITE_PATH} {TARGET}")
 
-  # Note: Start after running registrar preferably
+  # Note: Start after running registrar preferably.
   discovery_node(
       device_id="GAT-1",
       site_path=SITE_PATH
   )
 
   result = run(
-      f"bin/sequencer -v {SITE_PATH} {TARGET} GAT-1 single_scan_future"
+      f"bin/sequencer -v {SITE_PATH} {TARGET} GAT-1 scan_single_future"
   )
 
-  assert "RESULT pass discovery.scan single_scan_future" in str(result.stdout), "result is pass (note this test can be flakey)"
+  print("sequencer output")
+  print(result.stdout.decode("utf8"))
+  assert "RESULT pass discovery.scan scan_single_future" in str(result.stdout), "result is pass (note this test can be flakey)"
 
 
 @pytest.fixture