[testsuite] Refactor test suite simulated cluster command

erjiaqing · Sep 13, 2021 · 8390956 · 8390956
1 parent 987a2d3
commit 8390956
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 29 deletions.
diff --git a/examples/chip-tool/templates/partials/test_cluster.zapt b/examples/chip-tool/templates/partials/test_cluster.zapt
@@ -46,12 +46,7 @@ class {{filename}}: public TestCommand
 
     {{#chip_tests_items}}
     {{#if (isTestOnlyCluster cluster)}}
-    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}});
-    }
+    {{> (asTestSuiteSimulatedClusterCommandPartial command) }}
     {{else}}
     // Test {{label}}
     {{#if isSubscribeAttribute}}

diff --git a/examples/chip-tool/templates/partials/testsuite/WaitForMs.zapt b/examples/chip-tool/templates/partials/testsuite/WaitForMs.zapt
@@ -0,0 +1,6 @@
+CHIP_ERROR TestSendCluster{{asUpperCamelCase cluster}}Command{{asUpperCamelCase command}}_{{index}}()
+{
+    ChipLogProgress(chipTool, "{{cluster}} - {{asUpperCamelCase command}} - {{label}}");
+
+    return {{command}}({{#chip_tests_item_parameters}}{{#not_first}}, {{/not_first}}{{definedValue}}{{/chip_tests_item_parameters}});
+}
diff --git a/examples/chip-tool/templates/templates.json b/examples/chip-tool/templates/templates.json
@@ -26,6 +26,10 @@
         {
             "name": "test_cluster",
             "path": "partials/test_cluster.zapt"
+        },
+        {
+            "name": "TestSuiteHelper_WaitForMs",
+            "path": "partials/testsuite/WaitForMs.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: "DelayCommands"
+      cluster: "TestSuite"
       command: "WaitForMs"
       arguments:
           values:

diff --git a/src/app/zap-templates/common/ClusterTestGeneration.js b/src/app/zap-templates/common/ClusterTestGeneration.js
@@ -26,7 +26,7 @@ const path              = require('path');
 // Import helpers from zap core
 const templateUtil = require(zapPath + 'dist/src-electron/generator/template-util.js')
 
-const { DelayCommands }                 = require('./simulated-clusters/TestDelayCommands.js');
+const { TestSuiteHelperCluster }        = require('./TestSuiteHelperCluster.js');
 const { Clusters, asBlocks, asPromise } = require('./ClustersHelper.js');
 
 const kClusterName       = 'cluster';
@@ -219,18 +219,19 @@ function getClusters()
 {
   // Create a new array to merge the configured clusters list and test
   // simulated clusters.
-  return Clusters.getClusters().then(clusters => clusters.concat(DelayCommands));
+  return Clusters.getClusters().then(clusters => clusters.concat(TestSuiteHelperCluster));
 }
 
 function getCommands(clusterName)
 {
-  return (clusterName == DelayCommands.name) ? Promise.resolve(DelayCommands.commands) : Clusters.getClientCommands(clusterName);
+  return (clusterName == TestSuiteHelperCluster.name) ? Promise.resolve(TestSuiteHelperCluster.commands)
+                                                      : Clusters.getClientCommands(clusterName);
 }
 
 function getAttributes(clusterName)
 {
-  return (clusterName == DelayCommands.name) ? Promise.resolve(DelayCommands.attributes)
-                                             : Clusters.getServerAttributes(clusterName);
+  return (clusterName == TestSuiteHelperCluster.name) ? Promise.resolve(TestSuiteHelperCluster.attributes)
+                                                      : Clusters.getServerAttributes(clusterName);
 }
 
 function assertCommandOrAttribute(context)
@@ -296,7 +297,7 @@ function chip_tests_items(options)
 
 function isTestOnlyCluster(name)
 {
-  return name == DelayCommands.name;
+  return name == TestSuiteHelperCluster.name;
 }
 
 function chip_tests_with_command_attribute_info(options)

diff --git a/...n/simulated-clusters/TestDelayCommands.js → ...emplates/common/TestSuiteHelperCluster.js b/...n/simulated-clusters/TestDelayCommands.js → ...emplates/common/TestSuiteHelperCluster.js
@@ -16,7 +16,7 @@
  */
 
 /*
- * This file declare test suites utilities methods for delayed commands.
+ * This file declare test suites utilities methods for test suite.
  *
  * Each method declared in this file needs to be implemented on a per-language
  * basis and permits to exposes methods to the test suites that are not part
@@ -30,12 +30,12 @@ const WaitForMs = {
   response : { arguments : [] }
 };
 
-const DelayCommands = {
-  name : 'DelayCommands',
+const TestSuiteHelperCluster = {
+  name : 'TestSuite',
   commands : [ WaitForMs ],
 };
 
 //
 // Module exports
 //
-exports.DelayCommands = DelayCommands;
+exports.TestSuiteHelperCluster = TestSuiteHelperCluster;
diff --git a/src/app/zap-templates/templates/app/helper.js b/src/app/zap-templates/templates/app/helper.js
@@ -335,16 +335,22 @@ function asMEI(prefix, suffix)
   return cHelper.asHex((prefix << 16) + suffix, 8);
 }
 
+function asTestSuiteSimulatedClusterCommandPartial(label)
+{
+  return "TestSuiteHelper_" + asUpperCamelCase(label)
+}
+
 //
 // Module exports
 //
-exports.asPrintFormat                     = asPrintFormat;
-exports.asReadType                        = asReadType;
-exports.asReadTypeLength                  = asReadTypeLength;
-exports.chip_endpoint_generated_functions = chip_endpoint_generated_functions
-exports.chip_endpoint_cluster_list        = chip_endpoint_cluster_list
-exports.asTypeLiteralSuffix               = asTypeLiteralSuffix;
-exports.asLowerCamelCase                  = asLowerCamelCase;
-exports.asUpperCamelCase                  = asUpperCamelCase;
-exports.hasSpecificAttributes             = hasSpecificAttributes;
-exports.asMEI                             = asMEI;
+exports.asPrintFormat                             = asPrintFormat;
+exports.asReadType                                = asReadType;
+exports.asReadTypeLength                          = asReadTypeLength;
+exports.chip_endpoint_generated_functions         = chip_endpoint_generated_functions
+exports.chip_endpoint_cluster_list                = chip_endpoint_cluster_list
+exports.asTypeLiteralSuffix                       = asTypeLiteralSuffix;
+exports.asLowerCamelCase                          = asLowerCamelCase;
+exports.asUpperCamelCase                          = asUpperCamelCase;
+exports.hasSpecificAttributes                     = hasSpecificAttributes;
+exports.asMEI                                     = asMEI;
+exports.asTestSuiteSimulatedClusterCommandPartial = asTestSuiteSimulatedClusterCommandPartial;
diff --git a/src/darwin/Framework/CHIP/templates/partials/test_cluster.zapt b/src/darwin/Framework/CHIP/templates/partials/test_cluster.zapt
@@ -4,8 +4,7 @@
 {
     XCTestExpectation * expectation = [self expectationWithDescription:@"{{label}}"];
 {{#if (isTestOnlyCluster cluster)}}
-    dispatch_queue_t queue = dispatch_get_main_queue();
-    {{command}}(expectation, queue{{#chip_tests_item_parameters}}, {{definedValue}}{{/chip_tests_item_parameters}});
+{{> (asTestSuiteSimulatedClusterCommandPartial command)}}
 {{else}}
     CHIPDevice * device = GetPairedDevice(kDeviceId);
     dispatch_queue_t queue = dispatch_get_main_queue();

diff --git a/src/darwin/Framework/CHIP/templates/partials/testsuite/WaitForMs.zapt b/src/darwin/Framework/CHIP/templates/partials/testsuite/WaitForMs.zapt
@@ -0,0 +1,2 @@
+dispatch_queue_t queue = dispatch_get_main_queue();
+{{command}}(expectation, queue{{#chip_tests_item_parameters}}, {{definedValue}}{{/chip_tests_item_parameters}});
diff --git a/src/darwin/Framework/CHIP/templates/templates.json b/src/darwin/Framework/CHIP/templates/templates.json
@@ -22,6 +22,10 @@
         {
             "name": "CHIPCallbackBridge",
             "path": "partials/CHIPCallbackBridge.zapt"
+        },
+        {
+            "name": "TestSuiteHelper_WaitForMs",
+            "path": "partials/testsuite/WaitForMs.zapt"
         }
     ],
     "templates": [
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		dispatch_queue_t queue = dispatch_get_main_queue();
		{{command}}(expectation, queue{{#chip_tests_item_parameters}}, {{definedValue}}{{/chip_tests_item_parameters}});