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
|
package gitpipe
import (
"context"
"errors"
"io"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v15/internal/git"
"gitlab.com/gitlab-org/gitaly/v15/internal/git/catfile"
"gitlab.com/gitlab-org/gitaly/v15/internal/git/gittest"
"gitlab.com/gitlab-org/gitaly/v15/internal/git/localrepo"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v15/internal/testhelper/testcfg"
"google.golang.org/grpc/metadata"
)
func TestCatfileObject(t *testing.T) {
cfg := testcfg.Build(t)
repoProto, _ := gittest.CloneRepo(t, cfg, cfg.Storages[0])
repo := localrepo.NewTestRepo(t, cfg, repoProto)
for _, tc := range []struct {
desc string
catfileInfoInputs []CatfileInfoResult
expectedResults []CatfileObjectResult
expectedErr error
}{
{
desc: "single blob",
catfileInfoInputs: []CatfileInfoResult{
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer1, Type: "blob", Size: 133}},
},
expectedResults: []CatfileObjectResult{
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: lfsPointer1, Type: "blob", Size: 133}}},
},
},
{
desc: "multiple blobs",
catfileInfoInputs: []CatfileInfoResult{
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer1, Type: "blob", Size: 133}},
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer2, Type: "blob", Size: 127}},
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer3, Type: "blob", Size: 127}},
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer4, Type: "blob", Size: 129}},
},
expectedResults: []CatfileObjectResult{
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: lfsPointer1, Type: "blob", Size: 133}}},
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: lfsPointer2, Type: "blob", Size: 127}}},
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: lfsPointer3, Type: "blob", Size: 127}}},
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: lfsPointer4, Type: "blob", Size: 129}}},
},
},
{
desc: "revlist result with object names",
catfileInfoInputs: []CatfileInfoResult{
{ObjectInfo: &catfile.ObjectInfo{Oid: "b95c0fad32f4361845f91d9ce4c1721b52b82793", Type: "tree", Size: 43}},
{ObjectInfo: &catfile.ObjectInfo{Oid: "93e123ac8a3e6a0b600953d7598af629dec7b735", Type: "blob", Size: 59}, ObjectName: []byte("branch-test.txt")},
},
expectedResults: []CatfileObjectResult{
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: "b95c0fad32f4361845f91d9ce4c1721b52b82793", Type: "tree", Size: 43}}},
{Object: &catfile.Object{ObjectInfo: catfile.ObjectInfo{Oid: "93e123ac8a3e6a0b600953d7598af629dec7b735", Type: "blob", Size: 59}}, ObjectName: []byte("branch-test.txt")},
},
},
{
desc: "invalid object ID",
catfileInfoInputs: []CatfileInfoResult{
{ObjectInfo: &catfile.ObjectInfo{Oid: "invalidobjectid", Type: "blob"}},
},
expectedErr: errors.New("requesting object: object not found"),
},
} {
t.Run(tc.desc, func(t *testing.T) {
ctx := testhelper.Context(t)
catfileCache := catfile.NewCache(cfg)
defer catfileCache.Stop()
objectReader, cancel, err := catfileCache.ObjectReader(ctx, repo)
require.NoError(t, err)
defer cancel()
it, err := CatfileObject(ctx, objectReader, NewCatfileInfoIterator(ctx, tc.catfileInfoInputs))
require.NoError(t, err)
var results []CatfileObjectResult
for it.Next() {
result := it.Result()
objectData, err := io.ReadAll(result)
require.NoError(t, err)
require.Len(t, objectData, int(result.ObjectSize()))
// We only really want to compare the publicly visible fields
// containing info about the object itself, and not the object's
// private state. We thus need to reconstruct the objects here.
results = append(results, CatfileObjectResult{
Object: &catfile.Object{
ObjectInfo: catfile.ObjectInfo{
Oid: result.ObjectID(),
Type: result.ObjectType(),
Size: result.ObjectSize(),
},
},
ObjectName: result.ObjectName,
})
}
// We're converting the error here to a plain un-nested error such
// that we don't have to replicate the complete error's structure.
err = it.Err()
if err != nil {
err = errors.New(err.Error())
}
require.Equal(t, tc.expectedErr, err)
require.Equal(t, tc.expectedResults, results)
})
}
t.Run("context cancellation", func(t *testing.T) {
ctx, cancel := context.WithCancel(testhelper.Context(t))
catfileCache := catfile.NewCache(cfg)
defer catfileCache.Stop()
objectReader, objectReaderCancel, err := catfileCache.ObjectReader(ctx, repo)
require.NoError(t, err)
defer objectReaderCancel()
it, err := CatfileObject(ctx, objectReader, NewCatfileInfoIterator(ctx, []CatfileInfoResult{
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer1, Type: "blob", Size: 133}},
{ObjectInfo: &catfile.ObjectInfo{Oid: lfsPointer2, Type: "blob", Size: 127}},
}))
require.NoError(t, err)
require.True(t, it.Next())
require.NoError(t, it.Err())
require.Equal(t, git.ObjectID(lfsPointer1), it.Result().ObjectID())
_, err = io.Copy(io.Discard, it.Result())
require.NoError(t, err)
cancel()
require.False(t, it.Next())
require.Equal(t, context.Canceled, it.Err())
require.Equal(t, CatfileObjectResult{
err: context.Canceled,
}, it.Result())
})
t.Run("context cancellation with cached process", func(t *testing.T) {
ctx, cancel := context.WithCancel(testhelper.Context(t))
ctx = testhelper.MergeIncomingMetadata(ctx, metadata.Pairs(
catfile.SessionIDField, "1",
))
catfileCache := catfile.NewCache(cfg)
defer catfileCache.Stop()
objectReader, objectReaderCancel, err := catfileCache.ObjectReader(ctx, repo)
require.NoError(t, err)
defer objectReaderCancel()
inputIter, inputCh, nextCh := newChanObjectIterator()
it, err := CatfileObject(ctx, objectReader, inputIter)
require.NoError(t, err)
// We request a single object from the catfile process. Because the request queue is
// not flushed after every object this means that the request is currently
// outstanding.
<-nextCh
inputCh <- git.ObjectID(lfsPointer1)
// Wait for the pipeline to request the next object.
<-nextCh
// We now cancel the context with the outstanding request. In the past, this used to
// block the downstream consumer of the object data. This is because of two reasons:
//
// - When the process is being cached then cancellation of the context doesn't cause
// the process to get killed. So consequentially, the process would sit around
// waiting for input.
// - We didn't flush the queue when the context was cancelled, so the buffered input
// never arrived at the process.
cancel()
// Now we queue another request that should cause the pipeline to fail.
inputCh <- git.ObjectID(lfsPointer1)
// Reading the object should now fail because the context got cancelled, but it
// definitely shouldn't block like it did earlier.
require.False(t, it.Next())
require.Equal(t, context.Canceled, it.Err())
})
}
|
