// Package repotesting contains test utilities for working with repositories. package repotesting import ( "context" "os" "path/filepath" "testing" "github.com/kopia/kopia/internal/blobtesting" "github.com/kopia/kopia/internal/testlogging" "github.com/kopia/kopia/internal/testutil" "github.com/kopia/kopia/repo" "github.com/kopia/kopia/repo/blob" "github.com/kopia/kopia/repo/content" "github.com/kopia/kopia/repo/encryption" "github.com/kopia/kopia/repo/object" ) const defaultPassword = "foobarbazfoobarbaz" // Environment encapsulates details of a test environment. type Environment struct { Repository repo.Repository RepositoryWriter repo.DirectRepositoryWriter Password string configDir string st blob.Storage connected bool } // Options used during Environment Setup. type Options struct { NewRepositoryOptions func(*repo.NewRepositoryOptions) OpenOptions func(*repo.Options) } // setup sets up a test environment. func (e *Environment) setup(tb testing.TB, version content.FormatVersion, opts ...Options) *Environment { tb.Helper() ctx := testlogging.Context(tb) e.configDir = testutil.TempDirectory(tb) openOpt := &repo.Options{} opt := &repo.NewRepositoryOptions{ BlockFormat: content.FormattingOptions{ MutableParameters: content.MutableParameters{ Version: version, }, HMACSecret: []byte{}, Hash: "HMAC-SHA256", Encryption: encryption.DefaultAlgorithm, EnablePasswordChange: true, }, ObjectFormat: object.Format{ Splitter: "FIXED-1M", }, } for _, mod := range opts { if mod.NewRepositoryOptions != nil { mod.NewRepositoryOptions(opt) } if mod.OpenOptions != nil { mod.OpenOptions(openOpt) } } st := blobtesting.NewMapStorage(blobtesting.DataMap{}, nil, openOpt.TimeNowFunc) st = newReconnectableStorage(tb, st) e.st = st if e.Password == "" { e.Password = defaultPassword } if err := repo.Initialize(ctx, st, opt, e.Password); err != nil { tb.Fatalf("err: %v", err) } if err := repo.Connect(ctx, e.ConfigFile(), st, e.Password, nil); err != nil { tb.Fatalf("can't connect: %v", err) } e.connected = true rep, err := repo.Open(ctx, e.ConfigFile(), e.Password, openOpt) if err != nil { tb.Fatalf("can't open: %v", err) } e.Repository = rep _, e.RepositoryWriter, err = rep.(repo.DirectRepository).NewDirectWriter(ctx, repo.WriteSessionOptions{Purpose: "test"}) if err != nil { tb.Fatal(err) } tb.Cleanup(func() { rep.Close(ctx) }) return e } // Close closes testing environment. func (e *Environment) Close(ctx context.Context, tb testing.TB) { tb.Helper() if err := e.RepositoryWriter.Close(ctx); err != nil { tb.Fatalf("unable to close: %v", err) } if e.connected { if err := repo.Disconnect(ctx, e.ConfigFile()); err != nil { tb.Errorf("error disconnecting: %v", err) } } if err := os.Remove(e.configDir); err != nil { // should be empty, assuming Disconnect was successful tb.Errorf("error removing config directory: %v", err) } } // ConfigFile returns the name of the config file. func (e *Environment) ConfigFile() string { return filepath.Join(e.configDir, "kopia.config") } // MustReopen closes and reopens the repository. func (e *Environment) MustReopen(tb testing.TB, openOpts ...func(*repo.Options)) { tb.Helper() ctx := testlogging.Context(tb) err := e.RepositoryWriter.Close(ctx) if err != nil { tb.Fatalf("close error: %v", err) } rep, err := repo.Open(ctx, e.ConfigFile(), e.Password, repoOptions(openOpts)) if err != nil { tb.Fatalf("err: %v", err) } tb.Cleanup(func() { rep.Close(ctx) }) _, e.RepositoryWriter, err = rep.(repo.DirectRepository).NewDirectWriter(ctx, repo.WriteSessionOptions{Purpose: "test"}) if err != nil { tb.Fatalf("err: %v", err) } } // MustOpenAnother opens another repository backend by the same storage. func (e *Environment) MustOpenAnother(tb testing.TB) repo.RepositoryWriter { tb.Helper() ctx := testlogging.Context(tb) rep2, err := repo.Open(ctx, e.ConfigFile(), e.Password, &repo.Options{}) if err != nil { tb.Fatalf("err: %v", err) } tb.Cleanup(func() { rep2.Close(ctx) }) _, w, err := rep2.NewWriter(ctx, repo.WriteSessionOptions{Purpose: "test"}) if err != nil { tb.Fatal(err) } return w } // MustConnectOpenAnother opens another repository backend by the same storage, // with independent config and cache options. func (e *Environment) MustConnectOpenAnother(tb testing.TB, openOpts ...func(*repo.Options)) repo.Repository { tb.Helper() ctx := testlogging.Context(tb) config := filepath.Join(testutil.TempDirectory(tb), "kopia.config") connOpts := &repo.ConnectOptions{ CachingOptions: content.CachingOptions{ CacheDirectory: testutil.TempDirectory(tb), }, } if err := repo.Connect(ctx, config, e.st, e.Password, connOpts); err != nil { tb.Fatal("can't connect:", err) } rep, err := repo.Open(ctx, e.ConfigFile(), e.Password, repoOptions(openOpts)) if err != nil { tb.Fatal("can't open:", err) } return rep } // VerifyBlobCount verifies that the underlying storage contains the specified number of blobs. func (e *Environment) VerifyBlobCount(tb testing.TB, want int) { tb.Helper() var got int _ = e.RepositoryWriter.BlobReader().ListBlobs(testlogging.Context(tb), "", func(_ blob.Metadata) error { got++ return nil }) if got != want { tb.Errorf("got unexpected number of BLOBs: %v, wanted %v", got, want) } } func repoOptions(openOpts []func(*repo.Options)) *repo.Options { openOpt := &repo.Options{} for _, mod := range openOpts { if mod != nil { mod(openOpt) } } return openOpt } // FormatNotImportant chooses arbitrary format version where it's not important to the test. const FormatNotImportant = content.FormatVersion2 // NewEnvironment creates a new repository testing environment and ensures its cleanup at the end of the test. func NewEnvironment(tb testing.TB, version content.FormatVersion, opts ...Options) (context.Context, *Environment) { tb.Helper() ctx := testlogging.Context(tb) var env Environment env.setup(tb, version, opts...) tb.Cleanup(func() { env.Close(ctx, tb) }) return ctx, &env }