[babeltrace.git] / tests / plugins / sink.ctf.fs / succeed / test_succeed

#!/bin/bash
#
# 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; only 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

# This test validates that a `src.ctf.fs` component successfully reads
# specific CTF traces and creates the expected messages.
#
# Such CTF traces to open either exist (in `tests/ctf-traces/succeed`)
# or are generated by this test using local trace generators.

SH_TAP=1

if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then
	UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh"
else
	UTILSSH="$(dirname "$0")/../../../utils/utils.sh"
fi

# shellcheck source=../../../utils/utils.sh
source "$UTILSSH"

this_dir_relative="plugins/sink.ctf.fs/succeed"
this_dir_build="$BT_TESTS_BUILDDIR/$this_dir_relative"
expect_dir="$BT_TESTS_DATADIR/$this_dir_relative"
succeed_traces="$BT_CTF_TRACES_PATH/succeed"

test_ctf_single() {
	local name="$1"
	local in_trace_dir="$2"
	local temp_out_trace_dir="$(mktemp -d)"

	diag "Converting trace '$name' to CTF through 'sink.ctf.fs'"
	"$BT_TESTS_BT2_BIN" >/dev/null "$in_trace_dir" -o ctf -w "$temp_out_trace_dir"
	ret=$?
	ok $ret "'sink.ctf.fs' component succeeds with input trace '$name'"
	converted_test_name="Converted trace '$name' gives the expected output"

	if [ $ret -eq 0 ]; then
		bt_diff_details_ctf_single "$expect_dir/trace-$name.expect" \
			"$temp_out_trace_dir" \
			'-p' 'with-uuid=no,with-trace-name=no,with-stream-name=no'
		ok $? "$converted_test_name"
	else
		fail "$converted_test_name"
	fi

	rm -rf "$temp_out_trace_dir"
}

test_ctf_existing_single() {
	local name="$1"
	local trace_dir="$succeed_traces/$name"

	test_ctf_single "$name" "$trace_dir"
}

test_ctf_gen_single() {
	local name="$1"
	local temp_gen_trace_dir="$(mktemp -d)"

	diag "Generating trace '$name'"

	if ! "$this_dir_build/gen-trace-$name" "$temp_gen_trace_dir"; then
		# this is not part of the test itself; it must not fail
		echo "ERROR: \"$this_dir_build/gen-trace-$name" "$temp_gen_trace_dir\" failed" >&2
		rm -rf "$temp_gen_trace_dir"
		exit 1
	fi

	test_ctf_single "$name" "$temp_gen_trace_dir"
	rm -rf "$temp_gen_trace_dir"
}

plan_tests 14

test_ctf_gen_single float
test_ctf_gen_single double
test_ctf_existing_single meta-variant-no-underscore
test_ctf_existing_single meta-variant-one-underscore
test_ctf_existing_single meta-variant-reserved-keywords
test_ctf_existing_single meta-variant-same-with-underscore
test_ctf_existing_single meta-variant-two-underscores
Commit	Line	Data
1fba7c7b PP	1	#!/bin/bash
	2	#
	3	# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
	4	#
	5	# This program is free software; you can redistribute it and/or
	6	# modify it under the terms of the GNU General Public License
	7	# as published by the Free Software Foundation; only version 2
	8	# of the License.
	9	#
	10	# This program is distributed in the hope that it will be useful,
	11	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	# GNU General Public License for more details.
	14	#
	15	# You should have received a copy of the GNU General Public License
	16	# along with this program; if not, write to the Free Software
	17	# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18
	19	# This test validates that a `src.ctf.fs` component successfully reads
	20	# specific CTF traces and creates the expected messages.
	21	#
	22	# Such CTF traces to open either exist (in `tests/ctf-traces/succeed`)
	23	# or are generated by this test using local trace generators.
	24
	25	SH_TAP=1
	26
	27	if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then
	28	UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh"
	29	else
	30	UTILSSH="$(dirname "$0")/../../../utils/utils.sh"
	31	fi
	32
	33	# shellcheck source=../../../utils/utils.sh
	34	source "$UTILSSH"
	35
	36	this_dir_relative="plugins/sink.ctf.fs/succeed"
	37	this_dir_build="$BT_TESTS_BUILDDIR/$this_dir_relative"
	38	expect_dir="$BT_TESTS_DATADIR/$this_dir_relative"
45c51519	39	succeed_traces="$BT_CTF_TRACES_PATH/succeed"
1fba7c7b	40
45c51519 PP	41	test_ctf_single() {
	42	local name="$1"
	43	local in_trace_dir="$2"
	44	local temp_out_trace_dir="$(mktemp -d)"
1fba7c7b PP	45
1fba7c7b PP	46	diag "Converting trace '$name' to CTF through 'sink.ctf.fs'"
45c51519	47	"$BT_TESTS_BT2_BIN" >/dev/null "$in_trace_dir" -o ctf -w "$temp_out_trace_dir"
1fba7c7b PP	48	ret=$?
	49	ok $ret "'sink.ctf.fs' component succeeds with input trace '$name'"
	50	converted_test_name="Converted trace '$name' gives the expected output"
	51
	52	if [ $ret -eq 0 ]; then
53cc240b MJ	53	bt_diff_details_ctf_single "$expect_dir/trace-$name.expect" \
53cc240b MJ	54	"$temp_out_trace_dir" \
45c51519	55	'-p' 'with-uuid=no,with-trace-name=no,with-stream-name=no'
1fba7c7b PP	56	ok $? "$converted_test_name"
	57	else
	58	fail "$converted_test_name"
	59	fi
	60
1fba7c7b PP	61	rm -rf "$temp_out_trace_dir"
	62	}
	63
45c51519 PP	64	test_ctf_existing_single() {
	65	local name="$1"
	66	local trace_dir="$succeed_traces/$name"
	67
	68	test_ctf_single "$name" "$trace_dir"
	69	}
	70
	71	test_ctf_gen_single() {
	72	local name="$1"
	73	local temp_gen_trace_dir="$(mktemp -d)"
	74
	75	diag "Generating trace '$name'"
	76
	77	if ! "$this_dir_build/gen-trace-$name" "$temp_gen_trace_dir"; then
	78	# this is not part of the test itself; it must not fail
	79	echo "ERROR: \"$this_dir_build/gen-trace-$name" "$temp_gen_trace_dir\" failed" >&2
	80	rm -rf "$temp_gen_trace_dir"
	81	exit 1
	82	fi
	83
	84	test_ctf_single "$name" "$temp_gen_trace_dir"
	85	rm -rf "$temp_gen_trace_dir"
	86	}
	87
	88	plan_tests 14
1fba7c7b PP	89
	90	test_ctf_gen_single float
	91	test_ctf_gen_single double
45c51519 PP	92	test_ctf_existing_single meta-variant-no-underscore
	93	test_ctf_existing_single meta-variant-one-underscore
	94	test_ctf_existing_single meta-variant-reserved-keywords
	95	test_ctf_existing_single meta-variant-same-with-underscore
	96	test_ctf_existing_single meta-variant-two-underscores