1 package PVE
::QemuServer
; ## no critic
9 use PVE
::Storage
::Plugin
;
13 use PVE
::ReplicationConfig
;
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 = {};
30 my $save_vmstate_works;
35 sub mocked_volume_snapshot
{
36 my ($storecfg, $volid, $snapname) = @_;
37 die "Storage config not mocked! aborting\n"
38 if defined($storecfg);
39 die "volid undefined\n"
41 die "snapname undefined\n"
42 if !defined($snapname);
43 if ($vol_snapshot_possible->{$volid}) {
44 if (defined($vol_snapshot->{$volid})) {
45 $vol_snapshot->{$volid} .= ",$snapname";
47 $vol_snapshot->{$volid} = $snapname;
51 die "volume snapshot disabled\n";
55 sub mocked_volume_snapshot_delete
{
56 my ($storecfg, $volid, $snapname) = @_;
57 die "Storage config not mocked! aborting\n"
58 if defined($storecfg);
59 die "volid undefined\n"
61 die "snapname undefined\n"
62 if !defined($snapname);
63 if ($vol_snapshot_delete_possible->{$volid}) {
64 if (defined($vol_snapshot_delete->{$volid})) {
65 $vol_snapshot_delete->{$volid} .= ",$snapname";
67 $vol_snapshot_delete->{$volid} = $snapname;
71 die "volume snapshot delete disabled\n";
75 sub mocked_volume_snapshot_rollback
{
76 my ($storecfg, $volid, $snapname) = @_;
77 die "Storage config not mocked! aborting\n"
78 if defined($storecfg);
79 die "volid undefined\n"
81 die "snapname undefined\n"
82 if !defined($snapname);
83 if ($vol_snapshot_rollback_enabled->{$volid}) {
84 if (defined($vol_snapshot_rollback->{$volid})) {
85 $vol_snapshot_rollback->{$volid} .= ",$snapname";
87 $vol_snapshot_rollback->{$volid} = $snapname;
91 die "volume snapshot rollback disabled\n";
95 sub mocked_volume_rollback_is_possible
{
96 my ($storecfg, $volid, $snapname) = @_;
97 die "Storage config not mocked! aborting\n"
98 if defined($storecfg);
99 die "volid undefined\n"
101 die "snapname undefined\n"
102 if !defined($snapname);
103 return $vol_snapshot_rollback_possible->{$volid}
104 if ($vol_snapshot_rollback_possible->{$volid});
105 die "volume_rollback_is_possible failed\n";
108 sub mocked_activate_volumes
{
109 my ($storecfg, $volumes) = @_;
110 die "Storage config not mocked! aborting\n"
111 if defined($storecfg);
112 die "wrong volume - fake vmstate expected!\n"
113 if ((scalar @$volumes != 1) || @$volumes[0] ne "somestorage:state-volume");
117 sub mocked_deactivate_volumes
{
118 my ($storecfg, $volumes) = @_;
119 die "Storage config not mocked! aborting\n"
120 if defined($storecfg);
121 die "wrong volume - fake vmstate expected!\n"
122 if ((scalar @$volumes != 1) || @$volumes[0] ne "somestorage:state-volume");
126 sub mocked_vdisk_free
{
127 my ($storecfg, $vmstate) = @_;
128 die "Storage config not mocked! aborting\n"
129 if defined($storecfg);
130 die "wrong vdisk - fake vmstate expected!\n"
131 if ($vmstate ne "somestorage:state-volume");
135 sub mocked_run_command
{
136 my ($cmd, %param) = @_;
138 if (my $ref = ref($cmd)) {
139 $cmdstring = PVE
::Tools
::cmd2string
($cmd);
140 if ($cmdstring =~ m/.*\/qemu-
(un
)?freeze
.*/) {
141 return 1 if $freeze_possible;
142 die "qemu-[un]freeze disabled\n";
144 if ($cmdstring =~ m/.*\/qemu-stop
.*--kill.*/) {
145 if ($stop_possible) {
153 die "unexpected run_command call: '$cmdstring', aborting\n";
159 my ($exp_fn, $real_fn) = @_;
162 $ret = system("diff -u '$exp_fn' '$real_fn'");
168 sub testcase_prepare
{
169 my ($vmid, $snapname, $save_vmstate, $comment, $exp_err) = @_;
170 subtest
"Preparing snapshot '$snapname' for vm '$vmid'" => sub {
174 PVE
::QemuConfig-
>__snapshot_prepare($vmid, $snapname, $save_vmstate, $comment);
176 is($@, $exp_err, "\$@ correct");
177 ok
(test_file
("snapshot-expected/prepare/qemu-server/$vmid.conf", "snapshot-working/prepare/qemu-server/$vmid.conf"), "config file correct");
181 sub testcase_commit
{
182 my ($vmid, $snapname, $exp_err) = @_;
183 subtest
"Committing snapshot '$snapname' for vm '$vmid'" => sub {
187 PVE
::QemuConfig-
>__snapshot_commit($vmid, $snapname);
189 is($@, $exp_err, "\$@ correct");
190 ok
(test_file
("snapshot-expected/commit/qemu-server/$vmid.conf", "snapshot-working/commit/qemu-server/$vmid.conf"), "config file correct");
194 sub testcase_create
{
195 my ($vmid, $snapname, $save_vmstate, $comment, $exp_err, $exp_vol_snap, $exp_vol_snap_delete) = @_;
196 subtest
"Creating snapshot '$snapname' for vm '$vmid'" => sub {
199 $vol_snapshot_delete = {};
200 $exp_vol_snap = {} if !defined($exp_vol_snap);
201 $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
204 PVE
::QemuConfig-
>snapshot_create($vmid, $snapname, $save_vmstate, $comment);
206 is($@, $exp_err, "\$@ correct");
207 is_deeply
($vol_snapshot, $exp_vol_snap, "created correct volume snapshots");
208 is_deeply
($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
209 ok
(test_file
("snapshot-expected/create/qemu-server/$vmid.conf", "snapshot-working/create/qemu-server/$vmid.conf"), "config file correct");
213 sub testcase_delete
{
214 my ($vmid, $snapname, $force, $exp_err, $exp_vol_snap_delete) = @_;
215 subtest
"Deleting snapshot '$snapname' of vm '$vmid'" => sub {
217 $vol_snapshot_delete = {};
218 $exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
221 PVE
::QemuConfig-
>snapshot_delete($vmid, $snapname, $force);
223 is($@, $exp_err, "\$@ correct");
224 is_deeply
($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
225 ok
(test_file
("snapshot-expected/delete/qemu-server/$vmid.conf", "snapshot-working/delete/qemu-server/$vmid.conf"), "config file correct");
229 sub testcase_rollback
{
230 my ($vmid, $snapname, $exp_err, $exp_vol_snap_rollback) = @_;
231 subtest
"Rolling back to snapshot '$snapname' of vm '$vmid'" => sub {
233 $vol_snapshot_rollback = {};
235 $exp_vol_snap_rollback = {} if !defined($exp_vol_snap_rollback);
238 PVE
::QemuConfig-
>snapshot_rollback($vmid, $snapname);
240 is($@, $exp_err, "\$@ correct");
241 is_deeply
($vol_snapshot_rollback, $exp_vol_snap_rollback, "rolled back to correct volume snapshots");
242 ok
(test_file
("snapshot-expected/rollback/qemu-server/$vmid.conf", "snapshot-working/rollback/qemu-server/$vmid.conf"), "config file correct");
246 # BEGIN mocked PVE::QemuConfig methods
247 sub config_file_lock
{
248 return "snapshot-working/pve-test.lock";
251 sub cfs_config_path
{
252 my ($class, $vmid, $node) = @_;
254 $node = $nodename if !$node;
255 return "snapshot-working/$node/qemu-server/$vmid.conf";
259 my ($class, $vmid, $node) = @_;
261 my $filename = $class->cfs_config_path($vmid, $node);
263 my $raw = PVE
::Tools
::file_get_contents
($filename);
265 my $conf = PVE
::QemuServer
::parse_vm_config
($filename, $raw);
270 my ($class, $vmid, $conf) = @_;
272 my $filename = $class->cfs_config_path($vmid);
274 if ($conf->{snapshots
}) {
275 foreach my $snapname (keys %{$conf->{snapshots
}}) {
276 $conf->{snapshots
}->{$snapname}->{snaptime
} = "1234567890"
277 if $conf->{snapshots
}->{$snapname}->{snaptime
};
281 my $raw = PVE
::QemuServer
::write_vm_config
($filename, $conf);
283 PVE
::Tools
::file_set_contents
($filename, $raw);
287 my ($class, $feature, $conf, $storecfg, $snapname, $running, $backup_only) = @_;
288 return $snapshot_possible;
291 sub __snapshot_save_vmstate
{
292 my ($class, $vmid, $conf, $snapname, $storecfg) = @_;
293 die "save_vmstate failed\n"
294 if !$save_vmstate_works;
296 my $snap = $conf->{snapshots
}->{$snapname};
297 $snap->{vmstate
} = "somestorage:state-volume";
298 $snap->{runningmachine
} = "somemachine"
301 sub assert_config_exists_on_node
{
302 my ($vmid, $node) = @_;
303 return -f cfs_config_path
("PVE::QemuConfig", $vmid, $node);
305 # END mocked PVE::QemuConfig methods
307 # BEGIN mocked PVE::QemuServer::Helpers methods
309 sub vm_running_locally
{
313 # END mocked PVE::QemuServer::Helpers methods
315 # BEGIN mocked PVE::QemuServer::Monitor methods
318 my ($vmid, $cmd) = @_;
320 my $exec = $cmd->{execute
};
321 if ($exec eq "delete-drive-snapshot") {
324 if ($exec eq "guest-ping") {
325 die "guest-ping disabled\n"
326 if !$vm_mon->{guest_ping
};
329 if ($exec eq "guest-fsfreeze-freeze" || $exec eq "guest-fsfreeze-thaw") {
330 die "freeze disabled\n"
331 if !$freeze_possible;
334 if ($exec eq "savevm-start") {
335 die "savevm-start disabled\n"
336 if !$vm_mon->{savevm_start
};
339 if ($exec eq "savevm-end") {
340 die "savevm-end disabled\n"
341 if !$vm_mon->{savevm_end
};
344 if ($exec eq "query-savevm") {
346 "status" => "completed",
347 "bytes" => 1024*1024*1024,
348 "total-time" => 5000,
351 die "unexpected vm_qmp_command!\n";
354 # END mocked PVE::QemuServer::Monitor methods
356 # BEGIN redefine PVE::QemuServer methods
358 sub do_snapshots_with_qemu
{
363 my ($storecfg, $vmid, $params, $migrate_opts) = @_;
365 die "Storage config not mocked! aborting\n"
366 if defined($storecfg);
368 die "statefile and forcemachine must be both defined or undefined! aborting\n"
369 if defined($params->{statefile
}) xor defined($params->{forcemachine
});
375 my ($storecfg, $vmid, $skiplock, $nocheck, $timeout, $shutdown, $force, $keepActive, $migratedfrom) = @_;
383 # END redefine PVE::QemuServer methods
385 PVE
::Tools
::run_command
("rm -rf snapshot-working");
386 PVE
::Tools
::run_command
("cp -a snapshot-input snapshot-working");
388 my $qemu_helpers_module = Test
::MockModule-
>new('PVE::QemuServer::Helpers');
389 $qemu_helpers_module->mock('vm_running_locally', \
&vm_running_locally
);
391 my $qemu_monitor_module = Test
::MockModule-
>new('PVE::QemuServer::Monitor');
392 $qemu_monitor_module->mock('qmp_cmd', \
&qmp_cmd
);
394 my $qemu_config_module = Test
::MockModule-
>new('PVE::QemuConfig');
395 $qemu_config_module->mock('config_file_lock', \
&config_file_lock
);
396 $qemu_config_module->mock('cfs_config_path', \
&cfs_config_path
);
397 $qemu_config_module->mock('load_config', \
&load_config
);
398 $qemu_config_module->mock('write_config', \
&write_config
);
399 $qemu_config_module->mock('has_feature', \
&has_feature
);
400 $qemu_config_module->mock('__snapshot_save_vmstate', \
&__snapshot_save_vmstate
);
401 $qemu_config_module->mock('assert_config_exists_on_node', \
&assert_config_exists_on_node
);
403 # ignore existing replication config
404 my $repl_config_module = Test
::MockModule-
>new('PVE::ReplicationConfig');
405 $repl_config_module->mock('new' => sub { return bless {}, "PVE::ReplicationConfig" });
406 $repl_config_module->mock('check_for_existing_jobs' => sub { return });
408 my $storage_module = Test
::MockModule-
>new('PVE::Storage');
409 $storage_module->mock('config', sub { return; });
410 $storage_module->mock('path', sub { return "/some/store/statefile/path"; });
411 $storage_module->mock('activate_volumes', \
&mocked_activate_volumes
);
412 $storage_module->mock('deactivate_volumes', \
&mocked_deactivate_volumes
);
413 $storage_module->mock('vdisk_free', \
&mocked_vdisk_free
);
414 $storage_module->mock('volume_snapshot', \
&mocked_volume_snapshot
);
415 $storage_module->mock('volume_snapshot_delete', \
&mocked_volume_snapshot_delete
);
416 $storage_module->mock('volume_snapshot_rollback', \
&mocked_volume_snapshot_rollback
);
417 $storage_module->mock('volume_rollback_is_possible', \
&mocked_volume_rollback_is_possible
);
420 $freeze_possible = 1;
421 $save_vmstate_works = 1;
424 printf("Running prepare tests\n");
426 $nodename = "prepare";
429 printf("Setting has_feature to return true\n");
431 $snapshot_possible = 1;
433 printf("Successful snapshot_prepare with no existing snapshots\n");
434 testcase_prepare
("101", "test", 0, "test comment", '');
436 printf("Successful snapshot_prepare with no existing snapshots, including vmstate\n");
437 testcase_prepare
("102", "test", 1, "test comment", '');
439 printf("Successful snapshot_prepare with one existing snapshot\n");
440 testcase_prepare
("103", "test2", 0, "test comment", "");
442 printf("Successful snapshot_prepare with one existing snapshot, including vmstate\n");
443 testcase_prepare
("104", "test2", 1, "test comment", "");
445 printf("Expected error for snapshot_prepare on locked container\n");
446 testcase_prepare
("200", "test", 0, "test comment", "VM is locked (snapshot)\n");
448 printf("Expected error for snapshot_prepare with duplicate snapshot name\n");
449 testcase_prepare
("201", "test", 0, "test comment", "snapshot name 'test' already used\n");
451 $save_vmstate_works = 0;
453 printf("Expected error for snapshot_prepare with failing save_vmstate\n");
454 testcase_prepare
("202", "test", 1, "test comment", "save_vmstate failed\n");
456 $save_vmstate_works = 1;
459 printf("Setting has_feature to return false\n");
461 $snapshot_possible = 0;
463 printf("Expected error for snapshot_prepare if snapshots not possible\n");
464 testcase_prepare
("300", "test", 0, "test comment", "snapshot feature is not available\n");
467 printf("Running commit tests\n");
469 $nodename = "commit";
472 printf("Setting has_feature to return true\n");
474 $snapshot_possible = 1;
476 printf("Successful snapshot_commit with one prepared snapshot\n");
477 testcase_commit
("101", "test", "");
479 printf("Successful snapshot_commit with one committed and one prepared snapshot\n");
480 testcase_commit
("102", "test2", "");
482 printf("Expected error for snapshot_commit with no snapshot lock\n");
483 testcase_commit
("201", "test", "missing snapshot lock\n");
485 printf("Expected error for snapshot_commit with invalid snapshot name\n");
486 testcase_commit
("202", "test", "snapshot 'test' does not exist\n");
488 printf("Expected error for snapshot_commit with invalid snapshot state\n");
489 testcase_commit
("203", "test", "wrong snapshot state\n");
491 $vol_snapshot_possible->{"local:snapshotable-disk-1"} = 1;
492 $vol_snapshot_possible->{"local:snapshotable-disk-2"} = 1;
493 $vol_snapshot_possible->{"local:snapshotable-disk-3"} = 1;
494 $vol_snapshot_delete_possible->{"local:snapshotable-disk-1"} = 1;
495 $vol_snapshot_delete_possible->{"local:snapshotable-disk-3"} = 1;
496 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-1"} = 1;
497 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-2"} = 1;
498 $vol_snapshot_rollback_enabled->{"local:snapshotable-disk-3"} = 1;
499 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-1"} = 1;
500 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-2"} = 1;
501 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-3"} = 1;
502 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
503 $vm_mon->{guest_ping
} = 1;
504 $vm_mon->{savevm_start
} = 1;
505 $vm_mon->{savevm_end
} = 1;
507 # possible, but fails
508 $vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;
512 #printf("Setting up Mocking for PVE::Tools\n");
513 #my $tools_module = Test::MockModule->new('PVE::Tools');
514 #$tools_module->mock('run_command' => \&mocked_run_command);
515 #printf("\trun_command() mocked\n");
517 $nodename = "create";
519 printf("Running create tests\n");
522 printf("Successful snapshot_create with no existing snapshots\n");
523 testcase_create
("101", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test" });
525 printf("Successful snapshot_create with no existing snapshots, including vmstate\n");
526 testcase_create
("102", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
528 printf("Successful snapshot_create with one existing snapshots\n");
529 testcase_create
("103", "test2", 0, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
531 printf("Successful snapshot_create with one existing snapshots, including vmstate\n");
532 testcase_create
("104", "test2", 1, "test comment", "", { "local:snapshotable-disk-1" => "test2" });
534 printf("Successful snapshot_create with multiple mps\n");
535 testcase_create
("105", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
537 $freeze_possible = 0;
538 printf("Successful snapshot_create with no existing snapshots and broken freeze\n");
539 testcase_create
("106", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
540 $freeze_possible = 1;
542 printf("Expected error for snapshot_create when volume snapshot is not possible\n");
543 testcase_create
("201", "test", 0, "test comment", "volume snapshot disabled\n\n");
545 printf("Expected error for snapshot_create when volume snapshot is not possible for one drive\n");
546 testcase_create
("202", "test", 0, "test comment", "volume snapshot disabled\n\n", { "local:snapshotable-disk-1" => "test" }, { "local:snapshotable-disk-1" => "test" });
548 $vm_mon->{savevm_start
} = 0;
549 printf("Expected error for snapshot_create when Qemu mon command 'savevm-start' fails\n");
550 testcase_create
("203", "test", 0, "test comment", "savevm-start disabled\n\n");
551 $vm_mon->{savevm_start
} = 1;
553 printf("Successful snapshot_create with no existing snapshots but set machine type\n");
554 testcase_create
("301", "test", 1, "test comment", "", { "local:snapshotable-disk-1" => "test" });
556 $nodename = "delete";
558 printf("Running delete tests\n");
561 printf("Successful snapshot_delete of only existing snapshot\n");
562 testcase_delete
("101", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
564 printf("Successful snapshot_delete of leaf snapshot\n");
565 testcase_delete
("102", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
567 printf("Successful snapshot_delete of root snapshot\n");
568 testcase_delete
("103", "test", 0, "", { "local:snapshotable-disk-1" => "test" });
570 printf("Successful snapshot_delete of intermediate snapshot\n");
571 testcase_delete
("104", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });
573 printf("Successful snapshot_delete with broken volume_snapshot_delete and force=1\n");
574 testcase_delete
("105", "test", 1, "");
576 printf("Successful snapshot_delete with mp broken volume_snapshot_delete and force=1\n");
577 testcase_delete
("106", "test", 1, "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-3" => "test" });
579 printf("Expected error when snapshot_delete fails with broken volume_snapshot_delete and force=0\n");
580 testcase_delete
("201", "test", 0, "volume snapshot delete disabled\n");
582 printf("Expected error when snapshot_delete fails with broken mp volume_snapshot_delete and force=0\n");
583 testcase_delete
("202", "test", 0, "volume snapshot delete disabled\n", { "local:snapshotable-disk-1" => "test" });
585 printf("Expected error for snapshot_delete with locked config\n");
586 testcase_delete
("203", "test", 0, "VM is locked (backup)\n");
588 $nodename = "rollback";
590 printf("Running rollback tests\n");
595 printf("Successful snapshot_rollback to only existing snapshot\n");
596 testcase_rollback
("101", "test", "", { "local:snapshotable-disk-1" => "test" });
598 printf("Successful snapshot_rollback to leaf snapshot\n");
599 testcase_rollback
("102", "test2", "", { "local:snapshotable-disk-1" => "test2" });
601 printf("Successful snapshot_rollback to root snapshot\n");
602 testcase_rollback
("103", "test", "", { "local:snapshotable-disk-1" => "test" });
604 printf("Successful snapshot_rollback to intermediate snapshot\n");
605 testcase_rollback
("104", "test2", "", { "local:snapshotable-disk-1" => "test2" });
607 printf("Successful snapshot_rollback with multiple mp\n");
608 testcase_rollback
("105", "test", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });
610 printf("Successful snapshot_rollback to only existing snapshot, with saved vmstate and machine config\n");
611 testcase_rollback
("106", "test", "", { "local:snapshotable-disk-1" => "test" });
613 printf("Expected error for snapshot_rollback with non-existing snapshot\n");
614 testcase_rollback
("201", "test2", "snapshot 'test2' does not exist\n");
616 printf("Expected error for snapshot_rollback if volume rollback not possible\n");
617 testcase_rollback
("202", "test", "volume_rollback_is_possible failed\n");
619 printf("Expected error for snapshot_rollback with incomplete snapshot\n");
620 testcase_rollback
("203", "test", "unable to rollback to incomplete snapshot (snapstate = delete)\n");
622 printf("Expected error for snapshot_rollback with lock\n");
623 testcase_rollback
("204", "test", "VM is locked (backup)\n");
627 printf("Expected error for snapshot_rollback with unkillable container\n");
628 testcase_rollback
("205", "test", "unable to rollback vm 205: vm is running\n");
632 printf("Expected error for snapshot_rollback with mp rollback_is_possible failure\n");
633 testcase_rollback
("206", "test", "volume_rollback_is_possible failed\n");
635 printf("Expected error for snapshot_rollback with mp rollback failure (results in inconsistent state)\n");
636 testcase_rollback
("207", "test", "volume snapshot rollback disabled\n", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test" });
638 printf("Successful snapshot_rollback with saved vmstate and machine config only in snapshot\n");
639 testcase_rollback
("301", "test", "", { "local:snapshotable-disk-1" => "test" });
641 printf("Successful snapshot_rollback with saved vmstate and machine config and runningmachine \n");
642 testcase_rollback
("302", "test", "", { "local:snapshotable-disk-1" => "test" });