Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable secret scanning with the enterprise-level REST API (#2607)
Fixes: #2599.
- Loading branch information
1 parent
84cc7d5
commit 4a5aa8c
Showing
4 changed files
with
282 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,78 @@ | ||
// 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" | ||
) | ||
|
||
// EnterpriseSecurityAnalysisSettings represents security analysis settings for an enterprise. | ||
type EnterpriseSecurityAnalysisSettings struct { | ||
AdvancedSecurityEnabledForNewRepositories *bool `json:"advanced_security_enabled_for_new_repositories,omitempty"` | ||
SecretScanningEnabledForNewRepositories *bool `json:"secret_scanning_enabled_for_new_repositories,omitempty"` | ||
SecretScanningPushProtectionEnabledForNewRepositories *bool `json:"secret_scanning_push_protection_enabled_for_new_repositories,omitempty"` | ||
SecretScanningPushProtectionCustomLink *string `json:"secret_scanning_push_protection_custom_link,omitempty"` | ||
} | ||
|
||
// GetCodeSecurityAndAnalysis gets code security and analysis features for an enterprise. | ||
// | ||
// GitHub API docs: https://docs.github.com/en/rest/enterprise-admin/code-security-and-analysis?apiVersion=2022-11-28#get-code-security-and-analysis-features-for-an-enterprise | ||
func (s *EnterpriseService) GetCodeSecurityAndAnalysis(ctx context.Context, enterprise string) (*EnterpriseSecurityAnalysisSettings, *Response, error) { | ||
u := fmt.Sprintf("enterprises/%v/code_security_and_analysis", enterprise) | ||
|
||
req, err := s.client.NewRequest("GET", u, nil) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
|
||
settings := new(EnterpriseSecurityAnalysisSettings) | ||
resp, err := s.client.Do(ctx, req, settings) | ||
if err != nil { | ||
return nil, resp, err | ||
} | ||
|
||
return settings, resp, nil | ||
} | ||
|
||
// UpdateCodeSecurityAndAnalysis updates code security and analysis features for new repositories in an enterprise. | ||
// | ||
// GitHub API docs: https://docs.github.com/en/rest/enterprise-admin/code-security-and-analysis?apiVersion=2022-11-28#update-code-security-and-analysis-features-for-an-enterprise | ||
func (s *EnterpriseService) UpdateCodeSecurityAndAnalysis(ctx context.Context, enterprise string, settings *EnterpriseSecurityAnalysisSettings) (*Response, error) { | ||
u := fmt.Sprintf("enterprises/%v/code_security_and_analysis", enterprise) | ||
req, err := s.client.NewRequest("PATCH", u, settings) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
resp, err := s.client.Do(ctx, req, nil) | ||
if err != nil { | ||
return resp, err | ||
} | ||
|
||
return resp, nil | ||
} | ||
|
||
// EnableDisableSecurityFeature enables or disables a security feature for all repositories in an enterprise. | ||
// | ||
// Valid values for securityProduct: "advanced_security", "secret_scanning", "secret_scanning_push_protection". | ||
// Valid values for enablement: "enable_all", "disable_all". | ||
// | ||
// GitHub API docs: https://docs.github.com/en/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis?apiVersion=2022-11-28#enable-or-disable-a-security-feature | ||
func (s *EnterpriseService) EnableDisableSecurityFeature(ctx context.Context, enterprise, securityProduct, enablement string) (*Response, error) { | ||
u := fmt.Sprintf("enterprises/%v/%v/%v", enterprise, securityProduct, enablement) | ||
req, err := s.client.NewRequest("POST", u, nil) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
resp, err := s.client.Do(ctx, req, nil) | ||
if err != nil { | ||
return resp, err | ||
} | ||
|
||
return resp, nil | ||
} |
This file contains 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,132 @@ | ||
// 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" | ||
"encoding/json" | ||
"fmt" | ||
"net/http" | ||
"testing" | ||
|
||
"github.com/google/go-cmp/cmp" | ||
) | ||
|
||
func TestEnterpriseService_GetCodeSecurityAndAnalysis(t *testing.T) { | ||
client, mux, _, teardown := setup() | ||
defer teardown() | ||
|
||
mux.HandleFunc("/enterprises/e/code_security_and_analysis", func(w http.ResponseWriter, r *http.Request) { | ||
testMethod(t, r, "GET") | ||
|
||
fmt.Fprint(w, ` | ||
{ | ||
"advanced_security_enabled_for_new_repositories": true, | ||
"secret_scanning_enabled_for_new_repositories": true, | ||
"secret_scanning_push_protection_enabled_for_new_repositories": true, | ||
"secret_scanning_push_protection_custom_link": "https://github.com/test-org/test-repo/blob/main/README.md" | ||
}`) | ||
}) | ||
|
||
ctx := context.Background() | ||
|
||
const methodName = "GetCodeSecurityAndAnalysis" | ||
|
||
settings, _, err := client.Enterprise.GetCodeSecurityAndAnalysis(ctx, "e") | ||
if err != nil { | ||
t.Errorf("Enterprise.%v returned error: %v", methodName, err) | ||
} | ||
want := &EnterpriseSecurityAnalysisSettings{ | ||
AdvancedSecurityEnabledForNewRepositories: Bool(true), | ||
SecretScanningEnabledForNewRepositories: Bool(true), | ||
SecretScanningPushProtectionEnabledForNewRepositories: Bool(true), | ||
SecretScanningPushProtectionCustomLink: String("https://github.com/test-org/test-repo/blob/main/README.md"), | ||
} | ||
|
||
if !cmp.Equal(settings, want) { | ||
t.Errorf("Enterprise.%v return \ngot: %+v,\nwant:%+v", methodName, settings, want) | ||
} | ||
|
||
testBadOptions(t, methodName, func() (err error) { | ||
_, _, err = client.Enterprise.GetCodeSecurityAndAnalysis(ctx, "o") | ||
return err | ||
}) | ||
|
||
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
got, resp, err := client.Enterprise.GetCodeSecurityAndAnalysis(ctx, "e") | ||
if got != nil { | ||
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) | ||
} | ||
return resp, err | ||
}) | ||
} | ||
|
||
func TestEnterpriseService_UpdateCodeSecurityAndAnalysis(t *testing.T) { | ||
client, mux, _, teardown := setup() | ||
defer teardown() | ||
|
||
input := &EnterpriseSecurityAnalysisSettings{ | ||
AdvancedSecurityEnabledForNewRepositories: Bool(true), | ||
SecretScanningEnabledForNewRepositories: Bool(true), | ||
SecretScanningPushProtectionEnabledForNewRepositories: Bool(true), | ||
SecretScanningPushProtectionCustomLink: String("https://github.com/test-org/test-repo/blob/main/README.md"), | ||
} | ||
|
||
mux.HandleFunc("/enterprises/e/code_security_and_analysis", func(w http.ResponseWriter, r *http.Request) { | ||
v := new(EnterpriseSecurityAnalysisSettings) | ||
json.NewDecoder(r.Body).Decode(v) | ||
|
||
testMethod(t, r, "PATCH") | ||
if !cmp.Equal(v, input) { | ||
t.Errorf("Request body = %+v, want %+v", v, input) | ||
} | ||
}) | ||
|
||
ctx := context.Background() | ||
|
||
const methodName = "UpdateCodeSecurityAndAnalysis" | ||
|
||
_, err := client.Enterprise.UpdateCodeSecurityAndAnalysis(ctx, "e", input) | ||
if err != nil { | ||
t.Errorf("Enterprise.%v returned error: %v", methodName, err) | ||
} | ||
|
||
testBadOptions(t, methodName, func() (err error) { | ||
_, err = client.Enterprise.UpdateCodeSecurityAndAnalysis(ctx, "o", input) | ||
return err | ||
}) | ||
|
||
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
return client.Enterprise.UpdateCodeSecurityAndAnalysis(ctx, "e", input) | ||
}) | ||
} | ||
|
||
func TestEnterpriseService_EnableAdvancedSecurity(t *testing.T) { | ||
client, mux, _, teardown := setup() | ||
defer teardown() | ||
|
||
mux.HandleFunc("/enterprises/e/advanced_security/enable_all", func(w http.ResponseWriter, r *http.Request) { | ||
testMethod(t, r, "POST") | ||
}) | ||
|
||
ctx := context.Background() | ||
|
||
const methodName = "EnableDisableSecurityFeature" | ||
|
||
_, err := client.Enterprise.EnableDisableSecurityFeature(ctx, "e", "advanced_security", "enable_all") | ||
if err != nil { | ||
t.Errorf("Enterprise.%v returned error: %v", methodName, err) | ||
} | ||
|
||
testBadOptions(t, methodName, func() (err error) { | ||
_, err = client.Enterprise.EnableDisableSecurityFeature(ctx, "o", "advanced_security", "enable_all") | ||
return err | ||
}) | ||
|
||
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { | ||
return client.Enterprise.EnableDisableSecurityFeature(ctx, "e", "advanced_security", "enable_all") | ||
}) | ||
} |
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.