Skip to content

Commit

Permalink
Fix capitalisation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@jporzucek
jporzucek committed Aug 28, 2023
1 parent 7e42754 commit c71d14e
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 95 deletions.
55 changes: 27 additions & 28 deletions github/code-scanning.go
View file
Expand Up @@ -158,10 +158,10 @@ type AnalysesListOptions struct {
ListOptions
}

// CodeqlDatabase represents a metadata about the CodeQL database.
// CodeQLDatabase represents a metadata about the CodeQL database.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning
type CodeqlDatabase struct {
type CodeQLDatabase struct {
ID *int64 `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Language *string `json:"language,omitempty"`
Expand Down Expand Up @@ -235,7 +235,7 @@ type SarifID struct {
// You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events
// read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#list-code-scanning-alerts-for-an-organization
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
func (s *CodeScanningService) ListAlertsForOrg(ctx context.Context, org string, opts *AlertListOptions) ([]*Alert, *Response, error) {
u := fmt.Sprintf("orgs/%v/code-scanning/alerts", org)
u, err := addOptions(u, opts)
Expand Down Expand Up @@ -263,7 +263,7 @@ func (s *CodeScanningService) ListAlertsForOrg(ctx context.Context, org string,
// You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events
// read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#list-code-scanning-alerts-for-a-repository
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
func (s *CodeScanningService) ListAlertsForRepo(ctx context.Context, owner, repo string, opts *AlertListOptions) ([]*Alert, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/alerts", owner, repo)
u, err := addOptions(u, opts)
Expand Down Expand Up @@ -292,7 +292,7 @@ func (s *CodeScanningService) ListAlertsForRepo(ctx context.Context, owner, repo
//
// The security alert_id is the number at the end of the security alert's URL.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#get-a-code-scanning-alert
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-alert
func (s *CodeScanningService) GetAlert(ctx context.Context, owner, repo string, id int64) (*Alert, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/alerts/%v", owner, repo, id)

Expand Down Expand Up @@ -340,7 +340,7 @@ func (s *CodeScanningService) UpdateAlert(ctx context.Context, owner, repo strin
// You must use an access token with the security_events scope to use this endpoint.
// GitHub Apps must have the security_events read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#list-instances-of-a-code-scanning-alert
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
func (s *CodeScanningService) ListAlertInstances(ctx context.Context, owner, repo string, id int64, opts *AlertInstancesListOptions) ([]*MostRecentInstance, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/alerts/%v/instances", owner, repo, id)
u, err := addOptions(u, opts)
Expand Down Expand Up @@ -368,7 +368,7 @@ func (s *CodeScanningService) ListAlertInstances(ctx context.Context, owner, rep
// You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events
// write permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#upload-an-analysis-as-sarif-data
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data
func (s *CodeScanningService) UploadSarif(ctx context.Context, owner, repo string, sarif *SarifAnalysis) (*SarifID, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/sarifs", owner, repo)

Expand All @@ -386,30 +386,30 @@ func (s *CodeScanningService) UploadSarif(ctx context.Context, owner, repo strin
return sarifID, resp, nil
}

// SarifUpload represents information about a SARIF upload.
type SarifUpload struct {
// SARIFUpload represents information about a SARIF upload.
type SARIFUpload struct {
// `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored.
// `failed` files have either not been processed at all, or could only be partially processed.
ProcessingStatus *string `json:"processing_status,omitempty"`
// The REST API URL for getting the analyses associated with the upload.
AnalysesURL *string `json:"analyses_url,omitempty"`
}

// GetSarif get information about a SARIF upload.
// GetSARIF gets information about a SARIF upload.
//
// You must use an access token with the security_events scope to use this endpoint.
// GitHub Apps must have the security_events read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#get-information-about-a-sarif-upload
func (s *CodeScanningService) GetSarif(ctx context.Context, owner, repo, id string) (*SarifUpload, *Response, error) {
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload
func (s *CodeScanningService) GetSARIF(ctx context.Context, owner, repo, id string) (*SARIFUpload, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/sarifs/%v", owner, repo, id)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

sarifUpload := new(SarifUpload)
sarifUpload := new(SARIFUpload)
resp, err := s.client.Do(ctx, req, sarifUpload)
if err != nil {
return nil, resp, err
Expand All @@ -424,7 +424,7 @@ func (s *CodeScanningService) GetSarif(ctx context.Context, owner, repo, id stri
// You must use an access token with the security_events scope to use this endpoint.
// GitHub Apps must have the security_events read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#list-code-scanning-analyses-for-a-repository
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
func (s *CodeScanningService) ListAnalysesForRepo(ctx context.Context, owner, repo string, opts *AnalysesListOptions) ([]*ScanningAnalysis, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/analyses", owner, repo)
u, err := addOptions(u, opts)
Expand Down Expand Up @@ -453,7 +453,7 @@ func (s *CodeScanningService) ListAnalysesForRepo(ctx context.Context, owner, re
//
// The security analysis_id is the ID of the analysis, as returned from the ListAnalysesForRepo operation.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#get-a-code-scanning-analysis-for-a-repository
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
func (s *CodeScanningService) GetAnalysis(ctx context.Context, owner, repo string, id int64) (*ScanningAnalysis, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/analyses/%v", owner, repo, id)

Expand All @@ -471,7 +471,7 @@ func (s *CodeScanningService) GetAnalysis(ctx context.Context, owner, repo strin
return analysis, resp, nil
}

// DeleteAnalysis represents a successful deletion of a code scanning analysis
// DeleteAnalysis represents a successful deletion of a code scanning analysis.
type DeleteAnalysis struct {
// Next deletable analysis in chain, without last analysis deletion confirmation
NextAnalysisURL *string `json:"next_analysis_url,omitempty"`
Expand All @@ -486,8 +486,7 @@ type DeleteAnalysis struct {
//
// The security analysis_id is the ID of the analysis, as returned from the ListAnalysesForRepo operation.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#delete-a-code-scanning-analysis-from-a-repository

// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
func (s *CodeScanningService) DeleteAnalysis(ctx context.Context, owner, repo string, id int64) (*DeleteAnalysis, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/analyses/%v", owner, repo, id)

Expand All @@ -505,21 +504,21 @@ func (s *CodeScanningService) DeleteAnalysis(ctx context.Context, owner, repo st
return deleteAnalysis, resp, nil
}

// ListCodeqlDatabases lists the CodeQL databases that are available in a repository.
// ListCodeQLDatabases lists the CodeQL databases that are available in a repository.
//
// You must use an access token with the security_events scope to use this endpoint.
// GitHub Apps must have the contents read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#list-codeql-databases-for-a-repository
func (s *CodeScanningService) ListCodeqlDatabases(ctx context.Context, owner, repo string) ([]*CodeqlDatabase, *Response, error) {
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
func (s *CodeScanningService) ListCodeQLDatabases(ctx context.Context, owner, repo string) ([]*CodeQLDatabase, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/codeql/databases", owner, repo)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

var codeqlDatabases []*CodeqlDatabase
var codeqlDatabases []*CodeQLDatabase
resp, err := s.client.Do(ctx, req, &codeqlDatabases)
if err != nil {
return nil, resp, err
Expand All @@ -528,21 +527,21 @@ func (s *CodeScanningService) ListCodeqlDatabases(ctx context.Context, owner, re
return codeqlDatabases, resp, nil
}

// GetCodeqlDatabase gets a CodeQL database for a language in a repository.
// GetCodeQLDatabase gets a CodeQL database for a language in a repository.
//
// You must use an access token with the security_events scope to use this endpoint.
// GitHub Apps must have the contents read permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#get-a-codeql-database-for-a-repository
func (s *CodeScanningService) GetCodeqlDatabase(ctx context.Context, owner, repo, language string) (*CodeqlDatabase, *Response, error) {
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
func (s *CodeScanningService) GetCodeQLDatabase(ctx context.Context, owner, repo, language string) (*CodeQLDatabase, *Response, error) {
u := fmt.Sprintf("repos/%v/%v/code-scanning/codeql/databases/%v", owner, repo, language)

req, err := s.client.NewRequest("GET", u, nil)
if err != nil {
return nil, nil, err
}

codeqlDatabase := new(CodeqlDatabase)
codeqlDatabase := new(CodeQLDatabase)
resp, err := s.client.Do(ctx, req, codeqlDatabase)
if err != nil {
return nil, resp, err
Expand All @@ -565,7 +564,7 @@ type DefaultSetupConfiguration struct {
// endpoint with private repos or the public_repo scope for public repos. GitHub Apps must have the repo write
// permission to use this endpoint.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#get-a-code-scanning-default-setup-configuration
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
func (s *CodeScanningService) GetDefaultSetupConfiguration(ctx context.Context, owner, repo string) (*DefaultSetupConfiguration, *Response, error) {
u := fmt.Sprintf("repos/%s/%s/code-scanning/default-setup", owner, repo)

Expand Down Expand Up @@ -606,7 +605,7 @@ type UpdateDefaultSetupConfigurationResponse struct {
// This method might return an AcceptedError and a status code of 202. This is because this is the status that GitHub
// returns to signify that it has now scheduled the update of the pull request branch in a background task.
//
// GitHub API docs: https://docs.github.com/en/rest/code-scanning#update-a-code-scanning-default-setup-configuration
// GitHub API docs: https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
func (s *CodeScanningService) UpdateDefaultSetupConfiguration(ctx context.Context, owner, repo string, options *UpdateDefaultSetupConfigurationOptions) (*UpdateDefaultSetupConfigurationResponse, *Response, error) {
u := fmt.Sprintf("repos/%s/%s/code-scanning/default-setup", owner, repo)

Expand Down
48 changes: 24 additions & 24 deletions github/code-scanning_test.go
View file
Expand Up @@ -89,7 +89,7 @@ func TestCodeScanningService_UploadSarif(t *testing.T) {
})
}

func TestCodeScanningService_GetSarif(t *testing.T) {
func TestCodeScanningService_GetSARIF(t *testing.T) {
client, mux, _, teardown := setup()
defer teardown()

Expand All @@ -102,27 +102,27 @@ func TestCodeScanningService_GetSarif(t *testing.T) {
})

ctx := context.Background()
sarifUpload, _, err := client.CodeScanning.GetSarif(ctx, "o", "r", "abc")
sarifUpload, _, err := client.CodeScanning.GetSARIF(ctx, "o", "r", "abc")
if err != nil {
t.Errorf("CodeScanning.GetSarif returned error: %v", err)
t.Errorf("CodeScanning.GetSARIF returned error: %v", err)
}

want := &SarifUpload{
want := &SARIFUpload{
ProcessingStatus: String("s"),
AnalysesURL: String("u"),
}
if !cmp.Equal(sarifUpload, want) {
t.Errorf("CodeScanning.GetSarif returned %+v, want %+v", sarifUpload, want)
t.Errorf("CodeScanning.GetSARIF returned %+v, want %+v", sarifUpload, want)
}

const methodName = "GetSarif"
const methodName = "GetSARIF"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.CodeScanning.GetSarif(ctx, "\n", "\n", "\n")
_, _, err = client.CodeScanning.GetSARIF(ctx, "\n", "\n", "\n")
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.CodeScanning.GetSarif(ctx, "o", "r", "abc")
got, resp, err := client.CodeScanning.GetSARIF(ctx, "o", "r", "abc")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
Expand Down Expand Up @@ -1341,7 +1341,7 @@ func TestCodeScanningService_DeleteAnalysis(t *testing.T) {
})
}

func TestCodeScanningService_ListCodeqlDatabases(t *testing.T) {
func TestCodeScanningService_ListCodeQLDatabases(t *testing.T) {
client, mux, _, teardown := setup()
defer teardown()

Expand Down Expand Up @@ -1382,13 +1382,13 @@ func TestCodeScanningService_ListCodeqlDatabases(t *testing.T) {
})

ctx := context.Background()
databases, _, err := client.CodeScanning.ListCodeqlDatabases(ctx, "o", "r")
databases, _, err := client.CodeScanning.ListCodeQLDatabases(ctx, "o", "r")
if err != nil {
t.Errorf("CodeScanning.ListCodeqlDatabases returned error: %v", err)
t.Errorf("CodeScanning.ListCodeQLDatabases returned error: %v", err)
}

date := &Timestamp{time.Date(2021, time.January, 13, 11, 55, 49, 0, time.UTC)}
want := []*CodeqlDatabase{
want := []*CodeQLDatabase{
{
ID: Int64(1),
Name: String("name"),
Expand Down Expand Up @@ -1422,25 +1422,25 @@ func TestCodeScanningService_ListCodeqlDatabases(t *testing.T) {
}

if !cmp.Equal(databases, want) {
t.Errorf("CodeScanning.ListCodeqlDatabases returned %+v, want %+v", databases, want)
t.Errorf("CodeScanning.ListCodeQLDatabases returned %+v, want %+v", databases, want)
}

const methodName = "ListCodeqlDatabases"
const methodName = "ListCodeQLDatabases"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.CodeScanning.ListCodeqlDatabases(ctx, "\n", "\n")
_, _, err = client.CodeScanning.ListCodeQLDatabases(ctx, "\n", "\n")
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.CodeScanning.ListCodeqlDatabases(ctx, "o", "r")
got, resp, err := client.CodeScanning.ListCodeQLDatabases(ctx, "o", "r")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
return resp, err
})
}

func TestCodeScanningService_GetCodeqlDatabase(t *testing.T) {
func TestCodeScanningService_GetCodeQLDatabase(t *testing.T) {
client, mux, _, teardown := setup()
defer teardown()

Expand Down Expand Up @@ -1479,13 +1479,13 @@ func TestCodeScanningService_GetCodeqlDatabase(t *testing.T) {
})

ctx := context.Background()
database, _, err := client.CodeScanning.GetCodeqlDatabase(ctx, "o", "r", "lang")
database, _, err := client.CodeScanning.GetCodeQLDatabase(ctx, "o", "r", "lang")
if err != nil {
t.Errorf("CodeScanning.GetCodeqlDatabase returned error: %v", err)
t.Errorf("CodeScanning.GetCodeQLDatabase returned error: %v", err)
}

date := &Timestamp{time.Date(2021, time.January, 13, 11, 55, 49, 0, time.UTC)}
want := &CodeqlDatabase{
want := &CodeQLDatabase{
ID: Int64(1),
Name: String("name"),
Language: String("language"),
Expand Down Expand Up @@ -1517,17 +1517,17 @@ func TestCodeScanningService_GetCodeqlDatabase(t *testing.T) {
}

if !cmp.Equal(database, want) {
t.Errorf("CodeScanning.GetCodeqlDatabase returned %+v, want %+v", database, want)
t.Errorf("CodeScanning.GetCodeQLDatabase returned %+v, want %+v", database, want)
}

const methodName = "GetCodeqlDatabase"
const methodName = "GetCodeQLDatabase"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.CodeScanning.GetCodeqlDatabase(ctx, "\n", "\n", "\n")
_, _, err = client.CodeScanning.GetCodeQLDatabase(ctx, "\n", "\n", "\n")
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.CodeScanning.GetCodeqlDatabase(ctx, "o", "r", "lang")
got, resp, err := client.CodeScanning.GetCodeQLDatabase(ctx, "o", "r", "lang")
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
Expand Down

0 comments on commit c71d14e

Please sign in to comment.