1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
package repository
import (
"os"
"os/exec"
"path/filepath"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v14/internal/git"
"gitlab.com/gitlab-org/gitaly/v14/internal/git/catfile"
"gitlab.com/gitlab-org/gitaly/v14/internal/git/gittest"
"gitlab.com/gitlab-org/gitaly/v14/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/v14/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v14/internal/testhelper/testcfg"
"gitlab.com/gitlab-org/gitaly/v14/proto/go/gitalypb"
)
// TODO: replace emulated rebase RPC with actual
// https://gitlab.com/gitlab-org/gitaly/issues/1750
func TestCleanupDeletesStaleWorktrees(t *testing.T) {
t.Parallel()
cfg, client := setupRepositoryServiceWithoutRepo(t)
testCases := []struct {
desc string
worktreeTime time.Time
shouldExist bool
}{
{
desc: "with a recent worktree",
worktreeTime: freshTime,
shouldExist: true,
},
{
desc: "with a slightly old worktree",
worktreeTime: oldTime,
shouldExist: true,
},
{
desc: "with an old worktree",
worktreeTime: oldTreeTime,
shouldExist: false,
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
repo, repoPath := gittest.CloneRepo(t, cfg, cfg.Storages[0])
req := &gitalypb.CleanupRequest{Repository: repo}
worktreeCheckoutPath := filepath.Join(repoPath, worktreePrefix, "test-worktree")
gittest.AddWorktree(t, cfg, repoPath, worktreeCheckoutPath)
basePath := filepath.Join(repoPath, "worktrees")
worktreePath := filepath.Join(basePath, "test-worktree")
require.NoError(t, os.Chtimes(worktreeCheckoutPath, tc.worktreeTime, tc.worktreeTime))
ctx, cancel := testhelper.Context()
defer cancel()
c, err := client.Cleanup(ctx, req)
// Sanity check
assert.FileExists(t, filepath.Join(repoPath, "HEAD")) // For good measure
if tc.shouldExist {
assert.DirExists(t, worktreeCheckoutPath)
assert.DirExists(t, worktreePath)
} else {
assert.NoError(t, err)
assert.NotNil(t, c)
require.NoDirExists(t, worktreeCheckoutPath)
require.NoDirExists(t, worktreePath)
}
})
}
}
func TestCleanupDeletesOrphanedWorktrees(t *testing.T) {
t.Parallel()
_, repo, repoPath, client := setupRepositoryService(t)
worktreeCheckoutPath := filepath.Join(repoPath, worktreePrefix, "test-worktree")
basePath := filepath.Join(repoPath, "worktrees")
worktreePath := filepath.Join(basePath, "test-worktree")
require.NoError(t, os.MkdirAll(worktreeCheckoutPath, os.ModePerm))
require.NoError(t, os.Chtimes(worktreeCheckoutPath, oldTreeTime, oldTreeTime))
ctx, cancel := testhelper.Context()
defer cancel()
c, err := client.Cleanup(ctx, &gitalypb.CleanupRequest{Repository: repo})
assert.NoError(t, err)
assert.NotNil(t, c)
require.NoDirExists(t, worktreeCheckoutPath)
require.NoDirExists(t, worktreePath)
}
// TODO: replace emulated rebase RPC with actual
// https://gitlab.com/gitlab-org/gitaly/issues/1750
func TestCleanupDisconnectedWorktrees(t *testing.T) {
t.Parallel()
const (
worktreeName = "test-worktree"
worktreeAdminDir = "worktrees"
)
cfg, repo, repoPath, client := setupRepositoryService(t)
worktreePath := filepath.Join(repoPath, worktreePrefix, worktreeName)
worktreeAdminPath := filepath.Join(
repoPath, worktreeAdminDir, filepath.Base(worktreeName),
)
req := &gitalypb.CleanupRequest{Repository: repo}
gittest.AddWorktree(t, cfg, repoPath, worktreePath)
ctx, cancel := testhelper.Context()
defer cancel()
// removing the work tree path but leaving the administrative files in
// $GIT_DIR/worktrees will result in the work tree being in a
// "disconnected" state
err := os.RemoveAll(worktreePath)
require.NoError(t, err,
"disconnecting worktree by removing work tree at %s should succeed", worktreePath,
)
err = exec.Command(cfg.Git.BinPath, gittest.AddWorktreeArgs(repoPath, worktreePath)...).Run()
require.Error(t, err, "creating a new work tree at the same path as a disconnected work tree should fail")
// cleanup should prune the disconnected worktree administrative files
_, err = client.Cleanup(ctx, req)
require.NoError(t, err)
require.NoDirExists(t, worktreeAdminPath)
// if the worktree administrative files are pruned, then we should be able
// to checkout another worktree at the same path
gittest.AddWorktree(t, cfg, repoPath, worktreePath)
}
func TestRemoveWorktree(t *testing.T) {
t.Parallel()
cfg, repoProto, repoPath := testcfg.BuildWithRepo(t)
gitCmdFactory := git.NewExecCommandFactory(cfg)
repo := localrepo.New(gitCmdFactory, catfile.NewCache(cfg), repoProto, cfg)
existingWorktreePath := filepath.Join(repoPath, worktreePrefix, "existing")
gittest.AddWorktree(t, cfg, repoPath, existingWorktreePath)
disconnectedWorktreePath := filepath.Join(repoPath, worktreePrefix, "disconnected")
gittest.AddWorktree(t, cfg, repoPath, disconnectedWorktreePath)
require.NoError(t, os.RemoveAll(disconnectedWorktreePath))
orphanedWorktreePath := filepath.Join(repoPath, worktreePrefix, "orphaned")
require.NoError(t, os.MkdirAll(orphanedWorktreePath, os.ModePerm))
for _, tc := range []struct {
worktree string
errorIs error
expectExists bool
}{
{
worktree: "existing",
expectExists: false,
},
{
worktree: "disconnected",
expectExists: false,
},
{
worktree: "unknown",
errorIs: errUnknownWorktree,
expectExists: false,
},
{
worktree: "orphaned",
errorIs: errUnknownWorktree,
expectExists: true,
},
} {
t.Run(tc.worktree, func(t *testing.T) {
ctx, cancel := testhelper.Context()
defer cancel()
worktreePath := filepath.Join(repoPath, worktreePrefix, tc.worktree)
err := removeWorktree(ctx, cfg, repo, tc.worktree)
if tc.errorIs == nil {
require.NoError(t, err)
} else {
require.ErrorIs(t, err, tc.errorIs)
}
if tc.expectExists {
require.DirExists(t, worktreePath)
} else {
require.NoDirExists(t, worktreePath)
}
})
}
}
|
