Add user input to UserPrompt function. (#16190)

project-chip · Sep 9, 2023 · 4112513 · 4112513
1 parent 1033090
commit 4112513
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 4 deletions.
diff --git a/src/app/tests/suites/TestLogCommands.yaml b/src/app/tests/suites/TestLogCommands.yaml
@@ -36,6 +36,28 @@ tests:
               - name: "message"
                 value: "This is a simple message"
 
+    - label: "Do a simple user prompt message. Expect 'y' to pass."
+      cluster: "LogCommands"
+      command: "UserPrompt"
+      disabled: true
+      arguments:
+          values:
+              - name: "message"
+                value: "Please enter 'y' for success"
+              - name: "expectedValue"
+                value: "y"
+
+    - label: "Do a simple user prompt message. Use enter to coninue."
+      cluster: "LogCommands"
+      command: "UserPrompt"
+      disabled: true
+      arguments:
+          values:
+              - name: "message"
+                value: "Please enter enter to continue"
+              - name: "expectedValue"
+                value: ""
+
     - label: "Do a simple user prompt message"
       cluster: "LogCommands"
       command: "UserPrompt"

diff --git a/src/app/tests/suites/commands/log/LogCommands.cpp b/src/app/tests/suites/commands/log/LogCommands.cpp
@@ -17,15 +17,28 @@
  */
 
 #include "LogCommands.h"
+#include <iostream>
 
 CHIP_ERROR LogCommands::Log(const char * message)
 {
     ChipLogDetail(chipTool, "%s", message);
     return ContinueOnChipMainThread(CHIP_NO_ERROR);
 }
 
-CHIP_ERROR LogCommands::UserPrompt(const char * message)
+CHIP_ERROR LogCommands::UserPrompt(const char * message, const char * expectedValue)
 {
+    CHIP_ERROR err = CHIP_NO_ERROR;
+    std::string line;
     ChipLogDetail(chipTool, "USER_PROMPT: %s", message);
-    return ContinueOnChipMainThread(CHIP_NO_ERROR);
+    if (expectedValue == nullptr)
+    {
+        return ContinueOnChipMainThread(err);
+    }
+
+    std::getline(std::cin, line);
+    if (line != expectedValue)
+    {
+        err = CHIP_ERROR_INVALID_ARGUMENT;
+    }
+    return ContinueOnChipMainThread(err);
 }
diff --git a/src/app/tests/suites/commands/log/LogCommands.h b/src/app/tests/suites/commands/log/LogCommands.h
@@ -29,5 +29,5 @@ class LogCommands
     virtual CHIP_ERROR ContinueOnChipMainThread(CHIP_ERROR err) = 0;
 
     CHIP_ERROR Log(const char * message);
-    CHIP_ERROR UserPrompt(const char * message);
+    CHIP_ERROR UserPrompt(const char * message, const char * expectedValue = nullptr);
 };
diff --git a/src/app/zap-templates/common/simulated-clusters/clusters/LogCommands.js b/src/app/zap-templates/common/simulated-clusters/clusters/LogCommands.js
@@ -32,7 +32,7 @@ const Log = {
 
 const UserPrompt = {
   name : 'UserPrompt',
-  arguments : [ { type : 'CHAR_STRING', name : 'message' } ],
+  arguments : [ { type : 'CHAR_STRING', name : 'message' }, { type : 'CHAR_STRING', name : 'expectedValue', isOptional : true } ],
   response : { arguments : [] }
 };