[lttng-tools.git] / tests / regression / tools / exclusion / test_exclusion

#!/bin/bash
#
# Copyright (C) 2012 Christian Babeux <christian.babeux@efficios.com>
#
# SPDX-License-Identifier: GPL-2.0-only
#

TEST_DESC="Event exclusion"

CURDIR=$(dirname $0)/
TESTDIR=$CURDIR/../../..
STATS_BIN="$TESTDIR/utils/babelstats.pl"
SESSION_NAME="test-exclusion"
TESTAPP_PATH="$TESTDIR/utils/testapp"
TESTAPP_NAME="gen-ust-nevents"
TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
NR_ITER=100
NR_USEC_WAIT=1
NUM_TESTS=178

source $TESTDIR/utils/utils.sh

function enable_ust_lttng_all_event_exclusion()
{
	sess_name="$1"
	exclusion="$2"

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event -u "tp:*" -s $sess_name -x "$exclusion" > /dev/null
}

function run_apps
{
	$TESTAPP_BIN $NR_ITER $NR_USEC_WAIT >/dev/null 2>&1
	ok $? "Running test application"
}

# Testing for the absence of an event when testing exclusion is tricky. An
# event could be absent because our exclusion mechanism works but also because
# the event was not generate in the first place. This function test the ability
# of our test suite to generate events.
function dry_run
{
	trace_path=$(mktemp -d)

	# Create session
	create_lttng_session_ok $SESSION_NAME $trace_path

	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event -u "tp:*" -s $SESSION_NAME > /dev/null
	ok $? "Enabling events without exclusion"

	# Trace apps
	start_lttng_tracing_ok $SESSION_NAME
	run_apps
	stop_lttng_tracing_ok $SESSION_NAME

	nb_events=$(babeltrace $trace_path | wc -l)
	if [ "$nb_events" -ne "0" ]; then
		ok 0 "Events were found during the dry run without exclusion"
	else
		fail "No events were found during the dry run without exclusion"
	fi

	rm -rf $trace_path

	# Destroy session
	destroy_lttng_session_ok $SESSION_NAME
}

function test_exclusion
{
	exclusions="$1"
	event_name_expected_to_be_missing="$2"
	trace_path=$(mktemp -d)

	# Create session
	create_lttng_session_ok $SESSION_NAME $trace_path

	enable_ust_lttng_all_event_exclusion $SESSION_NAME "$exclusions"
	ok $? "Enable lttng event with event \"$exclusions\" excluded"

	# Trace apps
	start_lttng_tracing_ok $SESSION_NAME
	run_apps
	stop_lttng_tracing_ok $SESSION_NAME

	# Destroy session
	destroy_lttng_session_ok $SESSION_NAME

	stats=`babeltrace $trace_path | $STATS_BIN --tracepoint "$event_name_expected_to_be_missing" | grep -v index 2> /dev/null`
	if [ ! -z "$stats" ]; then
		fail "Excluded event \"$event_name_expected_to_be_missing\" was found in trace!"
	else
		ok 0 "Validate trace exclusion output"
		rm -rf $trace_path
	fi
}

function test_exclusion_fail
{
	event_name="$1"
	exclusions="$2"

	create_lttng_session_ok $SESSION_NAME $trace_path
	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event -u "$event_name" -s $sess_name -x "$exclusions" >/dev/null 2>&1
	res=$?
	destroy_lttng_session_ok $SESSION_NAME

	if [ $res -eq 0 ]; then
		fail "Enable LTTng event \"$event_name\" with exclusion \"$exclusions\" passes"
		return 1
	else
		pass "Enable LTTng event \"$event_name\" with exclusion \"$exclusions\" fails"
		return 0
	fi
}

plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"

start_lttng_sessiond

diag "Enable event without exclusion"
dry_run

