[babeltrace.git] / tests / plugins / src.ctf.lttng-live / test_live

#!/bin/bash
#
# SPDX-License-Identifier: GPL-2.0-only
#
# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
#

# 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/`)
# 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"

function cleanup ()
{
	# Disable trap for SIGTERM since the following kill to the
	# pidgroup will be SIGTERM. Otherwise it loops.
	# The '-' before the pid number ($$) indicates 'kill' to signal the
	# whole process group.
	trap - SIGTERM && kill -- -$$
}

# Ensure that background child jobs are killed on SIGINT/SIGTERM
trap cleanup SIGINT SIGTERM

this_dir_relative="plugins/src.ctf.lttng-live"
test_data_dir="$BT_TESTS_DATADIR/$this_dir_relative"
trace_dir="$BT_CTF_TRACES_PATH"

if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
	# Same as the above, but in Windows form (C:\foo\bar) instead of Unix form
	# (/c/foo/bar).
	trace_dir_native=$(cygpath -w "${trace_dir}")
else
	trace_dir_native="${trace_dir}"
fi

lttng_live_server() {
	local port_file="$1"
	local pid_file="$2"
	local retcode_file="$3"
	local server_args="$4"
	local server_script="$test_data_dir/lttng_live_server.py"

	# start server
	diag "$BT_TESTS_PYTHON_BIN $server_script --port-file $port_file --trace-path-prefix $trace_dir_native $server_args"
	echo "$server_args" | xargs "$BT_TESTS_PYTHON_BIN" "$server_script" \
		--port-file "$port_file" \
		--trace-path-prefix "$trace_dir_native" &

	# write PID to file
	echo $! > "$pid_file"

	# wait for server to exit
	wait

	# write return code to file
	echo $? > "$retcode_file"
}

kill_lttng_live_server() {
	local pid_file="$1"

	if [ ! -s "$pid_file" ]; then
		return
	fi

	kill -9 "$(cat "$pid_file")"
}

