[lttng-tools.git] / tests / regression / tools / working-directory / test_relayd_working_directory

#!/bin/bash
#
# Copyright (C) 2018 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
#
# SPDX-License-Identifier: LGPL-2.1-only

TEST_DESC="Change working directory of process"

CURDIR=$(dirname "$0")/
TESTDIR=$CURDIR/../../../

DIR=$(readlink -f "$TESTDIR")

NUM_TESTS=35

source $TESTDIR/utils/utils.sh

#MUST set TESTDIR before calling those functions
plan_tests $NUM_TESTS

print_test_banner "$TEST_DESC"
function test_relayd()
{
	local relayd_bin_path="$DIR/../src/bin/lttng-relayd/$RELAYD_BIN"
	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
	local pid
	local cwd


	diag "Test lttng-relayd normal mode change working directory"

	# There is no rendez-vous mechanism that can guarantee the good timing
	# to check if the workdir directory was changed.
	# In the case of lttng-sessiond this would be achieved using the
	# --sig-parent option but lttng-relayd does not have this feature yet.
	# Fall back on using polling of the value and unblock when the value is
	# the one we expect. In case of a failure the test will hang.
	$relayd_bin_path --working-directory "$working_dir" > /dev/null 2>&1 &
	pid=$!

	while true; do
		cwd=$(readlink "/proc/${pid}/cwd")
		if test "$working_dir" = "$cwd"; then
			# Working dir for process is valid
			break
		fi
		sleep 0.1
	done

	# If we are here the test passed
	pass "Working directory changed"

	stop_lttng_relayd
	rm -rf "$working_dir"
}

function test_relayd_daemon()
{
	local cwd
	local pid
	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")

	diag "Test lttng-relayd daemon mode change working directory"

	start_lttng_relayd_opt 1 "-d" "--working-directory $working_dir"

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	ok $? "Found lttng-relayd"

	cwd=$(readlink "/proc/${pid}/cwd")

	is "$cwd" "$working_dir" "Working directory changed"

	stop_lttng_relayd
	rm -rf "$working_dir"
}

function test_relayd_daemon_no_working_dir()
{
	local expected_working_dir="/"
	local cwd
	local pid

	diag "Test lttng-relayd daemon mode change working directory"

	start_lttng_relayd_opt 1 "-d" ""

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	ok $? "Found lttng-relayd"

	cwd=$(readlink "/proc/${pid}/cwd")

	is "$cwd" "$expected_working_dir" "Working directory is $expected_working_dir"

	stop_lttng_relayd
	rm -rf "$working_dir"
}

function test_relayd_background()
{
	local cwd
	local pid
	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")

	diag "Test lttng-relayd background mode change working directory"

	start_lttng_relayd_opt 1 "-b" "--working-directory $working_dir"

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	ok $? "Found lttng-relayd"

	cwd=$(readlink "/proc/${pid}/cwd")

	is "$cwd" "$working_dir" "Working directory changed"

	stop_lttng_relayd
	rm -rf "$working_dir"
}

function test_relayd_background_no_working_dir()
{
	local expected_working_dir="/"
	local cwd
	local pid

	diag "Test lttng-relayd background working directory"

	start_lttng_relayd_opt 1 "-b" ""

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	ok $? "Found lttng-relayd"

	cwd=$(readlink "/proc/${pid}/cwd")

	is "$cwd" "$expected_working_dir" "Working directory is $expected_working_dir"

	stop_lttng_relayd
	rm -rf "$working_dir"
}

function test_relayd_debug_permission()
{
	local is_user

	diag "Test lttng-relayd change working directory on non writable directory"

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

	skip $is_user "Skipping permission debug output test; operation can't fail as root" 6 ||
	{
		local output_pattern='Working directory \".*\" is not writable'
		local cwd
		local pid
		local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")

		# Removing write access to working dir
		okx chmod -w "$working_dir"

		# Redirect the error output to a temporary file

		ERROR_OUTPUT_DEST=$(mktemp --tmpdir "tmp.${FUNCNAME[0]}_error_output.XXXXXX")
		start_lttng_relayd_opt 1 "-b" "-v --working-dir $working_dir"

		pid=$(lttng_pgrep "$RELAYD_MATCH")
		ok $? "Found lttng-relayd"

		cwd=$(readlink "/proc/${pid}/cwd")
		is "$cwd" "$working_dir" "Working directory changed"

		grep -q "$output_pattern" "$ERROR_OUTPUT_DEST"
		ok $? "Warning about missing write permission is present"

		stop_lttng_relayd
		rm "$ERROR_OUTPUT_DEST"
		rm -rf "$working_dir" "$ERROR_OUTPUT_DEST"
		ERROR_OUTPUT_DEST=/dev/null
	}
}

