TC-CC-2.2: Add (#34645)
* TC-CC-2.2: Add
* Restyled by isort
* linter
* Address TP review comments
* address remaining TP review comments
---------
Co-authored-by: Restyled.io <commits@restyled.io>
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
index bd89c46..8284b5a 100644
--- a/.github/workflows/tests.yaml
+++ b/.github/workflows/tests.yaml
@@ -509,6 +509,7 @@
scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_ACE_1_4.py'
scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_ACE_1_5.py'
scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_AccessChecker.py'
+ scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_CC_2_2.py'
scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_CC_10_1.py'
scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_CGEN_2_4.py'
scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --load-from-env /tmp/test_env.yaml --script src/python_testing/TC_CNET_1_4.py'
diff --git a/src/python_testing/TC_CC_2_2.py b/src/python_testing/TC_CC_2_2.py
new file mode 100644
index 0000000..66ed2a8
--- /dev/null
+++ b/src/python_testing/TC_CC_2_2.py
@@ -0,0 +1,290 @@
+#
+# 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 logging
+import time
+
+import chip.clusters as Clusters
+from chip.clusters import ClusterObjects as ClusterObjects
+from matter_testing_support import (ClusterAttributeChangeAccumulator, MatterBaseTest, TestStep, default_matter_test_main,
+ has_cluster, per_endpoint_test)
+from mobly import asserts
+from test_plan_support import commission_if_required, if_feature_supported, read_attribute, verify_success
+
+
+class TC_CC_2_3(MatterBaseTest):
+
+ # Test includes several long waits, adjust timeout to accommodate.
+ @property
+ def default_timeout(self) -> int:
+ return 180
+
+ def steps_TC_CC_2_2(self):
+ THcommand = "Test Harness sends the"
+
+ def store_values(attr: str) -> str:
+ return f"TH stores the reported values of _{attr}_ in all incoming reports for _{attr}_ attribute, that contains data in _reportedCurrentHueValuesList_, over a period of 20 seconds."
+
+ def verify_entry_count(attr: str) -> str:
+ return f'TH verifies that _reportedCurrentHueValuesList_ does not contain more than 10 entries for _{attr}_'
+
+ def entry_count_verification() -> str:
+ return '_reportedCurrentHueValuesList_ has 10 or less entries in the list'
+
+ return [TestStep(1, commission_if_required(), is_commissioning=True),
+ TestStep(2, read_attribute('FeatureMap')),
+ TestStep(3, read_attribute('AttributeList')),
+ TestStep(4, read_attribute('ServerList', 'Descriptor')),
+ TestStep(
+ 5, f"If OnOff cluster is present in _ServerList_, {THcommand} On command on OnOff cluster", verify_success()),
+ TestStep(
+ 6, f'{if_feature_supported("HS")}, {THcommand} MoveHue with _MoveMode_ field set to Down, _Rate_ field set to 255 and remaining fields set to 0', verify_success()),
+ TestStep(7, f'{if_feature_supported("HS")}, {THcommand} MoveSaturation with _MoveMode_ field set to Down, _Rate_ field set to 255 and remaining fields set to 0', verify_success()),
+ TestStep(8, 'Set up a subscription wildcard subscription for the Color Control Cluster, with MinIntervalFloor set to 0, MaxIntervalCeiling set to 30 and KeepSubscriptions set to false',
+ 'Subscription successfully established'),
+ TestStep(9, 'If the HS feature is not supported, skip step 10 to 15'),
+ TestStep(10, f'{THcommand} MoveToHue with _Hue_ field set to 254, _TransitionTime_ field set to 100, _Direction_ field set to Shortest and remaining fields set to 0', verify_success()),
+ TestStep(11, store_values('CurrentHue')),
+ TestStep(12, verify_entry_count('CurrentHue'), entry_count_verification()),
+ TestStep(
+ 13, f"{THcommand} MoveToSaturation with _Saturation_ field set to 254, _TransitionTime_ field set to 100 and remaining fields set to 0"),
+ TestStep(14, store_values('CurrentSaturation')),
+ TestStep(15, verify_entry_count('CurrentSaturation'), entry_count_verification()),
+ TestStep(16, 'If XY feature is not supported, skip steps 17-21'),
+ TestStep(
+ "17a", f"{THcommand} MoveToColor with _ColorX_ field set to 32768, _ColorY_ set to 19660, _TransitionTime_ field set to 0 and remaining fields set to 0"),
+ TestStep(
+ "17b", f"{THcommand} MoveToColor with _ColorX_ field set to 13107, _ColorY_ set to 13107, _TransitionTime_ field set to 100 and remaining fields set to 0"),
+ TestStep(18, store_values('CurrentX')),
+ TestStep(19, store_values('CurrentY')),
+ TestStep(20, verify_entry_count('CurrentX'), entry_count_verification()),
+ TestStep(21, verify_entry_count('CurrentY'), entry_count_verification()),
+ TestStep(22, "If the EHUE feature is not supported, skip steps 23 to 25"),
+ TestStep(23, f"{THcommand} EnhancedMoveToHue with _EnhancedHue_ field set to 0, _TransitionTime_ field set to 100, _Direction_ field set to Shortest and remaining fields set to 0", verify_success()),
+ TestStep(24, store_values('EnhancedCurrentHue')),
+ TestStep(25, verify_entry_count('EnhancedCurrentHue'), entry_count_verification()),
+ TestStep(26, "If the RemainingTime attribute is not supported, skip the remaining steps and end test case"),
+ TestStep(27, store_values('RemainingTime')),
+ TestStep(
+ 29, f"If the XY feature is supported and the HS feature is not supported, {THcommand} MoveToColor with _ColorX_ field set to 32768, _ColorY_ set to 19660, _TransitionTime_ field set to 100 and remaining fields set to 0", verify_success()),
+ TestStep(30, "Wait for 5 seconds"),
+ TestStep(
+ 32, f"If the XY feature is supported and the HS feature is not supported, {THcommand} MoveToColor with _ColorX_ field set to 13107, _ColorY_ set to 13107, _TransitionTime_ field set to 150 and remaining fields set to 0", verify_success()),
+ TestStep(33, "Wait for 20 seconds"),
+ TestStep(34, "TH verifies _reportedRemainingTimeValuesList_ contains three entries",
+ "_reportedRemainingTimeValuesList_ has 3 entries in the list"),
+ TestStep(35, "TH verifies the first entry in _reportedRemainingTimeValuesList_ is 100",
+ "The first entry in _reportedRemainingTimeValuesList_ is equal to 100"),
+ TestStep(36, "TH verifies the second entry in _reportedRemainingTimeValuesList_ is approximately 150",
+ "The second entry in _reportedRemainingTimeValuesList_ is approximately equal to 150"),
+ TestStep(37, "TH verifies the third entry in _reportedRemainingTimeValuesList_ is 0",
+ "The third entry in _reportedRemainingTimeValuesList_ is equal to 0")
+ ]
+
+ @per_endpoint_test(has_cluster(Clusters.ColorControl))
+ async def test_TC_CC_2_2(self):
+ gather_time = 20
+
+ # commissioning - already done
+ self.step(1)
+
+ cc = Clusters.ColorControl
+
+ self.step(2)
+ feature_map = await self.read_single_attribute_check_success(cluster=cc, attribute=cc.Attributes.FeatureMap)
+ supports_hs = (feature_map & cc.Bitmaps.Feature.kHueAndSaturation) != 0
+ supports_xy = (feature_map & cc.Bitmaps.Feature.kXy) != 0
+ supports_ehue = (feature_map & cc.Bitmaps.Feature.kEnhancedHue) != 0
+
+ self.step(3)
+ attribute_list = await self.read_single_attribute_check_success(cluster=cc, attribute=cc.Attributes.AttributeList)
+
+ self.step(4)
+ server_list = await self.read_single_attribute_check_success(cluster=Clusters.Descriptor, attribute=Clusters.Descriptor.Attributes.ServerList)
+
+ self.step(5)
+ if Clusters.OnOff.id in server_list:
+ cmd = Clusters.OnOff.Commands.On()
+ await self.send_single_cmd(cmd)
+ else:
+ self.mark_current_step_skipped()
+
+ self.step(6)
+ if supports_hs:
+ cmd = cc.Commands.MoveHue(moveMode=cc.Enums.HueMoveMode.kDown, rate=225)
+ await self.send_single_cmd(cmd)
+ else:
+ self.mark_current_step_skipped()
+
+ self.step(7)
+ if supports_hs:
+ cmd = cc.Commands.MoveSaturation(moveMode=cc.Enums.SaturationMoveMode.kDown, rate=225)
+ await self.send_single_cmd(cmd)
+ else:
+ self.mark_current_step_skipped()
+
+ self.step(8)
+ sub_handler = ClusterAttributeChangeAccumulator(cc)
+ await sub_handler.start(self.default_controller, self.dut_node_id, self.matter_test_config.endpoint)
+
+ def accumulate_reports():
+ sub_handler.reset()
+ logging.info(f"Test will now wait {gather_time} seconds to accumulate reports")
+ time.sleep(gather_time)
+
+ def check_report_counts(attr: ClusterObjects.ClusterAttributeDescriptor):
+ count = sub_handler.attribute_report_counts[attr]
+ # TODO: should be 12 - see issue #34646
+ # asserts.assert_less_equal(count, 12, "More than 12 reports received")
+ asserts.assert_less_equal(count, gather_time, f"More than {gather_time} reports received")
+
+ self.step(9)
+ if not supports_hs:
+ self.skip_step(10)
+ self.skip_step(11)
+ self.skip_step(12)
+ self.skip_step(13)
+ self.skip_step(14)
+ self.skip_step(15)
+ else:
+ self.step(10)
+ cmd = cc.Commands.MoveToHue(hue=254, transitionTime=100, direction=cc.Enums.HueDirection.kShortestDistance)
+ await self.send_single_cmd(cmd)
+
+ self.step(11)
+ accumulate_reports()
+
+ self.step(12)
+ check_report_counts(cc.Attributes.CurrentHue)
+
+ self.step(13)
+ cmd = cc.Commands.MoveToSaturation(saturation=254, transitionTime=100)
+ await self.send_single_cmd(cmd)
+
+ self.step(14)
+ accumulate_reports()
+
+ self.step(15)
+ check_report_counts(cc.Attributes.CurrentSaturation)
+
+ self.step(16)
+ if not supports_xy:
+ self.skip_step(17)
+ self.skip_step(18)
+ self.skip_step(19)
+ self.skip_step(20)
+ self.skip_step(21)
+ else:
+ self.step("17a")
+ cmd = cc.Commands.MoveToColor(colorX=32768, colorY=19660, transitionTime=0)
+ await self.send_single_cmd(cmd)
+
+ self.step("17b")
+ cmd = cc.Commands.MoveToColor(colorX=13107, colorY=13107, transitionTime=0)
+ await self.send_single_cmd(cmd)
+
+ self.step(18)
+ accumulate_reports()
+
+ self.step(19)
+ # reports for x and y are both accumulated in a dict - done above
+
+ self.step(20)
+ check_report_counts(cc.Attributes.CurrentX)
+
+ self.step(21)
+ check_report_counts(cc.Attributes.CurrentY)
+
+ self.step(22)
+ if not supports_ehue:
+ self.skip_step(23)
+ self.skip_step(24)
+ self.skip_step(25)
+ else:
+ self.step(23)
+ cmd = cc.Commands.EnhancedMoveToHue(enhancedHue=0, transitionTime=100,
+ direction=cc.Enums.HueDirection.kShortestDistance)
+ await self.send_single_cmd(cmd)
+
+ self.step(24)
+ accumulate_reports()
+
+ self.step(25)
+ check_report_counts(cc.Attributes.EnhancedCurrentHue)
+
+ self.step(26)
+ if cc.Attributes.RemainingTime.attribute_id not in attribute_list:
+ self.skip_all_remaining_steps(27)
+ return
+
+ self.step(27)
+ accumulate_reports()
+
+ self.step(29)
+ # TODO: If this is mandatory, we should just omit this
+ if supports_xy:
+ cmd = cc.Commands.MoveToColor(colorX=32768, colorY=19660, transitionTime=100)
+ await self.send_single_cmd(cmd)
+ else:
+ self.mark_current_step_skipped()
+
+ self.step(30)
+ logging.info("Test will now wait for 5 seconds")
+ time.sleep(5)
+
+ self.step(32)
+ if supports_xy:
+ cmd = cc.Commands.MoveToColor(colorX=13107, colorY=13107, transitionTime=150)
+ await self.send_single_cmd(cmd)
+ else:
+ self.mark_current_step_skipped()
+
+ self.step(33)
+ logging.info("Test will now wait for 20 seconds")
+ time.sleep(20)
+
+ self.step(34)
+ # TODO: Re-enable checks 34, 36 when #34643 is addressed
+ logging.info(f'received reports: {sub_handler.attribute_reports[cc.Attributes.RemainingTime]}')
+ # count = sub_handler.attribute_report_counts[cc.Attributes.RemainingTime]
+ # asserts.assert_equal(count, 3, "Unexpected number of reports received")
+
+ self.step(35)
+ asserts.assert_equal(sub_handler.attribute_reports[cc.Attributes.RemainingTime][0].value, 100, "Unexpected first report")
+
+ self.step(36)
+ # asserts.assert_almost_equal(
+ # sub_handler.attribute_reports[cc.Attributes.RemainingTime][1].value, 0, delta=10, msg="Unexpected second report")
+
+ self.step(37)
+ asserts.assert_equal(sub_handler.attribute_reports[cc.Attributes.RemainingTime][-1].value, 0, "Unexpected last report")
+
+
+if __name__ == "__main__":
+ default_matter_test_main()
diff --git a/src/python_testing/test_plan_support.py b/src/python_testing/test_plan_support.py
index 1acb857..3e332e1 100644
--- a/src/python_testing/test_plan_support.py
+++ b/src/python_testing/test_plan_support.py
@@ -76,3 +76,7 @@
def verify_commissioning_successful() -> str:
return 'Verify the commissioning is successful.'
+
+
+def if_feature_supported(feature: str) -> str:
+ return f"If the {feature} is supported"
