-
Notifications
You must be signed in to change notification settings - Fork 2.1k
feat: add GetCodeownersErrors to RepositoriesService (#2405) #2408
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.
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
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
10e4d1d
feat: add GetCodeownersErrors to RepositoriesService
cbrgm 9185955
fix: generate github-accessors
cbrgm 3e5e5f8
fix: make goimports linter happy and sort imports
cbrgm 595a023
docs: add copyright headers
cbrgm e578227
refactor: use values instead of pointers
cbrgm 0d5cc3a
refactor: re-generate github-accessors
cbrgm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
// Copyright 2022 The go-github AUTHORS. All rights reserved. | ||
// | ||
// Use of this source code is governed by a BSD-style | ||
// license that can be found in the LICENSE file. | ||
|
||
package github | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
) | ||
|
||
// CodeownersErrors represents a list of syntax errors detected in the CODEOWNERS file. | ||
type CodeownersErrors struct { | ||
Errors []*CodeownersError `json:"errors"` | ||
} | ||
|
||
// CodeownersError represents a syntax error detected in the CODEOWNERS file. | ||
type CodeownersError struct { | ||
cbrgm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Line int `json:"line"` | ||
Column int `json:"column"` | ||
Kind string `json:"kind"` | ||
Source string `json:"source"` | ||
Suggestion *string `json:"suggestion,omitempty"` | ||
Message string `json:"message"` | ||
Path string `json:"path"` | ||
} | ||
|
||
// GetCodeownersErrors lists any syntax errors that are detected in the CODEOWNERS file. | ||
// | ||
// GitHub API docs: https://docs.github.com/en/rest/repos/repos#list-codeowners-errors | ||
func (s *RepositoriesService) GetCodeownersErrors(ctx context.Context, owner, repo string) (*CodeownersErrors, *Response, error) { | ||
u := fmt.Sprintf("repos/%v/%v/codeowners/errors", owner, repo) | ||
req, err := s.client.NewRequest("GET", u, nil) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
|
||
codeownersErrors := &CodeownersErrors{} | ||
resp, err := s.client.Do(ctx, req, codeownersErrors) | ||
if err != nil { | ||
return nil, resp, err | ||
} | ||
|
||
return codeownersErrors, resp, nil | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
// Copyright 2022 The go-github AUTHORS. All rights reserved. | ||
// | ||
// Use of this source code is governed by a BSD-style | ||
// license that can be found in the LICENSE file. | ||
|
||
package github | ||
cbrgm marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"net/http" | ||
"testing" | ||
|
||
"github.com/google/go-cmp/cmp" | ||
) | ||
|
||
func TestRepositoriesService_GetCodeownersErrors(t *testing.T) { | ||
client, mux, _, teardown := setup() | ||
defer teardown() | ||
|
||
mux.HandleFunc("/repos/o/r/codeowners/errors", func(w http.ResponseWriter, r *http.Request) { | ||
testMethod(t, r, "GET") | ||
testHeader(t, r, "Accept", mediaTypeV3) | ||
fmt.Fprint(w, `{ | ||
"errors": [ | ||
{ | ||
"line": 1, | ||
"column": 1, | ||
"kind": "Invalid pattern", | ||
"source": "***/*.rb @monalisa", | ||
"suggestion": "Did you mean **/*.rb?", | ||
"message": "Invalid pattern on line 3: Did you mean **/*.rb?\n\n ***/*.rb @monalisa\n ^", | ||
"path": ".github/CODEOWNERS" | ||
} | ||
] | ||
} | ||
`) | ||
}) | ||
|
||
ctx := context.Background() | ||
codeownersErrors, _, err := client.Repositories.GetCodeownersErrors(ctx, "o", "r") | ||
if err != nil { | ||
t.Errorf("Repositories.GetCodeownersErrors returned error: %v", err) | ||
} | ||
|
||
want := &CodeownersErrors{ | ||
Errors: []*CodeownersError{ | ||
{ | ||
Line: 1, | ||
Column: 1, | ||
Kind: "Invalid pattern", | ||
Source: "***/*.rb @monalisa", | ||
Suggestion: String("Did you mean **/*.rb?"), | ||
Message: "Invalid pattern on line 3: Did you mean **/*.rb?\n\n ***/*.rb @monalisa\n ^", | ||
Path: ".github/CODEOWNERS", | ||
}, | ||
}, | ||
} | ||
if !cmp.Equal(codeownersErrors, want) { | ||
t.Errorf("Repositories.GetCodeownersErrors returned %+v, want %+v", codeownersErrors, want) | ||
} | ||
|
||
const methodName = "GetCodeownersErrors" | ||
testBadOptions(t, methodName, func() (err error) { | ||
_, _, err = client.Repositories.GetCodeownersErrors(ctx, "\n", "\n") | ||
return err | ||
}) | ||
|
||
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
got, resp, err := client.Repositories.GetCodeownersErrors(ctx, "o", "r") | ||
if got != nil { | ||
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) | ||
} | ||
return resp, err | ||
}) | ||
} | ||
|
||
func TestCodeownersErrors_Marshal(t *testing.T) { | ||
testJSONMarshal(t, &CodeownersErrors{}, "{}") | ||
|
||
u := &CodeownersErrors{ | ||
Errors: []*CodeownersError{ | ||
{ | ||
Line: 1, | ||
Column: 1, | ||
Kind: "Invalid pattern", | ||
Source: "***/*.rb @monalisa", | ||
Suggestion: String("Did you mean **/*.rb?"), | ||
Message: "Invalid pattern on line 3: Did you mean **/*.rb?\n\n ***/*.rb @monalisa\n ^", | ||
Path: ".github/CODEOWNERS", | ||
}, | ||
}, | ||
} | ||
|
||
want := `{ | ||
"errors": [ | ||
{ | ||
"line": 1, | ||
"column": 1, | ||
"kind": "Invalid pattern", | ||
"source": "***/*.rb @monalisa", | ||
"suggestion": "Did you mean **/*.rb?", | ||
"message": "Invalid pattern on line 3: Did you mean **/*.rb?\n\n ***/*.rb @monalisa\n ^", | ||
"path": ".github/CODEOWNERS" | ||
} | ||
] | ||
} | ||
` | ||
testJSONMarshal(t, u, want) | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.