Fix saveAs handling for nullable values. (#14602)

* test_cluster_placeholder.zapt should never have been checked in (and was identical to test_cluster.zapt). * Store the saveAs value as the type we expect to actually consume (this means a boxed value on Darwin, and a Nullable as needed in chip-tool). * Fix comparisons to the saveAs value to work right.
project-chip · Feb 2, 2022 · b8cb560 · b8cb560
1 parent 3c8d272
commit b8cb560
Show file tree

Hide file tree

Showing 11 changed files with 158 additions and 600 deletions.
diff --git a/examples/chip-tool/templates/partials/test_cluster.zapt b/examples/chip-tool/templates/partials/test_cluster.zapt
@@ -2,7 +2,11 @@
 class {{filename}}: public TestCommand
 {
   public:
+    {{#if ../credsIssuerConfigArg}}
     {{filename}}(CredentialIssuerCommands * credsIssuerConfig): TestCommand("{{filename}}", credsIssuerConfig), mTestIndex(0)
+    {{else}}
+    {{filename}}(): TestCommand("{{filename}}"), mTestIndex(0)
+    {{/if}}
     {
         {{#chip_tests_config}}
           {{#if (isString type)}}
@@ -93,7 +97,7 @@ class {{filename}}: public TestCommand
     {{#chip_tests_item_response_parameters}}
     {{#if saveAs}}
     {{~#if (isString type)}}{{#if (isOctetString type)}}uint8_t{{else}}char{{/if}} * {{saveAs}}Buffer = nullptr;{{/if~}}
-    {{chipType}} {{saveAs}};
+    {{zapTypeToDecodableClusterObjectType type ns=../cluster}} {{saveAs}};
     {{/if}}
     {{/chip_tests_item_response_parameters}}
     {{/chip_tests_items}}

diff --git a/examples/chip-tool/templates/partials/test_cluster_placeholder.zapt b/examples/chip-tool/templates/partials/test_cluster_placeholder.zapt
diff --git a/examples/chip-tool/templates/partials/test_cluster_value_equals.zapt b/examples/chip-tool/templates/partials/test_cluster_value_equals.zapt
@@ -5,8 +5,20 @@
   {{#if (isLiteralNull expected)}}
     VerifyOrReturn(CheckValueNull("{{label}}", {{actual}}));
   {{else}}
-    VerifyOrReturn(CheckValueNonNull("{{label}}", {{actual}}));
-    {{>valueEquals label=(concat label ".Value()") actual=(concat actual ".Value()") expected=expected isNullable=false depth=(incrementDepth depth)}}
+    {{#if (chip_tests_variables_has expected)}}
+      {{! Expected value is also a nullable. }}
+      if ({{expected}}.IsNull()) {
+        VerifyOrReturn(CheckValueNull("{{label}}", {{actual}}));
+      }
+      else
+      {
+        VerifyOrReturn(CheckValueNonNull("{{label}}", {{actual}}));
+        {{>valueEquals label=(concat label ".Value()") actual=(concat actual ".Value()") expected=(concat expected ".Value()") isNullable=false depth=(incrementDepth depth)}}
+      }
+    {{else}}
+      VerifyOrReturn(CheckValueNonNull("{{label}}", {{actual}}));
+      {{>valueEquals label=(concat label ".Value()") actual=(concat actual ".Value()") expected=expected isNullable=false depth=(incrementDepth depth)}}
+    {{/if}}
   {{/if}}
 {{else if isArray}}
     {

diff --git a/examples/chip-tool/templates/tests-commands.zapt b/examples/chip-tool/templates/tests-commands.zapt
@@ -21,7 +21,7 @@ public:
     }
 };
 
-{{>test_cluster tests=(getTests)}}
+{{>test_cluster tests=(getTests) credsIssuerConfigArg=true}}
 
 void registerCommandsTests(Commands & commands, CredentialIssuerCommands * credsIssuerConfig)
 {

diff --git a/examples/placeholder/templates/templates.json b/examples/placeholder/templates/templates.json
@@ -26,7 +26,7 @@
         },
         {
             "name": "test_cluster",
-            "path": "../../../examples/chip-tool/templates/partials/test_cluster_placeholder.zapt"
+            "path": "../../../examples/chip-tool/templates/partials/test_cluster.zapt"
         },
         {
             "name": "commandValue",

diff --git a/examples/placeholder/templates/tests-commands.zapt b/examples/placeholder/templates/tests-commands.zapt
@@ -5,7 +5,7 @@
 #include "TestCommand.h"
 
 {{#if (getTests)}}
-{{>test_cluster tests=(getTests)}}
+{{>test_cluster tests=(getTests) credsIssuerConfigArg=false}}
 {{/if}}
 
 std::unique_ptr<TestCommand>GetTestCommand(std::string testName)

diff --git a/src/app/zap-templates/partials/helper.js b/src/app/zap-templates/partials/helper.js
@@ -23,10 +23,14 @@ function pad(label, len, ch = ' ')
 function concat()
 {
   let str = ''
-  for (let arg in arguments)
+  // Last argument is our hash argument.
+  for (let arg = 0; arg < arguments.length - 1; ++arg)
   {
-    if (typeof arguments[arg] != 'object') {
+    if (typeof arguments[arg] != 'object' || arguments[arg] instanceof String) {
       str += arguments[arg];
+    } else {
+      throw new TypeError(
+          `Unexpected object in concat: ${arg}:${Object.prototype.toString.call(arguments[arg])}, ${JSON.stringify(arguments)}`);
     }
   }
   return str

diff --git a/src/darwin/Framework/CHIP/templates/partials/check_test_value.zapt b/src/darwin/Framework/CHIP/templates/partials/check_test_value.zapt
@@ -6,8 +6,17 @@
   {{#if (isLiteralNull expected)}}
     XCTAssertTrue({{actual}} == nil);
   {{else}}
+    {{#if (chip_tests_variables_has expected)}}
+      {{! Expected value is also a nullable. }}
+      if ({{expected}} == nil) {
+        XCTAssertTrue({{actual}} == nil);
+      } else {
+    {{/if}}
     XCTAssertFalse({{actual}} == nil);
     {{>check_test_value actual=actual expected=expected cluster=cluster isNullable=false}}
+    {{#if (chip_tests_variables_has expected)}}
+    }
+    {{/if}}
   {{/if}}
 {{else if isArray}}
     XCTAssertEqual([{{actual}} count], {{expected.length}});
@@ -28,11 +37,7 @@
         than "global") that are not present in the struct ? }}
   {{else}}
     {{#if (chip_tests_variables_has expected)}}
-      {{#if (isString type)}}
       XCTAssertEqualObjects({{actual}}, {{expected}});
-      {{else}}
-      XCTAssertEqual([{{actual}} {{asObjectiveCNumberType "" type true}}Value], {{expected}});
-      {{/if}}
     {{else if (isOctetString type)}}
       XCTAssertTrue([{{actual}} isEqualToData:[[NSData alloc] initWithBytes:"{{octetStringEscapedForCLiteral expected}}" length:{{expected.length}}]]);
     {{else if (isCharString type)}}

diff --git a/src/darwin/Framework/CHIP/templates/partials/test_cluster.zapt b/src/darwin/Framework/CHIP/templates/partials/test_cluster.zapt
@@ -5,7 +5,7 @@ bool testSendCluster{{parent.filename}}_{{asTestIndex index}}_{{asUpperCamelCase
 {{/if}}
 {{#chip_tests_item_response_parameters}}
 {{#if saveAs}}
-{{asObjectiveCBasicType type is_mutable=true}} {{saveAs}};
+{{asObjectiveCType type ../cluster}} {{saveAs}};
 {{/if}}
 {{/chip_tests_item_response_parameters}}
 
@@ -173,27 +173,25 @@ ResponseHandler {{> subscribeDataCallback}} = nil;
         {{#if (isLiteralNull expectedConstraints.notValue)}}
           XCTAssertFalse(actualValue == nil);
         {{else}}
-          if (actualValue != nil) {
-            {{#if (isString type)}}
+          {{#if (chip_tests_variables_has expectedConstraints.notValue)}}
             XCTAssertNotEqualObjects(actualValue, {{expectedConstraints.notValue}});
-            {{else}}
-            XCTAssertNotEqual([actualValue {{asObjectiveCNumberType "" type true}}Value], {{asTypedLiteral expectedConstraints.notValue type}});
-            {{/if}}
-          }
+          {{else}}
+            if (actualValue != nil) {
+              {{#if (isString type)}}
+              XCTAssertNotEqualObjects(actualValue, {{expectedConstraints.notValue}});
+              {{else}}
+              XCTAssertNotEqual([actualValue {{asObjectiveCNumberType "" type true}}Value], {{asTypedLiteral expectedConstraints.notValue type}});
+             {{/if}}
+            }
+          {{/if}}
         {{/if}}
         }
         {{/if}}
         {{/if}}
         {{#if saveAs}}
         {
           {{> actualValue}}
-          {{#if (isOctetString type)}}
-        {{saveAs}} = [NSMutableData dataWithData:actualValue];
-          {{else if (isCharString type)}}
-        {{saveAs}} = [NSMutableString stringWithString:actualValue];
-          {{else}}
-        {{saveAs}} = [actualValue {{asObjectiveCNumberType "" type true}}Value];
-          {{/if}}
+          {{saveAs}} = actualValue;
         }
         {{/if}}
         {{/chip_tests_item_response_parameters}}

diff --git a/src/darwin/Framework/CHIP/templates/partials/test_value.zapt b/src/darwin/Framework/CHIP/templates/partials/test_value.zapt
@@ -28,11 +28,7 @@
     {{/zcl_struct_items_by_struct_name}}
 
   {{else if (chip_tests_variables_has definedValue)}}
-    {{#if (isString type)}}
     {{target}} = [{{definedValue}} copy];
-    {{else}}
-    {{target}} = [NSNumber numberWith{{asObjectiveCNumberType definedValue type false}}:{{definedValue}}];
-    {{/if}}
   {{else if (isCharString type)}}
     {{target}} = @"{{definedValue}}";
   {{else if (isOctetString type)}}