[pve-container.git] / src / test / snapshot-test.pm

package PVE::LXC::Test;

use strict;
use warnings;

use lib qw(..);

use PVE::Storage;
use PVE::Storage::Plugin;
use PVE::LXC;
use PVE::LXC::Config;
use PVE::Tools;
use PVE::ReplicationConfig;

use Test::MockModule;
use Test::More;

my $nodename;
my $snapshot_possible;
my $vol_snapshot_possible = {};
my $vol_snapshot_delete_possible = {};
my $vol_snapshot_rollback_possible = {};
my $vol_snapshot_rollback_enabled = {};
my $vol_snapshot = {};
my $vol_snapshot_delete = {};
my $vol_snapshot_rollback = {};
my $running;
my $freeze_possible;
my $kill_possible;

# Mocked methods

sub mocked_has_feature {
    my ($feature, $conf, $storecfg, $snapname) = @_;
    return $snapshot_possible;
}

sub mocked_check_running {
    return $running;
}

sub mocked_volume_snapshot {
    my ($storecfg, $volid, $snapname) = @_;
    die "Storage config not mocked! aborting\n"
	if defined($storecfg);
    die "volid undefined\n"
	if !defined($volid);
    die "snapname undefined\n"
	if !defined($snapname);
    if ($vol_snapshot_possible->{$volid}) {
	if (defined($vol_snapshot->{$volid})) {
	    $vol_snapshot->{$volid} .= ",$snapname";
	} else {
	    $vol_snapshot->{$volid} = $snapname;
	}
	return 1;
    } else {
	die "volume snapshot disabled\n";
    }
}

sub mocked_volume_snapshot_delete {
    my ($storecfg, $volid, $snapname) = @_;
    die "Storage config not mocked! aborting\n"
	if defined($storecfg);
    die "volid undefined\n"
	if !defined($volid);
    die "snapname undefined\n"
	if !defined($snapname);
    if ($vol_snapshot_delete_possible->{$volid}) {
	if (defined($vol_snapshot_delete->{$volid})) {
	    $vol_snapshot_delete->{$volid} .= ",$snapname";
	} else {
	    $vol_snapshot_delete->{$volid} = $snapname;
	}
	return 1;
    } else {
	die "volume snapshot delete disabled\n";
    }
}

sub mocked_volume_snapshot_rollback {
    my ($storecfg, $volid, $snapname) = @_;
    die "Storage config not mocked! aborting\n"
	if defined($storecfg);
    die "volid undefined\n"
	if !defined($volid);
    die "snapname undefined\n"
	if !defined($snapname);
    if ($vol_snapshot_rollback_enabled->{$volid}) {
	if (defined($vol_snapshot_rollback->{$volid})) {
	    $vol_snapshot_rollback->{$volid} .= ",$snapname";
	} else {
	    $vol_snapshot_rollback->{$volid} = $snapname;
	}
	return 1;
    } else {
	die "volume snapshot rollback disabled\n";
    }
}

sub mocked_volume_rollback_is_possible {
    my ($storecfg, $volid, $snapname) = @_;
    die "Storage config not mocked! aborting\n"
	if defined($storecfg);
    die "volid undefined\n"
	if !defined($volid);
    die "snapname undefined\n"
	if !defined($snapname);
    return $vol_snapshot_rollback_possible->{$volid}
	if ($vol_snapshot_rollback_possible->{$volid});
    die "volume_rollback_is_possible failed\n";
}

sub mocked_vm_stop {
    if ($kill_possible) {
	$running = 0;
	return 1;
    } else {
	return 0;
    }
}

sub mocked_run_command {
    my ($cmd, %param) = @_;
    my $cmdstring;
    if (my $ref = ref($cmd)) {
	$cmdstring = PVE::Tools::cmd2string($cmd);
	if ($cmdstring =~ m/.*\/lxc-(un)?freeze.*/) {
	    return 1 if $freeze_possible;
	    die "lxc-[un]freeze disabled\n";
	}
	if ($cmdstring =~ m/.*\/lxc-stop.*--kill.*/) {
	    mocked_vm_stop();
	}
    }
    die "unexpected run_command call: '$cmdstring', aborting\n";
}

