2 # vim:ts=4:sw=4:expandtab
4 # Please read the following documents before working on tests:
5 # • https://build.i3wm.org/docs/testsuite.html
8 # • https://build.i3wm.org/docs/lib-i3test.html
9 # (alternatively: perldoc ./testcases/lib/i3test.pm)
11 # • https://build.i3wm.org/docs/ipc.html
14 # • http://onyxneon.com/books/modern_perl/modern_perl_a4.pdf
15 # (unless you are already familiar with Perl)
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.
21 use i3test i3_autostart => 0;
28 run [ 'test.config_parser', $command ],
31 # TODO: use a timeout, so that we can error out if it doesn’t terminate
33 # Filter out all debugging output.
34 my @lines = split("\n", $stdout);
35 @lines = grep { not /^# / } @lines;
37 # The criteria management calls are irrelevant and not what we want to test
39 @lines = grep { !(/cfg_criteria_init/ || /cfg_criteria_pop_state/) } @lines;
40 return join("\n", @lines) . "\n";
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 bindsym --exclude-titlebar button3 nop
53 bindsym --whole-window --border --exclude-titlebar button3 nop
57 my $expected = <<'EOT';
58 cfg_enter_mode((null), meh)
59 cfg_mode_binding(bindsym, Mod1,Shift, x, (null), (null), (null), (null), resize grow)
60 cfg_mode_binding(bindcode, Mod1, 44, (null), (null), (null), (null), resize shrink)
61 cfg_mode_binding(bindsym, Mod1, x, --release, (null), (null), (null), exec foo)
62 cfg_mode_binding(bindsym, (null), button3, (null), (null), --whole-window, (null), nop)
63 cfg_mode_binding(bindsym, (null), button3, --release, (null), --whole-window, (null), nop)
64 cfg_mode_binding(bindsym, (null), button3, (null), --border, (null), (null), nop)
65 cfg_mode_binding(bindsym, (null), button3, --release, --border, (null), (null), nop)
66 cfg_mode_binding(bindsym, (null), button3, (null), (null), (null), --exclude-titlebar, nop)
67 cfg_mode_binding(bindsym, (null), button3, (null), --border, --whole-window, --exclude-titlebar, nop)
70 is(parser_calls($config),
74 ################################################################################
75 # exec and exec_always
76 ################################################################################
80 exec --no-startup-id /tmp/foo.sh
82 exec_always --no-startup-id /tmp/bar.sh
86 cfg_exec(exec, (null), geeqie)
87 cfg_exec(exec, --no-startup-id, /tmp/foo.sh)
88 cfg_exec(exec_always, (null), firefox)
89 cfg_exec(exec_always, --no-startup-id, /tmp/bar.sh)
92 is(parser_calls($config),
96 ################################################################################
98 ################################################################################
101 for_window [class="^Chrome"] floating enable
105 cfg_criteria_add(class, ^Chrome)
106 cfg_for_window(floating enable)
109 is(parser_calls($config),
113 ################################################################################
115 ################################################################################
118 assign [class="^Chrome"] 4
119 assign [class="^Chrome"] workspace number 3
120 assign [class="^Chrome"] named workspace
121 assign [class="^Chrome"] "quoted named workspace"
122 assign [class="^Chrome"] → "quoted named workspace"
126 cfg_criteria_add(class, ^Chrome)
128 cfg_criteria_add(class, ^Chrome)
130 cfg_criteria_add(class, ^Chrome)
131 cfg_assign(named workspace, 0)
132 cfg_criteria_add(class, ^Chrome)
133 cfg_assign(quoted named workspace, 0)
134 cfg_criteria_add(class, ^Chrome)
135 cfg_assign(quoted named workspace, 0)
138 is(parser_calls($config),
142 ################################################################################
143 # floating_minimum_size / floating_maximum_size
144 ################################################################################
147 floating_minimum_size 80x55
148 floating_minimum_size 80 x 55
149 floating_maximum_size 73 x 10
153 cfg_floating_minimum_size(80, 55)
154 cfg_floating_minimum_size(80, 55)
155 cfg_floating_maximum_size(73, 10)
158 is(parser_calls($config),
160 'floating_minimum_size ok');
162 ################################################################################
163 # popup_during_fullscreen
164 ################################################################################
167 popup_during_fullscreen ignore
168 popup_during_fullscreen leave_fullscreen
169 popup_during_fullscreen SMArt
173 cfg_popup_during_fullscreen(ignore)
174 cfg_popup_during_fullscreen(leave_fullscreen)
175 cfg_popup_during_fullscreen(smart)
178 is(parser_calls($config),
180 'popup_during_fullscreen ok');
183 ################################################################################
185 ################################################################################
188 floating_modifier Mod1
189 floating_modifier mOd1
193 cfg_floating_modifier(Mod1)
194 cfg_floating_modifier(Mod1)
197 is(parser_calls($config),
199 'floating_modifier ok');
201 ################################################################################
202 # default_orientation
203 ################################################################################
206 default_orientation horizontal
207 default_orientation vertical
208 default_orientation auto
212 cfg_default_orientation(horizontal)
213 cfg_default_orientation(vertical)
214 cfg_default_orientation(auto)
217 is(parser_calls($config),
219 'default_orientation ok');
221 ################################################################################
223 ################################################################################
226 workspace_layout default
227 workspace_layout stacked
228 workspace_layout stacking
229 workspace_layout tabbed
233 cfg_workspace_layout(default)
234 cfg_workspace_layout(stacked)
235 cfg_workspace_layout(stacking)
236 cfg_workspace_layout(tabbed)
239 is(parser_calls($config),
241 'workspace_layout ok');
243 ################################################################################
244 # workspace assignments, with trailing whitespace (ticket #921)
245 ################################################################################
248 workspace "3" output DP-1
249 workspace "3" output VGA-1
253 cfg_workspace(3, DP-1)
254 cfg_workspace(3, VGA-1)
257 is(parser_calls($config),
259 'workspace assignment ok');
261 ################################################################################
263 ################################################################################
269 default_border 1pixel
270 default_border normal
275 default_floating_border 1pixel
276 default_floating_border normal
277 default_floating_border none
281 cfg_default_border(new_window, 1pixel, -1)
282 cfg_default_border(new_window, normal, 2)
283 cfg_default_border(new_window, none, -1)
284 cfg_default_border(default_border, 1pixel, -1)
285 cfg_default_border(default_border, normal, 2)
286 cfg_default_border(default_border, none, -1)
287 cfg_default_border(new_float, 1pixel, -1)
288 cfg_default_border(new_float, normal, 2)
289 cfg_default_border(new_float, none, -1)
290 cfg_default_border(default_floating_border, 1pixel, -1)
291 cfg_default_border(default_floating_border, normal, 2)
292 cfg_default_border(default_floating_border, none, -1)
295 # TODO: are there no tests for "border pixel 1" etc?
297 is(parser_calls($config),
301 ################################################################################
303 ################################################################################
306 hide_edge_borders none
307 hide_edge_borders vertical
308 hide_edge_borders horizontal
309 hide_edge_borders both
310 hide_edge_borders smart
314 cfg_hide_edge_borders(none)
315 cfg_hide_edge_borders(vertical)
316 cfg_hide_edge_borders(horizontal)
317 cfg_hide_edge_borders(both)
318 cfg_hide_edge_borders(smart)
321 is(parser_calls($config),
323 'hide_edge_borders ok');
325 ################################################################################
326 # focus_follows_mouse
327 ################################################################################
330 focus_follows_mouse yes
331 focus_follows_mouse no
335 cfg_focus_follows_mouse(yes)
336 cfg_focus_follows_mouse(no)
339 is(parser_calls($config),
341 'focus_follows_mouse ok');
343 ################################################################################
345 ################################################################################
353 cfg_mouse_warping(output)
354 cfg_mouse_warping(none)
357 is(parser_calls($config),
361 ################################################################################
362 # force_display_urgency_hint
363 ################################################################################
365 is(parser_calls('force_display_urgency_hint 300'),
366 "cfg_force_display_urgency_hint(300)\n",
367 'force_display_urgency_hint ok');
369 is(parser_calls('force_display_urgency_hint 500 ms'),
370 "cfg_force_display_urgency_hint(500)\n",
371 'force_display_urgency_hint ok');
373 is(parser_calls('force_display_urgency_hint 700ms'),
374 "cfg_force_display_urgency_hint(700)\n",
375 'force_display_urgency_hint ok');
378 force_display_urgency_hint 300
379 force_display_urgency_hint 500 ms
380 force_display_urgency_hint 700ms
381 force_display_urgency_hint 700
385 cfg_force_display_urgency_hint(300)
386 cfg_force_display_urgency_hint(500)
387 cfg_force_display_urgency_hint(700)
388 cfg_force_display_urgency_hint(700)
391 is(parser_calls($config),
393 'force_display_urgency_hint ok');
395 ################################################################################
397 ################################################################################
400 workspace 3 output VGA-1
401 workspace "4: output" output VGA-2
402 workspace bleh output LVDS1/I_1
404 workspace foo output a b c "a b c"
408 cfg_workspace(3, VGA-1)
409 cfg_workspace(4: output, VGA-2)
410 cfg_workspace(bleh, LVDS1/I_1)
411 cfg_workspace(foo, a)
412 cfg_workspace((null), b)
413 cfg_workspace((null), c)
414 cfg_workspace((null), a b c)
417 is(parser_calls($config),
421 ################################################################################
423 ################################################################################
426 ipc-socket /tmp/i3.sock
427 ipc_socket ~/.i3/i3.sock
431 cfg_ipc_socket(/tmp/i3.sock)
432 cfg_ipc_socket(~/.i3/i3.sock)
435 is(parser_calls($config),
439 ################################################################################
441 ################################################################################
444 client.focused #4c7899 #285577 #ffffff #2e9ef4 #b34d4c
445 client.focused_inactive #333333 #5f676a #ffffff #484e50
446 client.unfocused #333333 #222222 #888888 #292d2e
447 client.urgent #2f343a #900000 #ffffff #900000 #c00000
448 client.placeholder #000000 #0c0c0c #ffffff #000000
452 cfg_color(client.focused, #4c7899, #285577, #ffffff, #2e9ef4, #b34d4c)
453 cfg_color(client.focused_inactive, #333333, #5f676a, #ffffff, #484e50, NULL)
454 cfg_color(client.unfocused, #333333, #222222, #888888, #292d2e, NULL)
455 cfg_color(client.urgent, #2f343a, #900000, #ffffff, #900000, #c00000)
456 cfg_color(client.placeholder, #000000, #0c0c0c, #ffffff, #000000, NULL)
459 is(parser_calls($config),
463 ################################################################################
464 # Verify that errors don’t harm subsequent valid statements
465 ################################################################################
468 hide_edge_border both
469 client.focused #4c7899 #285577 #ffffff #2e9ef4
472 my $expected_all_tokens = "ERROR: CONFIG: Expected one of these tokens: <end>, '#', '" . join("', '", 'set ', 'set ', qw(
480 floating_minimum_size
481 floating_maximum_size
487 default_floating_border
501 workspace_auto_back_and_forth
504 force_display_urgency_hint
505 focus_on_window_activation
513 popup_during_fullscreen
517 client.focused_inactive
524 my $expected_end = <<'EOT';
525 ERROR: CONFIG: (in file <stdin>)
526 ERROR: CONFIG: Line 1: hide_edge_border both
527 ERROR: CONFIG: ^^^^^^^^^^^^^^^^^^^^^
528 ERROR: CONFIG: Line 2: client.focused #4c7899 #285577 #ffffff #2e9ef4
529 cfg_color(client.focused, #4c7899, #285577, #ffffff, #2e9ef4, NULL)
532 $expected = $expected_all_tokens . $expected_end;
534 is(parser_calls($config),
536 'errors dont harm subsequent statements');
539 hide_edge_borders FOOBAR
540 client.focused #4c7899 #285577 #ffffff #2e9ef4
544 ERROR: CONFIG: Expected one of these tokens: 'none', 'vertical', 'horizontal', 'both', 'smart', '1', 'yes', 'true', 'on', 'enable', 'active'
545 ERROR: CONFIG: (in file <stdin>)
546 ERROR: CONFIG: Line 1: hide_edge_borders FOOBAR
547 ERROR: CONFIG: ^^^^^^
548 ERROR: CONFIG: Line 2: client.focused #4c7899 #285577 #ffffff #2e9ef4
549 cfg_color(client.focused, #4c7899, #285577, #ffffff, #2e9ef4, NULL)
552 is(parser_calls($config),
554 'errors dont harm subsequent statements');
556 ################################################################################
557 # Regression: semicolons end comments, but shouldn’t
558 ################################################################################
561 # "foo" client.focused #4c7899 #285577 #ffffff #2e9ef4
568 is(parser_calls($config),
570 'semicolon does not end a comment line');
572 ################################################################################
573 # Error message with 2+2 lines of context
574 ################################################################################
577 # i3 config file (v4)
584 # this should not show up
587 my $expected_head = <<'EOT';
591 my $expected_tail = <<'EOT';
592 ERROR: CONFIG: (in file <stdin>)
593 ERROR: CONFIG: Line 3: font foobar
594 ERROR: CONFIG: Line 4:
595 ERROR: CONFIG: Line 5: unknown qux
596 ERROR: CONFIG: ^^^^^^^^^^^
597 ERROR: CONFIG: Line 6:
598 ERROR: CONFIG: Line 7: # yay
601 $expected = $expected_head . $expected_all_tokens . $expected_tail;
603 is(parser_calls($config),
605 'error message (2+2 context) ok');
607 ################################################################################
608 # Error message with 0+0 lines of context
609 ################################################################################
615 $expected_tail = <<'EOT';
616 ERROR: CONFIG: (in file <stdin>)
617 ERROR: CONFIG: Line 1: unknown qux
618 ERROR: CONFIG: ^^^^^^^^^^^
621 $expected = $expected_all_tokens . $expected_tail;
623 is(parser_calls($config),
625 'error message (0+0 context) ok');
627 ################################################################################
628 # Error message with 1+0 lines of context
629 ################################################################################
636 $expected_tail = <<'EOT';
637 ERROR: CONFIG: (in file <stdin>)
638 ERROR: CONFIG: Line 1: # context before
639 ERROR: CONFIG: Line 2: unknown qux
640 ERROR: CONFIG: ^^^^^^^^^^^
643 $expected = $expected_all_tokens . $expected_tail;
645 is(parser_calls($config),
647 'error message (1+0 context) ok');
649 ################################################################################
650 # Error message with 0+1 lines of context
651 ################################################################################
658 $expected_tail = <<'EOT';
659 ERROR: CONFIG: (in file <stdin>)
660 ERROR: CONFIG: Line 1: unknown qux
661 ERROR: CONFIG: ^^^^^^^^^^^
662 ERROR: CONFIG: Line 2: # context after
665 $expected = $expected_all_tokens . $expected_tail;
667 is(parser_calls($config),
669 'error message (0+1 context) ok');
671 ################################################################################
672 # Error message with 0+2 lines of context
673 ################################################################################
681 $expected_tail = <<'EOT';
682 ERROR: CONFIG: (in file <stdin>)
683 ERROR: CONFIG: Line 1: unknown qux
684 ERROR: CONFIG: ^^^^^^^^^^^
685 ERROR: CONFIG: Line 2: # context after
686 ERROR: CONFIG: Line 3: # context 2 after
689 $expected = $expected_all_tokens . $expected_tail;
691 is(parser_calls($config),
693 'error message (0+2 context) ok');
695 ################################################################################
696 # Error message within mode blocks
697 ################################################################################
701 bindsym x resize shrink left
707 cfg_enter_mode((null), yo)
708 cfg_mode_binding(bindsym, (null), x, (null), (null), (null), (null), resize shrink left)
709 ERROR: CONFIG: Expected one of these tokens: <end>, '#', 'set', 'bindsym', 'bindcode', 'bind', '}'
710 ERROR: CONFIG: (in file <stdin>)
711 ERROR: CONFIG: Line 1: mode "yo" {
712 ERROR: CONFIG: Line 2: bindsym x resize shrink left
713 ERROR: CONFIG: Line 3: unknown qux
714 ERROR: CONFIG: ^^^^^^^^^^^
715 ERROR: CONFIG: Line 4: }
718 is(parser_calls($config),
720 'error message (mode block) ok');
722 ################################################################################
723 # Error message within bar blocks
724 ################################################################################
735 cfg_bar_output(LVDS-1)
736 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', 'strip_workspace_name', 'verbose', 'colors', '}'
737 ERROR: CONFIG: (in file <stdin>)
738 ERROR: CONFIG: Line 1: bar {
739 ERROR: CONFIG: Line 2: output LVDS-1
740 ERROR: CONFIG: Line 3: unknown qux
741 ERROR: CONFIG: ^^^^^^^^^^^
742 ERROR: CONFIG: Line 4: }
746 is(parser_calls($config),
748 'error message (bar block) ok');