integration tests

Author: jpnurmi

CONTRIBUTING.md

@@ -155,6 +155,7 @@ The example currently supports the following commands:
   instead of a hardcoded value.
 - `attachment`: Adds an attachment, which is currently defined as the
   `CMakeCache.txt` file, which is part of the CMake build folder.
+- `attach-after-init`: Same as `attachment` but after the SDK has been initialized.
 - `stdout`: Uses a custom transport which dumps all envelopes to `stdout`.
 - `no-setup`: Skips all scope and breadcrumb initialization code.
 - `start-session`: Starts a new release-health session.
@@ -185,6 +186,7 @@ The example currently supports the following commands:
  This file can be found in `./tests/fixtures/view-hierachy.json`.
 - `set-trace`: Sets the scope `propagation_context`'s trace data to the given `trace_id="aaaabbbbccccddddeeeeffff00001111"` and `parent_span_id=""f0f0f0f0f0f0f0f0"`.
 - `capture-with-scope`: Captures an event with a local scope.
+- `attach-to-scope`: Same as `attachment` but attaches the file to the local scope.
 
 Only on Linux using crashpad:
 - `crashpad-wait-for-upload`: Couples application shutdown to complete the upload in the `crashpad_handler`.

examples/example.c

@@ -399,6 +399,12 @@ main(int argc, char **argv)
         sentry_set_trace(direct_trace_id, direct_parent_span_id);
     }
 
+    if (has_arg(argc, argv, "attach-after-init")) {
+        // assuming the example / test is run directly from the cmake build
+        // directory
+        sentry_add_attachment("./CMakeCache.txt");
+    }
+
     if (has_arg(argc, argv, "start-session")) {
         sentry_start_session();
     }
@@ -424,6 +430,12 @@ main(int argc, char **argv)
         sentry_value_t debug_crumb = create_debug_crumb("scoped crumb");
         sentry_scope_add_breadcrumb(scope, debug_crumb);
 
+        if (has_arg(argc, argv, "attach-to-scope")) {
+            // assuming the example / test is run directly from the cmake build
+            // directory
+            sentry_scope_add_attachment(scope, "./CMakeCache.txt");
+        }
+
         sentry_capture_event_with_scope(event, scope);
     }
 

tests/test_integration_crashpad.py

@@ -289,11 +289,11 @@ def test_crashpad_wer_crash(cmake, httpserver, run_args):
     "run_args,build_args",
     [
         # if we crash, we want a dump
-        ([], {"SENTRY_TRANSPORT_COMPRESSION": "Off"}),
-        ([], {"SENTRY_TRANSPORT_COMPRESSION": "On"}),
+        (["attachment"], {"SENTRY_TRANSPORT_COMPRESSION": "Off"}),
+        (["attachment"], {"SENTRY_TRANSPORT_COMPRESSION": "On"}),
         # if we crash and before-send doesn't discard, we want a dump
         pytest.param(
-            ["before-send"],
+            ["attachment", "before-send"],
             {},
             marks=pytest.mark.skipif(
                 sys.platform == "darwin",
@@ -302,13 +302,21 @@ def test_crashpad_wer_crash(cmake, httpserver, run_args):
         ),
         # if on_crash() is non-discarding, a discarding before_send() is overruled, so we get a dump
         pytest.param(
-            ["discarding-before-send", "on-crash"],
+            ["attachment", "discarding-before-send", "on-crash"],
             {},
             marks=pytest.mark.skipif(
                 sys.platform == "darwin",
                 reason="crashpad doesn't provide SetFirstChanceExceptionHandler on macOS",
             ),
         ),
+        pytest.param(
+            ["attach-after-init"],
+            {},
+            marks=pytest.mark.skipif(
+                sys.platform == "darwin",
+                reason="crashpad doesn't support dynamic attachments on macOS",
+            ),
+        ),
     ],
 )
 def test_crashpad_dumping_crash(cmake, httpserver, run_args, build_args):
@@ -329,7 +337,6 @@ def test_crashpad_dumping_crash(cmake, httpserver, run_args, build_args):
             [
                 "log",
                 "start-session",
-                "attachment",
                 "attach-view-hierarchy",
                 "overflow-breadcrumbs",
                 "crash",

tests/test_integration_http.py

@@ -1173,7 +1173,7 @@ def test_capture_with_scope(cmake, httpserver):
     run(
         tmp_path,
         "sentry_example",
-        ["log", "attachment", "capture-with-scope"],
+        ["log", "attach-to-scope", "capture-with-scope"],
         check=True,
         env=dict(os.environ, SENTRY_DSN=make_dsn(httpserver)),
     )