mirror of
https://github.com/kopia/kopia.git
synced 2026-03-14 12:16:46 -04:00
c8fcae93aa
This is mostly mechanical and changes how loggers are instantiated. Logger is now associated with a context, passed around all methods, (most methods had ctx, but had to add it in a few missing places). By default Kopia does not produce any logs, but it can be overridden, either locally for a nested context, by calling ctx = logging.WithLogger(ctx, newLoggerFunc) To override logs globally, call logging.SetDefaultLogger(newLoggerFunc) This refactoring allowed removing dependency from Kopia repo and go-logging library (the CLI still uses it, though). It is now also possible to have all test methods emit logs using t.Logf() so that they show up in failure reports, which should make debugging of test failures suck less.
138 lines
3.2 KiB
Go
138 lines
3.2 KiB
Go
// Package repotesting contains test utilities for working with repositories.
|
|
package repotesting
|
|
|
|
import (
|
|
"context"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/kopia/kopia/internal/testlogging"
|
|
"github.com/kopia/kopia/repo"
|
|
"github.com/kopia/kopia/repo/blob"
|
|
"github.com/kopia/kopia/repo/blob/filesystem"
|
|
"github.com/kopia/kopia/repo/content"
|
|
"github.com/kopia/kopia/repo/object"
|
|
)
|
|
|
|
const masterPassword = "foobarbazfoobarbaz"
|
|
|
|
// Environment encapsulates details of a test environment.
|
|
type Environment struct {
|
|
Repository *repo.Repository
|
|
|
|
configDir string
|
|
storageDir string
|
|
connected bool
|
|
}
|
|
|
|
// Setup sets up a test environment.
|
|
func (e *Environment) Setup(t *testing.T, opts ...func(*repo.NewRepositoryOptions)) *Environment {
|
|
var err error
|
|
|
|
ctx := testlogging.Context(t)
|
|
|
|
e.configDir, err = ioutil.TempDir("", "")
|
|
if err != nil {
|
|
t.Fatalf("err: %v", err)
|
|
}
|
|
|
|
e.storageDir, err = ioutil.TempDir("", "")
|
|
if err != nil {
|
|
t.Fatalf("err: %v", err)
|
|
}
|
|
|
|
opt := &repo.NewRepositoryOptions{
|
|
BlockFormat: content.FormattingOptions{
|
|
HMACSecret: []byte{},
|
|
Hash: "HMAC-SHA256",
|
|
Encryption: "NONE",
|
|
},
|
|
ObjectFormat: object.Format{
|
|
Splitter: "FIXED-1M",
|
|
},
|
|
}
|
|
|
|
for _, mod := range opts {
|
|
mod(opt)
|
|
}
|
|
|
|
st, err := filesystem.New(ctx, &filesystem.Options{
|
|
Path: e.storageDir,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("err: %v", err)
|
|
}
|
|
|
|
if err = repo.Initialize(ctx, st, opt, masterPassword); err != nil {
|
|
t.Fatalf("err: %v", err)
|
|
}
|
|
|
|
if err = repo.Connect(ctx, e.configFile(), st, masterPassword, nil); err != nil {
|
|
t.Fatalf("can't connect: %v", err)
|
|
}
|
|
|
|
e.connected = true
|
|
|
|
e.Repository, err = repo.Open(ctx, e.configFile(), masterPassword, &repo.Options{})
|
|
if err != nil {
|
|
t.Fatalf("can't open: %v", err)
|
|
}
|
|
|
|
return e
|
|
}
|
|
|
|
// Close closes testing environment
|
|
func (e *Environment) Close(ctx context.Context, t *testing.T) {
|
|
if err := e.Repository.Close(ctx); err != nil {
|
|
t.Fatalf("unable to close: %v", err)
|
|
}
|
|
|
|
if e.connected {
|
|
if err := repo.Disconnect(ctx, e.configFile()); err != nil {
|
|
t.Errorf("error disconnecting: %v", err)
|
|
}
|
|
}
|
|
|
|
if err := os.Remove(e.configDir); err != nil {
|
|
// should be empty, assuming Disconnect was successful
|
|
t.Errorf("error removing config directory: %v", err)
|
|
}
|
|
|
|
if err := os.RemoveAll(e.storageDir); err != nil {
|
|
t.Errorf("error removing storage directory: %v", err)
|
|
}
|
|
}
|
|
|
|
func (e *Environment) configFile() string {
|
|
return filepath.Join(e.configDir, "kopia.config")
|
|
}
|
|
|
|
// MustReopen closes and reopens the repository.
|
|
func (e *Environment) MustReopen(t *testing.T) {
|
|
err := e.Repository.Close(testlogging.Context(t))
|
|
if err != nil {
|
|
t.Fatalf("close error: %v", err)
|
|
}
|
|
|
|
e.Repository, err = repo.Open(testlogging.Context(t), e.configFile(), masterPassword, &repo.Options{})
|
|
if err != nil {
|
|
t.Fatalf("err: %v", err)
|
|
}
|
|
}
|
|
|
|
// VerifyBlobCount verifies that the underlying storage contains the specified number of blobs.
|
|
func (e *Environment) VerifyBlobCount(t *testing.T, want int) {
|
|
var got int
|
|
|
|
_ = e.Repository.Blobs.ListBlobs(testlogging.Context(t), "", func(_ blob.Metadata) error {
|
|
got++
|
|
return nil
|
|
})
|
|
|
|
if got != want {
|
|
t.Errorf("got unexpected number of BLOBs: %v, wanted %v", got, want)
|
|
}
|
|
}
|