Enable rvc python tests to run in ci (project-chip#31872)

* Replaced the vendor specific mode tag for the mapping mode with the mapping mode tag.

* Updated the rvc-app's RvcOperationalStateDelegate to allow setting of a callback furtion for when the GoHome commond in received.

* Implemented the GoHome handler for rvc-app.

* Updated the PICS file for the rvc-app.

* Fixed the Admin commissioning cluter's zap config for the rvc-app

* Renamed the PICS values file to be similar to the ci file. Updated the script that runs all the RVC yaml tests.

* Updated the rvc-app state machine diagram.

* Updated theh rvc-app README.

* Restyled by clang-format

* Restyled by prettier-markdown

* Restyled by shfmt

* Updated the rvc-app .matter file.

* Reduced the text of some errors as it was longer that allowed.

* Added an out-of-band message to reset the rvc-app to its start-up state.

* Updated a returend error following the spec change.

* Excluded the RVC state diagram png from the lint check for %zu.

* Added the PICS_SDK_CI_ONLY PICS to the rvc-app-pics-values to allow it to run tests in CI.

* Improved the TC_RVCCLEANM_2_1 test to allow the CI to run the tests against the rvc-app.

* Improved the TC_RVCRUNM_2_1 test to allow the CI to run the tests against the rvc-app.

* Improved the TC_RVCCLEAN_2_2 test to allow the CI to run the tests against the rvc-app.

* Improved the TC_RVCRUNN_2_2 test to allow the CI to run the tests against the rvc-app.

* Improved the TC_RVCOPSTATE_2_1 test to allow the CI to run the tests against the rvc-app.

* Improved the TC_RVCOPSTATE_2_3 test to allow the CI to run the tests against the rvc-app.

* Restyled by autopep8

* Restyled by isort

* Updated the rvc-app readme.

* Removed PIXIT settings from the rvc-app-pics values.

* Excluded all binary files from the lint check for %zu.

* Fixed typos from code review

Co-authored-by: Petru Lauric <81822411+plauric@users.noreply.github.com>

* Re-removed the OpenBasicCommissioningWindow command of the Administrator Commissioning cluster in the rvc-app due to security concerns.

* Updated the rvc-app .matter file.

* Removed sleeps between messages to the DUT as they are not needed.

* Restyled by isort

* Fixed extra imports in python tests.

---------

Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Petru Lauric <81822411+plauric@users.noreply.github.com>

Author: 3 people

examples/rvc-app/rvc-common/pics/rvc-app-pics-values

@@ -1,3 +1,5 @@
+PICS_SDK_CI_ONLY=1
+
 RVCCLEANM.S=1
 RVCCLEANM.S.A0000=1
 RVCCLEANM.S.A0001=1

src/python_testing/TC_RVCCLEANM_2_1.py

@@ -33,17 +33,30 @@ def __init__(self, *args):
         self.endpoint = 0
         self.mode_ok = 0
         self.mode_fail = 0
+        self.is_ci = False
+        self.app_pipe = "/tmp/chip_rvc_fifo_"
 
     async def read_mod_attribute_expect_success(self, endpoint, attribute):
         cluster = Clusters.Objects.RvcCleanMode
         return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)
 
-    async def send_change_to_mode_cmd(self, newMode) -> Clusters.Objects.RvcCleanMode.Commands.ChangeToModeResponse:
+    async def send_clean_change_to_mode_cmd(self, newMode) -> Clusters.Objects.RvcCleanMode.Commands.ChangeToModeResponse:
         ret = await self.send_single_cmd(cmd=Clusters.Objects.RvcCleanMode.Commands.ChangeToMode(newMode=newMode), endpoint=self.endpoint)
         asserts.assert_true(type_matches(ret, Clusters.Objects.RvcCleanMode.Commands.ChangeToModeResponse),
-                            "Unexpected return type for ChangeToMode")
+                            "Unexpected return type for RVC Clean Mode ChangeToMode")
         return ret
 
+    async def send_run_change_to_mode_cmd(self, newMode) -> Clusters.Objects.RvcRunMode.Commands.ChangeToModeResponse:
+        ret = await self.send_single_cmd(cmd=Clusters.Objects.RvcRunMode.Commands.ChangeToMode(newMode=newMode), endpoint=self.endpoint)
+        asserts.assert_true(type_matches(ret, Clusters.Objects.RvcRunMode.Commands.ChangeToModeResponse),
+                            "Unexpected return type for RVC Run Mode ChangeToMode")
+        return ret
+
+    # Sends and out-of-band command to the rvc-app
+    def write_to_app_pipe(self, command):
+        with open(self.app_pipe, "w") as app_pipe:
+            app_pipe.write(command + "\n")
+
     def pics_TC_RVCCLEANM_2_1(self) -> list[str]:
         return ["RVCCLEANM.S"]
 
