lttng add-trigger: replace event rule type options with --type
[lttng-tools.git] / tests / regression / tools / trigger / test_add_trigger_cli
CommitLineData
b4b7369f
JR
1#!/bin/bash
2#
3# Copyright (C) - 2020 EfficiOS, inc
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# Test the `lttng add-trigger` command line interface.
19
20CURDIR="$(dirname "$0")"
21TESTDIR="$CURDIR/../../.."
22
23# shellcheck source=../../../utils/utils.sh
24source "$TESTDIR/utils/utils.sh"
25
24de704e 26plan_tests 252
b4b7369f
JR
27
28FULL_LTTNG_BIN="${TESTDIR}/../src/bin/lttng/${LTTNG_BIN}"
29
30# shellcheck disable=SC2119
31start_lttng_sessiond_notap
32
33tmp_stdout=$(mktemp -t test_parse_cli_trigger_stdout.XXXXXX)
34tmp_stderr=$(mktemp -t test_parse_cli_trigger_stderr.XXXXXX)
35uprobe_elf_binary="${TESTDIR}/utils/testapp/userspace-probe-elf-binary/.libs/userspace-probe-elf-binary"
36
37if [ "$(id -u)" == "0" ]; then
38 ist_root=1
39else
40 ist_root=0
41fi
42
43function test_success ()
44{
45 local test_name="$1"
46 shift
47
48 diag "${FULL_LTTNG_BIN} add-trigger $*"
e45dd625 49 set -x
b4b7369f 50 "${FULL_LTTNG_BIN}" add-trigger "$@" > "${tmp_stdout}" 2> "${tmp_stderr}"
e45dd625 51 set +x
b4b7369f
JR
52 ok $? "${test_name}: exit code is 0"
53
54 diff -u "${tmp_stdout}" <(echo "Trigger registered successfully.")
55 ok $? "${test_name}: expected stdout"
56
57 diff -u "${tmp_stderr}" /dev/null
58 ok $? "${test_name}: expected stderr"
59}
60
61function test_failure ()
62{
63 local test_name="$1"
64 local error_msg="$2"
65
66 shift 2
67
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"
71
72 diff -u "${tmp_stdout}" /dev/null
73 ok $? "${test_name}: expected stdout"
74
75 diff -u "${tmp_stderr}" <(echo "${error_msg}")
76 ok $? "${test_name}: expected stderr"
77}
78
79# top-level options
1d4b59f2
SM
80test_success "explicit name" \
81 --name hohoho \
64c34630 82 --condition event-rule-matches --name=some-event-id --domain=user \
b4b7369f
JR
83 --action notify
84
665db063 85# `--condition event-rule-matches` successes
64c34630
SM
86test_success "--condition event-rule-matches some-event --domain=user" \
87 --condition event-rule-matches --name=some-event --domain=user \
b4b7369f
JR
88 --action notify
89
64c34630
SM
90test_success "--condition event-rule-matches --domain=user" \
91 --condition event-rule-matches --domain=user \
b4b7369f
JR
92 --action notify
93
e45dd625 94test_success "notify action polices" \
64c34630 95 --condition event-rule-matches --domain=user --name=test-rate-policy \
b4b7369f 96 --action notify \
bbadb5e0 97 --rate-policy=every:55 \
e45dd625 98 --action notify \
bbadb5e0 99 --rate-policy=once-after:55
b4b7369f 100
e45dd625 101test_success "start session action polices" \
64c34630 102 --condition event-rule-matches --domain=user --name=test-rate-policy \
e45dd625 103 --action start-session my_session \
bbadb5e0 104 --rate-policy=every:55 \
e45dd625 105 --action start-session my_session \
bbadb5e0 106 --rate-policy=once-after:55
e45dd625
JR
107
108test_success "stop session action polices" \
64c34630 109 --condition event-rule-matches --domain=user --name=test-rate-policy \
e45dd625 110 --action stop-session my_session \
bbadb5e0 111 --rate-policy=every:55 \
e45dd625 112 --action stop-session my_session \
bbadb5e0 113 --rate-policy=once-after:55
e45dd625
JR
114
115test_success "snapshot session action polices" \
64c34630 116 --condition event-rule-matches --domain=user --name=test-rate-policy \
e45dd625 117 --action snapshot-session my_session \
bbadb5e0 118 --rate-policy=every:55 \
e45dd625 119 --action snapshot-session my_session \
bbadb5e0 120 --rate-policy=once-after:55
e45dd625
JR
121
122test_success "rotate session action polices" \
64c34630 123 --condition event-rule-matches --domain=user --name=test-rate-policy \
e45dd625 124 --action rotate-session my_session \
bbadb5e0 125 --rate-policy=every:55 \
e45dd625 126 --action rotate-session my_session \
bbadb5e0 127 --rate-policy=once-after:55
b4b7369f 128
24de704e
SM
129skip $ist_root "non-root user: skipping kprobe tests" 18 || {
130 for type in kprobe kernel-probe; do
131 test_success "--condition event-rule-matches probe by symbol" \
132 --condition event-rule-matches --domain=kernel --type=$type --location=lttng_channel_enable --event-name=my_channel_enable \
133 --action notify
134
135 channel_enable_addr=$(grep ' t lttng_channel_enable\s\[lttng_tracer\]$' /proc/kallsyms | cut -f 1 -d ' ')
136 channel_disable_addr=$(grep ' t lttng_channel_disable\s\[lttng_tracer\]$' /proc/kallsyms | cut -f 1 -d ' ')
137
138 # We need to find a valid offset.
139 base_symbol=""
140 offset=0
141 if [[ 0x$channel_enable_addr -lt 0x$channel_disable_addr ]]; then
142 base_symbol="lttng_channel_enable"
143 offset=$(( 0x$channel_disable_addr - 0x$channel_enable_addr ))
144 else
145 base_symbol="lttng_channel_disable"
146 offset=$(( 0x$channel_enable_addr - 0x$channel_disable_addr ))
147 fi
148
149 offset_hex="0x$(printf '%x' $offset)"
150
151 test_success "--condition event-rule-matches probe by symbol with offset" \
152 --condition event-rule-matches --domain=kernel --type=$type --location="${base_symbol}+${offset_hex}" --event-name=my_$base_symbol \
153 --action notify
154
155 test_success "--condition event-rule-matches probe by address" \
156 --condition event-rule-matches --domain=kernel --type=$type --location="0x${channel_enable_addr}" --event-name=my_channel_enable \
157 --action notify
158 done
b4b7369f
JR
159}
160
24de704e
SM
161skip $ist_root "non-root user: skipping uprobe tests" 12 || {
162 for type in uprobe userspace-probe; do
163 test_success "--condition event-rule-matches uprobe" \
164 --condition event-rule-matches --domain=kernel --type=$type --location=${uprobe_elf_binary}:test_function --event-name=ma-probe \
165 --action notify
b4b7369f 166
24de704e
SM
167 test_success "--condition event-rule-matches uprobe with elf prefix" \
168 --condition event-rule-matches --domain=kernel --type=$type --location=elf:${uprobe_elf_binary}:test_function --event-name=ma-probe-2 \
169 --action notify
170 done
b4b7369f
JR
171}
172
173skip $ist_root "non-root user: skipping syscall tests" 9 || {
50ad0862 174 test_success "--condition event-rule-matches one syscall" \
24de704e 175 --condition event-rule-matches --domain=kernel --type=syscall --name=open \
b4b7369f
JR
176 --action notify
177
50ad0862 178 test_success "--condition event-rule-matches all syscalls" \
24de704e 179 --condition event-rule-matches --domain=kernel --type=syscall \
b4b7369f
JR
180 --action notify
181
50ad0862 182 test_success "--condition event-rule-matches one syscall with filter" \
24de704e 183 --condition event-rule-matches --domain=kernel --type=syscall --filter 'a > 2' --name=open \
b4b7369f
JR
184 --action notify
185}
186
187# `--action notify` successes
188test_success "--action notify" \
64c34630 189 --condition event-rule-matches --domain=user \
b4b7369f
JR
190 --action notify
191
20a01d15 192test_success "--action notify --capture foo" \
64c34630 193 --condition event-rule-matches --domain=user \
20a01d15
SM
194 --capture foo --action notify
195
196test_success "--action notify --capture foo[2]" \
64c34630 197 --condition event-rule-matches --domain=user \
20a01d15
SM
198 --capture 'foo[2]' --action notify
199
200test_success '--action notify --capture $ctx.foo' \
64c34630 201 --condition event-rule-matches --domain=user \
20a01d15
SM
202 --capture '$ctx.foo' --action notify
203
204test_success '--action notify --capture $ctx.foo[2]' \
64c34630 205 --condition event-rule-matches --domain=user \
20a01d15
SM
206 --capture '$ctx.foo[2]' --action notify
207
208test_success '--action notify --capture $app.prov:type' \
64c34630 209 --condition event-rule-matches --domain=user \
20a01d15
SM
210 --capture '$app.prov:type' --action notify
211
212test_success '--action notify --capture $app.prov:type[2]' \
64c34630 213 --condition event-rule-matches --domain=user \
20a01d15
SM
214 --capture '$app.prov:type[2]' --action notify
215
216test_success '--action notify multiple captures' \
64c34630 217 --condition event-rule-matches --domain=user \
20a01d15
SM
218 --capture foo --capture '$app.hello:world' --action notify
219
b4b7369f
JR
220# `--action start-session` successes
221test_success "--action start-session" \
64c34630 222 --condition event-rule-matches --domain=user \
b4b7369f
JR
223 --action start-session ze-session
224
225# `--action stop-session` successes
226test_success "--action stop-session foo" \
64c34630 227 --condition event-rule-matches --domain=user \
b4b7369f
JR
228 --action stop-session ze-session
229
230# `--action rotate-session` successes
231test_success "--action rotate-session foo" \
64c34630 232 --condition event-rule-matches --domain=user \
b4b7369f
JR
233 --action rotate-session ze-session
234
235# `--action snapshot-session` successes
236test_success "--action snapshot-session foo" \
64c34630 237 --condition event-rule-matches --domain=user \
b4b7369f
JR
238 --action snapshot-session ze-session
239
240test_success "--action snapshot-session with file URI" \
64c34630 241 --condition event-rule-matches --domain=user \
b4b7369f
JR
242 --action snapshot-session ze-session --path /hello
243
244test_success "--action snapshot-session with net URI" \
64c34630 245 --condition event-rule-matches --domain=user \
b4b7369f
JR
246 --action snapshot-session ze-session --url net://1.2.3.4
247
248test_success "--action snapshot-session with ctrl/data URIs" \
64c34630 249 --condition event-rule-matches --domain=user \
b4b7369f
JR
250 --action snapshot-session ze-session --ctrl-url=tcp://1.2.3.4:1234 --data-url=tcp://1.2.3.4:1235
251
252# top-level failures
253test_failure "no args" "Error: Missing --condition."
254
255test_failure "unknown option" \
256 "Error: Unknown option \`--hello\`" \
257 --hello
258
259test_failure "missing --action" \
260 "Error: Need at least one --action." \
64c34630 261 --condition event-rule-matches --domain=user
b4b7369f
JR
262
263test_failure "two --condition" \
264 "Error: A --condition was already given." \
64c34630
SM
265 --condition event-rule-matches --name=aaa --domain=user \
266 --condition event-rule-matches --name=bbb --domain=user \
b4b7369f
JR
267 --action notify
268
1d4b59f2
SM
269test_failure "missing argument to --name" \
270 "Error: While parsing argument #1 (\`--name\`): Missing required argument for option \`--name\`" \
271 --name
b4b7369f 272
bbadb5e0 273for cmd in rate-policy=once-after rate-policy=every; do
b4b7369f 274 test_failure "missing argument to --${cmd}" \
bbadb5e0 275 "Error: Rate policy format is invalid." \
64c34630 276 --condition event-rule-matches --domain=user --action notify \
b4b7369f
JR
277 --${cmd}
278
279 test_failure "invalid argument to --${cmd}: non-digit character" \
bbadb5e0 280 "Error: Failed to parse rate policy value \`123bob\` as an integer." \
64c34630 281 --condition event-rule-matches --domain=user --action notify \
bbadb5e0 282 --${cmd}:123bob
b4b7369f
JR
283
284 test_failure "invalid argument to --${cmd}: empty string" \
bbadb5e0 285 "Error: Failed to parse rate policy value \`\` as an integer." \
64c34630 286 --condition event-rule-matches --domain=user --action notify \
bbadb5e0 287 --${cmd}":"
b4b7369f
JR
288done
289
bbadb5e0
JR
290test_failure "invalid argument to --rate-policy: unknown policy type" \
291 "Error: Rate policy type \`bob\` unknown." \
64c34630 292 --condition event-rule-matches --domain=user --action notify \
bbadb5e0
JR
293 --rate-policy=bob:123
294
b4b7369f
JR
295# `--condition` failures
296test_failure "missing args after --condition" \
29bcf415 297 "Error: While parsing argument #1 (\`--condition\`): Missing required argument for option \`--condition\`" \
b4b7369f
JR
298 --condition
299test_failure "unknown --condition" \
300 "Error: Unknown condition name 'zoofest'" \
301 --condition zoofest
302
665db063
SM
303# `--condition event-rule-matches` failures
304test_failure "missing args after --condition event-rule-matches" \
64c34630 305 "Error: Please specify a domain (--domain=(kernel,user,jul,log4j,python))." \
50ad0862
SM
306 --condition event-rule-matches
307
665db063 308test_failure "extra args after --condition event-rule-matches" \
b4b7369f 309 "Error: Unexpected argument 'bozo'" \
64c34630
SM
310 --condition event-rule-matches --domain=user bozo
311
312test_failure "two same --domain" \
313 "Error: More than one \`--domain\` was specified." \
314 --condition event-rule-matches --domain=user --domain=user
315
316test_failure "two different --domain" \
317 "Error: More than one \`--domain\` was specified." \
318 --condition event-rule-matches --domain=user --domain=kernel
b4b7369f 319
24de704e
SM
320for type in kprobe kernel-probe; do
321 test_failure "--condition event-rule-matches: --name with --type=$type" \
322 "Error: Can't use --name with probe event rules." \
323 --condition event-rule-matches --type=$type --location=do_sys_open --name='hello'
324done
325
326test_failure "--condition event-rule-matches: --location with tracepoint event rule" \
327 "Error: Can't use --location with tracepoint event rules." \
328 --condition event-rule-matches --domain=user --location='hello'
b4b7369f 329
24de704e 330test_failure "--condition event-rule-matches: --event-name with tracepoint event rule" \
50ad0862 331 "Error: Can't use --event-name with tracepoint event rules." \
64c34630 332 --condition event-rule-matches --domain=user --event-name='hello'
50ad0862 333
24de704e
SM
334for type in uprobe userspace-probe; do
335 test_failure "--condition event-rule-matches: extra argument with --type=$type" \
336 "Error: Unexpected argument 'hello'" \
337 --condition event-rule-matches --domain=kernel --type=$type --location=${uprobe_elf_binary}:test_failure hello
338done
b4b7369f 339
24de704e 340test_failure "--condition event-rule-matches: extra argument with --type=syscall" \
b4b7369f 341 "Error: Unexpected argument 'open'" \
24de704e 342 --condition event-rule-matches --domain=kernel --type=syscall open
b4b7369f 343
665db063 344test_failure "--condition event-rule-matches --capture: missing argument (end of arg list)" \
50ad0862 345 'Error: While parsing argument #2 (`--capture`): Missing required argument for option `--capture`' \
20a01d15 346 --action notify \
64c34630 347 --condition event-rule-matches --domain=user --capture
20a01d15 348
665db063 349test_failure "--condition event-rule-matches --capture: missing argument (before another option)" \
20a01d15 350 'Error: While parsing expression `--action`: Unary operators are not allowed in capture expressions.' \
64c34630 351 --condition event-rule-matches --domain=user --capture \
20a01d15
SM
352 --action notify \
353
665db063 354test_failure "--condition event-rule-matches --capture: binary operator" \
20a01d15 355 'Error: While parsing expression `foo == 2`: Binary operators are not allowed in capture expressions.' \
64c34630 356 --condition event-rule-matches --domain=user \
20a01d15
SM
357 --capture 'foo == 2' --action notify
358
665db063 359test_failure "--condition event-rule-matches --capture: unary operator" \
20a01d15 360 'Error: While parsing expression `!foo`: Unary operators are not allowed in capture expressions.' \
64c34630 361 --condition event-rule-matches --domain=user \
20a01d15
SM
362 --capture '!foo' --action notify
363
665db063 364test_failure "--condition event-rule-matches --capture: logical operator" \
20a01d15 365 'Error: While parsing expression `foo || bar`: Logical operators are not allowed in capture expressions.' \
64c34630 366 --condition event-rule-matches --domain=user \
20a01d15
SM
367 --capture 'foo || bar' --action notify
368
665db063 369test_failure "--condition event-rule-matches --capture: accessing a sub-field" \
20a01d15 370 'Error: While parsing expression `foo.bar`: Capturing subfields is not supported.' \
64c34630 371 --condition event-rule-matches --domain=user \
20a01d15
SM
372 --capture 'foo.bar' --action notify
373
665db063 374test_failure "--condition event-rule-matches --capture: accessing the sub-field of an array element" \
20a01d15 375 'Error: While parsing expression `foo[3].bar`: Capturing subfields is not supported.' \
64c34630 376 --condition event-rule-matches --domain=user \
20a01d15
SM
377 --capture 'foo[3].bar' --action notify
378
665db063 379test_failure "--condition event-rule-matches --capture: missing colon in app-specific context field" \
20a01d15 380 'Error: Invalid app-specific context field name: missing colon in `foo`.' \
64c34630 381 --condition event-rule-matches --domain=user \
20a01d15
SM
382 --capture '$app.foo' --action notify
383
665db063 384test_failure "--condition event-rule-matches --capture: missing colon in app-specific context field" \
20a01d15 385 'Error: Invalid app-specific context field name: missing type name after colon in `foo:`.' \
64c34630 386 --condition event-rule-matches --domain=user \
20a01d15
SM
387 --capture '$app.foo:' --action notify
388
b4b7369f
JR
389# `--action` failures
390test_failure "missing args after --action" \
29bcf415 391 "Error: While parsing argument #1 (\`--action\`): Missing required argument for option \`--action\`" \
64c34630 392 --condition event-rule-matches --domain=user \
b4b7369f
JR
393 --action
394
395# `--action notify` failures
396test_failure "extra arg after --action notify" \
397 "Error: Unexpected argument \`bob\`." \
64c34630 398 --condition event-rule-matches --domain=user \
b4b7369f
JR
399 --action notify bob
400
401# `--action start-session` failures
402test_failure "missing arg after --action start-session" \
403 "Error: Missing session name." \
64c34630 404 --condition event-rule-matches --domain=user \
b4b7369f
JR
405 --action start-session
406test_failure "extra arg after --action start-session" \
407 "Error: Unexpected argument \`bob\`." \
64c34630 408 --condition event-rule-matches --domain=user \
b4b7369f
JR
409 --action start-session ze-session bob
410
411# `--action stop-session` failures
412test_failure "missing arg after --action stop-session" \
413 "Error: Missing session name." \
64c34630 414 --condition event-rule-matches --domain=user \
b4b7369f
JR
415 --action stop-session
416test_failure "extra arg after --action stop-session" \
417 "Error: Unexpected argument \`bob\`." \
64c34630 418 --condition event-rule-matches --domain=user \
b4b7369f
JR
419 --action stop-session ze-session bob
420
421# `--action rotate-session` failures
422test_failure "missing arg after --action rotate-session" \
423 "Error: Missing session name." \
64c34630 424 --condition event-rule-matches --domain=user \
b4b7369f
JR
425 --action rotate-session
426test_failure "extra arg after --action rotate-session" \
427 "Error: Unexpected argument \`bob\`." \
64c34630 428 --condition event-rule-matches --domain=user \
b4b7369f
JR
429 --action rotate-session ze-session bob
430
431# `--action snapshot-session` failures
432test_failure "missing arg after --action snapshot-session" \
433 "Error: Missing session name." \
64c34630 434 --condition event-rule-matches --domain=user \
b4b7369f
JR
435 --action snapshot-session
436test_failure "extra arg after --action snapshot-session" \
437 "Error: Unexpected argument \`bob\`." \
64c34630 438 --condition event-rule-matches --domain=user \
b4b7369f
JR
439 --action snapshot-session ze-session bob
440test_failure "snapshot-session action, --max-size without destination" \
441 "Error: Can't provide a snapshot output max size without a snapshot output destination." \
64c34630 442 --condition event-rule-matches --domain=user \
b4b7369f
JR
443 --action snapshot-session ze-session --max-size 10M
444test_failure "snapshot-session action, --name without destination" \
445 "Error: Can't provide a snapshot output name without a snapshot output destination." \
64c34630 446 --condition event-rule-matches --domain=user \
b4b7369f
JR
447 --action snapshot-session ze-session --name hallo
448test_failure "snapshot-session action, --name with-local-path-instead-of-url" \
449 "Error: Failed to parse '/something/that/looks/like/a/path' as an URL." \
64c34630 450 --condition event-rule-matches --domain=user \
b4b7369f
JR
451 --action snapshot-session ze-session --name hallo --url /something/that/looks/like/a/path
452test_failure "snapshot-session action, --name with-net-url-instead-of-path" \
453 "Error: Failed to parse 'net://8.8.8.8/' as a local path." \
64c34630 454 --condition event-rule-matches --domain=user \
b4b7369f
JR
455 --action snapshot-session ze-session --name hallo --path net://8.8.8.8/
456
457# Cleanup
458stop_lttng_sessiond_notap
459rm -f "${tmp_stdout}"
460rm -f "${tmp_stderr}"
This page took 0.074962 seconds and 4 git commands to generate.