[DISHM]-Initial add of yaml test scripts for dishwasher mode cluster

.github/workflows/tests.yaml

@@ -526,6 +526,7 @@ jobs:
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_TIMESYNC_3_1.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json --enable-key 000102030405060708090a0b0c0d0e0f" --script "src/python_testing/TC_TestEventTrigger.py" --script-args "--storage-path admin_storage.json --bool-arg allow_sdk_dac:true --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TestBatchInvoke.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
+                  scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TC_DISHM_1_2.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --script "src/python_testing/TestConformanceSupport.py" --script-args "--trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --app out/linux-x64-all-clusters-ipv6only-no-ble-no-wifi-tsan-clang-test/chip-all-clusters-app  --factoryreset --app-args "--discriminator 1234 --KVS kvs1 --trace-to json:out/trace_data/app-{SCRIPT_BASE_NAME}.json" --script "src/python_testing/TestGroupTableReports.py" --script-args "--storage-path admin_storage.json --commissioning-method on-network --discriminator 1234 --passcode 20202021 --trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'
                   scripts/run_in_python_env.sh out/venv './scripts/tests/run_python_test.py --script "src/python_testing/TestMatterTestingSupport.py" --script-args "--trace-to json:out/trace_data/test-{SCRIPT_BASE_NAME}.json --trace-to perfetto:out/trace_data/test-{SCRIPT_BASE_NAME}.perfetto"'

src/app/tests/suites/certification/Test_TC_DISHM_1_1.yaml

@@ -13,94 +13,139 @@
 # limitations under the License.
 # Auto-generated scripts for harness use only, please review before automation. The endpoints and cluster names are currently set to default
 
-name: 263.1.1. [TC-DISHM-1.1] Global attributes with DUT as Server
+name: 194.1.1. [TC-DISHM-1.1] Global Attributes with DUT as Server
 
 PICS:
     - DISHM.S
 
 config:
     nodeId: 0x12344321
-    cluster: "Basic Information"
-    endpoint: 0
+    cluster: "Dishwasher Mode"
+    endpoint: 1
 
 tests:
-    - label:
-          "Step 1: Commission DUT to TH (can be skipped if done in a preceding
-          test)."
-      verification: |
-
-      disabled: true
-
-    - label: "Step 2: TH reads from the DUT the ClusterRevision attribute."
-      verification: |
-          ./chip-tool dishwashermode read cluster-revision 1 1
-
-          Verify the "ClusterRevision" value is of unit16 and reflects the highest revision number 2 on the TH(Chip-tool) and below is the sample log provided for the raspi platform:
-
-          CHIP:DMG : }
-          CHIP:TOO : Endpoint: 1 Cluster: 0x0000_0059 Attribute 0x0000_FFFD DataVersion: 2488070594
-          CHIP:TOO :   ClusterRevision: 2
-      disabled: true
-
-    - label: "Step 3: TH reads from the DUT the FeatureMap attribute."
-      verification: |
-          ./chip-tool dishwashermode read feature-map 1 1
-
-          On the TH(Chip-tool) Log, Verify featureMap value is 0 and below is the sample log provided for the raspi platform:
-
-          [1690365613.351850][27441:27443] CHIP:TOO: Endpoint: 1 Cluster: 0x0000_0059 Attribute 0x0000_FFFC DataVersion: 1130015440
-          [1690365613.351911][27441:27443] CHIP:TOO:   FeatureMap: 1
-      disabled: true
-
-    - label: "Step 4: TH reads from the DUT the AttributeList attribute."
-      verification: |
-          ./chip-tool dishwashermode read attribute-list 1 1
-
-          Verify the "AttributeList " should include the mandatory attributes (values 0, 1),
-          - Global attributes  (value 65533, 65532, 65531, 65529 and 65528) and
-          - List may include optional attribute(value 0x0002), if DISHM.S.A0002(StartUpMode) supports, on the TH(Chip-tool) Log and below is the sample log provided for the raspi platform:
+    - label: "1. Wait for the commissioned device to be retrieved"
+      cluster: "DelayCommands"
+      command: "WaitForCommissionee"
+      arguments:
+          values:
+              - name: "nodeId"
+                value: nodeId
+
+    - label: "2. TH reads the ClusterRevision from DUT"
+      command: "readAttribute"
+      attribute: "ClusterRevision"
+      response:
+          value: 2
+          constraints:
+              type: int16u
+
+    - label: "3. TH reads the FeatureMap from DUT"
+      PICS: " !DISHM.S.F00 "
+      command: "readAttribute"
+      attribute: "FeatureMap"
+      response:
+          value: 0
+          constraints:
+              type: bitmap32
 
