forked from project-chip/connectedhomeip
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTC_ACE_1_4.py
373 lines (289 loc) · 19.7 KB
/
TC_ACE_1_4.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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
#
# Copyright (c) 2022 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.
#
# See https://github.com/project-chip/connectedhomeip/blob/master/docs/testing/python.md#defining-the-ci-test-arguments
# for details about the block below.
#
# === 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
# --int-arg PIXIT.ACE.APPENDPOINT:1
# --int-arg PIXIT.ACE.APPDEVTYPEID:0x0100
# --string-arg PIXIT.ACE.APPCLUSTER:OnOff
# --string-arg PIXIT.ACE.APPATTRIBUTE:OnOff
# --trace-to json:${TRACE_TEST_JSON}.json
# --trace-to perfetto:${TRACE_TEST_PERFETTO}.perfetto
# factory-reset: true
# quiet: true
# === END CI TEST ARGUMENTS ===
import sys
import chip.clusters as Clusters
from chip.interaction_model import Status
from chip.testing.matter_testing import MatterBaseTest, async_test_body, default_matter_test_main
from mobly import asserts
# This test requires several additional command line arguments
# run with
# --int-arg PIXIT.ACE.ENDPOINT:<endpoint> --int-arg PIXIT.ACE.APPDEVTYPE:<device_type_id>
# --string-arg PIXIT.ACE.APPCLUSTER:<cluster_name> --string-arg PIXIT.ACE.APPATTRIBUTE:<attribute_name>
def str_to_cluster(str):
return getattr(sys.modules["chip.clusters.Objects"], str)
def str_to_attribute(cluster, str):
return getattr(cluster.Attributes, str)
class TC_ACE_1_4(MatterBaseTest):
async def write_acl(self, acl):
# This returns an attribute status
result = await self.default_controller.WriteAttribute(self.dut_node_id, [(0, Clusters.AccessControl.Attributes.Acl(acl))])
asserts.assert_equal(result[0].Status, Status.Success, "ACL write failed")
async def read_descriptor_expect_success(self, endpoint: int) -> None:
cluster = Clusters.Objects.Descriptor
attribute = Clusters.Descriptor.Attributes.DeviceTypeList
await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)
async def read_descriptor_expect_unsupported_access(self, endpoint: int) -> None:
cluster = Clusters.Objects.Descriptor
attribute = Clusters.Descriptor.Attributes.DeviceTypeList
await self.read_single_attribute_expect_error(
endpoint=endpoint, cluster=cluster, attribute=attribute, error=Status.UnsupportedAccess)
async def read_appcluster_expect_success(self) -> None:
await self.read_single_attribute_check_success(endpoint=self.endpoint, cluster=self.cluster, attribute=self.attribute)
async def read_appcluster_expect_unsupported_access(self) -> None:
await self.read_single_attribute_expect_error(
endpoint=self.endpoint, cluster=self.cluster, attribute=self.attribute, error=Status.UnsupportedAccess)
async def read_wildcard_endpoint(self, attribute: object) -> object:
return await self.default_controller.ReadAttribute(self.dut_node_id, [(attribute)])
def check_read_success(self, results: object, endpoint: int, cluster: object, attribute: object) -> None:
err_msg = "Results not returned for ep {}".format(str(endpoint))
asserts.assert_true(endpoint in results, err_msg)
err_msg = "Results not returned for cluster {} on ep {}".format(str(cluster), str(endpoint))
asserts.assert_true(cluster in results[endpoint], err_msg)
err_msg = "Results not returned for attribute {} on ep {}".format(str(attribute), str(endpoint))
asserts.assert_true(attribute in results[endpoint][cluster], err_msg)
attr_ret = results[endpoint][cluster][attribute]
err_msg = "Error reading {}:{}".format(str(cluster), str(attribute))
asserts.assert_true(attr_ret is not None, err_msg)
asserts.assert_false(isinstance(attr_ret, Clusters.Attribute.ValueDecodeFailure), err_msg)
@async_test_body
async def test_TC_ACE_1_4(self):
# TODO: Guard these on the PICS
asserts.assert_true('PIXIT.ACE.APPENDPOINT' in self.matter_test_config.global_test_params,
"PIXIT.ACE.APPENDPOINT must be included on the command line in "
"the --int-arg flag as PIXIT.ACE.APPENDPOINT:<endpoint>")
asserts.assert_true('PIXIT.ACE.APPCLUSTER' in self.matter_test_config.global_test_params,
"PIXIT.ACE.APPCLUSTER must be included on the command line in "
"the --string-arg flag as PIXIT.ACE.APPCLUSTER:<cluster_name>")
asserts.assert_true('PIXIT.ACE.APPATTRIBUTE' in self.matter_test_config.global_test_params,
"PIXIT.ACE.APPATTRIBUTE must be included on the command line in "
"the --string-arg flag as PIXIT.ACE.APPATTRIBUTE:<attribute_name>")
asserts.assert_true('PIXIT.ACE.APPDEVTYPEID' in self.matter_test_config.global_test_params,
"PIXIT.ACE.APPDEVTYPEID must be included on the command line in "
"the --int-arg flag as PIXIT.ACE.APPDEVTYPEID:<device_type_id>")
cluster_str = self.matter_test_config.global_test_params['PIXIT.ACE.APPCLUSTER']
attribute_str = self.matter_test_config.global_test_params['PIXIT.ACE.APPATTRIBUTE']
self.cluster = str_to_cluster(cluster_str)
self.attribute = str_to_attribute(self.cluster, attribute_str)
self.devtype = self.matter_test_config.global_test_params['PIXIT.ACE.APPDEVTYPEID']
self.endpoint = self.matter_test_config.global_test_params['PIXIT.ACE.APPENDPOINT']
asserts.assert_true(self.cluster is not None, "Invalid cluster name")
asserts.assert_true(self.attribute is not None, "Invalue attribute name")
self.print_step(1, "Commissioning, already done")
self.print_step(2, "TH1 writes ACL all clusters view on all endpoints")
admin_acl = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kAdminister,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(endpoint=0, cluster=Clusters.AccessControl.id)])
all_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[])
acl = [admin_acl, all_view]
await self.write_acl(acl)
self.print_step(3, "TH1 reads EP0 descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(0)
self.print_step(4, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(self.endpoint)
self.print_step(5, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(6, "TH1 writes ACL descriptor view all endpoints")
descriptor_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(cluster=Clusters.Descriptor.id)])
acl = [admin_acl, descriptor_view]
await self.write_acl(acl)
self.print_step(7, "TH1 reads EP0 descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(0)
self.print_step(8, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(self.endpoint)
self.print_step(9, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect UNSUPPORTED_ACCESS")
await self.read_appcluster_expect_unsupported_access()
self.print_step(10, "TH1 writes ACL PIXIT.ACE.APPCLUSTER view on all endpoints")
appcluster_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(cluster=self.cluster.id)])
acl = [admin_acl, appcluster_view]
await self.write_acl(acl)
self.print_step(11, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(12, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(self.endpoint)
self.print_step(13, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(14, "TH1 writes ACL descriptor view on PIXIT.ACE.APPENDPOINT")
descriptor_appendpoint_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(endpoint=self.endpoint, cluster=Clusters.Descriptor.id)])
acl = [admin_acl, descriptor_appendpoint_view]
await self.write_acl(acl)
self.print_step(15, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(16, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(self.endpoint)
self.print_step(17, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect UNSUPPORTED_ACCESS")
await self.read_appcluster_expect_unsupported_access()
self.print_step(18, "TH1 writes ACL appcluster view on PIXIT.ACE.APPENDPOINT")
appcluster_appendpoint_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(endpoint=self.endpoint, cluster=self.cluster.id)])
acl = [admin_acl, appcluster_appendpoint_view]
await self.write_acl(acl)
self.print_step(19, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(20, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(self.endpoint)
self.print_step(21, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(22, "TH1 writes ACL all clusters view on PIXIT.ACE.APPENDPOINT")
allclusters_appendpoint_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(endpoint=self.endpoint)])
acl = [admin_acl, allclusters_appendpoint_view]
await self.write_acl(acl)
self.print_step(23, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(24, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(self.endpoint)
self.print_step(25, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(26, "TH1 writes ACL rootnode device type view on all endpoints")
rootnode_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(deviceType=0x0016)])
acl = [admin_acl, rootnode_view]
await self.write_acl(acl)
self.print_step(27, "TH1 reads EP0 descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(0)
self.print_step(28, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(self.endpoint)
self.print_step(29, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect UNSUPPORTED_ACCESS")
await self.read_appcluster_expect_unsupported_access()
self.print_step(30, "TH1 writes ACL PIXIT.ACE.APPDEVTYPE view on all endpoints")
appdevtype_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(deviceType=self.devtype)])
acl = [admin_acl, appdevtype_view]
await self.write_acl(acl)
self.print_step(31, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(32, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(self.endpoint)
self.print_step(33, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(34, "TH1 writes ACL descriptor cluster on appdevtype on all endpoints")
descriptor_appdevtype_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(cluster=0x001d, deviceType=self.devtype)])
acl = [admin_acl, descriptor_appdevtype_view]
await self.write_acl(acl)
self.print_step(35, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(36, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(self.endpoint)
self.print_step(37, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect UNSUPPORTED_ACCESS")
await self.read_appcluster_expect_unsupported_access()
self.print_step(38, "TH1 writes ACL PIXIT.ACE.APPCLUSTER view on PIXIT.ACE.APPDEVTYPE")
appcluster_appdevtype_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(cluster=self.cluster.id, deviceType=self.devtype)])
acl = [admin_acl, appcluster_appdevtype_view]
await self.write_acl(acl)
self.print_step(39, "TH1 reads EP0 descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(0)
self.print_step(40, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(self.endpoint)
self.print_step(41, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(42, "TH1 writes ACL multi-target view")
multitarget_view = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kView,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[],
targets=[Clusters.AccessControl.Structs.AccessControlTargetStruct(cluster=Clusters.Descriptor.id, endpoint=0),
Clusters.AccessControl.Structs.AccessControlTargetStruct(cluster=self.cluster.id, endpoint=self.endpoint)])
acl = [admin_acl, multitarget_view]
await self.write_acl(acl)
self.print_step(43, "TH1 reads EP0 descriptor - expect SUCCESS")
await self.read_descriptor_expect_success(0)
self.print_step(44, "TH1 reads PIXIT.ACE.APPENDPOINT descriptor - expect UNSUPPORTED_ACCESS")
await self.read_descriptor_expect_unsupported_access(self.endpoint)
self.print_step(45, "TH1 reads PIXIT.ACE.APPENDPOINT PIXIT.ACE.APPCLUSTER - expect SUCCESS")
await self.read_appcluster_expect_success()
self.print_step(46, "TH1 reads wildcard descriptor - expect SUCCESS on EP0, no response on PIXIT.ACE.APPENDPOINT")
descriptor_wildcard = await self.read_wildcard_endpoint(Clusters.Descriptor.Attributes.DeviceTypeList)
# Ensure we get a success callback for ep 0
self.check_read_success(descriptor_wildcard, 0, Clusters.Objects.Descriptor, Clusters.Descriptor.Attributes.DeviceTypeList)
# Ensure we get NO results back for ep PIXIT.ACE.APPENDPOINT
asserts.assert_false(self.endpoint in descriptor_wildcard, "Received unexpected results on PIXIT.ACE.APPENDPOINT")
self.print_step(47, "TH1 reads wildcard PIXIT.ACE.APPCLUSTER - expect no response on EP0, success on PIXIT.ACE.APPENDPOINT")
appcluster_wildcard = await self.read_wildcard_endpoint(self.attribute)
# Ensure we get no response on EP 0
asserts.assert_false(0 in appcluster_wildcard, "Received unexpected results on EP 0")
# Ensure we get a success callback for PIXIT.ACE.APPENDPOINT
self.check_read_success(appcluster_wildcard, self.endpoint, self.cluster, self.attribute)
self.print_step(48, "TH1 resets ACL")
full_acl = Clusters.AccessControl.Structs.AccessControlEntryStruct(
privilege=Clusters.AccessControl.Enums.AccessControlEntryPrivilegeEnum.kAdminister,
authMode=Clusters.AccessControl.Enums.AccessControlEntryAuthModeEnum.kCase,
subjects=[self.matter_test_config.controller_node_id],
targets=[])
acl = [full_acl]
await self.write_acl(acl)
if __name__ == "__main__":
default_matter_test_main()