Add documentation of UserPrompt logging in step_start

project-chip · May 31, 2023 · 28ff5fc · 28ff5fc
1 parent 20f90c5
commit 28ff5fc
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/scripts/tests/yaml/tests_logger.py b/scripts/tests/yaml/tests_logger.py
@@ -199,6 +199,8 @@ def step_start(self, request: TestStep):
             print(self.__strings.test_harness_step_start.format(index=self.__index, name=request.label))
 
         print(self.__strings.step_start.format(index=self.__index, name=click.style(request.label, bold=True)), end='')
+        # This is to keep previous behavior of UserPrompt. Where it logs USER_PROMPT prior to user input. See link below:
+        # https://github.com/project-chip/connectedhomeip/blob/master/src/app/tests/suites/commands/log/LogCommands.cpp#L31
         if request.command == 'UserPrompt':
             message = request.arguments['values'][0]['value']
             print("\n" + self.__strings.user_prompt.format(message=f'{message}'))