[YAML] Add a mechanism to specify the test timeout for a given YAML file (#11861)

Author: vivien-apple

examples/chip-tool/commands/tests/TestCommand.h

@@ -30,6 +30,8 @@
 #include <type_traits>
 #include <zap-generated/tests/CHIPClustersTest.h>
 
+constexpr uint16_t kTimeoutInSeconds = 30;
+
 class TestCommand : public CHIPCommand
 {
 public:
@@ -39,20 +41,26 @@ class TestCommand : public CHIPCommand
     {
         AddArgument("node-id", 0, UINT64_MAX, &mNodeId);
         AddArgument("delayInMs", 0, UINT64_MAX, &mDelayInMs);
+        AddArgument("timeout", 0, UINT16_MAX, &mTimeout);
         AddArgument("endpoint-id", CHIP_ZCL_ENDPOINT_MIN, CHIP_ZCL_ENDPOINT_MAX, &mEndpointId);
         AddArgument("PICS", &mPICSFilePath);
     }
 
     /////////// CHIPCommand Interface /////////
     CHIP_ERROR RunCommand() override;
-    chip::System::Clock::Timeout GetWaitDuration() const override { return chip::System::Clock::Seconds16(30); }
+    chip::System::Clock::Timeout GetWaitDuration() const override
+    {
+        return chip::System::Clock::Seconds16(mTimeout.HasValue() ? mTimeout.Value() : kTimeoutInSeconds);
+    }
 
     virtual void NextTest() = 0;
 
     /////////// GlobalCommands Interface /////////
     CHIP_ERROR Wait(chip::System::Clock::Timeout ms);
     CHIP_ERROR WaitForMs(uint16_t ms) { return Wait(chip::System::Clock::Milliseconds32(ms)); }
+    CHIP_ERROR WaitForCommissionee();
     CHIP_ERROR Log(const char * message);
+    CHIP_ERROR Prompt(const char * message);
 
 protected:
     ChipDevice * mDevice;
@@ -261,5 +269,6 @@ class TestCommand : public CHIPCommand
     chip::Optional<uint64_t> mDelayInMs;
     chip::Optional<char *> mPICSFilePath;
     chip::Optional<chip::EndpointId> mEndpointId;
+    chip::Optional<uint16_t> mTimeout;
     chip::Optional<std::map<std::string, bool>> PICS;
 };

examples/chip-tool/templates/partials/test_cluster.zapt

@@ -44,6 +44,9 @@ class {{filename}}: public TestCommand
       }
     }
 
+  {{#if timeout}}
+    chip::System::Clock::Timeout GetWaitDuration() const override { return chip::System::Clock::Seconds16(mTimeout.HasValue() : mTimeout.Value() : {{timeout}}); }
+  {{/if}}
 
   private:
     std::atomic_uint16_t mTestIndex;

src/app/zap-templates/common/ClusterTestGeneration.js

@@ -327,6 +327,7 @@ function parse(filename)
   });
 
   yaml.filename   = filename;
+  yaml.timeout    = yaml.config.timeout;
   yaml.totalTests = yaml.tests.length;
 
   return yaml;