[im/test] Fix interaction model subscription test (#9677)

* Revert "[testsuite] Refactor test suite simulated cluster command" This reverts commit 8390956. * Update subscription test per comment * Apply comments * Port test to darwin * Run Codegen Co-authored-by: Vivien Nicolas <[email protected]>
project-chip · Sep 16, 2021 · b4d7eb3 · b4d7eb3
1 parent 24e4df6
commit b4d7eb3
Show file tree

Hide file tree

Showing 16 changed files with 1,230 additions and 337 deletions.
diff --git a/examples/chip-tool/templates/partials/process_response_value.zapt b/examples/chip-tool/templates/partials/process_response_value.zapt
diff --git a/examples/chip-tool/templates/partials/test_cluster.zapt b/examples/chip-tool/templates/partials/test_cluster.zapt
@@ -46,19 +46,21 @@ class {{filename}}: public TestCommand
 
     {{#chip_tests_items}}
     {{#if (isTestOnlyCluster cluster)}}
-    {{> (asTestSuiteSimulatedClusterCommandPartial command) }}
+    CHIP_ERROR TestSendCluster{{asUpperCamelCase cluster}}Command{{asUpperCamelCase command}}_{{index}}()
+    {
+        ChipLogProgress(chipTool, "{{cluster}} - {{label}}");
+
+        return {{command}}({{#chip_tests_item_parameters}}{{#not_first}}, {{/not_first}}{{definedValue}}{{/chip_tests_item_parameters}});
+    }
     {{else}}
     // Test {{label}}
     using SuccessCallback_{{index}} = void (*)(void * context{{#chip_tests_item_response_parameters}}, {{#if isList}}uint16_t count, {{/if}}{{chipType}} {{#if isList}}* {{/if}}{{asLowerCamelCase name}}{{/chip_tests_item_response_parameters}});
     chip::Callback::Callback<SuccessCallback_{{index}}> mOnSuccessCallback_{{index}} { OnTestSendCluster{{asUpperCamelCase cluster}}Command{{asUpperCamelCase command}}_{{index}}_SuccessResponse, this };
     chip::Callback::Callback<DefaultFailureCallback> mOnFailureCallback_{{index}} { OnTestSendCluster{{asUpperCamelCase cluster}}Command{{asUpperCamelCase command}}_{{index}}_FailureResponse, this };
-    {{#if isSubscribeAttribute}}
-    chip::Callback::Callback<DefaultSuccessCallback> mOnSubscriptionEstablishedCallback_{{index}} { SubscribeAttribute_{{ index }}_OnSubscriptionEstablishedCallback, this };
-    {{/if}}
 
     bool mIsFailureExpected_{{index}} = {{response.error}};
 
-    {{#if isSubscribeAttribute}}
+    {{#if isWaitForReport}}
     bool mReceivedReport_{{index}} = false;
     {{/if}}
 
@@ -81,8 +83,9 @@ class {{filename}}: public TestCommand
         {{/chip_tests_item_parameters}}
         err = cluster.{{asUpperCamelCase command}}(mOnSuccessCallback_{{index}}.Cancel(), mOnFailureCallback_{{index}}.Cancel(){{#chip_tests_item_parameters}}, {{asLowerCamelCase name}}Argument{{/chip_tests_item_parameters}});
         {{else if isSubscribeAttribute}}
-        cluster.ReportAttribute{{asUpperCamelCase attribute}}(mOnSuccessCallback_{{index}}.Cancel());
-        err = cluster.ConfigureAttribute{{asUpperCamelCase attribute}}(mOnSubscriptionEstablishedCallback_{{index}}.Cancel(), mOnFailureCallback_{{index}}.Cancel(), {{minInterval}}, {{maxInterval}});
+        err = cluster.ConfigureAttribute{{asUpperCamelCase attribute}}(mOnSuccessCallback_{{index}}.Cancel(), mOnFailureCallback_{{index}}.Cancel(), {{minInterval}}, {{maxInterval}});
+        {{else if isWaitForReport}}
+        err = cluster.ReportAttribute{{asUpperCamelCase attribute}}(mOnSuccessCallback_{{index}}.Cancel());
         {{else if isReadAttribute}}
         err = cluster.ReadAttribute{{asUpperCamelCase attribute}}(mOnSuccessCallback_{{index}}.Cancel(), mOnFailureCallback_{{index}}.Cancel());
         {{else if isWriteAttribute}}
@@ -98,21 +101,10 @@ class {{filename}}: public TestCommand
         err = CHIP_ERROR_NOT_IMPLEMENTED;
         {{/if}}
 
-        return err;
-    }
+        {{#if async}}ReturnErrorOnFailure(chip::DeviceLayer::SystemLayer().StartTimer(0, OnWaitForMsFn, this));{{/if}}
 
-    {{#if isSubscribeAttribute }}
-    static void SubscribeAttribute_{{ index }}_OnSubscriptionEstablishedCallback(void * context)
-    {
-      {{parent.filename}} * runner = reinterpret_cast<{{parent.filename}} *>(context);
-      if (!runner->mReceivedReport_{{index}}) {
-          ChipLogError(chipTool, "Error: Initial report not received!");
-          runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
-          return;
-      }
-      runner->NextTest();
+        return err;
     }
-    {{/if}}
 
     static void OnTestSendCluster{{asUpperCamelCase cluster}}Command{{asUpperCamelCase command}}_{{index}}_FailureResponse(void * context, uint8_t status)
     {
@@ -133,7 +125,7 @@ class {{filename}}: public TestCommand
             return;
         }
 
-        runner->NextTest();
+        {{#unless async}}runner->NextTest();{{/unless}}
     }
 
     static void OnTestSendCluster{{asUpperCamelCase cluster}}Command{{asUpperCamelCase command}}_{{index}}_SuccessResponse(void * context {{#chip_tests_item_response_parameters}}, {{#if isList}}uint16_t count, {{/if}}{{chipType}} {{#if isList}}* {{/if}}{{asLowerCamelCase name}}{{/chip_tests_item_response_parameters}})
@@ -149,13 +141,105 @@ class {{filename}}: public TestCommand
             return;
         }
 
-        {{> process_response_value}}
+        {{#if isWaitForReport}}
+        if (runner->mReceivedReport_{{index}}) {
+            // Receiving report more than once is not an error since the subscription may be alive for a long time.
+            ChipLogProgress(chipTool, "Note: on report called more than once.");
+            return;
+        }
+        runner->mReceivedReport_{{index}} = true;
+        {{/if}}
 
         {{#if isSubscribeAttribute}}
-            runner->mReceivedReport_{{index}} = true;
+        {{#if hasWaitForReport}}
+        if (!runner->mReceivedReport_{{waitForReport.index}}) {
+            ChipLogError(chipTool, "Error: Initial report not received!");
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+        }
+        {{/if}}
+        {{/if}}
+
+        {{#chip_tests_item_response_parameters}}
+        {{#if hasExpectedValue}}
+        {{#if isList}}
+        if (count != {{expectedValue.length}})
+        {
+            ChipLogError(chipTool, "Error: Value mismatch. Expected: '%s'", "{{expectedValue}}");
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+        }
         {{else}}
-            runner->NextTest();
+        {{#if (isString type)}}
+        {{chipType}} {{asLowerCamelCase name}}Argument = chip::ByteSpan(chip::Uint8::from_const_char("{{expectedValue}}"), strlen("{{expectedValue}}"));
+        if (!{{asLowerCamelCase name}}.data_equal({{asLowerCamelCase name}}Argument))
+        {{else}}
+        if ({{asLowerCamelCase name}} != {{expectedValue}}{{asTypeLiteralSuffix chipType}})
+        {{/if}}
+        {
+            ChipLogError(chipTool, "Error: Value mismatch. Expected: '%s'", "{{expectedValue}}");
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+        }
+        {{/if}}
+        {{/if}}
+        {{#if hasExpectedConstraints}}
+        {{#if expectedConstraints.type}}
+        ChipLogError(chipTool, "Warning: {{asLowerCamelCase name}} type checking is not implemented yet. Expected type: '%s'", "{{expectedConstraints.type}}");
+        {{/if}}
+
+        {{#if expectedConstraints.format}}
+        ChipLogError(chipTool, "Warning: {{asLowerCamelCase name}} format checking is not implemented yet. Expected format: '%s'", "{{expectedConstraints.format}}");
+        {{/if}}
+
+        {{#if expectedConstraints.minLength}}
+          if ({{asLowerCamelCase name}}.size() < {{expectedConstraints.minLength}})
+          {
+            ChipLogError(chipTool, "Error: {{asLowerCamelCase name}} is too short. Min size is {{expectedConstraints.minLength}} but got '%zu'", {{asLowerCamelCase name}}.size());
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+          }
+        {{/if}}
+
+        {{#if expectedConstraints.maxLength}}
+          if ({{asLowerCamelCase name}}.size() > {{expectedConstraints.maxLength}})
+          {
+            ChipLogError(chipTool, "Error: {{asLowerCamelCase name}} is too long. Max size is {{expectedConstraints.maxLength}} but got '%zu'", {{asLowerCamelCase name}}.size());
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+          }
         {{/if}}
+
+        {{#if expectedConstraints.minValue}}
+          if ({{asLowerCamelCase name}} < {{expectedConstraints.minValue}})
+          {
+            ChipLogError(chipTool, "Error: {{asLowerCamelCase name}} is lower than expected. Min value is {{expectedConstraints.minValue}} but got '%d'", {{asLowerCamelCase name}});
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+          }
+        {{/if}}
+
+        {{#if expectedConstraints.maxValue}}
+          if ({{asLowerCamelCase name}} > {{expectedConstraints.maxValue}})
+          {
+            ChipLogError(chipTool, "Error: {{asLowerCamelCase name}} is higher than expected. Max value is {{expectedConstraints.maxValue}} but got '%d'", {{asLowerCamelCase name}});
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+          }
+        {{/if}}
+
+        {{#if expectedConstraints.notValue}}
+          if ({{asLowerCamelCase name}} == {{expectedConstraints.notValue}})
+          {
+            ChipLogError(chipTool, "Error: {{asLowerCamelCase name}} was not expected to be '{{expectedConstraints.notValue}}' due to notValue constraint");
+            runner->SetCommandExitStatus(CHIP_ERROR_INTERNAL);
+            return;
+          }
+        {{/if}}
+        {{/if}}
+        {{/chip_tests_item_response_parameters}}
+
+        {{#unless async}}runner->NextTest();{{/unless}}
     }
 
     {{/if}}

diff --git a/examples/chip-tool/templates/partials/testsuite/WaitForAttributeReport.zapt b/examples/chip-tool/templates/partials/testsuite/WaitForAttributeReport.zapt
diff --git a/examples/chip-tool/templates/partials/testsuite/WaitForMs.zapt b/examples/chip-tool/templates/partials/testsuite/WaitForMs.zapt
diff --git a/examples/chip-tool/templates/templates.json b/examples/chip-tool/templates/templates.json
@@ -23,21 +23,9 @@
             "name": "cluster_header",
             "path": "../../../src/app/zap-templates/partials/cluster_header.zapt"
         },
-        {
-            "name": "process_response_value",
-            "path": "partials/process_response_value.zapt"
-        },
         {
             "name": "test_cluster",
             "path": "partials/test_cluster.zapt"
-        },
-        {
-            "name": "TestSuiteHelper_WaitForMs",
-            "path": "partials/testsuite/WaitForMs.zapt"
-        },
-        {
-            "name": "TestSuiteHelper_WaitForAttributeReport",
-            "path": "partials/testsuite/WaitForAttributeReport.zapt"
         }
     ],
     "templates": [

diff --git a/src/app/tests/suites/TestDelayCommands.yaml b/src/app/tests/suites/TestDelayCommands.yaml
@@ -20,7 +20,7 @@ config:
 
 tests:
     - label: "Wait 100ms"
-      cluster: "TestSuite"
+      cluster: "DelayCommands"
       command: "WaitForMs"
       arguments:
           values:

diff --git a/src/app/tests/suites/TestSubscribe_OnOff.yaml b/src/app/tests/suites/TestSubscribe_OnOff.yaml
@@ -21,21 +21,29 @@ config:
 tests:
     - label: "Set OnOff Attribute to false"
       command: "Off"
+
     - label: "Subscribe OnOff Attribute"
       command: "subscribeAttribute"
       attribute: "OnOff"
       minInterval: 2
       maxInterval: 10
       response:
           value: false
+
     - label: "Turn On the light to see attribute change"
       command: "On"
+
+    - label: "Check for attribute report"
+      command: "waitForReport"
+      attribute: "OnOff"
+      response:
+          value: true
+
+    - label: "Turn Off the light to see attribute change"
+      command: "Off"
+
     - label: "Check for attribute report"
-      cluster: "TestSuite"
-      command: "WaitForAttributeReport"
-      waitfor:
-          endpoint: 1
-          cluster: "On/Off"
-          attribute: "OnOff"
-          response:
-              value: true
+      command: "waitForReport"
+      attribute: "OnOff"
+      response:
+          value: false