/*
* test_plugin.c
*
- * CTF IR Reference Count test
+ * Trace IR Reference Count test
*
* Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
*
*/
#include <babeltrace/plugin/plugin.h>
-#include <babeltrace/ref.h>
+#include <babeltrace/object.h>
#include <babeltrace/values.h>
+#include <babeltrace/private-values.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/graph.h>
+#include <babeltrace/graph/query-executor.h>
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
-#include <assert.h>
+#include <babeltrace/assert-internal.h>
#include <glib.h>
#include "tap/tap.h"
#include "common.h"
#define NON_EXISTING_PATH "/this/hopefully/does/not/exist/5bc75f8d-0dba-4043-a509-d7984b97e42b.so"
/* Those symbols are written to by some test plugins */
-int test_plugin_init_called;
-int test_plugin_exit_called;
+static int check_env_var(const char *name)
+{
+ const char *val = getenv(name);
+
+ if (!val) {
+ return -1;
+ }
+
+ return atoi(val);
+}
-static void reset_test_plugin_symbols(void)
+static void reset_test_plugin_env_vars(void)
{
- test_plugin_init_called = 0;
- test_plugin_exit_called = 0;
+ g_setenv("BT_TEST_PLUGIN_INIT_CALLED", "0", 1);
+ g_setenv("BT_TEST_PLUGIN_EXIT_CALLED", "0", 1);
}
static char *get_test_plugin_path(const char *plugin_dir,
const char *plugin_name)
{
- GString *path = g_string_new(plugin_dir);
char *ret;
+ char *plugin_file_name;
+
+ if (asprintf(&plugin_file_name, "plugin-%s." G_MODULE_SUFFIX,
+ plugin_name) == -1) {
+ abort();
+ }
+
+ ret = g_build_filename(plugin_dir, plugin_file_name, NULL);
+ free(plugin_file_name);
- assert(path);
- g_string_append_printf(path, "/plugin-%s.so", plugin_name);
- ret = path->str;
- g_string_free(path, FALSE);
return ret;
}
{
struct bt_plugin_set *plugin_set;
+ diag("invalid plugin test below");
+
plugin_set = bt_plugin_create_all_from_file(NON_EXISTING_PATH);
ok(!plugin_set, "bt_plugin_create_all_from_file() fails with a non-existing file");
struct bt_plugin *plugin;
char *minimal_path = get_test_plugin_path(plugin_dir, "minimal");
- assert(minimal_path);
+ BT_ASSERT(minimal_path);
diag("minimal plugin test below");
- reset_test_plugin_symbols();
+ reset_test_plugin_env_vars();
plugin_set = bt_plugin_create_all_from_file(minimal_path);
ok(plugin_set && bt_plugin_set_get_plugin_count(plugin_set) == 1,
"bt_plugin_create_all_from_file() succeeds with a valid file");
- ok(test_plugin_init_called, "plugin's initialization function is called during bt_plugin_create_all_from_file()");
+ ok(check_env_var("BT_TEST_PLUGIN_INIT_CALLED") == 1,
+ "plugin's initialization function is called during bt_plugin_create_all_from_file()");
ok(bt_plugin_set_get_plugin_count(plugin_set) == 1,
"bt_plugin_create_all_from_file() returns the expected number of plugins");
plugin = bt_plugin_set_get_plugin(plugin_set, 0);
"bt_plugin_get_path() returns the expected path");
ok(bt_plugin_get_component_class_count(plugin) == 0,
"bt_plugin_get_component_class_count() returns the expected value");
- bt_put(plugin);
- bt_put(plugin_set);
- ok(test_plugin_exit_called, "plugin's exit function is called when the plugin is destroyed");
+ bt_object_put_ref(plugin);
+ bt_object_put_ref(plugin_set);
+ ok(check_env_var("BT_TEST_PLUGIN_EXIT_CALLED") == 1,
+ "plugin's exit function is called when the plugin is destroyed");
free(minimal_path);
}
char *sfs_path = get_test_plugin_path(plugin_dir, "sfs");
unsigned int major, minor, patch;
const char *extra;
- struct bt_value *params;
+ struct bt_private_value *params;
struct bt_value *results;
struct bt_value *object;
struct bt_value *res_params;
struct bt_graph *graph;
const char *object_str;
+ enum bt_graph_status graph_ret;
+ struct bt_query_executor *query_exec = bt_query_executor_create();
int ret;
- assert(sfs_path);
+ BT_ASSERT(query_exec);
+ BT_ASSERT(sfs_path);
diag("sfs plugin test below");
plugin_set = bt_plugin_create_all_from_file(sfs_path);
- assert(plugin_set && bt_plugin_set_get_plugin_count(plugin_set) == 1);
+ BT_ASSERT(plugin_set && bt_plugin_set_get_plugin_count(plugin_set) == 1);
plugin = bt_plugin_set_get_plugin(plugin_set, 0);
ok(bt_plugin_get_version(plugin, &major, &minor, &patch, &extra) ==
BT_PLUGIN_STATUS_OK,
ok(!bt_plugin_get_component_class_by_name_and_type(plugin, "filter",
BT_COMPONENT_CLASS_TYPE_SOURCE),
"bt_plugin_get_component_class_by_name_and_type() does not find a component class given the wrong type");
- params = bt_value_integer_create_init(23);
- assert(params);
- ok (!bt_component_class_query(NULL, "get-something", params),
- "bt_component_class_query() handles NULL (component class)");
- ok (!bt_component_class_query(filter_comp_class, NULL, params),
- "bt_component_class_query() handles NULL (object)");
- ok (!bt_component_class_query(filter_comp_class, "get-something", NULL),
- "bt_component_class_query() handles NULL (parameters)");
- results = bt_component_class_query(filter_comp_class,
- "get-something", params);
- ok(results, "bt_component_class_query() succeeds");
- assert(bt_value_is_array(results) && bt_value_array_size(results) == 2);
- object = bt_value_array_get(results, 0);
- assert(object && bt_value_is_string(object));
- ret = bt_value_string_get(object, &object_str);
- assert(ret == 0);
+ params = bt_private_value_integer_create_init(23);
+ BT_ASSERT(params);
+ ret = bt_query_executor_query(NULL, filter_comp_class, "object",
+ bt_value_borrow_from_private(params), &results);
+ ok (ret, "bt_query_executor_query() handles NULL (query executor)");
+ ret = bt_query_executor_query(query_exec, NULL, "object",
+ bt_value_borrow_from_private(params), &results);
+ ok (ret, "bt_query_executor_query() handles NULL (component class)");
+ ret = bt_query_executor_query(query_exec, filter_comp_class, NULL,
+ bt_value_borrow_from_private(params), &results);
+ ok (ret, "bt_query_executor_query() handles NULL (object)");
+ ret = bt_query_executor_query(query_exec, filter_comp_class,
+ "get-something", bt_value_borrow_from_private(params),
+ &results);
+ ok(ret == 0 && results, "bt_query_executor_query() succeeds");
+ BT_ASSERT(bt_value_is_array(results) && bt_value_array_get_size(results) == 2);
+ object = bt_value_array_borrow_element_by_index(results, 0);
+ BT_ASSERT(object && bt_value_is_string(object));
+ object_str = bt_value_string_get(object);
ok(strcmp(object_str, "get-something") == 0,
"bt_component_class_query() receives the expected object name");
- res_params = bt_value_array_get(results, 1);
- ok(res_params == params,
+ res_params = bt_value_array_borrow_element_by_index(results, 1);
+ ok(res_params == bt_value_borrow_from_private(params),
"bt_component_class_query() receives the expected parameters");
diag("> putting the plugin object here");
- BT_PUT(plugin);
+ BT_OBJECT_PUT_REF_AND_RESET(plugin);
graph = bt_graph_create();
- assert(graph);
- ret = bt_graph_add_component(graph, sink_comp_class, "the-sink", NULL,
- &sink_component);
- ok(ret == 0 && sink_component,
+ BT_ASSERT(graph);
+ graph_ret = bt_graph_add_component(graph, sink_comp_class, "the-sink",
+ NULL, &sink_component);
+ ok(graph_ret == BT_GRAPH_STATUS_OK && sink_component,
"bt_graph_add_component() still works after the plugin object is destroyed");
- BT_PUT(sink_component);
- BT_PUT(source_comp_class);
- bt_put(graph);
+ BT_OBJECT_PUT_REF_AND_RESET(sink_component);
+ BT_OBJECT_PUT_REF_AND_RESET(source_comp_class);
+ bt_object_put_ref(graph);
graph = bt_graph_create();
- assert(graph);
- ret = bt_graph_add_component(graph, sink_comp_class, "the-sink", NULL,
- &sink_component);
- ok(ret == 0 && sink_component,
+ BT_ASSERT(graph);
+ graph_ret = bt_graph_add_component(graph, sink_comp_class, "the-sink",
+ NULL, &sink_component);
+ ok(graph_ret == BT_GRAPH_STATUS_OK && sink_component,
"bt_graph_add_component() still works after the source component class object is destroyed");
- BT_PUT(sink_component);
- BT_PUT(filter_comp_class);
- bt_put(graph);
+ BT_OBJECT_PUT_REF_AND_RESET(sink_component);
+ BT_OBJECT_PUT_REF_AND_RESET(filter_comp_class);
+ bt_object_put_ref(graph);
graph = bt_graph_create();
- assert(graph);
- ret = bt_graph_add_component(graph, sink_comp_class, "the-sink", NULL,
- &sink_component);
- ok(ret == 0 && sink_component,
+ BT_ASSERT(graph);
+ graph_ret = bt_graph_add_component(graph, sink_comp_class, "the-sink",
+ NULL, &sink_component);
+ ok(graph_ret == BT_GRAPH_STATUS_OK && sink_component,
"bt_graph_add_component() still works after the filter component class object is destroyed");
- BT_PUT(sink_comp_class);
- BT_PUT(sink_component);
+ BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class);
+ BT_OBJECT_PUT_REF_AND_RESET(sink_component);
free(sfs_path);
- bt_put(graph);
- bt_put(plugin_set);
- bt_put(object);
- bt_put(res_params);
- bt_put(results);
- bt_put(params);
+ bt_object_put_ref(graph);
+ bt_object_put_ref(plugin_set);
+ bt_object_put_ref(results);
+ bt_object_put_ref(params);
+ bt_object_put_ref(query_exec);
}
static void test_create_all_from_dir(const char *plugin_dir)
bt_plugin_set_get_plugin_count(plugin_set) == 4,
"bt_plugin_create_all_from_dir() returns the expected number of plugin objects");
- bt_put(plugin_set);
+ bt_object_put_ref(plugin_set);
}
static void test_find(const char *plugin_dir)
{
+ int ret;
struct bt_plugin *plugin;
struct bt_component_class *comp_cls_sink;
struct bt_component_class *comp_cls_source;
"bt_plugin_find() handles NULL");
ok(!bt_plugin_find(NON_EXISTING_PATH),
"bt_plugin_find() returns NULL with an unknown plugin name");
- plugin_path = malloc(PATH_MAX * 5);
- assert(plugin_path);
- sprintf(plugin_path, "%s:/ec1d09e5-696c-442e-b1c3-f9c6cf7f5958:::%s:8db46494-a398-466a-9649-c765ae077629:",
+ ret = asprintf(&plugin_path, "%s" G_SEARCHPATH_SEPARATOR_S
+ G_DIR_SEPARATOR_S "ec1d09e5-696c-442e-b1c3-f9c6cf7f5958"
+ G_SEARCHPATH_SEPARATOR_S G_SEARCHPATH_SEPARATOR_S
+ G_SEARCHPATH_SEPARATOR_S "%s" G_SEARCHPATH_SEPARATOR_S
+ "8db46494-a398-466a-9649-c765ae077629"
+ G_SEARCHPATH_SEPARATOR_S,
NON_EXISTING_PATH, plugin_dir);
+ BT_ASSERT(ret > 0 && plugin_path);
g_setenv("BABELTRACE_PLUGIN_PATH", plugin_path, 1);
plugin = bt_plugin_find("test_minimal");
ok(plugin,
"bt_plugin_find() succeeds with a plugin name it can find");
ok(strcmp(bt_plugin_get_author(plugin), "Janine Sutto") == 0,
"bt_plugin_find() finds the correct plugin for a given name");
- BT_PUT(plugin);
+ BT_OBJECT_PUT_REF_AND_RESET(plugin);
comp_cls_sink = bt_plugin_find_component_class(NULL, "sink",
BT_COMPONENT_CLASS_TYPE_SINK);
ok(!comp_cls_sink, "bt_plugin_find_component_class() handles NULL (plugin name)");
ok(comp_cls_sink, "bt_plugin_find_component_class() succeeds with another component class name (same plugin)");
ok(strcmp(bt_component_class_get_name(comp_cls_source), "source") == 0,
"bt_plugin_find_component_class() returns the appropriate component class (source)");
- BT_PUT(comp_cls_sink);
- BT_PUT(comp_cls_source);
+ BT_OBJECT_PUT_REF_AND_RESET(comp_cls_sink);
+ BT_OBJECT_PUT_REF_AND_RESET(comp_cls_source);
free(plugin_path);
}