git.sur5r.net Git - i3/i3/blob - testcases/t/171-config-migrate.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 if i3-migrate-config-to-v4 correctly migrates all config file
  18 # directives and commands
  19 #
  20 use i3test i3_autostart => 0;
  21 use Cwd qw(abs_path);
  22 use File::Temp qw(tempfile tempdir);
  23 use v5.10;
  24
  25 # reads in a whole file
  26 sub slurp {
  27     open my $fh, '<', shift;
  28     local $/;
  29     <$fh>;
  30 }
  31
  32 sub migrate_config {
  33     my ($config) = @_;
  34
  35     my ($fh, $tmpfile) = tempfile('/tmp/i3-migrate-cfg.XXXXXX', UNLINK => 1);
  36     print $fh $config;
  37     close($fh);
  38
  39     my $cmd = "sh -c 'exec " . abs_path("../i3-migrate-config-to-v4") . " --v3 <$tmpfile'";
  40     return [ split /\n/, qx($cmd) ];
  41 }
  42
  43 sub line_exists {
  44     my ($lines, $pattern) = @_;
  45
  46     for my $line (@$lines) {
  47         return 1 if $line =~ $pattern;
  48     }
  49
  50     return 0
  51 }
  52
  53 #####################################################################
  54 # check that some directives remain untouched
  55 #####################################################################
  56
  57 my $input = <<EOT;
  58     font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
  59 EOT
  60
  61 my $output = migrate_config($input);
  62 ok(line_exists($output, qr|font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1|), 'font directive unchanged');
  63
  64 $input = <<EOT;
  65     floating_Modifier Mod1
  66     focus_follows_mouse true
  67     ipc-socket /tmp/i3-ipc.sock
  68     ipc_socket /tmp/i3-ipc.sock
  69     exec /usr/bin/i3
  70     set stuff Mod1
  71     assign "XTerm" → 3
  72     assign "XTerm" → ~5
  73     client.focused #2F343A #900000 #FFFFFF
  74     client.focused_inactive #FF0000 #FF0000 #FF0000
  75     client.unfocused #00FF00 #00FF00 #00FF00
  76     client.urgent #0000FF #0000FF #0000FF
  77     client.background #000000
  78 EOT
  79
  80 $output = migrate_config($input);
  81 ok(line_exists($output, qr|^floating_Modifier Mod1$|), 'floating_modifier unchanged');
  82 ok(line_exists($output, qr|^focus_follows_mouse true$|), 'focus_follows_mouse unchanged');
  83 ok(line_exists($output, qr|^ipc-socket /tmp/i3-ipc.sock$|), 'ipc-socket unchanged');
  84 ok(line_exists($output, qr|^ipc_socket /tmp/i3-ipc.sock$|), 'ipc_socket unchanged');
  85 ok(line_exists($output, qr|^exec /usr/bin/i3|), 'exec unchanged');
  86 ok(line_exists($output, qr|^set stuff Mod1|), 'set unchanged');
  87 ok(line_exists($output, qr|^assign "XTerm" → 3|), 'assign unchanged');
  88 ok(line_exists($output, qr|^assign "XTerm" → ~5|), 'assign unchanged');
  89 ok(line_exists($output, qr|^client\.focused #2F343A #900000 #FFFFFF$|), 'client.focused unchanged');
  90 ok(line_exists($output, qr|^client\.focused_inactive #FF0000 #FF0000 #FF0000$|), 'client.focused_inactive unchanged');
  91 ok(line_exists($output, qr|^client\.unfocused #00FF00 #00FF00 #00FF00$|), 'client.unfocused unchanged');
  92 ok(line_exists($output, qr|^client\.urgent #0000FF #0000FF #0000FF$|), 'client.urgent unchanged');
  93 ok(line_exists($output, qr|^client\.background #000000$|), 'client.background unchanged');
  94
  95 #####################################################################
  96 # check whether the bar colors get removed properly
  97 #####################################################################
  98
  99 $input = <<EOT;
 100     bar.focused #FFFF00 #FFFF00 #FFFF00
 101     bar.unfocused #FFFF00 #FFFF00 #FFFF00
 102     bar.urgent #FFFF00 #FFFF00 #FFFF00
 103 EOT
 104
 105 $output = migrate_config($input);
 106 ok(!line_exists($output, qr|^bar\.|), 'no bar. lines');
 107 ok(line_exists($output, qr|^#.*REMOVED bar|), 'note bar. removed');
 108
 109
 110 #####################################################################
 111 # check whether the other directives get converted correctly
 112 #####################################################################
 113
 114 $input = <<EOT;
 115     new_container stacking
 116     workspace_bar no
 117     new_window bb
 118 EOT
 119
 120 $output = migrate_config($input);
 121 ok(line_exists($output, qr|^workspace_layout stacking$|), 'new_container changed');
 122 ok(line_exists($output, qr|REMOVED workspace_bar|), 'workspace_bar removed');
 123 ok(!line_exists($output, qr|^workspace_bar|), 'no workspace_bar in the output');
 124 ok(line_exists($output, qr|^new_window none$|), 'new_window changed');
 125
 126 #####################################################################
 127 # check whether new_window's parameters get changed correctly
 128 #####################################################################
 129
 130 $input = <<EOT;
 131     new_window bb
 132     new_window bn
 133     new_window bp
 134 EOT
 135 $output = migrate_config($input);
 136 like($output->[0], qr|^new_window none$|, 'new_window bb changed');
 137 like($output->[1], qr|^new_window normal$|, 'new_window bn changed');
 138 like($output->[2], qr|^new_window 1pixel$|, 'new_window bp changed');
 139
 140 #####################################################################
 141 # check that some commands remain untouched
 142 #####################################################################
 143
 144 $input = <<EOT;
 145     bindsym Mod1+s exec /usr/bin/urxvt
 146     bindsym Mod1+s mark foo
 147     bindsym Mod1+s restart
 148     bindsym Mod1+s reload
 149     bindsym Mod1+s exit
 150     bind Mod1+c exec /usr/bin/urxvt
 151     mode "asdf" {
 152         bind 36 mode default
 153     }
 154 EOT
 155
 156 $output = migrate_config($input);
 157 ok(line_exists($output, qr|^bindsym Mod1\+s exec /usr/bin/urxvt$|), 'exec unchanged');
 158 ok(line_exists($output, qr|^bindsym Mod1\+s mark foo$|), 'mark unchanged');
 159 ok(line_exists($output, qr|^bindsym Mod1\+s restart$|), 'restart unchanged');
 160 ok(line_exists($output, qr|^bindsym Mod1\+s reload$|), 'reload unchanged');
 161 ok(line_exists($output, qr|^bindsym Mod1\+s exit$|), 'exit unchanged');
 162 ok(line_exists($output, qr|^bindcode Mod1\+c exec /usr/bin/urxvt$|), 'bind changed to bindcode');
 163 ok(line_exists($output, qr|^mode "asdf" {$|), 'mode asdf unchanged');
 164 ok(line_exists($output, qr|^bindcode 36 mode \"default\"$|), 'mode default unchanged');
 165 ok(line_exists($output, qr|^}$|), 'closing mode bracket still there');
 166
 167 #####################################################################
 168 # check the simple command replacements
 169 #####################################################################
 170
 171 $input = <<EOT;
 172     bindsym Mod1+s s
 173     bindsym Mod1+s d
 174     bindsym Mod1+s T
 175
 176     bindsym Mod1+s f
 177     bindsym Mod1+s fg
 178
 179     bindsym Mod1+s t
 180
 181     bindsym Mod1+s h
 182     bindsym Mod1+s j
 183     bindsym Mod1+s k
 184     bindsym Mod1+s l
 185
 186     bindsym Mod1+s mh
 187     bindsym Mod1+s mj
 188     bindsym Mod1+s mk
 189     bindsym Mod1+s ml
 190
 191     bindsym Mod1+s bn
 192     bindsym Mod1+s bp
 193     bindsym Mod1+s bb
 194     bindsym Mod1+s bt
 195
 196     bindsym Mod1+j wch
 197     bindsym Mod1+j wcml
 198
 199     bindsym Mod1+k kill
 200
 201     bindsym Mod1+n nw
 202     bindsym Mod1+p pw
 203 EOT
 204
 205 $output = migrate_config($input);
 206 ok(line_exists($output, qr|^bindsym Mod1\+s layout stacking$|), 's replaced');
 207 ok(line_exists($output, qr|^bindsym Mod1\+s layout toggle split$|), 'd replaced');
 208 ok(line_exists($output, qr|^bindsym Mod1\+s layout tabbed$|), 'T replaced');
 209 ok(line_exists($output, qr|^bindsym Mod1\+s fullscreen$|), 'f replaced');
 210 ok(line_exists($output, qr|^bindsym Mod1\+s fullscreen global$|), 'fg replaced');
 211 ok(line_exists($output, qr|^bindsym Mod1\+s floating toggle$|), 't replaced');
 212 ok(line_exists($output, qr|^bindsym Mod1\+s focus left$|), 'h replaced');
 213 ok(line_exists($output, qr|^bindsym Mod1\+s focus down$|), 'j replaced');
 214 ok(line_exists($output, qr|^bindsym Mod1\+s focus up$|), 'k replaced');
 215 ok(line_exists($output, qr|^bindsym Mod1\+s focus right$|), 'l replaced');
 216 ok(line_exists($output, qr|^bindsym Mod1\+s move left$|), 'mh replaced');
 217 ok(line_exists($output, qr|^bindsym Mod1\+s move down$|), 'mj replaced');
 218 ok(line_exists($output, qr|^bindsym Mod1\+s move up$|), 'mk replaced');
 219 ok(line_exists($output, qr|^bindsym Mod1\+s move right$|), 'ml replaced');
 220 ok(line_exists($output, qr|^bindsym Mod1\+s border normal$|), 'bn replaced');
 221 ok(line_exists($output, qr|^bindsym Mod1\+s border 1pixel$|), 'bp replaced');
 222 ok(line_exists($output, qr|^bindsym Mod1\+s border none$|), 'bb replaced');
 223 ok(line_exists($output, qr|^bindsym Mod1\+s border toggle$|), 'bt replaced');
 224 ok(line_exists($output, qr|^bindsym Mod1\+j focus parent; focus left$|), 'with container replaced with focus parent; focus left');
 225 ok(line_exists($output, qr|^bindsym Mod1\+j focus parent; move right$|), 'with container replaced with focus parent; move right');
 226 ok(line_exists($output, qr|^bindsym Mod1\+k kill$|), 'kill unchanged');
 227 ok(line_exists($output, qr|^bindsym Mod1\+n workspace next$|), 'nw replaced');
 228 ok(line_exists($output, qr|^bindsym Mod1\+p workspace prev$|), 'pw replaced');
 229
 230 #####################################################################
 231 # check more advanced replacements
 232 #####################################################################
 233
 234 $input = <<EOT;
 235     bindsym Mod1+s goto foo
 236 EOT
 237
 238 $output = migrate_config($input);
 239 ok(line_exists($output, qr|^bindsym Mod1\+s \[con_mark="foo"\] focus$|), 'goto replaced');
 240
 241 #####################################################################
 242 # check whether focus's parameters get changed correctly
 243 #####################################################################
 244
 245 $input = <<EOT;
 246 bindsym Mod1+f focus 3
 247 bindsym Mod1+f focus floating
 248 bindsym Mod1+f focus tiling
 249 bindsym Mod1+f focus ft
 250 EOT
 251
 252 $output = migrate_config($input);
 253 like($output->[0], qr|^#.*focus.*obsolete.*focus 3$|, 'focus [number] gone');
 254 like($output->[1], qr|^bindsym Mod1\+f focus floating$|, 'focus floating unchanged');
 255 like($output->[2], qr|^bindsym Mod1\+f focus tiling$|, 'focus tiling unchanged');
 256 like($output->[3], qr|^bindsym Mod1\+f focus mode_toggle$|, 'focus ft changed');
 257
 258 #####################################################################
 259 # check whether resize's parameters get changed correctly
 260 #####################################################################
 261
 262 $input = <<EOT;
 263 bindsym Mod1+f resize left +10
 264 bindsym Mod1+f resize top -20
 265 bindsym Mod1+f resize right -20
 266 bindsym Mod1+f resize bottom +23
 267 bindsym Mod1+f resize          left    \t +10
 268 EOT
 269
 270 $output = migrate_config($input);
 271 like($output->[0], qr|^bindsym Mod1\+f resize grow left 10 px$|, 'resize left changed');
 272 like($output->[1], qr|^bindsym Mod1\+f resize shrink up 20 px$|, 'resize top changed');
 273 like($output->[2], qr|^bindsym Mod1\+f resize shrink right 20 px$|, 'resize right changed');
 274 like($output->[3], qr|^bindsym Mod1\+f resize grow down 23 px$|, 'resize bottom changed');
 275
 276 #####################################################################
 277 # also resizing, but with indention this time
 278 #####################################################################
 279
 280 like($output->[4], qr|^bindsym Mod1\+f resize grow left 10 px$|, 'resize left changed');
 281
 282 #####################################################################
 283 # check whether jump's parameters get changed correctly
 284 #####################################################################
 285
 286 $input = <<EOT;
 287 bindsym Mod1+f jump 3
 288 bindsym Mod1+f jump 3 4 5
 289 bindsym Mod1+f jump "XTerm"
 290 bindsym Mod1+f jump "XTerm/irssi"
 291 EOT
 292
 293 $output = migrate_config($input);
 294 like($output->[0], qr|^#.*obsolete.*jump 3$|, 'jump to workspace removed');
 295 like($output->[1], qr|^#.*obsolete.*jump 3 4 5$|, 'jump to workspace + col/row removed');
 296 like($output->[2], qr|^bindsym Mod1\+f \[class="XTerm"\] focus$|, 'jump changed');
 297 like($output->[3], qr|^bindsym Mod1\+f \[class="XTerm" title="irssi"\] focus$|, 'jump changed');
 298
 299 #####################################################################
 300 # check whether workspace commands are handled correctly
 301 #####################################################################
 302
 303 $output = migrate_config('workspace 3 output VGA-1');
 304 ok(line_exists($output, qr|^workspace 3 output VGA-1$|), 'workspace assignment unchanged');
 305
 306 $output = migrate_config('workspace 3 work');
 307 ok(!line_exists($output, qr|^workspace|), 'workspace name not present');
 308 ok(line_exists($output, qr|#.*workspace name.*bindings|), 'note present');
 309
 310 $input = <<EOT;
 311     workspace 3 work
 312     bindsym Mod1+3 3
 313 EOT
 314 $output = migrate_config($input);
 315 ok(!line_exists($output, qr|^workspace|), 'workspace name not present');
 316 ok(line_exists($output, qr|^bindsym Mod1\+3 workspace work|), 'named workspace in bindings');
 317
 318 # The same, but in reverse order
 319 $input = <<EOT;
 320     bindsym Mod1+3 3
 321     workspace 3 work
 322 EOT
 323 $output = migrate_config($input);
 324 ok(!line_exists($output, qr|^workspace|), 'workspace name not present');
 325 ok(line_exists($output, qr|^bindsym Mod1\+3 workspace work|), 'named workspace in bindings');
 326
 327 $output = migrate_config('bindsym Mod1+3 3');
 328 ok(line_exists($output, qr|^bindsym Mod1\+3 workspace 3|), 'workspace changed');
 329
 330 $output = migrate_config('bindsym Mod1+3 m3');
 331 ok(line_exists($output, qr|^bindsym Mod1\+3 move container to workspace 3|), 'move workspace changed');
 332
 333 $input = <<EOT;
 334     workspace 3 work
 335     bindsym Mod1+3 m3
 336 EOT
 337 $output = migrate_config($input);
 338 ok(!line_exists($output, qr|^workspace|), 'workspace name not present');
 339 ok(line_exists($output, qr|^bindsym Mod1\+3 move container to workspace work|), 'move to named workspace in bindings');
 340
 341 #####################################################################
 342 # check whether an i3bar call is added if the workspace bar bar was enabled
 343 #####################################################################
 344
 345 $output = migrate_config('');
 346 ok(line_exists($output, qr|bar {|), 'i3bar added');
 347
 348 $output = migrate_config('workspace_bar enable');
 349 ok(line_exists($output, qr|bar {|), 'i3bar added');
 350
 351 $output = migrate_config('workspace_bar no');
 352 ok(!line_exists($output, qr|bar {|), 'no i3bar added');
 353
 354 #####################################################################
 355 # check whether the mode command gets quotes
 356 #####################################################################
 357
 358 $output = migrate_config('bindsym Mod1+m mode foobar');
 359 ok(line_exists($output, qr|^bindsym Mod1\+m mode "foobar"|), 'mode got quotes');
 360
 361 done_testing();