[lttng-tools.git] / tests / regression / tools / snapshots / test_ust_streaming

#!/bin/bash
#
# Copyright (C) - 2013 David Goulet <dgoulet@efficios.com>
#
# SPDX-License-Identifier: LGPL-2.1-only

TEST_DESC="Streaming - Snapshot UST tracing"

CURDIR=$(dirname $0)/
TESTDIR=$CURDIR/../../..
EVENT_NAME="tp:tptest"
SESSION_NAME=""
CHANNEL_NAME="chan1"
BIN_NAME="gen-nevents"
TESTAPP_PATH="$TESTDIR/utils/testapp"
TESTAPP_NAME="gen-ust-events"
TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
NR_ITER=-1
NR_USEC_WAIT=100
APPS_PID=

TRACE_PATH=$(mktemp --tmpdir -d tmp.test_snapshots_ust_streaming_trace_path.XXXXXX)

NUM_TESTS=85

source $TESTDIR/utils/utils.sh

if [ ! -x "$TESTAPP_BIN" ]; then
	BAIL_OUT "No UST events binary detected."
fi

function snapshot_add_output ()
{
	local sess_name=$1
	local trace_path=$2
	local name=$3
	local extra_opt=""

	if [ ! -z $name ]; then
		extra_opt="-n $name"
	fi

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name $extra_opt $trace_path >/dev/null 2>&1
	ok $? "Added snapshot output $trace_path"
}

# Start trace application and return once one event has been hit.
function start_test_app()
{
	local tmp_file=$(mktemp --tmpdir -u tmp.test_${FUNCNAME[0]}_tmp_file.XXXXXX)

	# Start application with a temporary file.
	$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT --sync-after-first-event $tmp_file &
	ret=$?
	APPS_PID="${APPS_PID} ${!}"
	ok $ret "Start application to trace"

	# Wait for the application file to appear indicating that at least one
	# tracepoint has been fired.
	while [ ! -f "$tmp_file" ]; do
		sleep 0.5
	done
	diag "Removing test app temporary file $tmp_file"
	rm -f $tmp_file
}

function stop_test_apps()
{
	diag "Stopping $TESTAPP_NAME"
	for p in ${APPS_PID}; do
		kill ${p}
		wait ${p} 2>/dev/null
	done
	APPS_PID=
}

# Test a snapshot using a default name for the output destination.
function test_ust_default_name_with_del()
{
	diag "Test UST snapshot streaming with default name with delete output"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME

	start_test_app

	snapshot_add_output $SESSION_NAME "net://localhost"
	lttng_snapshot_record $SESSION_NAME

	# Validate test
	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" 0
	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/snapshot-1*
	if [ $? -ne 0 ]; then
		stop_test_apps
		return $?
	fi

	lttng_snapshot_del_output_ok $SESSION_NAME 1
	snapshot_add_output $SESSION_NAME "net://localhost"
	lttng_snapshot_record $SESSION_NAME

	# Validate test with the next ID since a del output was done prior.
	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-2" 1
	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/snapshot-2*
	if [ $? -ne 0 ]; then
		stop_test_apps
		return $?
	fi

	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	stop_test_apps

	return 0
}

# Test a snapshot using a default name for the output destination.
function test_ust_default_name()
{
	diag "Test UST snapshot streaming with default name"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME

	start_test_app

	snapshot_add_output $SESSION_NAME "net://localhost"
	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
	# Validate test
	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" 0
	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/snapshot-1*
	out=$?

	stop_test_apps

	return $out
}

function test_ust_default_name_custom_uri()
{
	diag "Test UST snapshot streaming with default name with custom URL"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME

	start_test_app

	snapshot_add_output $SESSION_NAME "-C tcp://localhost:5342 -D tcp://localhost:5343"
	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME
	# Validate test
	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" 0
	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/snapshot-1*
	out=$?

	stop_test_apps

	return $out
}

