Add a hasValue constraint in YAML. (#18770)

* Add a hasValue constraint in YAML.

Some commands require or forbid certain fields to be present in
certain conditions; we should have a way to test for that in YAML.

* Fix spellcheck job.

.github/.wordlist.txt

@@ -586,6 +586,7 @@ hardknott
 hardwarever
 HardwareVersion
 HardwareVersionString
+hasValue
 hci
 hciattach
 hciconfig

examples/chip-tool/templates/tests/partials/checks/maybeCheckExpectedConstraints.zapt

@@ -1,6 +1,9 @@
 {{#if hasExpectedConstraints}}
-    {{#if isOptional}}
-        VerifyOrReturn(CheckValuePresent("{{asPropertyValue dontUnwrapValue=true}}", {{asPropertyValue dontUnwrapValue=true}}));
+    {{~#if isOptional}}
+        {{~#if (hasProperty expectedConstraints "hasValue")}}VerifyOrReturn(CheckConstraintHasValue("{{asPropertyValue dontUnwrapValue=true}}", {{asPropertyValue dontUnwrapValue=true}}, {{expectedConstraints.hasValue}}));
+        {{else}}
+        if ({{asPropertyValue dontUnwrapValue=true}}.HasValue()) {
+        {{/if}}
     {{/if}}
 
     {{~#if (hasProperty expectedConstraints "type")}}VerifyOrReturn(CheckConstraintType("{{asPropertyValue}}", "", "{{expectedConstraints.type}}"));{{/if}}
@@ -32,5 +35,10 @@
             VerifyOrReturn(CheckConstraintNotValue("{{asPropertyValue}}", {{asPropertyValue}}, {{asTypedLiteral expectedConstraints.notValue type}}));
         {{/if}}
     {{/if}}
+    {{~#if isOptional}}
+        {{~#unless (hasProperty expectedConstraints "hasValue")}}
+        }
+        {{/unless}}
+    {{/if}}
 {{/if}}
 

src/app/tests/suites/README.md

@@ -167,6 +167,7 @@ properties:
 
 | Name        | Description                                                 | Required               |
 | ----------- | ----------------------------------------------------------- | ---------------------- |
+| hasValue    | If true, must have value. If false, must not have value.    | No (If other provided) |
 | minValue    | Minimum value to expect from the command response.          | No (If other provided) |
 | maxValue    | Maximum value to expect from the command response.          | No (If other provided) |
 | notValue    | Validate the the value is not what is provided.             | No (If other provided) |
@@ -178,6 +179,9 @@ properties:
 | isUpperCase | Validates if the char_string is upper case.                 | No (If other provided) |
 | isHexString | Checks whether the char_string is a hex string.             | No (If other provided) |
 
+Note: The hasValue constraint is only applied to optional fields. The other
+constraints are ignored for optional fields that do not have a value.
+
 Additionally, the object exhibits the following autogenerated properties:
 
 | Name  | Description        |

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

@@ -131,9 +131,11 @@ tests:
                 value: 0x0
               - name: "LocalStartTime"
                 constraints:
+                    hasValue: true
                     type: epoch-s
               - name: "LocalEndTime"
                 constraints:
+                    hasValue: true
                     type: epoch-s
 
     - label:
@@ -171,6 +173,12 @@ tests:
                 value: 21
               - name: "status"
                 value: 0x85
+              - name: "LocalStartTime"
+                constraints:
+                    hasValue: false
+              - name: "LocalEndTime"
+                constraints:
+                    hasValue: false
 
     - label:
           "send Get Year Day Schedule Command to DUT and verify NOT_FOUND
@@ -190,6 +198,12 @@ tests:
                 value: 5
               - name: "status"
                 value: 0x8B
+              - name: "LocalStartTime"
+                constraints:
+                    hasValue: false
+              - name: "LocalEndTime"
+                constraints:
+                    hasValue: false
 
     - label:
           "send Get Year Day Schedule Command  to DUT and verify NOT_FOUND
@@ -209,6 +223,12 @@ tests:
                 value: 2
               - name: "status"
                 value: 0x8B
+              - name: "LocalStartTime"
+                constraints:
+                    hasValue: false
+              - name: "LocalEndTime"
+                constraints:
+                    hasValue: false
 
     - label: "Send Set Year Day Schedule Command to DUT"
       command: "SetYearDaySchedule"

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

@@ -111,22 +111,27 @@ tests:
                 value: 0x0
               - name: "daysMask"
                 constraints:
+                    hasValue: true
                     minValue: 0
                     maxValue: 6
               - name: "startHour"
                 constraints:
+                    hasValue: true
                     minValue: 0
                     maxValue: 23
               - name: "startMinute"
                 constraints:
+                    hasValue: true
                     minValue: 0
                     maxValue: 59
               - name: "endHour"
                 constraints:
+                    hasValue: true
                     minValue: 0
                     maxValue: 23
               - name: "endMinute"
                 constraints:
+                    hasValue: true
                     minValue: 0
                     maxValue: 59
 
@@ -171,6 +176,21 @@ tests:
                 value: 1
               - name: "status"
                 value: 0x85
+              - name: "daysMask"
+                constraints:
+                    hasValue: false
+              - name: "startHour"
+                constraints:
+                    hasValue: false
+              - name: "startMinute"
+                constraints:
+                    hasValue: false
+              - name: "endHour"
+                constraints:
+                    hasValue: false
+              - name: "endMinute"
+                constraints:
+                    hasValue: false
 
     - label: "Clear all week day schedules for the first user"
       command: "ClearWeekDaySchedule"
@@ -197,3 +217,18 @@ tests:
                 value: 1
               - name: "status"
                 value: 0x8B
+              - name: "daysMask"
+                constraints:
+                    hasValue: false
+              - name: "startHour"
+                constraints:
+                    hasValue: false
+              - name: "startMinute"
+                constraints:
+                    hasValue: false
+              - name: "endHour"
+                constraints:
+                    hasValue: false
+              - name: "endMinute"
+                constraints:
+                    hasValue: false

src/app/tests/suites/include/ConstraintsChecker.h

@@ -400,4 +400,23 @@ class ConstraintsChecker
         }
         return CheckConstraintNotValue(itemName, current, expected.Value());
     }
+
+    template <typename T>
+    bool CheckConstraintHasValue(const char * itemName, const chip::Optional<T> & current, bool expected)
+    {
+        if (current.HasValue() == expected)
+        {
+            return true;
+        }
+
+        if (current.HasValue())
+        {
+            Exit(std::string(itemName) + " not expected to have a value but does");
+        }
+        else
+        {
+            Exit(std::string(itemName) + " expected to have a value but doesn't");
+        }
+        return false;
+    }
 };