src/test/snapshot-test.pm

   1 package PVE::LXC::Test;
   2
   3 use strict;
   4 use warnings;
   5
   6 use lib qw(..);
   7
   8 use PVE::Storage;
   9 use PVE::Storage::Plugin;
  10 use PVE::LXC;
  11 use PVE::LXC::Config;
  12 use PVE::Tools;
  13 use PVE::ReplicationConfig;
  14
  15 use Test::MockModule;
  16 use Test::More;
  17
  18 my $nodename;
  19 my $snapshot_possible;
  20 my $vol_snapshot_possible = {};
  21 my $vol_snapshot_delete_possible = {};
  22 my $vol_snapshot_rollback_possible = {};
  23 my $vol_snapshot_rollback_enabled = {};
  24 my $vol_snapshot = {};
  25 my $vol_snapshot_delete = {};
  26 my $vol_snapshot_rollback = {};
  27 my $running;
  28 my $freeze_possible;
  29 my $kill_possible;
  30
  31 # Mocked methods
  32
  33 sub mocked_has_feature {
  34     my ($feature, $conf, $storecfg, $snapname) = @_;
  35     return $snapshot_possible;
  36 }
  37
  38 sub mocked_check_running {
  39     return $running;
  40 }
  41
  42 sub mocked_volume_snapshot {
  43     my ($storecfg, $volid, $snapname) = @_;
  44     die "Storage config not mocked! aborting\n"
  45         if defined($storecfg);
  46     die "volid undefined\n"
  47         if !defined($volid);
  48     die "snapname undefined\n"
  49         if !defined($snapname);
  50     if ($vol_snapshot_possible->{$volid}) {
  51         if (defined($vol_snapshot->{$volid})) {
  52             $vol_snapshot->{$volid} .= ",$snapname";
  53         } else {
  54             $vol_snapshot->{$volid} = $snapname;
  55         }
  56         return 1;
  57     } else {
  58         die "volume snapshot disabled\n";
  59     }
  60 }
  61
  62 sub mocked_volume_snapshot_delete {
  63     my ($storecfg, $volid, $snapname) = @_;
  64     die "Storage config not mocked! aborting\n"
  65         if defined($storecfg);
  66     die "volid undefined\n"
  67         if !defined($volid);
  68     die "snapname undefined\n"
  69         if !defined($snapname);
  70     if ($vol_snapshot_delete_possible->{$volid}) {
  71         if (defined($vol_snapshot_delete->{$volid})) {
  72             $vol_snapshot_delete->{$volid} .= ",$snapname";
  73         } else {
  74             $vol_snapshot_delete->{$volid} = $snapname;
  75         }
  76         return 1;
  77     } else {
  78         die "volume snapshot delete disabled\n";
  79     }
  80 }
  81
  82 sub mocked_volume_snapshot_rollback {
  83     my ($storecfg, $volid, $snapname) = @_;
  84     die "Storage config not mocked! aborting\n"
  85         if defined($storecfg);
  86     die "volid undefined\n"
  87         if !defined($volid);
  88     die "snapname undefined\n"
  89         if !defined($snapname);
  90     if ($vol_snapshot_rollback_enabled->{$volid}) {
  91         if (defined($vol_snapshot_rollback->{$volid})) {
  92             $vol_snapshot_rollback->{$volid} .= ",$snapname";
  93         } else {
  94             $vol_snapshot_rollback->{$volid} = $snapname;
  95         }
  96         return 1;
  97     } else {
  98         die "volume snapshot rollback disabled\n";
  99     }
 100 }
 101
 102 sub mocked_volume_rollback_is_possible {
 103     my ($storecfg, $volid, $snapname) = @_;
 104     die "Storage config not mocked! aborting\n"
 105         if defined($storecfg);
 106     die "volid undefined\n"
 107         if !defined($volid);
 108     die "snapname undefined\n"
 109         if !defined($snapname);
 110     return $vol_snapshot_rollback_possible->{$volid}
 111         if ($vol_snapshot_rollback_possible->{$volid});
 112     die "volume_rollback_is_possible failed\n";
 113 }
 114
 115 sub mocked_vm_stop {
 116     if ($kill_possible) {
 117         $running = 0;
 118         return 1;
 119     } else {
 120         return 0;
 121     }
 122 }
 123
 124 sub mocked_run_command {
 125     my ($cmd, %param) = @_;
 126     my $cmdstring;
 127     if (my $ref = ref($cmd)) {
 128         $cmdstring = PVE::Tools::cmd2string($cmd);
 129         if ($cmdstring =~ m/.*\/lxc-(un)?freeze.*/) {
 130             return 1 if $freeze_possible;
 131             die "lxc-[un]freeze disabled\n";
 132         }
 133         if ($cmdstring =~ m/.*\/lxc-stop.*--kill.*/) {
 134             mocked_vm_stop();
 135         }
 136     }
 137     die "unexpected run_command call: '$cmdstring', aborting\n";
 138 }
 139
 140 # Testing methods
 141
 142 sub test_file {
 143     my ($exp_fn, $real_fn) = @_;
 144     my $ret;
 145     eval {
 146         $ret = system("diff -u '$exp_fn' '$real_fn'");
 147     };
 148     die if $@;
 149     return !$ret;
 150 }
 151
 152 sub testcase_prepare {
 153     my ($vmid, $snapname, $save_vmstate, $comment, $exp_err) = @_;
 154     subtest "Preparing snapshot '$snapname' for vm '$vmid'" => sub {
 155         plan tests => 2;
 156         $@ = undef;
 157         eval {
 158             PVE::LXC::Config->__snapshot_prepare($vmid, $snapname, $save_vmstate, $comment);
 159         };
 160         is($@, $exp_err, "\$@ correct");
 161         ok(test_file("snapshot-expected/prepare/lxc/$vmid.conf", "snapshot-working/prepare/lxc/$vmid.conf"), "config file correct");
 162     };
 163 }
 164
 165 sub testcase_commit {
 166     my ($vmid, $snapname, $exp_err) = @_;
 167     subtest "Committing snapshot '$snapname' for vm '$vmid'" => sub {
 168         plan tests => 2;
 169         $@ = undef;
 170         eval {
 171             PVE::LXC::Config->__snapshot_commit($vmid, $snapname);
 172         };
 173         is($@, $exp_err, "\$@ correct");
 174         ok(test_file("snapshot-expected/commit/lxc/$vmid.conf", "snapshot-working/commit/lxc/$vmid.conf"), "config file correct");
 175     }
 176 }
 177
 178 sub testcase_create {
 179     my ($vmid, $snapname, $save_vmstate, $comment, $exp_err, $exp_vol_snap, $exp_vol_snap_delete) = @_;
 180     subtest "Creating snapshot '$snapname' for vm '$vmid'" => sub {
 181         plan tests => 4;
 182         $vol_snapshot = {};
 183         $vol_snapshot_delete = {};
 184         $exp_vol_snap = {} if !defined($exp_vol_snap);
 185         $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
 186         $@ = undef;
 187         eval {
 188             PVE::LXC::Config->snapshot_create($vmid, $snapname, $save_vmstate, $comment);
 189         };
 190         is($@, $exp_err, "\$@ correct");
 191         is_deeply($vol_snapshot, $exp_vol_snap, "created correct volume snapshots");
 192         is_deeply($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
 193         ok(test_file("snapshot-expected/create/lxc/$vmid.conf", "snapshot-working/create/lxc/$vmid.conf"), "config file correct");
 194     };
 195 }
 196
 197 sub testcase_delete {
 198     my ($vmid, $snapname, $force, $exp_err, $exp_vol_snap_delete) = @_;
 199     subtest "Deleting snapshot '$snapname' of vm '$vmid'" => sub {
 200         plan tests => 3;
 201         $vol_snapshot_delete = {};
 202         $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
 203         $@ = undef;
 204         eval {
 205             PVE::LXC::Config->snapshot_delete($vmid, $snapname, $force);
 206         };
 207         is($@, $exp_err, "\$@ correct");
 208         is_deeply($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
 209         ok(test_file("snapshot-expected/delete/lxc/$vmid.conf", "snapshot-working/delete/lxc/$vmid.conf"), "config file correct");
 210     };
 211 }
 212
 213 sub testcase_rollback {
 214     my ($vmid, $snapname, $exp_err, $exp_vol_snap_rollback) = @_;
 215     subtest "Rolling back to snapshot '$snapname' of vm '$vmid'" => sub {
 216         plan tests => 3;
 217         $vol_snapshot_rollback = {};
 218         $running = 1;
 219         $exp_vol_snap_rollback = {} if !defined($exp_vol_snap_rollback);
 220         $@ = undef;
 221         eval {
 222             PVE::LXC::Config->snapshot_rollback($vmid, $snapname);
 223         };
 224         is($@, $exp_err, "\$@ correct");
 225         is_deeply($vol_snapshot_rollback, $exp_vol_snap_rollback, "rolled back to correct volume snapshots");
 226         ok(test_file("snapshot-expected/rollback/lxc/$vmid.conf", "snapshot-working/rollback/lxc/$vmid.conf"), "config file correct");
 227     };
 228 }
 229
 230 # BEGIN mocked PVE::LXC::Config methods
 231 sub mocked_config_file_lock {
 232     return "snapshot-working/pve-test.lock";
 233 }
 234
 235 sub mocked_cfs_config_path {
 236     my ($class, $vmid, $node) = @_;
 237
 238     $node = $nodename if !$node;
 239     return "snapshot-working/$node/lxc/$vmid.conf";
 240 }
 241
 242 sub mocked_load_config {
 243     my ($class, $vmid, $node) = @_;
 244
 245     my $filename = PVE::LXC::Config->cfs_config_path($vmid, $node);
 246
 247     my $raw = PVE::Tools::file_get_contents($filename);
 248
 249     my $conf = PVE::LXC::Config::parse_pct_config($filename, $raw);
 250     return $conf;
 251 }
 252
 253 sub mocked_write_config {
 254     my ($class, $vmid, $conf) = @_;
 255
 256     my $filename = PVE::LXC::Config->cfs_config_path($vmid);
 257
 258     if ($conf->{snapshots}) {
 259         foreach my $snapname (keys %{$conf->{snapshots}}) {
 260             $conf->{snapshots}->{$snapname}->{snaptime} = "1234567890"
 261                 if $conf->{snapshots}->{$snapname}->{snaptime};
 262         }
 263     }
 264
 265     my $raw = PVE::LXC::Config::write_pct_config($filename, $conf);
 266
 267     PVE::Tools::file_set_contents($filename, $raw);
 268 }
 269
 270 # END mocked PVE::LXC methods
 271
 272
 273 PVE::Tools::run_command("rm -rf snapshot-working");
 274 PVE::Tools::run_command("cp -a snapshot-input snapshot-working");
 275
 276 printf("\n");
 277 printf("Setting up Mocking for PVE::LXC and PVE::LXC::Config\n");
 278 my $lxc_module = new Test::MockModule('PVE::LXC');
 279 $lxc_module->mock('sync_container_namespace', sub { return; });
 280 $lxc_module->mock('check_running', \&mocked_check_running);
 281 $lxc_module->mock('vm_stop', \&mocked_vm_stop);
 282
 283 my $lxc_config_module = new Test::MockModule('PVE::LXC::Config');
 284 $lxc_config_module->mock('config_file_lock', sub { return "snapshot-working/pve-test.lock"; });
 285 $lxc_config_module->mock('cfs_config_path', \&mocked_cfs_config_path);
 286 $lxc_config_module->mock('load_config', \&mocked_load_config);
 287 $lxc_config_module->mock('write_config', \&mocked_write_config);
 288 $lxc_config_module->mock('has_feature', \&mocked_has_feature);
 289
 290 # ignore existing replication config
 291 my $repl_config_module = new Test::MockModule('PVE::ReplicationConfig');
 292 $repl_config_module->mock('check_for_existing_jobs' => sub { return undef });
 293
 294 $running = 1;
 295 $freeze_possible = 1;
 296
 297 printf("\n");
 298 printf("Running prepare tests\n");
 299 printf("\n");
 300 $nodename = "prepare";
 301
 302 printf("\n");
 303 printf("Setting has_feature to return true\n");
 304 printf("\n");
 305 $snapshot_possible = 1;
 306
 307 printf("Successful snapshot_prepare with no existing snapshots\n");
 308 testcase_prepare("101", "test", 0, "test comment", '');
 309
 310 printf("Successful snapshot_prepare with one existing snapshot\n");
 311 testcase_prepare("102", "test2", 0, "test comment", "");
 312
 313 printf("Expected error for snapshot_prepare on locked container\n");
 314 testcase_prepare("200", "test", 0, "test comment", "CT is locked (snapshot)\n");
 315
 316 printf("Expected error for snapshot_prepare with duplicate snapshot name\n");
 317 testcase_prepare("201", "test", 0, "test comment", "snapshot name 'test' already used\n");
 318
 319 printf("Expected error for snapshot_prepare with save_vmstate\n");
 320 testcase_prepare("202", "test", 1, "test comment", "implement me - snapshot_save_vmstate\n");
 321
 322 printf("\n");
 323 printf("Setting has_feature to return false\n");
 324 printf("\n");
 325 $snapshot_possible = 0;
 326
 327 printf("Expected error for snapshot_prepare if snapshots not possible\n");
 328 testcase_prepare("300", "test", 0, "test comment", "snapshot feature is not available\n");
 329
 330 printf("\n");
 331 printf("Running commit tests\n");
 332 printf("\n");
 333 $nodename = "commit";
 334
 335 printf("\n");
 336 printf("Setting has_feature to return true\n");
 337 printf("\n");
 338 $snapshot_possible = 1;
 339
 340 printf("Successful snapshot_commit with one prepared snapshot\n");
 341 testcase_commit("101", "test", "");
 342
 343 printf("Successful snapshot_commit with one committed and one prepared snapshot\n");
 344 testcase_commit("102", "test2", "");
 345
 346 printf("Expected error for snapshot_commit with no snapshot lock\n");
 347 testcase_commit("201", "test", "missing snapshot lock\n");
 348
 349 printf("Expected error for snapshot_commit with invalid snapshot name\n");
 350 testcase_commit("202", "test", "snapshot 'test' does not exist\n");
 351
 352 printf("Expected error for snapshot_commit with invalid snapshot state\n");
 353 testcase_commit("203", "test", "wrong snapshot state\n");
 354
 355 $vol_snapshot_possible->{"local:snapshotable-disk-1"} = 1;
 356 $vol_snapshot_possible->{"local:snapshotable-disk-2"} = 1;
 357 $vol_snapshot_possible->{"local:snapshotable-disk-3"} = 1;
 358 $vol_snapshot_delete_possible->{"local:snapshotable-disk-1"} = 1;
 359 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-1"} = 1;
 360 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-2"} = 1;
 361 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-3"} = 1;
 362 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-1"} = 1;
 363 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-2"} = 1;
 364 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-3"} = 1;
 365
 366 # possible, but fails
 367 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
 368
 369 printf("\n");
 370 printf("Setting up Mocking for PVE::Storage\n");
 371 my $storage_module = new Test::MockModule('PVE::Storage');
 372 $storage_module->mock('config', sub { return undef; });
 373 $storage_module->mock('volume_snapshot', \&mocked_volume_snapshot);
 374 $storage_module->mock('volume_snapshot_delete', \&mocked_volume_snapshot_delete);
 375 $storage_module->mock('volume_snapshot_rollback', \&mocked_volume_snapshot_rollback);
 376 $storage_module->mock('volume_rollback_is_possible', \&mocked_volume_rollback_is_possible);
 377 printf("\tconfig(), volume_snapshot(), volume_snapshot_delete(), volume_snapshot_rollback() and volume_rollback_is_possible() mocked\n");
 378
 379 printf("\n");
 380 printf("Setting up Mocking for PVE::Tools\n");
 381 my $tools_module = new Test::MockModule('PVE::Tools');
 382 $tools_module->mock('run_command' => \&mocked_run_command);
 383 printf("\trun_command() mocked\n");
 384
 385 $nodename = "create";
 386 printf("\n");
 387 printf("Running create tests\n");
 388 printf("\n");
 389
 390 printf("Successful snapshot_create with no existing snapshots\n");
 391 testcase_create("101", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test" });
 392
 393 printf("Successful snapshot_create with one existing snapshots\n");
 394 testcase_create("102", "test2", 0, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
 395
 396 printf("Successful snapshot_create with multiple mps\n");
 397 testcase_create("103", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
 398
 399 printf("Expected error for snapshot_create when volume snapshot is not possible\n");
 400 testcase_create("201", "test", 0, "test comment", "volume snapshot disabled\n\n");
 401
 402 printf("Expected error for snapshot_create with broken lxc-freeze\n");
 403 $freeze_possible = 0;
 404 testcase_create("202", "test", 0, "test comment", "lxc-[un]freeze disabled\n\n");
 405 $freeze_possible = 1;
 406
 407 printf("Expected error for snapshot_create when mp volume snapshot is not possible\n");
 408 testcase_create("203", "test", 0, "test comment", "volume snapshot disabled\n\n", { "local:snapshotable-disk-1" => "test" }, { "local:snapshotable-disk-1" => "test" });
 409
 410 $nodename = "delete";
 411 printf("\n");
 412 printf("Running delete tests\n");
 413 printf("\n");
 414
 415 printf("Successful snapshot_delete of only existing snapshot\n");
 416 testcase_delete("101", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
 417
 418 printf("Successful snapshot_delete of leaf snapshot\n");
 419 testcase_delete("102", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
 420
 421 printf("Successful snapshot_delete of root snapshot\n");
 422 testcase_delete("103", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
 423
 424 printf("Successful snapshot_delete of intermediate snapshot\n");
 425 testcase_delete("104", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
 426
 427 printf("Successful snapshot_delete with broken volume_snapshot_delete and force=1\n");
 428 testcase_delete("105", "test", 1, "");
 429
 430 printf("Successful snapshot_delete with mp broken volume_snapshot_delete and force=1\n");
 431 testcase_delete("106", "test", 1, "", { "local:snapshotable-disk-1" => "test" });
 432
 433 printf("Expected error when snapshot_delete fails with broken volume_snapshot_delete and force=0\n");
 434 testcase_delete("201", "test", 0, "volume snapshot delete disabled\n");
 435
 436 printf("Expected error when snapshot_delete fails with broken mp volume_snapshot_delete and force=0\n");
 437 testcase_delete("203", "test", 0, "volume snapshot delete disabled\n", { "local:snapshotable-disk-1" => "test" });
 438
 439 printf("Expected error for snapshot_delete with locked config\n");
 440 testcase_delete("202", "test", 0, "CT is locked (backup)\n");
 441
 442 $nodename = "rollback";
 443 printf("\n");
 444 printf("Running rollback tests\n");
 445 printf("\n");
 446
 447 $kill_possible = 1;
 448
 449 printf("Successful snapshot_rollback to only existing snapshot\n");
 450 testcase_rollback("101", "test", "", { "local:snapshotable-disk-1" => "test" });
 451
 452 printf("Successful snapshot_rollback to leaf snapshot\n");
 453 testcase_rollback("102", "test2", "", { "local:snapshotable-disk-1" => "test2" });
 454
 455 printf("Successful snapshot_rollback to root snapshot\n");
 456 testcase_rollback("103", "test", "", { "local:snapshotable-disk-1" => "test" });
 457
 458 printf("Successful snapshot_rollback to intermediate snapshot\n");
 459 testcase_rollback("104", "test2", "", { "local:snapshotable-disk-1" => "test2" });
 460
 461 printf("Successful snapshot_rollback with multiple mp\n");
 462 testcase_rollback("105", "test", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
 463
 464 printf("Expected error for snapshot_rollback with non-existing snapshot\n");
 465 testcase_rollback("201", "test2", "snapshot 'test2' does not exist\n");
 466
 467 printf("Expected error for snapshot_rollback if volume rollback not possible\n");
 468 testcase_rollback("202", "test", "volume_rollback_is_possible failed\n");
 469
 470 printf("Expected error for snapshot_rollback with incomplete snapshot\n");
 471 testcase_rollback("203", "test", "unable to rollback to incomplete snapshot (snapstate = delete)\n");
 472
 473 printf("Expected error for snapshot_rollback with lock\n");
 474 testcase_rollback("204", "test", "CT is locked (backup)\n");
 475
 476 printf("Expected error for snapshot_rollback with saved vmstate\n");
 477 testcase_rollback("205", "test", "implement me - save vmstate\n", { "local:snapshotable-disk-1" => "test" });
 478
 479 $kill_possible = 0;
 480
 481 printf("Expected error for snapshot_rollback with unkillable container\n");
 482 testcase_rollback("206", "test", "unable to rollback vm 206: vm is running\n");
 483
 484 $kill_possible = 1;
 485
 486 printf("Expected error for snapshot_rollback with mp rollback_is_possible failure\n");
 487 testcase_rollback("207", "test", "volume_rollback_is_possible failed\n");
 488
 489 printf("Expected error for snapshot_rollback with mp rollback failure (results in inconsistent state)\n");
 490 testcase_rollback("208", "test", "volume snapshot rollback disabled\n", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test" });
 491
 492 done_testing();