diag "Enable event with exclusion"
test_exclusion 'tp:tptest2' 'tp:tptest2'
test_exclusion 'tp:tptest3' 'tp:tptest3'
test_exclusion 'tp:tptest*' 'tp:tptest1'
test_exclusion 'tp:tptest*' 'tp:tptest2'
test_exclusion 'tp:tptest*' 'tp:tptest3'
test_exclusion 'tp:tptest*' 'tp:tptest4'
test_exclusion 'tp:tptest*' 'tp:tptest5'
test_exclusion 'tp*tptest*' 'tp:tptest1'
test_exclusion 'tp*tptest*' 'tp:tptest2'
test_exclusion 'tp*tptest*' 'tp:tptest3'
test_exclusion 'tp*tptest*' 'tp:tptest4'
test_exclusion 'tp*tptest*' 'tp:tptest5'
test_exclusion '*test2' 'tp:tptest2'
test_exclusion '*test5' 'tp:tptest5'
test_exclusion '*p*test*' 'tp:tptest1'
test_exclusion '*p*test*' 'tp:tptest2'
test_exclusion '*p*test*' 'tp:tptest3'
test_exclusion '*p***test*' 'tp:tptest4'
test_exclusion '*p*test*' 'tp:tptest5'
test_exclusion '*3' 'tp:tptest3'
test_exclusion 'tp*test3,*2' 'tp:tptest2'
test_exclusion '**tp*test3,*2' 'tp:tptest3'

diag "Cannot use exclusions with non-globbing event name"
test_exclusion_fail "allo" "lol"
test_exclusion_fail "allo" "meow,lol"
test_exclusion_fail "allo" "z*em"

diag "Exclusion name excludes all possible event names"
test_exclusion_fail "allo*" "all*"
test_exclusion_fail "allo*" "ze,all*,yes"

stop_lttng_sessiond
Commit	Line	Data
345121ec DG	1	#!/bin/bash
345121ec DG	2	#
9d16b343	3	# Copyright (C) 2012 Christian Babeux <christian.babeux@efficios.com>
345121ec	4	#
9d16b343	5	# SPDX-License-Identifier: GPL-2.0-only
345121ec	6	#
345121ec DG	7
	8	TEST_DESC="Event exclusion"
	9
	10	CURDIR=$(dirname $0)/
	11	TESTDIR=$CURDIR/../../..
345121ec DG	12	STATS_BIN="$TESTDIR/utils/babelstats.pl"
345121ec DG	13	SESSION_NAME="test-exclusion"
345121ec DG	14	TESTAPP_PATH="$TESTDIR/utils/testapp"
	15	TESTAPP_NAME="gen-ust-nevents"
	16	TESTAPP_BIN="$TESTAPP_PATH/$TESTAPP_NAME/$TESTAPP_NAME"
	17	NR_ITER=100
	18	NR_USEC_WAIT=1
afa7d3f1	19	NUM_TESTS=178
345121ec DG	20
	21	source $TESTDIR/utils/utils.sh
	22
	23	function enable_ust_lttng_all_event_exclusion()
	24	{
	25	sess_name="$1"
	26	exclusion="$2"
	27
a0e115d5	28	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event -u "tp:*" -s $sess_name -x "$exclusion" > /dev/null
345121ec DG	29	}
	30
	31	function run_apps
	32	{
afa7d3f1 FD	33	$TESTAPP_BIN $NR_ITER $NR_USEC_WAIT >/dev/null 2>&1
	34	ok $? "Running test application"
	35	}
	36
	37	# Testing for the absence of an event when testing exclusion is tricky. An
	38	# event could be absent because our exclusion mechanism works but also because
	39	# the event was not generate in the first place. This function test the ability
	40	# of our test suite to generate events.
	41	function dry_run
	42	{
	43	trace_path=$(mktemp -d)
	44
	45	# Create session
	46	create_lttng_session_ok $SESSION_NAME $trace_path
	47
	48	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event -u "tp:*" -s $SESSION_NAME > /dev/null
	49	ok $? "Enabling events without exclusion"
	50
	51	# Trace apps
	52	start_lttng_tracing_ok $SESSION_NAME
	53	run_apps
	54	stop_lttng_tracing_ok $SESSION_NAME
	55
	56	nb_events=$(babeltrace $trace_path \| wc -l)
	57	if [ "$nb_events" -ne "0" ]; then
	58	ok 0 "Events were found during the dry run without exclusion"
	59	else
	60	fail "No events were found during the dry run without exclusion"
	61	fi
	62
	63	rm -rf $trace_path
	64
	65	# Destroy session
	66	destroy_lttng_session_ok $SESSION_NAME
345121ec DG	67	}
	68
	69	function test_exclusion
	70	{
062f6132 PP	71	exclusions="$1"
062f6132 PP	72	event_name_expected_to_be_missing="$2"
345121ec DG	73	trace_path=$(mktemp -d)
	74
	75	# Create session
bf6ae429	76	create_lttng_session_ok $SESSION_NAME $trace_path
345121ec	77
062f6132 PP	78	enable_ust_lttng_all_event_exclusion $SESSION_NAME "$exclusions"
062f6132 PP	79	ok $? "Enable lttng event with event \"$exclusions\" excluded"
345121ec DG	80
345121ec DG	81	# Trace apps
e563bbdb	82	start_lttng_tracing_ok $SESSION_NAME
345121ec	83	run_apps
96340a01	84	stop_lttng_tracing_ok $SESSION_NAME
345121ec DG	85
345121ec DG	86	# Destroy session
67b4c664	87	destroy_lttng_session_ok $SESSION_NAME
345121ec	88
afa7d3f1	89	stats=`babeltrace $trace_path \| $STATS_BIN --tracepoint "$event_name_expected_to_be_missing" \| grep -v index 2> /dev/null`
345121ec	90	if [ ! -z "$stats" ]; then
062f6132	91	fail "Excluded event \"$event_name_expected_to_be_missing\" was found in trace!"
345121ec DG	92	else
	93	ok 0 "Validate trace exclusion output"
	94	rm -rf $trace_path
	95	fi
	96	}
	97
