Tests: Convert functions in utils.sh to output in the TAP format
[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 RELAYD_BIN="lttng-relayd"
20 LTTNG_BIN="lttng"
21 BABELTRACE_BIN="babeltrace"
22
23 # Minimal kernel version supported for session daemon tests
24 KERNEL_MAJOR_VERSION=2
25 KERNEL_MINOR_VERSION=6
26 KERNEL_PATCHLEVEL_VERSION=27
27
28 source $TESTDIR/utils/tap/tap.sh
29
30 function print_ok ()
31 {
32 # Check if we are a terminal
33 if [ -t 1 ]; then
34 echo -e "\e[1;32mOK\e[0m"
35 else
36 echo -e "OK"
37 fi
38 }
39
40 function print_fail ()
41 {
42 # Check if we are a terminal
43 if [ -t 1 ]; then
44 echo -e "\e[1;31mFAIL\e[0m"
45 else
46 echo -e "FAIL"
47 fi
48 }
49
50 function print_test_banner ()
51 {
52 desc="$1"
53 diag "$desc"
54 }
55
56 function validate_kernel_version ()
57 {
58 kern_version=($(uname -r | awk -F. '{ printf("%d.%d.%d\n",$1,$2,$3); }' | tr '.' '\n'))
59 if [ ${kern_version[0]} -gt $KERNEL_MAJOR_VERSION ]; then
60 return 0
61 fi
62 if [ ${kern_version[1]} -gt $KERNEL_MINOR_VERSION ]; then
63 return 0
64 fi
65 if [ ${kern_version[2]} -ge $KERNEL_PATCHLEVEL_VERSION ]; then
66 return 0
67 fi
68 return 1
69 }
70
71 # Generate a random string
72 # $1 = number of characters; defaults to 16
73 # $2 = include special characters; 1 = yes, 0 = no; defaults to yes
74 function randstring()
75 {
76 [ "$2" == "0" ] && CHAR="[:alnum:]" || CHAR="[:graph:]"
77 cat /dev/urandom | tr -cd "$CHAR" | head -c ${1:-16}
78 echo
79 }
80
81 function lttng_enable_kernel_event
82 {
83 sess_name=$1
84 event_name=$2
85
86 if [ -z $event_name ]; then
87 # Enable all event if no event name specified
88 event_name="-a"
89 fi
90
91 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -k >/dev/null 2>&1
92 ok $? "Enable kernel event $event_name for session $sess_name"
93 }
94
95 function start_lttng_relayd
96 {
97 local opt=$1
98
99 DIR=$(readlink -f $TESTDIR)
100
101 if [ -z $(pidof lt-$RELAYD_BIN) ]; then
102 $DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt >/dev/null 2>&1 &
103 #$DIR/../src/bin/lttng-relayd/$RELAYD_BIN $opt -vvv >>/tmp/relayd.log 2>&1 &
104 if [ $? -eq 1 ]; then
105 fail "Start lttng-relayd (opt: $opt)"
106 return 1
107 else
108 pass "Start lttng-relayd (opt: $opt)"
109 fi
110 else
111 pass "Start lttng-relayd (opt: $opt)"
112 fi
113 }
114
115 function stop_lttng_relayd
116 {
117 PID_RELAYD=`pidof lt-$RELAYD_BIN`
118
119 kill $PID_RELAYD >/dev/null 2>&1
120
121 if [ $? -eq 1 ]; then
122 fail "Kill lttng-relayd (pid: $PID_RELAYD)"
123 return 1
124 else
125 out=1
126 while [ -n "$out" ]; do
127 out=$(pidof lt-$RELAYD_BIN)
128 sleep 0.5
129 done
130 pass "Kill lttng-relayd (pid: $PID_RELAYD)"
131 return 0
132 fi
133 }
134
135 function start_lttng_sessiond()
136 {
137 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
138 # Env variable requested no session daemon
139 return
140 fi
141
142 validate_kernel_version
143 if [ $? -ne 0 ]; then
144 fail "Start session daemon"
145 BAIL_OUT "*** Kernel too old for session daemon tests ***"
146 fi
147
148 DIR=$(readlink -f $TESTDIR)
149
150 if [ -z $(pidof lt-$SESSIOND_BIN) ]; then
151 $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"
152 #$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 &
153 status=$?
154 # Wait for sessiond to bootstrap
155 sleep 2
156 ok $status "Start session daemon"
157 fi
158 }
159
160 function stop_lttng_sessiond ()
161 {
162 if [ -n $TEST_NO_SESSIOND ] && [ "$TEST_NO_SESSIOND" == "1" ]; then
163 # Env variable requested no session daemon
164 return
165 fi
166
167 PID_SESSIOND=`pidof lt-$SESSIOND_BIN`
168
169 kill $PID_SESSIOND >/dev/null 2>&1
170
171 if [ $? -eq 1 ]; then
172 fail "Kill sessions daemon"
173 return 1
174 else
175 out=1
176 while [ -n "$out" ]; do
177 out=$(pidof lt-$SESSIOND_BIN)
178 sleep 0.5
179 done
180 pass "Kill session daemon"
181 fi
182 }
183
184 function create_lttng_session ()
185 {
186 sess_name=$1
187 trace_path=$2
188
189 $TESTDIR/../src/bin/lttng/$LTTNG_BIN create $sess_name -o $trace_path >/dev/null 2>&1
190 ok $? "Create session $sess_name in $trace_path"
191 }
192
193 function enable_ust_lttng_channel()
194 {
195 sess_name=$1
196 channel_name=$2
197
198 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
199 ok $? "Enable channel $channel_name for session $sess_name"
200 }
201
202 function disable_ust_lttng_channel()
203 {
204 sess_name=$1
205 channel_name=$2
206
207 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-channel -u $channel_name -s $sess_name >/dev/null 2>&1
208 ok $? "Disable channel $channel_name for session $sess_name"
209 }
210
211 function enable_ust_lttng_event ()
212 {
213 sess_name=$1
214 event_name="$2"
215
216 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
217 ok $? "Enable event $event_name for session $sess_name"
218 }
219
220 function enable_ust_lttng_event_filter()
221 {
222 sess_name="$1"
223 event_name="$2"
224 filter="$3"
225
226 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --filter "$filter" >/dev/null 2>&1
227 ok $? "Enable event $event_name with filtering for session $sess_name"
228 }
229
230 function enable_ust_lttng_event_loglevel()
231 {
232 sess_name="$1"
233 event_name="$2"
234 loglevel="$3"
235
236 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel $loglevel >/dev/null 2>&1
237 ok $? "Enable event $event_name with loglevel $loglevel"
238 }
239
240 function enable_ust_lttng_event_loglevel_only()
241 {
242 sess_name="$1"
243 event_name="$2"
244 loglevel="$3"
245
246 $TESTDIR/../src/bin/lttng/$LTTNG_BIN enable-event "$event_name" -s $sess_name -u --loglevel-only $loglevel >/dev/null 2>&1
247 ok $? "Enable event $event_name with loglevel-only $loglevel"
248 }
249
250 function disable_ust_lttng_event ()
251 {
252 sess_name="$1"
253 event_name="$2"
254
255 $TESTDIR/../src/bin/lttng/$LTTNG_BIN disable-event "$event_name" -s $sess_name -u >/dev/null 2>&1
256 ok $? "Disable event $event_name for session $sess_name"
257 }
258
259 function start_lttng_tracing ()
260 {
261 sess_name=$1
262
263 $TESTDIR/../src/bin/lttng/$LTTNG_BIN start $sess_name >/dev/null 2>&1
264 ok $? "Start tracing for session $sess_name"
265 }
266
267 function stop_lttng_tracing ()
268 {
269 sess_name=$1
270
271 $TESTDIR/../src/bin/lttng/$LTTNG_BIN stop $sess_name >/dev/null 2>&1
272 ok $? "Stop lttng tracing for session $sess_name"
273 }
274
275 function destroy_lttng_session ()
276 {
277 sess_name=$1
278
279
280 $TESTDIR/../src/bin/lttng/$LTTNG_BIN destroy $sess_name >/dev/null 2>&1
281 ok $? "Destroy lttng session $sess_name"
282 }
283
284 function trace_matches ()
285 {
286 event_name=$1
287 nr_iter=$2
288 trace_path=$3
289
290 which $BABELTRACE_BIN >/dev/null
291 skip $? -ne 0 "Babeltrace binary not found. Skipping trace matches"
292
293 count=$($BABELTRACE_BIN $trace_path | grep $event_name | wc -l)
294
295 if [ "$count" -ne "$nr_iter" ]; then
296 fail "Trace match"
297 diag "$count events found in trace"
298 else
299 pass "Trace match"
300 fi
301 }
302
303 function validate_trace
304 {
305 event_name=$1
306 trace_path=$2
307
308 which $BABELTRACE_BIN >/dev/null
309 if [ $? -ne 0 ]; then
310 skip 0 "Babeltrace binary not found. Skipping trace validation"
311 fi
312
313 traced=$($BABELTRACE_BIN $trace_path 2>/dev/null | grep $event_name | wc -l)
314 if [ "$traced" -ne 0 ]; then
315 pass "Validate trace for event $event_name"
316 else
317 fail "Validate trace for event $event_name"
318 diag "Found $traced occurences of $event_name"
319 fi
320 }
This page took 0.037057 seconds and 6 git commands to generate.