-
Notifications
You must be signed in to change notification settings - Fork 258
/
bufimagetesting.go
121 lines (113 loc) · 3.54 KB
/
bufimagetesting.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
// 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 bufimagetesting
import (
"testing"
"github.com/bufbuild/buf/private/bufpkg/bufimage"
"github.com/bufbuild/buf/private/bufpkg/bufmodule"
imagev1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/image/v1"
"github.com/bufbuild/buf/private/pkg/protodescriptor"
"github.com/gofrs/uuid/v5"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"google.golang.org/protobuf/proto"
)
// NewImageFile returns a new ImageFile for testing.
//
// TODO FUTURE: moduleFullName and commit should be options.
func NewImageFile(
t testing.TB,
fileDescriptor protodescriptor.FileDescriptor,
moduleFullName bufmodule.ModuleFullName,
commit uuid.UUID,
externalPath string,
localPath string,
isImport bool,
isSyntaxUnspecified bool,
unusedDependencyIndexes []int32,
) bufimage.ImageFile {
imageFile, err := bufimage.NewImageFile(
fileDescriptor,
moduleFullName,
commit,
externalPath,
localPath,
isImport,
isSyntaxUnspecified,
unusedDependencyIndexes,
)
require.NoError(t, err)
return imageFile
}
// NewProtoImageFile returns a new *imagev1.ImageFile for testing.
//
// This is also a protodescriptor.FileDescriptor.
func NewProtoImageFile(
t testing.TB,
path string,
importPaths ...string,
) *imagev1.ImageFile {
return &imagev1.ImageFile{
Name: proto.String(path),
Dependency: importPaths,
BufExtension: &imagev1.ImageFileExtension{
IsImport: proto.Bool(false),
IsSyntaxUnspecified: proto.Bool(false),
},
}
}
// NewProtoImageFileIsImport returns a new *imagev1.ImageFile for testing that is an import.
//
// This is also a protodescriptor.FileDescriptor.
func NewProtoImageFileIsImport(
t testing.TB,
path string,
importPaths ...string,
) *imagev1.ImageFile {
return &imagev1.ImageFile{
Name: proto.String(path),
Dependency: importPaths,
BufExtension: &imagev1.ImageFileExtension{
IsImport: proto.Bool(true),
IsSyntaxUnspecified: proto.Bool(false),
},
}
}
// AssertImageFilesEqual asserts the expected ImageFiles equal the actual ImageFiles.
func AssertImageFilesEqual(t testing.TB, expected []bufimage.ImageFile, actual []bufimage.ImageFile) {
expectedNormalizedImageFiles := normalizeImageFiles(t, expected)
actualNormalizedImageFiles := normalizeImageFiles(t, actual)
assert.Equal(t, expectedNormalizedImageFiles, actualNormalizedImageFiles)
}
func normalizeImageFiles(t testing.TB, imageFiles []bufimage.ImageFile) []bufimage.ImageFile {
normalizedImageFiles := make([]bufimage.ImageFile, len(imageFiles))
for i, imageFile := range imageFiles {
normalizedImageFiles[i] = NewImageFile(
t,
NewProtoImageFile(
t,
imageFile.FileDescriptorProto().GetName(),
imageFile.FileDescriptorProto().GetDependency()...,
),
imageFile.ModuleFullName(),
imageFile.CommitID(),
imageFile.ExternalPath(),
imageFile.LocalPath(),
imageFile.IsImport(),
imageFile.IsSyntaxUnspecified(),
imageFile.UnusedDependencyIndexes(),
)
}
return normalizedImageFiles
}