3 # Copyright (C) - 2020 EfficiOS, inc
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.
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
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
18 # Test the `lttng add-trigger` command line interface.
20 CURDIR
="$(dirname "$0")"
21 TESTDIR
="$CURDIR/../../.."
23 # shellcheck source=../../../utils/utils.sh
24 source "$TESTDIR/utils/utils.sh"
28 FULL_LTTNG_BIN
="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
30 # shellcheck disable=SC2119
31 start_lttng_sessiond_notap
33 tmp_stdout
=$
(mktemp
-t test_parse_cli_trigger_stdout.XXXXXX
)
34 tmp_stderr
=$
(mktemp
-t test_parse_cli_trigger_stderr.XXXXXX
)
35 uprobe_elf_binary
="${TESTDIR}/utils/testapp/userspace-probe-elf-binary/.libs/userspace-probe-elf-binary"
37 if [ "$(id -u)" == "0" ]; then
43 function test_success
()
48 diag
"${FULL_LTTNG_BIN} add-trigger $*"
50 "${FULL_LTTNG_BIN}" add-trigger "$@" > "${tmp_stdout}" 2> "${tmp_stderr}"
52 ok $?
"${test_name}: exit code is 0"
54 diff -u "${tmp_stdout}" <(echo "Trigger registered successfully.")
55 ok $?
"${test_name}: expected stdout"
57 diff -u "${tmp_stderr}" /dev
/null
58 ok $?
"${test_name}: expected stderr"
61 function test_failure
()
68 diag
"${FULL_LTTNG_BIN} add-trigger $*"
69 "${FULL_LTTNG_BIN}" add-trigger "$@" > "${tmp_stdout}" 2> "${tmp_stderr}"
70 isnt $?
0 "${test_name}: exit code is not 0"
72 diff -u "${tmp_stdout}" /dev
/null
73 ok $?
"${test_name}: expected stdout"
75 diff -u "${tmp_stderr}" <(echo "${error_msg}")
76 ok $?
"${test_name}: expected stderr"
80 test_success
"explicit name" \
82 --condition event-rule-matches
--name=some-event-id
-u \
85 # `--condition event-rule-matches` successes
86 test_success
"--condition event-rule-matches some-event -u" \
87 --condition event-rule-matches
--name=some-event
-u \
90 test_success
"--condition event-rule-matches -u" \
91 --condition event-rule-matches
-u \
94 test_success
"notify action polices" \
95 --condition event-rule-matches
-u --name=test-rate-policy \
97 --rate-policy=every
:55 \
99 --rate-policy=once-after
:55
101 test_success
"start session action polices" \
102 --condition event-rule-matches
-u --name=test-rate-policy \
103 --action start-session my_session \
104 --rate-policy=every
:55 \
105 --action start-session my_session \
106 --rate-policy=once-after
:55
108 test_success
"stop session action polices" \
109 --condition event-rule-matches
-u --name=test-rate-policy \
110 --action stop-session my_session \
111 --rate-policy=every
:55 \
112 --action stop-session my_session \
113 --rate-policy=once-after
:55
115 test_success
"snapshot session action polices" \
116 --condition event-rule-matches
-u --name=test-rate-policy \
117 --action snapshot-session my_session \
118 --rate-policy=every
:55 \
119 --action snapshot-session my_session \
120 --rate-policy=once-after
:55
122 test_success
"rotate session action polices" \
123 --condition event-rule-matches
-u --name=test-rate-policy \
124 --action rotate-session my_session \
125 --rate-policy=every
:55 \
126 --action rotate-session my_session \
127 --rate-policy=once-after
:55
129 skip
$ist_root "non-root user: skipping kprobe tests" 9 ||
{
130 test_success
"--condition event-rule-matches probe by symbol" \
131 --condition event-rule-matches
-k --probe=lttng_channel_enable
--event-name=my_channel_enable \
134 channel_enable_addr
=$
(grep ' t lttng_channel_enable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
135 channel_disable_addr
=$
(grep ' t lttng_channel_disable\s\[lttng_tracer\]$' /proc
/kallsyms | cut
-f 1 -d ' ')
137 # We need to find a valid offset.
140 if [[ 0x
$channel_enable_addr -lt 0x
$channel_disable_addr ]]; then
141 base_symbol
="lttng_channel_enable"
142 offset
=$
(( 0x
$channel_disable_addr - 0x
$channel_enable_addr ))
144 base_symbol
="lttng_channel_disable"
145 offset
=$
(( 0x
$channel_enable_addr - 0x
$channel_disable_addr ))
148 offset_hex
="0x$(printf '%x' $offset)"
150 test_success
"--condition event-rule-matches probe by symbol with offset" \
151 --condition event-rule-matches
-k --probe="${base_symbol}+${offset_hex}" --event-name=my_
$base_symbol \
154 test_success
"--condition event-rule-matches probe by address" \
155 --condition event-rule-matches
-k "--probe=0x${channel_enable_addr}" --event-name=my_channel_enable \
159 skip
$ist_root "non-root user: skipping uprobe tests" 6 ||
{
160 test_success
"--condition event-rule-matches uprobe" \
161 --condition event-rule-matches
-k --userspace-probe=${uprobe_elf_binary}:test_function
--event-name=ma-probe \
164 test_success
"--condition event-rule-matches uprobe with elf prefix" \
165 --condition event-rule-matches
-k --userspace-probe=elf
:${uprobe_elf_binary}:test_function
--event-name=ma-probe-2 \
169 skip
$ist_root "non-root user: skipping syscall tests" 9 ||
{
170 test_success
"--condition event-rule-matches one syscall" \
171 --condition event-rule-matches
-k --syscall --name=open \
174 test_success
"--condition event-rule-matches all syscalls" \
175 --condition event-rule-matches
-k --syscall \
178 test_success
"--condition event-rule-matches one syscall with filter" \
179 --condition event-rule-matches
-k --syscall --filter 'a > 2' --name=open \
183 # `--action notify` successes
184 test_success
"--action notify" \
185 --condition event-rule-matches
-u \
188 test_success
"--action notify --capture foo" \
189 --condition event-rule-matches
-u \
190 --capture foo
--action notify
192 test_success
"--action notify --capture foo[2]" \
193 --condition event-rule-matches
-u \
194 --capture 'foo[2]' --action notify
196 test_success
'--action notify --capture $ctx.foo' \
197 --condition event-rule-matches
-u \
198 --capture '$ctx.foo' --action notify
200 test_success
'--action notify --capture $ctx.foo[2]' \
201 --condition event-rule-matches
-u \
202 --capture '$ctx.foo[2]' --action notify
204 test_success
'--action notify --capture $app.prov:type' \
205 --condition event-rule-matches
-u \
206 --capture '$app.prov:type' --action notify
208 test_success
'--action notify --capture $app.prov:type[2]' \
209 --condition event-rule-matches
-u \
210 --capture '$app.prov:type[2]' --action notify
212 test_success
'--action notify multiple captures' \
213 --condition event-rule-matches
-u \
214 --capture foo
--capture '$app.hello:world' --action notify
216 # `--action start-session` successes
217 test_success
"--action start-session" \
218 --condition event-rule-matches
-u \
219 --action start-session ze-session
221 # `--action stop-session` successes
222 test_success
"--action stop-session foo" \
223 --condition event-rule-matches
-u \
224 --action stop-session ze-session
226 # `--action rotate-session` successes
227 test_success
"--action rotate-session foo" \
228 --condition event-rule-matches
-u \
229 --action rotate-session ze-session
231 # `--action snapshot-session` successes
232 test_success
"--action snapshot-session foo" \
233 --condition event-rule-matches
-u \
234 --action snapshot-session ze-session
236 test_success
"--action snapshot-session with file URI" \
237 --condition event-rule-matches
-u \
238 --action snapshot-session ze-session
--path /hello
240 test_success
"--action snapshot-session with net URI" \
241 --condition event-rule-matches
-u \
242 --action snapshot-session ze-session
--url net
://1.2.3.4
244 test_success
"--action snapshot-session with ctrl/data URIs" \
245 --condition event-rule-matches
-u \
246 --action snapshot-session ze-session
--ctrl-url=tcp
://1.2.3.4:1234 --data-url=tcp
://1.2.3.4:1235
249 test_failure
"no args" "Error: Missing --condition."
251 test_failure
"unknown option" \
252 "Error: Unknown option \`--hello\`" \
255 test_failure
"missing --action" \
256 "Error: Need at least one --action." \
257 --condition event-rule-matches
-u
259 test_failure
"two --condition" \
260 "Error: A --condition was already given." \
261 --condition event-rule-matches
--name=aaa
-u \
262 --condition event-rule-matches
--name=bbb
-u \
265 test_failure
"missing argument to --name" \
266 "Error: While parsing argument #1 (\`--name\`): Missing required argument for option \`--name\`" \
269 for cmd
in rate-policy
=once-after rate-policy
=every
; do
270 test_failure
"missing argument to --${cmd}" \
271 "Error: Rate policy format is invalid." \
272 --condition event-rule-matches
-u --action notify \
275 test_failure
"invalid argument to --${cmd}: non-digit character" \
276 "Error: Failed to parse rate policy value \`123bob\` as an integer." \
277 --condition event-rule-matches
-u --action notify \
280 test_failure
"invalid argument to --${cmd}: empty string" \
281 "Error: Failed to parse rate policy value \`\` as an integer." \
282 --condition event-rule-matches
-u --action notify \
286 test_failure
"invalid argument to --rate-policy: unknown policy type" \
287 "Error: Rate policy type \`bob\` unknown." \
288 --condition event-rule-matches
-u --action notify \
289 --rate-policy=bob
:123
291 # `--condition` failures
292 test_failure
"missing args after --condition" \
293 "Error: While parsing argument #1 (\`--condition\`): Missing required argument for option \`--condition\`" \
295 test_failure
"unknown --condition" \
296 "Error: Unknown condition name 'zoofest'" \
299 # `--condition event-rule-matches` failures
300 test_failure
"missing args after --condition event-rule-matches" \
301 "Error: Please specify a domain (--kernel/--userspace/--jul/--log4j/--python)." \
302 --condition event-rule-matches
304 test_failure
"extra args after --condition event-rule-matches" \
305 "Error: Unexpected argument 'bozo'" \
306 --condition event-rule-matches
-u bozo
308 test_failure
"--condition event-rule-matches: --name with --probe" \
309 "Error: Can't use --name with probe event rules." \
310 --condition event-rule-matches
--probe=do_sys_open
--name='hello'
312 test_failure
"--condition event-rule-matches: --event-name with tracepoint" \
313 "Error: Can't use --event-name with tracepoint event rules." \
314 --condition event-rule-matches
-u --event-name='hello'
316 test_failure
"--condition event-rule-matches: extra argument with --userspace-probe" \
317 "Error: Unexpected argument 'hello'" \
318 --condition event-rule-matches
-k --userspace-probe=${uprobe_elf_binary}:test_failure hello
320 test_failure
"--condition event-rule-matches: extra argument with --syscall" \
321 "Error: Unexpected argument 'open'" \
322 --condition event-rule-matches
-k --syscall open
324 test_failure
"--condition event-rule-matches --capture: missing argument (end of arg list)" \
325 'Error: While parsing argument #2 (`--capture`): Missing required argument for option `--capture`' \
327 --condition event-rule-matches
-u --capture
329 test_failure
"--condition event-rule-matches --capture: missing argument (before another option)" \
330 'Error: While parsing expression `--action`: Unary operators are not allowed in capture expressions.' \
331 --condition event-rule-matches
-u --capture \
334 test_failure
"--condition event-rule-matches --capture: binary operator" \
335 'Error: While parsing expression `foo == 2`: Binary operators are not allowed in capture expressions.' \
336 --condition event-rule-matches
-u \
337 --capture 'foo == 2' --action notify
339 test_failure
"--condition event-rule-matches --capture: unary operator" \
340 'Error: While parsing expression `!foo`: Unary operators are not allowed in capture expressions.' \
341 --condition event-rule-matches
-u \
342 --capture '!foo' --action notify
344 test_failure
"--condition event-rule-matches --capture: logical operator" \
345 'Error: While parsing expression `foo || bar`: Logical operators are not allowed in capture expressions.' \
346 --condition event-rule-matches
-u \
347 --capture 'foo || bar' --action notify
349 test_failure
"--condition event-rule-matches --capture: accessing a sub-field" \
350 'Error: While parsing expression `foo.bar`: Capturing subfields is not supported.' \
351 --condition event-rule-matches
-u \
352 --capture 'foo.bar' --action notify
354 test_failure
"--condition event-rule-matches --capture: accessing the sub-field of an array element" \
355 'Error: While parsing expression `foo[3].bar`: Capturing subfields is not supported.' \
356 --condition event-rule-matches
-u \
357 --capture 'foo[3].bar' --action notify
359 test_failure
"--condition event-rule-matches --capture: missing colon in app-specific context field" \
360 'Error: Invalid app-specific context field name: missing colon in `foo`.' \
361 --condition event-rule-matches
-u \
362 --capture '$app.foo' --action notify
364 test_failure
"--condition event-rule-matches --capture: missing colon in app-specific context field" \
365 'Error: Invalid app-specific context field name: missing type name after colon in `foo:`.' \
366 --condition event-rule-matches
-u \
367 --capture '$app.foo:' --action notify
369 # `--action` failures
370 test_failure
"missing args after --action" \
371 "Error: While parsing argument #1 (\`--action\`): Missing required argument for option \`--action\`" \
372 --condition event-rule-matches
-u \
375 # `--action notify` failures
376 test_failure
"extra arg after --action notify" \
377 "Error: Unexpected argument \`bob\`." \
378 --condition event-rule-matches
-u \
381 # `--action start-session` failures
382 test_failure
"missing arg after --action start-session" \
383 "Error: Missing session name." \
384 --condition event-rule-matches
-u \
385 --action start-session
386 test_failure
"extra arg after --action start-session" \
387 "Error: Unexpected argument \`bob\`." \
388 --condition event-rule-matches
-u \
389 --action start-session ze-session bob
391 # `--action stop-session` failures
392 test_failure
"missing arg after --action stop-session" \
393 "Error: Missing session name." \
394 --condition event-rule-matches
-u \
395 --action stop-session
396 test_failure
"extra arg after --action stop-session" \
397 "Error: Unexpected argument \`bob\`." \
398 --condition event-rule-matches
-u \
399 --action stop-session ze-session bob
401 # `--action rotate-session` failures
402 test_failure
"missing arg after --action rotate-session" \
403 "Error: Missing session name." \
404 --condition event-rule-matches
-u \
405 --action rotate-session
406 test_failure
"extra arg after --action rotate-session" \
407 "Error: Unexpected argument \`bob\`." \
408 --condition event-rule-matches
-u \
409 --action rotate-session ze-session bob
411 # `--action snapshot-session` failures
412 test_failure
"missing arg after --action snapshot-session" \
413 "Error: Missing session name." \
414 --condition event-rule-matches
-u \
415 --action snapshot-session
416 test_failure
"extra arg after --action snapshot-session" \
417 "Error: Unexpected argument \`bob\`." \
418 --condition event-rule-matches
-u \
419 --action snapshot-session ze-session bob
420 test_failure
"snapshot-session action, --max-size without destination" \
421 "Error: Can't provide a snapshot output max size without a snapshot output destination." \
422 --condition event-rule-matches
-u \
423 --action snapshot-session ze-session
--max-size 10M
424 test_failure
"snapshot-session action, --name without destination" \
425 "Error: Can't provide a snapshot output name without a snapshot output destination." \
426 --condition event-rule-matches
-u \
427 --action snapshot-session ze-session
--name hallo
428 test_failure
"snapshot-session action, --name with-local-path-instead-of-url" \
429 "Error: Failed to parse '/something/that/looks/like/a/path' as an URL." \
430 --condition event-rule-matches
-u \
431 --action snapshot-session ze-session
--name hallo
--url /something
/that
/looks
/like
/a
/path
432 test_failure
"snapshot-session action, --name with-net-url-instead-of-path" \
433 "Error: Failed to parse 'net://8.8.8.8/' as a local path." \
434 --condition event-rule-matches
-u \
435 --action snapshot-session ze-session
--name hallo
--path net
://8.8.8.8/
438 stop_lttng_sessiond_notap
439 rm -f "${tmp_stdout}"
440 rm -f "${tmp_stderr}"