-          [1696402605.599359][7921:7923] CHIP:TOO: Endpoint: 1 Cluster: 0x0000_0059 Attribute 0x0000_FFFB DataVersion: 712950283
-          [1696402605.599377][7921:7923] CHIP:TOO:   AttributeList: 9 entries
-          [1696402605.599382][7921:7923] CHIP:TOO:     [1]: 0
-          [1696402605.599385][7921:7923] CHIP:TOO:     [2]: 1
-          [1696402605.599388][7921:7923] CHIP:TOO:     [3]: 2
-          [1696402605.599391][7921:7923] CHIP:TOO:     [4]: 3
-          [1696402605.599393][7921:7923] CHIP:TOO:     [5]: 65528
-          [1696402605.599396][7921:7923] CHIP:TOO:     [6]: 65529
-          [1696402605.599399][7921:7923] CHIP:TOO:     [7]: 65531
-          [1696402605.599402][7921:7923] CHIP:TOO:     [8]: 65532
-          [1696402605.599404][7921:7923] CHIP:TOO:     [9]: 65533
-      disabled: true
-
-    - label: "Step 5: TH reads from the DUT the EventList attribute."
-      verification: |
-          ./chip-tool dishwashermode read event-list 1 1
-
-          * Step 5 is currently not supported and SHALL be skipped.
-
-          [1696402636.316151][7926:7928] CHIP:DMG: }
-          [1696402636.316183][7926:7928] CHIP:TOO: Response Failure: IM Error 0x00000586: General error: 0x86 (UNSUPPORTED_ATTRIBUTE)
-      disabled: true
-
-    - label: "Step 6: TH reads from the DUT the AcceptedCommandList attribute."
-      verification: |
-          ./chip-tool dishwashermode read accepted-command-list 1 1
-
-          Verify the "AcceptedCommandList" contains a list of mandatory commands (value 0) on the TH (Chip-tool) and below is the sample log provided for the raspi platform:
+    - label:
+          "Given DISHM.S.F00(DEPONOFF) ensure featuremap has the correct bit set"
+      PICS: DISHM.S.F00
+      command: "readAttribute"
+      attribute: "FeatureMap"
+      response:
+          value: 1
+          constraints:
+              type: bitmap32
+
+    # Reference for "SHALL NOT contain" issue: https://github.com/project-chip/connectedhomeip/issues/28287
+    - label: "4. TH reads AttributeList from DUT"
+      PICS: PICS_EVENT_LIST_ENABLED
+      command: "readAttribute"
+      attribute: "AttributeList"
+      response:
+          constraints:
+              type: list
+              contains: [0, 1, 65528, 65529, 65530, 65531, 65532, 65533]
+
+    - label: "4. TH reads AttributeList from DUT"
+      PICS: "!PICS_EVENT_LIST_ENABLED"
+      command: "readAttribute"
+      attribute: "AttributeList"
+      response:
+          constraints:
+              type: list
+              contains: [0, 1, 65528, 65529, 65531, 65532, 65533]
 
-          [1690365651.143190][27451:27453] CHIP:TOO: Endpoint: 1 Cluster: 0x0000_0059 Attribute 0x0000_FFF9 DataVersion: 1130015440
-          [1690365651.143256][27451:27453] CHIP:TOO:   AcceptedCommandList: 1 entries
-          [1690365651.143284][27451:27453] CHIP:TOO:     [1]: 0
-      disabled: true
+    - label:
+          "4. TH reads optional attribute (DISHM.S.A0002(StartUpMode)) in
+          AttributeList"
+      PICS: DISHM.S.A0002
+      command: "readAttribute"
+      attribute: "AttributeList"
+      response:
+          constraints:
+              type: list
+              contains: [2]
 
-    - label: "Step 7: TH reads from the DUT the GeneratedCommandList attribute."
-      verification: |
-          ./chip-tool dishwashermode read generated-command-list 1 1
+    - label:
+          "4. TH reads optional attribute (DISHM.S.A0002(StartUpMode)) in
+          AttributeList"
+      PICS: " !DISHM.S.A0002 "
+      command: "readAttribute"
+      attribute: "AttributeList"
+      response:
+          constraints:
+              type: list
+              excludes: [2]
 
