Skip to content

Commit

Permalink
Fix init of all TC-OCC-* tests (#35001)
Browse files Browse the repository at this point in the history 
* Fix init of all TC-OCC-* tests

- During TE2 if was found that all TC-OCC-* tests require
  to pass a `--int-arg endpoint:N` argument which is not the right
  way to specify endpoint. This is fixed here.
- Some pre-steps were done in Step 1 which should have been done after Step 1
  so that errors are not marked as Commissioning Failure when it's test failure.

Fixes project-chip/matter-test-scripts#340

* More fixes to OCC tests

- 3.2 now properly using feature map
- Fixed typos
- Added queue flushing examples

* Restyle

* Fix line endings

* Restyled by autopep8

* Fix CI

---------

Co-authored-by: Restyled.io <[email protected]>
  • Loading branch information
@tcarmelveilleux @restyled-commits
tcarmelveilleux and restyled-commits authored Aug 22, 2024
1 parent 05ba803 commit daa2a57
Show file tree
Hide file tree
Showing 6 changed files with 907 additions and 878 deletions.
566 changes: 288 additions & 278 deletions src/python_testing/TC_OCC_2_1.py
View file

Large diffs are not rendered by default.

264 changes: 132 additions & 132 deletions src/python_testing/TC_OCC_2_2.py
View file
Original file line number Diff line number Diff line change
@@ -1,132 +1,132 @@
#
# 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.
#

# 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
# test-runner-run/run1/app: ${ALL_CLUSTERS_APP}
# test-runner-run/run1/factoryreset: True
# test-runner-run/run1/quiet: True
# test-runner-run/run1/app-args: --discriminator 1234 --KVS kvs1 --trace-to json:${TRACE_APP}.json
# test-runner-run/run1/script-args: --storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --PICS src/app/tests/suites/certification/ci-pics-values --trace-to json:${TRACE_TEST_JSON}.json --trace-to perfetto:${TRACE_TEST_PERFETTO}.perfetto
# === END CI TEST ARGUMENTS ===

import chip.clusters as Clusters
from matter_testing_support import MatterBaseTest, TestStep, async_test_body, default_matter_test_main
from mobly import asserts


class TC_OCC_2_2(MatterBaseTest):
async def read_occ_attribute_expect_success(self, endpoint, attribute):
cluster = Clusters.Objects.OccupancySensing
return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)

def desc_TC_OCC_2_2(self) -> str:
return "[TC-OCC-2.2] OccupancySensorTypeBitmap and OccupancySensorType interdependency with server as DUT"

def steps_TC_OCC_2_2(self) -> list[TestStep]:
steps = [
TestStep(1, "Commissioning, already done", is_commissioning=True),
TestStep(2, "Read OccupancySensorType attribute selection based on FeatureMap Bitmap."),
TestStep(3, "Read OccupancySensorTypeBitmap attribute selection based on FeatureMap Bitmap.")
]
return steps

def pics_TC_OCC_2_2(self) -> list[str]:
pics = [
"OCC.S",
]
return pics

@async_test_body
async def test_TC_OCC_2_2(self):

endpoint = self.user_params.get("endpoint", 1)

attributes = Clusters.OccupancySensing.Attributes
feature_map = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.FeatureMap)

self.step(1)
attribute_list = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.AttributeList)

self.step(2)
# OccupancySensorType will be determined by FeatureMap matching table at 2.7.6.2.
asserts.assert_in(attributes.OccupancySensorType.attribute_id, attribute_list,
"OccupancySensorType attribute is a mandatory attribute.")
occupancy_sensor_type_dut = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.OccupancySensorType)

# For validation purposes, 2.7.6.2 table describes what feature flags map to what type of sensors
TypeEnum = Clusters.OccupancySensing.Enums.OccupancySensorTypeEnum

