restic/internal/snapshot_policy_test.go

package restic_test

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"path/filepath"
	"reflect"
	"testing"
	"time"

	"github.com/restic/restic/internal"
)

func parseTimeUTC(s string) time.Time {
	t, err := time.Parse("2006-01-02 15:04:05", s)
	if err != nil {
		panic(err)
	}

	return t.UTC()
}

func TestExpireSnapshotOps(t *testing.T) {
	data := []struct {
		expectEmpty bool
		expectSum   int
		p           *restic.ExpirePolicy
	}{
		{true, 0, &restic.ExpirePolicy{}},
		{true, 0, &restic.ExpirePolicy{Tags: []restic.TagList{}}},
		{false, 22, &restic.ExpirePolicy{Daily: 7, Weekly: 2, Monthly: 3, Yearly: 10}},
	}
	for i, d := range data {
		isEmpty := d.p.Empty()
		if isEmpty != d.expectEmpty {
			t.Errorf("empty test %v: wrong result, want:\n  %#v\ngot:\n  %#v", i, d.expectEmpty, isEmpty)
		}
		hasSum := d.p.Sum()
		if hasSum != d.expectSum {
			t.Errorf("sum test %v: wrong result, want:\n  %#v\ngot:\n  %#v", i, d.expectSum, hasSum)
		}
	}
}

var testExpireSnapshots = restic.Snapshots{
	{Time: parseTimeUTC("2014-09-01 10:20:30")},
	{Time: parseTimeUTC("2014-09-02 10:20:30")},
	{Time: parseTimeUTC("2014-09-05 10:20:30")},
	{Time: parseTimeUTC("2014-09-06 10:20:30")},
	{Time: parseTimeUTC("2014-09-08 10:20:30")},
	{Time: parseTimeUTC("2014-09-09 10:20:30")},
	{Time: parseTimeUTC("2014-09-10 10:20:30")},
	{Time: parseTimeUTC("2014-09-11 10:20:30")},
	{Time: parseTimeUTC("2014-09-20 10:20:30")},
	{Time: parseTimeUTC("2014-09-22 10:20:30")},
	{Time: parseTimeUTC("2014-08-08 10:20:30")},
	{Time: parseTimeUTC("2014-08-10 10:20:30")},
	{Time: parseTimeUTC("2014-08-12 10:20:30")},
	{Time: parseTimeUTC("2014-08-13 10:20:30")},
	{Time: parseTimeUTC("2014-08-13 10:20:30.1")},
	{Time: parseTimeUTC("2014-08-15 10:20:30")},
	{Time: parseTimeUTC("2014-08-18 10:20:30")},
	{Time: parseTimeUTC("2014-08-20 10:20:30")},
	{Time: parseTimeUTC("2014-08-21 10:20:30")},
	{Time: parseTimeUTC("2014-08-22 10:20:30")},
	{Time: parseTimeUTC("2014-10-01 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-02 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-05 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-06 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-08 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-09 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-10 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-11 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-20 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-10-22 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-11-08 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-11-10 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-11-12 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-11-13 10:20:30"), Tags: []string{"foo"}},
	{Time: parseTimeUTC("2014-11-13 10:20:30.1"), Tags: []string{"bar"}},
	{Time: parseTimeUTC("2014-11-15 10:20:30"), Tags: []string{"foo", "bar"}},
	{Time: parseTimeUTC("2014-11-18 10:20:30")},
	{Time: parseTimeUTC("2014-11-20 10:20:30")},
	{Time: parseTimeUTC("2014-11-21 10:20:30")},
	{Time: parseTimeUTC("2014-11-22 10:20:30")},
	{Time: parseTimeUTC("2015-09-01 10:20:30")},
	{Time: parseTimeUTC("2015-09-02 10:20:30")},
	{Time: parseTimeUTC("2015-09-05 10:20:30")},
	{Time: parseTimeUTC("2015-09-06 10:20:30")},
	{Time: parseTimeUTC("2015-09-08 10:20:30")},
	{Time: parseTimeUTC("2015-09-09 10:20:30")},
	{Time: parseTimeUTC("2015-09-10 10:20:30")},
	{Time: parseTimeUTC("2015-09-11 10:20:30")},
	{Time: parseTimeUTC("2015-09-20 10:20:30")},
	{Time: parseTimeUTC("2015-09-22 10:20:30")},
	{Time: parseTimeUTC("2015-08-08 10:20:30")},
	{Time: parseTimeUTC("2015-08-10 10:20:30")},
	{Time: parseTimeUTC("2015-08-12 10:20:30")},
	{Time: parseTimeUTC("2015-08-13 10:20:30")},
	{Time: parseTimeUTC("2015-08-13 10:20:30.1")},
	{Time: parseTimeUTC("2015-08-15 10:20:30")},
	{Time: parseTimeUTC("2015-08-18 10:20:30")},
	{Time: parseTimeUTC("2015-08-20 10:20:30")},
	{Time: parseTimeUTC("2015-08-21 10:20:30")},
	{Time: parseTimeUTC("2015-08-22 10:20:30")},
	{Time: parseTimeUTC("2015-10-01 10:20:30")},
	{Time: parseTimeUTC("2015-10-02 10:20:30")},
	{Time: parseTimeUTC("2015-10-05 10:20:30")},
	{Time: parseTimeUTC("2015-10-06 10:20:30")},
	{Time: parseTimeUTC("2015-10-08 10:20:30")},
	{Time: parseTimeUTC("2015-10-09 10:20:30")},
	{Time: parseTimeUTC("2015-10-10 10:20:30")},
	{Time: parseTimeUTC("2015-10-11 10:20:30")},
	{Time: parseTimeUTC("2015-10-20 10:20:30")},
	{Time: parseTimeUTC("2015-10-22 10:20:30")},
	{Time: parseTimeUTC("2015-11-08 10:20:30")},
	{Time: parseTimeUTC("2015-11-10 10:20:30")},
	{Time: parseTimeUTC("2015-11-12 10:20:30")},
	{Time: parseTimeUTC("2015-11-13 10:20:30")},
	{Time: parseTimeUTC("2015-11-13 10:20:30.1")},
	{Time: parseTimeUTC("2015-11-15 10:20:30")},
	{Time: parseTimeUTC("2015-11-18 10:20:30")},
	{Time: parseTimeUTC("2015-11-20 10:20:30")},
	{Time: parseTimeUTC("2015-11-21 10:20:30")},
	{Time: parseTimeUTC("2015-11-22 10:20:30")},
	{Time: parseTimeUTC("2016-01-01 01:02:03")},
	{Time: parseTimeUTC("2016-01-01 01:03:03")},
	{Time: parseTimeUTC("2016-01-01 07:08:03")},
	{Time: parseTimeUTC("2016-01-03 07:02:03")},
	{Time: parseTimeUTC("2016-01-04 10:23:03")},
	{Time: parseTimeUTC("2016-01-04 11:23:03")},
	{Time: parseTimeUTC("2016-01-04 12:23:03")},
	{Time: parseTimeUTC("2016-01-04 12:24:03")},
	{Time: parseTimeUTC("2016-01-04 12:28:03")},
	{Time: parseTimeUTC("2016-01-04 12:30:03")},
	{Time: parseTimeUTC("2016-01-04 16:23:03")},
	{Time: parseTimeUTC("2016-01-05 09:02:03")},
	{Time: parseTimeUTC("2016-01-06 08:02:03")},
	{Time: parseTimeUTC("2016-01-07 10:02:03")},
	{Time: parseTimeUTC("2016-01-08 20:02:03")},
	{Time: parseTimeUTC("2016-01-09 21:02:03")},
	{Time: parseTimeUTC("2016-01-12 21:02:03")},
	{Time: parseTimeUTC("2016-01-12 21:08:03")},
	{Time: parseTimeUTC("2016-01-18 12:02:03")},
}