-          Verify " GeneratedCommandList" contains a list of mandatory commands (value 1)  on the TH(Chip-tool) Log and below is the sample log provided for the raspi platform:
+    - label:
+          "4. TH reads optional attribute (DISHM.S.F00(DEPONOFF)) in
+          AttributeList"
+      PICS: DISHM.S.F00
+      command: "readAttribute"
+      attribute: "AttributeList"
+      response:
+          constraints:
+              type: list
+              contains: [3]
 
-          [1689997224.280302][360025:360027] CHIP:TOO: Endpoint: 1 Cluster: 0x0000_0059 Attribute 0x0000_FFF8 DataVersion: 1427220838
-          [1689997224.280330][360025:360027] CHIP:TOO:   GeneratedCommandList: 1 entries
-          [1689997224.280346][360025:360027] CHIP:TOO:     [1]: 1
-      disabled: true
+    - label:
+          "4. TH reads optional attribute (DISHM.S.F00(DEPONOFF)) in
+          AttributeList"
+      PICS: " !DISHM.S.F00 "
+      command: "readAttribute"
+      attribute: "AttributeList"
+      response:
+          constraints:
+              type: list
+              excludes: [3]
+
+    # Reference for "SHALL NOT contain" issue: https://github.com/project-chip/connectedhomeip/issues/28287
+    - label: "5. TH reads from the DUT the EventList attribute"
+      PICS: PICS_EVENT_LIST_ENABLED
+      command: "readAttribute"
+      attribute: "EventList"
+      response:
+          value: []
+          constraints:
+              type: list
+
+    # Reference for "SHALL NOT contain" issue: https://github.com/project-chip/connectedhomeip/issues/28287
+    - label: "6. TH reads AcceptedCommandList from DUT"
+      command: "readAttribute"
+      attribute: "AcceptedCommandList"
+      response:
+          constraints:
+              type: list
+              contains: [0]
+
+    # Reference for "SHALL NOT contain" issue: https://github.com/project-chip/connectedhomeip/issues/28287
+    - label: "7. TH reads from the DUT the GeneratedCommandList attribute"
+      command: "readAttribute"
+      attribute: "GeneratedCommandList"
+      response:
+          constraints:
+              type: list
+              contains: [1]

src/app/tests/suites/ciTests.json

@@ -57,6 +57,7 @@
         "Test_TC_DGETH_2_2"
     ],
     "DiagnosticsLogs": ["Test_TC_DLOG_1_1"],
+    "DishwasherMode": ["Test_TC_DISHM_1_1"],
     "EnergyEVSE": ["Test_TC_EEVSE_1_1", "Test_TC_EEVSE_2_1"],
     "EnergyEVSEMode": [
         "Test_TC_EEVSEM_1_1",
@@ -406,6 +407,7 @@
         "DeviceEnergyManagementMode",
         "Descriptor",
         "DiagnosticsLogs",
+        "DishwasherMode",
         "EthernetNetworkDiagnostics",
         "EnergyEVSE",
         "EnergyEVSEMode",

src/app/tests/suites/manualTests.json

@@ -73,14 +73,6 @@
         "Test_TC_DISHALM_3_5",
         "Test_TC_DISHALM_3_6"
     ],
