pexpect-style wait for output in test_kernelapp

wait for the expected output to appear, instead of assuming 1 second is enough

this should be both faster (where sleep(1) was enough) and more reliable

Author: minrk

jupyter_client/tests/test_kernelapp.py

@@ -1,10 +1,9 @@
 import os
-import shutil
+import selectors
 import sys
 import time
 from subprocess import PIPE
 from subprocess import Popen
-from tempfile import mkdtemp
 
 
 def _launch(extra_env):
@@ -21,44 +20,55 @@ def _launch(extra_env):
 POLL_FREQ = 10
 
 
-def test_kernelapp_lifecycle():
+def test_kernelapp_lifecycle(request, tmpdir):
     # Check that 'jupyter kernel' starts and terminates OK.
-    runtime_dir = mkdtemp()
-    startup_dir = mkdtemp()
+    runtime_dir = str(tmpdir.join("runtime").mkdir())
+    startup_dir = str(tmpdir.join("startup").mkdir())
     started = os.path.join(startup_dir, "started")
-    try:
-        p = _launch(
-            {
-                "JUPYTER_RUNTIME_DIR": runtime_dir,
-                "JUPYTER_CLIENT_TEST_RECORD_STARTUP_PRIVATE": started,
-            }
-        )
-        # Wait for start
-        for _ in range(WAIT_TIME * POLL_FREQ):
-            if os.path.isfile(started):
-                break
-            time.sleep(1 / POLL_FREQ)
-        else:
-            raise AssertionError("No started file created in {} seconds".format(WAIT_TIME))
+    p = _launch(
+        {
+            "JUPYTER_RUNTIME_DIR": runtime_dir,
+            "JUPYTER_CLIENT_TEST_RECORD_STARTUP_PRIVATE": started,
+        }
+    )
+    request.addfinalizer(p.terminate)
+
+    # Wait for start
+    for _ in range(WAIT_TIME * POLL_FREQ):
+        if os.path.isfile(started):
+            break
+        time.sleep(1 / POLL_FREQ)
+    else:
+        raise AssertionError("No started file created in {} seconds".format(WAIT_TIME))
+
+    # Connection file should be there by now
+    for _ in range(WAIT_TIME * POLL_FREQ):
+        files = os.listdir(runtime_dir)
+        if files:
+            break
+        time.sleep(1 / POLL_FREQ)
+    else:
+        raise AssertionError("No connection file created in {} seconds".format(WAIT_TIME))
+
+    assert len(files) == 1
+    cf = files[0]
+    assert cf.startswith("kernel")
+    assert cf.endswith(".json")
 
-        # Connection file should be there by now
-        for _ in range(WAIT_TIME * POLL_FREQ):
-            files = os.listdir(runtime_dir)
-            if files:
-                break
-            time.sleep(1 / POLL_FREQ)
-        else:
-            raise AssertionError("No connection file created in {} seconds".format(WAIT_TIME))
-        assert len(files) == 1
-        cf = files[0]
-        assert cf.startswith("kernel")
-        assert cf.endswith(".json")
+    # pexpect-style wait-for-text with timeout
+    t = time.perf_counter()
+    deadline = t + WAIT_TIME
+    remaining = WAIT_TIME
 
-        # Send SIGTERM to shut down
-        time.sleep(1)
-        p.terminate()
-        _, stderr = p.communicate(timeout=WAIT_TIME)
-        assert cf in stderr.decode("utf-8", "replace")
-    finally:
-        shutil.rmtree(runtime_dir)
-        shutil.rmtree(startup_dir)
+    selector = selectors.DefaultSelector()
+    selector.register(p.stderr, selectors.EVENT_READ)
+    stderr = ""
+    while remaining >= 0 and p.poll() is None:
+        events = selector.select(remaining)
+        if events:
+            stderr += p.stderr.readline().decode("utf8", "replace")
+        if cf in stderr:
+            break
+        remaining = deadline - time.perf_counter()
+    selector.close()
+    assert cf in stderr