# Test a snapshot using a custom name for the output destination.
function test_ust_custom_name()
{
	local out
	local name="asnapshotname"

	diag "Test UST snapshot streaming with custom name"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	start_lttng_tracing_ok $SESSION_NAME

	start_test_app

	snapshot_add_output $SESSION_NAME "net://localhost" $name
	lttng_snapshot_record $SESSION_NAME
	stop_lttng_tracing_ok $SESSION_NAME
	destroy_lttng_session_ok $SESSION_NAME

	if ls $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/$name* &> /dev/null; then
		ok 0 "Custom name snapshot exists"
		# Validate test
		validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "$name" 0
		validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/$name-*
		out=$?
	else
		fail "No custom name snapshot found"
		out=1
	fi

	stop_test_apps

	return $out
}

function test_ust_n_snapshot()
{
	diag "Test ust snapshot streaming multiple consecutive snapshot"
	create_lttng_session_no_output $SESSION_NAME
	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	snapshot_add_output $SESSION_NAME "net://localhost"
	start_test_app
	for i in {0..4};
	do
		start_lttng_tracing_ok $SESSION_NAME
		lttng_snapshot_record $SESSION_NAME
		stop_lttng_tracing_ok $SESSION_NAME
		validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" $i
		validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME*/snapshot-1*
		if [ $? -ne 0 ]; then
			return 1
		fi
		set -u
		rm -rf $TRACE_PATH/$HOSTNAME
		set +u
	done

	destroy_lttng_session_ok $SESSION_NAME
	stop_test_apps
	return 0
}

plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"

if [ "$(id -u)" == "0" ]; then
	isroot=1
else
	isroot=0
fi

start_lttng_relayd "-o $TRACE_PATH"
start_lttng_sessiond

tests=( test_ust_default_name_with_del
	test_ust_default_name
	test_ust_custom_name
	test_ust_default_name_custom_uri
	test_ust_n_snapshot
)

for fct_test in ${tests[@]};
do
	SESSION_NAME=$(randstring 16 0)
	${fct_test}
	if [ $? -eq 0 ]; then
		# Only delete if successful
		rm -rf $TRACE_PATH
	else
		break
	fi
done

stop_lttng_sessiond
stop_lttng_relayd
Commit	Line	Data
ebaaaf5e JD	1	#!/bin/bash
	2	#
	3	# Copyright (C) - 2013 David Goulet <dgoulet@efficios.com>
	4	#
9d16b343 MJ	5	# SPDX-License-Identifier: LGPL-2.1-only
9d16b343 MJ	6
ebaaaf5e JD	7	TEST_DESC="Streaming - Snapshot UST tracing"
	8
	9	CURDIR=$(dirname $0)/
	10	TESTDIR=$CURDIR/../../..
	11	EVENT_NAME="tp:tptest"
ebaaaf5e JD	12	SESSION_NAME=""
	13	CHANNEL_NAME="chan1"
	14	BIN_NAME="gen-nevents"
	15	TESTAPP_PATH="$TESTDIR/utils/testapp"
	16	TESTAPP_NAME="gen-ust-events"
	17	TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
18c9d47c	18	NR_ITER=-1
ebaaaf5e	19	NR_USEC_WAIT=100
0fc2834c	20	APPS_PID=
ebaaaf5e	21
33e55711	22	TRACE_PATH=$(mktemp --tmpdir -d tmp.test_snapshots_ust_streaming_trace_path.XXXXXX)
ebaaaf5e	23
bd666153	24	NUM_TESTS=85
ebaaaf5e JD	25
	26	source $TESTDIR/utils/utils.sh
	27
	28	if [ ! -x "$TESTAPP_BIN" ]; then
	29	BAIL_OUT "No UST events binary detected."
	30	fi
	31
	32	function snapshot_add_output ()
	33	{
	34	local sess_name=$1
	35	local trace_path=$2
	36	local name=$3
	37	local extra_opt=""
	38
	39	if [ ! -z $name ]; then
	40	extra_opt="-n $name"
	41	fi
	42
	43	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name $extra_opt $trace_path >/dev/null 2>&1
	44	ok $? "Added snapshot output $trace_path"
	45	}
	46
