Skip to content

Commit

Permalink
python testing: add test functions for IDs (project-chip#36766)
Browse files Browse the repository at this point in the history 
* python testing: add test functions for IDs

- Add functions to say whether an ID is in the standard range
- simpify API to accept an int ID rather than the enum since this
  is how they appear on the device.
- fix tests

TEST: see unit test

* Update src/python_testing/matter_testing_infrastructure/chip/testing/global_attribute_ids.py

Co-authored-by: Andrei Litvin <[email protected]>

---------

Co-authored-by: Andrei Litvin <[email protected]>
  • Loading branch information
@cecille @andy31415
cecille and andy31415 authored Dec 10, 2024
1 parent 918320e commit 29c6fd8
Show file tree
Hide file tree
Showing 3 changed files with 87 additions and 43 deletions.
2 changes: 1 addition & 1 deletion src/python_testing/TC_DeviceConformance.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ def record_warning(location, problem):
continue

device_type_list = endpoint[Clusters.Descriptor][Clusters.Descriptor.Attributes.DeviceTypeList]
invalid_device_types = [x for x in device_type_list if not is_valid_device_type_id(device_type_id_type(x.deviceType))]
invalid_device_types = [x for x in device_type_list if not is_valid_device_type_id(x.deviceType)]
standard_device_types = [x for x in endpoint[Clusters.Descriptor]
[Clusters.Descriptor.Attributes.DeviceTypeList] if device_type_id_type(x.deviceType) == DeviceTypeIdType.kStandard]
endpoint_clusters = []
Expand Down
96 changes: 58 additions & 38 deletions src/python_testing/TestIdChecks.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@
#

from chip.testing.global_attribute_ids import (AttributeIdType, ClusterIdType, CommandIdType, DeviceTypeIdType, attribute_id_type,
cluster_id_type, command_id_type, device_type_id_type, is_valid_attribute_id,
is_valid_cluster_id, is_valid_command_id, is_valid_device_type_id)
cluster_id_type, command_id_type, device_type_id_type, is_standard_attribute_id,
is_standard_cluster_id, is_standard_command_id, is_standard_device_type_id,
is_valid_attribute_id, is_valid_cluster_id, is_valid_command_id,
is_valid_device_type_id)
from chip.testing.matter_testing import MatterBaseTest, default_matter_test_main
from mobly import asserts

Expand All @@ -39,29 +41,33 @@ def check_standard(id):
id_type = device_type_id_type(id)
msg = f"Incorrect device type range assessment, expecting standard {id:08x}, type = {id_type}"
asserts.assert_equal(device_type_id_type(id), DeviceTypeIdType.kStandard, msg)
asserts.assert_true(is_valid_device_type_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_device_type_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_device_type_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_device_type_id(id, allow_test=False), msg)
asserts.assert_true(is_standard_device_type_id(id), msg)

def check_manufacturer(id):
id_type = device_type_id_type(id)
msg = f"Incorrect device type range assessment, expecting manufacturer {id:08x}, type = {id_type}"
asserts.assert_equal(device_type_id_type(id), DeviceTypeIdType.kManufacturer, msg)
asserts.assert_true(is_valid_device_type_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_device_type_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_device_type_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_device_type_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_device_type_id(id), msg)

def check_test(id):
id_type = device_type_id_type(id)
msg = f"Incorrect device type range assessment, expecting test {id:08x}, type = {id_type}"
asserts.assert_equal(device_type_id_type(id), DeviceTypeIdType.kTest, msg)
asserts.assert_true(is_valid_device_type_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_device_type_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_device_type_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_device_type_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_device_type_id(id), msg)

def check_all_bad(id):
id_type = device_type_id_type(id)
msg = f"Incorrect device type range assessment, expecting invalid {id:08x}, type = {id_type}"
asserts.assert_equal(device_type_id_type(id), DeviceTypeIdType.kInvalid, msg)
asserts.assert_false(is_valid_device_type_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_device_type_id(id_type, allow_test=False), msg)
asserts.assert_false(is_valid_device_type_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_device_type_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_device_type_id(id), msg)

