triggering tests on more selective criteria to avoid churn

Author: brandonjbjelland

.github/workflows/e2e-test.yaml

@@ -1,12 +1,17 @@
 name: e2e docs test
 on:
+  issue_comment:
+    types: [created]
   workflow_dispatch:
-  pull_request:
-    branches:
-      - main
 jobs:
   run-tests:
     name: run tests
+    if: |
+      github.event_name == 'workflow_dispatch' ||
+      (github.event_name == 'issue_comment' &&
+      github.event.issue.pull_request &&
+      github.event.comment.body == 'test this please' &&
+      github.event.comment.author_association == 'MEMBER')
     runs-on: ubuntu-latest
     permissions:
       contents: "read"

tests/capture_output_stream.py

@@ -9,7 +9,7 @@
 import re
 import threading
 import time
-from queue import Queue, Empty
+from queue import Empty, Queue
 
 from jupyter_client.blocking.client import BlockingKernelClient
 from watchdog.events import FileSystemEventHandler
@@ -49,13 +49,16 @@ def watch_kernel(connection_file, stop_event):
     kc.load_connection_file()
     kc.start_channels()
 
-    while not stop_event.is_set():
-        try:
-            msg = kc.get_iopub_msg(timeout=1)
-            if msg:
-                process_msg(msg)
-        except Exception as _:
-            continue
+    try:
+        while not stop_event.is_set():
+            try:
+                msg = kc.get_iopub_msg(timeout=1)
+                if msg:
+                    process_msg(msg)
+            except Exception as _:
+                continue
+    finally:
+        kc.stop_channels()  # Or some other method to close or clean up the client
 
 
 def watch_queue(queue, watched_files, stop_event):
@@ -72,9 +75,9 @@ def watch_queue(queue, watched_files, stop_event):
             continue
 
 
-def start_watches():
+def start_watches() -> tuple[list[threading.Thread], threading.Event]:
     stop_event = threading.Event()
-    threads = []
+    threads: list[threading.Thread] = []
     paths_to_watch = [
         f"{os.path.expanduser('~')}/Library/Jupyter/runtime/",
         "/private/var/folders/9n/1rd9yjf913s10bzn5w9mdf_m0000gn/T/",

tests/conftest.py

@@ -133,7 +133,9 @@ def gcp_setup(auth_tb_quickstart):
     finally:
         stop_event.set()
         for thread in threads:
-            thread.join()  # Wait for threads to finish
+            thread.join(timeout=1)
+            if thread.is_alive():
+                logger.warning(f"Thread {thread.name} did not stop as expected")
 
 
 def delete_state_lock(

tests/loading_datasets_test.py

@@ -2,7 +2,7 @@
 import time
 
 import pytest
-from conftest import auth_tb_loading_datasets, auth_tb_quickstart, tb_quickstart
+from conftest import auth_tb_loading_datasets
 from pytest_dependency import depends