test: add native crash helper for daemon waits

Author: jpnurmi

tests/__init__.py

@@ -25,8 +25,7 @@ def adb(*args, **kwargs):
 
 SENTRY_VERSION = "0.14.2"
 
-from .assertions import wait_for_daemon
-from .cmake import cmake_option
+from .assertions import wait_for_daemon as _wait_for_daemon
 
 
 def make_dsn(httpserver, auth="uiaeosnrtdy", id=123456, proxy_host=False):
@@ -100,19 +99,18 @@ def extract_request(httpserver_log, cond):
     return (None, httpserver_log)
 
 
-def run(cwd, exe, args, expect_failure=False, env=None, **kwargs):
+def run(
+    cwd, exe, args, expect_failure=False, env=None, wait_for_daemon=False, **kwargs
+):
     if env is None:
         env = dict(os.environ)
-    should_wait_for_daemon = (
-        expect_failure and cmake_option(cwd, "SENTRY_BACKEND") == "native"
-    )
     if kwargs.get("check"):
         raise pytest.fail.Exception(
             "`check` is inferred from `expect_failure`, and should not be passed in the kwargs"
         )
     check = expect_failure == False
     __tracebackhide__ = True
-    started_at = time.time() if should_wait_for_daemon else None
+    started_at = time.time()
     if os.environ.get("ANDROID_API"):
         # older android emulators do not correctly pass down the returncode
         # so we basically echo the return code, and parse it manually
@@ -187,10 +185,10 @@ def run(cwd, exe, args, expect_failure=False, env=None, **kwargs):
         ]
     try:
         result = subprocess.run([*cmd, *args], cwd=cwd, env=env, check=check, **kwargs)
-        if should_wait_for_daemon:
-            assert wait_for_daemon(
+        if wait_for_daemon:
+            assert _wait_for_daemon(
                 cwd, started_at
-            ), "native crash daemon did not finish before timeout"
+            ), "native crash daemon did not finish within timeout"
         if expect_failure:
             assert (
                 result.returncode != 0
@@ -208,6 +206,18 @@ def run(cwd, exe, args, expect_failure=False, env=None, **kwargs):
         ) from None
 
 
+def run_native_crash(cwd, exe, args, env=None, **kwargs):
+    return run(
+        cwd,
+        exe,
+        args,
+        expect_failure=True,
+        env=env,
+        wait_for_daemon=True,
+        **kwargs,
+    )
+
+
 def check_output(*args, **kwargs):
     stdout = run(*args, stdout=subprocess.PIPE, **kwargs).stdout
     # capturing stdout on windows actually encodes "\n" as "\r\n", which we

tests/cmake.py

@@ -17,17 +17,6 @@
     get_tsan_env,
 )
 
-_cmake_build_options = {}
-
-
-def cmake_option(cwd, name):
-    options = _cmake_build_options.get(os.fspath(cwd))
-    if options is None:
-        options = _cmake_build_options.get(os.path.realpath(cwd))
-    if options is None:
-        return None
-    return options.get(name)
-
 
 class CMake:
     def __init__(self, factory):
@@ -65,15 +54,13 @@ def compile(self, targets, options=None, cflags=None):
 
         # ensure that there are no left-overs from previous runs
         shutil.rmtree(build_tmp_path / ".sentry-native", ignore_errors=True)
-        _cmake_build_options[os.fspath(build_tmp_path)] = dict(options)
 
         # Inject a sub-path into the temporary build directory as the CWD for all tests to verify UTF-8 path handling.
         if os.environ.get("UTF8_TEST_CWD"):
             # this is Thai and translates to "this is a test directory"
             utf8_parent = self.factory.mktemp("utf8")
             utf8_subpath = utf8_parent / "นี่คือไดเร็กทอรีทดสอบ"
             utf8_subpath.symlink_to(build_tmp_path, target_is_directory=True)
-            _cmake_build_options[os.fspath(utf8_subpath)] = dict(options)
             return utf8_subpath
 
         return build_tmp_path

tests/test_e2e_sentry.py

@@ -372,7 +372,14 @@ def run_crash_e2e(tmp_path, exe, args, env):
 
     # Use check_output to capture stdout for test ID extraction
     try:
-        output = check_output(tmp_path, exe, args, env=env, expect_failure=True)
+        output = check_output(
+            tmp_path,
+            exe,
+            args,
+            env=env,
+            expect_failure=True,
+            wait_for_daemon=True,
+        )
     except AssertionError:
         if is_kcov:
             # kcov may exit with 0 even on crash, try without expect_failure

tests/test_integration_http.py

