Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TC-TCTL-2.3 python test #36703

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
1 change: 1 addition & 0 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ jobs:
src/app/zap-templates/zcl/data-model/chip/software-diagnostics-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/switch-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/target-navigator-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/temperature-control-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/temperature-measurement-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/test-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/thermostat-user-interface-configuration-cluster.xml \
Expand Down
98 changes: 98 additions & 0 deletions src/python_testing/TC_TCTL_2_3.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
#
# 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:
# 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
# --endpoint 1
# --trace-to json:${TRACE_TEST_JSON}.json
# --trace-to perfetto:${TRACE_TEST_PERFETTO}.perfetto
# --PICS src/app/tests/suites/certification/ci-pics-values
# factory-reset: true
# quiet: true
# === END CI TEST ARGUMENTS ===

import chip.clusters as Clusters
from chip.testing.matter_testing import MatterBaseTest, TestStep, default_matter_test_main, has_feature, run_if_endpoint_matches
from mobly import asserts


class TC_TCTL_2_3(MatterBaseTest):
def desc_TC_TCTL_2_3(self) -> str:
return "[TC-TCTL-2.3] Optional temperature level attributes with DUT as Server"

def pics_TC_TCTL_2_3(self):
"""Return the PICS definitions associated with this test."""
pics = [
"TCTL.S", # Temperature Control as a Server
"TCTL.S.F01", # Does a device support temperature level feature
]
return pics

def steps_TC_TCTL_2_3(self) -> list[TestStep]:
steps = [
TestStep(1, "Commissioning, already done", is_commissioning=True),
TestStep(2, "TH reads from the DUT the SelectedTemperatureLevel attribute"),
TestStep(3, "TH reads from the DUT the SupportedTemperatureLevels attribute and verifies string lengths"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind adding in the expected outcome strings here too? It's not a huge deal, but it makes it much easier to update the test plan.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, added

]
return steps

@run_if_endpoint_matches(has_feature(Clusters.TemperatureControl, Clusters.TemperatureControl.Bitmaps.Feature.kTemperatureLevel))
async def test_TC_TCTL_2_3(self):
self.endpoint = self.get_endpoint()
cluster = Clusters.TemperatureControl
attributes = cluster.Attributes
self.step(1)

# Step 2: Read SelectedTemperatureLevel attribute
self.step(2)
if self.attribute_guard(endpoint=self.endpoint, attribute=attributes.SelectedTemperatureLevel):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry - I know I commented earlier that these should be changed to attribute_guard (and this is totally correct, btw - thank you). But I also just realized that these attributes are mandatory when this feature is enabled. In other words, I believe the test plan is incorrect here and you've accidentally uncovered a test bug. You can just assume these two attributes are there. In other words, just remove this attribute guard, those attributes are there, and if they're not, then the test will throw an exception, and that exception is correct and expected because it means the device configuration is incorrect.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, really useful input for understanding this functionality. I've removed attribute guard.

selected_temp = await self.read_single_attribute_check_success(
cluster=cluster,
attribute=cluster.Attributes.SelectedTemperatureLevel
)
asserts.assert_true(0 <= selected_temp <= 31,
f"SelectedTemperatureLevel {selected_temp} is out of range [0-31]")

# Step 3: Read SupportedTemperatureLevels attribute
self.step(3)
if self.attribute_guard(endpoint=self.endpoint, attribute=attributes.SupportedTemperatureLevels):
supported_temps = await self.read_single_attribute_check_success(
cluster=cluster,
attribute=cluster.Attributes.SupportedTemperatureLevels
)
asserts.assert_true(isinstance(supported_temps, list),
"SupportedTemperatureLevels should be a list")
asserts.assert_true(len(supported_temps) <= 32,
f"SupportedTemperatureLevels list length {len(supported_temps)} exceeds maximum of 32")

# Verify string lengths
for level in supported_temps:
asserts.assert_true(isinstance(level, str),
f"Temperature level {level} is not a string")
asserts.assert_true(len(level) <= 16,
f"Temperature level string '{level}' exceeds maximum length of 16")


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