var expireTests = []restic.ExpirePolicy{
	{},
	{Last: 10},
	{Last: 15},
	{Last: 99},
	{Last: 200},
	{Hourly: 20},
	{Daily: 3},
	{Daily: 10},
	{Daily: 30},
	{Last: 5, Daily: 5},
	{Last: 2, Daily: 10},
	{Weekly: 2},
	{Weekly: 4},
	{Daily: 3, Weekly: 4},
	{Monthly: 6},
	{Daily: 2, Weekly: 2, Monthly: 6},
	{Yearly: 10},
	{Daily: 7, Weekly: 2, Monthly: 3, Yearly: 10},
	{Tags: []restic.TagList{{"foo"}}},
	{Tags: []restic.TagList{{"foo", "bar"}}},
	{Tags: []restic.TagList{{"foo"}, {"bar"}}},
}

func TestApplyPolicy(t *testing.T) {
	for i, p := range expireTests {
		keep, remove := restic.ApplyPolicy(testExpireSnapshots, p)

		t.Logf("test %d: returned keep %v, remove %v (of %v) expired snapshots for policy %v",
			i, len(keep), len(remove), len(testExpireSnapshots), p)

		if len(keep)+len(remove) != len(testExpireSnapshots) {
			t.Errorf("test %d: len(keep)+len(remove) = %d != len(testExpireSnapshots) = %d",
				i, len(keep)+len(remove), len(testExpireSnapshots))
		}

		if p.Sum() > 0 && len(keep) > p.Sum() {
			t.Errorf("not enough snapshots removed: policy allows %v snapshots to remain, but ended up with %v",
				p.Sum(), len(keep))
		}

		for _, sn := range keep {
			t.Logf("test %d:     keep snapshot at %v %s\n", i, sn.Time, sn.Tags)
		}
		for _, sn := range remove {
			t.Logf("test %d:   forget snapshot at %v %s\n", i, sn.Time, sn.Tags)
		}

		goldenFilename := filepath.Join("testdata", fmt.Sprintf("policy_keep_snapshots_%d", i))

		if *updateGoldenFiles {
			buf, err := json.MarshalIndent(keep, "", "  ")
			if err != nil {
				t.Fatalf("error marshaling result: %v", err)
			}

			if err = ioutil.WriteFile(goldenFilename, buf, 0644); err != nil {
				t.Fatalf("unable to update golden file: %v", err)
			}
		}

		buf, err := ioutil.ReadFile(goldenFilename)
		if err != nil {
			t.Errorf("error loading golden file %v: %v", goldenFilename, err)
			continue
		}

		var want restic.Snapshots
		err = json.Unmarshal(buf, &want)
		if err != nil {
			t.Errorf("error unmarshalling golden file %v: %v", goldenFilename, err)
			continue
		}

		if !reflect.DeepEqual(keep, want) {
			t.Errorf("test %v: wrong result, want:\n  %v\ngot:\n  %v", i, want, keep)
			continue
		}
	}
}