@@ -9,6 +9,7 @@
 from . import (
     make_dsn,
     run,
+    run_native_crash,
     Envelope,
     split_log_request_cond,
     is_feedback_envelope,
@@ -826,11 +827,10 @@ def test_native_crash_http(cmake, httpserver):
 
     # Use stdout for initialization delay under TSAN
     # Configure ASAN to not intercept crash signals
-    run(
+    run_native_crash(
         tmp_path,
         "sentry_example",
         ["log", "stdout", "attachment", "crash"],
-        expect_failure=True,
         env=get_asan_crash_env(env),
     )
 

tests/test_integration_logger.py

@@ -40,6 +40,7 @@ def _run_logger_crash_test(backend, cmake, logger_option):
         stdout=subprocess.PIPE,
         stderr=subprocess.STDOUT,
         expect_failure=True,
+        wait_for_daemon=backend == "native",
     )
 
     # Process should have crashed (non-zero exit code)

tests/test_integration_logs.py

@@ -5,6 +5,7 @@
 from . import (
     make_dsn,
     run,
+    run_native_crash,
     Envelope,
     split_log_request_cond,
     is_logs_envelope,
@@ -277,11 +278,10 @@ def test_logs_on_crash_native(cmake, httpserver, rerun):
     env = dict(os.environ, SENTRY_DSN=make_dsn(httpserver))
 
     with httpserver.wait(timeout=10):
-        run(
+        run_native_crash(
             tmp_path,
             "sentry_example",
             ["log", "capture-log", "crash"],
-            expect_failure=True,
             env=env,
         )
 

tests/test_integration_metrics.py

@@ -5,6 +5,7 @@
 from . import (
     make_dsn,
     run,
+    run_native_crash,
     Envelope,
     split_log_request_cond,
     is_metrics_envelope,
@@ -431,11 +432,10 @@ def test_metrics_on_crash_native(cmake, httpserver, rerun):
     env = dict(os.environ, SENTRY_DSN=make_dsn(httpserver))
 
     with httpserver.wait(timeout=10):
-        run(
+        run_native_crash(
             tmp_path,
             "sentry_example",
             ["log", "capture-metric", "crash"],
-            expect_failure=True,
             env=env,
         )
 

tests/test_integration_native.py

@@ -15,6 +15,7 @@
     is_feedback_envelope,
     make_dsn,
     run,
+    run_native_crash,
     Envelope,
     split_log_request_cond,
 )
@@ -64,12 +65,22 @@ def run_crash(tmp_path, exe, args, env):
 
     if is_kcov:
         try:
-            run(tmp_path, exe, args, expect_failure=True, env=env)
+            run_native_crash(
+                tmp_path,
+                exe,
+                args,
+                env=env,
+            )
         except AssertionError:
             # kcov may exit with 0 even on crash, that's acceptable
             pass
     else:
-        run(tmp_path, exe, args, expect_failure=True, env=env)
+        run_native_crash(
+            tmp_path,
+            exe,
+            args,
+            env=env,
+        )
 
 
 def test_native_capture_crash(cmake, httpserver):

tests/test_integration_screenshot.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from . import Envelope, make_dsn, run
+from . import Envelope, make_dsn, run, run_native_crash
 
 
 def assert_screenshot_file(database_path):
@@ -82,7 +82,12 @@ def test_capture_screenshot_native(cmake, httpserver):
     httpserver.expect_oneshot_request("/api/123456/envelope/").respond_with_data("OK")
 
     with httpserver.wait(timeout=10) as waiting:
-        run(tmp_path, "sentry_screenshot", ["crash"], expect_failure=True, env=env)
+        run_native_crash(
+            tmp_path,
+            "sentry_screenshot",
+            ["crash"],
+            env=env,
+        )
 
     assert waiting.result
 
@@ -172,11 +177,10 @@ def test_before_screenshot_native(cmake, httpserver):
     httpserver.expect_oneshot_request("/api/123456/envelope/").respond_with_data("OK")
 
     with httpserver.wait(timeout=10) as waiting:
-        run(
+        run_native_crash(
             tmp_path,
             "sentry_screenshot",
             ["crash", "before-screenshot"],
-            expect_failure=True,
             env=env,
         )
 

tests/test_integration_tus.py

@@ -8,6 +8,7 @@
 from . import (
     make_dsn,
     run,
+    run_native_crash,
     Envelope,
     SENTRY_VERSION,
 )
@@ -522,11 +523,10 @@ def test_tus_crash_native(cmake, httpserver):
     env = dict(os.environ, SENTRY_DSN=make_dsn(httpserver))
 
     with httpserver.wait(timeout=15) as waiting:
-        run(
+        run_native_crash(
             tmp_path,
             "sentry_example",
             ["log", "large-attachment", "crash"],
-            expect_failure=True,
             env=env,
         )
     assert waiting.result