3 # SPDX-License-Identifier: GPL-2.0-only
5 # Copyright (C) 2020 Geneviève Bastien <gbastien@versatic.net>
7 # This file tests pretty printing in details some event classes that are
8 # not all covered by the main babeltrace tests with traces.
11 if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then
12 UTILSSH
="$BT_TESTS_SRCDIR/utils/utils.sh"
14 UTILSSH
="$(dirname "$0")/../../utils/utils.sh"
17 # shellcheck source=../../utils/utils.sh
20 data_dir
="$BT_TESTS_DATADIR/plugins/sink.text.pretty"
21 temp_stdout_expected_file
=$
(mktemp
-t test_pretty_expected_stdout.XXXXXX
)
22 temp_stderr_expected
="/dev/null"
26 function compare_enum_sorted
28 local expected_file
="$1"
29 local actual_file
="$2"
31 # The order in which enum labels are printed by a `sink.text.pretty`
32 # component directly depends on the order in which mappings were added
33 # to the enum field class in the source component. This order should
34 # not be relied on when testing. Relying on it caused problems with
35 # Python component classes because different versions of Python sort
36 # data structures differently (e.g. dictionaries are insertion sorted
39 run_python_bt2
"${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/split_sort_compare.py" \
40 "$(cat $expected_file)" "$(cat $actual_file)"
46 local expected_to_fail
="$2"
48 local expected_stdout_file
="$4"
50 local actual_stdout_file
51 local actual_stderr_file
54 "--plugin-path" "$data_dir"
55 "-c" "src.test-pretty.TheSourceOfProblems"
56 "-p" "enum-values=\"$enum_values\""
58 "-p" "enum-signed=$enum_signed"
59 "-c" "sink.text.pretty"
60 "-p" "print-enum-flags=true"
63 actual_stdout_file
="$(mktemp -t actual_pretty_stdout.XXXXXX)"
64 actual_stderr_file
="$(mktemp -t actual_pretty_stderr.XXXXXX)"
66 bt_cli
"$actual_stdout_file" "$actual_stderr_file" "${local_args[@]}"
68 compare_enum_sorted
"$expected_stdout_file" "$actual_stdout_file"
71 bt_diff
/dev
/null
"$actual_stderr_file"
74 if ((ret_stdout
!= 0 || ret_stderr
!= 0)); then
78 rm -f "$actual_stdout_file" "$actual_stderr_file"
80 if (($expected_to_fail)); then
81 isnt
$ret 0 "$test_name signed=$enum_signed with value=$value doesn't match as expected"
83 ok
$ret "$test_name signed=$enum_signed with value=$value matches"
88 function test_normal_enum
{
89 test_name
="Normal enum"
91 enum_values
="single,1,1 single2,2,2 single3,4,4 range,4,8 range2,15,20"
94 cat <<- 'END' > "$temp_stdout_expected_file"
95 with_enum: { enum_field = ( "single" : container = 1 ) }
97 run_test "$test_name" 0 1 "$temp_stdout_expected_file"
100 cat <<- 'END' > "$temp_stdout_expected_file"
101 with_enum: { enum_field = ( "range" : container = 7 ) }
103 run_test "$test_name" 0 7 "$temp_stdout_expected_file"
105 # Hit a range and a value
106 cat <<- 'END' > "$temp_stdout_expected_file"
107 with_enum: { enum_field = ( { "single3", "range" } : container = 4 ) }
109 run_test "$test_name" 0 4 "$temp_stdout_expected_file"
111 # Hit a range and a value
112 cat <<- 'END' > "$temp_stdout_expected_file"
113 with_enum: { enum_field = ( { "NOT_A_LABEL", "DOESNT_EXIST" } : container = 4 ) }
115 run_test "$test_name" 1 4 "$temp_stdout_expected_file"
118 cat <<- 'END' > "$temp_stdout_expected_file"
119 with_enum: { enum_field = ( <unknown> : container = 21 ) }
121 run_test "$test_name" 0 21 "$temp_stdout_expected_file"
123 # Unknown but with bits with a value, but range larger than 1 element
124 cat <<- 'END' > "$temp_stdout_expected_file"
125 with_enum: { enum_field = ( <unknown> : container = 12 ) }
127 run_test "$test_name" 0 12 "$temp_stdout_expected_file"
130 cat <<- 'END' > "$temp_stdout_expected_file"
131 with_enum: { enum_field = ( <unknown> : container = 0 ) }
133 run_test "$test_name" 0 0 "$temp_stdout_expected_file"
136 function test_normal_enum_negative {
137 test_name="Normal enum with negative value"
139 enum_values="zero,0,0 single,1,1 single2,2,2 single3,4,4 range,4,8 negative,-1,-1 rangeNegative,-6,-2"
141 # Hit a single negative value
142 cat <<- 'END' > "$temp_stdout_expected_file"
143 with_enum: { enum_field = ( "negative" : container = -1 ) }
145 run_test "$test_name" 0 -1 "$temp_stdout_expected_file"
147 # Hit a single negative range
148 cat <<- 'END' > "$temp_stdout_expected_file"
149 with_enum: { enum_field = ( "rangeNegative" : container = -6 ) }
151 run_test "$test_name" 0 -6 "$temp_stdout_expected_file"
154 cat <<- 'END' > "$temp_stdout_expected_file"
155 with_enum: { enum_field = ( <unknown> : container = -7 ) }
157 run_test "$test_name" 0 -7 "$temp_stdout_expected_file"
160 cat <<- 'END' > "$temp_stdout_expected_file"
161 with_enum: { enum_field = ( "zero" : container = 0 ) }
163 run_test "$test_name" 0 0 "$temp_stdout_expected_file"
166 function test_bit_flag_enum {
167 test_name="Bit flag enum"
169 enum_values="bit0,1,1 bit0bis,1,1 bit1,2,2 bit3,4,4 bit4,8,8 bit5,16,16 bit5,32,32"
172 cat <<- 'END' > "$temp_stdout_expected_file"
173 with_enum: { enum_field = ( "bit1" : container = 2 ) }
175 run_test "$test_name" 0 2 "$temp_stdout_expected_file"
178 cat <<- 'END' > "$temp_stdout_expected_file"
179 with_enum: { enum_field = ( "bit3" | "bit4" : container = 12 ) }
181 run_test "$test_name" 0 12 "$temp_stdout_expected_file"
184 cat <<- 'END' > "$temp_stdout_expected_file"
185 with_enum: { enum_field = ( <unknown> : container = 68 ) }
187 run_test "$test_name" 0 68 "$temp_stdout_expected_file"
189 # Multiple labels for bit 0
190 cat <<- 'END' > "$temp_stdout_expected_file"
191 with_enum: { enum_field = ( { "bit0", "bit0bis" } : container = 1 ) }
193 run_test "$test_name" 0 1 "$temp_stdout_expected_file"
195 # Two labels for bit 0 and one label for bit 1
196 cat <<- 'END' > "$temp_stdout_expected_file"
197 with_enum: { enum_field = ( { "bit0", "bit0bis" } | "bit1" : container = 3 ) }
199 run_test "$test_name" 0 3 "$temp_stdout_expected_file"
201 # Single label for bit 0
202 cat <<- 'END' > "$temp_stdout_expected_file"
203 with_enum: { enum_field = ( "bit5" | "bit5" : container = 48 ) }
205 run_test "$test_name" 0 48 "$temp_stdout_expected_file"
209 cat <<- 'END' > "$temp_stdout_expected_file"
210 with_enum: { enum_field = ( <unknown> : container = -1 ) }
212 run_test "$test_name" 0 -1 "$temp_stdout_expected_file"
215 function test_mixed_enum {
216 test_name="Mixed enum bits at beginning"
218 enum_values="bit0,1,1 bit1,2,2 bit2,4,4 bit3,8,8 bit4,16,16 range,32,44 singleValue,45,45"
220 # Value with bit fields
221 cat <<- 'END' > "$temp_stdout_expected_file"
222 with_enum: { enum_field = ( "bit0" | "bit1" | "bit2" | "bit3" | "bit4" : container = 31 ) }
224 run_test "$test_name" 0 31 "$temp_stdout_expected_file"
226 # A value with some bit flags set, but within another range
227 cat <<- 'END' > "$temp_stdout_expected_file"
228 with_enum: { enum_field = ( "range" : container = 36 ) }
230 run_test "$test_name" 0 36 "$temp_stdout_expected_file"
232 # A value with some bit flags set, but corresponding to another value
233 cat <<- 'END' > "$temp_stdout_expected_file"
234 with_enum: { enum_field = ( "singleValue" : container = 45 ) }
236 run_test "$test_name" 0 45 "$temp_stdout_expected_file"
238 # Value above the ranges
239 cat <<- 'END' > "$temp_stdout_expected_file"
240 with_enum: { enum_field = ( <unknown> : container = 46 ) }
242 run_test "$test_name" 0 46 "$temp_stdout_expected_file"
244 # Since low values are often powers of 2, they may be considered bit flags too
245 test_name="Mixed enum bits at end"
247 enum_values="val1,1,1 val2,2,2 val3,3,3 val4,4,4 val5,5,5 bit3,8,8 bit4,16,16 bit5,32,32"
249 # Value with bit fields
250 cat <<- 'END' > "$temp_stdout_expected_file"
251 with_enum: { enum_field = ( "bit4" : container = 16 ) }
253 run_test "$test_name" 0 16 "$temp_stdout_expected_file"
255 # Value with a bit field set both at beginning and end
256 cat <<- 'END' > "$temp_stdout_expected_file"
257 with_enum: { enum_field = ( "val1" | "bit4" : container = 17 ) }
259 run_test "$test_name" 0 17 "$temp_stdout_expected_file"
263 test_normal_enum "false"
264 test_normal_enum "true"
265 test_normal_enum_negative
269 # Do not `rm` $temp_stderr_expected because it's set to `/dev/null` right now
270 # and that would print an error.
271 rm -f "$temp_stdout_expected_file"