# Testing methods

sub test_file {
    my ($exp_fn, $real_fn) = @_;
    my $ret;
    eval {
	$ret = system("diff -u '$exp_fn' '$real_fn'");
    };
    die if $@;
    return !$ret;
}

sub testcase_prepare {
    my ($vmid, $snapname, $save_vmstate, $comment, $exp_err) = @_;
    subtest "Preparing snapshot '$snapname' for vm '$vmid'" => sub {
	plan tests => 2;
	$@ = undef;
	eval {
	    PVE::LXC::Config->__snapshot_prepare($vmid, $snapname, $save_vmstate, $comment);
	};
	is($@, $exp_err, "\$@ correct");
	ok(test_file("snapshot-expected/prepare/lxc/$vmid.conf", "snapshot-working/prepare/lxc/$vmid.conf"), "config file correct");
    };
}

sub testcase_commit {
    my ($vmid, $snapname, $exp_err) = @_;
    subtest "Committing snapshot '$snapname' for vm '$vmid'" => sub {
	plan tests => 2;
	$@ = undef;
	eval {
	    PVE::LXC::Config->__snapshot_commit($vmid, $snapname);
	};
	is($@, $exp_err, "\$@ correct");
	ok(test_file("snapshot-expected/commit/lxc/$vmid.conf", "snapshot-working/commit/lxc/$vmid.conf"), "config file correct");
    }
}