for id in standard_good:
check_standard(id)
Expand Down Expand Up @@ -100,29 +106,33 @@ def check_standard(id):
id_type = cluster_id_type(id)
msg = f"Incorrect cluster range assessment, expecting standard {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, ClusterIdType.kStandard, msg)
asserts.assert_true(is_valid_cluster_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_cluster_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_cluster_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_cluster_id(id, allow_test=False), msg)
asserts.assert_true(is_standard_cluster_id(id), msg)

def check_manufacturer(id):
id_type = cluster_id_type(id)
msg = f"Incorrect cluster range assessment, expecting manufacturer {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, ClusterIdType.kManufacturer, msg)
asserts.assert_true(is_valid_cluster_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_cluster_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_cluster_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_cluster_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_cluster_id(id), msg)

def check_test(id):
id_type = cluster_id_type(id)
msg = f"Incorrect cluster range assessment, expecting test {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, ClusterIdType.kTest, msg)
asserts.assert_true(is_valid_cluster_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_cluster_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_cluster_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_cluster_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_cluster_id(id), msg)

def check_all_bad(id):
id_type = cluster_id_type(id)
msg = f"Incorrect cluster range assessment, expecting invalid {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, ClusterIdType.kInvalid, msg)
asserts.assert_false(is_valid_cluster_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_cluster_id(id_type, allow_test=False), msg)
asserts.assert_false(is_valid_cluster_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_cluster_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_cluster_id(id), msg)

for id in standard_good:
check_standard(id)
Expand Down Expand Up @@ -160,36 +170,41 @@ def check_standard_global(id):
id_type = attribute_id_type(id)
msg = f"Incorrect attribute range assessment, expecting standard global {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, AttributeIdType.kStandardGlobal, msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=False), msg)
asserts.assert_true(is_standard_attribute_id(id), msg)

def check_standard_non_global(id):
id_type = attribute_id_type(id)
msg = f"Incorrect attribute range assessment, expecting standard non-global {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, AttributeIdType.kStandardNonGlobal, msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=False), msg)
asserts.assert_true(is_standard_attribute_id(id), msg)

def check_manufacturer(id):
id_type = attribute_id_type(id)
msg = f"Incorrect attribute range assessment, expecting manufacturer {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, AttributeIdType.kManufacturer, msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_attribute_id(id), msg)

def check_test(id):
id_type = attribute_id_type(id)
msg = f"Incorrect attribute range assessment, expecting test {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, AttributeIdType.kTest, msg)
asserts.assert_true(is_valid_attribute_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_attribute_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_attribute_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_attribute_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_attribute_id(id), msg)

def check_all_bad(id):
id_type = attribute_id_type(id)
msg = f"Incorrect attribute range assessment, expecting invalid {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, AttributeIdType.kInvalid, msg)
asserts.assert_false(is_valid_attribute_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_attribute_id(id_type, allow_test=False), msg)
asserts.assert_false(is_valid_attribute_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_attribute_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_attribute_id(id), msg)

for id in standard_global_good:
check_standard_global(id)
Expand Down Expand Up @@ -225,36 +240,41 @@ def check_standard_global(id):
id_type = command_id_type(id)
msg = f"Incorrect command range assessment, expecting standard global {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, CommandIdType.kStandardGlobal, msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=False), msg)
asserts.assert_true(is_standard_command_id(id), msg)

def check_scoped_non_global(id):
id_type = command_id_type(id)
msg = f"Incorrect command range assessment, expecting scoped non-global {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, CommandIdType.kScopedNonGlobal, msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=False), msg)
asserts.assert_true(is_standard_command_id(id), msg)

def check_manufacturer(id):
id_type = command_id_type(id)
msg = f"Incorrect command range assessment, expecting manufacturer {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, CommandIdType.kManufacturer, msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=True), msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=True), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_command_id(id), msg)