function test_relayd_failure()
{
	local output_pattern='Failed to change working directory to'
	local relayd_bin_path="$DIR/../src/bin/lttng-relayd/$RELAYD_BIN"
	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
	local output_dest=$(mktemp --tmpdir "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")

	local working_dir_imaginary
	local pid

	working_dir_imaginary="${working_dir}/imaginary_directory"

	diag "Test lttng-relayd normal mode change non-existing directory"

	$relayd_bin_path -b --working-directory "$working_dir_imaginary" > "$output_dest" 2>&1
	test $? -eq "1"
	ok $? "Expect failure to start lttng-relayd for non-existent working directory"

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	if [ -z "$pid" ]; then
		pass "No lttng-relayd present"
	else
		fail "No lttng-relayd present"
		stop_lttng_relayd_notap
	fi

	grep -q "$output_pattern" "$output_dest"
	ok $? "Found error message: invalid directory"

	rm "$output_dest"
	rm -rf "$working_dir"
}

function test_relayd_env()
{
	local cwd
	local pid
	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")

	diag "Test lttng-relayd change working directory from env. variable"

	export LTTNG_RELAYD_WORKING_DIRECTORY=${working_dir}
	start_lttng_relayd_opt 1 "-b" ""

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	ok $? "Found lttng-relayd"

	cwd=$(readlink "/proc/$pid/cwd")

	is "$cwd" "$working_dir" "Working directory changed"

	stop_lttng_relayd
	rm -rf "$working_dir"
	unset LTTNG_RELAYD_WORKING_DIRECTORY
}

function test_relayd_cmdline_overwrite_env()
{
	local cwd
	local pid
	local working_dir_env=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir_even.XXXXXX")")
	local working_dir_cmdline=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir_cmdline.XXXXXX")")

	diag "Test lttng-relayd change working directory command line overwrite env variable"

	export LTTNG_RELAYD_WORKING_DIRECTORY=${working_dir_env}
	start_lttng_relayd_opt 1 "-b" "--working-dir ${working_dir_cmdline}"

	pid=$(lttng_pgrep "$RELAYD_MATCH")
	ok $? "Found lttng-relayd"

	cwd=$(readlink "/proc/$pid/cwd")

	is "$cwd" "$working_dir_cmdline" "Working directory is the one from command line"

	stop_lttng_relayd
	rm -rf "$working_dir_env" "$working_dir_cmdline"
	unset LTTNG_RELAYD_WORKING_DIRECTORY
}

TESTS=(
	test_relayd
	test_relayd_daemon
	test_relayd_daemon_no_working_dir
	test_relayd_background
	test_relayd_background_no_working_dir
	test_relayd_debug_permission
	test_relayd_failure
	test_relayd_env
	test_relayd_cmdline_overwrite_env
)

for fct_test in "${TESTS[@]}";
do
	if ! ${fct_test}; then
		break;
	fi
done
Commit	Line	Data
f3630ec4 JR	1	#!/bin/bash
f3630ec4 JR	2	#
9d16b343	3	# Copyright (C) 2018 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
f3630ec4	4	#
9d16b343	5	# SPDX-License-Identifier: LGPL-2.1-only
f3630ec4 JR	6
	7	TEST_DESC="Change working directory of process"
	8
	9	CURDIR=$(dirname "$0")/
	10	TESTDIR=$CURDIR/../../../
	11
	12	DIR=$(readlink -f "$TESTDIR")
	13
2a10de3b	14	NUM_TESTS=35
f3630ec4 JR	15
	16	source $TESTDIR/utils/utils.sh
	17
