Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

behaviour: fix downloading assets with redirects #98

Merged
merged 3 commits into from
May 28, 2020
Merged

behaviour: fix downloading assets with redirects #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bfdc4c3
behaviour: use oauth http client to download redirect
aoldershaw May 17, 2020
e4b658c
behaviour: download asset on redirect
aoldershaw May 17, 2020
300491f
behaviour: don't pass Authorization header on redirect
aoldershaw May 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package resource

import (
"context"
"crypto/tls"
"errors"
"fmt"
Expand All @@ -11,8 +12,6 @@ import (

"golang.org/x/oauth2"

"context"

"github.com/google/go-github/github"
)

Expand All @@ -37,10 +36,11 @@ type GitHub interface {
}

type GitHubClient struct {
client *github.Client
client *github.Client

owner string
repository string
owner string
repository string
accessToken string
}

func NewGitHubClient(source Source) (*GitHubClient, error) {
Expand Down Expand Up @@ -92,9 +92,10 @@ func NewGitHubClient(source Source) (*GitHubClient, error) {
}

return &GitHubClient{
client: client,
owner: owner,
repository: source.Repository,
client: client,
owner: owner,
repository: source.Repository,
accessToken: source.AccessToken,
}, nil
}

Expand Down Expand Up @@ -232,12 +233,23 @@ func (g *GitHubClient) DownloadReleaseAsset(asset github.ReleaseAsset) (io.ReadC
return bodyReader, err
}

resp, err := http.Get(redirectURL)
req, err := g.client.NewRequest("GET", redirectURL, nil)
if err != nil {
return nil, err
}
req.Header.Set("Accept", "application/octet-stream")
if g.accessToken != "" && req.URL.Host == g.client.BaseURL.Host {
req.Header.Set("Authorization", "Bearer " + g.accessToken)
}

httpClient := &http.Client{}
resp, err := httpClient.Do(req)
if err != nil {
return nil, err
}

if resp.StatusCode < 200 || resp.StatusCode > 299 {
resp.Body.Close()
return nil, fmt.Errorf("redirect URL %q responded with bad status code: %d", redirectURL, resp.StatusCode)
}

Expand Down
106 changes: 80 additions & 26 deletions github_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,28 +368,40 @@ var _ = Describe("GitHub Client", func() {
BeforeEach(func() {
source.Owner = owner
source.Repository = repo
source.AccessToken = "abc123"
assetID = 42
asset = github.ReleaseAsset{ID: &assetID}
assetPath = fmt.Sprintf("/repos/%s/%s/releases/assets/%d", owner, repo, assetID)
})

var appendGetHandler = func(server *ghttp.Server, path string, statusCode int, body string, headers ...http.Header) {
server.AppendHandlers(
ghttp.CombineHandlers(
ghttp.VerifyRequest("GET", path),
var appendGetHandler = func(server *ghttp.Server, path string, statusCode int, body string, usesAuth bool, headers ...http.Header) {
var authHeaderValue []string
if usesAuth {
authHeaderValue = []string{"Bearer abc123"}
}
server.AppendHandlers(ghttp.CombineHandlers(
ghttp.VerifyRequest("GET", fmt.Sprintf("%s", path)),
ghttp.RespondWith(statusCode, body, headers...),
),
)
ghttp.VerifyHeaderKV("Accept", "application/octet-stream"),
ghttp.VerifyHeaderKV("Authorization", authHeaderValue...),
))
}

var locationHeader = func(url string) http.Header {
header := make(http.Header)
header.Add("Location", url)
return header
}


Context("when the asset can be downloaded directly", func() {
Context("when the asset is downloaded successfully", func() {
const (
fileContents = "some-random-contents-from-github"
)

BeforeEach(func() {
appendGetHandler(server, assetPath, 200, fileContents)
appendGetHandler(server, assetPath, 200, fileContents, true)
})

It("returns the correct body", func() {
Expand All @@ -405,7 +417,7 @@ var _ = Describe("GitHub Client", func() {

Context("when there is an error downloading the asset", func() {
BeforeEach(func() {
appendGetHandler(server, assetPath, 401, "authorized personnel only")
appendGetHandler(server, assetPath, 401, "authorized personnel only", true)
})

It("returns an error", func() {
Expand All @@ -416,18 +428,10 @@ var _ = Describe("GitHub Client", func() {
})

Context("when the asset is behind a redirect", func() {
const (
redirectPath = "/the/redirect/path"
)

var locationHeader = func(url string) http.Header {
header := make(http.Header)
header.Add("Location", url)
return header
}
const redirectPath = "/the/redirect/path"

BeforeEach(func() {
appendGetHandler(server, assetPath, 307, "", locationHeader(redirectPath))
appendGetHandler(server, assetPath, 307, "", true, locationHeader(redirectPath))
})

Context("when the redirect succeeds", func() {
Expand All @@ -436,7 +440,7 @@ var _ = Describe("GitHub Client", func() {
)

BeforeEach(func() {
appendGetHandler(server, redirectPath, 200, redirectFileContents)
appendGetHandler(server, redirectPath, 200, redirectFileContents, true)
})

It("returns the body from the redirect request", func() {
Expand All @@ -457,8 +461,8 @@ var _ = Describe("GitHub Client", func() {
)

BeforeEach(func() {
appendGetHandler(server, redirectPath, 307, "", locationHeader("/somewhere-else"))
appendGetHandler(server, "/somewhere-else", 200, redirectFileContents)
appendGetHandler(server, redirectPath, 307, "", true, locationHeader("/somewhere-else"))
appendGetHandler(server, "/somewhere-else", 200, redirectFileContents, true)
})

It("returns the body from the final redirect request", func() {
Expand All @@ -472,9 +476,34 @@ var _ = Describe("GitHub Client", func() {
})
})

Context("when there is another redirect to an external server", func() {
const (
redirectFileContents = "some-random-contents-from-redirect"
)

var externalServer *ghttp.Server

BeforeEach(func() {
externalServer = ghttp.NewServer()

appendGetHandler(server, redirectPath, 307, "", true, locationHeader(externalServer.URL() + "/somewhere-else"))
appendGetHandler(externalServer, "/somewhere-else", 200, redirectFileContents, false)
})

It("downloads the file without the Authorization header", func() {
readCloser, err := client.DownloadReleaseAsset(asset)
Expect(err).NotTo(HaveOccurred())
defer readCloser.Close()

body, err := ioutil.ReadAll(readCloser)
Expect(err).NotTo(HaveOccurred())
Expect(string(body)).To(Equal(redirectFileContents))
})
})

Context("when the redirect request response is a 400", func() {
BeforeEach(func() {
appendGetHandler(server, redirectPath, 400, "oops")
appendGetHandler(server, redirectPath, 400, "oops", true)
})

It("returns an error", func() {
Expand All @@ -485,7 +514,7 @@ var _ = Describe("GitHub Client", func() {

Context("when the redirect request response is a 401", func() {
BeforeEach(func() {
appendGetHandler(server, redirectPath, 401, "authorized personnel only")
appendGetHandler(server, redirectPath, 401, "authorized personnel only", true)
})

It("returns an error", func() {
Expand All @@ -497,7 +526,7 @@ var _ = Describe("GitHub Client", func() {
Context("when the redirect request response is a 403", func() {

BeforeEach(func() {
appendGetHandler(server, redirectPath, 403, "authorized personnel only")
appendGetHandler(server, redirectPath, 403, "authorized personnel only", true)
})

It("returns an error", func() {
Expand All @@ -508,7 +537,7 @@ var _ = Describe("GitHub Client", func() {

Context("when the redirect request response is a 404", func() {
BeforeEach(func() {
appendGetHandler(server, redirectPath, 404, "I don't know her")
appendGetHandler(server, redirectPath, 404, "I don't know her", true)
})

It("returns an error", func() {
Expand All @@ -519,7 +548,7 @@ var _ = Describe("GitHub Client", func() {

Context("when the redirect request response is a 500", func() {
BeforeEach(func() {
appendGetHandler(server, redirectPath, 500, "boom")
appendGetHandler(server, redirectPath, 500, "boom", true)
})

It("returns an error", func() {
Expand All @@ -528,5 +557,30 @@ var _ = Describe("GitHub Client", func() {
})
})
})

Context("when the asset is behind a redirect on an external server", func() {
const (
redirectFileContents = "some-random-contents-from-redirect"
)

var externalServer *ghttp.Server

BeforeEach(func() {
externalServer = ghttp.NewServer()

appendGetHandler(server, assetPath, 307, "", true, locationHeader(externalServer.URL() + "/somewhere-else"))
appendGetHandler(externalServer, "/somewhere-else", 200, redirectFileContents, false)
})

It("downloads the file without the Authorization header", func() {
readCloser, err := client.DownloadReleaseAsset(asset)
Expect(err).NotTo(HaveOccurred())
defer readCloser.Close()

body, err := ioutil.ReadAll(readCloser)
Expect(err).NotTo(HaveOccurred())
Expect(string(body)).To(Equal(redirectFileContents))
})
})
})
})