Add tests

jpnurmi · jpnurmi · commit 8f3ffd5134ee · 2026-01-23T14:22:07.000+01:00
diff --git a/examples/example.c b/examples/example.c
@@ -506,6 +506,7 @@ main(int argc, char **argv)
     if (has_arg(argc, argv, "cache-keep")) {
         sentry_options_set_cache_keep(options, true);
         sentry_options_set_cache_max_size(options, 1000 * 8);
+        sentry_options_set_cache_max_age(options, 5);
     }
 
     if (0 != sentry_init(options)) {
diff --git a/tests/test_integration_cache.py b/tests/test_integration_cache.py
@@ -0,0 +1,102 @@
+import os
+import time
+import pytest
+
+from . import run
+from .conditions import has_files
+
+pytestmark = pytest.mark.skipif(not has_files, reason="tests need local filesystem")
+
+
+@pytest.mark.parametrize("cache_keep", [True, False])
+@pytest.mark.parametrize("backend", ["inproc", "breakpad"])
+def test_cache_keep(cmake, backend, cache_keep):
+    tmp_path = cmake(["sentry_example"], {"SENTRY_BACKEND": backend})
+
+    run(
+        tmp_path,
+        "sentry_example",
+        ["log", "crash"] + (["cache-keep"] if cache_keep else []),
+        expect_failure=True,
+    )
+
+    cache_dir = tmp_path.joinpath(".sentry-native/cache")
+    assert not cache_dir.exists() or len(list(cache_dir.glob("*.envelope"))) == 0
+
+    run(
+        tmp_path,
+        "sentry_example",
+        ["log", "no-setup"] + (["cache-keep"] if cache_keep else []),
+    )
+
+    assert cache_dir.exists() or cache_keep is False
+    if cache_keep:
+        cache_files = list(cache_dir.glob("*.envelope"))
+        assert len(cache_files) == 1
+
+
+@pytest.mark.parametrize("backend", ["inproc", "breakpad"])
+def test_cache_max_size(cmake, backend):
+    tmp_path = cmake(["sentry_example"], {"SENTRY_BACKEND": backend})
+    cache_dir = tmp_path.joinpath(".sentry-native/cache")
+
+    # 5 x 2mb
+    for i in range(5):
+        run(
+            tmp_path,
+            "sentry_example",
+            ["log", "cache-keep", "crash"],
+            expect_failure=True,
+        )
+
+        if cache_dir.exists():
+            cache_files = list(cache_dir.glob("*.envelope"))
+            for f in cache_files:
+                with open(f, "r+b") as file:
+                    file.truncate(2048 * 1000)
+
+    run(
+        tmp_path,
+        "sentry_example",
+        ["log", "cache-keep", "no-setup"],
+    )
+
+    # max 8mb
+    assert cache_dir.exists()
+    cache_files = list(cache_dir.glob("*.envelope"))
+    assert len(cache_files) <= 4
+    assert sum(f.stat().st_size for f in cache_files) <= 8 * 1000 * 1024
+
+
+@pytest.mark.parametrize("backend", ["inproc", "breakpad"])
+def test_cache_max_age(cmake, backend):
+    tmp_path = cmake(["sentry_example"], {"SENTRY_BACKEND": backend})
+    cache_dir = tmp_path.joinpath(".sentry-native/cache")
+
+    for i in range(5):
+        run(
+            tmp_path,
+            "sentry_example",
+            ["log", "cache-keep", "crash"],
+            expect_failure=True,
+        )
+
+    # 2,4,6,8,10 days old
+    assert cache_dir.exists()
+    cache_files = list(cache_dir.glob("*.envelope"))
+    for i, f in enumerate(cache_files):
+        mtime = time.time() - ((i + 1) * 2 * 24 * 60 * 60)
+        os.utime(str(f), (mtime, mtime))
+
+    # 0 days old
+    run(
+        tmp_path,
+        "sentry_example",
+        ["log", "cache-keep", "no-setup"],
+    )
+
+    # max 5 days
+    cache_files = list(cache_dir.glob("*.envelope"))
+    assert len(cache_files) == 3
+    for f in cache_files:
+        assert time.time() - f.stat().st_mtime <= 5 * 24 * 60 * 60
diff --git a/tests/unit/CMakeLists.txt b/tests/unit/CMakeLists.txt
@@ -23,6 +23,7 @@ add_executable(sentry_test_unit
 	sentry_testsupport.h
 	test_attachments.c
 	test_basic.c
+	test_cache.c
 	test_consent.c
 	test_concurrency.c
 	test_embedded_info.c
diff --git a/tests/unit/test_cache.c b/tests/unit/test_cache.c
@@ -0,0 +1,180 @@
+#include "sentry_core.h"
+#include "sentry_database.h"
+#include "sentry_envelope.h"
+#include "sentry_options.h"
+#include "sentry_path.h"
+#include "sentry_testsupport.h"
+#include "sentry_uuid.h"
+#include "sentry_value.h"
+
+#ifdef SENTRY_PLATFORM_WINDOWS
+#    include <windows.h>
+#else
+#    include <utime.h>
+#endif
+
+static int
+set_file_mtime(const sentry_path_t *path, time_t mtime)
+{
+#ifdef SENTRY_PLATFORM_WINDOWS
+    HANDLE h = CreateFileW(path->path_w, FILE_WRITE_ATTRIBUTES, 0, NULL,
+        OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
+    ULARGE_INTEGER ft
+        = { (uint64_t)(mtime * 10000000ULL + 116444736000000000ULL) };
+    BOOL rv = SetFileTime(h, NULL, NULL, (FILETIME *)&ft);
+    CloseHandle(h);
+    return rv ? 0 : -1;
+#else
+    struct utimbuf times = { .modtime = mtime, .actime = mtime };
+    return utime(path->path, &times);
+#endif
+}
+
+SENTRY_TEST(cache_keep)
+{
+    SENTRY_TEST_OPTIONS_NEW(options);
+    sentry_options_set_dsn(options, "https://foo@sentry.invalid/42");
+    sentry_options_set_cache_keep(options, true);
+    sentry_init(options);
+
+    sentry_path_t *cache_path
+        = sentry__path_join_str(options->database_path, "cache");
+    TEST_ASSERT(!!cache_path);
+    TEST_ASSERT(sentry__path_remove_all(cache_path) == 0);
+
+    sentry_path_t *old_run_path
+        = sentry__path_join_str(options->database_path, "old.run");
+    TEST_ASSERT(!!old_run_path);
+    TEST_ASSERT(sentry__path_create_dir_all(old_run_path) == 0);
+
+    sentry_envelope_t *envelope = sentry__envelope_new();
+    TEST_ASSERT(!!envelope);
+    sentry_uuid_t event_id = sentry_uuid_new_v4();
+    sentry_value_t event = sentry__value_new_event_with_id(&event_id);
+    sentry__envelope_add_event(envelope, event);
+
+    char *envelope_filename = sentry__uuid_as_filename(&event_id, ".envelope");
+    TEST_ASSERT(!!envelope_filename);
+    sentry_path_t *old_envelope_path
+        = sentry__path_join_str(old_run_path, envelope_filename);
+    TEST_ASSERT(
+        sentry_envelope_write_to_path(envelope, old_envelope_path) == 0);
+    sentry_envelope_free(envelope);
+
+    sentry_path_t *cached_envelope_path
+        = sentry__path_join_str(cache_path, envelope_filename);
+    TEST_ASSERT(!!cached_envelope_path);
+
+    TEST_ASSERT(sentry__path_is_file(old_envelope_path));
+    TEST_ASSERT(!sentry__path_is_file(cached_envelope_path));
+
+    sentry__process_old_runs(options, 0);
+
+    TEST_ASSERT(!sentry__path_is_file(old_envelope_path));
+    TEST_ASSERT(sentry__path_is_file(cached_envelope_path));
+
+    sentry__path_free(old_envelope_path);
+    sentry__path_free(cached_envelope_path);
+    sentry__path_free(old_run_path);
+    sentry__path_free(cache_path);
+    sentry_free(envelope_filename);
+    sentry_close();
+}
+
+SENTRY_TEST(cache_max_size)
+{
+    SENTRY_TEST_OPTIONS_NEW(options);
+    sentry_options_set_dsn(options, "https://foo@sentry.invalid/42");
+    sentry_options_set_cache_keep(options, true);
+    sentry_options_set_cache_max_size(options, 10); // 10 kb
+    sentry_init(options);
+
+    sentry_path_t *cache_path
+        = sentry__path_join_str(options->database_path, "cache");
+    TEST_ASSERT(!!cache_path);
+    TEST_ASSERT(sentry__path_remove_all(cache_path) == 0);
+    TEST_ASSERT(sentry__path_create_dir_all(cache_path) == 0);
+
+    // 10 x 5 kb files
+    for (int i = 0; i < 10; i++) {
+        sentry_uuid_t event_id = sentry_uuid_new_v4();
+        char *filename = sentry__uuid_as_filename(&event_id, ".envelope");
+        TEST_ASSERT(!!filename);
+        sentry_path_t *filepath = sentry__path_join_str(cache_path, filename);
+        sentry_free(filename);
+
+        sentry_filewriter_t *fw = sentry__filewriter_new(filepath);
+        TEST_ASSERT(!!fw);
+        for (int j = 0; j < 500; j++) {
+            sentry__filewriter_write(fw, "0123456789", 10);
+        }
+        TEST_CHECK_INT_EQUAL(sentry__filewriter_byte_count(fw), 5000);
+        sentry__filewriter_free(fw);
+        sentry__path_free(filepath);
+    }
+
+    sentry__cleanup_cache(options);
+
+    int cache_count = 0;
+    size_t cache_size = 0;
+    sentry_pathiter_t *iter = sentry__path_iter_directory(cache_path);
+    const sentry_path_t *entry;
+    while (iter && (entry = sentry__pathiter_next(iter)) != NULL) {
+        cache_count++;
+        cache_size += sentry__path_get_size(entry);
+    }
+    sentry__pathiter_free(iter);
+
+    TEST_CHECK_INT_EQUAL(cache_count, 2);
+    TEST_CHECK(cache_size <= 10 * 1024);
+
+    sentry__path_free(cache_path);
+    sentry_close();
+}
+
+SENTRY_TEST(cache_max_age)
+{
+    SENTRY_TEST_OPTIONS_NEW(options);
+    sentry_options_set_dsn(options, "https://foo@sentry.invalid/42");
+    sentry_options_set_cache_keep(options, true);
+    sentry_options_set_cache_max_age(options, 3); // 3 days
+    sentry_init(options);
+
+    sentry_path_t *cache_path
+        = sentry__path_join_str(options->database_path, "cache");
+    TEST_ASSERT(!!cache_path);
+    TEST_ASSERT(sentry__path_remove_all(cache_path) == 0);
+    TEST_ASSERT(sentry__path_create_dir_all(cache_path) == 0);
+
+    // 10 files, 0-9 days old
+    time_t now = time(NULL);
+    for (int i = 0; i < 10; i++) {
+        sentry_uuid_t event_id = sentry_uuid_new_v4();
+        char *filename = sentry__uuid_as_filename(&event_id, ".envelope");
+        TEST_ASSERT(!!filename);
+        sentry_path_t *filepath = sentry__path_join_str(cache_path, filename);
+        sentry_free(filename);
+
+        TEST_ASSERT(sentry__path_touch(filepath) == 0);
+        time_t mtime = now - (i * 24 * 60 * 60); // N days ago
+        TEST_CHECK(set_file_mtime(filepath, mtime) == 0);
+        sentry__path_free(filepath);
+    }
+
+    sentry__cleanup_cache(options);
+
+    int cache_count = 0;
+    sentry_pathiter_t *iter = sentry__path_iter_directory(cache_path);
+    const sentry_path_t *entry;
+    while (iter && (entry = sentry__pathiter_next(iter)) != NULL) {
+        cache_count++;
+        time_t mtime = sentry__path_get_mtime(entry);
+        TEST_CHECK(now - mtime <= (3 * 24 * 60 * 60));
+    }
+    sentry__pathiter_free(iter);
+
+    TEST_CHECK_INT_EQUAL(cache_count, 4);
+
+    sentry__path_free(cache_path);
+    sentry_close();
+}
diff --git a/tests/unit/tests.inc b/tests/unit/tests.inc
@@ -27,6 +27,9 @@ XX(basic_write_envelope_to_file)
 XX(bgworker_flush)
 XX(breadcrumb_without_type_or_message_still_valid)
 XX(build_id_parser)
+XX(cache_keep)
+XX(cache_max_age)
+XX(cache_max_size)
 XX(capture_minidump_basic)
 XX(capture_minidump_invalid_path)
 XX(capture_minidump_null_path)

Original file line number	Diff line number	Diff line change
`@@ -506,6 +506,7 @@ main(int argc, char **argv)`
`506`	`506`	`if (has_arg(argc, argv, "cache-keep")) {`
`507`	`507`	`sentry_options_set_cache_keep(options, true);`
`508`	`508`	`sentry_options_set_cache_max_size(options, 1000 * 8);`
	`509`	`+ sentry_options_set_cache_max_age(options, 5);`
`509`	`510`	`}`
`510`	`511`
`511`	`512`	`if (0 != sentry_init(options)) {`