forked from bufbuild/buf
/
bufsynctest.go
351 lines (337 loc) · 12.1 KB
/
bufsynctest.go
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
// Copyright 2020-2024 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package bufsynctest
import (
"context"
"fmt"
"path/filepath"
"testing"
"github.com/alis-exchange/buf/private/buf/bufsync"
"github.com/alis-exchange/buf/private/bufpkg/bufcas"
"github.com/alis-exchange/buf/private/bufpkg/bufcas/bufcasalpha"
"github.com/alis-exchange/buf/private/bufpkg/bufconfig"
"github.com/alis-exchange/buf/private/bufpkg/bufmodule/bufmodulebuild"
"github.com/alis-exchange/buf/private/bufpkg/bufmodule/bufmoduleref"
modulev1alpha1 "github.com/alis-exchange/buf/private/gen/proto/go/buf/alpha/module/v1alpha1"
"github.com/alis-exchange/buf/private/pkg/git"
"github.com/alis-exchange/buf/private/pkg/git/gittest"
"github.com/alis-exchange/buf/private/pkg/storage"
"github.com/alis-exchange/buf/private/pkg/storage/storagegit"
"github.com/alis-exchange/buf/private/pkg/storage/storagemem"
"github.com/alis-exchange/buf/private/pkg/uuidutil"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/zap/zaptest"
)
const (
ReleaseBranchName = "__release__"
OtherProtectedBranchName = "__protected__"
)
// TestHandler is a bufsync.Handler with a few helpful utilities for tests to set up
// and assert some state.
type TestHandler interface {
bufsync.Handler
ManuallyPushModule(
ctx context.Context,
t *testing.T,
targetModuleIdentity bufmoduleref.ModuleIdentity,
branchName string,
manifest *modulev1alpha1.Blob,
blobs []*modulev1alpha1.Blob,
)
}
// RunTestSuite runs a set of test cases using Syncer with the provided TestHandler. Use
// this test suite to ensure compliance with Sync behavior.
//
// The following behavior is asserted:
//
// # Local validation
//
// - Prevent duplicate module identities across module dirs on a branch.
//
// # Syncing commits
//
// CONDITION RESUME FROM (-> means fallback)
// new remote branch:
// unprotected: any synced commit from any branch -> START of branch
// protected:
// not release branch: START of branch
// release lineage:
// empty: START of branch
// not empty: content match(HEAD of Release) -> HEAD of branch
// existing remote branch:
// not previously synced: content match -> HEAD of branch
// previously synced:
// protected: protect branch && any synced commit from branch -> error
// unprotected: any synced commit from any branch -> content match -> HEAD of branch
func RunTestSuite(t *testing.T, handlerProvider func() TestHandler) {
t.Run("duplicate_identities", func(t *testing.T) {
t.Parallel()
handler := handlerProvider()
testDuplicateIdentities(t, handler, makeRunFunc(handler))
})
t.Run("new_remote_branch", func(t *testing.T) {
t.Parallel()
t.Run("unprotected", func(t *testing.T) {
t.Parallel()
t.Run("overlap_with_another_synced_branch", func(t *testing.T) {
t.Parallel()
testNewRemoteBranchUnprotectedOverlapWithAnotherSyncedBranch(t, makeRunFunc(handlerProvider()))
})
t.Run("no_overlap_with_any_synced_branch", func(t *testing.T) {
t.Parallel()
testNewRemoteBranchUnprotectedNoOverlapWithAnySyncedBranch(t, makeRunFunc(handlerProvider()))
})
})
t.Run("protected", func(t *testing.T) {
t.Parallel()
t.Run("not_release_branch", func(t *testing.T) {
t.Parallel()
testNewRemoteBranchProtectedNotReleaseBranch(t, makeRunFunc(handlerProvider()))
})
t.Run("release_branch", func(t *testing.T) {
t.Parallel()
t.Run("empty", func(t *testing.T) {
t.Parallel()
testNewRemoteBranchProtectedReleaseBranchEmpty(t, makeRunFunc(handlerProvider()))
})
t.Run("not_empty", func(t *testing.T) {
t.Parallel()
t.Run("content_match", func(t *testing.T) {
t.Parallel()
handler := handlerProvider()
testNewRemoteBranchProtectedReleaseBranchNotEmptyContentMatch(t, handler, makeRunFunc(handler))
})
t.Run("no_content_match", func(t *testing.T) {
t.Parallel()
handler := handlerProvider()
testNewRemoteBranchProtectedReleaseBranchNotEmptyNoContentMatch(t, handler, makeRunFunc(handler))
})
})
})
})
})
t.Run("existing_remote_branch", func(t *testing.T) {
t.Parallel()
t.Run("not_previously_synced", func(t *testing.T) {
t.Parallel()
t.Run("content_match", func(t *testing.T) {
t.Parallel()
handler := handlerProvider()
testExistingRemoteBranchNotPreviouslySyncedContentMatch(t, handler, makeRunFunc(handler))
})
t.Run("no_content_match", func(t *testing.T) {
t.Parallel()
handler := handlerProvider()
testExistingRemoteBranchNotPreviouslySyncedNoContentMatch(t, handler, makeRunFunc(handler))
})
})
t.Run("previously_synced", func(t *testing.T) {
t.Parallel()
t.Run("protected", func(t *testing.T) {
t.Parallel()
t.Run("fails_protection", func(t *testing.T) {
t.Parallel()
handler := handlerProvider()
testExistingRemoteBranchPreviouslySyncedProtectedFailsProtection(t, handler, makeRunFunc(handler))
})
t.Run("passes_protection", func(t *testing.T) {
t.Parallel()
testExistingRemoteBranchPreviouslySyncedProtectedPassesProtection(t, makeRunFunc(handlerProvider()))
})
})
t.Run("unprotected", func(t *testing.T) {
t.Parallel()
t.Run("overlap_with_another_synced_branch", func(t *testing.T) {
t.Parallel()
testExistingRemoteBranchPreviouslySyncedUnprotectedOverlapWithAnotherSyncedBranch(t, makeRunFunc(handlerProvider()))
})
t.Run("no_overlap_with_any_synced_branch", func(t *testing.T) {
t.Parallel()
t.Run("content_match", func(t *testing.T) {
t.Parallel()
testExistingRemoteBranchPreviouslySyncedUnprotectedNoOverlapWithAnySyncedBranchContentMatch(t, makeRunFunc(handlerProvider()))
})
t.Run("no_content_match", func(t *testing.T) {
t.Parallel()
testExistingRemoteBranchPreviouslySyncedUnprotectedNoOverlapWithAnySyncedBranchNoContentMatch(t, makeRunFunc(handlerProvider()))
})
})
})
})
})
}
// runFunc runs Plan and Sync on the provided Repository with the provided options, returning any error that occurred along the way.
// If Plan errors, Sync is not invoked.
type runFunc func(t *testing.T, repo git.Repository, options ...bufsync.SyncerOption) (bufsync.ExecutionPlan, error)
func makeRunFunc(handler bufsync.Handler) runFunc {
return func(t *testing.T, repo git.Repository, options ...bufsync.SyncerOption) (bufsync.ExecutionPlan, error) {
syncer, err := bufsync.NewSyncer(
zaptest.NewLogger(t),
repo,
storagegit.NewProvider(repo.Objects()),
handler,
options...,
)
require.NoError(t, err)
plan, err := syncer.Plan(context.Background())
if err != nil {
return plan, err
}
return plan, syncer.Sync(context.Background())
}
}
func doCommitRandomModule(
t *testing.T,
repo gittest.Repository,
dir string,
moduleIdentity bufmoduleref.ModuleIdentity,
) bufmoduleref.ModuleIdentity {
if moduleIdentity == nil {
moduleName, err := uuidutil.New()
require.NoError(t, err)
moduleIdentity, err = bufmoduleref.NewModuleIdentity("buf.build", "acme", moduleName.String())
require.NoError(t, err)
}
repo.Commit(t, "module-"+moduleIdentity.IdentityString(), map[string]string{
filepath.Join(dir, "buf.yaml"): fmt.Sprintf("version: v1\nname: %s\n", moduleIdentity.IdentityString()),
filepath.Join(dir, "foo.proto"): `syntax="proto3"; package buf;`,
})
repo.Tag(t, "module/"+moduleIdentity.IdentityString(), "")
return moduleIdentity
}
func doRandomUpdateToModule(t *testing.T, repo gittest.Repository, dir string, counter *int) {
*counter++
repo.Commit(t, fmt.Sprintf("change-module-%d", *counter), map[string]string{
filepath.Join(dir, fmt.Sprintf("foo_%d.proto", *counter)): fmt.Sprintf(`syntax="proto3"; package buf_%d;`, *counter),
})
repo.Tag(t, fmt.Sprintf("tag-%d", *counter), "")
}
func doManualPushCommit(
t *testing.T,
handler TestHandler,
repo gittest.Repository,
targetModuleIdentity bufmoduleref.ModuleIdentity,
moduleDir string,
branch string,
commit git.Commit,
) {
commitBucket, err := storagegit.NewProvider(repo.Objects()).NewReadBucket(commit.Tree())
require.NoError(t, err)
moduleBucket := storage.MapReadBucket(commitBucket, storage.MapOnPrefix(moduleDir))
sourceConfig, err := bufconfig.GetConfigForBucket(context.Background(), moduleBucket)
require.NoError(t, err)
builtModule, err := bufmodulebuild.NewModuleBucketBuilder().BuildForBucket(
context.Background(),
moduleBucket,
sourceConfig.Build,
bufmodulebuild.WithModuleIdentity(sourceConfig.ModuleIdentity),
)
require.NoError(t, err)
fileSet, err := bufcas.NewFileSetForBucket(context.Background(), builtModule.Bucket)
require.NoError(t, err)
protoManifestBlob, protoBlobs, err := bufcasalpha.FileSetToAlphaManifestBlobAndBlobs(fileSet)
require.NoError(t, err)
handler.ManuallyPushModule(
context.Background(),
t,
targetModuleIdentity,
branch,
protoManifestBlob,
protoBlobs,
)
}
func doManualPushRandomModule(
t *testing.T,
handler TestHandler,
targetModuleIdentity bufmoduleref.ModuleIdentity,
branch string,
counter *int,
) {
*counter++
bucket, err := storagemem.NewReadBucket(map[string][]byte{
"buf.yaml": []byte(fmt.Sprintf("version: v1\nname: %s\n", targetModuleIdentity.IdentityString())),
fmt.Sprintf("foo_%d.proto", *counter): []byte(fmt.Sprintf(`syntax="proto3"; package buf_%d;`, *counter)),
})
require.NoError(t, err)
fileSet, err := bufcas.NewFileSetForBucket(context.Background(), bucket)
require.NoError(t, err)
protoManifestBlob, protoBlobs, err := bufcasalpha.FileSetToAlphaManifestBlobAndBlobs(fileSet)
require.NoError(t, err)
handler.ManuallyPushModule(
context.Background(),
t,
targetModuleIdentity,
branch,
protoManifestBlob,
protoBlobs,
)
}
func doEmptyCommits(t *testing.T, repo gittest.Repository, numOfCommits int, counter *int) {
for i := 0; i < numOfCommits; i++ {
*counter++
randomContent, err := uuidutil.New()
require.NoError(t, err)
repo.Commit(t, fmt.Sprintf("commit-%d", *counter), map[string]string{
"randomfile.txt": randomContent.String(),
})
repo.Tag(t, fmt.Sprintf("tag-%d", *counter), "")
}
}
func assertPlanForModuleBranch(
t *testing.T,
plan bufsync.ExecutionPlan,
identity bufmoduleref.ModuleIdentity,
branch string,
expectedMessagesOfCommitsToSync ...string,
) {
t.Helper()
var found = false
for _, moduleBranch := range plan.ModuleBranchesToSync() {
if moduleBranch.BranchName() != branch {
continue
}
if moduleBranch.TargetModuleIdentity().IdentityString() != identity.IdentityString() {
continue
}
found = true
var actualMessagesOfCommitsToSync []string
for _, commitToSync := range moduleBranch.CommitsToSync() {
actualMessagesOfCommitsToSync = append(actualMessagesOfCommitsToSync, commitToSync.Commit().Message())
}
assert.Equal(t, expectedMessagesOfCommitsToSync, actualMessagesOfCommitsToSync)
}
assert.True(t, found, "no plan for module branch")
}
func assertPlanForModuleTags(
t *testing.T,
plan bufsync.ExecutionPlan,
identity bufmoduleref.ModuleIdentity,
expectedMessagesOfTaggedCommitsToSync ...string,
) {
t.Helper()
var found = false
for _, moduleBranch := range plan.ModuleTagsToSync() {
if moduleBranch.TargetModuleIdentity().IdentityString() != identity.IdentityString() {
continue
}
found = true
var actualMessagesOfTaggedCommitsToSync []string
for _, commitToSync := range moduleBranch.TaggedCommitsToSync() {
actualMessagesOfTaggedCommitsToSync = append(actualMessagesOfTaggedCommitsToSync, commitToSync.Commit().Message())
}
assert.ElementsMatch(t, expectedMessagesOfTaggedCommitsToSync, actualMessagesOfTaggedCommitsToSync)
}
assert.True(t, found, "no plan for module tags")
}