Y = True
N = False
# Map is PIR, US, PHY => expected sensor type
# odd Y/N mapping to make the table align nicely
mappings = {
(N, N, N): TypeEnum.kPir,
(Y, N, N): TypeEnum.kPir,
(N, Y, N): TypeEnum.kUltrasonic,
(Y, Y, N): TypeEnum.kPIRAndUltrasonic,
(N, N, Y): TypeEnum.kPhysicalContact,
(Y, N, Y): TypeEnum.kPir,
(N, Y, Y): TypeEnum.kUltrasonic,
(Y, Y, Y): TypeEnum.kPIRAndUltrasonic,
}

FeatureBit = Clusters.OccupancySensing.Bitmaps.Feature
expected = mappings.get(
(
(feature_map & FeatureBit.kPassiveInfrared) != 0,
(feature_map & FeatureBit.kUltrasonic) != 0,
(feature_map & FeatureBit.kPhysicalContact) != 0
))

asserts.assert_equal(
occupancy_sensor_type_dut,
expected,
f"Sensor Type should be f{expected}"
)

self.step(3)
# OccupancySensorTypeBitmap will be determined by FeatureMap matching table at 2.7.6.2.
asserts.assert_in(attributes.OccupancySensorTypeBitmap.attribute_id, attribute_list,
"OccupancySensorTypeBitmap attribute is a mandatory attribute.")

occupancy_sensor_type_bitmap_dut = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.OccupancySensorTypeBitmap)

# Feature map must match the sensor type bitmap
must_match_bits = [
(Clusters.OccupancySensing.Bitmaps.OccupancySensorTypeBitmap.kPir,
Clusters.OccupancySensing.Bitmaps.Feature.kPassiveInfrared, "PIR"),
(Clusters.OccupancySensing.Bitmaps.OccupancySensorTypeBitmap.kUltrasonic,
Clusters.OccupancySensing.Bitmaps.Feature.kUltrasonic, "Ultrasonic"),
(Clusters.OccupancySensing.Bitmaps.OccupancySensorTypeBitmap.kPhysicalContact,
Clusters.OccupancySensing.Bitmaps.Feature.kPhysicalContact, "Physical contact"),
]

for sensor_bit, feature_bit, name in must_match_bits:
asserts.assert_equal(
(occupancy_sensor_type_bitmap_dut & sensor_bit) != 0,
(feature_map & feature_bit) != 0,
f"Feature bit and sensor bitmap must be equal for {name} (BITMAP: 0x{occupancy_sensor_type_bitmap_dut:02X}, FEATUREMAP: 0x{feature_map:02X})"
)


if __name__ == "__main__":
default_matter_test_main()
#
# 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.
#

# 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
# test-runner-run/run1/app: ${ALL_CLUSTERS_APP}
# test-runner-run/run1/factoryreset: True
# test-runner-run/run1/quiet: True
# test-runner-run/run1/app-args: --discriminator 1234 --KVS kvs1 --trace-to json:${TRACE_APP}.json
# test-runner-run/run1/script-args: --storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --PICS src/app/tests/suites/certification/ci-pics-values --trace-to json:${TRACE_TEST_JSON}.json --trace-to perfetto:${TRACE_TEST_PERFETTO}.perfetto --endpoint 1
# === END CI TEST ARGUMENTS ===

import chip.clusters as Clusters
from matter_testing_support import MatterBaseTest, TestStep, async_test_body, default_matter_test_main
from mobly import asserts


class TC_OCC_2_2(MatterBaseTest):
async def read_occ_attribute_expect_success(self, endpoint, attribute):
cluster = Clusters.Objects.OccupancySensing
return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)

def desc_TC_OCC_2_2(self) -> str:
return "[TC-OCC-2.2] OccupancySensorTypeBitmap and OccupancySensorType interdependency with server as DUT"

