From 227b6b6b6b1e115652b1c9e10b6eb7fa11b4c2c0 Mon Sep 17 00:00:00 2001
From: Boris Zbarsky <bzbarsky@apple.com>
Date: Tue, 15 Jun 2021 19:08:41 -0400
Subject: [PATCH] Make sure chip-all-clusters-app is ready before we try to do
 PASE setup with it. (#7561)

We were racing startup of chip-tool against that of
chip-all-clusters-app, and if the former started faster it would send
the first PASE handshake message before the latter was ready. Then it
would wait 5 seconds before resending, which slowed the test down
quite a bit
---
 .github/workflows/tests.yaml |  3 ++-
 scripts/tests/test_suites.sh | 34 ++++++++++++++++++++++++++++++++--
 2 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
index 2ad05d3b8423ed..e123133823e81b 100644
--- a/.github/workflows/tests.yaml
+++ b/.github/workflows/tests.yaml
@@ -103,7 +103,8 @@ jobs:
               with:
                   submodules: true
             - name: Setup Environment
-              run: brew install openssl pkg-config
+              # coreutils for stdbuf
+              run: brew install openssl pkg-config coreutils
             - name: Try to ensure the directories for core dumping and diagnostic log collection exist and we can write them.
               run: |
                   sudo chown ${USER} /cores || true
diff --git a/scripts/tests/test_suites.sh b/scripts/tests/test_suites.sh
index 997f9ac08e03b7..96951161f10aa2 100755
--- a/scripts/tests/test_suites.sh
+++ b/scripts/tests/test_suites.sh
@@ -54,8 +54,38 @@ for j in "${iter_array[@]}"; do
         echo "  ===== Running test: $i"
         echo "          * Starting cluster server"
         rm -rf /tmp/chip_tool_config.ini
-        out/debug/chip-all-clusters-app &
-        background_pid=$!
+        # This part is a little complicated.  We want to
+        # 1) Start chip-all-clusters-app in the background
+        # 2) Pipe its output through tee so we can wait until it's ready for a
+        #    PASE handshake.
+        # 3) Save its pid off so we can kill it.
+        #
+        # The subshell with echoing of $! to a file descriptor and
+        # then reading things out of there accomplishes item 3;
+        # otherwise $! would be the last-started command which would
+        # be the tee.  This part comes from https://stackoverflow.com/a/3786955
+        # and better ideas are welcome.
+        #
+        # The stdbuf -o0 is to make sure our output is flushed through
+        # tee expeditiously; otherwise it will buffer things up and we
+        # will never see the string we want.
+
+        # Clear out our temp files so we don't accidentally do a stale
+        # read from them before we write to them.
+        rm -rf /tmp/all-clusters-log
+        rm -rf /tmp/pid
+        (
+            stdbuf -o0 out/debug/chip-all-clusters-app &
+            echo $! >&3
+        ) 3>/tmp/pid | tee /tmp/all-clusters-log &
+        while ! grep -q "Server Listening" /tmp/all-clusters-log; do
+            :
+        done
+        # Now read $background_pid from /tmp/pid; presumably it's
+        # landed there by now.  If we try to read it immediately after
+        # kicking off the subshell, sometimes we try to do it before
+        # the data is there yet.
+        background_pid="$(</tmp/pid)"
         echo "          * Pairing to device"
         out/debug/standalone/chip-tool pairing onnetwork 1 20202021 3840 ::1 11097
         echo "          * Starting test run: $i"