Mi test: Refactoring and multiple test suites
[lttng-tools.git] / tests / utils / utils.sh
1 #!/src/bin/bash
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
18 SESSIOND_BIN="lttng-sessiond"
19 CONSUMERD_BIN="lttng-consumerd"
20 RELAYD_BIN="lttng-relayd"
21 LTTNG_BIN="lttng"
22 BABELTRACE_BIN="babeltrace"
23 OUTPUT_DEST=/dev/null 2>&1
24
25 # Minimal kernel version supported for session daemon tests
26 KERNEL_MAJOR_VERSION=2
27 KERNEL_MINOR_VERSION=6
28 KERNEL_PATCHLEVEL_VERSION=27
29
30 source $TESTDIR/utils/tap/tap.sh
31
32 function 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
42 function 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
52 function print_test_banner ()
53 {
54 desc="$1"
55 diag "$desc"
56 }
57
58 function 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
73 # Generate a random string
74 # $1 = number of characters; defaults to 16
75 # $2 = include special characters; 1 = yes, 0 = no; defaults to yes
76 function randstring()
77 {
78 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
79 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
80 echo
81 }
82
83 function lttng_enable_kernel_event
84 {
85 sess_name=$1
86 event_name=$2
87 channel_name=$3
88
89 if [ -z $event_name ]; then
90 # Enable all event if no event name specified
91 event_name="-a"
92 fi
93
94 if [ -z $channel_name ]; then
95 # default channel if none specified
96 chan=""
97 else
98 chan="-c $channel_name"
99 fi
100
101 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -k >$OUTPUT_DEST
102 ok $? "Enable kernel event $event_name for session $sess_name"
103 }
104
105 function start_lttng_relayd
106 {
107 local opt=$1
108
109 DIR=$(readlink -f $TESTDIR)
110
111 if [ -z $(pidof lt-$RELAYD_BIN) ]; then
112 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN -b $opt >$OUTPUT_DEST
113 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
114 if [ $? -eq 1 ]; then
115 fail "Start lttng-relayd (opt: $opt)"
116 return 1
117 else
118 pass "Start lttng-relayd (opt: $opt)"
119 fi
120 else
121 pass "Start lttng-relayd (opt: $opt)"
122 fi
123 }
124
125 function stop_lttng_relayd_nocheck
126 {
127 PID_RELAYD=`pidof lt-$RELAYD_BIN`
128
129 diag "Killing lttng-relayd (pid: $PID_RELAYD)"
130 kill $PID_RELAYD >$OUTPUT_DEST
131 retval=$?
132
133 if [ $retval -eq 1 ]; then
134 out=1
135 while [ -n "$out" ]; do
136 out=$(pidof lt-$RELAYD_BIN)
137 sleep 0.5
138 done
139 fi
140 return $retval
141 }
142
143 function 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)"
152 return 0
153 fi
154 }
155
156 function start_lttng_sessiond()
157 {
158 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
159 # Env variable requested no session daemon
160 return
161 fi
162
163 validate_kernel_version
164 if [ $? -ne 0 ]; then
165 fail "Start session daemon"
166 BAIL_OUT "*** Kernel too old for session daemon tests ***"
167 fi
168
169 DIR=$(readlink -f $TESTDIR)
170 : ${LTTNG_SESSION_CONFIG_XSD_PATH=${DIR}/../src/common/config/}
171 export LTTNG_SESSION_CONFIG_XSD_PATH
172
173 if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
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"
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=$?
177 ok $status "Start session daemon"
178 fi
179 }
180
181 function stop_lttng_sessiond ()
182 {
183 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
184 # Env variable requested no session daemon
185 return
186 fi
187
188 PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
189
190 kill $PID_SESSIOND >$OUTPUT_DEST
191
192 if [ $? -eq 1 ]; then
193 fail "Kill sessions daemon"
194 return 1
195 else
196 out=1
197 while [ -n "$out" ]; do
198 out=$(pidof lt-$SESSIOND_BIN)
199 sleep 0.5
200 done
201 out=1
202 while [ -n "$out" ]; do
203 out=$(pidof $CONSUMERD_BIN)
204 sleep 0.5
205 done
206 pass "Kill session daemon"
207 fi
208 }
209
210 function list_lttng_with_opts ()
211 {
212 opts=$1
213 $TESTDIR/../src/bin/lttng/$LTTNG_BIN list $opts >$OUTPUT_DEST
214 ok $? "Lttng-tool list command with option $opts"
215 }
216
217 function create_lttng_session_no_output ()
218 {
219 sess_name=$1
220
221 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name --no-output >$OUTPUT_DEST
222 ok $? "Create session $sess_name in no-output mode"
223 }
224
225 function create_lttng_session ()
226 {
227 sess_name=$1
228 trace_path=$2
229 expected_to_fail=$3
230
231 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path > $OUTPUT_DEST
232 ret=$?
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
239 else
240 ok $ret "Create session $sess_name in $trace_path"
241 fi
242 }
243
244 function enable_ust_lttng_channel()
245 {
246 sess_name=$1
247 channel_name=$2
248 expect_fail=$3
249
250 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >$OUTPUT_DEST
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
261 }
262
263 function disable_ust_lttng_channel()
264 {
265 sess_name=$1
266 channel_name=$2
267
268 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >$OUTPUT_DEST
269 ok $? "Disable channel $channel_name for session $sess_name"
270 }
271
272 function enable_lttng_mmap_overwrite_kernel_channel()
273 {
274 sess_name=$1
275 channel_name=$2
276
277 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -k --output mmap --overwrite >$OUTPUT_DEST
278 ok $? "Enable channel $channel_name for session $sess_name"
279 }
280
281 function enable_lttng_mmap_overwrite_ust_channel()
282 {
283 sess_name=$1
284 channel_name=$2
285
286 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -s $sess_name $channel_name -u --output mmap --overwrite >$OUTPUT_DEST
287 ok $? "Enable channel $channel_name for session $sess_name"
288 }
289
290 function enable_ust_lttng_event ()
291 {
292 sess_name=$1
293 event_name="$2"
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
302
303 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -u >$OUTPUT_DEST
304 ok $? "Enable event $event_name for session $sess_name"
305 }
306
307 function 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
320 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" $chan -s $sess_name -j >$OUTPUT_DEST
321 ok $? "Enable JUL event $event_name for session $sess_name"
322 }
323
324 function 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
338 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event --loglevel $loglevel "$event_name" $chan -s $sess_name -j >$OUTPUT_DEST
339 ok $? "Enable JUL event $event_name for session $sess_name with loglevel $loglevel"
340 }
341
342 function enable_ust_lttng_event_filter()
343 {
344 sess_name="$1"
345 event_name="$2"
346 filter="$3"
347
348 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >$OUTPUT_DEST
349 ok $? "Enable event $event_name with filtering for session $sess_name"
350 }
351
352 function enable_ust_lttng_event_loglevel()
353 {
354 sess_name="$1"
355 event_name="$2"
356 loglevel="$3"
357
358 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >$OUTPUT_DEST
359 ok $? "Enable event $event_name with loglevel $loglevel"
360 }
361
362 function enable_ust_lttng_event_loglevel_only()
363 {
364 sess_name="$1"
365 event_name="$2"
366 loglevel="$3"
367
368 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >$OUTPUT_DEST
369 ok $? "Enable event $event_name with loglevel-only $loglevel"
370 }
371
372 function disable_ust_lttng_event ()
373 {
374 sess_name="$1"
375 event_name="$2"
376
377 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >$OUTPUT_DEST
378 ok $? "Disable event $event_name for session $sess_name"
379 }
380
381 function 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
390 function start_lttng_tracing ()
391 {
392 sess_name=$1
393
394 $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >$OUTPUT_DEST
395 ok $? "Start tracing for session $sess_name"
396 }
397
398 function stop_lttng_tracing ()
399 {
400 sess_name=$1
401
402 $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >$OUTPUT_DEST
403 ok $? "Stop lttng tracing for session $sess_name"
404 }
405
406 function destroy_lttng_session ()
407 {
408 sess_name=$1
409
410 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >$OUTPUT_DEST
411 ok $? "Destroy lttng session $sess_name"
412 }
413
414 function destroy_lttng_sessions ()
415 {
416 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy --all >$OUTPUT_DEST
417 ok $? "Destroy all lttng sessions"
418 }
419
420 function lttng_snapshot_add_output ()
421 {
422 sess_name=$1
423 trace_path=$2
424
425 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot add-output -s $sess_name file://$trace_path >$OUTPUT_DEST
426 ok $? "Added snapshot output file://$trace_path"
427 }
428
429 function lttng_snapshot_del_output ()
430 {
431 local sess_name=$1
432 local id=$2
433
434 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot del-output -s $sess_name $id >$OUTPUT_DEST
435 ok $? "Deleted snapshot output id $id"
436 }
437
438 function lttng_snapshot_record ()
439 {
440 sess_name=$1
441 trace_path=$2
442
443 $TESTDIR/../src/bin/lttng/$LTTNG_BIN snapshot record -s $sess_name >$OUTPUT_DEST
444 ok $? "Snapshot recorded"
445 }
446
447 function lttng_save()
448 {
449 local sess_name=$1
450 local opts=$2
451
452 $TESTDIR/../src/bin/lttng/$LTTNG_BIN save $sess_name $opts >$OUTPUT_DEST
453 ok $? "Session successfully saved"
454 }
455
456 function lttng_load()
457 {
458 local opts=$1
459
460 $TESTDIR/../src/bin/lttng/$LTTNG_BIN load $opts >$OUTPUT_DEST
461 ok $? "Load command successful"
462 }
463
464 function trace_matches ()
465 {
466 event_name=$1
467 nr_iter=$2
468 trace_path=$3
469
470 which $BABELTRACE_BIN >/dev/null
471 skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
472
473 count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
474
475 if [ "$count" -ne "$nr_iter" ]; then
476 fail "Trace match"
477 diag "$count events found in trace"
478 else
479 pass "Trace match"
480 fi
481 }
482
483 function validate_trace
484 {
485 event_name=$1
486 trace_path=$2
487
488 which $BABELTRACE_BIN >/dev/null
489 if [ $? -ne 0 ]; then
490 skip 0 "Babeltrace binary not found. Skipping trace validation"
491 fi
492
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
498 pass "Validate trace for event $i, $traced events"
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
507 }
This page took 0.061527 seconds and 4 git commands to generate.