[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_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.*/) {
	    if ($kill_possible) {
		$running = 0;
		return 1;
	    } else {
		return 0;
	    }
	}
    }
    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);

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