diff --git a/src/app/tests/suites/certification/Test_TC_CADMIN_1_19.yaml b/src/app/tests/suites/certification/Test_TC_CADMIN_1_19.yaml deleted file mode 100644 index 892ae3c627623b..00000000000000 --- a/src/app/tests/suites/certification/Test_TC_CADMIN_1_19.yaml +++ /dev/null @@ -1,127 +0,0 @@ -# Copyright (c) 2021 Project CHIP Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# Auto-generated scripts for harness use only, please review before automation. The endpoints and cluster names are currently set to default - -name: - 4.1.19. [TC-CADMIN-1.19] max number of Commissioned Fabrics and - SupportedFabrics rollover using ECM [DUT - Commissionee] -PICS: - - CADMIN.S - -config: - nodeId: 0x12344321 - cluster: "Basic Information" - endpoint: 0 - -tests: - - label: "Precondition" - verification: | - Reset Devices to factory defaults - disabled: true - - - label: "Step 1: TH_CR1 starts a commissioning process with DUT_CE" - PICS: CADMIN.S - verification: | - "1. Provision the device using TH_CR1 -chip tool(use above instructions) , - " - disabled: true - - - label: - "Step 2: TH_CR1 opens a commissioning window on DUT_CE using a - commissioning timeout of PIXIT.CADMIN.CwDuration seconds using ECM" - PICS: CADMIN.S.C00.Rsp - verification: | - On TH_CR1 (chip tool), open commissioning window using ECM - - ./chip-tool pairing open-commissioning-window 1 1 300 1000 3840 - - Verify Manual pairing code on TH_CR1 (chip-tool) Log - - [1635925713.966786][9695:9700] CHIP:SC: Success status report received. Session was established - [1635925713.966839][9695:9700] CHIP:IN: New secure session created for device 0x0000000000000001, key 33!! - [1635925713.966938][9695:9700] CHIP:CTL: OpenCommissioningWindow for device ID 1 - [1635925713.972601][9695:9700] CHIP:DMG: ICR moving to [AddingComm] - [1635925713.972705][9695:9700] CHIP:DMG: ICR moving to [AddedComma] - [1635925713.972815][9695:9700] CHIP:IN: Prepared encrypted message 0xaaaad9b57d10 to 0x0000000000000001 of type 0x8 and protocolId (0, 1) on exchange 31056i with MessageCounter:0. - [1635925713.972876][9695:9700] CHIP:IN: Sending encrypted msg 0xaaaad9b57d10 with MessageCounter:0 to 0x0000000000000001 at monotonic time: 13449459 msec - [1635925713.973006][9695:9700] CHIP:DMG: ICR moving to [CommandSen] - [1635925713.973061][9695:9700] CHIP:CTL: Manual pairing code: [36217551633] - [1635925713.973120][9695:9700] CHIP:CTL: SetupQRCode: [MT:00000CQM00A7F87ZT10] - [1635925713.973178][9695:9700] CHIP:EM: Sending Standalone Ack for MessageCounter:1964916542 on exchange 31055i - disabled: true - - - label: "Step 3: THn starts a commissioning process with DUT_CE" - PICS: CADMIN.S - verification: | - On TH_CR1+1 controller using chip tool connect to the accessory - - - ./chip-tool pairing code 2 36217551633 --commissioner-name beta - - Verify you got below message on TH_CR1+1(chip-tool) log - Device commissioning completed with success - disabled: true - - - label: - "Step 4: Repeat Step 3 and Step 4 an additional (SupportedFabrics - 2) - times to reach an index value of SupportedFabrics on DUT_CE" - PICS: CADMIN.S.C00.Rsp - verification: | - Repeat step 3 until CommissionedFabrics=SupportedFabrics (Supported fabrics value obtained in the precondition) - - Use the following command to verify the currentcommissioned fabric (Output number may vary depends on the number successful commissioning ) - - ./chip-tool operationalcredentials read commissioned-fabrics 1 0 - - [1660907933.677983][33780:33785] CHIP:TOO: CommissionedFabrics: 16 - disabled: true - - - label: - "Step 5: THn_1 starts a commissioning process and opens a - commissioning window with DUT_CE" - PICS: CADMIN.S - verification: | - On THnth controller using chip tool connect to the accessory - - ./chip-tool pairing code 6 36217551633 --commissioner-name 4 - - Verify DUT_CE responds with NOCResponse with a StatusCode of 0x05 on THn (chip-tool) log - - CHIP:DMG: Received Command Response Data, Endpoint=0 Cluster=0x0000_003E Command=0x0000_0008 - [1649756670.402192][10794:10799] CHIP:CTL: Device returned status 5 on receiving the NOC - [1649756670.402221][10794:10799] CHIP:CTL: Add NOC failed with error ../../third_party/connectedhomeip/src/controller/CHIPDeviceController.cpp:1110: CHIP Error 0x0000000B: No memory - [1649756670.402241][10794:10799] CHIP:CTL: Failed to perform commissioning step 13 - disabled: true - - - label: "Step 6: TH_CR1 removes FabricIndex1" - PICS: OPCREDS.S.C0a.Rsp - verification: | - on TH_CR1 using chip tool, remove fabric with FabricIndex=1 - - ./chip-tool operationalcredentials remove-fabric 1 1 0 - - CHIP:DMG: Received Command Response Data, Endpoint=0 Cluster=0x0000_003E Command=0x0000_0008 - CHIP:TOO: Endpoint: 0 Cluster: 0x0000_003E Command 0x0000_0008 - CHIP:TOO: NOCResponse: { - CHIP:TOO: statusCode: 0 - CHIP:TOO: fabricIndex: 1 - CHIP:TOO: } - CHIP:DMG: ICR moving to [AwaitingDe] - - Verify CommissionedFabrics=SupportedFabrics-1 on TH_CR1(chip-tool) log - - ./chip-tool operationalcredentials read commissioned-fabrics 2 0 --commissioner-name beta - - [1660907933.677983][33780:33785] CHIP:TOO: CommissionedFabrics: 15 - disabled: true diff --git a/src/python_testing/TC_CADMIN_1_19.py b/src/python_testing/TC_CADMIN_1_19.py new file mode 100644 index 00000000000000..5ec3da867da6f1 --- /dev/null +++ b/src/python_testing/TC_CADMIN_1_19.py @@ -0,0 +1,172 @@ +# +# Copyright (c) 2024 Project CHIP Authors +# All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# === BEGIN CI TEST ARGUMENTS === +# test-runner-runs: +# run1: +# app: ${ALL_CLUSTERS_APP} +# app-args: --discriminator 1234 --KVS kvs1 --trace-to json:${TRACE_APP}.json +# script-args: > +# --storage-path admin_storage.json +# --commissioning-method on-network +# --discriminator 1234 +# --passcode 20202021 +# --trace-to json:${TRACE_TEST_JSON}.json +# --trace-to perfetto:${TRACE_TEST_PERFETTO}.perfetto +# --PICS src/app/tests/suites/certification/ci-pics-values +# factory-reset: true +# quiet: true +# === END CI TEST ARGUMENTS === + +import random + +import chip.clusters as Clusters +from chip import ChipDeviceCtrl +from chip.exceptions import ChipStackError +from chip.testing.matter_testing import MatterBaseTest, TestStep, async_test_body, default_matter_test_main +from mobly import asserts + + +class TC_CADMIN_1_19(MatterBaseTest): + def generate_unique_random_value(self, value): + while True: + random_value = random.randint(10000000, 99999999) + asserts.assert_equal(random_value, value) + return random_value + + async def get_fabrics(self, th: ChipDeviceCtrl) -> int: + OC_cluster = Clusters.OperationalCredentials + fabrics = await self.read_single_attribute_check_success(dev_ctrl=th, fabric_filtered=False, endpoint=0, cluster=OC_cluster, attribute=OC_cluster.Attributes.Fabrics) + return fabrics + + def steps_TC_CADMIN_1_19(self) -> list[TestStep]: + return [ + TestStep( + 1, "TH_CR1 reads the BasicCommissioningInfo attribute from the General Commissioning cluster and saves the MaxCumulativeFailsafeSeconds field as max_window_duration."), + TestStep(2, "TH_CR1 reads the Fabrics attribute from the Node Operational Credentials cluster using a non-fabric-filtered read. Save the number of fabrics in the list as initial_number_of_fabrics"), + TestStep(3, "TH_CR1 reads the SupportedFabrics attribute from the Node Operational Credentials cluster. Save max_fabrics", + "Verify that max_fabrics is larger than initial_number_of_fabrics. If not, instruct the tester to remove one non-test-harness fabric and re-start the test."), + TestStep(4, "Repeat the following steps (5a and 5b) max_fabrics - initial_number_of_fabrics times"), + TestStep( + "4a", "TH_CR1 send an OpenCommissioningWindow command to DUT_CE using a commissioning timeout of max_window_duration", "{resDutSuccess}"), + TestStep("4b", "TH creates a controller on a new fabric and commissions DUT_CE using that controller", + "Commissioning is successful"), + TestStep(5, "TH reads the CommissionedFabrics attributes from the Node Operational Credentials cluster.", + "Verify this is equal to max_fabrics"), + TestStep( + 6, "TH_CR1 send an OpenCommissioningWindow command to DUT_CE using a commissioning timeout of max_window_duration", "{resDutSuccess}"), + TestStep(7, "TH creates a controller on a new fabric and commissions DUT_CE using that controller", + "Verify DUT_CE responds with NOCResponse with a StatusCode field value of TableFull(5)"), + TestStep(8, "Repeat the following steps (9a and 9b) for each controller (TH_CRn) created by this test"), + TestStep("8a", "The controller reads the CurrentFabricIndex from the Node Operational Credentials cluster. Save as fabric_index."), + TestStep("8b", "TH_CR1 sends the RemoveFabric command to DUT_CE", "{resDutSuccess}"), + TestStep(9, "TH reads the CommissionedFabrics attributes from the Node Operational Credentials cluster.", + "Verify this is equal to initial_number_of_fabrics."), + ] + + def pics_TC_CADMIN_1_19(self) -> list[str]: + return ["CADMIN.S"] + + @async_test_body + async def test_TC_CADMIN_1_19(self): + self.step(1) + # Establishing TH1 + self.th1 = self.default_controller + + GC_cluster = Clusters.GeneralCommissioning + attribute = GC_cluster.Attributes.BasicCommissioningInfo + duration = await self.read_single_attribute_check_success(endpoint=0, cluster=GC_cluster, attribute=attribute) + self.max_window_duration = duration.maxCumulativeFailsafeSeconds + + self.step(2) + fabrics = await self.get_fabrics(th=self.th1) + initial_number_of_fabrics = len(fabrics) + + self.step(3) + OC_cluster = Clusters.OperationalCredentials + max_fabrics = await self.read_single_attribute_check_success(dev_ctrl=self.th1, fabric_filtered=False, endpoint=0, cluster=OC_cluster, attribute=OC_cluster.Attributes.SupportedFabrics) + asserts.assert_greater(max_fabrics, initial_number_of_fabrics, + "max fabrics must be greater than initial fabrics, please remove one non-test-harness fabric and try test again") + + self.step(4) + fids_ca_dir = {} + fids_fa_dir = {} + fids = {} + for fid in range(0, max_fabrics - initial_number_of_fabrics): + self.print_step("commissioning iteration", fid + 1) + # Make sure that current test step is 5, resets here after each loop + self.current_step_index = 4 + + self.step("4a") + params = await self.openCommissioningWindow(dev_ctrl=self.th1, timeout=self.max_window_duration, node_id=self.dut_node_id) + + self.step("4b") + fids_ca_dir[fid] = self.certificate_authority_manager.NewCertificateAuthority() + fids_fa_dir[fid] = fids_ca_dir[fid].NewFabricAdmin(vendorId=0xFFF1, fabricId=fid + 1) + fids[fid] = fids_fa_dir[fid].NewController(nodeId=fid + 1) + + await fids[fid].CommissionOnNetwork( + nodeId=self.dut_node_id, setupPinCode=params.commissioningParameters.setupPinCode, + filterType=ChipDeviceCtrl.DiscoveryFilterType.LONG_DISCRIMINATOR, filter=params.randomDiscriminator) + + self.step(5) + # TH reads the CommissionedFabrics attributes from the Node Operational Credentials cluster + current_fabrics = await self.read_single_attribute_check_success(dev_ctrl=self.th1, fabric_filtered=False, endpoint=0, cluster=OC_cluster, attribute=OC_cluster.Attributes.SupportedFabrics) + asserts.assert_equal(current_fabrics, max_fabrics, "Expected number of fabrics not correct") + + self.step(6) + params = await self.openCommissioningWindow(dev_ctrl=self.th1, node_id=self.dut_node_id) + + self.step(7) + # TH creates a controller on a new fabric and attempts to commission DUT_CE using that controller + next_fabric = current_fabrics + 1 + fids_ca_dir[next_fabric] = self.certificate_authority_manager.NewCertificateAuthority() + fids_fa_dir[next_fabric] = fids_ca_dir[current_fabrics + + 1].NewFabricAdmin(vendorId=0xFFF1, fabricId=next_fabric) + try: + fids[next_fabric] = fids_fa_dir[next_fabric].NewController(nodeId=next_fabric) + await fids[next_fabric].CommissionOnNetwork( + nodeId=self.dut_node_id, setupPinCode=params.commissioningParameters.setupPinCode, + filterType=ChipDeviceCtrl.DiscoveryFilterType.LONG_DISCRIMINATOR, filter=params.randomDiscriminator) + + except ChipStackError as e: + # When attempting to create a new controller we are expected to get the following response: + # src/credentials/FabricTable.cpp:833: CHIP Error 0x0000000B: No memory + # Since the FabricTable is full and unable to create any new fabrics + self.print_step("Max number of fabrics", "reached") + asserts.assert_equal(e.err, 0x0000000B, + "Expected to return table is full since max number of fabrics has been created already") + + self.step(8) + for thc in fids.keys(): + # Make sure that current test step is 11 (9 + 2 since 5a and 5b test steps included in count), resets here after each loop + self.current_step_index = 10 + + self.step("8a") + fabric_index = await self.read_single_attribute_check_success(dev_ctrl=fids[thc], endpoint=0, cluster=OC_cluster, attribute=OC_cluster.Attributes.CurrentFabricIndex) + + self.step("8b") + removeFabricCmd = Clusters.OperationalCredentials.Commands.RemoveFabric(fabric_index) + await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=removeFabricCmd) + + self.step(9) + # TH reads the CommissionedFabrics attributes from the Node Operational Credentials cluster. + current_fabrics = await self.read_single_attribute_check_success(dev_ctrl=self.th1, fabric_filtered=False, endpoint=0, cluster=OC_cluster, attribute=OC_cluster.Attributes.CommissionedFabrics) + asserts.assert_equal(current_fabrics, initial_number_of_fabrics, "Expected number of fabrics not correct") + + +if __name__ == "__main__": + default_matter_test_main() diff --git a/src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py b/src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py index b16d1b42a08b45..c2427fe1a8b39e 100644 --- a/src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py +++ b/src/python_testing/matter_testing_infrastructure/chip/testing/matter_testing.py @@ -1136,10 +1136,10 @@ def check_pics(self, pics_key: str) -> bool: def is_pics_sdk_ci_only(self) -> bool: return self.check_pics('PICS_SDK_CI_ONLY') - async def openCommissioningWindow(self, dev_ctrl: ChipDeviceCtrl, node_id: int) -> CustomCommissioningParameters: + async def openCommissioningWindow(self, dev_ctrl: ChipDeviceCtrl, node_id: int, timeout: int = 900) -> CustomCommissioningParameters: rnd_discriminator = random.randint(0, 4095) try: - commissioning_params = await dev_ctrl.OpenCommissioningWindow(nodeid=node_id, timeout=900, iteration=1000, + commissioning_params = await dev_ctrl.OpenCommissioningWindow(nodeid=node_id, timeout=timeout, iteration=1000, discriminator=rnd_discriminator, option=1) params = CustomCommissioningParameters(commissioning_params, rnd_discriminator) return params