062f6132 PP	98	function test_exclusion_fail
	99	{
	100	event_name="$1"
	101	exclusions="$2"
	102
	103	create_lttng_session_ok $SESSION_NAME $trace_path
6efba076	104	$TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event -u "$event_name" -s $sess_name -x "$exclusions" >/dev/null 2>&1
062f6132 PP	105	res=$?
	106	destroy_lttng_session_ok $SESSION_NAME
	107
	108	if [ $res -eq 0 ]; then
	109	fail "Enable LTTng event \"$event_name\" with exclusion \"$exclusions\" passes"
	110	return 1
	111	else
	112	pass "Enable LTTng event \"$event_name\" with exclusion \"$exclusions\" fails"
	113	return 0
	114	fi
	115	}
	116
345121ec DG	117	plan_tests $NUM_TESTS
345121ec DG	118
a0e115d5	119	print_test_banner "$TEST_DESC"
345121ec DG	120
	121	start_lttng_sessiond
	122
a0e115d5	123	diag "Enable event without exclusion"
afa7d3f1 FD	124	dry_run
afa7d3f1 FD	125
a0e115d5	126	diag "Enable event with exclusion"
062f6132 PP	127	test_exclusion 'tp:tptest2' 'tp:tptest2'
	128	test_exclusion 'tp:tptest3' 'tp:tptest3'
	129	test_exclusion 'tp:tptest*' 'tp:tptest1'
	130	test_exclusion 'tp:tptest*' 'tp:tptest2'
	131	test_exclusion 'tp:tptest*' 'tp:tptest3'
	132	test_exclusion 'tp:tptest*' 'tp:tptest4'
	133	test_exclusion 'tp:tptest*' 'tp:tptest5'
	134	test_exclusion 'tptptest' 'tp:tptest1'
	135	test_exclusion 'tptptest' 'tp:tptest2'
	136	test_exclusion 'tptptest' 'tp:tptest3'
	137	test_exclusion 'tptptest' 'tp:tptest4'
	138	test_exclusion 'tptptest' 'tp:tptest5'
	139	test_exclusion '*test2' 'tp:tptest2'
	140	test_exclusion '*test5' 'tp:tptest5'
	141	test_exclusion 'ptest*' 'tp:tptest1'
	142	test_exclusion 'ptest*' 'tp:tptest2'
	143	test_exclusion 'ptest*' 'tp:tptest3'
	144	test_exclusion 'p*test' 'tp:tptest4'
	145	test_exclusion 'ptest*' 'tp:tptest5'
	146	test_exclusion '*3' 'tp:tptest3'
	147	test_exclusion 'tptest3,2' 'tp:tptest2'
	148	test_exclusion '*tptest3,*2' 'tp:tptest3'
	149
a0e115d5	150	diag "Cannot use exclusions with non-globbing event name"
062f6132 PP	151	test_exclusion_fail "allo" "lol"
	152	test_exclusion_fail "allo" "meow,lol"
	153	test_exclusion_fail "allo" "z*em"
	154
a0e115d5	155	diag "Exclusion name excludes all possible event names"
062f6132 PP	156	test_exclusion_fail "allo" "all"
062f6132 PP	157	test_exclusion_fail "allo" "ze,all,yes"
345121ec DG	158
345121ec DG	159	stop_lttng_sessiond