f3630ec4 JR	18	#MUST set TESTDIR before calling those functions
	19	plan_tests $NUM_TESTS
	20
	21	print_test_banner "$TEST_DESC"
	22	function test_relayd()
	23	{
	24	local relayd_bin_path="$DIR/../src/bin/lttng-relayd/$RELAYD_BIN"
33e55711	25	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
f3630ec4 JR	26	local pid
	27	local cwd
	28
f3630ec4 JR	29
	30	diag "Test lttng-relayd normal mode change working directory"
	31
	32	# There is no rendez-vous mechanism that can guarantee the good timing
	33	# to check if the workdir directory was changed.
	34	# In the case of lttng-sessiond this would be achieved using the
	35	# --sig-parent option but lttng-relayd does not have this feature yet.
	36	# Fall back on using polling of the value and unblock when the value is
	37	# the one we expect. In case of a failure the test will hang.
	38	$relayd_bin_path --working-directory "$working_dir" > /dev/null 2>&1 &
	39	pid=$!
	40
	41	while true; do
	42	cwd=$(readlink "/proc/${pid}/cwd")
	43	if test "$working_dir" = "$cwd"; then
	44	# Working dir for process is valid
	45	break
	46	fi
	47	sleep 0.1
	48	done
	49
	50	# If we are here the test passed
	51	pass "Working directory changed"
	52
	53	stop_lttng_relayd
	54	rm -rf "$working_dir"
	55	}
	56
	57	function test_relayd_daemon()
	58	{
f3630ec4 JR	59	local cwd
f3630ec4 JR	60	local pid
33e55711	61	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
f3630ec4 JR	62
	63	diag "Test lttng-relayd daemon mode change working directory"
	64
	65	start_lttng_relayd_opt 1 "-d" "--working-directory $working_dir"
	66
7cb78e2f	67	pid=$(lttng_pgrep "$RELAYD_MATCH")
f3630ec4 JR	68	ok $? "Found lttng-relayd"
	69
	70	cwd=$(readlink "/proc/${pid}/cwd")
	71
	72	is "$cwd" "$working_dir" "Working directory changed"
	73
	74	stop_lttng_relayd
	75	rm -rf "$working_dir"
	76	}
	77
	78	function test_relayd_daemon_no_working_dir()
	79	{
	80	local expected_working_dir="/"
	81	local cwd
	82	local pid
	83
	84	diag "Test lttng-relayd daemon mode change working directory"
	85
	86	start_lttng_relayd_opt 1 "-d" ""
	87
7cb78e2f	88	pid=$(lttng_pgrep "$RELAYD_MATCH")
f3630ec4 JR	89	ok $? "Found lttng-relayd"
	90
	91	cwd=$(readlink "/proc/${pid}/cwd")
	92
	93	is "$cwd" "$expected_working_dir" "Working directory is $expected_working_dir"
	94
	95	stop_lttng_relayd
	96	rm -rf "$working_dir"
	97	}
	98
	99	function test_relayd_background()
	100	{
f3630ec4 JR	101	local cwd
f3630ec4 JR	102	local pid
33e55711	103	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
f3630ec4 JR	104
	105	diag "Test lttng-relayd background mode change working directory"
	106
	107	start_lttng_relayd_opt 1 "-b" "--working-directory $working_dir"
	108
7cb78e2f	109	pid=$(lttng_pgrep "$RELAYD_MATCH")
f3630ec4 JR	110	ok $? "Found lttng-relayd"
	111
	112	cwd=$(readlink "/proc/${pid}/cwd")
	113
	114	is "$cwd" "$working_dir" "Working directory changed"
	115
	116	stop_lttng_relayd
	117	rm -rf "$working_dir"
	118	}
	119
	120	function test_relayd_background_no_working_dir()
	121	{
	122	local expected_working_dir="/"
	123	local cwd
	124	local pid
	125
	126	diag "Test lttng-relayd background working directory"
	127
	128	start_lttng_relayd_opt 1 "-b" ""
	129
7cb78e2f	130	pid=$(lttng_pgrep "$RELAYD_MATCH")
f3630ec4 JR	131	ok $? "Found lttng-relayd"
	132
	133	cwd=$(readlink "/proc/${pid}/cwd")
	134
	135	is "$cwd" "$expected_working_dir" "Working directory is $expected_working_dir"
	136
	137	stop_lttng_relayd
	138	rm -rf "$working_dir"
	139	}
	140
	141	function test_relayd_debug_permission()
	142	{
15da468c	143	local is_user
f3630ec4 JR	144
	145	diag "Test lttng-relayd change working directory on non writable directory"
	146
15da468c JG	147	if [ "$(id -u)" == "0" ]; then
	148	is_user=0
	149	else
	150	is_user=1
	151	fi
f3630ec4	152
15da468c JG	153	skip $is_user "Skipping permission debug output test; operation can't fail as root" 6 \|\|
	154	{
	155	local output_pattern='Working directory \".*\" is not writable'
15da468c JG	156	local cwd
15da468c JG	157	local pid
33e55711	158	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
f3630ec4	159
15da468c JG	160	# Removing write access to working dir
15da468c JG	161	okx chmod -w "$working_dir"
f3630ec4	162
15da468c	163	# Redirect the error output to a temporary file
f3630ec4	164
33e55711	165	ERROR_OUTPUT_DEST=$(mktemp --tmpdir "tmp.${FUNCNAME[0]}_error_output.XXXXXX")
e7b7a0e3	166	start_lttng_relayd_opt 1 "-b" "-v --working-dir $working_dir"
15da468c	167
7cb78e2f	168	pid=$(lttng_pgrep "$RELAYD_MATCH")
15da468c JG	169	ok $? "Found lttng-relayd"
	170
	171	cwd=$(readlink "/proc/${pid}/cwd")
	172	is "$cwd" "$working_dir" "Working directory changed"
	173
	174	grep -q "$output_pattern" "$ERROR_OUTPUT_DEST"
	175	ok $? "Warning about missing write permission is present"
	176
	177	stop_lttng_relayd
	178	rm "$ERROR_OUTPUT_DEST"
	179	rm -rf "$working_dir" "$ERROR_OUTPUT_DEST"
	180	ERROR_OUTPUT_DEST=/dev/null
	181	}
f3630ec4 JR	182	}
	183
	184	function test_relayd_failure()
	185	{
	186	local output_pattern='Failed to change working directory to'
	187	local relayd_bin_path="$DIR/../src/bin/lttng-relayd/$RELAYD_BIN"
33e55711 FD	188	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
33e55711 FD	189	local output_dest=$(mktemp --tmpdir "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")
f3630ec4	190
f3630ec4	191	local working_dir_imaginary
f3630ec4 JR	192	local pid
f3630ec4 JR	193
f3630ec4	194	working_dir_imaginary="${working_dir}/imaginary_directory"
f3630ec4 JR	195
	196	diag "Test lttng-relayd normal mode change non-existing directory"
	197
	198	$relayd_bin_path -b --working-directory "$working_dir_imaginary" > "$output_dest" 2>&1
	199	test $? -eq "1"
	200	ok $? "Expect failure to start lttng-relayd for non-existent working directory"
	201
7cb78e2f	202	pid=$(lttng_pgrep "$RELAYD_MATCH")
f3630ec4 JR	203	if [ -z "$pid" ]; then
	204	pass "No lttng-relayd present"
	205	else
	206	fail "No lttng-relayd present"
	207	stop_lttng_relayd_notap
	208	fi
	209
	210	grep -q "$output_pattern" "$output_dest"
	211	ok $? "Found error message: invalid directory"
	212
	213	rm "$output_dest"
	214	rm -rf "$working_dir"
	215	}
	216
