-
Notifications
You must be signed in to change notification settings - Fork 46
/
sync.go
373 lines (310 loc) · 8.75 KB
/
sync.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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
// Copyright 2020 VMware, Inc.
// SPDX-License-Identifier: Apache-2.0
package githubrelease
import (
"crypto/sha256"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"path/filepath"
"github.com/bmatcuk/doublestar"
ctlconf "github.com/vmware-tanzu/carvel-vendir/pkg/vendir/config"
ctlfetch "github.com/vmware-tanzu/carvel-vendir/pkg/vendir/fetch"
)
type Sync struct {
opts ctlconf.DirectoryContentsGithubRelease
defaultAPIToken string
refFetcher ctlfetch.RefFetcher
}
func NewSync(opts ctlconf.DirectoryContentsGithubRelease,
defaultAPIToken string, refFetcher ctlfetch.RefFetcher) Sync {
return Sync{opts, defaultAPIToken, refFetcher}
}
func (d Sync) DescAndURL() (string, string, error) {
desc := ""
url := fmt.Sprintf("https://api.github.com/repos/%s/releases", d.opts.Slug)
switch {
case len(d.opts.URL) > 0:
desc = d.opts.URL
url = d.opts.URL
case len(d.opts.Tag) > 0:
desc = d.opts.Slug + "@" + d.opts.Tag
url += "/tags/" + d.opts.Tag
case d.opts.Latest:
desc = d.opts.Slug + "@latest"
url += "/latest"
default:
return "", "", fmt.Errorf("Expected to have non-empty tag, latest or url")
}
return desc, url, nil
}
func (d Sync) Sync(dstPath string, tempArea ctlfetch.TempArea) (ctlconf.LockDirectoryContentsGithubRelease, error) {
lockConf := ctlconf.LockDirectoryContentsGithubRelease{}
incomingTmpPath, err := tempArea.NewTempDir("github-release")
if err != nil {
return lockConf, err
}
defer os.RemoveAll(incomingTmpPath)
authToken, err := d.authToken()
if err != nil {
return lockConf, err
}
releaseAPI, err := d.downloadRelease(authToken)
if err != nil {
return lockConf, fmt.Errorf("Downloading release info: %s", err)
}
fileChecksums := map[string]string{}
matchedAssets := []ReleaseAssetAPI{}
for _, asset := range releaseAPI.Assets {
matched, err := d.matchesAssetName(asset.Name)
if err != nil {
return lockConf, fmt.Errorf("Matching asset name '%s': %s", asset.Name, err)
}
if matched {
matchedAssets = append(matchedAssets, asset)
}
}
if len(d.opts.Checksums) > 0 {
fileChecksums = d.opts.Checksums
} else {
if !d.opts.DisableAutoChecksumValidation {
fileChecksums, err = ReleaseNotesChecksums{}.Find(matchedAssets, releaseAPI.Body)
if err != nil {
return lockConf, fmt.Errorf("Finding checksums in release notes: %s", err)
}
}
}
for _, asset := range matchedAssets {
path := filepath.Join(incomingTmpPath, asset.Name)
err = d.downloadFile(asset.URL, path, authToken)
if err != nil {
return lockConf, fmt.Errorf("Downloading asset '%s': %s", asset.Name, err)
}
err = d.checkFileSize(path, asset.Size)
if err != nil {
return lockConf, fmt.Errorf("Checking asset '%s' size: %s", asset.Name, err)
}
if len(fileChecksums) > 0 {
err = d.checkFileChecksum(path, fileChecksums[asset.Name])
if err != nil {
return lockConf, fmt.Errorf("Checking asset '%s' checksum: %s", asset.Name, err)
}
}
}
if d.opts.UnpackArchive != nil {
newIncomingTmpPath, err := tempArea.NewTempDir("github-release-unpack")
if err != nil {
return lockConf, err
}
defer os.RemoveAll(newIncomingTmpPath)
final, err := ctlfetch.NewArchive(filepath.Join(incomingTmpPath, d.opts.UnpackArchive.Path), false, "").Unpack(newIncomingTmpPath)
if err != nil {
return lockConf, fmt.Errorf("Unpacking archive '%s': %s", d.opts.UnpackArchive.Path, err)
}
if !final {
return lockConf, fmt.Errorf("Expected known archive type (zip, tgz, tar)")
}
incomingTmpPath = newIncomingTmpPath
}
err = os.RemoveAll(dstPath)
if err != nil {
return lockConf, fmt.Errorf("Deleting dir %s: %s", dstPath, err)
}
err = os.Rename(incomingTmpPath, dstPath)
if err != nil {
return lockConf, fmt.Errorf("Moving directory '%s' to staging dir: %s", incomingTmpPath, err)
}
lockConf.URL = releaseAPI.URL
return lockConf, nil
}
func (d Sync) matchesAssetName(name string) (bool, error) {
if len(d.opts.AssetNames) == 0 {
return true, nil
}
for _, pattern := range d.opts.AssetNames {
ok, err := doublestar.PathMatch(pattern, name)
if err != nil {
return false, err
}
if ok {
return true, nil
}
}
return false, nil
}
func (d Sync) downloadRelease(authToken string) (ReleaseAPI, error) {
releaseAPI := ReleaseAPI{}
_, url, err := d.DescAndURL()
if err != nil {
return releaseAPI, err
}
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return releaseAPI, err
}
if len(authToken) > 0 {
req.Header.Add("Authorization", "token "+authToken)
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
return releaseAPI, err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
errMsg := fmt.Sprintf("Expected response status 200, but was '%d'", resp.StatusCode)
switch resp.StatusCode {
case 401, 403:
hintMsg := "(hint: consider setting VENDIR_GITHUB_API_TOKEN env variable to increase API rate limits)"
bs, _ := ioutil.ReadAll(resp.Body)
errMsg += fmt.Sprintf(" %s (body: '%s')", hintMsg, bs)
case 404:
hintMsg := "(hint: if you are using 'latest: true', there may not be any non-pre-release releases)"
errMsg += " " + hintMsg
}
return releaseAPI, fmt.Errorf(errMsg)
}
bs, err := ioutil.ReadAll(resp.Body)
if err != nil {
return releaseAPI, err
}
err = json.Unmarshal(bs, &releaseAPI)
if err != nil {
return releaseAPI, err
}
return releaseAPI, nil
}
func (d Sync) downloadFile(url, dstPath, authToken string) error {
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return err
}
// Forces Github to redirect to asset contents
req.Header.Add("Accept", "application/octet-stream")
if len(authToken) > 0 {
req.Header.Add("Authorization", "token "+authToken)
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
errMsg := fmt.Sprintf("Expected response status 200, but was '%d'", resp.StatusCode)
switch resp.StatusCode {
case 401, 403:
bs, _ := ioutil.ReadAll(resp.Body)
errMsg += fmt.Sprintf(" (body: '%s')", bs)
}
return fmt.Errorf(errMsg)
}
out, err := os.Create(dstPath)
if err != nil {
return err
}
defer out.Close()
_, err = io.Copy(out, resp.Body)
return err
}
func (d Sync) checkFileSize(path string, expectedSize int64) error {
fi, err := os.Stat(path)
if err != nil {
return err
}
if fi.Size() != expectedSize {
return fmt.Errorf("Expected file size to be %d, but was %d", expectedSize, fi.Size())
}
return nil
}
func (d Sync) checkFileChecksum(path string, expectedChecksum string) error {
if len(expectedChecksum) == 0 {
panic("Expected non-empty checksum as argument")
}
f, err := os.Open(path)
if err != nil {
return err
}
defer f.Close()
hash := sha256.New()
_, err = io.Copy(hash, f)
if err != nil {
return fmt.Errorf("Calculating checksum: %s", err)
}
actualChecksum := fmt.Sprintf("%x", hash.Sum(nil))
if actualChecksum != expectedChecksum {
return fmt.Errorf("Expected file checksum to be '%s', but was '%s'",
expectedChecksum, actualChecksum)
}
return nil
}
func (d Sync) authToken() (string, error) {
token := ""
if len(d.defaultAPIToken) > 0 {
token = d.defaultAPIToken
}
if d.opts.SecretRef != nil {
secret, err := d.refFetcher.GetSecret(d.opts.SecretRef.Name)
if err != nil {
return "", err
}
for name, val := range secret.Data {
switch name {
case ctlconf.SecretToken:
token = string(val)
default:
return "", fmt.Errorf("Unknown secret field '%s' in secret '%s'", name, secret.Metadata.Name)
}
}
}
return token, nil
}
type ReleaseAPI struct {
URL string `json:"url"`
Body string
Assets []ReleaseAssetAPI
}
type ReleaseAssetAPI struct {
URL string
Name string
Size int64
// This URL does not work for private repo assets
// BrowserDownloadURL string `json:"browser_download_url"`
}
func (a ReleaseAPI) AssetNames() []string {
var result []string
for _, asset := range a.Assets {
result = append(result, asset.Name)
}
return result
}
/*
Example response (not all fields present):
{
"url": "https://api.github.com/repos/jgm/pandoc/releases/22608933",
"id": 22608933,
"node_id": "MDc6UmVsZWFzZTIyNjA4OTMz",
"tag_name": "2.9.1.1",
"target_commitish": "master",
"name": "pandoc 2.9.1.1",
"draft": false,
"assets": [
{
"url": "https://api.github.com/repos/jgm/pandoc/releases/assets/17158996",
"id": 17158996,
"node_id": "MDEyOlJlbGVhc2VBc3NldDE3MTU4OTk2",
"name": "pandoc-2.9.1.1-windows-x86_64.zip",
"label": null,
"content_type": "application/zip",
"state": "uploaded",
"size": 36132549,
"download_count": 9236,
"created_at": "2020-01-06T05:16:32Z",
"updated_at": "2020-01-06T05:23:48Z",
"browser_download_url": "https://github.com/jgm/pandoc/releases/download/2.9.1.1/pandoc-2.9.1.1-windows-x86_64.zip"
}
],
"body": "..."
}
*/