forked from TrueCloudLab/restic
b1266867d2
The toplevel context in restic only canceled if the user interrupts a restic operation. If the network connection has failed this can require waiting the full retry duration of 15 minutes which is a bad user experience for interactive usage. Thus limit the delay to one minute in this case.
327 lines
9.1 KiB
Go
327 lines
9.1 KiB
Go
package restic_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/restic/restic/internal/backend"
|
|
"github.com/restic/restic/internal/backend/mem"
|
|
"github.com/restic/restic/internal/repository"
|
|
"github.com/restic/restic/internal/restic"
|
|
rtest "github.com/restic/restic/internal/test"
|
|
)
|
|
|
|
func TestLock(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
lock, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
rtest.OK(t, lock.Unlock(context.TODO()))
|
|
}
|
|
|
|
func TestDoubleUnlock(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
lock, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
rtest.OK(t, lock.Unlock(context.TODO()))
|
|
|
|
err = lock.Unlock(context.TODO())
|
|
rtest.Assert(t, err != nil,
|
|
"double unlock didn't return an error, got %v", err)
|
|
}
|
|
|
|
func TestMultipleLock(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
lock1, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
lock2, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
rtest.OK(t, lock1.Unlock(context.TODO()))
|
|
rtest.OK(t, lock2.Unlock(context.TODO()))
|
|
}
|
|
|
|
type failLockLoadingBackend struct {
|
|
backend.Backend
|
|
}
|
|
|
|
func (be *failLockLoadingBackend) Load(ctx context.Context, h backend.Handle, length int, offset int64, fn func(rd io.Reader) error) error {
|
|
if h.Type == restic.LockFile {
|
|
return fmt.Errorf("error loading lock")
|
|
}
|
|
return be.Backend.Load(ctx, h, length, offset, fn)
|
|
}
|
|
|
|
func TestMultipleLockFailure(t *testing.T) {
|
|
be := &failLockLoadingBackend{Backend: mem.New()}
|
|
repo, _ := repository.TestRepositoryWithBackend(t, be, 0, repository.Options{})
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
lock1, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
_, err = restic.NewLock(context.TODO(), repo)
|
|
rtest.Assert(t, err != nil, "unreadable lock file did not result in an error")
|
|
|
|
rtest.OK(t, lock1.Unlock(context.TODO()))
|
|
}
|
|
|
|
func TestLockExclusive(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
|
|
elock, err := restic.NewExclusiveLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
rtest.OK(t, elock.Unlock(context.TODO()))
|
|
}
|
|
|
|
func TestLockOnExclusiveLockedRepo(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
elock, err := restic.NewExclusiveLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
lock, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.Assert(t, err != nil,
|
|
"create normal lock with exclusively locked repo didn't return an error")
|
|
rtest.Assert(t, restic.IsAlreadyLocked(err),
|
|
"create normal lock with exclusively locked repo didn't return the correct error")
|
|
|
|
rtest.OK(t, lock.Unlock(context.TODO()))
|
|
rtest.OK(t, elock.Unlock(context.TODO()))
|
|
}
|
|
|
|
func TestExclusiveLockOnLockedRepo(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
elock, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
lock, err := restic.NewExclusiveLock(context.TODO(), repo)
|
|
rtest.Assert(t, err != nil,
|
|
"create normal lock with exclusively locked repo didn't return an error")
|
|
rtest.Assert(t, restic.IsAlreadyLocked(err),
|
|
"create normal lock with exclusively locked repo didn't return the correct error")
|
|
|
|
rtest.OK(t, lock.Unlock(context.TODO()))
|
|
rtest.OK(t, elock.Unlock(context.TODO()))
|
|
}
|
|
|
|
func createFakeLock(repo restic.SaverUnpacked, t time.Time, pid int) (restic.ID, error) {
|
|
hostname, err := os.Hostname()
|
|
if err != nil {
|
|
return restic.ID{}, err
|
|
}
|
|
|
|
newLock := &restic.Lock{Time: t, PID: pid, Hostname: hostname}
|
|
return restic.SaveJSONUnpacked(context.TODO(), repo, restic.LockFile, &newLock)
|
|
}
|
|
|
|
func removeLock(repo restic.RemoverUnpacked, id restic.ID) error {
|
|
return repo.RemoveUnpacked(context.TODO(), restic.LockFile, id)
|
|
}
|
|
|
|
var staleLockTests = []struct {
|
|
timestamp time.Time
|
|
stale bool
|
|
staleOnOtherHost bool
|
|
pid int
|
|
}{
|
|
{
|
|
timestamp: time.Now(),
|
|
stale: false,
|
|
staleOnOtherHost: false,
|
|
pid: os.Getpid(),
|
|
},
|
|
{
|
|
timestamp: time.Now().Add(-time.Hour),
|
|
stale: true,
|
|
staleOnOtherHost: true,
|
|
pid: os.Getpid(),
|
|
},
|
|
{
|
|
timestamp: time.Now().Add(3 * time.Minute),
|
|
stale: false,
|
|
staleOnOtherHost: false,
|
|
pid: os.Getpid(),
|
|
},
|
|
{
|
|
timestamp: time.Now(),
|
|
stale: true,
|
|
staleOnOtherHost: false,
|
|
pid: os.Getpid() + 500000,
|
|
},
|
|
}
|
|
|
|
func TestLockStale(t *testing.T) {
|
|
hostname, err := os.Hostname()
|
|
rtest.OK(t, err)
|
|
|
|
otherHostname := "other-" + hostname
|
|
|
|
for i, test := range staleLockTests {
|
|
lock := restic.Lock{
|
|
Time: test.timestamp,
|
|
PID: test.pid,
|
|
Hostname: hostname,
|
|
}
|
|
|
|
rtest.Assert(t, lock.Stale() == test.stale,
|
|
"TestStaleLock: test %d failed: expected stale: %v, got %v",
|
|
i, test.stale, !test.stale)
|
|
|
|
lock.Hostname = otherHostname
|
|
rtest.Assert(t, lock.Stale() == test.staleOnOtherHost,
|
|
"TestStaleLock: test %d failed: expected staleOnOtherHost: %v, got %v",
|
|
i, test.staleOnOtherHost, !test.staleOnOtherHost)
|
|
}
|
|
}
|
|
|
|
func lockExists(repo restic.Lister, t testing.TB, lockID restic.ID) bool {
|
|
var exists bool
|
|
rtest.OK(t, repo.List(context.TODO(), restic.LockFile, func(id restic.ID, size int64) error {
|
|
if id == lockID {
|
|
exists = true
|
|
}
|
|
return nil
|
|
}))
|
|
|
|
return exists
|
|
}
|
|
|
|
func TestLockWithStaleLock(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
|
|
id1, err := createFakeLock(repo, time.Now().Add(-time.Hour), os.Getpid())
|
|
rtest.OK(t, err)
|
|
|
|
id2, err := createFakeLock(repo, time.Now().Add(-time.Minute), os.Getpid())
|
|
rtest.OK(t, err)
|
|
|
|
id3, err := createFakeLock(repo, time.Now().Add(-time.Minute), os.Getpid()+500000)
|
|
rtest.OK(t, err)
|
|
|
|
processed, err := restic.RemoveStaleLocks(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
rtest.Assert(t, lockExists(repo, t, id1) == false,
|
|
"stale lock still exists after RemoveStaleLocks was called")
|
|
rtest.Assert(t, lockExists(repo, t, id2) == true,
|
|
"non-stale lock was removed by RemoveStaleLocks")
|
|
rtest.Assert(t, lockExists(repo, t, id3) == false,
|
|
"stale lock still exists after RemoveStaleLocks was called")
|
|
rtest.Assert(t, processed == 2,
|
|
"number of locks removed does not match: expected %d, got %d",
|
|
2, processed)
|
|
|
|
rtest.OK(t, removeLock(repo, id2))
|
|
}
|
|
|
|
func TestRemoveAllLocks(t *testing.T) {
|
|
repo := repository.TestRepository(t)
|
|
|
|
id1, err := createFakeLock(repo, time.Now().Add(-time.Hour), os.Getpid())
|
|
rtest.OK(t, err)
|
|
|
|
id2, err := createFakeLock(repo, time.Now().Add(-time.Minute), os.Getpid())
|
|
rtest.OK(t, err)
|
|
|
|
id3, err := createFakeLock(repo, time.Now().Add(-time.Minute), os.Getpid()+500000)
|
|
rtest.OK(t, err)
|
|
|
|
processed, err := restic.RemoveAllLocks(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
|
|
rtest.Assert(t, lockExists(repo, t, id1) == false,
|
|
"lock still exists after RemoveAllLocks was called")
|
|
rtest.Assert(t, lockExists(repo, t, id2) == false,
|
|
"lock still exists after RemoveAllLocks was called")
|
|
rtest.Assert(t, lockExists(repo, t, id3) == false,
|
|
"lock still exists after RemoveAllLocks was called")
|
|
rtest.Assert(t, processed == 3,
|
|
"number of locks removed does not match: expected %d, got %d",
|
|
3, processed)
|
|
}
|
|
|
|
func checkSingleLock(t *testing.T, repo restic.Lister) restic.ID {
|
|
t.Helper()
|
|
var lockID *restic.ID
|
|
err := repo.List(context.TODO(), restic.LockFile, func(id restic.ID, size int64) error {
|
|
if lockID != nil {
|
|
t.Error("more than one lock found")
|
|
}
|
|
lockID = &id
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if lockID == nil {
|
|
t.Fatal("no lock found")
|
|
}
|
|
return *lockID
|
|
}
|
|
|
|
func testLockRefresh(t *testing.T, refresh func(lock *restic.Lock) error) {
|
|
repo := repository.TestRepository(t)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
lock, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
time0 := lock.Time
|
|
|
|
lockID := checkSingleLock(t, repo)
|
|
|
|
time.Sleep(time.Millisecond)
|
|
rtest.OK(t, refresh(lock))
|
|
|
|
lockID2 := checkSingleLock(t, repo)
|
|
|
|
rtest.Assert(t, !lockID.Equal(lockID2),
|
|
"expected a new ID after lock refresh, got the same")
|
|
lock2, err := restic.LoadLock(context.TODO(), repo, lockID2)
|
|
rtest.OK(t, err)
|
|
rtest.Assert(t, lock2.Time.After(time0),
|
|
"expected a later timestamp after lock refresh")
|
|
rtest.OK(t, lock.Unlock(context.TODO()))
|
|
}
|
|
|
|
func TestLockRefresh(t *testing.T) {
|
|
testLockRefresh(t, func(lock *restic.Lock) error {
|
|
return lock.Refresh(context.TODO())
|
|
})
|
|
}
|
|
|
|
func TestLockRefreshStale(t *testing.T) {
|
|
testLockRefresh(t, func(lock *restic.Lock) error {
|
|
return lock.RefreshStaleLock(context.TODO())
|
|
})
|
|
}
|
|
|
|
func TestLockRefreshStaleMissing(t *testing.T) {
|
|
repo, be := repository.TestRepositoryWithVersion(t, 0)
|
|
restic.TestSetLockTimeout(t, 5*time.Millisecond)
|
|
|
|
lock, err := restic.NewLock(context.TODO(), repo)
|
|
rtest.OK(t, err)
|
|
lockID := checkSingleLock(t, repo)
|
|
|
|
// refresh must fail if lock was removed
|
|
rtest.OK(t, be.Remove(context.TODO(), backend.Handle{Type: restic.LockFile, Name: lockID.String()}))
|
|
time.Sleep(time.Millisecond)
|
|
err = lock.RefreshStaleLock(context.TODO())
|
|
rtest.Assert(t, err == restic.ErrRemovedLock, "unexpected error, expected %v, got %v", restic.ErrRemovedLock, err)
|
|
}
|