[#92992] tests: Add rpc_pickle test module

Author: pkoscik

.ci.yml

@@ -78,6 +78,7 @@ api-test:
     - ./tests/test-order.sh
     - ./tests/test-overrides.sh
     - ./tests/test-plugins.sh
+    - ./tests/test-rpc-pickle.sh
   artifacts:
     paths:
       - srv/protoplaster/*

tests/custom_modules/rpc_pickle/__init__.py

@@ -0,0 +1,43 @@
+from protoplaster.tools.tools import trigger_on_remote
+from protoplaster.conf.module import ModuleName
+from rpc_pickle.utils import remote_pickle_echo, CustomPickleObject
+
+
+@ModuleName("rpc_pickle")
+class TestPickleRPC:
+
+    def configure(self):
+        assert hasattr(self, "dev"), "dev parameter required in yaml"
+
+    def test_custom_objects_rpc(self):
+        """
+        Test sending and receiving non-JSON serializable objects over RPC.
+        Sends: bytes, set
+        Receives: CustomPickleObject instance
+        """
+        test_bytes = b"\x00\xFF\xAAtest_bytes"
+        test_set = {"apple", "banana", 42}
+
+        print(f"[{self.dev}] Sending bytes and set to remote via RPC...")
+
+        result = trigger_on_remote(self.dev, remote_pickle_echo,
+                                   [test_bytes, test_set])
+
+        print(f"[{self.dev}] Received result: {result}")
+        print(f"[{self.dev}] Result type: {type(result)}")
+
+        assert isinstance(result, CustomPickleObject), \
+            f"Expected CustomPickleObject, got {type(result)}"
+
+        assert result.byte_data == test_bytes, \
+            f"Byte data mismatch: expected {test_bytes}, got {result.byte_data}"
+
+        assert result.set_data == test_set, \
+            f"Set data mismatch: expected {test_set}, got {result.set_data}"
+
+        print(
+            "SUCCESS: Pickle RPC serialization verified for bytes, sets, and custom classes!"
+        )
+
+    def name(self):
+        return f"Pickle RPC Serialization Test ({self.dev})"

tests/custom_modules/rpc_pickle/test.py

@@ -0,0 +1,24 @@
+class CustomPickleObject:
+    """
+    A custom class to test that pickle can reconstruct arbitrary
+    objects across the RPC calls.
+    """
+
+    def __init__(self, byte_data: bytes, set_data: set):
+        self.byte_data = byte_data
+        self.set_data = set_data
+
+    def __repr__(self):
+        return f"CustomPickleObject(bytes={self.byte_data}, set={self.set_data})"
+
+
+def remote_pickle_echo(byte_arg: bytes, set_arg: set) -> CustomPickleObject:
+    """
+    Executes on the remote device.
+    Verifies the types of incoming arguments and returns a custom class instance.
+    """
+    print(f"remote_pickle_echo received: bytes={byte_arg}, set={set_arg}")
+
+    assert isinstance(byte_arg, bytes), f"Expected bytes, got {type(byte_arg)}"
+    assert isinstance(set_arg, set), f"Expected set, got {type(set_arg)}"
+    return CustomPickleObject(byte_data=byte_arg, set_data=set_arg)

tests/custom_modules/rpc_pickle/utils.py

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+set -e
+mkdir -p /tmp/protoplaster/pickle_node/{tests,reports,artifacts}
+mkdir -p /tmp/protoplaster/pickle_main/{tests,reports,artifacts}
+OUTPUT_DIR="test_pickle_output"
+TEST_DIR="$( dirname "${BASH_SOURCE[0]}" )"
+mkdir -p "$OUTPUT_DIR"
+
+cat <<EOF > /tmp/protoplaster/pickle_devices.yaml
+node1: localhost:2140
+EOF
+
+cat <<EOF > /tmp/protoplaster/rpc-pickle-test.yml
+tests:
+  pickle_test:
+    - rpc_pickle:
+        dev: "node1"
+
+test-suites:
+  local:
+    tests:
+    - pickle_test
+EOF
+
+echo "Starting Protoplaster nodes for Pickle RPC test..."
+
+# Start Worker Node on port 2140
+protoplaster --test-dir /tmp/protoplaster/pickle_node/tests \
+             --reports-dir /tmp/protoplaster/pickle_node/reports \
+             --artifacts-dir /tmp/protoplaster/pickle_node/artifacts \
+             --custom-tests $TEST_DIR/custom_modules \
+             --port 2140 --dut &
+PID_WORKER=$!
+
+# Start Main Node on port 5001
+protoplaster --test-dir /tmp/protoplaster/pickle_main/tests \
+             --reports-dir /tmp/protoplaster/pickle_main/reports \
+             --artifacts-dir /tmp/protoplaster/pickle_main/artifacts \
+             --external-devices /tmp/protoplaster/pickle_devices.yaml \
+             --custom-tests $TEST_DIR/custom_modules \
+             --port 5001 --server &
+PID_MAIN=$!
+
+# Cleanup function
+function finish {
+  echo "Stopping servers..."
+  kill $PID_WORKER $PID_MAIN 2>/dev/null || true
+}
+trap finish EXIT
+
+# Wait for servers
+echo "Waiting for servers to start..."
+for port in 2140 5001; do
+  while ! curl -s http://localhost:$port/api/v1/configs > /dev/null; do
+    sleep 1
+  done
+done
+
+# Upload config
+CONFIG_FILE="rpc-pickle-test.yml"
+for port in 2140 5001; do
+  echo "Uploading config to port $port..."
+  NAME=$(curl -s -X POST http://localhost:$port/api/v1/configs -F "file=@/tmp/protoplaster/$CONFIG_FILE" | jq -r '.name')
+  if [ "$NAME" != "$CONFIG_FILE" ] ; then
+    echo "Config upload failed on port $port!"
+    exit 1
+  fi
+done
+
+# Trigger test run
+echo "Triggering Pickle RPC run..."
+curl -s -X POST http://localhost:5001/api/v1/test-runs \
+         -H "Content-Type: application/json" \
+         -d "{\"config_name\": \"$CONFIG_FILE\"}" > /dev/null
+
+sleep 2
+
+REPORT_FILE="$OUTPUT_DIR/pickle_test_report.csv"
+RUN_ID=$(curl -s http://localhost:5001/api/v1/test-runs | jq -r '.[-1].id')
+
+# Wait for finish
+STATUS=""
+while [ "$STATUS" != "finished" ] && [ "$STATUS" != "failed" ]; do
+    STATUS=$(curl -s http://localhost:5001/api/v1/test-runs/$RUN_ID | jq -r '.status')
+    sleep 1
+done
+
+# Get report
+curl -s http://localhost:5001/api/v1/test-runs/$RUN_ID/report > "$REPORT_FILE"
+
+if ! grep "test_custom_objects_rpc" "$REPORT_FILE" | grep -q "passed"; then
+    echo "FAILURE: Pickle RPC test did not pass!"
+    cat "$REPORT_FILE"
+    exit 1
+fi
+
+echo "SUCCESS: Pickle RPC test passed."
+echo "---------------------------------------------------"
+echo "Results saved in: $OUTPUT_DIR"
+echo "---------------------------------------------------"