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

#!/bin/bash
#
# Copyright (C) - 2013 David Goulet <dgoulet@efficios.com>
#
# This library is free software; you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation; version 2.1 of the License.
#
# This library 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
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 -d)

NUM_TESTS=75

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 -u)

	# Start application with a temporary file.
	$TESTAPP_BIN $NR_ITER $NR_USEC_WAIT $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 $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 $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 $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 $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 $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" $name
	start_test_app
	for i in {1..5};
	do
		start_lttng_tracing_ok $SESSION_NAME
		lttng_snapshot_record $SESSION_NAME
		stop_lttng_tracing_ok $SESSION_NAME
		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
	1	#!/bin/bash
	2	#
	3	# Copyright (C) - 2013 David Goulet <dgoulet@efficios.com>
	4	#
	5	# This library is free software; you can redistribute it and/or modify it under
	6	# the terms of the GNU Lesser General Public License as published by the Free
	7	# Software Foundation; version 2.1 of the License.
	8	#
	9	# This library is distributed in the hope that it will be useful, but WITHOUT
	10	# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
	11	# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
	12	# details.
	13	#
	14	# You should have received a copy of the GNU Lesser General Public License
	15	# along with this library; if not, write to the Free Software Foundation, Inc.,
	16	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	17	TEST_DESC="Streaming - Snapshot UST tracing"
	18
	19	CURDIR=$(dirname $0)/
	20	TESTDIR=$CURDIR/../../..
	21	EVENT_NAME="tp:tptest"
	22	SESSION_NAME=""
	23	CHANNEL_NAME="chan1"
	24	BIN_NAME="gen-nevents"
	25	TESTAPP_PATH="$TESTDIR/utils/testapp"
	26	TESTAPP_NAME="gen-ust-events"
	27	TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
	28	NR_ITER=-1
	29	NR_USEC_WAIT=100
	30	APPS_PID=
	31
	32	TRACE_PATH=$(mktemp -d)
	33
	34	NUM_TESTS=75
	35
	36	source $TESTDIR/utils/utils.sh
	37
	38	if [ ! -x "$TESTAPP_BIN" ]; then
	39	BAIL_OUT "No UST events binary detected."
	40	fi
	41
	42	function snapshot_add_output ()
	43	{
	44	local sess_name=$1
	45	local trace_path=$2
	46	local name=$3
	47	local extra_opt=""
	48
	49	if [ ! -z $name ]; then
	50	extra_opt="-n $name"
	51	fi
	52
	53	$TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name $extra_opt $trace_path >/dev/null 2>&1
	54	ok $? "Added snapshot output $trace_path"
	55	}
	56
	57	# Start trace application and return once one event has been hit.
	58	function start_test_app()
	59	{
	60	local tmp_file=$(mktemp -u)
	61
	62	# Start application with a temporary file.
	63	$TESTAPP_BIN $NR_ITER $NR_USEC_WAIT $tmp_file &
	64	ret=$?
	65	APPS_PID="${APPS_PID} ${!}"
	66	ok $ret "Start application to trace"
	67
	68	# Wait for the application file to appear indicating that at least one
	69	# tracepoint has been fired.
	70	while [ ! -f "$tmp_file" ]; do
	71	sleep 0.5
	72	done
	73	diag "Removing test app temporary file $tmp_file"
	74	rm -f $tmp_file
	75	}
	76
	77	function stop_test_apps()
	78	{
	79	diag "Stopping $TESTAPP_NAME"
	80	for p in ${APPS_PID}; do
	81	kill ${p}
	82	wait ${p} 2>/dev/null
	83	done
	84	APPS_PID=
	85	}
	86
	87	# Test a snapshot using a default name for the output destination.
	88	function test_ust_default_name_with_del()
	89	{
	90	diag "Test UST snapshot streaming with default name with delete output"
	91	create_lttng_session_no_output $SESSION_NAME
	92	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	93	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	94	start_lttng_tracing_ok $SESSION_NAME
	95
	96	start_test_app
	97
	98	snapshot_add_output $SESSION_NAME "net://localhost"
	99	lttng_snapshot_record $SESSION_NAME
	100
	101	# Validate test
	102	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
	103	if [ $? -ne 0 ]; then
	104	stop_test_apps
	105	return $?
	106	fi
	107
	108	lttng_snapshot_del_output_ok $SESSION_NAME 1
	109	snapshot_add_output $SESSION_NAME "net://localhost"
	110	lttng_snapshot_record $SESSION_NAME
	111
	112	# Validate test with the next ID since a del output was done prior.
	113	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-2
	114	if [ $? -ne 0 ]; then
	115	stop_test_apps
	116	return $?
	117	fi
	118
	119	stop_lttng_tracing_ok $SESSION_NAME
	120	destroy_lttng_session_ok $SESSION_NAME
	121
	122	stop_test_apps
	123
	124	return 0
	125	}
	126
	127	# Test a snapshot using a default name for the output destination.
	128	function test_ust_default_name()
	129	{
	130	diag "Test UST snapshot streaming with default name"
	131	create_lttng_session_no_output $SESSION_NAME
	132	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	133	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	134	start_lttng_tracing_ok $SESSION_NAME
	135
	136	start_test_app
	137
	138	snapshot_add_output $SESSION_NAME "net://localhost"
	139	lttng_snapshot_record $SESSION_NAME
	140	stop_lttng_tracing_ok $SESSION_NAME
	141	destroy_lttng_session_ok $SESSION_NAME
	142	# Validate test
	143	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
	144	out=$?
	145
	146	stop_test_apps
	147
	148	return $out
	149	}
	150
	151	function test_ust_default_name_custom_uri()
	152	{
	153	diag "Test UST snapshot streaming with default name with custom URL"
	154	create_lttng_session_no_output $SESSION_NAME
	155	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	156	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	157	start_lttng_tracing_ok $SESSION_NAME
	158
	159	start_test_app
	160
	161	snapshot_add_output $SESSION_NAME "-C tcp://localhost:5342 -D tcp://localhost:5343"
	162	lttng_snapshot_record $SESSION_NAME
	163	stop_lttng_tracing_ok $SESSION_NAME
	164	destroy_lttng_session_ok $SESSION_NAME
	165	# Validate test
	166	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
	167	out=$?
	168
	169	stop_test_apps
	170
	171	return $out
	172	}
	173
	174	# Test a snapshot using a custom name for the output destination.
	175	function test_ust_custom_name()
	176	{
	177	local out
	178	local name="asnapshotname"
	179
	180	diag "Test UST snapshot streaming with custom name"
	181	create_lttng_session_no_output $SESSION_NAME
	182	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	183	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	184	start_lttng_tracing_ok $SESSION_NAME
	185
	186	start_test_app
	187
	188	snapshot_add_output $SESSION_NAME "net://localhost" $name
	189	lttng_snapshot_record $SESSION_NAME
	190	stop_lttng_tracing_ok $SESSION_NAME
	191	destroy_lttng_session_ok $SESSION_NAME
	192
	193	if ls $TRACE_PATH/$HOSTNAME/$SESSION_NAME/$name &> /dev/null; then
	194	ok 0 "Custom name snapshot exists"
	195	# Validate test
	196	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/$name-
	197	out=$?
	198	else
	199	fail "No custom name snapshot found"
	200	out=1
	201	fi
	202
	203	stop_test_apps
	204
	205	return $out
	206	}
	207
	208	function test_ust_n_snapshot()
	209	{
	210	diag "Test ust snapshot streaming multiple consecutive snapshot"
	211	create_lttng_session_no_output $SESSION_NAME
	212	enable_lttng_mmap_overwrite_ust_channel $SESSION_NAME $CHANNEL_NAME
	213	enable_ust_lttng_event_ok $SESSION_NAME $EVENT_NAME $CHANNEL_NAME
	214	snapshot_add_output $SESSION_NAME "net://localhost" $name
	215	start_test_app
	216	for i in {1..5};
	217	do
	218	start_lttng_tracing_ok $SESSION_NAME
	219	lttng_snapshot_record $SESSION_NAME
	220	stop_lttng_tracing_ok $SESSION_NAME
	221	validate_trace $EVENT_NAME $TRACE_PATH/$HOSTNAME/$SESSION_NAME/snapshot-1
	222	if [ $? -ne 0 ]; then
	223	return 1
	224	fi
	225	set -u
	226	rm -rf $TRACE_PATH/$HOSTNAME
	227	set +u
	228	done
	229
	230	destroy_lttng_session_ok $SESSION_NAME
	231	stop_test_apps
	232	return 0
	233	}
	234
	235	plan_tests $NUM_TESTS
	236
	237	print_test_banner "$TEST_DESC"
	238
	239	if [ "$(id -u)" == "0" ]; then
	240	isroot=1
	241	else
	242	isroot=0
	243	fi
	244
	245	start_lttng_relayd "-o $TRACE_PATH"
	246	start_lttng_sessiond
	247
	248	tests=( test_ust_default_name_with_del
	249	test_ust_default_name
	250	test_ust_custom_name
	251	test_ust_default_name_custom_uri
	252	test_ust_n_snapshot
	253	)
	254
	255	for fct_test in ${tests[@]};
	256	do
	257	SESSION_NAME=$(randstring 16 0)
	258	${fct_test}
	259	if [ $? -eq 0 ]; then
	260	# Only delete if successful
	261	rm -rf $TRACE_PATH
	262	else
	263	break
	264	fi
	265	done
	266
	267	stop_lttng_sessiond
	268	stop_lttng_relayd