@@ -60,6 +73,12 @@ async def test_TC_RVCCLEANM_2_1(self):
         self.endpoint = self.matter_test_config.endpoint
         self.mode_ok = self.matter_test_config.global_test_params['PIXIT.RVCCLEANM.MODE_CHANGE_OK']
         self.mode_fail = self.matter_test_config.global_test_params['PIXIT.RVCCLEANM.MODE_CHANGE_FAIL']
+        self.is_ci = self.check_pics("PICS_SDK_CI_ONLY")
+        if self.is_ci:
+            app_pid = self.matter_test_config.app_pid
+            if app_pid == 0:
+                asserts.fail("The --app-pid flag must be set when PICS_SDK_CI_ONLY is set")
+            self.app_pipe = self.app_pipe + str(app_pid)
 
         asserts.assert_true(self.check_pics("RVCCLEANM.S.A0000"), "RVCCLEANM.S.A0000 must be supported")
         asserts.assert_true(self.check_pics("RVCCLEANM.S.A0001"), "RVCCLEANM.S.A0001 must be supported")
@@ -70,6 +89,10 @@ async def test_TC_RVCCLEANM_2_1(self):
 
         self.print_step(1, "Commissioning, already done")
 
+        # Ensure that the device is in the correct state
+        if self.is_ci:
+            self.write_to_app_pipe('{"Name": "Reset"}')
+
         self.print_step(2, "Read SupportedModes attribute")
         supported_modes = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.SupportedModes)
 
@@ -100,14 +123,18 @@ class CommonCodes(Enum):
 
         self.print_step(4, "Send ChangeToMode command with NewMode set to %d" % (old_current_mode))
 
-        ret = await self.send_change_to_mode_cmd(newMode=old_current_mode)
+        ret = await self.send_clean_change_to_mode_cmd(newMode=old_current_mode)
         asserts.assert_true(ret.status == CommonCodes.SUCCESS.value, "Changing the mode to the current mode should be a no-op")
 
         if self.check_pics("RVCCLEANM.S.M.CAN_TEST_MODE_FAILURE"):
             asserts.assert_true(self.mode_fail in modes,
                                 "The MODE_CHANGE_FAIL PIXIT value (%d) is not a supported mode" % (self.mode_fail))
             self.print_step(5, "Manually put the device in a state from which it will FAIL to transition to mode %d" % (self.mode_fail))
-            input("Press Enter when done.\n")
+            if self.is_ci:
+                print("Changing mode to Cleaning")
+                await self.send_run_change_to_mode_cmd(1)
+            else:
+                input("Press Enter when done.\n")
 
             self.print_step(6, "Read CurrentMode attribute")
             old_current_mode = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
@@ -116,7 +143,7 @@ class CommonCodes(Enum):
 
             self.print_step(7, "Send ChangeToMode command with NewMode set to %d" % (self.mode_fail))
 