8c93562f	47	# Start trace application and return once one event has been hit.
0fc2834c	48	function start_test_app()
8c93562f	49	{
33e55711	50	local tmp_file=$(mktemp --tmpdir -u tmp.test_${FUNCNAME[0]}_tmp_file.XXXXXX)
8c93562f DG	51
8c93562f DG	52	# Start application with a temporary file.
6c4a91d6	53	$TESTAPP_BIN -i $NR_ITER -w $NR_USEC_WAIT --sync-after-first-event $tmp_file &
0fc2834c MD	54	ret=$?
	55	APPS_PID="${APPS_PID} ${!}"
	56	ok $ret "Start application to trace"
8c93562f DG	57
	58	# Wait for the application file to appear indicating that at least one
	59	# tracepoint has been fired.
	60	while [ ! -f "$tmp_file" ]; do
	61	sleep 0.5
	62	done
	63	diag "Removing test app temporary file $tmp_file"
	64	rm -f $tmp_file
	65	}
	66
0fc2834c	67	function stop_test_apps()
5dca3876	68	{
0fc2834c MD	69	diag "Stopping $TESTAPP_NAME"
	70	for p in ${APPS_PID}; do
	71	kill ${p}
5402fe87	72	wait ${p} 2>/dev/null
0fc2834c	73	done
c7613334	74	APPS_PID=
5dca3876 MD	75	}
5dca3876 MD	76
ebaaaf5e JD	77	# Test a snapshot using a default name for the output destination.
	78	function test_ust_default_name_with_del()
	79	{
	80	diag "Test UST snapshot streaming with default name with delete output"
	81	create_lttng_session_no_output $SESSION_NAME
	82	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	83	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	84	start_lttng_tracing_ok $SESSION_NAME
8c93562f	85
0fc2834c	86	start_test_app
8c93562f	87
ebaaaf5e JD	88	snapshot_add_output $SESSION_NAME "net://localhost"
	89	lttng_snapshot_record $SESSION_NAME
	90
	91	# Validate test
bd666153	92	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" 0
b178f53e	93	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
ebaaaf5e	94	if [ $? -ne 0 ]; then
0fc2834c	95	stop_test_apps
ebaaaf5e JD	96	return $?
	97	fi
	98
31580dc7	99	lttng_snapshot_del_output_ok $SESSION_NAME 1
ebaaaf5e JD	100	snapshot_add_output $SESSION_NAME "net://localhost"
	101	lttng_snapshot_record $SESSION_NAME
	102
	103	# Validate test with the next ID since a del output was done prior.
bd666153	104	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-2" 1
b178f53e	105	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-2
ebaaaf5e	106	if [ $? -ne 0 ]; then
0fc2834c	107	stop_test_apps
ebaaaf5e JD	108	return $?
	109	fi
	110
96340a01	111	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	112	destroy_lttng_session_ok $SESSION_NAME
ebaaaf5e	113
0fc2834c	114	stop_test_apps
ebaaaf5e JD	115
	116	return 0
	117	}
	118
	119	# Test a snapshot using a default name for the output destination.
	120	function test_ust_default_name()
	121	{
	122	diag "Test UST snapshot streaming with default name"
	123	create_lttng_session_no_output $SESSION_NAME
	124	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	125	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	126	start_lttng_tracing_ok $SESSION_NAME
8c93562f	127
0fc2834c	128	start_test_app
8c93562f	129
ebaaaf5e JD	130	snapshot_add_output $SESSION_NAME "net://localhost"
ebaaaf5e JD	131	lttng_snapshot_record $SESSION_NAME
96340a01	132	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	133	destroy_lttng_session_ok $SESSION_NAME
ebaaaf5e	134	# Validate test
bd666153	135	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" 0
b178f53e	136	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
ebaaaf5e JD	137	out=$?
ebaaaf5e JD	138
0fc2834c	139	stop_test_apps
ebaaaf5e JD	140
	141	return $out
	142	}
	143