sub testcase_create {
    my ($vmid, $snapname, $save_vmstate, $comment, $exp_err, $exp_vol_snap, $exp_vol_snap_delete) = @_;
    subtest "Creating snapshot '$snapname' for vm '$vmid'" => sub {
	plan tests => 4;
	$vol_snapshot = {};
	$vol_snapshot_delete = {};
	$exp_vol_snap = {} if !defined($exp_vol_snap);
	$exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
	$@ = undef;
	eval {
	    PVE::LXC::Config->snapshot_create($vmid, $snapname, $save_vmstate, $comment);
	};
	is($@, $exp_err, "\$@ correct");
	is_deeply($vol_snapshot, $exp_vol_snap, "created correct volume snapshots");
	is_deeply($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
	ok(test_file("snapshot-expected/create/lxc/$vmid.conf", "snapshot-working/create/lxc/$vmid.conf"), "config file correct");
    };
}

sub testcase_delete {
    my ($vmid, $snapname, $force, $exp_err, $exp_vol_snap_delete) = @_;
    subtest "Deleting snapshot '$snapname' of vm '$vmid'" => sub {
	plan tests => 3;
	$vol_snapshot_delete = {};
	$exp_vol_snap_delete = {} if !defined($exp_vol_snap_delete);
	$@ = undef;
	eval {
	    PVE::LXC::Config->snapshot_delete($vmid, $snapname, $force);
	};
	is($@, $exp_err, "\$@ correct");
	is_deeply($vol_snapshot_delete, $exp_vol_snap_delete, "deleted correct volume snapshots");
	ok(test_file("snapshot-expected/delete/lxc/$vmid.conf", "snapshot-working/delete/lxc/$vmid.conf"), "config file correct");
    };
}

sub testcase_rollback {
    my ($vmid, $snapname, $exp_err, $exp_vol_snap_rollback) = @_;
    subtest "Rolling back to snapshot '$snapname' of vm '$vmid'" => sub {
	plan tests => 3;
	$vol_snapshot_rollback = {};
	$running = 1;
	$exp_vol_snap_rollback = {} if !defined($exp_vol_snap_rollback);
	$@ = undef;
	eval {
	    PVE::LXC::Config->snapshot_rollback($vmid, $snapname);
	};
	is($@, $exp_err, "\$@ correct");
	is_deeply($vol_snapshot_rollback, $exp_vol_snap_rollback, "rolled back to correct volume snapshots");
	ok(test_file("snapshot-expected/rollback/lxc/$vmid.conf", "snapshot-working/rollback/lxc/$vmid.conf"), "config file correct");
    };
}

# BEGIN mocked PVE::LXC::Config methods
sub mocked_config_file_lock {
    return "snapshot-working/pve-test.lock";
}

sub mocked_cfs_config_path {
    my ($class, $vmid, $node) = @_;

    $node = $nodename if !$node;
    return "snapshot-working/$node/lxc/$vmid.conf";
}

sub mocked_load_config {
    my ($class, $vmid, $node) = @_;

    my $filename = PVE::LXC::Config->cfs_config_path($vmid, $node);

    my $raw = PVE::Tools::file_get_contents($filename);

    my $conf = PVE::LXC::Config::parse_pct_config($filename, $raw);
    return $conf;
}

sub mocked_write_config {
    my ($class, $vmid, $conf) = @_;

    my $filename = PVE::LXC::Config->cfs_config_path($vmid);

    if ($conf->{snapshots}) {
	foreach my $snapname (keys %{$conf->{snapshots}}) {
	    $conf->{snapshots}->{$snapname}->{snaptime} = "1234567890"
		if $conf->{snapshots}->{$snapname}->{snaptime};
	}
    }

    my $raw = PVE::LXC::Config::write_pct_config($filename, $conf);

    PVE::Tools::file_set_contents($filename, $raw);
}

# END mocked PVE::LXC methods


PVE::Tools::run_command("rm -rf snapshot-working");
PVE::Tools::run_command("cp -a snapshot-input snapshot-working");

printf("\n");
printf("Setting up Mocking for PVE::LXC and PVE::LXC::Config\n");
my $lxc_module = new Test::MockModule('PVE::LXC');
$lxc_module->mock('sync_container_namespace', sub { return; });
$lxc_module->mock('check_running', \&mocked_check_running);
$lxc_module->mock('vm_stop', \&mocked_vm_stop);

my $lxc_config_module = new Test::MockModule('PVE::LXC::Config');
$lxc_config_module->mock('config_file_lock', sub { return "snapshot-working/pve-test.lock"; });
$lxc_config_module->mock('cfs_config_path', \&mocked_cfs_config_path);
$lxc_config_module->mock('load_config', \&mocked_load_config);
$lxc_config_module->mock('write_config', \&mocked_write_config);
$lxc_config_module->mock('has_feature', \&mocked_has_feature);

# ignore existing replication config
my $repl_config_module = new Test::MockModule('PVE::ReplicationConfig');
$repl_config_module->mock('check_for_existing_jobs' => sub { return undef });

$running = 1;
$freeze_possible = 1;

printf("\n");
printf("Running prepare tests\n");
printf("\n");
$nodename = "prepare";

printf("\n");
printf("Setting has_feature to return true\n");
printf("\n");
$snapshot_possible = 1;

printf("Successful snapshot_prepare with no existing snapshots\n");
testcase_prepare("101", "test", 0, "test comment", '');

printf("Successful snapshot_prepare with one existing snapshot\n");
testcase_prepare("102", "test2", 0, "test comment", "");

printf("Expected error for snapshot_prepare on locked container\n");
testcase_prepare("200", "test", 0, "test comment", "CT is locked (snapshot)\n");

printf("Expected error for snapshot_prepare with duplicate snapshot name\n");
testcase_prepare("201", "test", 0, "test comment", "snapshot name 'test' already used\n");

printf("Expected error for snapshot_prepare with save_vmstate\n");
testcase_prepare("202", "test", 1, "test comment", "implement me - snapshot_save_vmstate\n");

printf("\n");
printf("Setting has_feature to return false\n");
printf("\n");
$snapshot_possible = 0;

printf("Expected error for snapshot_prepare if snapshots not possible\n");
testcase_prepare("300", "test", 0, "test comment", "snapshot feature is not available\n");

printf("\n");
printf("Running commit tests\n");
printf("\n");
$nodename = "commit";

printf("\n");
printf("Setting has_feature to return true\n");
printf("\n");
$snapshot_possible = 1;

printf("Successful snapshot_commit with one prepared snapshot\n");
testcase_commit("101", "test", "");

printf("Successful snapshot_commit with one committed and one prepared snapshot\n");
testcase_commit("102", "test2", "");

printf("Expected error for snapshot_commit with no snapshot lock\n");
testcase_commit("201", "test", "missing snapshot lock\n");

printf("Expected error for snapshot_commit with invalid snapshot name\n");
testcase_commit("202", "test", "snapshot 'test' does not exist\n");

printf("Expected error for snapshot_commit with invalid snapshot state\n");
testcase_commit("203", "test", "wrong snapshot state\n");

$vol_snapshot_possible->{"local:snapshotable-disk-1"} = 1;
$vol_snapshot_possible->{"local:snapshotable-disk-2"} = 1;
$vol_snapshot_possible->{"local:snapshotable-disk-3"} = 1;
$vol_snapshot_delete_possible->{"local:snapshotable-disk-1"} = 1;
$vol_snapshot_rollback_enabled->{"local:snapshotable-disk-1"} = 1;
$vol_snapshot_rollback_enabled->{"local:snapshotable-disk-2"} = 1;
$vol_snapshot_rollback_enabled->{"local:snapshotable-disk-3"} = 1;
$vol_snapshot_rollback_possible->{"local:snapshotable-disk-1"} = 1;
$vol_snapshot_rollback_possible->{"local:snapshotable-disk-2"} = 1;
$vol_snapshot_rollback_possible->{"local:snapshotable-disk-3"} = 1;

# possible, but fails
$vol_snapshot_rollback_possible->{"local:snapshotable-disk-4"} = 1;

printf("\n");
printf("Setting up Mocking for PVE::Storage\n");
my $storage_module = new Test::MockModule('PVE::Storage');
$storage_module->mock('config', sub { return undef; });
$storage_module->mock('volume_snapshot', \&mocked_volume_snapshot);
$storage_module->mock('volume_snapshot_delete', \&mocked_volume_snapshot_delete);
$storage_module->mock('volume_snapshot_rollback', \&mocked_volume_snapshot_rollback);
$storage_module->mock('volume_rollback_is_possible', \&mocked_volume_rollback_is_possible);
printf("\tconfig(), volume_snapshot(), volume_snapshot_delete(), volume_snapshot_rollback() and volume_rollback_is_possible() mocked\n");

printf("\n");
printf("Setting up Mocking for PVE::Tools\n");
my $tools_module = new Test::MockModule('PVE::Tools');
$tools_module->mock('run_command' => \&mocked_run_command);
printf("\trun_command() mocked\n");

$nodename = "create";
printf("\n");
printf("Running create tests\n");
printf("\n");

printf("Successful snapshot_create with no existing snapshots\n");
testcase_create("101", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test" });

printf("Successful snapshot_create with one existing snapshots\n");
testcase_create("102", "test2", 0, "test comment", "", { "local:snapshotable-disk-1" => "test2" });

printf("Successful snapshot_create with multiple mps\n");
testcase_create("103", "test", 0, "test comment", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });

printf("Expected error for snapshot_create when volume snapshot is not possible\n");
testcase_create("201", "test", 0, "test comment", "volume snapshot disabled\n\n");

printf("Expected error for snapshot_create with broken lxc-freeze\n");
$freeze_possible = 0;
testcase_create("202", "test", 0, "test comment", "lxc-[un]freeze disabled\n\n");
$freeze_possible = 1;

printf("Expected error for snapshot_create when mp volume snapshot is not possible\n");
testcase_create("203", "test", 0, "test comment", "volume snapshot disabled\n\n", { "local:snapshotable-disk-1" => "test" }, { "local:snapshotable-disk-1" => "test" });

$nodename = "delete";
printf("\n");
printf("Running delete tests\n");
printf("\n");

printf("Successful snapshot_delete of only existing snapshot\n");
testcase_delete("101", "test", 0, "", { "local:snapshotable-disk-1" => "test" });

printf("Successful snapshot_delete of leaf snapshot\n");
testcase_delete("102", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });

