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

#!/bin/bash
#
# Copyright (C) - 2018 Jonathan Rajotte <jonathan.rajotte-julien@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="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
	local pid
	local cwd

	working_dir=$(mktemp -d)

	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 working_dir
	local cwd
	local pid

	working_dir=$(mktemp -d)

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

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

	pid=$(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=$(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 working_dir
	local cwd
	local pid

	working_dir=$(mktemp -d)

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

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

	pid=$(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=$(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 output_pattern='Working directory \".*\" is not writable'
	local working_dir
	local cwd
	local pid

	working_dir=$(mktemp -d)

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

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

	# Redirect the error output to a temporary file
	ERROR_OUTPUT_DEST=$(mktemp)
	start_lttng_relayd_opt 1 "-b" "-v --working-dir $working_dir"

	pid=$(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
	local working_dir_imaginary
	local output_dest
	local pid

	working_dir="$(mktemp -d)"
	working_dir_imaginary="${working_dir}/imaginary_directory"
	output_dest=$(mktemp)

	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=$(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 working_dir
	local cwd
	local pid

	working_dir=$(mktemp -d)

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

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

	pid=$(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 working_dir_env
	local working_dir_cmdline
	local cwd
	local pid

	working_dir_env=$(mktemp -d)
	working_dir_cmdline=$(mktemp -d)

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