tests/plugins/flt.utils.trimmer/test_trimming

   1 #!/bin/bash
   2 #
   3 # Copyright (C) 2019 Simon Marchi <simon.marchi@efficios.com>
   4 #
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; only version 2
   8 # of the License.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 # This file tests what happens when we trim at different points in the message
  20 # flow.
  21
  22 SH_TAP=1
  23
  24 if [ "x${BT_TESTS_SRCDIR:-}" != "x" ]; then
  25         UTILSSH="$BT_TESTS_SRCDIR/utils/utils.sh"
  26 else
  27         UTILSSH="$(dirname "$0")/../../utils/utils.sh"
  28 fi
  29
  30 # shellcheck source=../../utils/utils.sh
  31 source "$UTILSSH"
  32
  33 data_dir="$BT_TESTS_DATADIR/plugins/flt.utils.trimmer"
  34 temp_stdout_expected=$(mktemp)
  35 temp_stderr_expected="/dev/null"
  36
  37 plan_tests 32
  38
  39 function run_test
  40 {
  41         local begin_time="$1"
  42         local end_time="$2"
  43         # with_stream_msgs_cs is set to "true" or "false" by the tests.
  44         local local_args=(
  45                 "--plugin-path" "$data_dir"
  46                 "-c" "src.test-trimmer.TheSourceOfAllEvil"
  47                 "-p" "with-stream-msgs-cs=$with_stream_msgs_cs"
  48                 "-c" "sink.text.details"
  49                 "--params=compact=true,with-metadata=false"
  50         )
  51
  52         if [ "$with_stream_msgs_cs" = "true" ]; then
  53                 test_name="with stream message clock snapshots"
  54         else
  55                 test_name="without stream message clock snapshots"
  56         fi
  57
  58         if [ -n "$begin_time" ]; then
  59                 local_args+=("--begin=$begin_time")
  60                 test_name="$test_name, with --begin=$begin_time"
  61         else
  62                 test_name="$test_name, without --begin"
  63         fi
  64
  65         if [ -n "$end_time" ]; then
  66                 local_args+=("--end=$end_time")
  67                 test_name="$test_name, with --end=$end_time"
  68         else
  69                 test_name="$test_name, without --end"
  70         fi
  71
  72         bt_diff_cli "$temp_stdout_expected" "$temp_stderr_expected" "${local_args[@]}"
  73         ok $? "$test_name"
  74 }
  75
  76 function test_with_stream_msg_cs {
  77         with_stream_msgs_cs="true"
  78
  79         # Baseline (without trimming)
  80         cat <<- 'END' > "$temp_stdout_expected"
  81         [100 10,100,000,000,000] {0 0 0} Stream beginning
  82         [200 10,200,000,000,000] {0 0 0} Packet beginning
  83         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
  84         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
  85         [900 10,900,000,000,000] {0 0 0} Packet end
  86         [1000 11,000,000,000,000] {0 0 0} Stream end
  87         END
  88         run_test "" ""
  89
  90         # Trim begin at a time before what the clock class can represent
  91         cat <<- 'END' > "$temp_stdout_expected"
  92         [100 10,100,000,000,000] {0 0 0} Stream beginning
  93         [200 10,200,000,000,000] {0 0 0} Packet beginning
  94         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
  95         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
  96         [900 10,900,000,000,000] {0 0 0} Packet end
  97         [1000 11,000,000,000,000] {0 0 0} Stream end
  98         END
  99         run_test 50 ""
 100
 101         # Trim begin before stream beginning
 102         cat <<- 'END' > "$temp_stdout_expected"
 103         [100 10,100,000,000,000] {0 0 0} Stream beginning
 104         [200 10,200,000,000,000] {0 0 0} Packet beginning
 105         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 106         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 107         [900 10,900,000,000,000] {0 0 0} Packet end
 108         [1000 11,000,000,000,000] {0 0 0} Stream end
 109         END
 110         run_test 10050 ""
 111
 112         # Trim begin before packet beginning
 113         cat <<- 'END' > "$temp_stdout_expected"
 114         [150 10,150,000,000,000] {0 0 0} Stream beginning
 115         [200 10,200,000,000,000] {0 0 0} Packet beginning
 116         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 117         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 118         [900 10,900,000,000,000] {0 0 0} Packet end
 119         [1000 11,000,000,000,000] {0 0 0} Stream end
 120         END
 121         run_test 10150 ""
 122
 123         # Trim begin before first event
 124         cat <<- 'END' > "$temp_stdout_expected"
 125         [250 10,250,000,000,000] {0 0 0} Stream beginning
 126         [250 10,250,000,000,000] {0 0 0} Packet beginning
 127         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 128         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 129         [900 10,900,000,000,000] {0 0 0} Packet end
 130         [1000 11,000,000,000,000] {0 0 0} Stream end
 131         END
 132         run_test 10250 ""
 133
 134         # Trim begin before second event
 135         cat <<- 'END' > "$temp_stdout_expected"
 136         [350 10,350,000,000,000] {0 0 0} Stream beginning
 137         [350 10,350,000,000,000] {0 0 0} Packet beginning
 138         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 139         [900 10,900,000,000,000] {0 0 0} Packet end
 140         [1000 11,000,000,000,000] {0 0 0} Stream end
 141         END
 142
 143         run_test 10350 ""
 144
 145         # Trim begin before packet end
 146         cat <<- 'END' > "$temp_stdout_expected"
 147         [850 10,850,000,000,000] {0 0 0} Stream beginning
 148         [850 10,850,000,000,000] {0 0 0} Packet beginning
 149         [900 10,900,000,000,000] {0 0 0} Packet end
 150         [1000 11,000,000,000,000] {0 0 0} Stream end
 151         END
 152
 153         run_test 10850 ""
 154
 155         # Trim begin after everything
 156         cat <<- 'END' > "$temp_stdout_expected"
 157         END
 158
 159         run_test 11050 ""
 160
 161         # Trim end after stream end
 162         cat <<- 'END' > "$temp_stdout_expected"
 163         [100 10,100,000,000,000] {0 0 0} Stream beginning
 164         [200 10,200,000,000,000] {0 0 0} Packet beginning
 165         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 166         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 167         [900 10,900,000,000,000] {0 0 0} Packet end
 168         [1000 11,000,000,000,000] {0 0 0} Stream end
 169         END
 170
 171         run_test "" 11050
 172
 173         # Trim end after packet end
 174         cat <<- 'END' > "$temp_stdout_expected"
 175         [100 10,100,000,000,000] {0 0 0} Stream beginning
 176         [200 10,200,000,000,000] {0 0 0} Packet beginning
 177         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 178         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 179         [900 10,900,000,000,000] {0 0 0} Packet end
 180         [950 10,950,000,000,000] {0 0 0} Stream end
 181         END
 182
 183         run_test "" 10950
 184
 185         # Trim end after second event
 186         cat <<- 'END' > "$temp_stdout_expected"
 187         [100 10,100,000,000,000] {0 0 0} Stream beginning
 188         [200 10,200,000,000,000] {0 0 0} Packet beginning
 189         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 190         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 191         [450 10,450,000,000,000] {0 0 0} Packet end
 192         [450 10,450,000,000,000] {0 0 0} Stream end
 193         END
 194
 195         run_test "" 10450
 196
 197         # Trim end after first event
 198         cat <<- 'END' > "$temp_stdout_expected"
 199         [100 10,100,000,000,000] {0 0 0} Stream beginning
 200         [200 10,200,000,000,000] {0 0 0} Packet beginning
 201         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 202         [350 10,350,000,000,000] {0 0 0} Packet end
 203         [350 10,350,000,000,000] {0 0 0} Stream end
 204         END
 205
 206         run_test "" 10350
 207
 208         # Trim end after packet beginning
 209         cat <<- 'END' > "$temp_stdout_expected"
 210         [100 10,100,000,000,000] {0 0 0} Stream beginning
 211         [200 10,200,000,000,000] {0 0 0} Packet beginning
 212         [250 10,250,000,000,000] {0 0 0} Packet end
 213         [250 10,250,000,000,000] {0 0 0} Stream end
 214         END
 215
 216         run_test "" 10250
 217
 218         # Trim end after stream beginning
 219         cat <<- 'END' > "$temp_stdout_expected"
 220         [100 10,100,000,000,000] {0 0 0} Stream beginning
 221         [150 10,150,000,000,000] {0 0 0} Stream end
 222         END
 223
 224         run_test "" 10150
 225
 226         # Trim end before everything
 227         cat <<- 'END' > "$temp_stdout_expected"
 228         END
 229
 230         run_test "" 10050
 231
 232         # Trim end at a time before what the clock class can represent
 233         cat <<- 'END' > "$temp_stdout_expected"
 234         END
 235
 236         run_test "" 50
 237 }
 238
 239 function test_without_stream_msg_cs {
 240         with_stream_msgs_cs="false"
 241
 242         # Baseline (without trimming)
 243         cat <<- 'END' > "$temp_stdout_expected"
 244         [Unknown] {0 0 0} Stream beginning
 245         [200 10,200,000,000,000] {0 0 0} Packet beginning
 246         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 247         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 248         [900 10,900,000,000,000] {0 0 0} Packet end
 249         [Unknown] {0 0 0} Stream end
 250         END
 251         run_test "" ""
 252
 253         # Trim begin at a time before what the clock class can represent
 254         cat <<- 'END' > "$temp_stdout_expected"
 255         [Unknown] {0 0 0} Stream beginning
 256         [200 10,200,000,000,000] {0 0 0} Packet beginning
 257         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 258         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 259         [900 10,900,000,000,000] {0 0 0} Packet end
 260         [Unknown] {0 0 0} Stream end
 261         END
 262         run_test 50 ""
 263
 264         # Trim begin before stream beginning
 265         cat <<- 'END' > "$temp_stdout_expected"
 266         [Unknown] {0 0 0} Stream beginning
 267         [200 10,200,000,000,000] {0 0 0} Packet beginning
 268         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 269         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 270         [900 10,900,000,000,000] {0 0 0} Packet end
 271         [Unknown] {0 0 0} Stream end
 272         END
 273         run_test 10050 ""
 274
 275         # Trim begin before packet beginning
 276         cat <<- 'END' > "$temp_stdout_expected"
 277         [Unknown] {0 0 0} Stream beginning
 278         [200 10,200,000,000,000] {0 0 0} Packet beginning
 279         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 280         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 281         [900 10,900,000,000,000] {0 0 0} Packet end
 282         [Unknown] {0 0 0} Stream end
 283         END
 284         run_test 10150 ""
 285
 286         # Trim begin before first event
 287         cat <<- 'END' > "$temp_stdout_expected"
 288         [250 10,250,000,000,000] {0 0 0} Stream beginning
 289         [250 10,250,000,000,000] {0 0 0} Packet beginning
 290         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 291         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 292         [900 10,900,000,000,000] {0 0 0} Packet end
 293         [Unknown] {0 0 0} Stream end
 294         END
 295         run_test 10250 ""
 296
 297         # Trim begin before second event
 298         cat <<- 'END' > "$temp_stdout_expected"
 299         [350 10,350,000,000,000] {0 0 0} Stream beginning
 300         [350 10,350,000,000,000] {0 0 0} Packet beginning
 301         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 302         [900 10,900,000,000,000] {0 0 0} Packet end
 303         [Unknown] {0 0 0} Stream end
 304         END
 305
 306         run_test 10350 ""
 307
 308         # Trim begin before packet end
 309         cat <<- 'END' > "$temp_stdout_expected"
 310         [850 10,850,000,000,000] {0 0 0} Stream beginning
 311         [850 10,850,000,000,000] {0 0 0} Packet beginning
 312         [900 10,900,000,000,000] {0 0 0} Packet end
 313         [Unknown] {0 0 0} Stream end
 314         END
 315
 316         run_test 10850 ""
 317
 318         # Trim begin after everything
 319         cat <<- 'END' > "$temp_stdout_expected"
 320         END
 321
 322         run_test 11050 ""
 323
 324         # Trim end after stream end
 325         cat <<- 'END' > "$temp_stdout_expected"
 326         [Unknown] {0 0 0} Stream beginning
 327         [200 10,200,000,000,000] {0 0 0} Packet beginning
 328         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 329         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 330         [900 10,900,000,000,000] {0 0 0} Packet end
 331         [Unknown] {0 0 0} Stream end
 332         END
 333
 334         run_test "" 11050
 335
 336         # Trim end after packet end
 337         cat <<- 'END' > "$temp_stdout_expected"
 338         [Unknown] {0 0 0} Stream beginning
 339         [200 10,200,000,000,000] {0 0 0} Packet beginning
 340         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 341         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 342         [900 10,900,000,000,000] {0 0 0} Packet end
 343         [Unknown] {0 0 0} Stream end
 344         END
 345
 346         run_test "" 10950
 347
 348         # Trim end after second event
 349         cat <<- 'END' > "$temp_stdout_expected"
 350         [Unknown] {0 0 0} Stream beginning
 351         [200 10,200,000,000,000] {0 0 0} Packet beginning
 352         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 353         [400 10,400,000,000,000] {0 0 0} Event `event 2` (1)
 354         [450 10,450,000,000,000] {0 0 0} Packet end
 355         [450 10,450,000,000,000] {0 0 0} Stream end
 356         END
 357
 358         run_test "" 10450
 359
 360         # Trim end after first event
 361         cat <<- 'END' > "$temp_stdout_expected"
 362         [Unknown] {0 0 0} Stream beginning
 363         [200 10,200,000,000,000] {0 0 0} Packet beginning
 364         [300 10,300,000,000,000] {0 0 0} Event `event 1` (0)
 365         [350 10,350,000,000,000] {0 0 0} Packet end
 366         [350 10,350,000,000,000] {0 0 0} Stream end
 367         END
 368
 369         run_test "" 10350
 370
 371         # Trim end after packet beginning
 372         cat <<- 'END' > "$temp_stdout_expected"
 373         [Unknown] {0 0 0} Stream beginning
 374         [200 10,200,000,000,000] {0 0 0} Packet beginning
 375         [250 10,250,000,000,000] {0 0 0} Packet end
 376         [250 10,250,000,000,000] {0 0 0} Stream end
 377         END
 378
 379         run_test "" 10250
 380
 381         # Trim end after stream beginning
 382         cat <<- 'END' > "$temp_stdout_expected"
 383         [Unknown] {0 0 0} Stream beginning
 384         [Unknown] {0 0 0} Stream end
 385         END
 386
 387         run_test "" 10150
 388
 389         # Trim end before everything
 390         cat <<- 'END' > "$temp_stdout_expected"
 391         [Unknown] {0 0 0} Stream beginning
 392         [Unknown] {0 0 0} Stream end
 393         END
 394
 395         run_test "" 10050
 396
 397         # Trim end at a time before what the clock class can represent
 398         cat <<- 'END' > "$temp_stdout_expected"
 399         [Unknown] {0 0 0} Stream beginning
 400         [Unknown] {0 0 0} Stream end
 401         END
 402
 403         run_test "" 50
 404 }
 405
 406 test_with_stream_msg_cs
 407 test_without_stream_msg_cs
 408
 409 # Do not `rm` $temp_stderr_expected because it's set to `/dev/null` right now
 410 # and that would print an error.
 411 rm -f "$temp_stdout_expected"