[WebRTC] Align test scripts with test plan trickle ICE update (project-chip#41990)

* [WebRTC] Align with test plan trickle ICE update

* Update src/controller/python/matter/webrtc/browser_peer_connection.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Update src/controller/python/matter/webrtc/libdatachannel_peer_connection.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Update src/controller/python/matter/webrtc/libdatachannel_peer_connection.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Address gemini review comments

* Call set_remote_ice_candidates asyncrously

* Fix docstring return type mismatch

* Address gemini review comment

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: yufengwangca

src/controller/python/matter/webrtc/browser_peer_connection.py

@@ -120,7 +120,7 @@ async def set_remote_ice_candidates(self, remote_candidates: list[IceCandidate])
         """Sets the remote ICE candidates for the WebRTC peer connection.
 
         Args:
-            remote_candidates (list[str]): A list of remote ICE candidates to be set.
+            remote_candidates (list[IceCandidate]): A list of remote ICE candidates to be set.
         """
         # for candidate in remote_candidates:
         await self.set_remote_icecandidates(remote_candidates)
@@ -219,14 +219,14 @@ async def get_remote_answer(self, timeout_s: Optional[int] = None) -> tuple[int,
         return await self._remote_events[Events.ANSWER].get(timeout_s)
 
     async def get_remote_ice_candidates(self, timeout_s: Optional[int] = None) -> tuple[int, list[IceCandidate]]:
-        """Waits for a remote SDP answer to be received through a matter command.
+        """Waits for a list of remote ICE Candidates to be received through a matter command.
 
         Args:
-            timeout_s (Optional[int]): The maximum time in seconds to wait for a remote offer.
+            timeout_s (Optional[int]): The maximum time in seconds to wait for a list of remote candidates.
             If None, the function will wait indefinitely.
 
         Returns:
-            tuple[int, list[str]]: A tuple containing the session ID and list of ice candidate strings.
+            tuple[int, list[IceCandidate]]: A tuple containing the session ID and list of IceCandidate objects.
 
         Raises:
             asyncio.TimeoutError: If no remote offer is received within the specified timeout period.
@@ -324,5 +324,17 @@ def on_remote_answer(self, sessionId: int, answer_sdp: str) -> None:
         self._remote_events[Events.ANSWER].put((sessionId, answer_sdp))
 
     def on_remote_ice_candidates(self, sessionId: int, candidates: list[IceCandidate]) -> None:
-        """Callback function called when a remote ICE candidates are received through a matter command."""
+        """Callback function called when a remote ICE candidates are received through a matter command.
+
+        Implements trickle ICE by scheduling candidates to be applied to the peer connection.
+        Also stores them in the event queue for tests that may need to wait for and verify them.
+        """
+        # Schedule candidates to be applied for trickle ICE support
+        LOGGER.debug(f"Scheduling {len(candidates)} candidates for trickle ICE support: {candidates}")
+        asyncio.run_coroutine_threadsafe(
+            self.set_remote_ice_candidates(candidates),
+            self.event_loop
+        )
+
+        # Also put in event queue for any waiting consumers
         self._remote_events[Events.ICE_CANDIDATE].put((sessionId, candidates))

src/controller/python/matter/webrtc/libdatachannel_peer_connection.py

@@ -118,7 +118,7 @@ def set_remote_ice_candidates(self, remote_candidates: list[IceCandidate]) -> No
         """Sets the remote ICE candidates for the WebRTC peer connection.
 
         Args:
-            remote_candidates (list[str]): A list of remote ICE candidates to be set.
+            remote_candidates (list[IceCandidate]): A list of remote ICE candidates to be set.
         """
         for candidate in remote_candidates:
             self.add_ice_candidate(candidate.candidate, candidate.sdpMid or "video")
@@ -216,15 +216,15 @@ async def get_remote_answer(self, timeout_s: Optional[int] = None) -> tuple[int,
         LOGGER.debug("Waiting for remote answer")
         return await self._remote_events[Events.ANSWER].get(timeout_s)
 
-    async def get_remote_ice_candidates(self, timeout_s: Optional[int] = None) -> tuple[int, list[str]]:
-        """Waits for a remote SDP answer to be received through a matter command.
+    async def get_remote_ice_candidates(self, timeout_s: Optional[int] = None) -> tuple[int, list[IceCandidate]]:
+        """Waits for a list of remote ICE Candidates to be received through a matter command.
 
         Args:
-            timeout_s (Optional[int]): The maximum time in seconds to wait for a remote offer.
+            timeout_s (Optional[int]): The maximum time in seconds to wait for a list of remote candidates.
             If None, the function will wait indefinitely.
 
         Returns:
-            tuple[int, list[str]]: A tuple containing the session ID and list of ice candidate strings.
+            tuple[int, list[IceCandidate]]: A tuple containing the session ID and list of ice candidate strings.
 
         Raises:
             asyncio.TimeoutError: If no remote offer is received within the specified timeout period.
@@ -331,8 +331,17 @@ def on_remote_answer(self, sessionId: int, answer_sdp: str) -> None:
         """Callback function called when a remote SDP answer is received through a matter command."""
         self._remote_events[Events.ANSWER].put((sessionId, answer_sdp))
 
-    def on_remote_ice_candidates(self, sessionId: int, candidates: list[str]) -> None:
-        """Callback function called when a remote ICE candidates are received through a matter command."""
+    def on_remote_ice_candidates(self, sessionId: int, candidates: list[IceCandidate]) -> None:
+        """Callback function called when a remote ICE candidates are received through a matter command.
+
+        Implements trickle ICE by immediately applying received candidates to the peer connection.
+        Also stores them in the event queue for tests that may need to wait for and verify them.
+        """
+        # Immediately apply candidates for trickle ICE support
+        LOGGER.debug(f"Applying {len(candidates)} candidates for trickle ICE support: {candidates}")
+        self.set_remote_ice_candidates(candidates)
+
+        # Also put in event queue for any waiting consumers
         self._remote_events[Events.ICE_CANDIDATE].put((sessionId, candidates))
 
     def on_remote_end(self, sessionId: int, reason: int) -> None:

src/python_testing/TC_WEBRTC_1_1.py

@@ -66,19 +66,14 @@ def steps_TC_WEBRTC_1_1(self) -> list[TestStep]:
             TestStep(3, description="TH sends the SUCCESS status code to the DUT."),
             TestStep(
                 4,
-                description="TH sends the ProvideICECandidates command with a its ICE candidates to the DUT.",
+                description="TH sends the ProvideICECandidates command with its ICE candidates to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
             TestStep(
-                5,
-                description="DUT sends ICECandidates command to the TH/WEBRTCR.",
-                expectation="Verify that ICECandidates command contains the same WebRTCSessionID saved in step 1 and contain a non-empty ICE candidates.",
+                5, description="TH waits for 10 seconds.", expectation="Verify the WebRTC session has been successfully established."
             ),
             TestStep(
-                6, description="TH waits for 5 seconds", expectation="Verify the WebRTC session has been successfully established."
-            ),
-            TestStep(
-                7,
+                6,
                 description="TH sends the EndSession command with the WebRTCSessionID saved in step 1 to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
@@ -162,21 +157,14 @@ async def test_TC_WEBRTC_1_1(self):
         )
 
         self.step(5)
-        ice_session_id, remote_candidates = await webrtc_peer.get_remote_ice_candidates()
-        asserts.assert_equal(session_id, ice_session_id, "ProvideIceCandidates invoked with wrong session id")
-        asserts.assert_true(len(remote_candidates) > 0, "Invalid remote ice candidates received")
-
-        webrtc_peer.set_remote_ice_candidates(remote_candidates)
-
-        self.step(6)
         if not await webrtc_peer.check_for_session_establishment():
             logging.error("Failed to establish webrtc session")
             raise Exception("Failed to establish webrtc session")
 
         if not self.is_pics_sdk_ci_only and aVideoStreamID != NullValue:
             self.user_verify_video_stream("Verify WebRTC session by validating if video is received")
 
-        self.step(7)
+        self.step(6)
         await self.send_single_cmd(
             cmd=WebRTCTransportProvider.Commands.EndSession(
                 webRTCSessionID=session_id, reason=Objects.Globals.Enums.WebRTCEndReasonEnum.kUserHangup

src/python_testing/TC_WEBRTC_1_2.py

@@ -71,21 +71,16 @@ def steps_TC_WEBRTC_1_2(self) -> list[TestStep]:
             TestStep(4, "TH sends the SUCCESS status code to the DUT."),
             TestStep(
                 5,
-                description="TH sends the ProvideICECandidates command with a its ICE candidates to the DUT.",
+                description="TH sends the ProvideICECandidates command with its ICE candidates to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
             TestStep(
                 6,
-                description="TH waits up to 30 seconds for ICECandidates command from the DUT.",
-                expectation="Verify that ICECandidates command contains the same WebRTCSessionID saved in step 1 and contain a non-empty ICE candidates.",
-            ),
-            TestStep(
-                7,
                 description="TH waits for 10 seconds.",
                 expectation="Verify the WebRTC session has been successfully established.",
             ),
             TestStep(
-                8,
+                7,
                 description="TH sends the EndSession command with the WebRTCSessionID saved in step 1 to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
@@ -169,20 +164,14 @@ async def test_TC_WEBRTC_1_2(self):
         )
 
         self.step(6)
-        ice_session_id, remote_candidates = await webrtc_peer.get_remote_ice_candidates()
-        asserts.assert_equal(prev_sessionid, ice_session_id, "ProvideIceCandidates invoked with wrong session id")
-        asserts.assert_true(len(remote_candidates) > 0, "Invalid remote ice candidates received")
-        webrtc_peer.set_remote_ice_candidates(remote_candidates)
-
-        self.step(7)
-        if not webrtc_peer.is_session_connected():
+        if not await webrtc_peer.check_for_session_establishment():
             logging.error("Failed to establish webrtc session")
             raise Exception("Failed to establish webrtc session")
 
         if not self.is_pics_sdk_ci_only:
             self.user_verify_video_stream("Verify WebRTC session by validating if video is received")
 
-        self.step(8)
+        self.step(7)
         await self.send_single_cmd(
             cmd=WebRTCTransportProvider.Commands.EndSession(
                 webRTCSessionID=prev_sessionid, reason=Objects.Globals.Enums.WebRTCEndReasonEnum.kUserHangup
@@ -226,9 +215,6 @@ async def establish_webrtc_session(webrtc_manager, webrtc_peer, endpoint, ctrl,
         payloadCapability=TransportPayloadCapability.LARGE_PAYLOAD,
     )
 
-    ice_session_id, remote_candidates = await webrtc_peer.get_remote_ice_candidates()
-    webrtc_peer.set_remote_ice_candidates(remote_candidates)
-
     return await webrtc_peer.check_for_session_establishment()
 
 

src/python_testing/TC_WEBRTC_1_3.py

@@ -73,16 +73,11 @@ def steps_TC_WEBRTC_1_3(self) -> list[TestStep]:
             ),
             TestStep(
                 5,
-                description="TH waits up to 30 seconds for ICECandidates command from the DUT.",
-                expectation="Verify that ICECandidates command contains the same WebRTCSessionID saved in step 1 and contain a non-empty ICE candidates.",
-            ),
-            TestStep(
-                6,
                 description="TH waits for 10 seconds.",
                 expectation="Verify the WebRTC session has been successfully established.",
             ),
             TestStep(
-                7,
+                6,
                 description="TH sends the EndSession command with the WebRTCSessionID saved in step 1 to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
@@ -152,20 +147,14 @@ async def test_TC_WEBRTC_1_3(self):
         )
 
         self.step(5)
-        ice_session_id, remote_candidates = await webrtc_peer.get_remote_ice_candidates(timeout_s=30)
-        asserts.assert_equal(ice_session_id, session_id, "Invalid session id")
-        asserts.assert_true(len(remote_candidates) > 0, "Invalid ice candidates received")
-        webrtc_peer.set_remote_ice_candidates(remote_candidates)
-
-        self.step(6)
         if not await webrtc_peer.check_for_session_establishment():
             logging.error("Failed to establish webrtc session")
             raise Exception("Failed to establish webrtc session")
 
         if not self.is_pics_sdk_ci_only:
             self.user_verify_video_stream("Verify WebRTC session by validating if video is received")
 
-        self.step(7)
+        self.step(6)
         await self.send_single_cmd(
             cmd=WebRTCTransportProvider.Commands.EndSession(
                 webRTCSessionID=session_id, reason=Objects.Globals.Enums.WebRTCEndReasonEnum.kUserHangup

src/python_testing/TC_WEBRTC_1_4.py

@@ -75,16 +75,11 @@ def steps_TC_WEBRTC_1_4(self) -> list[TestStep]:
             ),
             TestStep(
                 6,
-                description="TH waits up to 30 seconds for ICECandidates command from the DUT.",
-                expectation="Verify that ICECandidates command contains the same WebRTCSessionID saved in step 1 and contain a non-empty ICE candidates.",
-            ),
-            TestStep(
-                7,
                 description="TH waits for 10 seconds.",
                 expectation="Verify the WebRTC session has been successfully established.",
             ),
             TestStep(
-                8,
+                7,
                 description="TH sends the EndSession command with the WebRTCSessionID saved in step 1 to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
@@ -169,20 +164,14 @@ async def test_TC_WEBRTC_1_4(self):
         )
 
         self.step(6)
-        ice_session_id, remote_candidates = await webrtc_peer.get_remote_ice_candidates(timeout_s=30)
-        asserts.assert_equal(ice_session_id, session_id, "Invalid session id")
-        asserts.assert_true(len(remote_candidates) > 0, "Invalid ice candidates received")
-        webrtc_peer.set_remote_ice_candidates(remote_candidates)
-
-        self.step(7)
         if not await webrtc_peer.check_for_session_establishment():
             logging.error("Failed to establish webrtc session")
             raise Exception("Failed to establish webrtc session")
 
         if not self.is_pics_sdk_ci_only:
             self.user_verify_video_stream("Verify WebRTC session by validating if video is received")
 
-        self.step(8)
+        self.step(7)
         await self.send_single_cmd(
             cmd=WebRTCTransportProvider.Commands.EndSession(
                 webRTCSessionID=session_id, reason=Objects.Globals.Enums.WebRTCEndReasonEnum.kUserHangup

src/python_testing/TC_WEBRTC_1_5.py

@@ -68,15 +68,10 @@ def steps_TC_WEBRTC_1_5(self) -> list[TestStep]:
                 expectation="DUT responds with SUCCESS status code.",
             ),
             TestStep(
-                5,
-                description="DUT sends ProvideICECandidates command to the TH",
-                expectation="Verify that ProvideICECandidates command contains the same WebRTCSessionID saved in step 1 and contain a non-empty ICE candidates.",
+                5, description="TH waits for 10 seconds", expectation="Verify the WebRTC session has been successfully established."
             ),
             TestStep(
-                6, description="TH waits for 5 seconds", expectation="Verify the WebRTC session has been successfully established."
-            ),
-            TestStep(
-                7,
+                6,
                 description="TH sends the End command with the WebRTCSessionID saved in step 1 to the DUT.",
                 expectation="DUT responds with SUCCESS status code.",
             ),
@@ -141,20 +136,14 @@ async def test_TC_WEBRTC_1_5(self):
         )
 
         self.step(5)
-        ice_session_id, remote_candidates = await webrtc_peer.get_remote_ice_candidates(timeout=30)
-        asserts.assert_equal(ice_session_id, session_id, "Invalid session id")
-        asserts.assert_true(len(remote_candidates) > 0, "Invalid ice candidates received")
-        webrtc_peer.set_remote_ice_candidates(remote_candidates)
-
-        self.step(6)
         if not await webrtc_peer.check_for_session_establishment():
             logging.error("Failed to establish webrtc session")
             raise Exception("Failed to establish webrtc session")
 
         if not self.is_pics_sdk_ci_only:
             self.user_verify_video_stream("Verify WebRTC session by validating if video is received")
 
-        self.step(7)
+        self.step(6)
         await self.send_single_cmd(
             cmd=WebRTCTransportRequestor.Commands.End(
                 webRTCSessionID=session_id, reason=Objects.Globals.Enums.WebRTCEndReasonEnum.kUserHangup