printf("Successful snapshot_delete of root snapshot\n");
testcase_delete("103", "test", 0, "", { "local:snapshotable-disk-1" => "test" });

printf("Successful snapshot_delete of intermediate snapshot\n");
testcase_delete("104", "test2", 0, "", { "local:snapshotable-disk-1" => "test2" });

printf("Successful snapshot_delete with broken volume_snapshot_delete and force=1\n");
testcase_delete("105", "test", 1, "");

printf("Successful snapshot_delete with mp broken volume_snapshot_delete and force=1\n");
testcase_delete("106", "test", 1, "", { "local:snapshotable-disk-1" => "test" });

printf("Expected error when snapshot_delete fails with broken volume_snapshot_delete and force=0\n");
testcase_delete("201", "test", 0, "volume snapshot delete disabled\n");

printf("Expected error when snapshot_delete fails with broken mp volume_snapshot_delete and force=0\n");
testcase_delete("203", "test", 0, "volume snapshot delete disabled\n", { "local:snapshotable-disk-1" => "test" });

printf("Expected error for snapshot_delete with locked config\n");
testcase_delete("202", "test", 0, "CT is locked (backup)\n");

$nodename = "rollback";
printf("\n");
printf("Running rollback tests\n");
printf("\n");

$kill_possible = 1;

