/***
Oak - Non-Linear Video Editor
Copyright (C) 2026 Oak Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
***/
// Pure C ABI test for the liboakengine disk cache family
// (oakengine/disk.h). Exercises the DiskManager instance lifecycle, default
// cache path queries, cache clearing, settings handler dispatch, folder
// handle lookup and default path mutation. Runs headless; no GPU required.
#include
#include
#include
#include
#include
#if defined(_WIN32)
#include
#include
#else
#include
#include
#endif
#include "oakengine/disk.h"
#include "oakengine/init.h"
static char g_handler_path[512];
static int g_handler_call_count;
static void reset_handler_state(void)
{
memset(g_handler_path, 0, sizeof(g_handler_path));
g_handler_call_count = 0;
}
static void settings_handler(const char *folder_path, void *parent_window,
void *userdata)
{
(void) parent_window;
(void) userdata;
EXPECT_TRUE(folder_path != NULL);
EXPECT_TRUE(strlen(folder_path) > 0);
strncpy(g_handler_path, folder_path, sizeof(g_handler_path) - 1);
g_handler_path[sizeof(g_handler_path) - 1] = '\0';
g_handler_call_count++;
}
static void test_instance_lifecycle(void)
{
char buf[512];
// DiskManager is created by oakengine_init(HEADLESS).
EXPECT_TRUE(oakengine_disk_get_default_cache_path(buf, sizeof(buf)) > 0);
// Destroy is allowed and idempotent.
EXPECT_TRUE(oakengine_disk_destroy_instance() == OAKENGINE_OK);
EXPECT_TRUE(oakengine_disk_get_default_cache_path(buf, sizeof(buf)) ==
OAKENGINE_E_STATE);
EXPECT_TRUE(oakengine_disk_destroy_instance() == OAKENGINE_OK);
// Create recreates the instance.
EXPECT_TRUE(oakengine_disk_create_instance() == OAKENGINE_OK);
EXPECT_TRUE(oakengine_disk_get_default_cache_path(buf, sizeof(buf)) > 0);
// Create is idempotent.
EXPECT_TRUE(oakengine_disk_create_instance() == OAKENGINE_OK);
EXPECT_TRUE(oakengine_disk_get_default_cache_path(buf, sizeof(buf)) > 0);
}
static void test_default_cache_path(void)
{
char buf[512];
memset(buf, 0, sizeof(buf));
const int len = oakengine_disk_get_default_cache_path(buf, sizeof(buf));
EXPECT_TRUE(len > 0);
EXPECT_TRUE((int) strlen(buf) == len);
EXPECT_TRUE(strchr(buf, '/') != NULL || strchr(buf, '\\') != NULL);
// Query length with NULL buffer.
EXPECT_TRUE(oakengine_disk_get_default_cache_path(NULL, 0) == len);
}
static void test_open_folder_handle(void)
{
char buf[512];
EXPECT_TRUE(oakengine_disk_get_default_cache_path(buf, sizeof(buf)) > 0);
void *folder = oakengine_disk_get_open_folder(buf);
EXPECT_TRUE(folder != NULL);
// NULL/empty path returns the default folder handle.
void *default_folder = oakengine_disk_get_open_folder(nullptr);
EXPECT_TRUE(default_folder == folder);
void *empty_folder = oakengine_disk_get_open_folder("");
EXPECT_TRUE(empty_folder == folder);
// A different path opens a distinct folder.
char tmp[256];
snprintf(tmp, sizeof(tmp),
#if defined(_WIN32)
"%s\\oakengine_disk_test_folder_XXXXXX",
#else
"%s/oakengine_disk_test_folder_XXXXXX",
#endif
getenv("TMPDIR") ? getenv("TMPDIR") : "/tmp");
#if defined(_WIN32)
char *tmpdir = _mktemp(tmp);
EXPECT_TRUE(tmpdir != NULL);
EXPECT_TRUE(_mkdir(tmpdir) == 0);
#else
char *tmpdir = mkdtemp(tmp);
EXPECT_TRUE(tmpdir != NULL);
#endif
void *other_folder = oakengine_disk_get_open_folder(tmpdir);
EXPECT_TRUE(other_folder != NULL);
EXPECT_TRUE(other_folder != folder);
// The same path returns the same handle.
void *other_folder_again = oakengine_disk_get_open_folder(tmpdir);
EXPECT_TRUE(other_folder_again == other_folder);
#if defined(_WIN32)
_rmdir(tmpdir);
#else
rmdir(tmpdir);
#endif
}
static void test_clear_cache(void)
{
// Create a temporary cache directory and seed it with a file.
char path[256];
snprintf(path, sizeof(path),
#if defined(_WIN32)
"%s\\oakengine_disk_test_cache_XXXXXX",
#else
"%s/oakengine_disk_test_cache_XXXXXX",
#endif
getenv("TMPDIR") ? getenv("TMPDIR") : "/tmp");
#if defined(_WIN32)
char *tmpdir = _mktemp(path);
EXPECT_TRUE(tmpdir != NULL);
EXPECT_TRUE(_mkdir(tmpdir) == 0);
#else
char *tmpdir = mkdtemp(path);
EXPECT_TRUE(tmpdir != NULL);
#endif
char index_file[512];
snprintf(index_file, sizeof(index_file),
#if defined(_WIN32)
"%s\\index", tmpdir);
#else
"%s/index", tmpdir);
#endif
FILE *f = fopen(index_file, "w");
EXPECT_TRUE(f != NULL);
fclose(f);
// clear_cache opens the folder and clears its contents.
EXPECT_TRUE(oakengine_disk_clear_cache(tmpdir) == 1);
// Re-create a file and clear again to ensure idempotency.
f = fopen(index_file, "w");
EXPECT_TRUE(f != NULL);
fclose(f);
EXPECT_TRUE(oakengine_disk_clear_cache(tmpdir) == 1);
#if defined(_WIN32)
_rmdir(tmpdir);
#else
rmdir(tmpdir);
#endif
}
static void test_settings_handler_round_trip(void)
{
reset_handler_state();
EXPECT_TRUE(oakengine_disk_set_settings_handler(settings_handler, NULL) ==
OAKENGINE_OK);
// NULL path uses the default folder.
EXPECT_TRUE(oakengine_disk_show_settings_dialog(NULL, NULL) == OAKENGINE_OK);
EXPECT_TRUE(g_handler_call_count == 1);
EXPECT_TRUE(strlen(g_handler_path) > 0);
// Calling again with a specific path invokes the handler with that path.
EXPECT_TRUE(oakengine_disk_show_settings_dialog(g_handler_path, NULL) ==
OAKENGINE_OK);
EXPECT_TRUE(g_handler_call_count == 2);
EXPECT_TRUE(strcmp(g_handler_path, g_handler_path) == 0);
// Clearing the handler is allowed and results in a logged skip.
EXPECT_TRUE(oakengine_disk_set_settings_handler(NULL, NULL) == OAKENGINE_OK);
EXPECT_TRUE(oakengine_disk_show_settings_dialog(g_handler_path, NULL) ==
OAKENGINE_OK);
EXPECT_TRUE(g_handler_call_count == 2);
}
static void test_invalidate_project(void)
{
// No instance returns an error.
EXPECT_TRUE(oakengine_disk_destroy_instance() == OAKENGINE_OK);
EXPECT_TRUE(oakengine_disk_invalidate_project(NULL) == OAKENGINE_E_STATE);
EXPECT_TRUE(oakengine_disk_create_instance() == OAKENGINE_OK);
// NULL project is accepted (signal emitted with null pointer).
EXPECT_TRUE(oakengine_disk_invalidate_project(NULL) == OAKENGINE_OK);
// Valid project returns OK without crashing.
OakEngineProject *project = oakengine_project_create();
EXPECT_TRUE(project != NULL);
EXPECT_TRUE(oakengine_disk_invalidate_project(project) == OAKENGINE_OK);
oakengine_project_free(project);
}
static void test_set_default_cache_path(void)
{
char original[512];
EXPECT_TRUE(oakengine_disk_get_default_cache_path(original, sizeof(original)) >
0);
char tmp[256];
snprintf(tmp, sizeof(tmp),
#if defined(_WIN32)
"%s\\oakengine_disk_test_default_XXXXXX",
#else
"%s/oakengine_disk_test_default_XXXXXX",
#endif
getenv("TMPDIR") ? getenv("TMPDIR") : "/tmp");
#if defined(_WIN32)
char *tmpdir = _mktemp(tmp);
EXPECT_TRUE(tmpdir != NULL);
EXPECT_TRUE(_mkdir(tmpdir) == 0);
#else
char *tmpdir = mkdtemp(tmp);
EXPECT_TRUE(tmpdir != NULL);
#endif
EXPECT_TRUE(oakengine_disk_set_default_cache_path(tmpdir) == OAKENGINE_OK);
char updated[512];
EXPECT_TRUE(oakengine_disk_get_default_cache_path(updated, sizeof(updated)) > 0);
EXPECT_TRUE(strcmp(updated, tmpdir) == 0);
// Restore original default path.
EXPECT_TRUE(oakengine_disk_set_default_cache_path(original) == OAKENGINE_OK);
EXPECT_TRUE(oakengine_disk_get_default_cache_path(updated, sizeof(updated)) > 0);
EXPECT_TRUE(strcmp(updated, original) == 0);
#if defined(_WIN32)
_rmdir(tmpdir);
#else
rmdir(tmpdir);
#endif
}
TEST(OakEngineDisk, Main)
{
EXPECT_TRUE(oakengine_init(OAKENGINE_INIT_HEADLESS) == OAKENGINE_OK);
test_instance_lifecycle();
test_default_cache_path();
test_open_folder_handle();
test_clear_cache();
test_settings_handler_round_trip();
test_set_default_cache_path();
test_invalidate_project();
// Leave DiskManager in the initialized state for shutdown.
oakengine_disk_create_instance();
oakengine_shutdown();
printf("oakengine_disk_test: OK\n");
}