847b88a9 CB	144	function test_ust_default_name_custom_uri()
	145	{
	146	diag "Test UST snapshot streaming with default name with custom URL"
	147	create_lttng_session_no_output $SESSION_NAME
	148	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	149	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	150	start_lttng_tracing_ok $SESSION_NAME
8c93562f	151
0fc2834c	152	start_test_app
8c93562f	153
847b88a9 CB	154	snapshot_add_output $SESSION_NAME "-C tcp://localhost:5342 -D tcp://localhost:5343"
847b88a9 CB	155	lttng_snapshot_record $SESSION_NAME
96340a01	156	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	157	destroy_lttng_session_ok $SESSION_NAME
847b88a9	158	# Validate test
bd666153	159	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" 0
b178f53e	160	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
847b88a9 CB	161	out=$?
847b88a9 CB	162
0fc2834c	163	stop_test_apps
847b88a9 CB	164
	165	return $out
	166	}
	167
ebaaaf5e JD	168	# Test a snapshot using a custom name for the output destination.
	169	function test_ust_custom_name()
	170	{
	171	local out
	172	local name="asnapshotname"
	173
	174	diag "Test UST snapshot streaming with custom name"
	175	create_lttng_session_no_output $SESSION_NAME
	176	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
c4926bb5	177	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
e563bbdb	178	start_lttng_tracing_ok $SESSION_NAME
8c93562f	179
0fc2834c	180	start_test_app
8c93562f	181
ebaaaf5e JD	182	snapshot_add_output $SESSION_NAME "net://localhost" $name
ebaaaf5e JD	183	lttng_snapshot_record $SESSION_NAME
96340a01	184	stop_lttng_tracing_ok $SESSION_NAME
67b4c664	185	destroy_lttng_session_ok $SESSION_NAME
ebaaaf5e	186
b178f53e	187	if ls $TRACE_PATH/$HOSTNAME/$SESSION_NAME/$name &> /dev/null; then
ebaaaf5e JD	188	ok 0 "Custom name snapshot exists"
ebaaaf5e JD	189	# Validate test
bd666153	190	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "$name" 0
b178f53e	191	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/$name-
ebaaaf5e JD	192	out=$?
	193	else
	194	fail "No custom name snapshot found"
	195	out=1
	196	fi
	197
0fc2834c	198	stop_test_apps
ebaaaf5e JD	199
	200	return $out
	201	}
	202
b61ccd96 JR	203	function test_ust_n_snapshot()
	204	{
	205	diag "Test ust snapshot streaming multiple consecutive snapshot"
	206	create_lttng_session_no_output $SESSION_NAME
	207	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	208	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
bd666153	209	snapshot_add_output $SESSION_NAME "net://localhost"
b61ccd96	210	start_test_app
bd666153	211	for i in {0..4};
b61ccd96 JR	212	do
	213	start_lttng_tracing_ok $SESSION_NAME
	214	lttng_snapshot_record $SESSION_NAME
	215	stop_lttng_tracing_ok $SESSION_NAME
bd666153	216	validate_trace_path_ust_uid_snapshot_network "$TRACE_PATH" "$SESSION_NAME" "snapshot-1" $i
b178f53e	217	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
b61ccd96 JR	218	if [ $? -ne 0 ]; then
	219	return 1
	220	fi
	221	set -u
	222	rm -rf $TRACE_PATH/$HOSTNAME
	223	set +u
	224	done
	225
	226	destroy_lttng_session_ok $SESSION_NAME
	227	stop_test_apps
	228	return 0
	229	}
	230
ebaaaf5e JD	231	plan_tests $NUM_TESTS
	232
	233	print_test_banner "$TEST_DESC"
	234
	235	if [ "$(id -u)" == "0" ]; then
	236	isroot=1
	237	else
	238	isroot=0
	239	fi
	240
	241	start_lttng_relayd "-o $TRACE_PATH"
	242	start_lttng_sessiond
	243
b61ccd96 JR	244	tests=( test_ust_default_name_with_del
	245	test_ust_default_name
	246	test_ust_custom_name
	247	test_ust_default_name_custom_uri
	248	test_ust_n_snapshot
	249	)
ebaaaf5e JD	250
	251	for fct_test in ${tests[@]};
	252	do
	253	SESSION_NAME=$(randstring 16 0)
	254	${fct_test}
	255	if [ $? -eq 0 ]; then
	256	# Only delete if successful
	257	rm -rf $TRACE_PATH
	258	else
	259	break
	260	fi
	261	done
	262
	263	stop_lttng_sessiond
	264	stop_lttng_relayd