kopia/tests/robustness/pathlock/path_lock_test.go

package pathlock

import (
	"math/rand"
	"os"
	"path/filepath"
	"sync"
	"sync/atomic"
	"testing"
	"time"
)

func TestPathLockBasic(t *testing.T) {
	pl := NewLocker()

	cwd, err := os.Getwd()
	if err != nil {
		t.Fatalf("Could not get working directory: %v", err)
	}

	for ti, tc := range []struct {
		name  string
		path1 string
		path2 string
	}{
		{
			name:  "(Abs) Blocks a Lock call for the same path /a/b/c",
			path1: "/a/b/c",
			path2: "/a/b/c",
		},
		{
			name:  "(Abs) Blocks a Lock call for path /a/b/c/d",
			path1: "/a/b/c",
			path2: "/a/b/c/d",
		},
		{
			name:  "(Abs) Blocks a Lock call for path /a/b",
			path1: "/a/b/c",
			path2: "/a/b",
		},
		{
			name:  "(Abs) Blocks a Lock call for path /a",
			path1: "/a/b/c",
			path2: "/a",
		},
		{
			name:  "(Rel) Blocks a Lock call for the same path a/b/c",
			path1: "a/b/c",
			path2: "a/b/c",
		},
		{
			name:  "(Rel) Blocks a Lock call for path a/b/c/d",
			path1: "a/b/c",
			path2: "a/b/c/d",
		},
		{
			name:  "(Rel) Blocks a Lock call for path a/b",
			path1: "a/b/c",
			path2: "a/b",
		},
		{
			name:  "(Rel) Blocks a Lock call for path a",
			path1: "a/b/c",
			path2: "a",
		},
		{
			name:  "(Mix Abs/Rel) Blocks a Lock call for the same path a/b/c",
			path1: filepath.Join(cwd, "a/b/c"),
			path2: "a/b/c",
		},
		{
			name:  "(Mix Abs/Rel) Blocks a Lock call for path a/b/c/d",
			path1: filepath.Join(cwd, "a/b/c"),
			path2: "a/b/c/d",
		},
		{
			name:  "(Mix Abs/Rel) Blocks a Lock call for path a/b",
			path1: filepath.Join(cwd, "a/b/c"),
			path2: "a/b",
		},
		{
			name:  "(Mix Abs/Rel) Blocks a Lock call for path a",
			path1: filepath.Join(cwd, "a/b/c"),
			path2: "a",
		},
		{
			name:  "(Mix Rel/Abs) Blocks a Lock call for the same path a/b/c",
			path1: "a/b/c",
			path2: filepath.Join(cwd, "a/b/c"),
		},
		{
			name:  "(Mix Rel/Abs) Blocks a Lock call for path a/b/c/d",
			path1: "a/b/c",
			path2: filepath.Join(cwd, "a/b/c/d"),
		},
		{
			name:  "(Mix Rel/Abs) Blocks a Lock call for path a/b",
			path1: "a/b/c",
			path2: filepath.Join(cwd, "a/b"),
		},
		{
			name:  "(Mix Rel/Abs) Blocks a Lock call for path a",
			path1: "a/b/c",
			path2: filepath.Join(cwd, "a"),
		},
	} {
		t.Logf("%v %v (path1: %q, path2: %q)", ti, tc.name, tc.path1, tc.path2)

		lock1, err := pl.Lock(tc.path1)
		if err != nil {
			t.Fatalf("Unexpected path lock error: %v", err)
		}

		currBusyCounter := busyCounter.Load()

		var path2Err error

		wg := new(sync.WaitGroup)
		wg.Add(1)

		go func() {
			defer wg.Done()

			lock2, err := pl.Lock(tc.path2)
			if err != nil {
				path2Err = err
				return
			}

			lock2.Unlock()
		}()

		// Wait until the internal atomic counter increments.
		// That will only happen once the Lock call to path2 executes
		// and blocks on the prior Lock to path1.
		for busyCounter.Load() <= currBusyCounter {
			time.Sleep(1 * time.Millisecond)
		}

		lock1.Unlock()

		// Wait for the goroutine to return
		wg.Wait()

		if path2Err != nil {
			t.Fatalf("Error in second lock path: %v", path2Err)
		}
	}
}