def check_test(id):
id_type = command_id_type(id)
msg = f"Incorrect command range assessment, expecting test {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, CommandIdType.kTest, msg)
asserts.assert_true(is_valid_command_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_command_id(id_type, allow_test=False), msg)
asserts.assert_true(is_valid_command_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_command_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_command_id(id), msg)

def check_all_bad(id):
id_type = command_id_type(id)
msg = f"Incorrect command range assessment, expecting invalid {id:08x}, type = {id_type}"
asserts.assert_equal(id_type, CommandIdType.kInvalid, msg)
asserts.assert_false(is_valid_command_id(id_type, allow_test=True), msg)
asserts.assert_false(is_valid_command_id(id_type, allow_test=False), msg)
asserts.assert_false(is_valid_command_id(id, allow_test=True), msg)
asserts.assert_false(is_valid_command_id(id, allow_test=False), msg)
asserts.assert_false(is_standard_command_id(id), msg)

for id in standard_global_good:
check_standard_global(id)
Expand Down
32 changes: 28 additions & 4 deletions src/python_testing/matter_testing_infrastructure/chip/testing/global_attribute_ids.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,13 @@ def device_type_id_type(id: int) -> DeviceTypeIdType:
return DeviceTypeIdType.kInvalid


def is_valid_device_type_id(id_type: DeviceTypeIdType, allow_test=False) -> bool:
def is_standard_device_type_id(id: int) -> bool:
id_type = device_type_id_type(id)
return id_type == DeviceTypeIdType.kStandard


def is_valid_device_type_id(id: int, allow_test=False) -> bool:
id_type = device_type_id_type(id)
valid = [DeviceTypeIdType.kStandard, DeviceTypeIdType.kManufacturer]
if allow_test:
valid.append(DeviceTypeIdType.kTest)
Expand All @@ -133,7 +139,13 @@ def cluster_id_type(id: int) -> ClusterIdType:
return ClusterIdType.kInvalid


def is_valid_cluster_id(id_type: ClusterIdType, allow_test: bool = False) -> bool:
def is_standard_cluster_id(id: int) -> bool:
id_type = cluster_id_type(id)
return id_type == ClusterIdType.kStandard


def is_valid_cluster_id(id: int, allow_test: bool = False) -> bool:
id_type = cluster_id_type(id)
valid = [ClusterIdType.kStandard, ClusterIdType.kManufacturer]
if allow_test:
valid.append(ClusterIdType.kTest)
Expand All @@ -152,13 +164,19 @@ def attribute_id_type(id: int) -> AttributeIdType:
return AttributeIdType.kInvalid


def is_valid_attribute_id(id_type: AttributeIdType, allow_test: bool = False):
def is_valid_attribute_id(id: int, allow_test: bool = False):
id_type = attribute_id_type(id)
valid = [AttributeIdType.kStandardGlobal, AttributeIdType.kStandardNonGlobal, AttributeIdType.kManufacturer]
if allow_test:
valid.append(AttributeIdType.kTest)
return id_type in valid


def is_standard_attribute_id(id: int):
id_type = attribute_id_type(id)
return id_type in [AttributeIdType.kStandardGlobal, AttributeIdType.kStandardNonGlobal]


def command_id_type(id: int) -> CommandIdType:
if id in STANDARD_PREFIX and id in COMMAND_ID_GLOBAL_STANDARD_SUFFIX:
return CommandIdType.kStandardGlobal
Expand All @@ -171,7 +189,13 @@ def command_id_type(id: int) -> CommandIdType:
return CommandIdType.kInvalid


def is_valid_command_id(id_type: CommandIdType, allow_test: bool = False):
def is_standard_command_id(id: int):
id_type = command_id_type(id)
return id_type in [CommandIdType.kScopedNonGlobal, CommandIdType.kStandardGlobal]


def is_valid_command_id(id: int, allow_test: bool = False):
id_type = command_id_type(id)
valid = [CommandIdType.kStandardGlobal, CommandIdType.kScopedNonGlobal, CommandIdType.kManufacturer]
if allow_test:
valid.append(CommandIdType.kTest)
Expand Down

0 comments on commit 29c6fd8

Please sign in to comment.