Add TC_EWATERHTRM_2_1.py

src/python_testing/TC_EWATERHTRM_2_1.py

@@ -0,0 +1,162 @@
+#
+#    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: ${WATER_HEATER_MANAGEMENT_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 --endpoint 1 --trace-to json:${TRACE_TEST_JSON}.json --trace-to perfetto:${TRACE_TEST_PERFETTO}.perfetto
+# === END CI TEST ARGUMENTS ===
+
+import logging
+from time import sleep
+
+import chip.clusters as Clusters
+from matter_testing_support import MatterBaseTest, TestStep, async_test_body, default_matter_test_main, type_matches
+from chip.interaction_model import Status
+from mobly import asserts
+
+
+class TC_EWATERHTRM_2_1(MatterBaseTest):
+
+    def __init__(self, *args):
+        super().__init__(*args)
+        self.endpoint = 0
+        self.mode_ok = 0
+        self.mode_fail = 0
+
+    def steps_TC_EWATERHTRM_2_1(self) -> list[TestStep]:
+        steps = [
+            TestStep(1, "Commissioning, already done", is_commissioning=True),
+            TestStep(2, "Read the SupportedModes attribute"),
+            TestStep(3, "Read the CurrentMode attribute"),
+            TestStep(4, "Send ChangeToMode command with NewMode"),
+            TestStep(5, "Manually put the device in a state from which it will FAIL to transition"),
+            TestStep(6, "Read CurrentMode attribute"),
+            TestStep(7, "Send ChangeToMode command with NewMode"),
+            TestStep(8, "Read CurrentMode attribute"),
+            TestStep(9, "Manually put the device in a state from which it will SUCCESSFULLY transition"),
+            TestStep(10, "Read CurrentMode attribute"),
+            TestStep(11, "Send ChangeToMode command with NewMode"),
+            TestStep(12, "Read CurrentMode attribute"),
+            TestStep(13, "Send ChangeToMode command with NewMode set to an invalid mode"),
+            TestStep(14, "Read CurrentMode attribute"),
+        ]
+        return steps
+
+    async def read_mod_attribute_expect_success(self, endpoint, attribute):
+        cluster = Clusters.Objects.WaterHeaterMode
+        return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)
+
+    async def send_change_to_mode_cmd(self, newMode) -> Clusters.Objects.WaterHeaterMode.Commands.ChangeToModeResponse:
+        ret = await self.send_single_cmd(cmd=Clusters.Objects.WaterHeaterMode.Commands.ChangeToMode(newMode=newMode), endpoint=self.endpoint)
+        asserts.assert_true(type_matches(ret, Clusters.Objects.WaterHeaterMode.Commands.ChangeToModeResponse),
+                            "Unexpected return type for Water Heater Mode ChangeToMode")
+        return ret
+
+    def pics_TC_EWATERHTRM_2_1(self) -> list[str]:
+        return ["EWATERHTRM.S"]
+
+    @async_test_body
+    async def test_TC_EWATERHTRM_2_1(self):
+
+        ModeOff    = 0
+        ModeManual = 1
+        ModeTimed  = 2
+
+        self.endpoint = self.matter_test_config.endpoint
+
+        attributes = Clusters.WaterHeaterMode.Attributes
+
+        self.step(1)
+
+        self.step(2)
+
+        supported_modes = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.SupportedModes)
+
+        logging.info(f"SupportedModes: {supported_modes}")
+
+        asserts.assert_greater_equal(len(supported_modes), 2, "SupportedModes must have at least two entries!")
+
+        modes = [m.mode for m in supported_modes]
+
+        self.step(3)
+
+        old_current_mode = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
+
+        logging.info(f"CurrentMode: {old_current_mode}")
+
+        # pick a value that's not on the list of supported modes
+        invalid_mode = max(modes) + 1
+
+        self.step(4)
+
+        ret = await self.send_change_to_mode_cmd(newMode=old_current_mode)
+        logging.info(f"ret.status {ret.status}")
+        asserts.assert_true(ret.status == Status.Success, "Changing the mode to the current mode should be a no-op")
+
+        # Steps 5-9 are not performed as EWATERHTRM.S.M.CAN_TEST_MODE_FAILURE is false
+        self.step(5)
+        self.step(6)
+        self.step(7)
+        self.step(8)
+        self.step(9)
+
+        self.step(10)
+
+        old_current_mode = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
+
+        logging.info(f"CurrentMode: {old_current_mode}")
+
+        self.step(11)
+
+        ret = await self.send_change_to_mode_cmd(newMode=ModeManual)
+        asserts.assert_true(ret.status == Status.Success,
+                            f"Changing to mode {ModeManual}must succeed due to the current state of the device")
+
+        self.step(12)
+
+        current_mode = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
+
+        logging.info(f"CurrentMode: {current_mode}")
+
+        asserts.assert_true(current_mode == ModeManual,
+                            "CurrentMode doesn't match the argument of the successful ChangeToMode command!")
+
+        self.step(13)
+
+        ret = await self.send_change_to_mode_cmd(newMode=invalid_mode)
+        logging.info(f"ret {ret}")
+        asserts.assert_true(ret.status == Status.Failure,
+                            f"Attempt to change to invalid mode {invalid_mode} didn't fail as expected")
+
+        self.step(14)
+
+        current_mode = await self.read_mod_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
+
+        logging.info(f"CurrentMode: {current_mode}")
+
+        asserts.assert_true(current_mode == ModeManual, "CurrentMode changed after failed ChangeToMode command!")
+
+
+if __name__ == "__main__":
+    default_matter_test_main()