Tests: Add helper functions for printing status and banner
[lttng-tools.git] / tests / 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"
f4e40ab6 19RELAYD_BIN="lttng-relayd"
d3e8f6bb
DG
20LTTNG_BIN="lttng"
21BABELTRACE_BIN="babeltrace"
22
fd4dfcec
DG
23# Minimal kernel version supported for session daemon tests
24KERNEL_MAJOR_VERSION=2
25KERNEL_MINOR_VERSION=6
26KERNEL_PATCHLEVEL_VERSION=27
27
fec81a7e
CB
28function print_ok ()
29{
30 # Check if we are a terminal
31 if [ -t 1 ]; then
32 echo -e "\e[1;32mOK\e[0m"
33 else
34 echo -e "OK"
35 fi
36}
37
38function print_fail ()
39{
40 # Check if we are a terminal
41 if [ -t 1 ]; then
42 echo -e "\e[1;31mFAIL\e[0m"
43 else
44 echo -e "FAIL"
45 fi
46}
47
48function print_test_banner ()
49{
50 desc="$1"
51
52 count=$((${#desc}+2))
53 str=$(printf "%${count}s");
54 echo -e "\n"
55 echo -e ${str// /-}
56 echo -e " $desc "
57 echo -e ${str// /-}
58}
59
fd4dfcec
DG
60function validate_kernel_version ()
61{
62 kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
63 if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
64 return 0
65 fi
66 if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
67 return 0
68 fi
69 if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
70 return 0
71 fi
72 return 1
73}
74
f4e40ab6
DG
75# Generate a random string
76# $1 = number of characters; defaults to 16
77# $2 = include special characters; 1 = yes, 0 = no; defaults to yes
78function randstring()
79{
80 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
81 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
82 echo
83}
84
355f483d 85function spawn_sessiond ()
d3e8f6bb 86{
317eef93
DG
87 echo ""
88 echo -n "Starting session daemon... "
fd4dfcec
DG
89 validate_kernel_version
90 if [ $? -ne 0 ]; then
fbb28ea9 91 echo -e "\n*** Kernel too old for session daemon tests ***\n"
fd4dfcec
DG
92 return 2
93 fi
94
2e6a03f6 95 DIR=$(readlink -f $TESTDIR)
355f483d 96
317eef93 97 if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
355f483d 98 $DIR/../src/bin/lttng-sessiond/$SESSIOND_BIN --daemonize --quiet --consumerd32-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd" --consumerd64-path="$DIR/../src/bin/lttng-consumerd/lttng-consumerd"
25a818af 99 #$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 &
d3e8f6bb
DG
100 if [ $? -eq 1 ]; then
101 echo -e "\e[1;31mFAILED\e[0m"
102 return 1
103 else
104 echo -e "\e[1;32mOK\e[0m"
105 fi
106 fi
fd4dfcec
DG
107
108 return 0
d3e8f6bb
DG
109}
110
f4e40ab6
DG
111function lttng_enable_kernel_event
112{
113 sess_name=$1
114 event_name=$2
115
116 if [ -z $event_name ]; then
117 # Enable all event if no event name specified
118 $event_name="-a"
119 fi
120
121 echo -n "Enabling kernel event $event_name for session $sess_name"
122 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event $event_name -s $sess_name -k >/dev/null 2>&1
123 if [ $? -eq 1 ]; then
124 echo -e '\e[1;31mFAILED\e[0m'
125 return 1
126 else
127 echo -e "\e[1;32mOK\e[0m"
128 fi
129}
130
131function lttng_start_relayd
132{
173af62f
DG
133 local opt="$1"
134
135 echo -e -n "Starting lttng-relayd (opt: $opt)... "
136
f4e40ab6
DG
137 DIR=$(readlink -f $TESTDIR)
138
139 if [ -z $(pidof lt-$RELAYD_BIN) ]; then
173af62f 140 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt >/dev/null 2>&1 &
25a818af 141 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
f4e40ab6
DG
142 if [ $? -eq 1 ]; then
143 echo -e "\e[1;31mFAILED\e[0m"
144 return 1
145 else
146 echo -e "\e[1;32mOK\e[0m"
147 fi
148 else
149 echo -e "\e[1;32mOK\e[0m"
150 fi
151}
152
153function lttng_stop_relayd
154{
155 PID_RELAYD=`pidof lt-$RELAYD_BIN`
156
157 echo -e -n "Killing lttng-relayd (pid: $PID_RELAYD)... "
158 kill $PID_RELAYD >/dev/null 2>&1
159 if [ $? -eq 1 ]; then
160 echo -e "\e[1;31mFAILED\e[0m"
161 return 1
162 else
163 out=1
164 while [ -n "$out" ]; do
165 out=$(pidof lt-$RELAYD_BIN)
166 sleep 0.5
167 done
168 echo -e "\e[1;32mOK\e[0m"
169 return 0
170 fi
171}
172
355f483d
DG
173function start_sessiond()
174{
175 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
176 # Env variable requested no session daemon
177 return
178 fi
179
180 spawn_sessiond
181 out=$?
182 if [ $out -eq 2 ]; then
183 # Kernel version is not compatible.
184 exit 0
185 elif [ $out -ne 0 ]; then
186 echo "NOT bad $?"
187 exit 1
188 fi
189
190 # Simply wait for the session daemon bootstrap
191 echo "Waiting for the session daemon to bootstrap (2 secs)"
192 sleep 2
193}
194
d3e8f6bb
DG
195function stop_sessiond ()
196{
355f483d
DG
197 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
198 # Env variable requested no session daemon
199 return
200 fi
201
d3e8f6bb
DG
202 PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
203
204 echo -e -n "Killing session daemon... "
205 kill $PID_SESSIOND >/dev/null 2>&1
206 if [ $? -eq 1 ]; then
207 echo -e "\e[1;31mFAILED\e[0m"
208 return 1
209 else
5fa32580
DG
210 out=1
211 while [ -n "$out" ]; do
212 out=$(pidof lt-$SESSIOND_BIN)
213 sleep 0.5
214 done
d3e8f6bb
DG
215 echo -e "\e[1;32mOK\e[0m"
216 fi
217}
218
219function create_lttng_session ()
220{
221 sess_name=$1
222 trace_path=$2
223
908ee7bd 224 echo -n "Creating lttng session $sess_name in $trace_path "
10a8a223 225 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
d3e8f6bb
DG
226 if [ $? -eq 1 ]; then
227 echo -e "\e[1;31mFAILED\e[0m"
228 return 1
229 else
230 echo -e "\e[1;32mOK\e[0m"
d4018451
DG
231 fi
232}
233
234function enable_lttng_channel()
235{
236 sess_name=$1
237 channel_name=$2
238
239 echo -n "Enabling lttng channel $channel_name for session $sess_name"
240 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel $channel_name -s $sess_name >/dev/null 2>&1
241 if [ $? -eq 1 ]; then
242 echo -e "\e[1;31mFAILED\e[0m"
243 return 1
244 else
245 echo -e "\e[1;32mOK\e[0m"
246 fi
247}
248
249function disable_lttng_channel()
250{
251 sess_name=$1
252 channel_name=$2
253
254 echo -n "Disabling lttng channel $channel_name for session $sess_name"
255 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel $channel_name -s $sess_name >/dev/null 2>&1
256 if [ $? -eq 1 ]; then
257 echo -e "\e[1;31mFAILED\e[0m"
258 return 1
259 else
260 echo -e "\e[1;32mOK\e[0m"
d3e8f6bb
DG
261 fi
262}
263
264function enable_ust_lttng_event ()
265{
266 sess_name=$1
267 event_name=$2
268
269 echo -n "Enabling lttng event $event_name for session $sess_name "
10a8a223 270 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event $event_name -s $sess_name -u >/dev/null 2>&1
d3e8f6bb
DG
271 if [ $? -eq 1 ]; then
272 echo -e '\e[1;31mFAILED\e[0m'
273 return 1
274 else
275 echo -e "\e[1;32mOK\e[0m"
276 fi
277}
278
279function start_tracing ()
280{
281 sess_name=$1
282
283 echo -n "Start lttng tracing for session $sess_name "
10a8a223 284 $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
d3e8f6bb
DG
285 if [ $? -eq 1 ]; then
286 echo -e '\e[1;31mFAILED\e[0m'
287 return 1
288 else
289 echo -e "\e[1;32mOK\e[0m"
290 fi
291}
292
293function stop_tracing ()
294{
295 sess_name=$1
296
297 echo -n "Stop lttng tracing for session $sess_name "
10a8a223 298 $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
d3e8f6bb
DG
299 if [ $? -eq 1 ]; then
300 echo -e '\e[1;31mFAILED\e[0m'
301 return 1
302 else
303 echo -e "\e[1;32mOK\e[0m"
304 fi
305}
306
307function destroy_lttng_session ()
308{
309 sess_name=$1
310
311 echo -n "Destroy lttng session $sess_name "
10a8a223 312 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
d3e8f6bb
DG
313 if [ $? -eq 1 ]; then
314 echo -e '\e[1;31mFAILED\e[0m'
315 return 1
316 else
317 echo -e "\e[1;32mOK\e[0m"
318 fi
319}
320
321function trace_matches ()
322{
323 event_name=$1
324 nr_iter=$2
325 trace_path=$3
326
317eef93
DG
327 which $BABELTRACE_BIN >/dev/null
328 if [ $? -eq 1 ]; then
329 echo "Babeltrace binary not found. Skipping trace matches"
330 return 0
331 fi
332
d3e8f6bb
DG
333 echo -n "Looking for $nr_iter $event_name in $trace_path "
334
335 count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
336 if [ "$count" -ne "$nr_iter" ]; then
337 echo -e "$count found in trace \e[1;31mFAILED\e[0m"
338 return 1
339 else
340 echo -e "Trace is coherent \e[1;32mOK\e[0m"
341 return 0
342 fi
343}
f4e40ab6
DG
344
345function validate_trace
346{
347 event_name=$1
348 trace_path=$2
349
350 which $BABELTRACE_BIN >/dev/null
351 if [ $? -eq 1 ]; then
352 echo "Babeltrace binary not found. Skipping trace matches"
353 return 0
354 fi
355
356 echo -n "Validating trace for event $event_name... "
357 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $event_name | wc -l)
358 if [ $traced -eq 0 ]; then
359 echo -e "\e[1;31mFAILED\e[0m"
360 return 1
361 else
362 echo -e "\e[1;32mOK\e[0m"
363 return 0
364 fi
365}
This page took 0.058898 seconds and 4 git commands to generate.