Skip to content

Fix issue in AcceptedError handling for UploadSarif #3047

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

Merged
gmlewis merged 2 commits into from
Jan 10, 2024
Merged

Fix issue in AcceptedError handling for UploadSarif #3047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d205a8b
Fix issue in AcceptedError handling for UploadSarif
Rigdon Jan 10, 2024
cb3be17
Update from linter recommendations
Rigdon Jan 10, 2024
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
18 changes: 15 additions & 3 deletions github/code-scanning.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ package github

import (
"context"
"encoding/json"
"errors"
"fmt"
"strconv"
"strings"
Expand Down Expand Up @@ -389,11 +391,21 @@ func (s *CodeScanningService) UploadSarif(ctx context.Context, owner, repo strin
return nil, nil, err
}

sarifID := new(SarifID)
resp, err := s.client.Do(ctx, req, sarifID)
if err != nil {
// This will always return an error without unmarshalling the data
resp, err := s.client.Do(ctx, req, nil)
// Even though there was an error, we still return the response
// in case the caller wants to inspect it further.
// However, if the error is AcceptedError, decode it below before
// returning from this function and closing the response body.
var acceptedError *AcceptedError
if !errors.As(err, &acceptedError) {
return nil, resp, err
}
sarifID := new(SarifID)
decErr := json.Unmarshal(acceptedError.Raw, sarifID)
if decErr != nil {
return nil, resp, decErr
}

return sarifID, resp, nil
}
Expand Down
14 changes: 12 additions & 2 deletions github/code-scanning_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ func TestCodeScanningService_UploadSarif(t *testing.T) {
client, mux, _, teardown := setup()
defer teardown()

expectedSarifID := &SarifID{
ID: String("testid"),
URL: String("https://example.com/testurl"),
}

mux.HandleFunc("/repos/o/r/code-scanning/sarifs", func(w http.ResponseWriter, r *http.Request) {
v := new(SarifAnalysis)
assertNilError(t, json.NewDecoder(r.Body).Decode(v))
Expand All @@ -67,15 +72,20 @@ func TestCodeScanningService_UploadSarif(t *testing.T) {
t.Errorf("Request body = %+v, want %+v", v, want)
}

fmt.Fprint(w, `{"commit_sha":"abc","ref":"ref/head/main","sarif":"abc"}`)
w.WriteHeader(http.StatusAccepted)
respBody, _ := json.Marshal(expectedSarifID)
_, _ = w.Write(respBody)
})

ctx := context.Background()
sarifAnalysis := &SarifAnalysis{CommitSHA: String("abc"), Ref: String("ref/head/main"), Sarif: String("abc"), CheckoutURI: String("uri"), StartedAt: &Timestamp{time.Date(2006, time.January, 02, 15, 04, 05, 0, time.UTC)}, ToolName: String("codeql-cli")}
_, _, err := client.CodeScanning.UploadSarif(ctx, "o", "r", sarifAnalysis)
respSarifID, _, err := client.CodeScanning.UploadSarif(ctx, "o", "r", sarifAnalysis)
if err != nil {
t.Errorf("CodeScanning.UploadSarif returned error: %v", err)
}
if !cmp.Equal(expectedSarifID, respSarifID) {
t.Errorf("Sarif response = %+v, want %+v", respSarifID, expectedSarifID)
}

const methodName = "UploadSarif"
testBadOptions(t, methodName, func() (err error) {
Expand Down