Add integration tests

Author: tustanivsky

examples/example.c

@@ -202,6 +202,28 @@ discarding_before_send_metric_callback(sentry_value_t metric, void *user_data)
     return sentry_value_new_null();
 }
 
+static sentry_value_t
+before_breadcrumb_callback(sentry_value_t breadcrumb, void *user_data)
+{
+    (void)user_data;
+
+    // make our mark on the breadcrumbs
+    sentry_value_set_by_key(
+        breadcrumb, "category", sentry_value_new_string("before_breadcrumb"));
+
+    return breadcrumb;
+}
+
+static sentry_value_t
+discarding_before_breadcrumb_callback(sentry_value_t breadcrumb, void *user_data)
+{
+    (void)user_data;
+
+    // discard breadcrumb
+    sentry_value_decref(breadcrumb);
+    return sentry_value_new_null();
+}
+
 // Test logger that outputs in a format the integration tests can parse
 static void
 test_logger_callback(
@@ -625,6 +647,16 @@ main(int argc, char **argv)
             options, discarding_before_send_metric_callback, NULL);
     }
 
+    if (has_arg(argc, argv, "before-breadcrumb")) {
+        sentry_options_set_before_breadcrumb(
+            options, before_breadcrumb_callback, NULL);
+    }
+
+    if (has_arg(argc, argv, "discarding-before-breadcrumb")) {
+        sentry_options_set_before_breadcrumb(
+            options, discarding_before_breadcrumb_callback, NULL);
+    }
+
     if (0 != sentry_init(options)) {
         return EXIT_FAILURE;
     }

tests/assertions.py

@@ -424,6 +424,19 @@ def assert_no_before_send(envelope):
     assert ("adapted_by", "before_send") not in event.items()
 
 
+def assert_before_breadcrumb(envelope):
+    event = envelope.get_event()
+    breadcrumbs = event.get("breadcrumbs", [])
+    assert len(breadcrumbs) > 0
+    assert all(b.get("category") == "before_breadcrumb" for b in breadcrumbs)
+
+
+def assert_no_breadcrumbs(envelope):
+    event = envelope.get_event()
+    breadcrumbs = event.get("breadcrumbs", [])
+    assert len(breadcrumbs) == 0
+
+
 @dataclass(frozen=True)
 class CrashpadAttachments:
     event: dict

tests/test_integration_http.py

@@ -30,6 +30,8 @@
     assert_gzip_content_encoding,
     assert_gzip_file_header,
     assert_attachment_view_hierarchy,
+    assert_before_breadcrumb,
+    assert_no_breadcrumbs,
 )
 from .conditions import has_http, has_breakpad, has_files, is_kcov
 
@@ -675,3 +677,51 @@ def test_capture_with_scope(cmake, httpserver):
 
     assert_breadcrumb(envelope, "scoped crumb")
     assert_attachment(envelope)
+
+
+def test_before_breadcrumb_http(cmake, httpserver):
+    tmp_path = cmake(["sentry_example"], {"SENTRY_BACKEND": "none"})
+
+    httpserver.expect_oneshot_request(
+        "/api/123456/envelope/",
+        headers={"x-sentry-auth": auth_header},
+    ).respond_with_data("OK")
+    env = dict(os.environ, SENTRY_DSN=make_dsn(httpserver))
+
+    run(
+        tmp_path,
+        "sentry_example",
+        ["log", "before-breadcrumb", "capture-event"],
+        env=env,
+    )
+
+    assert len(httpserver.log) == 1
+    output = httpserver.log[0][0].get_data()
+    envelope = Envelope.deserialize(output)
+
+    assert_event(envelope)
+    assert_before_breadcrumb(envelope)
+
+
+def test_discarding_before_breadcrumb_http(cmake, httpserver):
+    tmp_path = cmake(["sentry_example"], {"SENTRY_BACKEND": "none"})
+
+    httpserver.expect_oneshot_request(
+        "/api/123456/envelope/",
+        headers={"x-sentry-auth": auth_header},
+    ).respond_with_data("OK")
+    env = dict(os.environ, SENTRY_DSN=make_dsn(httpserver))
+
+    run(
+        tmp_path,
+        "sentry_example",
+        ["log", "discarding-before-breadcrumb", "capture-event"],
+        env=env,
+    )
+
+    assert len(httpserver.log) == 1
+    output = httpserver.log[0][0].get_data()
+    envelope = Envelope.deserialize(output)
+
+    assert_event(envelope)
+    assert_no_breadcrumbs(envelope)