-            ret = await self.send_change_to_mode_cmd(newMode=self.mode_fail)
+            ret = await self.send_clean_change_to_mode_cmd(newMode=self.mode_fail)
             st = ret.status
             is_mfg_code = st in range(0x80, 0xC0)
             is_err_code = (st == CommonCodes.GENERIC_FAILURE.value) or (
@@ -134,7 +161,11 @@ class CommonCodes(Enum):
             asserts.assert_true(current_mode == old_current_mode, "CurrentMode changed after failed ChangeToMode command!")
 
         self.print_step(9, "Manually put the device in a state from which it will SUCCESSFULLY transition to mode %d" % (self.mode_ok))
-        input("Press Enter when done.\n")
+        if self.is_ci:
+            print("Changing mode to Idle")
+            await self.send_run_change_to_mode_cmd(0)
+        else:
+            input("Press Enter when done.\n")
 
         self.print_step(10, "Read CurrentMode attribute")
         old_current_mode = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
@@ -143,7 +174,7 @@ class CommonCodes(Enum):
 
         self.print_step(11, "Send ChangeToMode command with NewMode set to %d" % (self.mode_ok))
 
-        ret = await self.send_change_to_mode_cmd(newMode=self.mode_ok)
+        ret = await self.send_clean_change_to_mode_cmd(newMode=self.mode_ok)
         asserts.assert_true(ret.status == CommonCodes.SUCCESS.value,
                             "Changing to mode %d must succeed due to the current state of the device" % (self.mode_ok))
 
@@ -157,7 +188,7 @@ class CommonCodes(Enum):
 
         self.print_step(13, "Send ChangeToMode command with NewMode set to %d" % (invalid_mode))
 
-        ret = await self.send_change_to_mode_cmd(newMode=invalid_mode)
+        ret = await self.send_clean_change_to_mode_cmd(newMode=invalid_mode)
         asserts.assert_true(ret.status == CommonCodes.UNSUPPORTED_MODE.value,
                             "Attempt to change to invalid mode %d didn't fail as expected" % (invalid_mode))
 

src/python_testing/TC_RVCCLEANM_2_2.py

@@ -31,6 +31,8 @@ def __init__(self, *args):
         self.run_mode_dut = 0
         self.old_clean_mode_dut = 0
         self.new_clean_mode_th = 0
+        self.is_ci = False
+        self.app_pipe = "/tmp/chip_rvc_fifo_"
 
     async def read_mod_attribute_expect_success(self, cluster, attribute):
         return await self.read_single_attribute_check_success(
@@ -48,10 +50,14 @@ async def read_clean_supported_modes(self) -> Clusters.Objects.RvcCleanMode.Attr
             Clusters.RvcCleanMode.Attributes.SupportedModes)
         return ret
 
-    async def send_change_to_mode_cmd(self, newMode) -> Clusters.Objects.RvcCleanMode.Commands.ChangeToModeResponse:
+    async def send_clean_change_to_mode_cmd(self, newMode) -> Clusters.Objects.RvcCleanMode.Commands.ChangeToModeResponse:
         ret = await self.send_single_cmd(cmd=Clusters.Objects.RvcCleanMode.Commands.ChangeToMode(newMode=newMode), endpoint=self.endpoint)
         return ret
 
+    async def send_run_change_to_mode_cmd(self, newMode) -> Clusters.Objects.RvcRunMode.Commands.ChangeToModeResponse:
+        ret = await self.send_single_cmd(cmd=Clusters.Objects.RvcRunMode.Commands.ChangeToMode(newMode=newMode), endpoint=self.endpoint)
+        return ret
+
     # Prints the instruction and waits for a user input to continue
     def print_instruction(self, step_number, instruction):
         self.print_step(step_number, instruction)
@@ -60,18 +66,37 @@ def print_instruction(self, step_number, instruction):
     def pics_TC_RVCCLEANM_2_2(self) -> list[str]:
         return ["RVCCLEANM.S"]
 
+    # Sends and out-of-band command to the rvc-app
+    def write_to_app_pipe(self, command):
+        with open(self.app_pipe, "w") as app_pipe:
+            app_pipe.write(command + "\n")
+
     @async_test_body
     async def test_TC_RVCCLEANM_2_2(self):
         self.endpoint = self.matter_test_config.endpoint
+        self.is_ci = self.check_pics("PICS_SDK_CI_ONLY")
+        if self.is_ci:
+            app_pid = self.matter_test_config.app_pid
+            if app_pid == 0:
+                asserts.fail("The --app-pid flag must be set when PICS_SDK_CI_ONLY is set.c")
+            self.app_pipe = self.app_pipe + str(app_pid)
 
         asserts.assert_true(self.check_pics("RVCCLEANM.S"), "RVCCLEANM.S must be supported")
         asserts.assert_true(self.check_pics("RVCRUNM.S.A0000"), "RVCRUNM.S.A0000 must be supported")
         asserts.assert_true(self.check_pics("RVCRUNM.S.A0001"), "RVCRUNM.S.A0001 must be supported")
 
         self.print_step(1, "Commissioning, already done")
 
-        self.print_instruction(2, "Manually put the device in a state in which the RVC Run Mode "
-                                  "cluster’s CurrentMode attribute is set to a mode without the Idle mode tag.")
+        # Ensure that the device is in the correct state
+        if self.is_ci:
+            self.write_to_app_pipe('{"Name": "Reset"}')
+
+        self.print_step(
+            2, "Manually put the device in a state in which the RVC Run Mode cluster’s CurrentMode attribute is set to a mode without the Idle mode tag.")
+        if self.is_ci:
+            await self.send_run_change_to_mode_cmd(1)
+        else:
+            input("Press Enter when done.\n")
 
         self.print_step(3, "Read the RvcRunMode SupportedModes attribute")
         supported_run_modes = await self.read_run_supported_modes()
@@ -115,7 +140,7 @@ async def test_TC_RVCCLEANM_2_2(self):
                 break
 
         self.print_step(7, "Send ChangeToMode command")
-        response = await self.send_change_to_mode_cmd(self.new_clean_mode_th)
+        response = await self.send_clean_change_to_mode_cmd(self.new_clean_mode_th)
         asserts.assert_equal(response.status, 3,
                              "The response should contain a ChangeToModeResponse command "
                              "with the Status set to InvalidInMode(0x03).")