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
213
214
215
216
217
218
|
package transaction
import (
"context"
"fmt"
"os"
"path/filepath"
"testing"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v14/internal/backchannel"
"gitlab.com/gitlab-org/gitaly/v14/internal/safe"
"gitlab.com/gitlab-org/gitaly/v14/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v14/internal/transaction/txinfo"
"gitlab.com/gitlab-org/gitaly/v14/internal/transaction/voting"
"google.golang.org/grpc/peer"
)
func TestRunOnContext(t *testing.T) {
ctx := testhelper.Context(t)
backchannelPeer := &peer.Peer{
AuthInfo: backchannel.WithID(nil, 1234),
}
t.Run("without transaction", func(t *testing.T) {
require.NoError(t, RunOnContext(ctx, func(tx txinfo.Transaction) error {
t.Fatal("this function should not be executed")
return nil
}))
})
t.Run("with transaction and no error", func(t *testing.T) {
ctx, err := txinfo.InjectTransaction(ctx, 5678, "node", true)
require.NoError(t, err)
ctx = peer.NewContext(ctx, backchannelPeer)
callbackExecuted := false
require.NoError(t, RunOnContext(ctx, func(tx txinfo.Transaction) error {
require.Equal(t, txinfo.Transaction{
ID: 5678,
Node: "node",
Primary: true,
BackchannelID: 1234,
}, tx)
callbackExecuted = true
return nil
}))
require.True(t, callbackExecuted, "callback should have been executed")
})
t.Run("with transaction and error", func(t *testing.T) {
ctx, err := txinfo.InjectTransaction(ctx, 5678, "node", true)
require.NoError(t, err)
ctx = peer.NewContext(ctx, backchannelPeer)
expectedErr := fmt.Errorf("any error")
require.Equal(t, expectedErr, RunOnContext(ctx, func(txinfo.Transaction) error {
return expectedErr
}))
})
t.Run("with transaction but missing peer", func(t *testing.T) {
ctx, err := txinfo.InjectTransaction(ctx, 5678, "node", true)
require.NoError(t, err)
require.EqualError(t, RunOnContext(ctx, nil), "get peer id: no peer info in context")
})
}
func TestVoteOnContext(t *testing.T) {
ctx := testhelper.Context(t)
backchannelPeer := &peer.Peer{
AuthInfo: backchannel.WithID(nil, 1234),
}
expectedVote := voting.VoteFromData([]byte("1"))
t.Run("without transaction", func(t *testing.T) {
require.NoError(t, VoteOnContext(ctx, &MockManager{}, voting.Vote{}, voting.Prepared))
})
t.Run("successful vote", func(t *testing.T) {
ctx, err := txinfo.InjectTransaction(ctx, 5678, "node", true)
require.NoError(t, err)
ctx = peer.NewContext(ctx, backchannelPeer)
callbackExecuted := false
require.NoError(t, VoteOnContext(ctx, &MockManager{
VoteFn: func(ctx context.Context, tx txinfo.Transaction, vote voting.Vote, phase voting.Phase) error {
require.Equal(t, txinfo.Transaction{
ID: 5678,
Node: "node",
Primary: true,
BackchannelID: 1234,
}, tx)
callbackExecuted = true
require.Equal(t, expectedVote, vote)
require.Equal(t, voting.Prepared, phase)
return nil
},
}, expectedVote, voting.Prepared))
require.True(t, callbackExecuted, "callback should have been executed")
})
t.Run("failing vote", func(t *testing.T) {
ctx, err := txinfo.InjectTransaction(ctx, 5678, "node", true)
require.NoError(t, err)
ctx = peer.NewContext(ctx, backchannelPeer)
expectedErr := fmt.Errorf("any error")
require.Equal(t, expectedErr, VoteOnContext(ctx, &MockManager{
VoteFn: func(context.Context, txinfo.Transaction, voting.Vote, voting.Phase) error {
return expectedErr
},
}, expectedVote, voting.Prepared))
})
}
func TestCommitLockedFile(t *testing.T) {
ctx := testhelper.Context(t)
backchannelPeer := &peer.Peer{
AuthInfo: backchannel.WithID(nil, 1234),
}
t.Run("without transaction", func(t *testing.T) {
file := filepath.Join(testhelper.TempDir(t), "file")
writer, err := safe.NewLockingFileWriter(file)
require.NoError(t, err)
_, err = writer.Write([]byte("contents"))
require.NoError(t, err)
require.NoError(t, CommitLockedFile(ctx, &MockManager{}, writer))
require.Equal(t, []byte("contents"), testhelper.MustReadFile(t, file))
})
ctx, err := txinfo.InjectTransaction(ctx, 5678, "node", true)
require.NoError(t, err)
ctx = peer.NewContext(ctx, backchannelPeer)
t.Run("successful transaction", func(t *testing.T) {
file := filepath.Join(testhelper.TempDir(t), "file")
writer, err := safe.NewLockingFileWriter(file)
require.NoError(t, err)
_, err = writer.Write([]byte("contents"))
require.NoError(t, err)
calls := 0
require.NoError(t, CommitLockedFile(ctx, &MockManager{
VoteFn: func(ctx context.Context, tx txinfo.Transaction, vote voting.Vote, phase voting.Phase) error {
require.Equal(t, txinfo.Transaction{
ID: 5678,
Node: "node",
Primary: true,
BackchannelID: 1234,
}, tx)
require.Equal(t, voting.VoteFromData([]byte("contents")), vote)
calls++
switch calls {
case 1:
require.Equal(t, voting.Prepared, phase)
case 2:
require.Equal(t, voting.Committed, phase)
default:
require.FailNow(t, "unexpected voting phase %q", phase)
}
return nil
},
}, writer))
require.Equal(t, 2, calls, "expected two votes")
require.Equal(t, []byte("contents"), testhelper.MustReadFile(t, file))
})
t.Run("failing transaction", func(t *testing.T) {
file := filepath.Join(testhelper.TempDir(t), "file")
writer, err := safe.NewLockingFileWriter(file)
require.NoError(t, err)
_, err = writer.Write([]byte("contents"))
require.NoError(t, err)
err = CommitLockedFile(ctx, &MockManager{
VoteFn: func(context.Context, txinfo.Transaction, voting.Vote, voting.Phase) error {
return fmt.Errorf("some error")
},
}, writer)
require.EqualError(t, err, "voting on locked file: preimage vote: some error")
require.NoFileExists(t, file)
})
t.Run("concurrent modification", func(t *testing.T) {
file := filepath.Join(testhelper.TempDir(t), "file")
writer, err := safe.NewLockingFileWriter(file)
require.NoError(t, err)
_, err = writer.Write([]byte("contents"))
require.NoError(t, err)
err = CommitLockedFile(ctx, &MockManager{
VoteFn: func(context.Context, txinfo.Transaction, voting.Vote, voting.Phase) error {
// This shouldn't typically happen given that the file is locked,
// but we concurrently update the file after our first vote.
require.NoError(t, os.WriteFile(file, []byte("something"), 0o666))
return nil
},
}, writer)
require.EqualError(t, err, "committing file: file concurrently created")
require.Equal(t, []byte("something"), testhelper.MustReadFile(t, file))
})
}
|