-    "DishwasherMode": [
-        "Test_TC_DISHM_1_1",
-        "Test_TC_DISHM_1_2",
-        "Test_TC_DISHM_2_1",
-        "Test_TC_DISHM_3_1",
-        "Test_TC_DISHM_3_2",
-        "Test_TC_DISHM_3_3"
-    ],
     "DeviceManagement": [
         "Test_TC_BINFO_3_1",
         "Test_TC_OPCREDS_3_1",
@@ -321,7 +313,6 @@
         "DeviceManagement",
         "DiagnosticsLogs",
         "DishwasherAlarm",
-        "DishwasherMode",
         "Descriptor",
         "DeviceEnergyManagementMode",
         "FanControl",

src/python_testing/TC_DISHM_1_2.py

@@ -0,0 +1,121 @@
+#
+#    Copyright (c) 2023 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.
+#
+
+import logging
+
+import chip.clusters as Clusters
+from chip.clusters.Types import NullValue
+from matter_testing_support import MatterBaseTest, async_test_body, default_matter_test_main
+from mobly import asserts
+
+
+class TC_DISHM_1_2(MatterBaseTest):
+
+    async def read_mode_attribute_expect_success(self, endpoint, attribute):
+        cluster = Clusters.Objects.DishwasherMode
+        return await self.read_single_attribute_check_success(endpoint=endpoint, cluster=cluster, attribute=attribute)
+
+    @async_test_body
+    async def test_TC_DISHM_1_2(self):
+
+        self.endpoint = self.user_params.get("endpoint", 1)
+        logging.info("This test expects to find this cluster on endpoint 1")
+
+        attributes = Clusters.DishwasherMode.Attributes
+
+        self.print_step(1, "Commissioning, already done")
+
+        if self.check_pics("DISHM.S.A0000"):
+            self.print_step(2, "Read SupportedModes attribute")
+            supported_modes = await self.read_mode_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.SupportedModes)
+
+            logging.info("SupportedModes: %s" % (supported_modes))
+
+            asserts.assert_greater_equal(len(supported_modes), 2, "SupportedModes must have at least two entries!")
+            asserts.assert_less_equal(len(supported_modes), 255, "SupportedModes must have at most 255 entries!")
+
+            supported_modes_dut = []
+            for m in supported_modes:
+                if m.mode in supported_modes_dut:
+                    asserts.fail("SupportedModes must have unique mode values!")
+                else:
+                    supported_modes_dut.append(m.mode)
+
+            labels = []
+            for m in supported_modes:
+                if m.label in labels:
+                    asserts.fail("SupportedModes must have unique mode label values!")
+                else:
+                    labels.append(m.label)
+
+            # common mode tags
+            commonTags = {0x0: 'Auto',
+                          0x1: 'Quick',
+                          0x2: 'Quiet',
+                          0x3: 'LowNoise',
+                          0x4: 'LowEnergy',
+                          0x5: 'Vacation',
+                          0x6: 'Min',
+                          0x7: 'Max',
+                          0x8: 'Night',
+                          0x9: 'Day'}
+
+            # kUnknownEnumValue may not be defined
+            try:
+                modeTags = [tag.value for tag in Clusters.DishwasherMode.Enums.ModeTag
+                            if tag is not Clusters.DishwasherMode.Enums.ModeTag.kUnknownEnumValue]
+            except AttributeError:
+                modeTags = Clusters.DishwasherMode.Enums.ModeTag
+
+            for m in supported_modes:
+                for t in m.modeTags:
+                    is_mfg = (0x8000 <= t.value and t.value <= 0xBFFF)
+                    asserts.assert_true(t.value <= 0xFFFF, "Tag value is > 16 bits")
+                    asserts.assert_true(t.value in commonTags.keys() or t.value in modeTags or is_mfg,
+                                        "Found a SupportedModes entry with invalid mode tag value!")
+
+                    asserts.assert_true(type(m.label) is str and len(m.label) in range(1, 65),
+                                        "TagName is not the appropriate length or type")
+                    if t.value == Clusters.DishwasherMode.Enums.ModeTag.kNormal:
+                        normal_present = True
+            asserts.assert_true(normal_present, "The Supported Modes does not have an entry of Normal(0x4000)")
+
+        if self.check_pics("DISHM.S.A0001"):
+            self.print_step(3, "Read CurrentMode attribute")
+            current_mode = await self.read_mode_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.CurrentMode)
+
+            logging.info("CurrentMode: %s" % (current_mode))
+            asserts.assert_true(current_mode in supported_modes_dut, "CurrentMode is not a supported mode!")
+
+        if self.check_pics("DISHM.S.A0003"):
+            self.print_step(4, "Read OnMode attribute")
+            on_mode = await self.read_mode_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.OnMode)
+
+            logging.info("OnMode: %s" % (on_mode))
+            asserts.assert_true(on_mode in supported_modes_dut or on_mode == NullValue, "OnMode is not a supported mode!")
+
+        if self.check_pics("DISHM.S.A0002"):
+            self.print_step(5, "Read StartUpMode attribute")
+            startup_mode = await self.read_mode_attribute_expect_success(endpoint=self.endpoint, attribute=attributes.StartUpMode)
+
+            logging.info("StartUpMode: %s" % (startup_mode))
+            asserts.assert_true(startup_mode in supported_modes_dut or startup_mode ==
+                                NullValue, "StartUpMode is not a supported mode!")
+
+
+if __name__ == "__main__":
+    default_matter_test_main()