X Tutup
Skip to content

Commit 8058c4e

Browse files
lpessoamislav
lpessoa
and
mislav
committed
Adding gh release download for .zip and .tar.gz
Co-authored-by: Mislav Marohnić <mislav@github.com>
1 parent c987c57 commit 8058c4e

File tree

3 files changed

+170
-16
lines changed

3 files changed

+170
-16
lines changed

‎pkg/cmd/release/download/download.go‎

Lines changed: 76 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ package download
22

33
import (
44
"errors"
5+
"fmt"
56
"io"
7+
"mime"
68
"net/http"
79
"os"
810
"path/filepath"
@@ -27,6 +29,8 @@ type DownloadOptions struct {
2729

2830
// maximum number of simultaneous downloads
2931
Concurrency int
32+
33+
ArchiveType string
3034
}
3135

3236
func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobra.Command {
@@ -47,12 +51,15 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr
4751
Example: heredoc.Doc(`
4852
# download all assets from a specific release
4953
$ gh release download v1.2.3
50-
54+
5155
# download only Debian packages for the latest release
5256
$ gh release download --pattern '*.deb'
53-
57+
5458
# specify multiple file patterns
5559
$ gh release download -p '*.deb' -p '*.rpm'
60+
61+
# download the archive of the source code for a release
62+
$ gh release download v1.2.3 --archive=zip
5663
`),
5764
Args: cobra.MaximumNArgs(1),
5865
RunE: func(cmd *cobra.Command, args []string) error {
@@ -67,6 +74,11 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr
6774
opts.TagName = args[0]
6875
}
6976

77+
// check archive type option validity
78+
if err := checkArchiveTypeOption(opts); err != nil {
79+
return err
80+
}
81+
7082
opts.Concurrency = 5
7183

7284
if runF != nil {
@@ -78,10 +90,30 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr
7890

7991
cmd.Flags().StringVarP(&opts.Destination, "dir", "D", ".", "The directory to download files into")
8092
cmd.Flags().StringArrayVarP(&opts.FilePatterns, "pattern", "p", nil, "Download only assets that match a glob pattern")
93+
cmd.Flags().StringVarP(&opts.ArchiveType, "archive", "A", "", "Download the source code archive in the specified `format` (zip or tar.gz)")
8194

8295
return cmd
8396
}
8497

98+
func checkArchiveTypeOption(opts *DownloadOptions) error {
99+
if len(opts.ArchiveType) == 0 {
100+
return nil
101+
}
102+
103+
if err := cmdutil.MutuallyExclusive(
104+
"specify only one of '--pattern' or '--archive'",
105+
true, // ArchiveType len > 0
106+
len(opts.FilePatterns) > 0,
107+
); err != nil {
108+
return err
109+
}
110+
111+
if opts.ArchiveType != "zip" && opts.ArchiveType != "tar.gz" {
112+
return cmdutil.FlagErrorf("the value for `--archive` must be one of \"zip\" or \"tar.gz\"")
113+
}
114+
return nil
115+
}
116+
85117
func downloadRun(opts *DownloadOptions) error {
86118
httpClient, err := opts.HttpClient()
87119
if err != nil {
@@ -93,8 +125,10 @@ func downloadRun(opts *DownloadOptions) error {
93125
return err
94126
}
95127

96-
var release *shared.Release
128+
opts.IO.StartProgressIndicator()
129+
defer opts.IO.StopProgressIndicator()
97130

131+
var release *shared.Release
98132
if opts.TagName == "" {
99133
release, err = shared.FetchLatestRelease(httpClient, baseRepo)
100134
if err != nil {
@@ -108,11 +142,22 @@ func downloadRun(opts *DownloadOptions) error {
108142
}
109143

110144
var toDownload []shared.ReleaseAsset
111-
for _, a := range release.Assets {
112-
if len(opts.FilePatterns) > 0 && !matchAny(opts.FilePatterns, a.Name) {
113-
continue
145+
isArchive := false
146+
if opts.ArchiveType != "" {
147+
var archiveURL = release.ZipballURL
148+
if opts.ArchiveType == "tar.gz" {
149+
archiveURL = release.TarballURL
150+
}
151+
// create pseudo-Asset with no name and pointing to ZipBallURL or TarBallURL
152+
toDownload = append(toDownload, shared.ReleaseAsset{APIURL: archiveURL})
153+
isArchive = true
154+
} else {
155+
for _, a := range release.Assets {
156+
if len(opts.FilePatterns) > 0 && !matchAny(opts.FilePatterns, a.Name) {
157+
continue
158+
}
159+
toDownload = append(toDownload, a)
114160
}
115-
toDownload = append(toDownload, a)
116161
}
117162

118163
if len(toDownload) == 0 {
@@ -129,10 +174,7 @@ func downloadRun(opts *DownloadOptions) error {
129174
}
130175
}
131176

132-
opts.IO.StartProgressIndicator()
133-
err = downloadAssets(httpClient, toDownload, opts.Destination, opts.Concurrency)
134-
opts.IO.StopProgressIndicator()
135-
return err
177+
return downloadAssets(httpClient, toDownload, opts.Destination, opts.Concurrency, isArchive)
136178
}
137179

138180
func matchAny(patterns []string, name string) bool {
@@ -144,7 +186,7 @@ func matchAny(patterns []string, name string) bool {
144186
return false
145187
}
146188

147-
func downloadAssets(httpClient *http.Client, toDownload []shared.ReleaseAsset, destDir string, numWorkers int) error {
189+
func downloadAssets(httpClient *http.Client, toDownload []shared.ReleaseAsset, destDir string, numWorkers int, isArchive bool) error {
148190
if numWorkers == 0 {
149191
return errors.New("the number of concurrent workers needs to be greater than 0")
150192
}
@@ -159,7 +201,7 @@ func downloadAssets(httpClient *http.Client, toDownload []shared.ReleaseAsset, d
159201
for w := 1; w <= numWorkers; w++ {
160202
go func() {
161203
for a := range jobs {
162-
results <- downloadAsset(httpClient, a.APIURL, filepath.Join(destDir, a.Name))
204+
results <- downloadAsset(httpClient, a.APIURL, destDir, a.Name, isArchive)
163205
}
164206
}()
165207
}
@@ -179,13 +221,17 @@ func downloadAssets(httpClient *http.Client, toDownload []shared.ReleaseAsset, d
179221
return downloadError
180222
}
181223

182-
func downloadAsset(httpClient *http.Client, assetURL, destinationPath string) error {
224+
func downloadAsset(httpClient *http.Client, assetURL, destinationDir string, fileName string, isArchive bool) error {
183225
req, err := http.NewRequest("GET", assetURL, nil)
184226
if err != nil {
185227
return err
186228
}
187229

188230
req.Header.Set("Accept", "application/octet-stream")
231+
// adding application/json to Accept header due to a bug in the zipball/tarball API endpoint that makes it mandatory
232+
if isArchive {
233+
req.Header.Set("Accept", "application/octet-stream, application/json")
234+
}
189235

190236
resp, err := httpClient.Do(req)
191237
if err != nil {
@@ -197,6 +243,22 @@ func downloadAsset(httpClient *http.Client, assetURL, destinationPath string) er
197243
return api.HandleHTTPError(resp)
198244
}
199245

246+
var destinationPath = filepath.Join(destinationDir, fileName)
247+
248+
if len(fileName) == 0 {
249+
contentDisposition := resp.Header.Get("Content-Disposition")
250+
251+
_, params, err := mime.ParseMediaType(contentDisposition)
252+
if err != nil {
253+
return fmt.Errorf("unable to parse file name of archive: %w", err)
254+
}
255+
if serverFileName, ok := params["filename"]; ok {
256+
destinationPath = filepath.Join(destinationDir, serverFileName)
257+
} else {
258+
return errors.New("unable to determine file name of archive")
259+
}
260+
}
261+
200262
f, err := os.OpenFile(destinationPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0644)
201263
if err != nil {
202264
return err

‎pkg/cmd/release/download/download_test.go‎

Lines changed: 83 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,36 @@ func Test_NewCmdDownload(t *testing.T) {
8080
Concurrency: 5,
8181
},
8282
},
83+
{
84+
name: "download archive with valid option",
85+
args: "v1.2.3 -A zip",
86+
isTTY: true,
87+
want: DownloadOptions{
88+
TagName: "v1.2.3",
89+
FilePatterns: []string(nil),
90+
Destination: ".",
91+
ArchiveType: "zip",
92+
Concurrency: 5,
93+
},
94+
},
8395
{
8496
name: "no arguments",
8597
args: "",
8698
isTTY: true,
8799
wantErr: "the '--pattern' flag is required when downloading the latest release",
88100
},
101+
{
102+
name: "simultaneous pattern and archive arguments",
103+
args: "-p * -A zip",
104+
isTTY: true,
105+
wantErr: "specify only one of '--pattern' or '--archive'",
106+
},
107+
{
108+
name: "invalid archive argument",
109+
args: "v1.2.3 -A abc",
110+
isTTY: true,
111+
wantErr: "the value for `--archive` must be one of \"zip\" or \"tar.gz\"",
112+
},
89113
}
90114
for _, tt := range tests {
91115
t.Run(tt.name, func(t *testing.T) {
@@ -184,6 +208,36 @@ func Test_downloadRun(t *testing.T) {
184208
wantStderr: ``,
185209
wantErr: "no assets match the file pattern",
186210
},
211+
{
212+
name: "download archive in zip format into destination directory",
213+
isTTY: true,
214+
opts: DownloadOptions{
215+
TagName: "v1.2.3",
216+
ArchiveType: "zip",
217+
Destination: "tmp/packages",
218+
Concurrency: 2,
219+
},
220+
wantStdout: ``,
221+
wantStderr: ``,
222+
wantFiles: []string{
223+
"tmp/packages/zipball.zip",
224+
},
225+
},
226+
{
227+
name: "download archive in `tar.gz` format into destination directory",
228+
isTTY: true,
229+
opts: DownloadOptions{
230+
TagName: "v1.2.3",
231+
ArchiveType: "tar.gz",
232+
Destination: "tmp/packages",
233+
Concurrency: 2,
234+
},
235+
wantStdout: ``,
236+
wantStderr: ``,
237+
wantFiles: []string{
238+
"tmp/packages/tarball.tgz",
239+
},
240+
},
187241
}
188242
for _, tt := range tests {
189243
t.Run(tt.name, func(t *testing.T) {
@@ -204,12 +258,34 @@ func Test_downloadRun(t *testing.T) {
204258
"url": "https://api.github.com/assets/3456" },
205259
{ "name": "linux.tgz", "size": 56,
206260
"url": "https://api.github.com/assets/5678" }
207-
]
261+
],
262+
"tarball_url": "https://api.github.com/repos/OWNER/REPO/tarball/v1.2.3",
263+
"zipball_url": "https://api.github.com/repos/OWNER/REPO/zipball/v1.2.3"
208264
}`))
209265
fakeHTTP.Register(httpmock.REST("GET", "assets/1234"), httpmock.StringResponse(`1234`))
210266
fakeHTTP.Register(httpmock.REST("GET", "assets/3456"), httpmock.StringResponse(`3456`))
211267
fakeHTTP.Register(httpmock.REST("GET", "assets/5678"), httpmock.StringResponse(`5678`))
212268

269+
fakeHTTP.Register(
270+
httpmock.REST(
271+
"GET",
272+
"repos/OWNER/REPO/tarball/v1.2.3",
273+
),
274+
httpmock.WithHeader(
275+
httpmock.StringResponse("somedata"), "content-disposition", "attachment; filename=tarball.tgz",
276+
),
277+
)
278+
279+
fakeHTTP.Register(
280+
httpmock.REST(
281+
"GET",
282+
"repos/OWNER/REPO/zipball/v1.2.3",
283+
),
284+
httpmock.WithHeader(
285+
httpmock.StringResponse("somedata"), "content-disposition", "attachment; filename=zipball.zip",
286+
),
287+
)
288+
213289
tt.opts.IO = io
214290
tt.opts.HttpClient = func() (*http.Client, error) {
215291
return &http.Client{Transport: fakeHTTP}, nil
@@ -226,7 +302,12 @@ func Test_downloadRun(t *testing.T) {
226302
require.NoError(t, err)
227303
}
228304

229-
assert.Equal(t, "application/octet-stream", fakeHTTP.Requests[1].Header.Get("Accept"))
305+
var expectedAcceptHeader = "application/octet-stream"
306+
if len(tt.opts.ArchiveType) > 0 {
307+
expectedAcceptHeader = "application/octet-stream, application/json"
308+
}
309+
310+
assert.Equal(t, expectedAcceptHeader, fakeHTTP.Requests[1].Header.Get("Accept"))
230311

231312
assert.Equal(t, tt.wantStdout, stdout.String())
232313
assert.Equal(t, tt.wantStderr, stderr.String())

‎pkg/httpmock/stub.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,17 @@ func StringResponse(body string) Responder {
7777
}
7878
}
7979

80+
func WithHeader(responder Responder, header string, value string) Responder {
81+
return func(req *http.Request) (*http.Response, error) {
82+
resp, _ := responder(req)
83+
if resp.Header == nil {
84+
resp.Header = make(http.Header)
85+
}
86+
resp.Header.Set(header, value)
87+
return resp, nil
88+
}
89+
}
90+
8091
func StatusStringResponse(status int, body string) Responder {
8192
return func(req *http.Request) (*http.Response, error) {
8293
return httpResponse(status, req, bytes.NewBufferString(body)), nil

0 commit comments

Comments
 (0)
X Tutup