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
--domain=user \
85 # `--condition event-rule-matches` successes
86 test_success
"--condition event-rule-matches some-event --domain=user" \
87 --condition event-rule-matches
--name=some-event
--domain=user \
90 test_success
"--condition event-rule-matches --domain=user" \
91 --condition event-rule-matches
--domain=user \
94 test_success
"notify action polices" \
95 --condition event-rule-matches
--domain=user
--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
--domain=user
--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
--domain=user
--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
--domain=user
--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
--domain=user
--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
--domain=kernel
--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
--domain=kernel
--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
--domain=kernel
"--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
--domain=kernel
--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
--domain=kernel
--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
--domain=kernel
--syscall --name=open \
174 test_success
"--condition event-rule-matches all syscalls" \
175 --condition event-rule-matches
--domain=kernel
--syscall \
178 test_success
"--condition event-rule-matches one syscall with filter" \
179 --condition event-rule-matches
--domain=kernel
--syscall --filter 'a > 2' --name=open \
183 # `--action notify` successes
184 test_success
"--action notify" \
185 --condition event-rule-matches
--domain=user \
188 test_success
"--action notify --capture foo" \
189 --condition event-rule-matches
--domain=user \
190 --capture foo
--action notify
192 test_success
"--action notify --capture foo[2]" \
193 --condition event-rule-matches
--domain=user \
194 --capture 'foo[2]' --action notify
196 test_success
'--action notify --capture $ctx.foo' \
197 --condition event-rule-matches
--domain=user \
198 --capture '$ctx.foo' --action notify
200 test_success
'--action notify --capture $ctx.foo[2]' \
201 --condition event-rule-matches
--domain=user \
202 --capture '$ctx.foo[2]' --action notify
204 test_success
'--action notify --capture $app.prov:type' \
205 --condition event-rule-matches
--domain=user \
206 --capture '$app.prov:type' --action notify
208 test_success
'--action notify --capture $app.prov:type[2]' \
209 --condition event-rule-matches
--domain=user \
210 --capture '$app.prov:type[2]' --action notify
212 test_success
'--action notify multiple captures' \
213 --condition event-rule-matches
--domain=user \
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
--domain=user \
219 --action start-session ze-session
221 # `--action stop-session` successes
222 test_success
"--action stop-session foo" \
223 --condition event-rule-matches
--domain=user \
224 --action stop-session ze-session
226 # `--action rotate-session` successes
227 test_success
"--action rotate-session foo" \
228 --condition event-rule-matches
--domain=user \
229 --action rotate-session ze-session
231 # `--action snapshot-session` successes
232 test_success
"--action snapshot-session foo" \
233 --condition event-rule-matches
--domain=user \
234 --action snapshot-session ze-session
236 test_success
"--action snapshot-session with file URI" \
237 --condition event-rule-matches
--domain=user \
238 --action snapshot-session ze-session
--path /hello
240 test_success
"--action snapshot-session with net URI" \
241 --condition event-rule-matches
--domain=user \
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
--domain=user \
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
--domain=user
259 test_failure
"two --condition" \
260 "Error: A --condition was already given." \
261 --condition event-rule-matches
--name=aaa
--domain=user \
262 --condition event-rule-matches
--name=bbb
--domain=user \
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
--domain=user
--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
--domain=user
--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
--domain=user
--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
--domain=user
--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 (--domain=(kernel,user,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
--domain=user bozo
308 test_failure
"two same --domain" \
309 "Error: More than one \`--domain\` was specified." \
310 --condition event-rule-matches
--domain=user
--domain=user
312 test_failure
"two different --domain" \
313 "Error: More than one \`--domain\` was specified." \
314 --condition event-rule-matches
--domain=user
--domain=kernel
316 test_failure
"--condition event-rule-matches: --name with --probe" \
317 "Error: Can't use --name with probe event rules." \
318 --condition event-rule-matches
--probe=do_sys_open
--name='hello'
320 test_failure
"--condition event-rule-matches: --event-name with tracepoint" \
321 "Error: Can't use --event-name with tracepoint event rules." \
322 --condition event-rule-matches
--domain=user
--event-name='hello'
324 test_failure
"--condition event-rule-matches: extra argument with --userspace-probe" \
325 "Error: Unexpected argument 'hello'" \
326 --condition event-rule-matches
--domain=kernel
--userspace-probe=${uprobe_elf_binary}:test_failure hello
328 test_failure
"--condition event-rule-matches: extra argument with --syscall" \
329 "Error: Unexpected argument 'open'" \
330 --condition event-rule-matches
--domain=kernel
--syscall open
332 test_failure
"--condition event-rule-matches --capture: missing argument (end of arg list)" \
333 'Error: While parsing argument #2 (`--capture`): Missing required argument for option `--capture`' \
335 --condition event-rule-matches
--domain=user
--capture
337 test_failure
"--condition event-rule-matches --capture: missing argument (before another option)" \
338 'Error: While parsing expression `--action`: Unary operators are not allowed in capture expressions.' \
339 --condition event-rule-matches
--domain=user
--capture \
342 test_failure
"--condition event-rule-matches --capture: binary operator" \
343 'Error: While parsing expression `foo == 2`: Binary operators are not allowed in capture expressions.' \
344 --condition event-rule-matches
--domain=user \
345 --capture 'foo == 2' --action notify
347 test_failure
"--condition event-rule-matches --capture: unary operator" \
348 'Error: While parsing expression `!foo`: Unary operators are not allowed in capture expressions.' \
349 --condition event-rule-matches
--domain=user \
350 --capture '!foo' --action notify
352 test_failure
"--condition event-rule-matches --capture: logical operator" \
353 'Error: While parsing expression `foo || bar`: Logical operators are not allowed in capture expressions.' \
354 --condition event-rule-matches
--domain=user \
355 --capture 'foo || bar' --action notify
357 test_failure
"--condition event-rule-matches --capture: accessing a sub-field" \
358 'Error: While parsing expression `foo.bar`: Capturing subfields is not supported.' \
359 --condition event-rule-matches
--domain=user \
360 --capture 'foo.bar' --action notify
362 test_failure
"--condition event-rule-matches --capture: accessing the sub-field of an array element" \
363 'Error: While parsing expression `foo[3].bar`: Capturing subfields is not supported.' \
364 --condition event-rule-matches
--domain=user \
365 --capture 'foo[3].bar' --action notify
367 test_failure
"--condition event-rule-matches --capture: missing colon in app-specific context field" \
368 'Error: Invalid app-specific context field name: missing colon in `foo`.' \
369 --condition event-rule-matches
--domain=user \
370 --capture '$app.foo' --action notify
372 test_failure
"--condition event-rule-matches --capture: missing colon in app-specific context field" \
373 'Error: Invalid app-specific context field name: missing type name after colon in `foo:`.' \
374 --condition event-rule-matches
--domain=user \
375 --capture '$app.foo:' --action notify
377 # `--action` failures
378 test_failure
"missing args after --action" \
379 "Error: While parsing argument #1 (\`--action\`): Missing required argument for option \`--action\`" \
380 --condition event-rule-matches
--domain=user \
383 # `--action notify` failures
384 test_failure
"extra arg after --action notify" \
385 "Error: Unexpected argument \`bob\`." \
386 --condition event-rule-matches
--domain=user \
389 # `--action start-session` failures
390 test_failure
"missing arg after --action start-session" \
391 "Error: Missing session name." \
392 --condition event-rule-matches
--domain=user \
393 --action start-session
394 test_failure
"extra arg after --action start-session" \
395 "Error: Unexpected argument \`bob\`." \
396 --condition event-rule-matches
--domain=user \
397 --action start-session ze-session bob
399 # `--action stop-session` failures
400 test_failure
"missing arg after --action stop-session" \
401 "Error: Missing session name." \
402 --condition event-rule-matches
--domain=user \
403 --action stop-session
404 test_failure
"extra arg after --action stop-session" \
405 "Error: Unexpected argument \`bob\`." \
406 --condition event-rule-matches
--domain=user \
407 --action stop-session ze-session bob
409 # `--action rotate-session` failures
410 test_failure
"missing arg after --action rotate-session" \
411 "Error: Missing session name." \
412 --condition event-rule-matches
--domain=user \
413 --action rotate-session
414 test_failure
"extra arg after --action rotate-session" \
415 "Error: Unexpected argument \`bob\`." \
416 --condition event-rule-matches
--domain=user \
417 --action rotate-session ze-session bob
419 # `--action snapshot-session` failures
420 test_failure
"missing arg after --action snapshot-session" \
421 "Error: Missing session name." \
422 --condition event-rule-matches
--domain=user \
423 --action snapshot-session
424 test_failure
"extra arg after --action snapshot-session" \
425 "Error: Unexpected argument \`bob\`." \
426 --condition event-rule-matches
--domain=user \
427 --action snapshot-session ze-session bob
428 test_failure
"snapshot-session action, --max-size without destination" \
429 "Error: Can't provide a snapshot output max size without a snapshot output destination." \
430 --condition event-rule-matches
--domain=user \
431 --action snapshot-session ze-session
--max-size 10M
432 test_failure
"snapshot-session action, --name without destination" \
433 "Error: Can't provide a snapshot output name without a snapshot output destination." \
434 --condition event-rule-matches
--domain=user \
435 --action snapshot-session ze-session
--name hallo
436 test_failure
"snapshot-session action, --name with-local-path-instead-of-url" \
437 "Error: Failed to parse '/something/that/looks/like/a/path' as an URL." \
438 --condition event-rule-matches
--domain=user \
439 --action snapshot-session ze-session
--name hallo
--url /something
/that
/looks
/like
/a
/path
440 test_failure
"snapshot-session action, --name with-net-url-instead-of-path" \
441 "Error: Failed to parse 'net://8.8.8.8/' as a local path." \
442 --condition event-rule-matches
--domain=user \
443 --action snapshot-session ze-session
--name hallo
--path net
://8.8.8.8/
446 stop_lttng_sessiond_notap
447 rm -f "${tmp_stdout}"
448 rm -f "${tmp_stderr}"