-
Notifications
You must be signed in to change notification settings - Fork 273
/
diff.go
291 lines (274 loc) · 7.75 KB
/
diff.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
// Copyright 2020-2021 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 storage
import (
"bytes"
"context"
"fmt"
"io"
"strings"
"github.com/bufbuild/buf/private/pkg/diff"
)
// DiffOption is an option for Diff.
type DiffOption func(*diffOptions)
// DiffWithSuppressCommands returns a new DiffOption that suppresses printing of commands.
func DiffWithSuppressCommands() DiffOption {
return func(diffOptions *diffOptions) {
diffOptions.suppressCommands = true
}
}
// DiffWithSuppressCommands returns a new DiffOption that suppresses printing of timestamps.
func DiffWithSuppressTimestamps() DiffOption {
return func(diffOptions *diffOptions) {
diffOptions.suppressTimestamps = true
}
}
// DiffWithExternalPaths returns a new DiffOption that prints diffs with external paths
// instead of paths.
func DiffWithExternalPaths() DiffOption {
return func(diffOptions *diffOptions) {
diffOptions.externalPaths = true
}
}
// DiffWithExternalPathPrefixes returns a new DiffOption that sets the external path prefixes for the buckets.
//
// If a file is in one bucket but not the other, it will be assumed that the file begins
// with the given prefix, and this prefix should be substituted for the other prefix.
//
// For example, if diffing the directories "test/a" and "test/b", use "test/a/" and "test/b/",
// and a file that is in one with path "test/a/foo.txt" will be shown as not
// existing as "test/b/foo.txt" in two.
//
// Note that the prefixes are directly concatenated, so "/" should be included generally.
//
// This option has no effect if DiffWithExternalPaths is not set.
// This option is not required if the prefixes are equal.
func DiffWithExternalPathPrefixes(
oneExternalPathPrefix string,
twoExternalPathPrefix string,
) DiffOption {
return func(diffOptions *diffOptions) {
if oneExternalPathPrefix != twoExternalPathPrefix {
// we don't know if external paths are file paths or not
// so we just operate on pure string-prefix paths
// this comes up with for example s3://
diffOptions.oneExternalPathPrefix = oneExternalPathPrefix
diffOptions.twoExternalPathPrefix = twoExternalPathPrefix
}
}
}
// DiffBytes does a diff of the ReadBuckets.
func DiffBytes(
ctx context.Context,
one ReadBucket,
two ReadBucket,
options ...DiffOption,
) ([]byte, error) {
buffer := bytes.NewBuffer(nil)
if err := Diff(ctx, buffer, one, two, options...); err != nil {
return nil, err
}
return buffer.Bytes(), nil
}
// Diff writes a diff of the ReadBuckets to the Writer.
func Diff(
ctx context.Context,
writer io.Writer,
one ReadBucket,
two ReadBucket,
options ...DiffOption,
) error {
diffOptions := newDiffOptions()
for _, option := range options {
option(diffOptions)
}
externalPaths := diffOptions.externalPaths
oneExternalPathPrefix := diffOptions.oneExternalPathPrefix
twoExternalPathPrefix := diffOptions.twoExternalPathPrefix
oneObjectInfos, err := allObjectInfos(ctx, one, "")
if err != nil {
return err
}
twoObjectInfos, err := allObjectInfos(ctx, two, "")
if err != nil {
return err
}
sortObjectInfos(oneObjectInfos)
sortObjectInfos(twoObjectInfos)
onePathToObjectInfo := pathToObjectInfo(oneObjectInfos)
twoPathToObjectInfo := pathToObjectInfo(twoObjectInfos)
for _, oneObjectInfo := range oneObjectInfos {
path := oneObjectInfo.Path()
oneDiffPath, err := getDiffPathForObjectInfo(
oneObjectInfo,
externalPaths,
oneExternalPathPrefix,
)
if err != nil {
return err
}
oneData, err := ReadPath(ctx, one, path)
if err != nil {
return err
}
var twoData []byte
var twoDiffPath string
if twoObjectInfo, ok := twoPathToObjectInfo[path]; ok {
twoData, err = ReadPath(ctx, two, path)
if err != nil {
return err
}
twoDiffPath, err = getDiffPathForObjectInfo(
twoObjectInfo,
externalPaths,
twoExternalPathPrefix,
)
if err != nil {
return err
}
} else {
twoDiffPath, err = getDiffPathForNotFound(
oneObjectInfo,
externalPaths,
oneExternalPathPrefix,
twoExternalPathPrefix,
)
if err != nil {
return err
}
}
diffData, err := diff.Diff(
ctx,
oneData,
twoData,
oneDiffPath,
twoDiffPath,
diffOptions.toDiffPackageOptions()...,
)
if err != nil {
return err
}
if len(diffData) > 0 {
if _, err := writer.Write(diffData); err != nil {
return err
}
}
}
for _, twoObjectInfo := range twoObjectInfos {
path := twoObjectInfo.Path()
if _, ok := onePathToObjectInfo[path]; !ok {
twoData, err := ReadPath(ctx, two, path)
if err != nil {
return err
}
oneDiffPath, err := getDiffPathForNotFound(
twoObjectInfo,
externalPaths,
twoExternalPathPrefix,
oneExternalPathPrefix,
)
if err != nil {
return err
}
twoDiffPath, err := getDiffPathForObjectInfo(
twoObjectInfo,
externalPaths,
twoExternalPathPrefix,
)
if err != nil {
return err
}
diffData, err := diff.Diff(
ctx,
nil,
twoData,
oneDiffPath,
twoDiffPath,
diffOptions.toDiffPackageOptions()...,
)
if err != nil {
return err
}
if len(diffData) > 0 {
if _, err := writer.Write(diffData); err != nil {
return err
}
}
}
}
return nil
}
func getDiffPathForObjectInfo(
objectInfo ObjectInfo,
externalPaths bool,
externalPathPrefix string,
) (string, error) {
if !externalPaths {
return objectInfo.Path(), nil
}
externalPath := objectInfo.ExternalPath()
if externalPathPrefix == "" {
return externalPath, nil
}
if !strings.HasPrefix(externalPath, externalPathPrefix) {
return "", fmt.Errorf("diff: expected %s to have prefix %s", externalPath, externalPathPrefix)
}
return externalPath, nil
}
func getDiffPathForNotFound(
foundObjectInfo ObjectInfo,
externalPaths bool,
foundExternalPathPrefix string,
notFoundExternalPathPrefix string,
) (string, error) {
if !externalPaths {
return foundObjectInfo.Path(), nil
}
externalPath := foundObjectInfo.ExternalPath()
switch {
case foundExternalPathPrefix == "" && notFoundExternalPathPrefix == "":
// no prefix, just return external path
return externalPath, nil
case foundExternalPathPrefix == "" && notFoundExternalPathPrefix != "":
// the not-found side has a prefix, append the external path to this prefix, and we're done
return notFoundExternalPathPrefix + externalPath, nil
default:
//foundExternalPathPrefix != "" && notFoundExternalPathPrefix == ""
//foundExternalPathPrefix != "" && notFoundExternalPathPrefix != ""
if !strings.HasPrefix(externalPath, foundExternalPathPrefix) {
return "", fmt.Errorf("diff: expected %s to have prefix %s", externalPath, foundExternalPathPrefix)
}
return notFoundExternalPathPrefix + strings.TrimPrefix(externalPath, foundExternalPathPrefix), nil
}
}
type diffOptions struct {
suppressCommands bool
suppressTimestamps bool
externalPaths bool
oneExternalPathPrefix string
twoExternalPathPrefix string
}
func newDiffOptions() *diffOptions {
return &diffOptions{}
}
func (d *diffOptions) toDiffPackageOptions() []diff.DiffOption {
var diffPackageOptions []diff.DiffOption
if d.suppressCommands {
diffPackageOptions = append(diffPackageOptions, diff.DiffWithSuppressCommands())
}
if d.suppressTimestamps {
diffPackageOptions = append(diffPackageOptions, diff.DiffWithSuppressTimestamps())
}
return diffPackageOptions
}