src/test/snapshot-test.pm

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