git.sur5r.net Git - i3/i3/blob - testcases/t/201-config-parser.t

   1 #!perl
   2 # vim:ts=4:sw=4:expandtab
   3 #
   4 # Please read the following documents before working on tests:
   5 # • http://build.i3wm.org/docs/testsuite.html
   6 #   (or docs/testsuite)
   7 #
   8 # • http://build.i3wm.org/docs/lib-i3test.html
   9 #   (alternatively: perldoc ./testcases/lib/i3test.pm)
  10 #
  11 # • http://build.i3wm.org/docs/ipc.html
  12 #   (or docs/ipc)
  13 #
  14 # • http://onyxneon.com/books/modern_perl/modern_perl_a4.pdf
  15 #   (unless you are already familiar with Perl)
  16 #
  17 # Tests the standalone parser binary to see if it calls the right code when
  18 # confronted with various commands, if it prints proper error messages for
  19 # wrong commands and if it terminates in every case.
  20 #
  21 use i3test i3_autostart => 0;
  22 use IPC::Run qw(run);
  23
  24 sub parser_calls {
  25     my ($command) = @_;
  26
  27     my $stdout;
  28     run [ '../test.config_parser', $command ],
  29         '>/dev/null',
  30         '2>', \$stdout;
  31     # TODO: use a timeout, so that we can error out if it doesn’t terminate
  32
  33     # Filter out all debugging output.
  34     my @lines = split("\n", $stdout);
  35     @lines = grep { not /^# / } @lines;
  36
  37     # The criteria management calls are irrelevant and not what we want to test
  38     # in the first place.
  39     @lines = grep { !(/cfg_criteria_init/ || /cfg_criteria_pop_state/) } @lines;
  40     return join("\n", @lines) . "\n";
  41 }
  42
  43 my $config = <<'EOT';
  44 mode "meh" {
  45     bindsym Mod1 + Shift +   x resize grow
  46     bindcode Mod1+44 resize shrink
  47     bindsym --release Mod1+x exec foo
  48     bindsym --whole-window button3 nop
  49     bindsym --release --whole-window button3 nop
  50     bindsym --border button3 nop
  51     bindsym --release --border button3 nop
  52 }
  53 EOT
  54
  55 my $expected = <<'EOT';
  56 cfg_enter_mode((null), meh)
  57 cfg_mode_binding(bindsym, Mod1,Shift, x, (null), (null), (null), resize grow)
  58 cfg_mode_binding(bindcode, Mod1, 44, (null), (null), (null), resize shrink)
  59 cfg_mode_binding(bindsym, Mod1, x, --release, (null), (null), exec foo)
  60 cfg_mode_binding(bindsym, (null), button3, (null), (null), --whole-window, nop)
  61 cfg_mode_binding(bindsym, (null), button3, --release, (null), --whole-window, nop)
  62 cfg_mode_binding(bindsym, (null), button3, (null), --border, (null), nop)
  63 cfg_mode_binding(bindsym, (null), button3, --release, --border, (null), nop)
  64 EOT
  65
  66 is(parser_calls($config),
  67    $expected,
  68    'mode bindings ok');
  69
  70 ################################################################################
  71 # exec and exec_always
  72 ################################################################################
  73
  74 $config = <<'EOT';
  75 exec geeqie
  76 exec --no-startup-id /tmp/foo.sh
  77 exec_always firefox
  78 exec_always --no-startup-id /tmp/bar.sh
  79 EOT
  80
  81 $expected = <<'EOT';
  82 cfg_exec(exec, (null), geeqie)
  83 cfg_exec(exec, --no-startup-id, /tmp/foo.sh)
  84 cfg_exec(exec_always, (null), firefox)
  85 cfg_exec(exec_always, --no-startup-id, /tmp/bar.sh)
  86 EOT
  87
  88 is(parser_calls($config),
  89    $expected,
  90    'exec okay');
  91
  92 ################################################################################
  93 # for_window
  94 ################################################################################
  95
  96 $config = <<'EOT';
  97 for_window [class="^Chrome"] floating enable
  98 EOT
  99
 100 $expected = <<'EOT';
 101 cfg_criteria_add(class, ^Chrome)
 102 cfg_for_window(floating enable)
 103 EOT
 104
 105 is(parser_calls($config),
 106    $expected,
 107    'for_window okay');
 108
 109 ################################################################################
 110 # assign
 111 ################################################################################
 112
 113 $config = <<'EOT';
 114 assign [class="^Chrome"] 4
 115 assign [class="^Chrome"] named workspace
 116 assign [class="^Chrome"] "quoted named workspace"
 117 assign [class="^Chrome"] → "quoted named workspace"
 118 EOT
 119
 120 $expected = <<'EOT';
 121 cfg_criteria_add(class, ^Chrome)
 122 cfg_assign(4)
 123 cfg_criteria_add(class, ^Chrome)
 124 cfg_assign(named workspace)
 125 cfg_criteria_add(class, ^Chrome)
 126 cfg_assign(quoted named workspace)
 127 cfg_criteria_add(class, ^Chrome)
 128 cfg_assign(quoted named workspace)
 129 EOT
 130
 131 is(parser_calls($config),
 132    $expected,
 133    'for_window okay');
 134
 135 ################################################################################
 136 # floating_minimum_size / floating_maximum_size
 137 ################################################################################
 138
 139 $config = <<'EOT';
 140 floating_minimum_size 80x55
 141 floating_minimum_size 80    x  55
 142 floating_maximum_size 73 x 10
 143 EOT
 144
 145 $expected = <<'EOT';
 146 cfg_floating_minimum_size(80, 55)
 147 cfg_floating_minimum_size(80, 55)
 148 cfg_floating_maximum_size(73, 10)
 149 EOT
 150
 151 is(parser_calls($config),
 152    $expected,
 153    'floating_minimum_size ok');
 154
 155 ################################################################################
 156 # popup_during_fullscreen
 157 ################################################################################
 158
 159 $config = <<'EOT';
 160 popup_during_fullscreen ignore
 161 popup_during_fullscreen leave_fullscreen
 162 popup_during_fullscreen SMArt
 163 EOT
 164
 165 $expected = <<'EOT';
 166 cfg_popup_during_fullscreen(ignore)
 167 cfg_popup_during_fullscreen(leave_fullscreen)
 168 cfg_popup_during_fullscreen(smart)
 169 EOT
 170
 171 is(parser_calls($config),
 172    $expected,
 173    'popup_during_fullscreen ok');
 174
 175
 176 ################################################################################
 177 # floating_modifier
 178 ################################################################################
 179
 180 $config = <<'EOT';
 181 floating_modifier Mod1
 182 floating_modifier mOd1
 183 EOT
 184
 185 $expected = <<'EOT';
 186 cfg_floating_modifier(Mod1)
 187 cfg_floating_modifier(Mod1)
 188 EOT
 189
 190 is(parser_calls($config),
 191    $expected,
 192    'floating_modifier ok');
 193
 194 ################################################################################
 195 # default_orientation
 196 ################################################################################
 197
 198 $config = <<'EOT';
 199 default_orientation horizontal
 200 default_orientation vertical
 201 default_orientation auto
 202 EOT
 203
 204 $expected = <<'EOT';
 205 cfg_default_orientation(horizontal)
 206 cfg_default_orientation(vertical)
 207 cfg_default_orientation(auto)
 208 EOT
 209
 210 is(parser_calls($config),
 211    $expected,
 212    'default_orientation ok');
 213
 214 ################################################################################
 215 # workspace_layout
 216 ################################################################################
 217
 218 $config = <<'EOT';
 219 workspace_layout default
 220 workspace_layout stacked
 221 workspace_layout stacking
 222 workspace_layout tabbed
 223 EOT
 224
 225 $expected = <<'EOT';
 226 cfg_workspace_layout(default)
 227 cfg_workspace_layout(stacked)
 228 cfg_workspace_layout(stacking)
 229 cfg_workspace_layout(tabbed)
 230 EOT
 231
 232 is(parser_calls($config),
 233    $expected,
 234    'workspace_layout ok');
 235
 236 ################################################################################
 237 # workspace assignments, with trailing whitespace (ticket #921)
 238 ################################################################################
 239
 240 $config = <<'EOT';
 241 workspace "3" output DP-1
 242 workspace "3" output            VGA-1
 243 EOT
 244
 245 $expected = <<'EOT';
 246 cfg_workspace(3, DP-1)
 247 cfg_workspace(3, VGA-1)
 248 EOT
 249
 250 is(parser_calls($config),
 251    $expected,
 252    'workspace assignment ok');
 253
 254 ################################################################################
 255 # new_window
 256 ################################################################################
 257
 258 $config = <<'EOT';
 259 new_window 1pixel
 260 new_window normal
 261 new_window none
 262 new_float 1pixel
 263 new_float normal
 264 new_float none
 265 EOT
 266
 267 $expected = <<'EOT';
 268 cfg_new_window(new_window, 1pixel, -1)
 269 cfg_new_window(new_window, normal, 2)
 270 cfg_new_window(new_window, none, -1)
 271 cfg_new_window(new_float, 1pixel, -1)
 272 cfg_new_window(new_float, normal, 2)
 273 cfg_new_window(new_float, none, -1)
 274 EOT
 275
 276 is(parser_calls($config),
 277    $expected,
 278    'new_window ok');
 279
 280 ################################################################################
 281 # hide_edge_borders
 282 ################################################################################
 283
 284 $config = <<'EOT';
 285 hide_edge_borders none
 286 hide_edge_borders vertical
 287 hide_edge_borders horizontal
 288 hide_edge_borders both
 289 EOT
 290
 291 $expected = <<'EOT';
 292 cfg_hide_edge_borders(none)
 293 cfg_hide_edge_borders(vertical)
 294 cfg_hide_edge_borders(horizontal)
 295 cfg_hide_edge_borders(both)
 296 EOT
 297
 298 is(parser_calls($config),
 299    $expected,
 300    'hide_edge_borders ok');
 301
 302 ################################################################################
 303 # focus_follows_mouse
 304 ################################################################################
 305
 306 $config = <<'EOT';
 307 focus_follows_mouse yes
 308 focus_follows_mouse no
 309 EOT
 310
 311 $expected = <<'EOT';
 312 cfg_focus_follows_mouse(yes)
 313 cfg_focus_follows_mouse(no)
 314 EOT
 315
 316 is(parser_calls($config),
 317    $expected,
 318    'focus_follows_mouse ok');
 319
 320 ################################################################################
 321 # mouse_warping
 322 ################################################################################
 323
 324 $config = <<'EOT';
 325 mouse_warping output
 326 mouse_warping none
 327 EOT
 328
 329 $expected = <<'EOT';
 330 cfg_mouse_warping(output)
 331 cfg_mouse_warping(none)
 332 EOT
 333
 334 is(parser_calls($config),
 335    $expected,
 336    'mouse_warping ok');
 337
 338 ################################################################################
 339 # force_display_urgency_hint
 340 ################################################################################
 341
 342 is(parser_calls('force_display_urgency_hint 300'),
 343    "cfg_force_display_urgency_hint(300)\n",
 344    'force_display_urgency_hint ok');
 345
 346 is(parser_calls('force_display_urgency_hint 500 ms'),
 347    "cfg_force_display_urgency_hint(500)\n",
 348    'force_display_urgency_hint ok');
 349
 350 is(parser_calls('force_display_urgency_hint 700ms'),
 351    "cfg_force_display_urgency_hint(700)\n",
 352    'force_display_urgency_hint ok');
 353
 354 $config = <<'EOT';
 355 force_display_urgency_hint 300
 356 force_display_urgency_hint 500 ms
 357 force_display_urgency_hint 700ms
 358 force_display_urgency_hint 700
 359 EOT
 360
 361 $expected = <<'EOT';
 362 cfg_force_display_urgency_hint(300)
 363 cfg_force_display_urgency_hint(500)
 364 cfg_force_display_urgency_hint(700)
 365 cfg_force_display_urgency_hint(700)
 366 EOT
 367
 368 is(parser_calls($config),
 369    $expected,
 370    'force_display_urgency_hint ok');
 371
 372 ################################################################################
 373 # workspace
 374 ################################################################################
 375
 376 $config = <<'EOT';
 377 workspace 3 output VGA-1
 378 workspace "4: output" output VGA-2
 379 workspace bleh output LVDS1/I_1
 380 EOT
 381
 382 $expected = <<'EOT';
 383 cfg_workspace(3, VGA-1)
 384 cfg_workspace(4: output, VGA-2)
 385 cfg_workspace(bleh, LVDS1/I_1)
 386 EOT
 387
 388 is(parser_calls($config),
 389    $expected,
 390    'workspace ok');
 391
 392 ################################################################################
 393 # ipc-socket
 394 ################################################################################
 395
 396 $config = <<'EOT';
 397 ipc-socket /tmp/i3.sock
 398 ipc_socket ~/.i3/i3.sock
 399 EOT
 400
 401 $expected = <<'EOT';
 402 cfg_ipc_socket(/tmp/i3.sock)
 403 cfg_ipc_socket(~/.i3/i3.sock)
 404 EOT
 405
 406 is(parser_calls($config),
 407    $expected,
 408    'ipc-socket ok');
 409
 410 ################################################################################
 411 # colors
 412 ################################################################################
 413
 414 $config = <<'EOT';
 415 client.focused          #4c7899 #285577 #ffffff #2e9ef4 #b34d4c
 416 client.focused_inactive #333333 #5f676a #ffffff #484e50
 417 client.unfocused        #333333 #222222 #888888 #292d2e
 418 client.urgent           #2f343a #900000 #ffffff #900000 #c00000
 419 client.placeholder      #000000 #0c0c0c #ffffff #000000
 420 EOT
 421
 422 $expected = <<'EOT';
 423 cfg_color(client.focused, #4c7899, #285577, #ffffff, #2e9ef4, #b34d4c)
 424 cfg_color(client.focused_inactive, #333333, #5f676a, #ffffff, #484e50, NULL)
 425 cfg_color(client.unfocused, #333333, #222222, #888888, #292d2e, NULL)
 426 cfg_color(client.urgent, #2f343a, #900000, #ffffff, #900000, #c00000)
 427 cfg_color(client.placeholder, #000000, #0c0c0c, #ffffff, #000000, NULL)
 428 EOT
 429
 430 is(parser_calls($config),
 431    $expected,
 432    'colors ok');
 433
 434 ################################################################################
 435 # Verify that errors don’t harm subsequent valid statements
 436 ################################################################################
 437
 438 $config = <<'EOT';
 439 hide_edge_border both
 440 client.focused          #4c7899 #285577 #ffffff #2e9ef4
 441 EOT
 442
 443 my $expected_all_tokens = <<'EOT';
 444 ERROR: CONFIG: Expected one of these tokens: <end>, '#', 'set', 'set_from_resource', 'bindsym', 'bindcode', 'bind', 'bar', 'font', 'mode', 'floating_minimum_size', 'floating_maximum_size', 'floating_modifier', 'default_orientation', 'workspace_layout', 'new_window', 'new_float', 'hide_edge_borders', 'for_window', 'assign', 'no_focus', 'focus_follows_mouse', 'mouse_warping', 'force_focus_wrapping', 'force_xinerama', 'force-xinerama', 'workspace_auto_back_and_forth', 'fake_outputs', 'fake-outputs', 'force_display_urgency_hint', 'focus_on_window_activation', 'show_marks', 'workspace', 'ipc_socket', 'ipc-socket', 'restart_state', 'popup_during_fullscreen', 'exec_always', 'exec', 'client.background', 'client.focused_inactive', 'client.focused', 'client.unfocused', 'client.urgent', 'client.placeholder'
 445 EOT
 446
 447 my $expected_end = <<'EOT';
 448 ERROR: CONFIG: (in file <stdin>)
 449 ERROR: CONFIG: Line   1: hide_edge_border both
 450 ERROR: CONFIG:           ^^^^^^^^^^^^^^^^^^^^^
 451 ERROR: CONFIG: Line   2: client.focused          #4c7899 #285577 #ffffff #2e9ef4
 452 cfg_color(client.focused, #4c7899, #285577, #ffffff, #2e9ef4, NULL)
 453 EOT
 454
 455 $expected = $expected_all_tokens . $expected_end;
 456
 457 is(parser_calls($config),
 458    $expected,
 459    'errors dont harm subsequent statements');
 460
 461 $config = <<'EOT';
 462 hide_edge_borders FOOBAR
 463 client.focused          #4c7899 #285577 #ffffff #2e9ef4
 464 EOT
 465
 466 $expected = <<'EOT';
 467 ERROR: CONFIG: Expected one of these tokens: 'none', 'vertical', 'horizontal', 'both', '1', 'yes', 'true', 'on', 'enable', 'active'
 468 ERROR: CONFIG: (in file <stdin>)
 469 ERROR: CONFIG: Line   1: hide_edge_borders FOOBAR
 470 ERROR: CONFIG:                             ^^^^^^
 471 ERROR: CONFIG: Line   2: client.focused          #4c7899 #285577 #ffffff #2e9ef4
 472 cfg_color(client.focused, #4c7899, #285577, #ffffff, #2e9ef4, NULL)
 473 EOT
 474
 475 is(parser_calls($config),
 476    $expected,
 477    'errors dont harm subsequent statements');
 478
 479 ################################################################################
 480 # Regression: semicolons end comments, but shouldn’t
 481 ################################################################################
 482
 483 $config = <<'EOT';
 484 # "foo" client.focused          #4c7899 #285577 #ffffff #2e9ef4
 485 EOT
 486
 487 $expected = <<'EOT';
 488
 489 EOT
 490
 491 is(parser_calls($config),
 492    $expected,
 493    'semicolon does not end a comment line');
 494
 495 ################################################################################
 496 # Error message with 2+2 lines of context
 497 ################################################################################
 498
 499 $config = <<'EOT';
 500 # i3 config file (v4)
 501
 502 font foobar
 503
 504 unknown qux
 505
 506 # yay
 507 # this should not show up
 508 EOT
 509
 510 my $expected_head = <<'EOT';
 511 cfg_font(foobar)
 512 EOT
 513
 514 my $expected_tail = <<'EOT';
 515 ERROR: CONFIG: (in file <stdin>)
 516 ERROR: CONFIG: Line   3: font foobar
 517 ERROR: CONFIG: Line   4:
 518 ERROR: CONFIG: Line   5: unknown qux
 519 ERROR: CONFIG:           ^^^^^^^^^^^
 520 ERROR: CONFIG: Line   6:
 521 ERROR: CONFIG: Line   7: # yay
 522 EOT
 523
 524 $expected = $expected_head . $expected_all_tokens . $expected_tail;
 525
 526 is(parser_calls($config),
 527    $expected,
 528    'error message (2+2 context) ok');
 529
 530 ################################################################################
 531 # Error message with 0+0 lines of context
 532 ################################################################################
 533
 534 $config = <<'EOT';
 535 unknown qux
 536 EOT
 537
 538 $expected_tail = <<'EOT';
 539 ERROR: CONFIG: (in file <stdin>)
 540 ERROR: CONFIG: Line   1: unknown qux
 541 ERROR: CONFIG:           ^^^^^^^^^^^
 542 EOT
 543
 544 $expected = $expected_all_tokens . $expected_tail;
 545
 546 is(parser_calls($config),
 547    $expected,
 548    'error message (0+0 context) ok');
 549
 550 ################################################################################
 551 # Error message with 1+0 lines of context
 552 ################################################################################
 553
 554 $config = <<'EOT';
 555 # context before
 556 unknown qux
 557 EOT
 558
 559 $expected_tail = <<'EOT';
 560 ERROR: CONFIG: (in file <stdin>)
 561 ERROR: CONFIG: Line   1: # context before
 562 ERROR: CONFIG: Line   2: unknown qux
 563 ERROR: CONFIG:           ^^^^^^^^^^^
 564 EOT
 565
 566 $expected = $expected_all_tokens . $expected_tail;
 567
 568 is(parser_calls($config),
 569    $expected,
 570    'error message (1+0 context) ok');
 571
 572 ################################################################################
 573 # Error message with 0+1 lines of context
 574 ################################################################################
 575
 576 $config = <<'EOT';
 577 unknown qux
 578 # context after
 579 EOT
 580
 581 $expected_tail = <<'EOT';
 582 ERROR: CONFIG: (in file <stdin>)
 583 ERROR: CONFIG: Line   1: unknown qux
 584 ERROR: CONFIG:           ^^^^^^^^^^^
 585 ERROR: CONFIG: Line   2: # context after
 586 EOT
 587
 588 $expected = $expected_all_tokens . $expected_tail;
 589
 590 is(parser_calls($config),
 591    $expected,
 592    'error message (0+1 context) ok');
 593
 594 ################################################################################
 595 # Error message with 0+2 lines of context
 596 ################################################################################
 597
 598 $config = <<'EOT';
 599 unknown qux
 600 # context after
 601 # context 2 after
 602 EOT
 603
 604 $expected_tail = <<'EOT';
 605 ERROR: CONFIG: (in file <stdin>)
 606 ERROR: CONFIG: Line   1: unknown qux
 607 ERROR: CONFIG:           ^^^^^^^^^^^
 608 ERROR: CONFIG: Line   2: # context after
 609 ERROR: CONFIG: Line   3: # context 2 after
 610 EOT
 611
 612 $expected = $expected_all_tokens . $expected_tail;
 613
 614 is(parser_calls($config),
 615    $expected,
 616    'error message (0+2 context) ok');
 617
 618 ################################################################################
 619 # Error message within mode blocks
 620 ################################################################################
 621
 622 $config = <<'EOT';
 623 mode "yo" {
 624     bindsym x resize shrink left
 625     unknown qux
 626 }
 627 EOT
 628
 629 $expected = <<'EOT';
 630 cfg_enter_mode((null), yo)
 631 cfg_mode_binding(bindsym, (null), x, (null), (null), (null), resize shrink left)
 632 ERROR: CONFIG: Expected one of these tokens: <end>, '#', 'set', 'bindsym', 'bindcode', 'bind', '}'
 633 ERROR: CONFIG: (in file <stdin>)
 634 ERROR: CONFIG: Line   1: mode "yo" {
 635 ERROR: CONFIG: Line   2:     bindsym x resize shrink left
 636 ERROR: CONFIG: Line   3:     unknown qux
 637 ERROR: CONFIG:               ^^^^^^^^^^^
 638 ERROR: CONFIG: Line   4: }
 639 EOT
 640
 641 is(parser_calls($config),
 642    $expected,
 643    'error message (mode block) ok');
 644
 645 ################################################################################
 646 # Error message within bar blocks
 647 ################################################################################
 648
 649 $config = <<'EOT';
 650 bar {
 651     output LVDS-1
 652     unknown qux
 653 }
 654 EOT
 655
 656 $expected = <<'EOT';
 657 cfg_bar_start()
 658 cfg_bar_output(LVDS-1)
 659 ERROR: CONFIG: Expected one of these tokens: <end>, '#', 'set', 'i3bar_command', 'status_command', 'socket_path', 'mode', 'hidden_state', 'id', 'modifier', 'wheel_up_cmd', 'wheel_down_cmd', 'bindsym', 'position', 'output', 'tray_output', 'tray_padding', 'font', 'separator_symbol', 'binding_mode_indicator', 'workspace_buttons', 'strip_workspace_numbers', 'verbose', 'colors', '}'
 660 ERROR: CONFIG: (in file <stdin>)
 661 ERROR: CONFIG: Line   1: bar {
 662 ERROR: CONFIG: Line   2:     output LVDS-1
 663 ERROR: CONFIG: Line   3:     unknown qux
 664 ERROR: CONFIG:               ^^^^^^^^^^^
 665 ERROR: CONFIG: Line   4: }
 666 cfg_bar_finish()
 667 EOT
 668
 669 is(parser_calls($config),
 670    $expected,
 671    'error message (bar block) ok');
 672
 673 done_testing;