/
git.go
334 lines (283 loc) · 8.01 KB
/
git.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
// Copyright 2018 jsonnet-bundler authors
//
// 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 pkg
import (
"archive/tar"
"bytes"
"compress/gzip"
"context"
"crypto/sha256"
"encoding/hex"
"fmt"
"io"
"net/http"
"os"
"os/exec"
"path"
"path/filepath"
"regexp"
"strings"
"github.com/fatih/color"
"github.com/pkg/errors"
"github.com/dadav/jsonnet-bundler-ng/spec/v1/deps"
)
type GitPackage struct {
Source *deps.Git
}
func NewGitPackage(source *deps.Git) Interface {
return &GitPackage{
Source: source,
}
}
var GitQuiet = false
func downloadGitHubArchive(filepath string, url string) error {
// Get the data
resp, err := http.Get(url)
if err != nil {
return err
}
if !GitQuiet {
color.Cyan("GET %s %d", url, resp.StatusCode)
}
if resp.StatusCode != 200 {
return fmt.Errorf("unexpected status code %d", resp.StatusCode)
}
defer resp.Body.Close()
// Create the file
out, err := os.Create(filepath)
if err != nil {
return err
}
defer out.Close()
// Write the body to file
_, err = io.Copy(out, resp.Body)
if err != nil {
return err
}
return nil
}
func gzipUntar(dst string, r io.Reader, subDir string) error {
gzr, err := gzip.NewReader(r)
if err != nil {
return err
}
defer gzr.Close()
tr := tar.NewReader(gzr)
for {
header, err := tr.Next()
switch {
case err == io.EOF:
return nil
case err != nil:
return err
case header == nil:
continue
}
// strip the two first components of the path
parts := strings.SplitAfterN(header.Name, "/", 2)
if len(parts) < 2 {
continue
}
suffix := parts[1]
prefix := dst
// reconstruct the target parh for the archive entry
target := filepath.Join(prefix, suffix)
// if subdir is provided and target is not under it, skip it
subDirPath := filepath.Join(prefix, subDir)
if subDir != "" && !strings.HasPrefix(target, subDirPath) {
continue
}
// check the file type
switch header.Typeflag {
// create directories as needed
case tar.TypeDir:
if err := os.MkdirAll(target, os.FileMode(header.Mode)); err != nil {
return err
}
case tar.TypeReg:
if err := os.MkdirAll(filepath.Dir(target), os.ModePerm); err != nil {
return err
}
err := func() error {
f, err := os.OpenFile(target, os.O_CREATE|os.O_RDWR, os.FileMode(header.Mode))
if err != nil {
return err
}
defer f.Close()
// copy over contents
if _, err := io.Copy(f, tr); err != nil {
return err
}
return nil
}()
if err != nil {
return err
}
case tar.TypeSymlink:
if err := os.MkdirAll(filepath.Dir(target), os.ModePerm); err != nil {
return err
}
if err := os.Symlink(header.Linkname, target); err != nil {
return err
}
}
}
}
func remoteResolveRef(ctx context.Context, remote string, ref string) (string, error) {
b := &bytes.Buffer{}
cmd := exec.CommandContext(ctx, "git", "ls-remote", "--heads", "--tags", "--refs", "--quiet", remote, ref)
cmd.Stdin = os.Stdin
cmd.Stdout = b
cmd.Stderr = os.Stderr
err := cmd.Run()
if err != nil {
return "", err
}
commitShaPattern := regexp.MustCompile(`^([0-9a-f]{40,})\b`)
commitSha := commitShaPattern.FindString(b.String())
return commitSha, nil
}
func (p *GitPackage) Install(ctx context.Context, name, dir, version string) (string, error) {
destPath := path.Join(dir, name)
pkgh := sha256.Sum256([]byte(fmt.Sprintf("jsonnetpkg-%s-%s", strings.ReplaceAll(name, "/", "-"), strings.ReplaceAll(version, "/", "-"))))
// using 16 bytes should be a good middle ground between length and collision resistance
tmpDir, err := os.MkdirTemp(filepath.Join(dir, ".tmp"), hex.EncodeToString(pkgh[:16]))
if err != nil {
return "", errors.Wrap(err, "failed to create tmp dir")
}
defer os.RemoveAll(tmpDir)
// Optimization for GitHub sources: download a tarball archive of the requested
// version instead of cloning the entire
isGitHubRemote, _ := regexp.MatchString(`^(https|ssh)://github\.com/.+$`, p.Source.Remote())
if isGitHubRemote {
// Let git ls-remote decide if "version" is a ref or a commit SHA in the unlikely
// but possible event that a ref is comprised of 40 or more hex characters
commitSha, _ := remoteResolveRef(ctx, p.Source.Remote(), version)
// If the ref resolution failed and "version" looks like a SHA,
// assume it is one and proceed.
commitShaPattern := regexp.MustCompile("^([0-9a-f]{40,})$")
if commitSha == "" && commitShaPattern.MatchString(version) {
commitSha = version
}
archiveUrl := fmt.Sprintf("%s/archive/%s.tar.gz", strings.TrimSuffix(p.Source.Remote(), ".git"), commitSha)
archiveFilepath := fmt.Sprintf("%s.tar.gz", tmpDir)
defer os.Remove(archiveFilepath)
err = downloadGitHubArchive(archiveFilepath, archiveUrl)
if err == nil {
var ar *os.File
ar, err = os.Open(archiveFilepath)
if err == nil {
defer ar.Close()
// Extract the sub-directory (if any) from the archive
// If none specified, the entire archive is unpacked
err = gzipUntar(tmpDir, ar, p.Source.Subdir)
// Move the extracted directory to its final destination
if err == nil {
if err := os.MkdirAll(filepath.Dir(destPath), os.ModePerm); err != nil {
panic(err)
}
if err := os.Rename(path.Join(tmpDir, p.Source.Subdir), destPath); err != nil {
panic(err)
}
}
}
}
if err == nil {
return commitSha, nil
}
// The repository may be private or the archive download may not work
// for other reasons. In any case, fall back to the slower git-based installation.
color.Yellow("archive install failed: %s", err)
color.Yellow("retrying with git...")
}
gitCmd := func(args ...string) *exec.Cmd {
cmd := exec.CommandContext(ctx, "git", args...)
cmd.Stdin = os.Stdin
if GitQuiet {
cmd.Stdout = nil
cmd.Stderr = nil
} else {
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
}
cmd.Dir = tmpDir
return cmd
}
cmd := gitCmd("init")
err = cmd.Run()
if err != nil {
return "", err
}
cmd = gitCmd("remote", "add", "origin", p.Source.Remote())
err = cmd.Run()
if err != nil {
return "", err
}
// Attempt shallow fetch at specific revision
cmd = gitCmd("fetch", "--tags", "--depth", "1", "origin", version)
err = cmd.Run()
if err != nil {
// Fall back to normal fetch (all revisions)
cmd = gitCmd("fetch", "origin")
err = cmd.Run()
if err != nil {
return "", err
}
}
// Sparse checkout optimization: if a Subdir is specified,
// there is no need to do a full checkout
if p.Source.Subdir != "" {
cmd = gitCmd("config", "core.sparsecheckout", "true")
err = cmd.Run()
if err != nil {
return "", err
}
glob := []byte(p.Source.Subdir + "/*\n")
err = os.WriteFile(filepath.Join(tmpDir, ".git", "info", "sparse-checkout"), glob, 0644)
if err != nil {
return "", err
}
}
cmd = gitCmd("-c", "advice.detachedHead=false", "checkout", version)
err = cmd.Run()
if err != nil {
return "", err
}
b := bytes.NewBuffer(nil)
cmd = exec.CommandContext(ctx, "git", "rev-parse", "HEAD")
cmd.Stdout = b
cmd.Dir = tmpDir
err = cmd.Run()
if err != nil {
return "", err
}
commitHash := strings.TrimSpace(b.String())
err = os.RemoveAll(path.Join(tmpDir, ".git"))
if err != nil {
return "", err
}
err = os.MkdirAll(path.Dir(destPath), os.ModePerm)
if err != nil {
return "", errors.Wrap(err, "failed to create parent path")
}
err = os.RemoveAll(destPath)
if err != nil {
return "", errors.Wrap(err, "failed to clean previous destination path")
}
err = os.Rename(path.Join(tmpDir, p.Source.Subdir), destPath)
if err != nil {
return "", errors.Wrap(err, "failed to move package")
}
return commitHash, nil
}