printf("Successful snapshot_rollback to only existing snapshot\n");
testcase_rollback("101", "test", "", { "local:snapshotable-disk-1" => "test" });

printf("Successful snapshot_rollback to leaf snapshot\n");
testcase_rollback("102", "test2", "", { "local:snapshotable-disk-1" => "test2" });

printf("Successful snapshot_rollback to root snapshot\n");
testcase_rollback("103", "test", "", { "local:snapshotable-disk-1" => "test" });

printf("Successful snapshot_rollback to intermediate snapshot\n");
testcase_rollback("104", "test2", "", { "local:snapshotable-disk-1" => "test2" });

printf("Successful snapshot_rollback with multiple mp\n");
testcase_rollback("105", "test", "", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test", "local:snapshotable-disk-3" => "test" });

printf("Expected error for snapshot_rollback with non-existing snapshot\n");
testcase_rollback("201", "test2", "snapshot 'test2' does not exist\n");

printf("Expected error for snapshot_rollback if volume rollback not possible\n");
testcase_rollback("202", "test", "volume_rollback_is_possible failed\n");

printf("Expected error for snapshot_rollback with incomplete snapshot\n");
testcase_rollback("203", "test", "unable to rollback to incomplete snapshot (snapstate = delete)\n");

printf("Expected error for snapshot_rollback with lock\n");
testcase_rollback("204", "test", "CT is locked (backup)\n");

printf("Expected error for snapshot_rollback with saved vmstate\n");
testcase_rollback("205", "test", "implement me - save vmstate\n", { "local:snapshotable-disk-1" => "test" });

$kill_possible = 0;

printf("Expected error for snapshot_rollback with unkillable container\n");
testcase_rollback("206", "test", "unable to rollback vm 206: vm is running\n");

$kill_possible = 1;

printf("Expected error for snapshot_rollback with mp rollback_is_possible failure\n");
testcase_rollback("207", "test", "volume_rollback_is_possible failed\n");

printf("Expected error for snapshot_rollback with mp rollback failure (results in inconsistent state)\n");
testcase_rollback("208", "test", "volume snapshot rollback disabled\n", { "local:snapshotable-disk-1" => "test", "local:snapshotable-disk-2" => "test" });

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