func TestPathLockWithoutBlock(t *testing.T) {
	pl := NewLocker()

	cwd, err := os.Getwd()
	if err != nil {
		t.Fatalf("Could not get working directory: %v", err)
	}

	for ti, tc := range []struct {
		name  string
		path1 string
		path2 string
	}{
		{
			name:  "(Abs) Allows a Lock call for path /a/b/x",
			path1: "/a/b/c",
			path2: "/a/b/x",
		},
		{
			name:  "(Abs) Allows a Lock call for path /a/x",
			path1: "/a/b/c",
			path2: "/a/x",
		},
		{
			name:  "(Rel) Allows a Lock call for path a/b/x",
			path1: "a/b/c",
			path2: "a/b/x",
		},
		{
			name:  "(Rel) Allows a Lock call for path a/x",
			path1: "a/b/c",
			path2: "a/x",
		},
		{
			name:  "(Mix Abs/Rel) Allows a Lock call for path a/b/x",
			path1: filepath.Join(cwd, "a/b/c"),
			path2: "a/b/x",
		},
		{
			name:  "(Mix Abs/Rel) Allows a Lock call for path a/x",
			path1: filepath.Join(cwd, "a/b/c"),
			path2: "a/x",
		},
		{
			name:  "(Mix Rel/Abs) Allows a Lock call for path a/b/x",
			path1: "a/b/c",
			path2: filepath.Join(cwd, "a/b/x"),
		},
		{
			name:  "(Mix Rel/Abs) Allows a Lock call for path a/x",
			path1: "a/b/c",
			path2: filepath.Join(cwd, "a/x"),
		},
	} {
		t.Logf("%v %v (path1: %q, path2: %q)", ti, tc.name, tc.path1, tc.path2)

		goroutineDoneWg := new(sync.WaitGroup)
		goroutineDoneWg.Add(1)

		goroutineLockedWg := new(sync.WaitGroup)
		goroutineLockedWg.Add(1)

		var trigger atomic.Int32

		triggerFalseCh := make(chan struct{})

		var path2Err error

		go func() {
			defer goroutineDoneWg.Done()

			lock2, err := pl.Lock(tc.path2)
			if err != nil {
				path2Err = err

				goroutineLockedWg.Done()

				return
			}

			trigger.Store(1)

			goroutineLockedWg.Done()

			time.Sleep(10 * time.Millisecond)

			trigger.Store(0)

			close(triggerFalseCh)

			lock2.Unlock()
		}()

		// Wait for the goroutine to lock
		goroutineLockedWg.Wait()

		if path2Err != nil {
			t.Fatalf("Error in second lock path: %v", path2Err)
		}

		// This should not block; the paths should not interfere
		lock1, err := pl.Lock(tc.path1)
		if err != nil {
			t.Fatalf("Unexpected path lock error: %v", err)
		}

		if trigger.Load() == 0 {
			t.Fatalf("Lock blocked")
		}

		lock1.Unlock()

		<-triggerFalseCh

		if trigger.Load() == 1 {
			t.Fatalf("Trigger should have been set false")
		}

		// Ensure the goroutine returns
		goroutineDoneWg.Wait()
	}
}

func TestPathLockRace(t *testing.T) {
	pl := NewLocker()

	counter := 0
	hitError := false

	wg := new(sync.WaitGroup)

	numGoroutines := 100
	for range numGoroutines {
		wg.Add(1)

		go func() {
			defer wg.Done()

			// Pick from three different path values that should all be
			// covered by the same lock.
			path := "/some/path/a/b/c"
			for range rand.Intn(3) {
				path = filepath.Dir(path)
			}

			lock, err := pl.Lock(path)
			if err != nil {
				t.Logf("Unexpected path lock error: %v", err)

				hitError = true

				return
			}

			counter++
			lock.Unlock()
		}()
	}

	wg.Wait()

	if hitError {
		t.Fatal("Hit unexpected error locking paths")
	}

	if counter != numGoroutines {
		t.Fatalf("counter %v != numgoroutines %v", counter, numGoroutines)
	}
}