]> git.sur5r.net Git - i3/i3/blob - testcases/t/201-config-parser.t
cfg_workspace: Accept outputs with spaces again
[i3/i3] / 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 # • https://build.i3wm.org/docs/testsuite.html
6 #   (or docs/testsuite)
7 #
8 # • https://build.i3wm.org/docs/lib-i3test.html
9 #   (alternatively: perldoc ./testcases/lib/i3test.pm)
10 #
11 # • https://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     bindsym --exclude-titlebar button3 nop
53     bindsym --whole-window --border --exclude-titlebar button3 nop
54 }
55 EOT
56
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)
68 EOT
69
70 is(parser_calls($config),
71    $expected,
72    'mode bindings ok');
73
74 ################################################################################
75 # exec and exec_always
76 ################################################################################
77
78 $config = <<'EOT';
79 exec geeqie
80 exec --no-startup-id /tmp/foo.sh
81 exec_always firefox
82 exec_always --no-startup-id /tmp/bar.sh
83 EOT
84
85 $expected = <<'EOT';
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)
90 EOT
91
92 is(parser_calls($config),
93    $expected,
94    'exec okay');
95
96 ################################################################################
97 # for_window
98 ################################################################################
99
100 $config = <<'EOT';
101 for_window [class="^Chrome"] floating enable
102 EOT
103
104 $expected = <<'EOT';
105 cfg_criteria_add(class, ^Chrome)
106 cfg_for_window(floating enable)
107 EOT
108
109 is(parser_calls($config),
110    $expected,
111    'for_window okay');
112
113 ################################################################################
114 # assign
115 ################################################################################
116
117 $config = <<'EOT';
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"
123 EOT
124
125 $expected = <<'EOT';
126 cfg_criteria_add(class, ^Chrome)
127 cfg_assign(4, 0)
128 cfg_criteria_add(class, ^Chrome)
129 cfg_assign(3, 1)
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)
136 EOT
137
138 is(parser_calls($config),
139    $expected,
140    'for_window okay');
141
142 ################################################################################
143 # floating_minimum_size / floating_maximum_size
144 ################################################################################
145
146 $config = <<'EOT';
147 floating_minimum_size 80x55
148 floating_minimum_size 80    x  55
149 floating_maximum_size 73 x 10
150 EOT
151
152 $expected = <<'EOT';
153 cfg_floating_minimum_size(80, 55)
154 cfg_floating_minimum_size(80, 55)
155 cfg_floating_maximum_size(73, 10)
156 EOT
157
158 is(parser_calls($config),
159    $expected,
160    'floating_minimum_size ok');
161
162 ################################################################################
163 # popup_during_fullscreen
164 ################################################################################
165
166 $config = <<'EOT';
167 popup_during_fullscreen ignore
168 popup_during_fullscreen leave_fullscreen
169 popup_during_fullscreen SMArt
170 EOT
171
172 $expected = <<'EOT';
173 cfg_popup_during_fullscreen(ignore)
174 cfg_popup_during_fullscreen(leave_fullscreen)
175 cfg_popup_during_fullscreen(smart)
176 EOT
177
178 is(parser_calls($config),
179    $expected,
180    'popup_during_fullscreen ok');
181
182
183 ################################################################################
184 # floating_modifier
185 ################################################################################
186
187 $config = <<'EOT';
188 floating_modifier Mod1
189 floating_modifier mOd1
190 EOT
191
192 $expected = <<'EOT';
193 cfg_floating_modifier(Mod1)
194 cfg_floating_modifier(Mod1)
195 EOT
196
197 is(parser_calls($config),
198    $expected,
199    'floating_modifier ok');
200
201 ################################################################################
202 # default_orientation
203 ################################################################################
204
205 $config = <<'EOT';
206 default_orientation horizontal
207 default_orientation vertical
208 default_orientation auto
209 EOT
210
211 $expected = <<'EOT';
212 cfg_default_orientation(horizontal)
213 cfg_default_orientation(vertical)
214 cfg_default_orientation(auto)
215 EOT
216
217 is(parser_calls($config),
218    $expected,
219    'default_orientation ok');
220
221 ################################################################################
222 # workspace_layout
223 ################################################################################
224
225 $config = <<'EOT';
226 workspace_layout default
227 workspace_layout stacked
228 workspace_layout stacking
229 workspace_layout tabbed
230 EOT
231
232 $expected = <<'EOT';
233 cfg_workspace_layout(default)
234 cfg_workspace_layout(stacked)
235 cfg_workspace_layout(stacking)
236 cfg_workspace_layout(tabbed)
237 EOT
238
239 is(parser_calls($config),
240    $expected,
241    'workspace_layout ok');
242
243 ################################################################################
244 # workspace assignments, with trailing whitespace (ticket #921)
245 ################################################################################
246
247 $config = <<'EOT';
248 workspace "3" output DP-1
249 workspace "3" output            VGA-1
250 EOT
251
252 $expected = <<'EOT';
253 cfg_workspace(3, DP-1)
254 cfg_workspace(3, VGA-1)
255 EOT
256
257 is(parser_calls($config),
258    $expected,
259    'workspace assignment ok');
260
261 ################################################################################
262 # new_window
263 ################################################################################
264
265 $config = <<'EOT';
266 new_window 1pixel
267 new_window normal
268 new_window none
269 default_border 1pixel
270 default_border normal
271 default_border none
272 new_float 1pixel
273 new_float normal
274 new_float none
275 default_floating_border 1pixel
276 default_floating_border normal
277 default_floating_border none
278 EOT
279
280 $expected = <<'EOT';
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)
293 EOT
294
295 # TODO: are there no tests for "border pixel 1" etc?
296
297 is(parser_calls($config),
298    $expected,
299    'new_window ok');
300
301 ################################################################################
302 # hide_edge_borders
303 ################################################################################
304
305 $config = <<'EOT';
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
311 EOT
312
313 $expected = <<'EOT';
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)
319 EOT
320
321 is(parser_calls($config),
322    $expected,
323    'hide_edge_borders ok');
324
325 ################################################################################
326 # focus_follows_mouse
327 ################################################################################
328
329 $config = <<'EOT';
330 focus_follows_mouse yes
331 focus_follows_mouse no
332 EOT
333
334 $expected = <<'EOT';
335 cfg_focus_follows_mouse(yes)
336 cfg_focus_follows_mouse(no)
337 EOT
338
339 is(parser_calls($config),
340    $expected,
341    'focus_follows_mouse ok');
342
343 ################################################################################
344 # mouse_warping
345 ################################################################################
346
347 $config = <<'EOT';
348 mouse_warping output
349 mouse_warping none
350 EOT
351
352 $expected = <<'EOT';
353 cfg_mouse_warping(output)
354 cfg_mouse_warping(none)
355 EOT
356
357 is(parser_calls($config),
358    $expected,
359    'mouse_warping ok');
360
361 ################################################################################
362 # force_display_urgency_hint
363 ################################################################################
364
365 is(parser_calls('force_display_urgency_hint 300'),
366    "cfg_force_display_urgency_hint(300)\n",
367    'force_display_urgency_hint ok');
368
369 is(parser_calls('force_display_urgency_hint 500 ms'),
370    "cfg_force_display_urgency_hint(500)\n",
371    'force_display_urgency_hint ok');
372
373 is(parser_calls('force_display_urgency_hint 700ms'),
374    "cfg_force_display_urgency_hint(700)\n",
375    'force_display_urgency_hint ok');
376
377 $config = <<'EOT';
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
382 EOT
383
384 $expected = <<'EOT';
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)
389 EOT
390
391 is(parser_calls($config),
392    $expected,
393    'force_display_urgency_hint ok');
394
395 ################################################################################
396 # workspace
397 ################################################################################
398
399 $config = <<'EOT';
400 workspace 3 output VGA-1
401 workspace "4: output" output VGA-2
402 workspace bleh output LVDS1/I_1
403 # See #3646
404 workspace foo output a b c "a b c"
405 EOT
406
407 $expected = <<'EOT';
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)
415 EOT
416
417 is(parser_calls($config),
418    $expected,
419    'workspace ok');
420
421 ################################################################################
422 # ipc-socket
423 ################################################################################
424
425 $config = <<'EOT';
426 ipc-socket /tmp/i3.sock
427 ipc_socket ~/.i3/i3.sock
428 EOT
429
430 $expected = <<'EOT';
431 cfg_ipc_socket(/tmp/i3.sock)
432 cfg_ipc_socket(~/.i3/i3.sock)
433 EOT
434
435 is(parser_calls($config),
436    $expected,
437    'ipc-socket ok');
438
439 ################################################################################
440 # colors
441 ################################################################################
442
443 $config = <<'EOT';
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
449 EOT
450
451 $expected = <<'EOT';
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)
457 EOT
458
459 is(parser_calls($config),
460    $expected,
461    'colors ok');
462
463 ################################################################################
464 # Verify that errors don’t harm subsequent valid statements
465 ################################################################################
466
467 $config = <<'EOT';
468 hide_edge_border both
469 client.focused          #4c7899 #285577 #ffffff #2e9ef4
470 EOT
471
472 my $expected_all_tokens = "ERROR: CONFIG: Expected one of these tokens: <end>, '#', '" . join("', '", 'set ', 'set      ', qw(
473         set_from_resource
474         bindsym
475         bindcode
476         bind
477         bar
478         font
479         mode
480         floating_minimum_size
481         floating_maximum_size
482         floating_modifier
483         default_orientation
484         workspace_layout
485         default_border
486         new_window
487         default_floating_border
488         new_float
489         hide_edge_borders
490         for_window
491         assign
492         no_focus
493         focus_follows_mouse
494         mouse_warping
495         focus_wrapping
496         force_focus_wrapping
497         force_xinerama
498         force-xinerama
499         disable_randr15
500         disable-randr15
501         workspace_auto_back_and_forth
502         fake_outputs
503         fake-outputs
504         force_display_urgency_hint
505         focus_on_window_activation
506         title_align
507         show_marks
508         workspace
509         ipc_socket
510         ipc-socket
511         ipc_kill_timeout
512         restart_state
513         popup_during_fullscreen
514         exec_always
515         exec
516         client.background
517         client.focused_inactive
518         client.focused
519         client.unfocused
520         client.urgent
521         client.placeholder
522     )) . "'\n";
523
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)
530 EOT
531
532 $expected = $expected_all_tokens . $expected_end;
533
534 is(parser_calls($config),
535    $expected,
536    'errors dont harm subsequent statements');
537
538 $config = <<'EOT';
539 hide_edge_borders FOOBAR
540 client.focused          #4c7899 #285577 #ffffff #2e9ef4
541 EOT
542
543 $expected = <<'EOT';
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)
550 EOT
551
552 is(parser_calls($config),
553    $expected,
554    'errors dont harm subsequent statements');
555
556 ################################################################################
557 # Regression: semicolons end comments, but shouldn’t
558 ################################################################################
559
560 $config = <<'EOT';
561 # "foo" client.focused          #4c7899 #285577 #ffffff #2e9ef4
562 EOT
563
564 $expected = <<'EOT';
565
566 EOT
567
568 is(parser_calls($config),
569    $expected,
570    'semicolon does not end a comment line');
571
572 ################################################################################
573 # Error message with 2+2 lines of context
574 ################################################################################
575
576 $config = <<'EOT';
577 # i3 config file (v4)
578
579 font foobar
580
581 unknown qux
582
583 # yay
584 # this should not show up
585 EOT
586
587 my $expected_head = <<'EOT';
588 cfg_font(foobar)
589 EOT
590
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
599 EOT
600
601 $expected = $expected_head . $expected_all_tokens . $expected_tail;
602
603 is(parser_calls($config),
604    $expected,
605    'error message (2+2 context) ok');
606
607 ################################################################################
608 # Error message with 0+0 lines of context
609 ################################################################################
610
611 $config = <<'EOT';
612 unknown qux
613 EOT
614
615 $expected_tail = <<'EOT';
616 ERROR: CONFIG: (in file <stdin>)
617 ERROR: CONFIG: Line   1: unknown qux
618 ERROR: CONFIG:           ^^^^^^^^^^^
619 EOT
620
621 $expected = $expected_all_tokens . $expected_tail;
622
623 is(parser_calls($config),
624    $expected,
625    'error message (0+0 context) ok');
626
627 ################################################################################
628 # Error message with 1+0 lines of context
629 ################################################################################
630
631 $config = <<'EOT';
632 # context before
633 unknown qux
634 EOT
635
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:           ^^^^^^^^^^^
641 EOT
642
643 $expected = $expected_all_tokens . $expected_tail;
644
645 is(parser_calls($config),
646    $expected,
647    'error message (1+0 context) ok');
648
649 ################################################################################
650 # Error message with 0+1 lines of context
651 ################################################################################
652
653 $config = <<'EOT';
654 unknown qux
655 # context after
656 EOT
657
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
663 EOT
664
665 $expected = $expected_all_tokens . $expected_tail;
666
667 is(parser_calls($config),
668    $expected,
669    'error message (0+1 context) ok');
670
671 ################################################################################
672 # Error message with 0+2 lines of context
673 ################################################################################
674
675 $config = <<'EOT';
676 unknown qux
677 # context after
678 # context 2 after
679 EOT
680
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
687 EOT
688
689 $expected = $expected_all_tokens . $expected_tail;
690
691 is(parser_calls($config),
692    $expected,
693    'error message (0+2 context) ok');
694
695 ################################################################################
696 # Error message within mode blocks
697 ################################################################################
698
699 $config = <<'EOT';
700 mode "yo" {
701     bindsym x resize shrink left
702     unknown qux
703 }
704 EOT
705
706 $expected = <<'EOT';
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: }
716 EOT
717
718 is(parser_calls($config),
719    $expected,
720    'error message (mode block) ok');
721
722 ################################################################################
723 # Error message within bar blocks
724 ################################################################################
725
726 $config = <<'EOT';
727 bar {
728     output LVDS-1
729     unknown qux
730 }
731 EOT
732
733 $expected = <<'EOT';
734 cfg_bar_start()
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: }
743 cfg_bar_finish()
744 EOT
745
746 is(parser_calls($config),
747    $expected,
748    'error message (bar block) ok');
749
750 done_testing;