forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Terms and Conditions Integration Test Scripts
```bash rm /tmp/chip* ; ./scripts/run_in_python_env.sh ./out/venv './scripts/tests/run_python_test.py --app out/linux-x64-terms-and-conditions/chip-terms-and-conditions-app --app-args "" --script ./src/python_testing/TC_CGEN_2_6.py --script-args "--trace-to json:log --in-test-commissioning-method on-network --qr-code MT:-24J0AFN00KA0648G00"' ```
- Loading branch information
1 parent
b4dec93
commit 26f967b
Showing
2 changed files
with
208 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
# | ||
# 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 | ||
# test-runner-run/run1/app: ${TERMS_AND_CONDITIONS_APP} | ||
# test-runner-run/run1/factoryreset: True | ||
# test-runner-run/run1/quiet: True | ||
# test-runner-run/run1/app-args: --KVS kvs1 | ||
# test-runner-run/run1/script-args: --commissioning-method on-network --qr-code MT:-24J0AFN00KA0648G00 --tc-version 1 --tc-user-response 1 --trace_file /tmp/chip_trace.log --trace_log 1 --trace_decode 1 | ||
# === END CI TEST ARGUMENTS === | ||
|
||
import logging | ||
import random | ||
|
||
import chip.clusters as Clusters | ||
from matter_testing_support import MatterBaseTest, async_test_body, default_matter_test_main | ||
from mobly import asserts | ||
|
||
|
||
class TC_CGEN_2_5(MatterBaseTest): | ||
async def verify_tc_attributes(self, expected_tc_version: int, expected_tc_acknowledgements: int): | ||
attr = Clusters.GeneralCommissioning.Attributes.TCAcceptedVersion | ||
tc_accepted_version = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=attr) | ||
asserts.assert_equal(tc_accepted_version, expected_tc_version, | ||
f"Expected TCAcceptedVersion to be {expected_tc_version}, but got {tc_accepted_version}") | ||
|
||
attr = Clusters.GeneralCommissioning.Attributes.TCAcknowledgements | ||
tc_acknowedgements = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=attr) | ||
asserts.assert_equal(tc_acknowedgements, expected_tc_acknowledgements, | ||
f"Expected TCAcknowledgements to be {expected_tc_acknowledgements}, but got {tc_acknowedgements}") | ||
|
||
@async_test_body | ||
async def test_TC_CGEN_2_5(self): | ||
self.th1 = self.default_controller | ||
self.discriminator = random.randint(0, 4095) | ||
|
||
logging.info('Step 1 - TH reads the TCAcceptedVersion attribute') | ||
attr = Clusters.GeneralCommissioning.Attributes.TCAcceptedVersion | ||
tc_accepted_version = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=attr) | ||
|
||
print(f"tc_accepted_version: {tc_accepted_version}") | ||
|
||
logging.info('Step 2 - TH reads the TCAcknowledgements attribute') | ||
attr = Clusters.GeneralCommissioning.Attributes.TCAcknowledgements | ||
tc_acknowedgements = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=attr) | ||
print(f"tc_acknowedgements: {tc_acknowedgements}") | ||
|
||
logging.info('Step 3 - TH reads the TCMinRequiredVersion attribute') | ||
attr = Clusters.GeneralCommissioning.Attributes.TCMinRequiredVersion | ||
tc_min_requried_version = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=attr) | ||
print(f"tc_min_requried_version: {tc_min_requried_version}") | ||
|
||
logging.info('Step 4 - TH reads the TCAcknowledgementsRequired attribute') | ||
attr = Clusters.GeneralCommissioning.Attributes.TCAcknowledgementsRequired | ||
tc_required = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=attr) | ||
print(f"tc_required: {tc_required}") | ||
|
||
logging.info('Step 5 - TH sends SetTCAcknowledgements with greater values than current and verify set') | ||
new_accepted_version = tc_accepted_version + 1 | ||
new_acknowledgements = 65535 | ||
|
||
cmd = Clusters.GeneralCommissioning.Commands.SetTCAcknowledgements(new_accepted_version, new_acknowledgements) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal(resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk, 'Incorrect error code') | ||
await self.verify_tc_attributes(new_accepted_version, new_acknowledgements) | ||
|
||
logging.info('Step 6 - TH sends SetTCAcknowledgements with no accepted terms at version 0') | ||
cmd = Clusters.GeneralCommissioning.Commands.SetTCAcknowledgements(0, 0) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal( | ||
resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kTCMinVersionNotMet, 'Incorrect error code' | ||
) | ||
await self.verify_tc_attributes(new_accepted_version, new_acknowledgements) | ||
|
||
logging.info('Step 7 - TH sends SetTCAcknowledgements with no accepted terms at version 1') | ||
cmd = Clusters.GeneralCommissioning.Commands.SetTCAcknowledgements(1, 0) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal( | ||
resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kRequiredTCNotAccepted, 'Incorrect error code' | ||
) | ||
await self.verify_tc_attributes(new_accepted_version, new_acknowledgements) | ||
|
||
logging.info('Step 8 - TH sends ArmFailSafe with ExpiryLengthSeconds set to 60') | ||
cmd = Clusters.GeneralCommissioning.Commands.ArmFailSafe(60) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal(resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk, | ||
'Incorrect error code') | ||
|
||
logging.info('Step 9 - TH sends SetTCAcknowledgements with incremented TCVersion') | ||
cmd = Clusters.GeneralCommissioning.Commands.SetTCAcknowledgements(new_accepted_version + 1, new_acknowledgements) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal(resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk, | ||
'Incorrect error code') | ||
|
||
logging.info('Step 10 - TH sends ArmFailSafe with ExpiryLengthSeconds set to 0') | ||
cmd = Clusters.GeneralCommissioning.Commands.ArmFailSafe(0) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal(resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk, | ||
'Incorrect error code') | ||
|
||
# Verify that the TC attributes have been reset to the pre-failsafe state | ||
await self.verify_tc_attributes(new_accepted_version, new_acknowledgements) | ||
|
||
logging.info('Step 11 - TH removes all fabrics from the device') | ||
fabrics = await self.read_single_attribute(dev_ctrl=self.th1, node_id=self.dut_node_id, endpoint=0, attribute=Clusters.OperationalCredentials.Attributes.Fabrics) | ||
for fabric in fabrics: | ||
if fabric.fabricIndex == self.th1.fabricId: | ||
continue | ||
cmd = Clusters.OperationalCredentials.Commands.RemoveFabric(fabric.fabricIndex) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal(resp.statusCode, Clusters.OperationalCredentials.Enums.NodeOperationalCertStatusEnum.kOk) | ||
|
||
# Remove TH1 fabric last | ||
cmd = Clusters.OperationalCredentials.Commands.RemoveFabric(self.th1.fabricId) | ||
resp = await self.th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
|
||
|
||
if __name__ == "__main__": | ||
default_matter_test_main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# | ||
# 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 | ||
# test-runner-run/run1/app: ${TERMS_AND_CONDITIONS_APP} | ||
# test-runner-run/run1/factoryreset: True | ||
# test-runner-run/run1/quiet: True | ||
# test-runner-run/run1/app-args: --KVS kvs1 | ||
# test-runner-run/run1/script-args: --in-test-commissioning-method on-network --qr-code MT:-24J0AFN00KA0648G00 --trace-to json:log | ||
# === END CI TEST ARGUMENTS === | ||
|
||
import random | ||
|
||
import chip.clusters as Clusters | ||
from chip import ChipDeviceCtrl | ||
from matter_testing_support import MatterBaseTest, TestStep, async_test_body, default_matter_test_main | ||
from mobly import asserts | ||
|
||
|
||
class TC_CGEN_2_6(MatterBaseTest): | ||
def desc_TC_CGEN_2_6(self) -> str: | ||
return "[TC-CGEN-2.6] Verification For CommissioningComplete no terms accepted when required [DUT as Server]" | ||
|
||
def steps_TC_CGEN_2_6(self) -> list[TestStep]: | ||
return [ | ||
TestStep("1", "TH starts commissioning the DUT. It performs all commissioning steps from ArmFailSafe to CommissioningComplete, except for TC configuration with SetTCAcknowledgements.", is_commissioning=False), | ||
] | ||
|
||
@async_test_body | ||
async def test_TC_CGEN_2_6(self): | ||
th1: ChipDeviceCtrl.ChipDeviceController = self.default_controller | ||
self.discriminator = random.randint(0, 4095) | ||
|
||
self.step("1") | ||
|
||
# Don't set TCs for the next commissioning and skip CommissioningComplete so we can manually call CommissioningComplete in order to check the response error code | ||
th1.SetTCRequired(False) | ||
th1.SetSkipCommissioningComplete(True) | ||
self.matter_test_config.commissioning_method = self.matter_test_config.in_test_commissioning_method | ||
await self.commission_devices() | ||
|
||
cmd = Clusters.GeneralCommissioning.Commands.CommissioningComplete() | ||
resp = await th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal( | ||
resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kTCAcknowledgementsNotReceived, 'Incorrect error code') | ||
|
||
cmd = Clusters.GeneralCommissioning.Commands.SetTCAcknowledgements(1, 0) | ||
resp = await th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal( | ||
resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kRequiredTCNotAccepted, 'Incorrect error code') | ||
|
||
cmd = Clusters.GeneralCommissioning.Commands.CommissioningComplete() | ||
resp = await th1.SendCommand(nodeid=self.dut_node_id, endpoint=0, payload=cmd, timedRequestTimeoutMs=6000) | ||
asserts.assert_equal( | ||
resp.errorCode, Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kTCAcknowledgementsNotReceived, 'Incorrect error code') | ||
|
||
|
||
if __name__ == "__main__": | ||
default_matter_test_main() |