2a10de3b JR	217	function test_relayd_env()
2a10de3b JR	218	{
2a10de3b JR	219	local cwd
2a10de3b JR	220	local pid
33e55711	221	local working_dir=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir.XXXXXX")")
2a10de3b JR	222
	223	diag "Test lttng-relayd change working directory from env. variable"
	224
	225	export LTTNG_RELAYD_WORKING_DIRECTORY=${working_dir}
	226	start_lttng_relayd_opt 1 "-b" ""
	227
7cb78e2f	228	pid=$(lttng_pgrep "$RELAYD_MATCH")
2a10de3b JR	229	ok $? "Found lttng-relayd"
	230
	231	cwd=$(readlink "/proc/$pid/cwd")
	232
	233	is "$cwd" "$working_dir" "Working directory changed"
	234
	235	stop_lttng_relayd
	236	rm -rf "$working_dir"
	237	unset LTTNG_RELAYD_WORKING_DIRECTORY
	238	}
	239
	240	function test_relayd_cmdline_overwrite_env()
	241	{
2a10de3b JR	242	local cwd
2a10de3b JR	243	local pid
33e55711 FD	244	local working_dir_env=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir_even.XXXXXX")")
33e55711 FD	245	local working_dir_cmdline=$(realpath "$(mktemp --tmpdir -d "tmp.${FUNCNAME[0]}_working_dir_cmdline.XXXXXX")")
2a10de3b JR	246
	247	diag "Test lttng-relayd change working directory command line overwrite env variable"
	248
	249	export LTTNG_RELAYD_WORKING_DIRECTORY=${working_dir_env}
	250	start_lttng_relayd_opt 1 "-b" "--working-dir ${working_dir_cmdline}"
	251
7cb78e2f	252	pid=$(lttng_pgrep "$RELAYD_MATCH")
2a10de3b JR	253	ok $? "Found lttng-relayd"
	254
	255	cwd=$(readlink "/proc/$pid/cwd")
	256
	257	is "$cwd" "$working_dir_cmdline" "Working directory is the one from command line"
	258
	259	stop_lttng_relayd
	260	rm -rf "$working_dir_env" "$working_dir_cmdline"
	261	unset LTTNG_RELAYD_WORKING_DIRECTORY
	262	}
	263
f3630ec4 JR	264	TESTS=(
	265	test_relayd
	266	test_relayd_daemon
	267	test_relayd_daemon_no_working_dir
	268	test_relayd_background
	269	test_relayd_background_no_working_dir
	270	test_relayd_debug_permission
	271	test_relayd_failure
2a10de3b JR	272	test_relayd_env
2a10de3b JR	273	test_relayd_cmdline_overwrite_env
f3630ec4 JR	274	)
	275
	276	for fct_test in "${TESTS[@]}";
	277	do
	278	if ! ${fct_test}; then
	279	break;
	280	fi
	281	done