rizin/test/unit/test_core_plugin.c

// SPDX-FileCopyrightText: 2026 RizinOrg <info@rizin.re>
// SPDX-License-Identifier: LGPL-3.0-only

#include <rz_core.h>
#include "minunit.h"

typedef struct test_core_plugin_context_t {
	int magic;
} TestCorePluginContext;

static int context_init_count = 0;
static int context_fini_count = 0;
static int legacy_init_count = 0;
static int legacy_fini_count = 0;
static int duplicate_init_count = 0;

static bool test_context_init(RzCore *core, void **user) {
	(void)core;
	TestCorePluginContext *ctx = RZ_NEW0(TestCorePluginContext);
	if (!ctx) {
		return false;
	}
	ctx->magic = 0x1337;
	*user = ctx;
	context_init_count++;
	return true;
}

static bool test_context_fini(RzCore *core, void *user) {
	(void)core;
	TestCorePluginContext *ctx = user;
	if (!ctx || ctx->magic != 0x1337) {
		return false;
	}
	free(ctx);
	context_fini_count++;
	return true;
}

static bool test_legacy_init(RzCore *core, void **user) {
	(void)core;
	(void)user;
	legacy_init_count++;
	return true;
}

static bool test_legacy_fini(RzCore *core, void *user) {
	(void)core;
	(void)user;
	legacy_fini_count++;
	return true;
}

static bool test_duplicate_init(RzCore *core, void **user) {
	(void)core;
	(void)user;
	duplicate_init_count++;
	return true;
}

static RzCmdStatus test_plugin_cmd_handler(RzCore *core, int argc, const char **argv) {
	(void)core;
	(void)argc;
	(void)argv;
	return RZ_CMD_STATUS_OK;
}

static const RzCmdDescArg test_plugin_cmd_args[] = {
	{ 0 },
};

static const RzCmdDescHelp test_plugin_cmd_help = {
	.summary = "test plugin command",
	.args = test_plugin_cmd_args,
};

static const RzCmdDescHelp test_plugin_group_help = {
	.summary = "test plugin command group",
};

static bool test_core_plugin_context_lifecycle(void) {
	RzCore *core = rz_core_new();
	mu_assert_notnull(core, "core should be created");

	RzCorePlugin plugin = {
		.name = "context-test",
		.desc = "context test plugin",
		.license = "LGPL-3.0-only",
		.author = "RizinOrg",
		.version = "1.0",
		.init = test_context_init,
		.fini = test_context_fini,
	};

	context_init_count = 0;
	context_fini_count = 0;
	mu_assert_true(rz_core_plugin_add(core, &plugin), "context plugin should be added");
	mu_assert_eq(context_init_count, 1, "context init should be called once");

	TestCorePluginContext *ctx = rz_core_plugin_context_get(core, &plugin);
	mu_assert_notnull(ctx, "context should be stored on the core");
	mu_assert_eq(ctx->magic, 0x1337, "context should preserve plugin state");

	mu_assert_true(rz_core_plugin_del(core, &plugin), "context plugin should be deleted");
	mu_assert_eq(context_fini_count, 1, "context fini should be called once");
	mu_assert_null(rz_core_plugin_context_get(core, &plugin), "context should be removed after plugin deletion");

	rz_core_free(core);
	mu_end;
}

static bool test_core_plugin_legacy_lifecycle(void) {
	RzCore *core = rz_core_new();
	mu_assert_notnull(core, "core should be created");

	RzCorePlugin plugin = {
		.name = "legacy-test",
		.desc = "legacy test plugin",
		.license = "LGPL-3.0-only",
		.author = "RizinOrg",
		.version = "1.0",
		.init = test_legacy_init,
		.fini = test_legacy_fini,
	};

	legacy_init_count = 0;
	legacy_fini_count = 0;
	mu_assert_true(rz_core_plugin_add(core, &plugin), "legacy plugin should be added");
	mu_assert_eq(legacy_init_count, 1, "legacy init should be called once");
	mu_assert_null(rz_core_plugin_context_get(core, &plugin), "legacy plugin should not get implicit context");

	mu_assert_true(rz_core_plugin_del(core, &plugin), "legacy plugin should be deleted");
	mu_assert_eq(legacy_fini_count, 1, "legacy fini should be called once");

	rz_core_free(core);
	mu_end;
}

static bool test_core_plugin_duplicate_name_is_rejected(void) {
	RzCore *core = rz_core_new();
	mu_assert_notnull(core, "core should be created");

	RzCorePlugin first = {
		.name = "duplicate-test",
		.desc = "first duplicate test plugin",
		.license = "LGPL-3.0-only",
		.author = "RizinOrg",
		.version = "1.0",
		.init = test_legacy_init,
		.fini = test_legacy_fini,
	};
	RzCorePlugin second = {
		.name = "duplicate-test",
		.desc = "second duplicate test plugin",
		.license = "LGPL-3.0-only",
		.author = "RizinOrg",
		.version = "1.0",
		.init = test_duplicate_init,
	};

	legacy_init_count = 0;
	legacy_fini_count = 0;
	duplicate_init_count = 0;
	mu_assert_true(rz_core_plugin_add(core, &first), "first plugin should be added");
	mu_assert_false(rz_core_plugin_add(core, &second), "duplicate plugin should be rejected");
	mu_assert_eq(legacy_init_count, 1, "first plugin init should be called once");
	mu_assert_eq(duplicate_init_count, 0, "duplicate plugin init should not be called");

	mu_assert_true(rz_core_plugin_del(core, &first), "first plugin should remain registered");
	mu_assert_eq(legacy_fini_count, 1, "first plugin fini should be called once");

	rz_core_free(core);
	mu_end;
}

static bool test_core_plugin_command_helpers(void) {
	RzCore *core = rz_core_new();
	mu_assert_notnull(core, "core should be created");

	RzCmdDesc *cmd = rz_core_plugin_cmd_desc_argv_new(core, "plugtest", test_plugin_cmd_handler, &test_plugin_cmd_help);
	mu_assert_notnull(cmd, "plugin argv command should be registered");
	mu_assert_true(rz_core_plugin_cmd_desc_remove(core, cmd), "plugin argv command should be removed");

	RzCmdDesc *group = rz_core_plugin_cmd_desc_group_new(core, "pluggrp", NULL, NULL, &test_plugin_group_help);
	mu_assert_notnull(group, "plugin command group should be registered");
	mu_assert_true(rz_core_plugin_cmd_desc_remove(core, group), "plugin command group should be removed");
	mu_assert_true(rz_core_plugin_cmd_desc_remove(core, NULL), "plugin command remove should accept null descriptors");

	rz_core_free(core);
	mu_end;
}

int all_tests(void) {
	mu_run_test(test_core_plugin_context_lifecycle);
	mu_run_test(test_core_plugin_legacy_lifecycle);
	mu_run_test(test_core_plugin_duplicate_name_is_rejected);
	mu_run_test(test_core_plugin_command_helpers);
	return tests_passed != tests_run;
}

mu_main(all_tests)