[babeltrace.git] / tests / lib / test_simple_sink.c

/*
 * Copyright (c) 2019 Philippe Proulx <pproulx@efficios.com>
 *
 * 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; under version 2 of the License.
 *
 * 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <babeltrace2/babeltrace.h>
#include "common/assert.h"
#include <string.h>
#include "tap/tap.h"

#define NR_TESTS 68

struct test_data {
	bt_graph_simple_sink_component_initialize_func_status init_status;
	bt_graph_simple_sink_component_consume_func_status consume_status;
};

static
bt_graph_simple_sink_component_initialize_func_status simple_INITIALIZE_func(
		bt_message_iterator *iterator,
		void *data)
{
	struct test_data *test_data = data;

	ok(iterator, "Message iterator is not NULL in initialization function");
	ok(data, "Data is not NULL in initialization function");
	return test_data->init_status;
}

static
bt_graph_simple_sink_component_consume_func_status simple_consume_func(
		bt_message_iterator *iterator,
		void *data)
{
	struct test_data *test_data = data;

	ok(iterator, "Message iterator is not NULL in consume function");
	ok(data, "Data is not NULL in consume function");
	return test_data->consume_status;
}

static
void simple_fini_func(void *data)
{
	ok(data, "Data is not NULL in finalization function");
}

static
bt_component_class_initialize_method_status src_init(
		bt_self_component_source *self_comp,
		bt_self_component_source_configuration *config,
		const bt_value *params, void *init_method_data)
{
	bt_self_component_add_port_status status;

	status = bt_self_component_source_add_output_port(self_comp,
		"out", NULL, NULL);
	BT_ASSERT(status == BT_SELF_COMPONENT_ADD_PORT_STATUS_OK);
	return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
}

static
bt_message_iterator_class_next_method_status src_iter_next(
		bt_self_message_iterator *message_iterator,
		bt_message_array_const msgs, uint64_t capacity,
		uint64_t *count)
{
	return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
}

static
bt_graph *create_graph_with_source(const bt_port_output **out_port)
{
	bt_message_iterator_class *msg_iter_cls;
	bt_component_class_source *src_comp_cls;
	bt_graph *graph;
	const bt_component_source *src_comp = NULL;
	bt_graph_add_component_status add_comp_status;
	bt_component_class_set_method_status set_method_status;

	BT_ASSERT(out_port);

	msg_iter_cls = bt_message_iterator_class_create(src_iter_next);
	BT_ASSERT(msg_iter_cls);

	src_comp_cls = bt_component_class_source_create("src", msg_iter_cls);
	BT_ASSERT(src_comp_cls);
	set_method_status = bt_component_class_source_set_initialize_method(
		src_comp_cls, src_init);
	BT_ASSERT(set_method_status == BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK);
	graph = bt_graph_create(0);
	BT_ASSERT(graph);
	add_comp_status = bt_graph_add_source_component(graph, src_comp_cls,
		"src", NULL, BT_LOGGING_LEVEL_NONE, &src_comp);
	BT_ASSERT(add_comp_status == BT_GRAPH_ADD_COMPONENT_STATUS_OK);
	BT_ASSERT(src_comp);
	*out_port = bt_component_source_borrow_output_port_by_index_const(
		src_comp, 0);
	BT_ASSERT(*out_port);
	bt_component_class_source_put_ref(src_comp_cls);
	bt_message_iterator_class_put_ref(msg_iter_cls);
	return graph;
}

static
void test_simple_expect_run_once_status(
		bt_graph_simple_sink_component_initialize_func_status init_status,
		bt_graph_simple_sink_component_consume_func_status consume_status,
		bt_graph_run_once_status exp_run_once_status)
{
	const bt_port_output *src_out_port = NULL;
	bt_graph *graph;
	const bt_component_sink *sink_comp = NULL;
	const bt_port_input *sink_in_port;
	bt_graph_add_component_status add_comp_status;
	bt_graph_run_once_status run_once_status;
	bt_graph_connect_ports_status connect_status;
	struct test_data test_data = {
		.init_status = init_status,
		.consume_status = consume_status,
	};
	const struct bt_error *err;

	graph = create_graph_with_source(&src_out_port);
	BT_ASSERT(graph);
	BT_ASSERT(src_out_port);

	add_comp_status = bt_graph_add_simple_sink_component(graph, "sink",
		simple_INITIALIZE_func, simple_consume_func, simple_fini_func,
		&test_data, &sink_comp);
	BT_ASSERT(add_comp_status == BT_GRAPH_ADD_COMPONENT_STATUS_OK);
	BT_ASSERT(sink_comp);

	sink_in_port = bt_component_sink_borrow_input_port_by_name_const(
		sink_comp, "in");
	ok(sink_in_port,
		"Simple sink component has an input port named \"in\"");

	connect_status = bt_graph_connect_ports(graph, src_out_port,
		sink_in_port, NULL);
	ok(connect_status == BT_GRAPH_CONNECT_PORTS_STATUS_OK,
		"Simple sink component's \"in\" port is connectable");

	run_once_status = bt_graph_run_once(graph);
	ok(run_once_status == exp_run_once_status,
		"Graph \"run once\" status is the expected one (status code: %d)",
		run_once_status);

	err = bt_current_thread_take_error();
	ok((run_once_status < 0) == (err != NULL),
		"Current thread error is set if bt_graph_run_once returned an error");

	bt_graph_put_ref(graph);
	if (err) {
		bt_error_release(err);
	}
}

int main(void)
{
	plan_tests(NR_TESTS);

	/* Test initialization function status */
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
		BT_GRAPH_RUN_ONCE_STATUS_OK);
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_ERROR,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
		BT_GRAPH_RUN_ONCE_STATUS_ERROR);
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_MEMORY_ERROR,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
		BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR);

	/* Test "consume" function status */
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
		BT_GRAPH_RUN_ONCE_STATUS_OK);
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_ERROR,
		BT_GRAPH_RUN_ONCE_STATUS_ERROR);
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_MEMORY_ERROR,
		BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR);
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_AGAIN,
		BT_GRAPH_RUN_ONCE_STATUS_AGAIN);
	test_simple_expect_run_once_status(
		BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
		BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_END,
		BT_GRAPH_RUN_ONCE_STATUS_END);

	return exit_status();
}
Commit	Line	Data
8c20dd54 PP	1	/*
	2	* Copyright (c) 2019 Philippe Proulx <pproulx@efficios.com>
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; under version 2 of the License.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along
	14	* with this program; if not, write to the Free Software Foundation, Inc.,
	15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#include <babeltrace2/babeltrace.h>
	19	#include "common/assert.h"
	20	#include <string.h>
	21	#include "tap/tap.h"
	22
79840741	23	#define NR_TESTS 68
8c20dd54 PP	24
8c20dd54 PP	25	struct test_data {
21a9f056	26	bt_graph_simple_sink_component_initialize_func_status init_status;
8c20dd54 PP	27	bt_graph_simple_sink_component_consume_func_status consume_status;
	28	};
	29
	30	static
21a9f056	31	bt_graph_simple_sink_component_initialize_func_status simple_INITIALIZE_func(
9a2c8b8e	32	bt_message_iterator *iterator,
8c20dd54 PP	33	void *data)
	34	{
	35	struct test_data *test_data = data;
	36
	37	ok(iterator, "Message iterator is not NULL in initialization function");
	38	ok(data, "Data is not NULL in initialization function");
	39	return test_data->init_status;
	40	}
	41
	42	static
	43	bt_graph_simple_sink_component_consume_func_status simple_consume_func(
9a2c8b8e	44	bt_message_iterator *iterator,
8c20dd54 PP	45	void *data)
	46	{
	47	struct test_data *test_data = data;
	48
	49	ok(iterator, "Message iterator is not NULL in consume function");
	50	ok(data, "Data is not NULL in consume function");
	51	return test_data->consume_status;
	52	}
	53
	54	static
	55	void simple_fini_func(void *data)
	56	{
	57	ok(data, "Data is not NULL in finalization function");
	58	}
	59
	60	static
21a9f056	61	bt_component_class_initialize_method_status src_init(
8c20dd54	62	bt_self_component_source *self_comp,
59225a3e	63	bt_self_component_source_configuration *config,
8c20dd54 PP	64	const bt_value params, void init_method_data)
	65	{
	66	bt_self_component_add_port_status status;
	67
	68	status = bt_self_component_source_add_output_port(self_comp,
	69	"out", NULL, NULL);
	70	BT_ASSERT(status == BT_SELF_COMPONENT_ADD_PORT_STATUS_OK);
21a9f056	71	return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
8c20dd54 PP	72	}
	73
	74	static
a3f0c7db	75	bt_message_iterator_class_next_method_status src_iter_next(
8c20dd54 PP	76	bt_self_message_iterator *message_iterator,
	77	bt_message_array_const msgs, uint64_t capacity,
	78	uint64_t *count)
	79	{
a3f0c7db	80	return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END;
8c20dd54 PP	81	}
	82
	83	static
	84	bt_graph create_graph_with_source(const bt_port_output *out_port)
	85	{
a3f0c7db	86	bt_message_iterator_class *msg_iter_cls;
8c20dd54 PP	87	bt_component_class_source *src_comp_cls;
	88	bt_graph *graph;
	89	const bt_component_source *src_comp = NULL;
	90	bt_graph_add_component_status add_comp_status;
	91	bt_component_class_set_method_status set_method_status;
	92
	93	BT_ASSERT(out_port);
a3f0c7db SM	94
	95	msg_iter_cls = bt_message_iterator_class_create(src_iter_next);
	96	BT_ASSERT(msg_iter_cls);
	97
	98	src_comp_cls = bt_component_class_source_create("src", msg_iter_cls);
8c20dd54	99	BT_ASSERT(src_comp_cls);
21a9f056	100	set_method_status = bt_component_class_source_set_initialize_method(
8c20dd54 PP	101	src_comp_cls, src_init);
8c20dd54 PP	102	BT_ASSERT(set_method_status == BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK);
056deb59	103	graph = bt_graph_create(0);
8c20dd54 PP	104	BT_ASSERT(graph);
	105	add_comp_status = bt_graph_add_source_component(graph, src_comp_cls,
	106	"src", NULL, BT_LOGGING_LEVEL_NONE, &src_comp);
	107	BT_ASSERT(add_comp_status == BT_GRAPH_ADD_COMPONENT_STATUS_OK);
	108	BT_ASSERT(src_comp);
	109	*out_port = bt_component_source_borrow_output_port_by_index_const(
	110	src_comp, 0);
	111	BT_ASSERT(*out_port);
8c20dd54	112	bt_component_class_source_put_ref(src_comp_cls);
a3f0c7db	113	bt_message_iterator_class_put_ref(msg_iter_cls);
8c20dd54 PP	114	return graph;
	115	}
	116
	117	static
	118	void test_simple_expect_run_once_status(
21a9f056	119	bt_graph_simple_sink_component_initialize_func_status init_status,
8c20dd54 PP	120	bt_graph_simple_sink_component_consume_func_status consume_status,
	121	bt_graph_run_once_status exp_run_once_status)
	122	{
	123	const bt_port_output *src_out_port = NULL;
	124	bt_graph *graph;
	125	const bt_component_sink *sink_comp = NULL;
	126	const bt_port_input *sink_in_port;
	127	bt_graph_add_component_status add_comp_status;
	128	bt_graph_run_once_status run_once_status;
	129	bt_graph_connect_ports_status connect_status;
	130	struct test_data test_data = {
	131	.init_status = init_status,
	132	.consume_status = consume_status,
	133	};
79840741	134	const struct bt_error *err;
8c20dd54 PP	135
	136	graph = create_graph_with_source(&src_out_port);
	137	BT_ASSERT(graph);
	138	BT_ASSERT(src_out_port);
79840741	139
8c20dd54	140	add_comp_status = bt_graph_add_simple_sink_component(graph, "sink",
21a9f056	141	simple_INITIALIZE_func, simple_consume_func, simple_fini_func,
8c20dd54 PP	142	&test_data, &sink_comp);
	143	BT_ASSERT(add_comp_status == BT_GRAPH_ADD_COMPONENT_STATUS_OK);
	144	BT_ASSERT(sink_comp);
79840741	145
8c20dd54 PP	146	sink_in_port = bt_component_sink_borrow_input_port_by_name_const(
	147	sink_comp, "in");
	148	ok(sink_in_port,
	149	"Simple sink component has an input port named \"in\"");
79840741	150
8c20dd54 PP	151	connect_status = bt_graph_connect_ports(graph, src_out_port,
	152	sink_in_port, NULL);
	153	ok(connect_status == BT_GRAPH_CONNECT_PORTS_STATUS_OK,
	154	"Simple sink component's \"in\" port is connectable");
79840741	155
8c20dd54 PP	156	run_once_status = bt_graph_run_once(graph);
	157	ok(run_once_status == exp_run_once_status,
	158	"Graph \"run once\" status is the expected one (status code: %d)",
	159	run_once_status);
79840741 SM	160
	161	err = bt_current_thread_take_error();
	162	ok((run_once_status < 0) == (err != NULL),
	163	"Current thread error is set if bt_graph_run_once returned an error");
	164
8c20dd54	165	bt_graph_put_ref(graph);
79840741 SM	166	if (err) {
	167	bt_error_release(err);
	168	}
8c20dd54 PP	169	}
	170
	171	int main(void)
	172	{
	173	plan_tests(NR_TESTS);
	174
	175	/* Test initialization function status */
	176	test_simple_expect_run_once_status(
21a9f056	177	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
8c20dd54 PP	178	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
	179	BT_GRAPH_RUN_ONCE_STATUS_OK);
	180	test_simple_expect_run_once_status(
21a9f056	181	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_ERROR,
8c20dd54 PP	182	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
	183	BT_GRAPH_RUN_ONCE_STATUS_ERROR);
	184	test_simple_expect_run_once_status(
21a9f056	185	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_MEMORY_ERROR,
8c20dd54 PP	186	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
	187	BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR);
	188
	189	/* Test "consume" function status */
	190	test_simple_expect_run_once_status(
21a9f056	191	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
8c20dd54 PP	192	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK,
	193	BT_GRAPH_RUN_ONCE_STATUS_OK);
	194	test_simple_expect_run_once_status(
21a9f056	195	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
8c20dd54 PP	196	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_ERROR,
	197	BT_GRAPH_RUN_ONCE_STATUS_ERROR);
	198	test_simple_expect_run_once_status(
21a9f056	199	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
8c20dd54 PP	200	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_MEMORY_ERROR,
	201	BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR);
	202	test_simple_expect_run_once_status(
21a9f056	203	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
8c20dd54 PP	204	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_AGAIN,
	205	BT_GRAPH_RUN_ONCE_STATUS_AGAIN);
	206	test_simple_expect_run_once_status(
21a9f056	207	BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK,
8c20dd54 PP	208	BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_END,
	209	BT_GRAPH_RUN_ONCE_STATUS_END);
	210
	211	return exit_status();
	212	}