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_activate_volumes
{
108 my ($storecfg, $volumes) = @_;
109 die "Storage config not mocked! aborting\n"
110 if defined($storecfg);
111 die "wrong volume - fake vmstate expected!\n"
112 if ((scalar @$volumes != 1) || @$volumes[0] ne "somestorage:state-volume");
116 sub mocked_deactivate_volumes
{
117 my ($storecfg, $volumes) = @_;
118 die "Storage config not mocked! aborting\n"
119 if defined($storecfg);
120 die "wrong volume - fake vmstate expected!\n"
121 if ((scalar @$volumes != 1) || @$volumes[0] ne "somestorage:state-volume");
125 sub mocked_vdisk_free
{
126 my ($storecfg, $vmstate) = @_;
127 die "Storage config not mocked! aborting\n"
128 if defined($storecfg);
129 die "wrong vdisk - fake vmstate expected!\n"
130 if ($vmstate ne "somestorage:state-volume");
134 sub mocked_run_command
{
135 my ($cmd, %param) = @_;
137 if (my $ref = ref($cmd)) {
138 $cmdstring = PVE
::Tools
::cmd2string
($cmd);
139 if ($cmdstring =~ m/.*\/qemu-
(un
)?freeze
.*/) {
140 return 1 if $freeze_possible;
141 die "qemu-[un]freeze disabled\n";
143 if ($cmdstring =~ m/.*\/qemu-stop
.*--kill.*/) {
144 if ($stop_possible) {
152 die "unexpected run_command call: '$cmdstring', aborting\n";
158 my ($exp_fn, $real_fn) = @_;
161 $ret = system("diff -u '$exp_fn' '$real_fn'");
167 sub testcase_prepare
{
168 my ($vmid, $snapname, $save_vmstate, $comment, $exp_err) = @_;
169 subtest
"Preparing snapshot '$snapname' for vm '$vmid'" => sub {
173 PVE
::QemuConfig-
>__snapshot_prepare($vmid, $snapname, $save_vmstate, $comment);
175 is($@, $exp_err, "\$@ correct");
176 ok
(test_file
("snapshot-expected/prepare/qemu-server/$vmid.conf", "snapshot-working/prepare/qemu-server/$vmid.conf"), "config file correct");
180 sub testcase_commit
{
181 my ($vmid, $snapname, $exp_err) = @_;
182 subtest
"Committing snapshot '$snapname' for vm '$vmid'" => sub {
186 PVE
::QemuConfig-
>__snapshot_commit($vmid, $snapname);
188 is($@, $exp_err, "\$@ correct");
189 ok
(test_file
("snapshot-expected/commit/qemu-server/$vmid.conf", "snapshot-working/commit/qemu-server/$vmid.conf"), "config file correct");
193 sub testcase_create
{
194 my ($vmid, $snapname, $save_vmstate, $comment, $exp_err, $exp_vol_snap, $exp_vol_snap_delete) = @_;
195 subtest
"Creating snapshot '$snapname' for vm '$vmid'" => sub {
198 $vol_snapshot_delete = {};
199 $exp_vol_snap = {} if !defined($exp_vol_snap);
200 $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
203 PVE
::QemuConfig-
>snapshot_create($vmid, $snapname, $save_vmstate, $comment);
205 is($@, $exp_err, "\$@ correct");
206 is_deeply
($vol_snapshot, $exp_vol_snap, "created correct volume snapshots");
207 is_deeply
($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
208 ok
(test_file
("snapshot-expected/create/qemu-server/$vmid.conf", "snapshot-working/create/qemu-server/$vmid.conf"), "config file correct");
212 sub testcase_delete
{
213 my ($vmid, $snapname, $force, $exp_err, $exp_vol_snap_delete) = @_;
214 subtest
"Deleting snapshot '$snapname' of vm '$vmid'" => sub {
216 $vol_snapshot_delete = {};
217 $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
220 PVE
::QemuConfig-
>snapshot_delete($vmid, $snapname, $force);
222 is($@, $exp_err, "\$@ correct");
223 is_deeply
($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
224 ok
(test_file
("snapshot-expected/delete/qemu-server/$vmid.conf", "snapshot-working/delete/qemu-server/$vmid.conf"), "config file correct");
228 sub testcase_rollback
{
229 my ($vmid, $snapname, $exp_err, $exp_vol_snap_rollback) = @_;
230 subtest
"Rolling back to snapshot '$snapname' of vm '$vmid'" => sub {
232 $vol_snapshot_rollback = {};
234 $exp_vol_snap_rollback = {} if !defined($exp_vol_snap_rollback);
237 PVE
::QemuConfig-
>snapshot_rollback($vmid, $snapname);
239 is($@, $exp_err, "\$@ correct");
240 is_deeply
($vol_snapshot_rollback, $exp_vol_snap_rollback, "rolled back to correct volume snapshots");
241 ok
(test_file
("snapshot-expected/rollback/qemu-server/$vmid.conf", "snapshot-working/rollback/qemu-server/$vmid.conf"), "config file correct");
245 # BEGIN mocked PVE::QemuConfig methods
246 sub config_file_lock
{
247 return "snapshot-working/pve-test.lock";
250 sub cfs_config_path
{
251 my ($class, $vmid, $node) = @_;
253 $node = $nodename if !$node;
254 return "snapshot-working/$node/qemu-server/$vmid.conf";
258 my ($class, $vmid, $node) = @_;
260 my $filename = $class->cfs_config_path($vmid, $node);
262 my $raw = PVE
::Tools
::file_get_contents
($filename);
264 my $conf = PVE
::QemuServer
::parse_vm_config
($filename, $raw);
269 my ($class, $vmid, $conf) = @_;
271 my $filename = $class->cfs_config_path($vmid);
273 if ($conf->{snapshots
}) {
274 foreach my $snapname (keys %{$conf->{snapshots
}}) {
275 $conf->{snapshots
}->{$snapname}->{snaptime
} = "1234567890"
276 if $conf->{snapshots
}->{$snapname}->{snaptime
};
280 my $raw = PVE
::QemuServer
::write_vm_config
($filename, $conf);
282 PVE
::Tools
::file_set_contents
($filename, $raw);
286 my ($class, $feature, $conf, $storecfg, $snapname, $running, $backup_only) = @_;
287 return $snapshot_possible;
290 sub __snapshot_save_vmstate
{
291 my ($class, $vmid, $conf, $snapname, $storecfg) = @_;
292 die "save_vmstate failed\n"
293 if !$save_vmstate_works;
295 my $snap = $conf->{snapshots
}->{$snapname};
296 $snap->{vmstate
} = "somestorage:state-volume";
297 $snap->{machine
} = "somemachine";
299 # END mocked PVE::QemuConfig methods
301 # BEGIN redefine PVE::QemuServer methods
308 sub do_snapshots_with_qemu
{
313 my ($vmid, $cmd, $nocheck) = @_;
315 my $exec = $cmd->{execute
};
316 if ($exec eq "delete-drive-snapshot") {
319 if ($exec eq "guest-ping") {
320 die "guest-ping disabled\n"
321 if !$vm_mon->{guest_ping
};
324 if ($exec eq "guest-fsfreeze-freeze" || $exec eq "guest-fsfreeze-thaw") {
325 die "freeze disabled\n"
326 if !$freeze_possible;
329 if ($exec eq "savevm-start") {
330 die "savevm-start disabled\n"
331 if !$vm_mon->{savevm_start
};
334 if ($exec eq "savevm-end") {
335 die "savevm-end disabled\n"
336 if !$vm_mon->{savevm_end
};
339 if ($exec eq "query-savevm") {
340 return { "status" => "completed" };
342 die "unexpected vm_qmp_command!\n";
346 my ($storecfg, $vmid, $statefile, $skiplock, $migratedfrom, $paused, $forcemachine) = @_;
348 die "Storage config not mocked! aborting\n"
349 if defined($storecfg);
351 die "statefile and forcemachine must be both defined or undefined! aborting\n"
352 if defined($statefile) xor defined($forcemachine);
358 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive, $migratedfrom) = @_;
366 # END redefine PVE::QemuServer methods
368 PVE
::Tools
::run_command
("rm -rf snapshot-working");
369 PVE
::Tools
::run_command
("cp -a snapshot-input snapshot-working");
371 my $qemu_config_module = new Test
::MockModule
('PVE::QemuConfig');
372 $qemu_config_module->mock('config_file_lock', \
&config_file_lock
);
373 $qemu_config_module->mock('cfs_config_path', \
&cfs_config_path
);
374 $qemu_config_module->mock('load_config', \
&load_config
);
375 $qemu_config_module->mock('write_config', \
&write_config
);
376 $qemu_config_module->mock('has_feature', \
&has_feature
);
377 $qemu_config_module->mock('__snapshot_save_vmstate', \
&__snapshot_save_vmstate
);
380 $freeze_possible = 1;
381 $save_vmstate_works = 1;
384 printf("Running prepare tests\n");
386 $nodename = "prepare";
389 printf("Setting has_feature to return true\n");
391 $snapshot_possible = 1;
393 printf("Successful snapshot_prepare with no existing snapshots\n");
394 testcase_prepare
("101", "test", 0, "test comment", '');
396 printf("Successful snapshot_prepare with no existing snapshots, including vmstate\n");
397 testcase_prepare
("102", "test", 1, "test comment", '');
399 printf("Successful snapshot_prepare with one existing snapshot\n");
400 testcase_prepare
("103", "test2", 0, "test comment", "");
402 printf("Successful snapshot_prepare with one existing snapshot, including vmstate\n");
403 testcase_prepare
("104", "test2", 1, "test comment", "");
405 printf("Expected error for snapshot_prepare on locked container\n");
406 testcase_prepare
("200", "test", 0, "test comment", "VM is locked (snapshot)\n");
408 printf("Expected error for snapshot_prepare with duplicate snapshot name\n");
409 testcase_prepare
("201", "test", 0, "test comment", "snapshot name 'test' already used\n");
411 $save_vmstate_works = 0;
413 printf("Expected error for snapshot_prepare with failing save_vmstate\n");
414 testcase_prepare
("202", "test", 1, "test comment", "save_vmstate failed\n");
416 $save_vmstate_works = 1;
419 printf("Setting has_feature to return false\n");
421 $snapshot_possible = 0;
423 printf("Expected error for snapshot_prepare if snapshots not possible\n");
424 testcase_prepare
("300", "test", 0, "test comment", "snapshot feature is not available\n");
427 printf("Running commit tests\n");
429 $nodename = "commit";
432 printf("Setting has_feature to return true\n");
434 $snapshot_possible = 1;
436 printf("Successful snapshot_commit with one prepared snapshot\n");
437 testcase_commit
("101", "test", "");
439 printf("Successful snapshot_commit with one committed and one prepared snapshot\n");
440 testcase_commit
("102", "test2", "");
442 printf("Expected error for snapshot_commit with no snapshot lock\n");
443 testcase_commit
("201", "test", "missing snapshot lock\n");
445 printf("Expected error for snapshot_commit with invalid snapshot name\n");
446 testcase_commit
("202", "test", "snapshot 'test' does not exist\n");
448 printf("Expected error for snapshot_commit with invalid snapshot state\n");
449 testcase_commit
("203", "test", "wrong snapshot state\n");
451 $vol_snapshot_possible->{"local:snapshotable-disk-1"} = 1;
452 $vol_snapshot_possible->{"local:snapshotable-disk-2"} = 1;
453 $vol_snapshot_possible->{"local:snapshotable-disk-3"} = 1;
454 $vol_snapshot_delete_possible->{"local:snapshotable-disk-1"} = 1;
455 $vol_snapshot_delete_possible->{"local:snapshotable-disk-3"} = 1;
456 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-1"} = 1;
457 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-2"} = 1;
458 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-3"} = 1;
459 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-1"} = 1;
460 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-2"} = 1;
461 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-3"} = 1;
462 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
463 $vm_mon->{guest_ping
} = 1;
464 $vm_mon->{savevm_start
} = 1;
465 $vm_mon->{savevm_end
} = 1;
467 # possible, but fails
468 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
471 printf("Setting up Mocking for PVE::Storage\n");
472 my $storage_module = new Test
::MockModule
('PVE::Storage');
473 $storage_module->mock('config', sub { return undef; });
474 $storage_module->mock('path', sub { return "/some/store/statefile/path"; });
475 $storage_module->mock('activate_volumes', \
&mocked_activate_volumes
);
476 $storage_module->mock('deactivate_volumes', \
&mocked_deactivate_volumes
);
477 $storage_module->mock('vdisk_free', \
&mocked_vdisk_free
);
478 $storage_module->mock('volume_snapshot', \
&mocked_volume_snapshot
);
479 $storage_module->mock('volume_snapshot_delete', \
&mocked_volume_snapshot_delete
);
480 $storage_module->mock('volume_snapshot_rollback', \
&mocked_volume_snapshot_rollback
);
481 $storage_module->mock('volume_rollback_is_possible', \
&mocked_volume_rollback_is_possible
);
482 printf("\tconfig(), volume_snapshot(), volume_snapshot_delete(), volume_snapshot_rollback() and volume_rollback_is_possible() mocked\n");
485 #printf("Setting up Mocking for PVE::Tools\n");
486 #my $tools_module = new Test::MockModule('PVE::Tools');
487 #$tools_module->mock('run_command' => \&mocked_run_command);
488 #printf("\trun_command() mocked\n");
490 $nodename = "create";
492 printf("Running create tests\n");
495 printf("Successful snapshot_create with no existing snapshots\n");
496 testcase_create
("101", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test" });
498 printf("Successful snapshot_create with no existing snapshots, including vmstate\n");
499 testcase_create
("102", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
501 printf("Successful snapshot_create with one existing snapshots\n");
502 testcase_create
("103", "test2", 0, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
504 printf("Successful snapshot_create with one existing snapshots, including vmstate\n");
505 testcase_create
("104", "test2", 1, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
507 printf("Successful snapshot_create with multiple mps\n");
508 testcase_create
("105", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
510 $freeze_possible = 0;
511 printf("Successful snapshot_create with no existing snapshots and broken freeze\n");
512 testcase_create
("106", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
513 $freeze_possible = 1;
515 printf("Expected error for snapshot_create when volume snapshot is not possible\n");
516 testcase_create
("201", "test", 0, "test comment", "volume snapshot disabled\n\n");
518 printf("Expected error for snapshot_create when volume snapshot is not possible for one drive\n");
519 testcase_create
("202", "test", 0, "test comment", "volume snapshot disabled\n\n", { "local:snapshotable-disk-1" => "test" }, { "local:snapshotable-disk-1" => "test" });
521 $vm_mon->{savevm_start
} = 0;
522 printf("Expected error for snapshot_create when Qemu mon command 'savevm-start' fails\n");
523 testcase_create
("203", "test", 0, "test comment", "savevm-start disabled\n\n");
524 $vm_mon->{savevm_start
} = 1;
527 $nodename = "delete";
529 printf("Running delete tests\n");
532 printf("Successful snapshot_delete of only existing snapshot\n");
533 testcase_delete
("101", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
535 printf("Successful snapshot_delete of leaf snapshot\n");
536 testcase_delete
("102", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
538 printf("Successful snapshot_delete of root snapshot\n");
539 testcase_delete
("103", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
541 printf("Successful snapshot_delete of intermediate snapshot\n");
542 testcase_delete
("104", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
544 printf("Successful snapshot_delete with broken volume_snapshot_delete and force=1\n");
545 testcase_delete
("105", "test", 1, "");
547 printf("Successful snapshot_delete with mp broken volume_snapshot_delete and force=1\n");
548 testcase_delete
("106", "test", 1, "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-3" => "test" });
550 printf("Expected error when snapshot_delete fails with broken volume_snapshot_delete and force=0\n");
551 testcase_delete
("201", "test", 0, "volume snapshot delete disabled\n");
553 printf("Expected error when snapshot_delete fails with broken mp volume_snapshot_delete and force=0\n");
554 testcase_delete
("202", "test", 0, "volume snapshot delete disabled\n", { "local:snapshotable-disk-1" => "test" });
556 printf("Expected error for snapshot_delete with locked config\n");
557 testcase_delete
("203", "test", 0, "VM is locked (backup)\n");
559 $nodename = "rollback";
561 printf("Running rollback tests\n");
566 printf("Successful snapshot_rollback to only existing snapshot\n");
567 testcase_rollback
("101", "test", "", { "local:snapshotable-disk-1" => "test" });
569 printf("Successful snapshot_rollback to leaf snapshot\n");
570 testcase_rollback
("102", "test2", "", { "local:snapshotable-disk-1" => "test2" });
572 printf("Successful snapshot_rollback to root snapshot\n");
573 testcase_rollback
("103", "test", "", { "local:snapshotable-disk-1" => "test" });
575 printf("Successful snapshot_rollback to intermediate snapshot\n");
576 testcase_rollback
("104", "test2", "", { "local:snapshotable-disk-1" => "test2" });
578 printf("Successful snapshot_rollback with multiple mp\n");
579 testcase_rollback
("105", "test", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
581 printf("Successful snapshot_rollback to only existing snapshot, with saved vmstate and machine config\n");
582 testcase_rollback
("106", "test", "", { "local:snapshotable-disk-1" => "test" });
584 printf("Expected error for snapshot_rollback with non-existing snapshot\n");
585 testcase_rollback
("201", "test2", "snapshot 'test2' does not exist\n");
587 printf("Expected error for snapshot_rollback if volume rollback not possible\n");
588 testcase_rollback
("202", "test", "volume_rollback_is_possible failed\n");
590 printf("Expected error for snapshot_rollback with incomplete snapshot\n");
591 testcase_rollback
("203", "test", "unable to rollback to incomplete snapshot (snapstate = delete)\n");
593 printf("Expected error for snapshot_rollback with lock\n");
594 testcase_rollback
("204", "test", "VM is locked (backup)\n");
598 printf("Expected error for snapshot_rollback with unkillable container\n");
599 testcase_rollback
("205", "test", "unable to rollback vm 205: vm is running\n");
603 printf("Expected error for snapshot_rollback with mp rollback_is_possible failure\n");
604 testcase_rollback
("206", "test", "volume_rollback_is_possible failed\n");
606 printf("Expected error for snapshot_rollback with mp rollback failure (results in inconsistent state)\n");
607 testcase_rollback
("207", "test", "volume snapshot rollback disabled\n", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test" });