forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathTC_CGEN_2_8.py
189 lines (165 loc) · 9.33 KB
/
TC_CGEN_2_8.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#
# Copyright (c) 2025 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: ${TERMS_AND_CONDITIONS_APP}
# app-args: >
# --tc-min-required-version 1
# --tc-required-acknowledgements 1
# --custom-flow 2
# --capabilities 6
# script-args:
# --PICS src/app/tests/suites/certification/ci-pics-values
# --in-test-commissioning-method on-network
# --int-arg PIXIT.CGEN.FailsafeExpiryLengthSeconds:900
# --int-arg PIXIT.CGEN.RequiredTCAcknowledgements:1
# --int-arg PIXIT.CGEN.TCRevision:1
# --qr-code MT:-24J0AFN00KA0648G00
# --trace-to json:log
# factoryreset: True
# quiet: True
# === END CI TEST ARGUMENTS ===
import chip.clusters as Clusters
from chip import ChipDeviceCtrl
from chip.commissioning import ROOT_ENDPOINT_ID
from chip.testing.matter_testing import MatterBaseTest, TestStep, async_test_body, default_matter_test_main
from mobly import asserts
class TC_CGEN_2_8(MatterBaseTest):
def desc_TC_CGEN_2_8(self) -> str:
return "[TC-CGEN-2.8] Verification that TCAcknowledgements is reset after Factory Reset [DUT as Server]"
def pics_TC_CGEN_2_8(self) -> list[str]:
""" This function returns a list of PICS for this test case that must be True for the test to be run"""
return ["CGEN.S", "CGEN.S.F00"]
def steps_TC_CGEN_2_8(self) -> list[TestStep]:
return [
TestStep(0, description="", expectation="", is_commissioning=False),
TestStep(1, "TH begins commissioning the DUT and performs the following steps in order:\n* Security setup using PASE\n* Setup fail-safe timer, with ExpiryLengthSeconds field set to PIXIT.CGEN.FailsafeExpiryLengthSeconds and the Breadcrumb value as 1\n* Configure information- UTC time, regulatory, etc."),
TestStep(2, "TH sends SetTCAcknowledgements to DUT with the following values:\n* TCVersion: PIXIT.CGEN.TCRevision\n* TCUserResponse: PIXIT.CGEN.RequiredTCAcknowledgements"),
TestStep(3, "TH continues commissioning steps with the DUT and performs steps 'Operation CSR exchange' through 'Security setup using CASE'"),
TestStep(4, "TH sends CommissioningComplete to DUT."),
TestStep(5, "DUT is factory reset."),
TestStep(6, "Perform the necessary actions to put the DUT into a commissionable state."),
TestStep(7, "TH begins commissioning the DUT and performs the steps 'Device discovery and establish commissioning channel' through 'Security setup using CASE', skipping 'Configure information- TC Acknowledgements'"),
TestStep(8, "TH reads from the DUT the attribute TCAcceptedVersion."),
TestStep(9, "TH reads from the DUT the attribute TCAcknowledgements."),
TestStep(10, "TH reads from the DUT the attribute TCAcknowledgementsRequired."),
TestStep(11, "TH sends CommissioningComplete to DUT."),
]
@async_test_body
async def test_TC_CGEN_2_8(self):
commissioner: ChipDeviceCtrl.ChipDeviceController = self.default_controller
failsafe_expiry_length_seconds = self.matter_test_config.global_test_params['PIXIT.CGEN.FailsafeExpiryLengthSeconds']
tc_version_to_simulate = self.matter_test_config.global_test_params['PIXIT.CGEN.TCRevision']
tc_user_response_to_simulate = self.matter_test_config.global_test_params['PIXIT.CGEN.RequiredTCAcknowledgements']
self.step(0)
if not self.check_pics("CGEN.S.F00"):
asserts.skip('Root endpoint does not support the [commissioning] feature under test')
return
# Step 1: Begin commissioning with PASE and failsafe
self.step(1)
commissioner.SetSkipCommissioningComplete(True)
self.matter_test_config.commissioning_method = self.matter_test_config.in_test_commissioning_method
self.matter_test_config.tc_version_to_simulate = None
self.matter_test_config.tc_user_response_to_simulate = None
await self.commission_devices()
response = await commissioner.SendCommand(
nodeid=self.dut_node_id,
endpoint=ROOT_ENDPOINT_ID,
payload=Clusters.GeneralCommissioning.Commands.ArmFailSafe(
expiryLengthSeconds=failsafe_expiry_length_seconds, breadcrumb=1),
)
asserts.assert_equal(
response.errorCode,
Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk,
"ArmFailSafeResponse error code is not OK.",
)
# Step 2: Send SetTCAcknowledgements
self.step(2)
response = await commissioner.SendCommand(
nodeid=self.dut_node_id,
endpoint=ROOT_ENDPOINT_ID,
payload=Clusters.GeneralCommissioning.Commands.SetTCAcknowledgements(
TCVersion=tc_version_to_simulate, TCUserResponse=tc_user_response_to_simulate
),
)
asserts.assert_equal(
response.errorCode,
Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk,
"SetTCAcknowledgements failed",
)
# Step 3: Continue with CSR and CASE setup
self.step(3)
# Note: CSR and CASE setup is handled by the commissioning process
# Step 4: Send CommissioningComplete
self.step(4)
response = await commissioner.SendCommand(
nodeid=self.dut_node_id,
endpoint=ROOT_ENDPOINT_ID,
payload=Clusters.GeneralCommissioning.Commands.CommissioningComplete(),
)
asserts.assert_equal(
response.errorCode,
Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kOk,
"First CommissioningComplete failed",
)
# Close the commissioner session with the device to clean up resources
commissioner.CloseSession(nodeid=self.dut_node_id)
# Step 5: Factory reset is handled by test operator
self.step(5)
if not self.check_pics('PICS_USER_PROMPT'):
self.skip_all_remaining_steps(6)
return
self.wait_for_user_input(prompt_msg="Manually trigger factory reset on the DUT, then continue")
# Step 6: Put device in commissioning mode (requiring user input, so skip in CI)
self.step(6)
self.wait_for_user_input(prompt_msg="Manually set the DUT into commissioning mode, then continue")
# Step 7: Commission without TC acknowledgements
self.step(7)
commissioner.SetSkipCommissioningComplete(True)
self.matter_test_config.tc_version_to_simulate = None
self.matter_test_config.tc_user_response_to_simulate = None
await self.commission_devices()
# Step 8: Verify that TCAcceptedVersion equals 0
self.step(8)
response = await commissioner.ReadAttribute(nodeid=self.dut_node_id, attributes=[(ROOT_ENDPOINT_ID, Clusters.GeneralCommissioning.Attributes.TCAcceptedVersion)])
accepted_version = response[ROOT_ENDPOINT_ID][Clusters.GeneralCommissioning][Clusters.GeneralCommissioning.Attributes.TCAcceptedVersion]
asserts.assert_equal(accepted_version, 0, "TCAcceptedVersion does not match expected value.")
# Step 9: Verify that TCAcknowledgements equals 0
self.step(9)
response = await commissioner.ReadAttribute(nodeid=self.dut_node_id, attributes=[(ROOT_ENDPOINT_ID, Clusters.GeneralCommissioning.Attributes.TCAcknowledgements)])
acknowledgements = response[ROOT_ENDPOINT_ID][Clusters.GeneralCommissioning][Clusters.GeneralCommissioning.Attributes.TCAcknowledgements]
asserts.assert_equal(acknowledgements, 0, "TCAcknowledgements does not match expected value.")
# Step 10: Verify that TCAcknowledgementsRequired equals True
self.step(10)
response = await commissioner.ReadAttribute(nodeid=self.dut_node_id, attributes=[(ROOT_ENDPOINT_ID, Clusters.GeneralCommissioning.Attributes.TCAcknowledgementsRequired)])
tc_acknowledgements_required = response[ROOT_ENDPOINT_ID][Clusters.GeneralCommissioning][Clusters.GeneralCommissioning.Attributes.TCAcknowledgementsRequired]
asserts.assert_equal(tc_acknowledgements_required, True, "TCAcknowledgementsRequired should be True.")
# Step 11: Verify CommissioningComplete fails
self.step(11)
response = await commissioner.SendCommand(
nodeid=self.dut_node_id,
endpoint=ROOT_ENDPOINT_ID,
payload=Clusters.GeneralCommissioning.Commands.CommissioningComplete(),
)
asserts.assert_equal(
response.errorCode,
Clusters.GeneralCommissioning.Enums.CommissioningErrorEnum.kTCAcknowledgementsNotReceived,
"Expected TCAcknowledgementsNotReceived error after factory reset",
)
if __name__ == "__main__":
default_matter_test_main()