Mi test: Refactoring and multiple test suites
[lttng-tools.git] / tests / utils / utils.sh
CommitLineData
10a8a223 1#!/src/bin/bash
d3e8f6bb
DG
2#
3# Copyright (C) - 2012 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
18SESSIOND_BIN="lttng-sessiond"
f7613992 19CONSUMERD_BIN="lttng-consumerd"
f4e40ab6 20RELAYD_BIN="lttng-relayd"
d3e8f6bb
DG
21LTTNG_BIN="lttng"
22BABELTRACE_BIN="babeltrace"
873c2aae 23OUTPUT_DEST=/dev/null 2>&1
d3e8f6bb 24
fd4dfcec
DG
25# Minimal kernel version supported for session daemon tests
26KERNEL_MAJOR_VERSION=2
27KERNEL_MINOR_VERSION=6
28KERNEL_PATCHLEVEL_VERSION=27
29
29655db7
CB
30source $TESTDIR/utils/tap/tap.sh
31
fec81a7e
CB
32function print_ok ()
33{
34 # Check if we are a terminal
35 if [ -t 1 ]; then
36 echo -e "\e[1;32mOK\e[0m"
37 else
38 echo -e "OK"
39 fi
40}
41
42function print_fail ()
43{
44 # Check if we are a terminal
45 if [ -t 1 ]; then
46 echo -e "\e[1;31mFAIL\e[0m"
47 else
48 echo -e "FAIL"
49 fi
50}
51
52function print_test_banner ()
53{
54 desc="$1"
29655db7 55 diag "$desc"
fec81a7e
CB
56}
57
fd4dfcec
DG
58function validate_kernel_version ()
59{
60 kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
61 if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
62 return 0
63 fi
64 if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
65 return 0
66 fi
67 if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
68 return 0
69 fi
70 return 1
71}
72
9ac429ef 73# Generate a random string
f4e40ab6
DG
74# $1 = number of characters; defaults to 16
75# $2 = include special characters; 1 = yes, 0 = no; defaults to yes
9ac429ef 76function randstring()
f4e40ab6
DG
77{
78 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
79 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
80 echo
81}
82
f4e40ab6
DG
83function lttng_enable_kernel_event
84{
85 sess_name=$1
86 event_name=$2
07b86b52 87 channel_name=$3
f4e40ab6
DG
88
89 if [ -z $event_name ]; then
90 # Enable all event if no event name specified
29655db7 91 event_name="-a"
f4e40ab6
DG
92 fi
93
07b86b52
JD
94 if [ -z $channel_name ]; then
95 # default channel if none specified
96 chan=""
97 else
98 chan="-c $channel_name"
99 fi
100
873c2aae 101 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k >$OUTPUT_DEST
29655db7 102 ok $? "Enable kernel event $event_name for session $sess_name"
f4e40ab6
DG
103}
104
fb3268e3 105function start_lttng_relayd
f4e40ab6 106{
198e7caf 107 local opt=$1
173af62f 108
f4e40ab6
DG
109 DIR=$(readlink -f $TESTDIR)
110
111 if [ -z $(pidof lt-$RELAYD_BIN) ]; then
873c2aae 112 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt >$OUTPUT_DEST
25a818af 113 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
f4e40ab6 114 if [ $? -eq 1 ]; then
29655db7 115 fail "Start lttng-relayd (opt: $opt)"
f4e40ab6
DG
116 return 1
117 else
29655db7 118 pass "Start lttng-relayd (opt: $opt)"
f4e40ab6
DG
119 fi
120 else
29655db7 121 pass "Start lttng-relayd (opt: $opt)"
f4e40ab6
DG
122 fi
123}
124
1fb23888 125function stop_lttng_relayd_nocheck
f4e40ab6
DG
126{
127 PID_RELAYD=`pidof lt-$RELAYD_BIN`
128
1fb23888 129 diag "Killing lttng-relayd (pid: $PID_RELAYD)"
873c2aae 130 kill $PID_RELAYD >$OUTPUT_DEST
1fb23888 131 retval=$?
29655db7 132
1fb23888 133 if [ $retval -eq 1 ]; then
f4e40ab6
DG
134 out=1
135 while [ -n "$out" ]; do
136 out=$(pidof lt-$RELAYD_BIN)
137 sleep 0.5
138 done
1fb23888
MD
139 fi
140 return $retval
141}
142
143function stop_lttng_relayd
144{
145 stop_lttng_relayd_nocheck
146
147 if [ $? -eq 1 ]; then
148 fail "Killed lttng-relayd (pid: $PID_RELAYD)"
149 return 1
150 else
151 pass "Killed lttng-relayd (pid: $PID_RELAYD)"
f4e40ab6
DG
152 return 0
153 fi
154}
155
fb3268e3 156function start_lttng_sessiond()
355f483d
DG
157{
158 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
159 # Env variable requested no session daemon
160 return
161 fi
162
29655db7
CB
163 validate_kernel_version
164 if [ $? -ne 0 ]; then
165 fail "Start session daemon"
166 BAIL_OUT "*** Kernel too old for session daemon tests ***"
355f483d
DG
167 fi
168
29655db7 169 DIR=$(readlink -f $TESTDIR)
d3d97763
JG
170 : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
171 export LTTNG_SESSION_CONFIG_XSD_PATH
29655db7
CB
172
173 if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
d7b63d8c 174 $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --background --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
29655db7
CB
175 #$DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --verbose-consumer >>/tmp/sessiond.log 2>&1 &
176 status=$?
29655db7
CB
177 ok $status "Start session daemon"
178 fi
355f483d
DG
179}
180
fb3268e3 181function stop_lttng_sessiond ()
d3e8f6bb 182{
355f483d
DG
183 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
184 # Env variable requested no session daemon
185 return
186 fi
187
d3e8f6bb
DG
188 PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
189
873c2aae 190 kill $PID_SESSIOND >$OUTPUT_DEST
29655db7 191
d3e8f6bb 192 if [ $? -eq 1 ]; then
29655db7 193 fail "Kill sessions daemon"
d3e8f6bb
DG
194 return 1
195 else
5fa32580
DG
196 out=1
197 while [ -n "$out" ]; do
198 out=$(pidof lt-$SESSIOND_BIN)
199 sleep 0.5
200 done
f7613992
MD
201 out=1
202 while [ -n "$out" ]; do
203 out=$(pidof $CONSUMERD_BIN)
204 sleep 0.5
205 done
29655db7 206 pass "Kill session daemon"
d3e8f6bb
DG
207 fi
208}
209
873c2aae
JRJ
210function list_lttng_with_opts ()
211{
212 opts=$1
312dabc3 213 $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts >$OUTPUT_DEST
873c2aae
JRJ
214 ok $? "Lttng-tool list command with option $opts"
215}
216
07b86b52
JD
217function create_lttng_session_no_output ()
218{
219 sess_name=$1
220
873c2aae 221 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >$OUTPUT_DEST
07b86b52
JD
222 ok $? "Create session $sess_name in no-output mode"
223}
224
d3e8f6bb
DG
225function create_lttng_session ()
226{
227 sess_name=$1
228 trace_path=$2
873c2aae 229 expected_to_fail=$3
d3e8f6bb 230
873c2aae
JRJ
231 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path > $OUTPUT_DEST
232 ret=$?
312dabc3
JRJ
233 if [[ $expected_to_fail ]]; then
234 if [[ $ret ]]; then
235 pass "Expected fail on session creation $sess_name in $trace_path"
236 else
237 fail "Session $sess_name creation in $trace_path was expected to fail"
238 fi
873c2aae
JRJ
239 else
240 ok $ret "Create session $sess_name in $trace_path"
241 fi
d4018451
DG
242}
243
29655db7 244function enable_ust_lttng_channel()
d4018451
DG
245{
246 sess_name=$1
247 channel_name=$2
312dabc3 248 expect_fail=$3
d4018451 249
873c2aae 250 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >$OUTPUT_DEST
312dabc3
JRJ
251 ret=$?
252 if [[ $expect_fail ]]; then
253 if [[ $ret ]]; then
254 pass "Enable channel $channel_name for session $sess_name expected fail"
255 else
256 fail "Enable channel $channel_name for session $sess_name did not fail as expected"
257 fi
258 else
259 ok $ret "Enable channel $channel_name for session $sess_name"
260 fi
d4018451
DG
261}
262
29655db7 263function disable_ust_lttng_channel()
d4018451
DG
264{
265 sess_name=$1
266 channel_name=$2
267
873c2aae 268 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >$OUTPUT_DEST
29655db7 269 ok $? "Disable channel $channel_name for session $sess_name"
d3e8f6bb
DG
270}
271
07b86b52
JD
272function enable_lttng_mmap_overwrite_kernel_channel()
273{
274 sess_name=$1
275 channel_name=$2
276
873c2aae 277 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >$OUTPUT_DEST
07b86b52
JD
278 ok $? "Enable channel $channel_name for session $sess_name"
279}
280
ebaaaf5e
JD
281function enable_lttng_mmap_overwrite_ust_channel()
282{
283 sess_name=$1
284 channel_name=$2
285
873c2aae 286 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite >$OUTPUT_DEST
ebaaaf5e
JD
287 ok $? "Enable channel $channel_name for session $sess_name"
288}
289
d3e8f6bb
DG
290function enable_ust_lttng_event ()
291{
292 sess_name=$1
26b53d3b 293 event_name="$2"
ebaaaf5e
JD
294 channel_name=$3
295
296 if [ -z $channel_name ]; then
297 # default channel if none specified
298 chan=""
299 else
300 chan="-c $channel_name"
301 fi
d3e8f6bb 302
873c2aae 303 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u >$OUTPUT_DEST
29655db7 304 ok $? "Enable event $event_name for session $sess_name"
26b53d3b
DG
305}
306
37175ce4
DG
307function enable_jul_lttng_event()
308{
309 sess_name=$1
310 event_name="$2"
311 channel_name=$3
312
313 if [ -z $channel_name ]; then
314 # default channel if none specified
315 chan=""
316 else
317 chan="-c $channel_name"
318 fi
319
873c2aae 320 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j >$OUTPUT_DEST
37175ce4
DG
321 ok $? "Enable JUL event $event_name for session $sess_name"
322}
323
b2064f54
DG
324function enable_jul_lttng_event_loglevel()
325{
326 sess_name=$1
327 event_name="$2"
328 loglevel=$3
329 channel_name=$4
330
331 if [ -z $channel_name ]; then
332 # default channel if none specified
333 chan=""
334 else
335 chan="-c $channel_name"
336 fi
337
873c2aae 338 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j >$OUTPUT_DEST
b2064f54
DG
339 ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
340}
341
26b53d3b
DG
342function enable_ust_lttng_event_filter()
343{
344 sess_name="$1"
345 event_name="$2"
346 filter="$3"
26b53d3b 347
873c2aae 348 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >$OUTPUT_DEST
29655db7 349 ok $? "Enable event $event_name with filtering for session $sess_name"
26b53d3b
DG
350}
351
352function enable_ust_lttng_event_loglevel()
353{
354 sess_name="$1"
355 event_name="$2"
356 loglevel="$3"
26b53d3b 357
873c2aae 358 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >$OUTPUT_DEST
29655db7 359 ok $? "Enable event $event_name with loglevel $loglevel"
26b53d3b
DG
360}
361
362function enable_ust_lttng_event_loglevel_only()
363{
364 sess_name="$1"
365 event_name="$2"
366 loglevel="$3"
26b53d3b 367
873c2aae 368 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >$OUTPUT_DEST
29655db7 369 ok $? "Enable event $event_name with loglevel-only $loglevel"
26b53d3b
DG
370}
371
372function disable_ust_lttng_event ()
373{
907b42de
DG
374 sess_name="$1"
375 event_name="$2"
26b53d3b 376
873c2aae 377 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >$OUTPUT_DEST
29655db7 378 ok $? "Disable event $event_name for session $sess_name"
d3e8f6bb
DG
379}
380
1d842d5a
DG
381function disable_jul_lttng_event ()
382{
383 local sess_name="$1"
384 local event_name="$2"
385
386 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -j >/dev/null 2>&1
387 ok $? "Disable JUL event $event_name for session $sess_name"
388}
389
fb3268e3 390function start_lttng_tracing ()
d3e8f6bb
DG
391{
392 sess_name=$1
393
873c2aae 394 $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >$OUTPUT_DEST
29655db7 395 ok $? "Start tracing for session $sess_name"
d3e8f6bb
DG
396}
397
fb3268e3 398function stop_lttng_tracing ()
d3e8f6bb
DG
399{
400 sess_name=$1
401
873c2aae 402 $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >$OUTPUT_DEST
29655db7 403 ok $? "Stop lttng tracing for session $sess_name"
d3e8f6bb
DG
404}
405
406function destroy_lttng_session ()
407{
408 sess_name=$1
409
873c2aae 410 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >$OUTPUT_DEST
29655db7 411 ok $? "Destroy lttng session $sess_name"
d3e8f6bb
DG
412}
413
873c2aae
JRJ
414function destroy_lttng_sessions ()
415{
416 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all >$OUTPUT_DEST
417 ok $? "Destroy all lttng sessions"
418}
419
07b86b52
JD
420function lttng_snapshot_add_output ()
421{
422 sess_name=$1
423 trace_path=$2
424
873c2aae 425 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >$OUTPUT_DEST
07b86b52
JD
426 ok $? "Added snapshot output file://$trace_path"
427}
428
26402e0c
DG
429function lttng_snapshot_del_output ()
430{
431 local sess_name=$1
432 local id=$2
433
873c2aae 434 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >$OUTPUT_DEST
26402e0c
DG
435 ok $? "Deleted snapshot output id $id"
436}
437
07b86b52
JD
438function lttng_snapshot_record ()
439{
440 sess_name=$1
441 trace_path=$2
442
873c2aae 443 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >$OUTPUT_DEST
07b86b52
JD
444 ok $? "Snapshot recorded"
445}
446
e02b109b
DG
447function lttng_save()
448{
449 local sess_name=$1
450 local opts=$2
451
873c2aae 452 $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts >$OUTPUT_DEST
e02b109b
DG
453 ok $? "Session successfully saved"
454}
455
456function lttng_load()
457{
458 local opts=$1
459
873c2aae 460 $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts >$OUTPUT_DEST
e02b109b
DG
461 ok $? "Load command successful"
462}
463
d3e8f6bb
DG
464function trace_matches ()
465{
466 event_name=$1
467 nr_iter=$2
468 trace_path=$3
469
317eef93 470 which $BABELTRACE_BIN >/dev/null
29655db7 471 skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
d3e8f6bb
DG
472
473 count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
29655db7 474
d3e8f6bb 475 if [ "$count" -ne "$nr_iter" ]; then
29655db7
CB
476 fail "Trace match"
477 diag "$count events found in trace"
d3e8f6bb 478 else
29655db7 479 pass "Trace match"
d3e8f6bb
DG
480 fi
481}
f4e40ab6
DG
482
483function validate_trace
484{
485 event_name=$1
486 trace_path=$2
487
488 which $BABELTRACE_BIN >/dev/null
29655db7
CB
489 if [ $? -ne 0 ]; then
490 skip 0 "Babeltrace binary not found. Skipping trace validation"
f4e40ab6
DG
491 fi
492
07b86b52
JD
493 OLDIFS=$IFS
494 IFS=","
495 for i in $event_name; do
496 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $i | wc -l)
497 if [ "$traced" -ne 0 ]; then
ebaaaf5e 498 pass "Validate trace for event $i, $traced events"
07b86b52
JD
499 else
500 fail "Validate trace for event $i"
501 diag "Found $traced occurences of $i"
502 fi
503 done
504 ret=$?
505 IFS=$OLDIFS
506 return $ret
f4e40ab6 507}
This page took 0.088446 seconds and 4 git commands to generate.