src/test/snapshot-test.pm

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