-
Notifications
You must be signed in to change notification settings - Fork 45
/
diff.go
303 lines (249 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
292
293
294
295
296
297
298
299
300
301
302
303
package checks
import (
"fmt"
"log"
"net/http"
"os"
"os/exec"
"path/filepath"
"strings"
goapk "github.com/chainguard-dev/go-apk/pkg/apk"
"github.com/google/go-cmp/cmp"
"github.com/wolfi-dev/wolfictl/pkg/apk"
"github.com/wolfi-dev/wolfictl/pkg/tar"
)
type DiffOptions struct {
Client *http.Client
Logger *log.Logger
PackageListFilename string
Dir string
PackagesDir string
ApkIndexURL string
ExistingPackages map[string]*goapk.Package
}
func NewDiff() *DiffOptions {
o := &DiffOptions{
Client: http.DefaultClient,
Logger: log.New(log.Writer(), "wolfictl check diff: ", log.LstdFlags|log.Lmsgprefix),
}
return o
}
// Diff compare a newly built apk with the latest in an APK repository, writing the differences to a file diff.log
func (o *DiffOptions) Diff() error {
// create two temp folders we can use to explode the apks and compare their contents
dirExistingApk, err := os.MkdirTemp("", "wolfictl-apk-*")
if err != nil {
return fmt.Errorf("failed to create temporary dir: %w", err)
}
defer os.RemoveAll(dirExistingApk)
dirNewApk, err := os.MkdirTemp("", "wolfictl-apk-*")
if err != nil {
return fmt.Errorf("failed to create temporary dir: %w", err)
}
defer os.RemoveAll(dirNewApk)
// get the latest APKINDEX
apkContext := apk.New(o.Client, o.ApkIndexURL)
o.ExistingPackages, err = apkContext.GetApkPackages()
if err != nil {
return fmt.Errorf("failed to get APK packages from URL %s: %w", o.ApkIndexURL, err)
}
// get a list of new package names that have recently been built
newPackages, err := getNewPackages(o.PackageListFilename)
if err != nil {
return fmt.Errorf("failed to get new packages from file %s: %w", o.PackageListFilename, err)
}
// for each new package being built grab the latest existing one
for newPackageName, newAPK := range newPackages {
o.Logger.Printf("checking %s", newPackageName)
// read new apk
filename := filepath.Join(o.PackagesDir, newAPK.Arch, fmt.Sprintf("%s-%s-r%s.apk", newPackageName, newAPK.Version, newAPK.Epoch))
newFile, err := os.Open(filename)
if err != nil {
return fmt.Errorf("failed to read %s: %w", filename, err)
}
if err := tar.Untar(newFile, filepath.Join(dirNewApk, newPackageName)); err != nil {
return fmt.Errorf("failed to untar new apk: %w", err)
}
// fetch current latest apk
p, ok := o.ExistingPackages[newPackageName]
if !ok {
err = os.Mkdir(filepath.Join(dirExistingApk, newAPK.Name), os.ModePerm)
if err != nil {
return fmt.Errorf("failed to mkdir %s", filepath.Join(dirExistingApk, newAPK.Name))
}
continue
}
existingFilename := fmt.Sprintf("%s-%s.apk", p.Name, p.Version)
err = downloadCurrentAPK(o.Client, o.ApkIndexURL, existingFilename, filepath.Join(dirExistingApk, newPackageName))
if err != nil {
return fmt.Errorf("failed to download %s using base URL %s: %w", newPackageName, existingFilename, err)
}
}
rs, err := diffDirectories(dirNewApk, dirExistingApk)
if err != nil {
return err
}
// If bincapz is on the path, then run it to get a capability diff.
var result []byte
if path, err := exec.LookPath("bincapz"); err == nil {
o.Logger.Printf("starting bincapz for %d packages", len(newPackages))
// --min-file-level=3 filters out lower-risk changes in lower-risk files.
//
// As we get more comfortable with the output, we should decrease this value from 3 (HIGH) to 2 (MEDIUM).
cmd := exec.Command(path, "-diff", "-format=markdown", "-min-file-level=3", dirExistingApk, dirNewApk)
result, err = cmd.CombinedOutput()
if err != nil {
return err
}
o.Logger.Printf("finished bincapz")
}
diffFile := filepath.Join(o.Dir, "diff.log")
err = writeDiffLog(rs, result, diffFile, newPackages)
if err != nil {
return fmt.Errorf("failed writing to file: %w", err)
}
fmt.Printf("diff written to %s\n", diffFile)
return nil
}
func readFileContents(path string) (string, error) {
bytes, err := os.ReadFile(path)
if err != nil {
return "", err
}
return string(bytes), nil
}
type diffResult struct {
added []string
modified []string
deleted []string
// If present, contains .PKGINFO.
// [0] = before, [1] = after.
pkginfos []string
}
func diffDirectories(dir1, dir2 string) (diffResult, error) {
result := diffResult{}
err := filepath.Walk(dir1, func(path1 string, info1 os.FileInfo, err error) error {
if err != nil {
return err
}
if info1.IsDir() {
return nil
}
relPath, err := filepath.Rel(dir1, path1)
if err != nil {
return err
}
path2 := filepath.Join(dir2, relPath)
if shouldSkipFile(path1) {
return nil
}
info2, err := os.Stat(path2)
if os.IsNotExist(err) {
if filepath.Base(path1) == ".PKGINFO" {
content, err := readFileContents(path1)
if err != nil {
return err
}
result.pkginfos = append(result.pkginfos, content)
}
result.added = append(result.added, relPath)
} else if !info2.IsDir() {
content1, err := readFileContents(path1)
if err != nil {
return err
}
content2, err := readFileContents(path2)
if err != nil {
return err
}
if content1 != content2 {
if filepath.Base(path1) == ".PKGINFO" {
result.pkginfos = append(result.pkginfos, content2, content1)
} else {
result.modified = append(result.modified, relPath)
}
}
}
return nil
})
if err != nil {
return diffResult{}, err
}
err = filepath.Walk(dir2, func(path2 string, info2 os.FileInfo, err error) error {
if err != nil {
return err
}
if info2.IsDir() {
return nil
}
relPath, err := filepath.Rel(dir2, path2)
if err != nil {
return err
}
path1 := filepath.Join(dir1, relPath)
if shouldSkipFile(path2) {
return nil
}
_, err = os.Stat(path1)
if os.IsNotExist(err) {
result.deleted = append(result.deleted, relPath)
}
return nil
})
if err != nil {
return diffResult{}, err
}
return result, nil
}
// let's skip wolfi core files
func shouldSkipFile(path string) bool {
return strings.HasSuffix(path, ".rsa.pub") ||
strings.HasSuffix(path, ".spdx.json")
}
func writeDiffLog(diff diffResult, bcz []byte, filename string, newPackages map[string]NewApkPackage) error {
var builder strings.Builder
for packageName := range newPackages {
builder.WriteString("<details>\n")
builder.WriteString(" <summary>Package " + packageName + ": Click to expand/collapse</summary>\n")
builder.WriteString("\n")
builder.WriteString("Package " + packageName + ":\n")
if len(diff.pkginfos) == 1 {
fmt.Fprintf(&builder, "\n`.PKGINFO` metadata:\n```\n%s\n```\n", diff.pkginfos[0])
} else if len(diff.pkginfos) == 2 {
cmpdiff := cmp.Diff(diff.pkginfos[0], diff.pkginfos[1])
fmt.Fprintf(&builder, "\n`.PKGINFO` metadata:\n```\n%s\n```\n", cmpdiff)
}
changes := []string{}
for _, added := range diff.added {
if strings.HasPrefix(added, packageName+"/") {
changes = append(changes, "Added: "+strings.TrimPrefix(added, packageName))
}
}
for _, modified := range diff.modified {
if strings.HasPrefix(modified, packageName+"/") {
changes = append(changes, "Modified: "+strings.TrimPrefix(modified, packageName))
}
}
for _, deleted := range diff.deleted {
if strings.HasPrefix(deleted, packageName+"/") {
changes = append(changes, "Deleted: "+strings.TrimPrefix(deleted, packageName))
}
}
if len(changes) == 0 {
builder.WriteString("Unchanged\n")
} else {
for _, change := range changes {
builder.WriteString(change + "\n")
}
}
builder.WriteString("\n</details>\n\n")
}
if len(bcz) > 0 {
builder.WriteString("<details>\n")
builder.WriteString(" <summary>bincapz found differences: Click to expand/collapse</summary>\n\n")
builder.Write(bcz)
builder.WriteString("\n</details>\n\n")
}
content := builder.String()
return os.WriteFile(filename, []byte(content), os.ModePerm)
}