get_cli_output_with_lttng_live_server() {
	local cli_args_template="$1"
	local sessions_file="$2"
	local cli_stdout_file="$3"
	local cli_stderr_file="$4"
	local port_file="$5"

	local i
	local ret
	local port
	local cli_args
	local server_pid_file
	local server_retcode_file

	server_pid_file="$(mktemp -t test_live_server_pid.XXXXXX)"
	server_retcode_file="$(mktemp -t test_live_server_ret.XXXXX)"

	diag "Starting LTTng live server mockup"

	# This starts the server, which eventually writes its listening
	# port number to the `$port_file` file. The lttng_live_server()
	# function itself writes the server's PID to the
	# `$server_pid_file` file. When the server exits,
	# lttng_live_server() writes its return code to the
	# `$server_retcode_file` file.
	lttng_live_server "$port_file" "$server_pid_file" \
		"$server_retcode_file" "$sessions_file" &

	# Get port number
	i=0
	while [ ! -s "$port_file" ]; do
		sleep .1

		# Timeout of 30 seconds
		if [ "$i" -eq "300" ]; then
			# too long, kill it
			kill_lttng_live_server "$server_pid_file"
			wait
			rm -f "$server_pid_file"
			rm -f "$server_retcode_file"
			return 1
		fi

		i=$((i + 1))
	done

	port=$(<"$port_file")

	diag "LTTng live port is $port"

	cli_args=${cli_args_template//@PORT@/$port}

	# Split argument string by spaces into an array.
	IFS=' ' read -ra cli_args <<< "$cli_args"

	if ! bt_cli "$cli_stdout_file" "$cli_stderr_file" "${cli_args[@]}"; then
		# CLI failed: cancel everything else
		kill_lttng_live_server "$server_pid_file"
		wait
		rm -f "$server_pid_file"
		rm -f "$server_retcode_file"
		return 1
	fi

	# get server's return code
	i=0
	while [ ! -s "$server_retcode_file" ]; do
		sleep .1

		# Timeout of 30 seconds
		if [ "$i" -eq "300" ]; then
			# too long, kill it
			kill_lttng_live_server "$server_pid_file"
			wait
			rm -f "$server_pid_file"
			rm -f "$server_retcode_file"
			return 1
		fi

		i=$((i + 1))
	done

	wait

	ret=$(<"$server_retcode_file")

	rm -f "$server_pid_file"
	rm -f "$server_retcode_file"
	return "$ret"
}

run_test() {
	local test_text="$1"
	local cli_args_template="$2"
	local server_args="$3"
	local expected_stdout="$4"
	local expected_stderr="$5"

	local cli_stderr
	local cli_stdout
	local port_file
	local port

	cli_stderr="$(mktemp -t test_live_stderr.XXXXXX)"
	cli_stdout="$(mktemp -t test_live_stdout.XXXXXX)"
	port_file="$(mktemp -t test_live_server_port.XXXXXX)"

	get_cli_output_with_lttng_live_server "$cli_args_template" "$server_args" "$cli_stdout" "$cli_stderr" "$port_file"
	port=$(<"$port_file")

	bt_diff "$expected_stdout" "$cli_stdout"
	ok $? "$test_text - stdout"
	bt_diff "$expected_stderr" "$cli_stderr"
	ok $? "$test_text - stderr"

	rm -f "$cli_stderr"
	rm -f "$cli_stdout"
	rm -f "$port_file"
}

test_list_sessions() {
	# Test the basic listing of sessions.
	# Ensure that a multi-domain trace is seen as a single session.
	# run_test() is not used here because the port is needed to craft the
	# expected output.

	local port
	local port_file
	local tmp_stdout_expected
	local template_expected

	local test_text="CLI prints the expected session list"
	local cli_args_template="-i lttng-live net://localhost:@PORT@"
	local sessions_file="$test_data_dir/list_sessions.json"
	local server_args="--sessions-filename '$sessions_file'"

	template_expected=$(<"$test_data_dir/cli-list-sessions.expect")
	cli_stderr="$(mktemp -t test_live_list_sessions_stderr.XXXXXX)"
	cli_stdout="$(mktemp -t test_live_list_sessions_stdout.XXXXXX)"
	empty_file="$(mktemp -t test_live_list_sessions_empty.XXXXXX)"
	port_file="$(mktemp -t test_live_list_sessions_server_port.XXXXXX)"
	tmp_stdout_expected="$(mktemp -t test_live_list_sessions_stdout_expected.XXXXXX)"

	get_cli_output_with_lttng_live_server "$cli_args_template" "$server_args" "$cli_stdout" "$cli_stderr" "$port_file"
	port=$(<"$port_file")

	# Craft the expected output. This is necessary since the port number
	# (random) of a "relayd" is present in the output.
	template_expected=${template_expected//@PORT@/$port}

	echo "$template_expected" > "$tmp_stdout_expected"

	bt_diff "$tmp_stdout_expected" "$cli_stdout"
	ok $? "$test_text - stdout"
	bt_diff "$empty_file" "$cli_stderr"
	ok $? "$test_text - stderr"

	rm -f "$cli_stderr"
	rm -f "$cli_stdout"
	rm -f "$empty_file"
	rm -f "$port_file"
	rm -f "$tmp_stdout_expected"
}

test_base() {
	# Attach and consume data from a multi packets ust session with no
	# discarded events.
	local test_text="CLI attach and fetch from single-domains session - no discarded events"
	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/trace-with-index -c sink.text.details"
	local sessions_file="$test_data_dir/base.json"
	local server_args="--sessions-filename '$sessions_file'"
	local expected_stdout="${test_data_dir}/cli-base.expect"
	local expected_stderr

	# Empty file for stderr expected
	expected_stderr="$(mktemp -t test_live_base_stderr_expected.XXXXXX)"

	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"

	rm -f "$expected_stderr"
}

test_multi_domains() {
	# Attach and consume data from a multi-domains session with discarded
	# events.
	local test_text="CLI attach and fetch from multi-domains session - discarded events"
	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/multi-domains -c sink.text.details"
	local sessions_file="${test_data_dir}/multi_domains.json"
	local server_args="--sessions-filename '$sessions_file'"
	local expected_stdout="$test_data_dir/cli-multi-domains.expect"
	local expected_stderr

	# Empty file for stderr expected
	expected_stderr="$(mktemp -t test_live_multi_domains_stderr_expected.XXXXXX)"

	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"

	rm -f "$expected_stderr"
}

test_rate_limited() {
	# Attach and consume data from a multi packets ust session with no
	# discarded events. Enforce a server side limit on the stream data
	# requests size. Ensure that babeltrace respect the returned size and that
	# many requests per packet works as expected.
	# The packet size of the test trace is 4k. Limit requests to 1k.
	local test_text="CLI many requests per packet"
	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/trace-with-index -c sink.text.details"
	local sessions_file="$test_data_dir/rate_limited.json"
	local server_args="--max-query-data-response-size 1024 --sessions-filename '$sessions_file'"
	local expected_stdout="${test_data_dir}/cli-base.expect"
	local expected_stderr

	# Empty file for stderr expected
	expected_stderr="$(mktemp -t test_live_rate_limited_stderr_expected.XXXXXX)"

	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"

	rm -f "$expected_stderr"
}

test_compare_to_ctf_fs() {
	# Compare the details text sink or ctf.fs and ctf.lttng-live to ensure
	# that the trace is parsed the same way.
	# Do the same with the session swapped on the relayd side. This validate
	# that ordering is consistent between live and ctf fs.
	local test_text="CLI src.ctf.fs vs src.ctf.lttng-live"
	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/multi-domains -c sink.text.details --params with-trace-name=false,with-stream-name=false"
	local sessions_file="$test_data_dir/multi_domains.json"
	local sessions_file_inverse="$test_data_dir/multi_domains_inverse.json"
	local server_args="--sessions-filename '$sessions_file'"
	local server_args_inverse="--sessions-filename '$sessions_file_inverse'"
	local expected_stdout
	local expected_stderr

	expected_stdout="$(mktemp -t test_live_compare_stdout_expected.XXXXXX)"
	expected_stderr="$(mktemp -t test_live_compare_stderr_expected.XXXXXX)"

	bt_cli "$expected_stdout" "$expected_stderr" "${trace_dir}/succeed/multi-domains" -c sink.text.details --params "with-trace-name=false,with-stream-name=false"
	bt_remove_cr "${expected_stdout}"
	bt_remove_cr "${expected_stderr}"
	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
	diag "Inverse session order from lttng-relayd"
	run_test "$test_text" "$cli_args_template" "$server_args_inverse" "$expected_stdout" "$expected_stderr"

	rm -f "$expected_stdout"
	rm -f "$expected_stderr"
}

test_inactivity_discarded_packet() {
	# Attach and consume data from a multi-packet trace with discarded
	# packets and emit an inactivity beacon during the discarded packets
	# period.
	#
	# | pkt seq:0 |<-------discarded packets------>| pkt seq:8 |
	# 0          20                                121       140
	#
	# This test was introduced to cover the following bug:
	#
	# When reading this type of trace locally, the CTF source is expected
	# to introduce a "Discarded packets" message between packets 0 and 8.
	# The timestamps of this message are [pkt0.end_ts, pkt8.begin_ts].
	#
	# In the context of a live source, the tracer could report an inactivity
	# period during the interval of the "Discarded packets" message.
	# Those messages eventually translate into a
	# "Iterator inactivity" message with a timestamp set at the end of the
	# inactivity period.
	#
	# If the tracer reports an inactivity period that ends at a point
	# between pkt0 and pkt7 (resulting in an "Iterator inactivity" message),
	# the live source could send a "Discarded packets" message that starts
	# before the preceding "Iterator inactivity" message. This would break
	# the monotonicity constraint of the graph.
	local test_text="CLI attach and fetch from single-domains session - inactivity discarded packet"
	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/7_lost_between_2_with_index -c sink.text.details"
	local sessions_file="$test_data_dir/inactivity_discarded_packet.json"
	local server_args="--sessions-filename '$sessions_file'"
	local expected_stdout="$test_data_dir/inactivity_discarded_packet.expect"
	local expected_stderr

	# Empty file for stderr expected
	expected_stderr="$(mktemp -t test_live_inactivity_discarded_packet_stderr_expected.XXXXXX)"

	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"

	rm -f "$expected_stderr"
}

test_split_metadata() {
	# Consume a metadata stream sent in two parts. This testcase tests the
	# behaviour of Babeltrace when the tracing session was cleared (lttng
	# clear) but the metadata is not yet available to the relay. In such
	# cases, when asked for metadata, the relay will return the
	# `LTTNG_VIEWER_METADATA_OK` status and a data length of 0. The viewer
	# need to consider such case as a request to retry fetching metadata.
	#
	# This testcase emulates such behaviour by adding empty metadata
	# packets.

	local test_text="CLI attach and fetch from single-domain session - Receive metadata in two sections separated by a empty section"
	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/split_metadata -c sink.text.details"
	local sessions_file="$test_data_dir/split_metadata.json"
	local server_args="--sessions-filename '$sessions_file'"
	local expected_stdout="${test_data_dir}/split_metadata.expect"
	local expected_stderr

	# Empty file for stderr expected
	expected_stderr="$(mktemp -t test_live_split_metadata_stderr_expected.XXXXXX)"

	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"

	rm -f "$expected_stderr"
}

plan_tests 16

test_list_sessions
test_base
test_multi_domains
test_rate_limited
test_compare_to_ctf_fs
test_inactivity_discarded_packet
test_split_metadata
Commit	Line	Data
584af91e PP	1	#!/bin/bash
584af91e PP	2	#
0235b0db	3	# SPDX-License-Identifier: GPL-2.0-only
584af91e	4	#
0235b0db	5	# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
584af91e	6	#
584af91e PP	7
	8	# This test validates that a `src.ctf.fs` component successfully reads
	9	# specific CTF traces and creates the expected messages.
	10	#
2b763e29	11	# Such CTF traces to open either exist (in `tests/ctf-traces/`)
584af91e PP	12	# or are generated by this test using local trace generators.
	13
	14	SH_TAP=1
	15
	16	if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then
	17	UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh"
	18	else
	19	UTILSSH="$(dirname "$0")/../../utils/utils.sh"
	20	fi
	21
	22	# shellcheck source=../../utils/utils.sh
	23	source "$UTILSSH"
	24
	25	function cleanup ()
	26	{
	27	# Disable trap for SIGTERM since the following kill to the
	28	# pidgroup will be SIGTERM. Otherwise it loops.
	29	# The '-' before the pid number ($$) indicates 'kill' to signal the
	30	# whole process group.
	31	trap - SIGTERM && kill -- -$$
	32	}
	33
	34	# Ensure that background child jobs are killed on SIGINT/SIGTERM
	35	trap cleanup SIGINT SIGTERM
	36
	37	this_dir_relative="plugins/src.ctf.lttng-live"
	38	test_data_dir="$BT_TESTS_DATADIR/$this_dir_relative"
2b763e29	39	trace_dir="$BT_CTF_TRACES_PATH"
584af91e	40
a0baab4a	41	if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
742e3279 SM	42	# Same as the above, but in Windows form (C:\foo\bar) instead of Unix form
	43	# (/c/foo/bar).
	44	trace_dir_native=$(cygpath -w "${trace_dir}")
	45	else
	46	trace_dir_native="${trace_dir}"
	47	fi
	48
584af91e PP	49	lttng_live_server() {
	50	local port_file="$1"
	51	local pid_file="$2"
	52	local retcode_file="$3"
	53	local server_args="$4"
	54	local server_script="$test_data_dir/lttng_live_server.py"
	55
	56	# start server
3f9e6f1e	57	diag "$BT_TESTS_PYTHON_BIN $server_script --port-file $port_file --trace-path-prefix $trace_dir_native $server_args"
2b763e29 JG	58	echo "$server_args" \| xargs "$BT_TESTS_PYTHON_BIN" "$server_script" \
	59	--port-file "$port_file" \
	60	--trace-path-prefix "$trace_dir_native" &
584af91e PP	61
	62	# write PID to file
	63	echo $! > "$pid_file"
	64
	65	# wait for server to exit
	66	wait
	67
	68	# write return code to file
	69	echo $? > "$retcode_file"
	70	}
	71
	72	kill_lttng_live_server() {
	73	local pid_file="$1"
	74
	75	if [ ! -s "$pid_file" ]; then
	76	return
	77	fi
	78
	79	kill -9 "$(cat "$pid_file")"
	80	}
	81
	82	get_cli_output_with_lttng_live_server() {
	83	local cli_args_template="$1"
2b763e29	84	local sessions_file="$2"
584af91e PP	85	local cli_stdout_file="$3"
	86	local cli_stderr_file="$4"
	87	local port_file="$5"
	88
	89	local i
	90	local ret
	91	local port
	92	local cli_args
	93	local server_pid_file
	94	local server_retcode_file
	95
a01934b7 SM	96	server_pid_file="$(mktemp -t test_live_server_pid.XXXXXX)"
a01934b7 SM	97	server_retcode_file="$(mktemp -t test_live_server_ret.XXXXX)"
584af91e PP	98
	99	diag "Starting LTTng live server mockup"
	100
	101	# This starts the server, which eventually writes its listening
	102	# port number to the `$port_file` file. The lttng_live_server()
	103	# function itself writes the server's PID to the
	104	# `$server_pid_file` file. When the server exits,
	105	# lttng_live_server() writes its return code to the
	106	# `$server_retcode_file` file.
	107	lttng_live_server "$port_file" "$server_pid_file" \
2b763e29	108	"$server_retcode_file" "$sessions_file" &
584af91e PP	109
	110	# Get port number
	111	i=0
	112	while [ ! -s "$port_file" ]; do
	113	sleep .1
	114
	115	# Timeout of 30 seconds
	116	if [ "$i" -eq "300" ]; then
	117	# too long, kill it
	118	kill_lttng_live_server "$server_pid_file"
	119	wait
	120	rm -f "$server_pid_file"
	121	rm -f "$server_retcode_file"
	122	return 1
	123	fi
	124
	125	i=$((i + 1))
	126	done
	127
	128	port=$(<"$port_file")
	129
	130	diag "LTTng live port is $port"
	131
	132	cli_args=${cli_args_template//@PORT@/$port}
	133
db4cb7f1 SM	134	# Split argument string by spaces into an array.
	135	IFS=' ' read -ra cli_args <<< "$cli_args"
	136
	137	if ! bt_cli "$cli_stdout_file" "$cli_stderr_file" "${cli_args[@]}"; then
584af91e PP	138	# CLI failed: cancel everything else
	139	kill_lttng_live_server "$server_pid_file"
	140	wait
	141	rm -f "$server_pid_file"
	142	rm -f "$server_retcode_file"
	143	return 1
	144	fi
	145
	146	# get server's return code
	147	i=0
	148	while [ ! -s "$server_retcode_file" ]; do
	149	sleep .1
	150
	151	# Timeout of 30 seconds
	152	if [ "$i" -eq "300" ]; then
	153	# too long, kill it
	154	kill_lttng_live_server "$server_pid_file"
	155	wait
	156	rm -f "$server_pid_file"
	157	rm -f "$server_retcode_file"
	158	return 1
	159	fi
	160
	161	i=$((i + 1))
	162	done
	163
	164	wait
	165
	166	ret=$(<"$server_retcode_file")
	167
	168	rm -f "$server_pid_file"
	169	rm -f "$server_retcode_file"
	170	return "$ret"
	171	}
	172
	173	run_test() {
	174	local test_text="$1"
	175	local cli_args_template="$2"
	176	local server_args="$3"
	177	local expected_stdout="$4"
	178	local expected_stderr="$5"
	179
	180	local cli_stderr
	181	local cli_stdout
	182	local port_file
4079467b	183	local port
584af91e	184
a01934b7 SM	185	cli_stderr="$(mktemp -t test_live_stderr.XXXXXX)"
	186	cli_stdout="$(mktemp -t test_live_stdout.XXXXXX)"
	187	port_file="$(mktemp -t test_live_server_port.XXXXXX)"
584af91e PP	188
	189	get_cli_output_with_lttng_live_server "$cli_args_template" "$server_args" "$cli_stdout" "$cli_stderr" "$port_file"
	190	port=$(<"$port_file")
	191
	192	bt_diff "$expected_stdout" "$cli_stdout"
	193	ok $? "$test_text - stdout"
	194	bt_diff "$expected_stderr" "$cli_stderr"
	195	ok $? "$test_text - stderr"
	196
	197	rm -f "$cli_stderr"
	198	rm -f "$cli_stdout"
	199	rm -f "$port_file"
	200	}
	201
	202	test_list_sessions() {
	203	# Test the basic listing of sessions.
	204	# Ensure that a multi-domain trace is seen as a single session.
	205	# run_test() is not used here because the port is needed to craft the
	206	# expected output.
	207
	208	local port
	209	local port_file
	210	local tmp_stdout_expected
	211	local template_expected
	212
	213	local test_text="CLI prints the expected session list"
	214	local cli_args_template="-i lttng-live net://localhost:@PORT@"
2b763e29 JG	215	local sessions_file="$test_data_dir/list_sessions.json"
2b763e29 JG	216	local server_args="--sessions-filename '$sessions_file'"
584af91e PP	217
584af91e PP	218	template_expected=$(<"$test_data_dir/cli-list-sessions.expect")
a01934b7 SM	219	cli_stderr="$(mktemp -t test_live_list_sessions_stderr.XXXXXX)"
	220	cli_stdout="$(mktemp -t test_live_list_sessions_stdout.XXXXXX)"
	221	empty_file="$(mktemp -t test_live_list_sessions_empty.XXXXXX)"
	222	port_file="$(mktemp -t test_live_list_sessions_server_port.XXXXXX)"
	223	tmp_stdout_expected="$(mktemp -t test_live_list_sessions_stdout_expected.XXXXXX)"
584af91e PP	224
	225	get_cli_output_with_lttng_live_server "$cli_args_template" "$server_args" "$cli_stdout" "$cli_stderr" "$port_file"
	226	port=$(<"$port_file")
	227
	228	# Craft the expected output. This is necessary since the port number
	229	# (random) of a "relayd" is present in the output.
	230	template_expected=${template_expected//@PORT@/$port}
	231
	232	echo "$template_expected" > "$tmp_stdout_expected"
	233
	234	bt_diff "$tmp_stdout_expected" "$cli_stdout"
	235	ok $? "$test_text - stdout"
	236	bt_diff "$empty_file" "$cli_stderr"
	237	ok $? "$test_text - stderr"
	238
	239	rm -f "$cli_stderr"
	240	rm -f "$cli_stdout"
	241	rm -f "$empty_file"
	242	rm -f "$port_file"
	243	rm -f "$tmp_stdout_expected"
	244	}
	245
	246	test_base() {
	247	# Attach and consume data from a multi packets ust session with no
	248	# discarded events.
	249	local test_text="CLI attach and fetch from single-domains session - no discarded events"
	250	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/trace-with-index -c sink.text.details"
2b763e29 JG	251	local sessions_file="$test_data_dir/base.json"
2b763e29 JG	252	local server_args="--sessions-filename '$sessions_file'"
584af91e PP	253	local expected_stdout="${test_data_dir}/cli-base.expect"
	254	local expected_stderr
	255
	256	# Empty file for stderr expected
a01934b7	257	expected_stderr="$(mktemp -t test_live_base_stderr_expected.XXXXXX)"
584af91e PP	258
	259	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
	260
	261	rm -f "$expected_stderr"
	262	}
	263
	264	test_multi_domains() {
	265	# Attach and consume data from a multi-domains session with discarded
	266	# events.
	267	local test_text="CLI attach and fetch from multi-domains session - discarded events"
	268	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/multi-domains -c sink.text.details"
2b763e29 JG	269	local sessions_file="${test_data_dir}/multi_domains.json"
	270	local server_args="--sessions-filename '$sessions_file'"
	271	local expected_stdout="$test_data_dir/cli-multi-domains.expect"
584af91e PP	272	local expected_stderr
	273
	274	# Empty file for stderr expected
a01934b7	275	expected_stderr="$(mktemp -t test_live_multi_domains_stderr_expected.XXXXXX)"
584af91e PP	276
	277	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
	278
	279	rm -f "$expected_stderr"
	280	}
	281
	282	test_rate_limited() {
	283	# Attach and consume data from a multi packets ust session with no
	284	# discarded events. Enforce a server side limit on the stream data
	285	# requests size. Ensure that babeltrace respect the returned size and that
	286	# many requests per packet works as expected.
	287	# The packet size of the test trace is 4k. Limit requests to 1k.
	288	local test_text="CLI many requests per packet"
	289	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/trace-with-index -c sink.text.details"
2b763e29 JG	290	local sessions_file="$test_data_dir/rate_limited.json"
2b763e29 JG	291	local server_args="--max-query-data-response-size 1024 --sessions-filename '$sessions_file'"
584af91e PP	292	local expected_stdout="${test_data_dir}/cli-base.expect"
	293	local expected_stderr
	294
	295	# Empty file for stderr expected
a01934b7	296	expected_stderr="$(mktemp -t test_live_rate_limited_stderr_expected.XXXXXX)"
584af91e PP	297
	298	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
	299
	300	rm -f "$expected_stderr"
	301	}
	302
	303	test_compare_to_ctf_fs() {
	304	# Compare the details text sink or ctf.fs and ctf.lttng-live to ensure
	305	# that the trace is parsed the same way.
2d2a59db JR	306	# Do the same with the session swapped on the relayd side. This validate
2d2a59db JR	307	# that ordering is consistent between live and ctf fs.
584af91e	308	local test_text="CLI src.ctf.fs vs src.ctf.lttng-live"
2d2a59db	309	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/multi-domains -c sink.text.details --params with-trace-name=false,with-stream-name=false"
2b763e29 JG	310	local sessions_file="$test_data_dir/multi_domains.json"
	311	local sessions_file_inverse="$test_data_dir/multi_domains_inverse.json"
	312	local server_args="--sessions-filename '$sessions_file'"
	313	local server_args_inverse="--sessions-filename '$sessions_file_inverse'"
584af91e PP	314	local expected_stdout
	315	local expected_stderr
	316
a01934b7 SM	317	expected_stdout="$(mktemp -t test_live_compare_stdout_expected.XXXXXX)"
a01934b7 SM	318	expected_stderr="$(mktemp -t test_live_compare_stderr_expected.XXXXXX)"
584af91e	319
2b763e29	320	bt_cli "$expected_stdout" "$expected_stderr" "${trace_dir}/succeed/multi-domains" -c sink.text.details --params "with-trace-name=false,with-stream-name=false"
90a8a0f2 SM	321	bt_remove_cr "${expected_stdout}"
90a8a0f2 SM	322	bt_remove_cr "${expected_stderr}"
584af91e	323	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
2d2a59db JR	324	diag "Inverse session order from lttng-relayd"
2d2a59db JR	325	run_test "$test_text" "$cli_args_template" "$server_args_inverse" "$expected_stdout" "$expected_stderr"
584af91e PP	326
	327	rm -f "$expected_stdout"
	328	rm -f "$expected_stderr"
	329	}
	330
b198ef81 JG	331	test_inactivity_discarded_packet() {
	332	# Attach and consume data from a multi-packet trace with discarded
	333	# packets and emit an inactivity beacon during the discarded packets
	334	# period.
	335	#
	336	# \| pkt seq:0 \|<-------discarded packets------>\| pkt seq:8 \|
	337	# 0 20 121 140
	338	#
	339	# This test was introduced to cover the following bug:
	340	#
	341	# When reading this type of trace locally, the CTF source is expected
	342	# to introduce a "Discarded packets" message between packets 0 and 8.
	343	# The timestamps of this message are [pkt0.end_ts, pkt8.begin_ts].
	344	#
	345	# In the context of a live source, the tracer could report an inactivity
	346	# period during the interval of the "Discarded packets" message.
	347	# Those messages eventually translate into a
	348	# "Iterator inactivity" message with a timestamp set at the end of the
	349	# inactivity period.
	350	#
	351	# If the tracer reports an inactivity period that ends at a point
	352	# between pkt0 and pkt7 (resulting in an "Iterator inactivity" message),
	353	# the live source could send a "Discarded packets" message that starts
	354	# before the preceding "Iterator inactivity" message. This would break
	355	# the monotonicity constraint of the graph.
	356	local test_text="CLI attach and fetch from single-domains session - inactivity discarded packet"
	357	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/7_lost_between_2_with_index -c sink.text.details"
	358	local sessions_file="$test_data_dir/inactivity_discarded_packet.json"
	359	local server_args="--sessions-filename '$sessions_file'"
	360	local expected_stdout="$test_data_dir/inactivity_discarded_packet.expect"
	361	local expected_stderr
	362
	363	# Empty file for stderr expected
	364	expected_stderr="$(mktemp -t test_live_inactivity_discarded_packet_stderr_expected.XXXXXX)"
	365
	366	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
	367
	368	rm -f "$expected_stderr"
	369	}
	370
78169723 FD	371	test_split_metadata() {
	372	# Consume a metadata stream sent in two parts. This testcase tests the
	373	# behaviour of Babeltrace when the tracing session was cleared (lttng
	374	# clear) but the metadata is not yet available to the relay. In such
	375	# cases, when asked for metadata, the relay will return the
	376	# `LTTNG_VIEWER_METADATA_OK` status and a data length of 0. The viewer
	377	# need to consider such case as a request to retry fetching metadata.
	378	#
	379	# This testcase emulates such behaviour by adding empty metadata
	380	# packets.
	381
	382	local test_text="CLI attach and fetch from single-domain session - Receive metadata in two sections separated by a empty section"
	383	local cli_args_template="-i lttng-live net://localhost:@PORT@/host/hostname/split_metadata -c sink.text.details"
	384	local sessions_file="$test_data_dir/split_metadata.json"
	385	local server_args="--sessions-filename '$sessions_file'"
	386	local expected_stdout="${test_data_dir}/split_metadata.expect"
	387	local expected_stderr
	388
	389	# Empty file for stderr expected
	390	expected_stderr="$(mktemp -t test_live_split_metadata_stderr_expected.XXXXXX)"
	391
	392	run_test "$test_text" "$cli_args_template" "$server_args" "$expected_stdout" "$expected_stderr"
	393
	394	rm -f "$expected_stderr"
	395	}
	396
	397	plan_tests 16
584af91e PP	398
	399	test_list_sessions
	400	test_base
	401	test_multi_domains
	402	test_rate_limited
	403	test_compare_to_ctf_fs
b198ef81	404	test_inactivity_discarded_packet
78169723	405	test_split_metadata