1 package PVE
::QemuServer
;
9 use PVE
::Storage
::Plugin
;
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 = {};
29 my $save_vmstate_works;
34 sub mocked_volume_snapshot
{
35 my ($storecfg, $volid, $snapname) = @_;
36 die "Storage config not mocked! aborting\n"
37 if defined($storecfg);
38 die "volid undefined\n"
40 die "snapname undefined\n"
41 if !defined($snapname);
42 if ($vol_snapshot_possible->{$volid}) {
43 if (defined($vol_snapshot->{$volid})) {
44 $vol_snapshot->{$volid} .= ",$snapname";
46 $vol_snapshot->{$volid} = $snapname;
50 die "volume snapshot disabled\n";
54 sub mocked_volume_snapshot_delete
{
55 my ($storecfg, $volid, $snapname) = @_;
56 die "Storage config not mocked! aborting\n"
57 if defined($storecfg);
58 die "volid undefined\n"
60 die "snapname undefined\n"
61 if !defined($snapname);
62 if ($vol_snapshot_delete_possible->{$volid}) {
63 if (defined($vol_snapshot_delete->{$volid})) {
64 $vol_snapshot_delete->{$volid} .= ",$snapname";
66 $vol_snapshot_delete->{$volid} = $snapname;
70 die "volume snapshot delete disabled\n";
74 sub mocked_volume_snapshot_rollback
{
75 my ($storecfg, $volid, $snapname) = @_;
76 die "Storage config not mocked! aborting\n"
77 if defined($storecfg);
78 die "volid undefined\n"
80 die "snapname undefined\n"
81 if !defined($snapname);
82 if ($vol_snapshot_rollback_enabled->{$volid}) {
83 if (defined($vol_snapshot_rollback->{$volid})) {
84 $vol_snapshot_rollback->{$volid} .= ",$snapname";
86 $vol_snapshot_rollback->{$volid} = $snapname;
90 die "volume snapshot rollback disabled\n";
94 sub mocked_volume_rollback_is_possible
{
95 my ($storecfg, $volid, $snapname) = @_;
96 die "Storage config not mocked! aborting\n"
97 if defined($storecfg);
98 die "volid undefined\n"
100 die "snapname undefined\n"
101 if !defined($snapname);
102 return $vol_snapshot_rollback_possible->{$volid}
103 if ($vol_snapshot_rollback_possible->{$volid});
104 die "volume_rollback_is_possible failed\n";
107 sub mocked_vdisk_free
{
108 my ($storecfg, $vmstate) = @_;
109 die "Storage config not mocked! aborting\n"
110 if defined($storecfg);
111 die "wrong vdisk - fake vmstate expected!\n"
112 if ($vmstate ne "somestorage:state-volume");
116 sub mocked_run_command
{
117 my ($cmd, %param) = @_;
119 if (my $ref = ref($cmd)) {
120 $cmdstring = PVE
::Tools
::cmd2string
($cmd);
121 if ($cmdstring =~ m/.*\/qemu-
(un
)?freeze
.*/) {
122 return 1 if $freeze_possible;
123 die "qemu-[un]freeze disabled\n";
125 if ($cmdstring =~ m/.*\/qemu-stop
.*--kill.*/) {
126 if ($stop_possible) {
134 die "unexpected run_command call: '$cmdstring', aborting\n";
140 my ($exp_fn, $real_fn) = @_;
143 $ret = system("diff -u '$exp_fn' '$real_fn'");
149 sub testcase_prepare
{
150 my ($vmid, $snapname, $save_vmstate, $comment, $exp_err) = @_;
151 subtest
"Preparing snapshot '$snapname' for vm '$vmid'" => sub {
155 PVE
::QemuConfig-
>__snapshot_prepare($vmid, $snapname, $save_vmstate, $comment);
157 is($@, $exp_err, "\$@ correct");
158 ok
(test_file
("snapshot-expected/prepare/qemu-server/$vmid.conf", "snapshot-working/prepare/qemu-server/$vmid.conf"), "config file correct");
162 sub testcase_commit
{
163 my ($vmid, $snapname, $exp_err) = @_;
164 subtest
"Committing snapshot '$snapname' for vm '$vmid'" => sub {
168 PVE
::QemuConfig-
>__snapshot_commit($vmid, $snapname);
170 is($@, $exp_err, "\$@ correct");
171 ok
(test_file
("snapshot-expected/commit/qemu-server/$vmid.conf", "snapshot-working/commit/qemu-server/$vmid.conf"), "config file correct");
175 sub testcase_create
{
176 my ($vmid, $snapname, $save_vmstate, $comment, $exp_err, $exp_vol_snap, $exp_vol_snap_delete) = @_;
177 subtest
"Creating snapshot '$snapname' for vm '$vmid'" => sub {
180 $vol_snapshot_delete = {};
181 $exp_vol_snap = {} if !defined($exp_vol_snap);
182 $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
185 PVE
::QemuConfig-
>snapshot_create($vmid, $snapname, $save_vmstate, $comment);
187 is($@, $exp_err, "\$@ correct");
188 is_deeply
($vol_snapshot, $exp_vol_snap, "created correct volume snapshots");
189 is_deeply
($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
190 ok
(test_file
("snapshot-expected/create/qemu-server/$vmid.conf", "snapshot-working/create/qemu-server/$vmid.conf"), "config file correct");
194 sub testcase_delete
{
195 my ($vmid, $snapname, $force, $exp_err, $exp_vol_snap_delete) = @_;
196 subtest
"Deleting snapshot '$snapname' of vm '$vmid'" => sub {
198 $vol_snapshot_delete = {};
199 $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
202 PVE
::QemuConfig-
>snapshot_delete($vmid, $snapname, $force);
204 is($@, $exp_err, "\$@ correct");
205 is_deeply
($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
206 ok
(test_file
("snapshot-expected/delete/qemu-server/$vmid.conf", "snapshot-working/delete/qemu-server/$vmid.conf"), "config file correct");
210 sub testcase_rollback
{
211 my ($vmid, $snapname, $exp_err, $exp_vol_snap_rollback) = @_;
212 subtest
"Rolling back to snapshot '$snapname' of vm '$vmid'" => sub {
214 $vol_snapshot_rollback = {};
216 $exp_vol_snap_rollback = {} if !defined($exp_vol_snap_rollback);
219 PVE
::QemuConfig-
>snapshot_rollback($vmid, $snapname);
221 is($@, $exp_err, "\$@ correct");
222 is_deeply
($vol_snapshot_rollback, $exp_vol_snap_rollback, "rolled back to correct volume snapshots");
223 ok
(test_file
("snapshot-expected/rollback/qemu-server/$vmid.conf", "snapshot-working/rollback/qemu-server/$vmid.conf"), "config file correct");
227 # BEGIN mocked PVE::QemuConfig methods
228 sub config_file_lock
{
229 return "snapshot-working/pve-test.lock";
232 sub cfs_config_path
{
233 my ($class, $vmid, $node) = @_;
235 $node = $nodename if !$node;
236 return "snapshot-working/$node/qemu-server/$vmid.conf";
240 my ($class, $vmid, $node) = @_;
242 my $filename = $class->cfs_config_path($vmid, $node);
244 my $raw = PVE
::Tools
::file_get_contents
($filename);
246 my $conf = PVE
::QemuServer
::parse_vm_config
($filename, $raw);
251 my ($class, $vmid, $conf) = @_;
253 my $filename = $class->cfs_config_path($vmid);
255 if ($conf->{snapshots
}) {
256 foreach my $snapname (keys %{$conf->{snapshots
}}) {
257 $conf->{snapshots
}->{$snapname}->{snaptime
} = "1234567890"
258 if $conf->{snapshots
}->{$snapname}->{snaptime
};
262 my $raw = PVE
::QemuServer
::write_vm_config
($filename, $conf);
264 PVE
::Tools
::file_set_contents
($filename, $raw);
268 my ($class, $feature, $conf, $storecfg, $snapname, $running, $backup_only) = @_;
269 return $snapshot_possible;
272 sub __snapshot_save_vmstate
{
273 my ($class, $vmid, $conf, $snapname, $storecfg) = @_;
274 die "save_vmstate failed\n"
275 if !$save_vmstate_works;
277 my $snap = $conf->{snapshots
}->{$snapname};
278 $snap->{vmstate
} = "somestorage:state-volume";
279 $snap->{machine
} = "somemachine";
281 # END mocked PVE::QemuConfig methods
283 # BEGIN redefine PVE::QemuServer methods
290 sub do_snapshots_with_qemu
{
295 my ($vmid, $cmd, $nocheck) = @_;
297 my $exec = $cmd->{execute
};
298 if ($exec eq "delete-drive-snapshot") {
301 if ($exec eq "guest-ping") {
302 die "guest-ping disabled\n"
303 if !$vm_mon->{guest_ping
};
306 if ($exec eq "guest-fsfreeze-freeze" || $exec eq "guest-fsfreeze-thaw") {
307 die "freeze disabled\n"
308 if !$freeze_possible;
311 if ($exec eq "savevm-start") {
312 die "savevm-start disabled\n"
313 if !$vm_mon->{savevm_start
};
316 if ($exec eq "savevm-end") {
317 die "savevm-end disabled\n"
318 if !$vm_mon->{savevm_end
};
321 if ($exec eq "query-savevm") {
322 return { "status" => "completed" };
324 die "unexpected vm_qmp_command!\n";
328 my ($storecfg, $vmid, $statefile, $skiplock, $migratedfrom, $paused, $forcemachine) = @_;
330 die "Storage config not mocked! aborting\n"
331 if defined($storecfg);
333 die "statefile and forcemachine must be both defined or undefined! aborting\n"
334 if defined($statefile) xor defined($forcemachine);
340 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive, $migratedfrom) = @_;
348 # END redefine PVE::QemuServer methods
350 PVE
::Tools
::run_command
("rm -rf snapshot-working");
351 PVE
::Tools
::run_command
("cp -a snapshot-input snapshot-working");
353 my $qemu_config_module = new Test
::MockModule
('PVE::QemuConfig');
354 $qemu_config_module->mock('config_file_lock', \
&config_file_lock
);
355 $qemu_config_module->mock('cfs_config_path', \
&cfs_config_path
);
356 $qemu_config_module->mock('load_config', \
&load_config
);
357 $qemu_config_module->mock('write_config', \
&write_config
);
358 $qemu_config_module->mock('has_feature', \
&has_feature
);
359 $qemu_config_module->mock('__snapshot_save_vmstate', \
&__snapshot_save_vmstate
);
362 $freeze_possible = 1;
363 $save_vmstate_works = 1;
366 printf("Running prepare tests\n");
368 $nodename = "prepare";
371 printf("Setting has_feature to return true\n");
373 $snapshot_possible = 1;
375 printf("Successful snapshot_prepare with no existing snapshots\n");
376 testcase_prepare
("101", "test", 0, "test comment", '');
378 printf("Successful snapshot_prepare with no existing snapshots, including vmstate\n");
379 testcase_prepare
("102", "test", 1, "test comment", '');
381 printf("Successful snapshot_prepare with one existing snapshot\n");
382 testcase_prepare
("103", "test2", 0, "test comment", "");
384 printf("Successful snapshot_prepare with one existing snapshot, including vmstate\n");
385 testcase_prepare
("104", "test2", 1, "test comment", "");
387 printf("Expected error for snapshot_prepare on locked container\n");
388 testcase_prepare
("200", "test", 0, "test comment", "VM is locked (snapshot)\n");
390 printf("Expected error for snapshot_prepare with duplicate snapshot name\n");
391 testcase_prepare
("201", "test", 0, "test comment", "snapshot name 'test' already used\n");
393 $save_vmstate_works = 0;
395 printf("Expected error for snapshot_prepare with failing save_vmstate\n");
396 testcase_prepare
("202", "test", 1, "test comment", "save_vmstate failed\n");
398 $save_vmstate_works = 1;
401 printf("Setting has_feature to return false\n");
403 $snapshot_possible = 0;
405 printf("Expected error for snapshot_prepare if snapshots not possible\n");
406 testcase_prepare
("300", "test", 0, "test comment", "snapshot feature is not available\n");
409 printf("Running commit tests\n");
411 $nodename = "commit";
414 printf("Setting has_feature to return true\n");
416 $snapshot_possible = 1;
418 printf("Successful snapshot_commit with one prepared snapshot\n");
419 testcase_commit
("101", "test", "");
421 printf("Successful snapshot_commit with one committed and one prepared snapshot\n");
422 testcase_commit
("102", "test2", "");
424 printf("Expected error for snapshot_commit with no snapshot lock\n");
425 testcase_commit
("201", "test", "missing snapshot lock\n");
427 printf("Expected error for snapshot_commit with invalid snapshot name\n");
428 testcase_commit
("202", "test", "snapshot 'test' does not exist\n");
430 printf("Expected error for snapshot_commit with invalid snapshot state\n");
431 testcase_commit
("203", "test", "wrong snapshot state\n");
433 $vol_snapshot_possible->{"local:snapshotable-disk-1"} = 1;
434 $vol_snapshot_possible->{"local:snapshotable-disk-2"} = 1;
435 $vol_snapshot_possible->{"local:snapshotable-disk-3"} = 1;
436 $vol_snapshot_delete_possible->{"local:snapshotable-disk-1"} = 1;
437 $vol_snapshot_delete_possible->{"local:snapshotable-disk-3"} = 1;
438 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-1"} = 1;
439 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-2"} = 1;
440 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-3"} = 1;
441 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-1"} = 1;
442 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-2"} = 1;
443 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-3"} = 1;
444 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
445 $vm_mon->{guest_ping
} = 1;
446 $vm_mon->{savevm_start
} = 1;
447 $vm_mon->{savevm_end
} = 1;
449 # possible, but fails
450 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
453 printf("Setting up Mocking for PVE::Storage\n");
454 my $storage_module = new Test
::MockModule
('PVE::Storage');
455 $storage_module->mock('config', sub { return undef; });
456 $storage_module->mock('path', sub { return "/some/store/statefile/path"; });
457 $storage_module->mock('vdisk_free', \
&mocked_vdisk_free
);
458 $storage_module->mock('volume_snapshot', \
&mocked_volume_snapshot
);
459 $storage_module->mock('volume_snapshot_delete', \
&mocked_volume_snapshot_delete
);
460 $storage_module->mock('volume_snapshot_rollback', \
&mocked_volume_snapshot_rollback
);
461 $storage_module->mock('volume_rollback_is_possible', \
&mocked_volume_rollback_is_possible
);
462 printf("\tconfig(), volume_snapshot(), volume_snapshot_delete(), volume_snapshot_rollback() and volume_rollback_is_possible() mocked\n");
465 #printf("Setting up Mocking for PVE::Tools\n");
466 #my $tools_module = new Test::MockModule('PVE::Tools');
467 #$tools_module->mock('run_command' => \&mocked_run_command);
468 #printf("\trun_command() mocked\n");
470 $nodename = "create";
472 printf("Running create tests\n");
475 printf("Successful snapshot_create with no existing snapshots\n");
476 testcase_create
("101", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test" });
478 printf("Successful snapshot_create with no existing snapshots, including vmstate\n");
479 testcase_create
("102", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
481 printf("Successful snapshot_create with one existing snapshots\n");
482 testcase_create
("103", "test2", 0, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
484 printf("Successful snapshot_create with one existing snapshots, including vmstate\n");
485 testcase_create
("104", "test2", 1, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
487 printf("Successful snapshot_create with multiple mps\n");
488 testcase_create
("105", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
490 $freeze_possible = 0;
491 printf("Successful snapshot_create with no existing snapshots and broken freeze\n");
492 testcase_create
("106", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
493 $freeze_possible = 1;
495 printf("Expected error for snapshot_create when volume snapshot is not possible\n");
496 testcase_create
("201", "test", 0, "test comment", "volume snapshot disabled\n\n");
498 printf("Expected error for snapshot_create when volume snapshot is not possible for one drive\n");
499 testcase_create
("202", "test", 0, "test comment", "volume snapshot disabled\n\n", { "local:snapshotable-disk-1" => "test" }, { "local:snapshotable-disk-1" => "test" });
501 $vm_mon->{savevm_start
} = 0;
502 printf("Expected error for snapshot_create when Qemu mon command 'savevm-start' fails\n");
503 testcase_create
("203", "test", 0, "test comment", "savevm-start disabled\n\n");
504 $vm_mon->{savevm_start
} = 1;
507 $nodename = "delete";
509 printf("Running delete tests\n");
512 printf("Successful snapshot_delete of only existing snapshot\n");
513 testcase_delete
("101", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
515 printf("Successful snapshot_delete of leaf snapshot\n");
516 testcase_delete
("102", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
518 printf("Successful snapshot_delete of root snapshot\n");
519 testcase_delete
("103", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
521 printf("Successful snapshot_delete of intermediate snapshot\n");
522 testcase_delete
("104", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
524 printf("Successful snapshot_delete with broken volume_snapshot_delete and force=1\n");
525 testcase_delete
("105", "test", 1, "");
527 printf("Successful snapshot_delete with mp broken volume_snapshot_delete and force=1\n");
528 testcase_delete
("106", "test", 1, "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-3" => "test" });
530 printf("Expected error when snapshot_delete fails with broken volume_snapshot_delete and force=0\n");
531 testcase_delete
("201", "test", 0, "volume snapshot delete disabled\n");
533 printf("Expected error when snapshot_delete fails with broken mp volume_snapshot_delete and force=0\n");
534 testcase_delete
("202", "test", 0, "volume snapshot delete disabled\n", { "local:snapshotable-disk-1" => "test" });
536 printf("Expected error for snapshot_delete with locked config\n");
537 testcase_delete
("203", "test", 0, "VM is locked (backup)\n");
539 $nodename = "rollback";
541 printf("Running rollback tests\n");
546 printf("Successful snapshot_rollback to only existing snapshot\n");
547 testcase_rollback
("101", "test", "", { "local:snapshotable-disk-1" => "test" });
549 printf("Successful snapshot_rollback to leaf snapshot\n");
550 testcase_rollback
("102", "test2", "", { "local:snapshotable-disk-1" => "test2" });
552 printf("Successful snapshot_rollback to root snapshot\n");
553 testcase_rollback
("103", "test", "", { "local:snapshotable-disk-1" => "test" });
555 printf("Successful snapshot_rollback to intermediate snapshot\n");
556 testcase_rollback
("104", "test2", "", { "local:snapshotable-disk-1" => "test2" });
558 printf("Successful snapshot_rollback with multiple mp\n");
559 testcase_rollback
("105", "test", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
561 printf("Successful snapshot_rollback to only existing snapshot, with saved vmstate and machine config\n");
562 testcase_rollback
("106", "test", "", { "local:snapshotable-disk-1" => "test" });
564 printf("Expected error for snapshot_rollback with non-existing snapshot\n");
565 testcase_rollback
("201", "test2", "snapshot 'test2' does not exist\n");
567 printf("Expected error for snapshot_rollback if volume rollback not possible\n");
568 testcase_rollback
("202", "test", "volume_rollback_is_possible failed\n");
570 printf("Expected error for snapshot_rollback with incomplete snapshot\n");
571 testcase_rollback
("203", "test", "unable to rollback to incomplete snapshot (snapstate = delete)\n");
573 printf("Expected error for snapshot_rollback with lock\n");
574 testcase_rollback
("204", "test", "VM is locked (backup)\n");
578 printf("Expected error for snapshot_rollback with unkillable container\n");
579 testcase_rollback
("205", "test", "unable to rollback vm 205: vm is running\n");
583 printf("Expected error for snapshot_rollback with mp rollback_is_possible failure\n");
584 testcase_rollback
("206", "test", "volume_rollback_is_possible failed\n");
586 printf("Expected error for snapshot_rollback with mp rollback failure (results in inconsistent state)\n");
587 testcase_rollback
("207", "test", "volume snapshot rollback disabled\n", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test" });