def steps_TC_OCC_2_2(self) -> list[TestStep]:
steps = [
TestStep(1, "Commissioning, already done", is_commissioning=True),
TestStep(2, "Read OccupancySensorType attribute selection based on FeatureMap Bitmap."),
TestStep(3, "Read OccupancySensorTypeBitmap attribute selection based on FeatureMap Bitmap.")
]
return steps

def pics_TC_OCC_2_2(self) -> list[str]:
pics = [
"OCC.S",
]
return pics

@async_test_body
async def test_TC_OCC_2_2(self):
endpoint = self.matter_test_config.endpoint

self.step(1) # Already done, immediately go to step 2

self.step(2)

attributes = Clusters.OccupancySensing.Attributes
feature_map = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.FeatureMap)
attribute_list = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.AttributeList)

# OccupancySensorType will be determined by FeatureMap matching table at 2.7.6.2.
asserts.assert_in(attributes.OccupancySensorType.attribute_id, attribute_list,
"OccupancySensorType attribute is a mandatory attribute.")
occupancy_sensor_type_dut = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.OccupancySensorType)

# For validation purposes, 2.7.6.2 table describes what feature flags map to what type of sensors
TypeEnum = Clusters.OccupancySensing.Enums.OccupancySensorTypeEnum

Y = True
N = False
# Map is PIR, US, PHY => expected sensor type
# odd Y/N mapping to make the table align nicely
mappings = {
(N, N, N): TypeEnum.kPir,
(Y, N, N): TypeEnum.kPir,
(N, Y, N): TypeEnum.kUltrasonic,
(Y, Y, N): TypeEnum.kPIRAndUltrasonic,
(N, N, Y): TypeEnum.kPhysicalContact,
(Y, N, Y): TypeEnum.kPir,
(N, Y, Y): TypeEnum.kUltrasonic,
(Y, Y, Y): TypeEnum.kPIRAndUltrasonic,
}

FeatureBit = Clusters.OccupancySensing.Bitmaps.Feature
expected = mappings.get(
(
(feature_map & FeatureBit.kPassiveInfrared) != 0,
(feature_map & FeatureBit.kUltrasonic) != 0,
(feature_map & FeatureBit.kPhysicalContact) != 0
))

asserts.assert_equal(
occupancy_sensor_type_dut,
expected,
f"Sensor Type should be f{expected}"
)

self.step(3)
# OccupancySensorTypeBitmap will be determined by FeatureMap matching table at 2.7.6.2.
asserts.assert_in(attributes.OccupancySensorTypeBitmap.attribute_id, attribute_list,
"OccupancySensorTypeBitmap attribute is a mandatory attribute.")

occupancy_sensor_type_bitmap_dut = await self.read_occ_attribute_expect_success(endpoint=endpoint, attribute=attributes.OccupancySensorTypeBitmap)

# Feature map must match the sensor type bitmap
must_match_bits = [
(Clusters.OccupancySensing.Bitmaps.OccupancySensorTypeBitmap.kPir,
Clusters.OccupancySensing.Bitmaps.Feature.kPassiveInfrared, "PIR"),
(Clusters.OccupancySensing.Bitmaps.OccupancySensorTypeBitmap.kUltrasonic,
Clusters.OccupancySensing.Bitmaps.Feature.kUltrasonic, "Ultrasonic"),
(Clusters.OccupancySensing.Bitmaps.OccupancySensorTypeBitmap.kPhysicalContact,
Clusters.OccupancySensing.Bitmaps.Feature.kPhysicalContact, "Physical contact"),
]

for sensor_bit, feature_bit, name in must_match_bits:
asserts.assert_equal(
(occupancy_sensor_type_bitmap_dut & sensor_bit) != 0,
(feature_map & feature_bit) != 0,
f"Feature bit and sensor bitmap must be equal for {name} (BITMAP: 0x{occupancy_sensor_type_bitmap_dut:02X}, FEATUREMAP: 0x{feature_map:02X})"
)


if __name__ == "__main__":
default_matter_test_main()
Loading

0 comments on commit daa2a57

Please sign in to comment.