Debian Codegraph @

cache/internal/lock/lock_test.go

raw
1 // Copyright (c) Microsoft Corporation. All rights reserved.
2 // Licensed under the MIT License. See LICENSE in the project root for license information.
3
4 package lock
5
6 import (
7 "bytes"
8 "context"
9 "errors"
10 "io"
11 "os"
12 "path/filepath"
13 "runtime"
14 "testing"
15 "time"
16
17 "github.com/stretchr/testify/require"
18 )
19
20 var ctx = context.Background()
21
22 type fakeFlock struct {
23 err error
24 p string
25 }
26
27 func (f fakeFlock) Fh() *os.File {
28 fh, _ := os.Open(f.p)
29 return fh
30 }
31
32 func (f fakeFlock) Path() string {
33 return f.p
34 }
35
36 func (f fakeFlock) TryLockContext(context.Context, time.Duration) (bool, error) {
37 return f.err == nil, f.err
38 }
39
40 func (f fakeFlock) Unlock() error {
41 return f.err
42 }
43
44 func TestCreatesAndRemovesFile(t *testing.T) {
45 p := filepath.Join(t.TempDir(), "nonexistent", t.Name())
46 lock, err := New(p, 0)
47 require.NoError(t, err)
48 require.NoFileExists(t, p)
49
50 err = lock.Lock(ctx)
51 require.NoError(t, err)
52 require.FileExists(t, p, "Lock didn't create the file")
53
54 buf := bytes.NewBuffer(nil)
55 _, err = io.Copy(buf, lock.f.Fh())
56 require.NoError(t, err)
57 require.NotEmpty(t, buf, "Lock didn't write debug info to the locked file")
58
59 err = lock.Unlock()
60 require.NoError(t, err)
61 require.NoFileExists(t, p, "Unlock didn't remove the file")
62 }
63
64 func TestFileExists(t *testing.T) {
65 p := filepath.Join(t.TempDir(), t.Name())
66 f, err := os.Create(p)
67 require.NoError(t, err)
68 data := "stuff"
69 _, err = f.WriteString(data)
70 require.NoError(t, err)
71 require.NoError(t, f.Close())
72
73 // Lock should succeed when the file exists but isn't locked
74 lock, err := New(p, 0)
75 require.NoError(t, err)
76 err = lock.Lock(ctx)
77 require.NoError(t, err)
78
79 buf := bytes.NewBuffer(nil)
80 _, err = io.Copy(buf, lock.f.Fh())
81 require.NoError(t, err)
82 require.NotEqual(t, data, buf, "Lock didn't write debug info to the locked file")
83
84 require.NoError(t, lock.Unlock())
85 require.NoFileExists(t, p, "Unlock didn't remove the file")
86 }
87
88 func TestLockError(t *testing.T) {
89 p := filepath.Join(t.TempDir(), t.Name())
90 lock, err := New(p, 0)
91 require.NoError(t, err)
92 expected := errors.New("expected")
93 lock.f = fakeFlock{err: expected}
94 require.Equal(t, lock.Lock(ctx), expected)
95 }
96
97 func TestLockTimeout(t *testing.T) {
98 p := filepath.Join(t.TempDir(), t.Name())
99 a, err := New(p, 0)
100 require.NoError(t, err)
101 err = a.Lock(ctx)
102 require.NoError(t, err)
103
104 defer func(d time.Duration) { timeout = d }(timeout)
105 timeout = 0
106 b, err := New(p, 0)
107 require.NoError(t, err)
108
109 err = b.Lock(ctx)
110 require.ErrorIs(t, err, context.DeadlineExceeded)
111
112 require.NoError(t, a.Unlock())
113 }
114
115 func TestUnlockErrors(t *testing.T) {
116 p := filepath.Join(t.TempDir(), t.Name())
117 lock, err := New(p, 0)
118 require.NoError(t, err)
119
120 err = lock.Lock(ctx)
121 require.NoError(t, err)
122 if runtime.GOOS != "windows" {
123 // Remove would fail on Windows because the file lock is mandatory there
124 require.NoError(t, os.Remove(p))
125 }
126 // Unlock should return nil even when the lock file has been removed
127 require.NoError(t, lock.Unlock())
128
129 expected := errors.New("it didn't work")
130 lock.f = fakeFlock{err: expected}
131 actual := lock.Unlock()
132 require.Equal(t, expected, actual)
133 }