created a function that checks if code scanning is enabled in github

Author: eyalk007

README.md

@@ -66,6 +66,7 @@ Currently supported providers are: [GitHub](#github), [Bitbucket Server](#bitbuc
       - [List Pull Request Labels](#list-pull-request-labels)
       - [Unlabel Pull Request](#unlabel-pull-request)
       - [Upload Code Scanning](#upload-code-scanning)
+      - [Check If Code Scanning Is Enabled](#check-if-code-scanning-is-enabled)
       - [Download a File From a Repository](#download-a-file-from-a-repository)
       - [Create a branch](#create-branch)
       - [Allow workflows on organization](#allow-workflows)
@@ -836,6 +837,22 @@ scanResults := "results"
 sarifID, err := client.UploadCodeScanning(ctx, owner, repo, branch, scanResults)
 ```
 
+#### Check If Code Scanning Is Enabled
+
+Notice - Code Scanning availability check is currently supported on GitHub only.
+
+```go
+// Go context
+ctx := context.Background()
+// The account owner of the git repository
+owner := "user"
+// The name of the repository
+repo := "my_repo"
+
+// Checks if code scanning is enabled for the repository
+enabled, err := client.IsCodeScanningEnabled(ctx, owner, repo)
+```
+
 #### Download a File From a Repository
 
 Note - This API is currently not supported for Bitbucket Cloud.

go.mod

@@ -30,6 +30,7 @@ require (
 	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
 	github.com/go-git/go-billy/v5 v5.6.2 // indirect
 	github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 // indirect
+	github.com/google/go-github/v53 v53.2.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect

go.sum

@@ -44,6 +44,8 @@ github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
 github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
+github.com/google/go-github/v53 v53.2.0 h1:wvz3FyF53v4BK+AsnvCmeNhf8AkTaeh2SoYu/XUvTtI=
+github.com/google/go-github/v53 v53.2.0/go.mod h1:XhFRObz+m/l+UCm9b7KSIC3lT3NWSXGt7mOsAWEloao=
 github.com/google/go-github/v62 v62.0.0 h1:/6mGCaRywZz9MuHyw9gD1CwsbmBX8GWsbFkwMmHdhl4=
 github.com/google/go-github/v62 v62.0.0/go.mod h1:EMxeUqGJq2xRu9DYBMwel/mr7kZrzUOfQmmpYrZn2a4=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=

vcsclient/azurerepos.go

@@ -789,6 +789,10 @@ func (client *AzureReposClient) UploadSnapshotToDependencyGraph(ctx context.Cont
 	return getUnsupportedInAzureError("uploading snapshot to dependency graph UI")
 }
 
+func (client *AzureReposClient) IsCodeScanningEnabled(ctx context.Context, owner, repository string) (bool, error) {
+	return false, getUnsupportedInAzureError("code scanning")
+}
+
 func parsePullRequestDetails(client *AzureReposClient, pullRequest git.GitPullRequest, owner, repository string, withBody bool) PullRequestInfo {
 	// Trim the branches prefix and get the actual branches name
 	shortSourceName := plumbing.ReferenceName(*pullRequest.SourceRefName).Short()

vcsclient/bitbucketcloud.go

@@ -747,6 +747,10 @@ func (client *BitbucketCloudClient) UploadSnapshotToDependencyGraph(ctx context.
 	return errBitbucketUploadSnapshotToDependencyGraphNotSupported
 }
 
+func (client *BitbucketCloudClient) IsCodeScanningEnabled(ctx context.Context, owner, repository string) (bool, error) {
+	return false, errBitbucketCodeScanningNotSupported
+}
+
 type pullRequestsResponse struct {
 	Values []pullRequestsDetails `json:"values"`
 }

vcsclient/bitbucketcommon.go

@@ -2,9 +2,10 @@ package vcsclient
 
 import (
 	"fmt"
+	"time"
+
 	"github.com/jfrog/froggit-go/vcsutils"
 	"github.com/mitchellh/mapstructure"
-	"time"
 )
 
 const (
@@ -36,6 +37,8 @@ var (
 	errBitbucketListAppReposNotSupported                     = fmt.Errorf("list app repositories is %s", notSupportedOnBitbucket)
 	errBitbucketCreatePullRequestDetailedNotSupported        = fmt.Errorf("creating pull request detailed is %s", notSupportedOnBitbucket)
 	errBitbucketUploadSnapshotToDependencyGraphNotSupported  = fmt.Errorf("uploading snapshot to dependency graph UI is %s", notSupportedOnBitbucket)
+	errBitbucketIsCodeScanningEnabledNotSupported            = fmt.Errorf("checking if code scanning is enabled is %s", notSupportedOnBitbucket)
+	errBitbucketIsCodeScanningEnabledViaSARIFNotSupported    = fmt.Errorf("checking if code scanning is enabled via SARIF upload is %s", notSupportedOnBitbucket)
 )
 
 type BitbucketCommitInfo struct {

vcsclient/bitbucketserver.go

@@ -939,6 +939,10 @@ func (client *BitbucketServerClient) UploadSnapshotToDependencyGraph(ctx context
 	return errBitbucketUploadSnapshotToDependencyGraphNotSupported
 }
 
+func (client *BitbucketServerClient) IsCodeScanningEnabled(ctx context.Context, owner, repository string) (bool, error) {
+	return false, errBitbucketCodeScanningNotSupported
+}
+
 func getBitbucketServerRepositoryVisibility(public bool) RepositoryVisibility {
 	if public {
 		return Public

vcsclient/github.go

@@ -1715,3 +1715,64 @@ func convertToGitHubSnapshot(snapshot *SbomSnapshot) (*github.DependencyGraphSna
 	}
 	return ghSnapshot, nil
 }
+
+// IsCodeScanningEnabled checks if code scanning is enabled for a repository.
+// Tests the SARIF upload endpoint with an empty body: 422=enabled, 403=disabled.
+// TODO: Replace with proper GitHub API when available.
+func (client *GitHubClient) IsCodeScanningEnabled(ctx context.Context, owner, repository string) (bool, error) {
+	err := validateParametersNotBlank(map[string]string{"owner": owner, "repository": repository})
+	if err != nil {
+		return false, err
+	}
+
+	requestUrl := fmt.Sprintf("%srepos/%s/%s/code-scanning/sarifs", client.ghClient.BaseURL.String(), owner, repository)
+	req, err := http.NewRequestWithContext(ctx, http.MethodPost, requestUrl, strings.NewReader(""))
+	if err != nil {
+		return false, err
+	}
+
+	req.Header.Set("Accept", "application/vnd.github+json")
+	req.Header.Set("Content-Type", "application/json")
+	if client.vcsInfo.Token != "" {
+		req.Header.Set("Authorization", "Bearer "+client.vcsInfo.Token)
+	}
+
+	resp, err := client.ghClient.Client().Do(req)
+	if err != nil {
+		return false, err
+	}
+	defer func() {
+		if closeErr := resp.Body.Close(); closeErr != nil {
+			client.logger.Warn("Failed to close response body:", closeErr)
+		}
+	}()
+
+	switch resp.StatusCode {
+	case http.StatusForbidden:
+		// Check if the error message mentions code scanning
+		body, readErr := io.ReadAll(resp.Body)
+		if readErr == nil {
+			bodyStr := strings.ToLower(string(body))
+			if strings.Contains(bodyStr, "code scanning") || strings.Contains(bodyStr, "advanced security") {
+				return false, nil
+			}
+		}
+		// If we can't read the body or it doesn't mention code scanning, log warning and return false
+		client.logger.Warn("Received 403 for code scanning check on", owner+"/"+repository, "but response doesn't clearly indicate code scanning status")
+		return false, nil
+	case http.StatusUnprocessableEntity:
+		// 422 means the endpoint exists and is processing our request, but the empty body is invalid
+		return true, nil
+	default:
+		// Any other status code is unexpected
+		if resp.StatusCode >= 200 && resp.StatusCode < 300 {
+			// Success is unexpected with empty body
+			client.logger.Warn("Code scanning request unexpectedly succeeded for", owner+"/"+repository, "with status", resp.StatusCode, ". This should not happen.")
+			return true, nil
+		} else {
+			// Other error status codes
+			client.logger.Warn("Unexpected status code", resp.StatusCode, "when checking code scanning for", owner+"/"+repository)
+			return false, nil
+		}
+	}
+}

vcsclient/github_test.go

@@ -1608,3 +1608,97 @@ func TestGithubClient_UploadSnapshotToDependencyGraph(t *testing.T) {
 	err = createBadGitHubClient(t).UploadSnapshotToDependencyGraph(ctx, owner, repo1, &snapshot)
 	assert.Error(t, err)
 }
+
+func TestGitHubClient_IsCodeScanningEnabled(t *testing.T) {
+	ctx := context.Background()
+
+	t.Run("code scanning enabled - 422 response", func(t *testing.T) {
+		unprocessableResponse := []byte(`{
+			"message": "Invalid request",
+			"errors": [
+				{
+					"code": "invalid",
+					"field": "sarif"
+				}
+			]
+		}`)
+
+		client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.GitHub, false, unprocessableResponse,
+			fmt.Sprintf("/repos/%s/%s/code-scanning/sarifs", owner, repo1), http.StatusUnprocessableEntity,
+			createGitHubHandler)
+		defer cleanUp()
+
+		enabled, err := client.IsCodeScanningEnabled(ctx, owner, repo1)
+		assert.NoError(t, err)
+		assert.True(t, enabled)
+	})
+
+	t.Run("code scanning disabled - 403 with code scanning message", func(t *testing.T) {
+		forbiddenResponse := []byte(`{
+			"message": "Advanced Security must be enabled for this repository to use code scanning.",
+			"documentation_url": "https://docs.github.com/rest/reference/code-scanning"
+		}`)
+
+		client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.GitHub, false, forbiddenResponse,
+			fmt.Sprintf("/repos/%s/%s/code-scanning/sarifs", owner, repo1), http.StatusForbidden,
+			createGitHubHandler)
+		defer cleanUp()
+
+		enabled, err := client.IsCodeScanningEnabled(ctx, owner, repo1)
+		assert.NoError(t, err)
+		assert.False(t, enabled)
+	})
+
+	t.Run("generic forbidden - 403 without code scanning message", func(t *testing.T) {
+		genericForbiddenResponse := []byte(`{
+			"message": "Forbidden"
+		}`)
+
+		client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.GitHub, false, genericForbiddenResponse,
+			fmt.Sprintf("/repos/%s/%s/code-scanning/sarifs", owner, repo1), http.StatusForbidden,
+			createGitHubHandler)
+		defer cleanUp()
+
+		enabled, err := client.IsCodeScanningEnabled(ctx, owner, repo1)
+		assert.NoError(t, err)
+		assert.False(t, enabled)
+	})
+
+	t.Run("unexpected success - 200 response", func(t *testing.T) {
+		successResponse := []byte(`{"message": "Success"}`)
+
+		client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.GitHub, false, successResponse,
+			fmt.Sprintf("/repos/%s/%s/code-scanning/sarifs", owner, repo1), http.StatusOK,
+			createGitHubHandler)
+		defer cleanUp()
+
+		enabled, err := client.IsCodeScanningEnabled(ctx, owner, repo1)
+		assert.NoError(t, err)
+		assert.True(t, enabled) // Should return true but log a warning
+	})
+
+	t.Run("network error", func(t *testing.T) {
+		enabled, err := createBadGitHubClient(t).IsCodeScanningEnabled(ctx, owner, repo1)
+		assert.Error(t, err)
+		assert.False(t, enabled)
+	})
+
+	t.Run("invalid parameters", func(t *testing.T) {
+		client, cleanUp := createServerAndClientReturningStatus(t, vcsutils.GitHub, false, nil,
+			fmt.Sprintf("/repos/%s/%s/code-scanning/sarifs", owner, repo1), http.StatusUnprocessableEntity,
+			createGitHubHandler)
+		defer cleanUp()
+
+		// Test empty owner
+		enabled, err := client.IsCodeScanningEnabled(ctx, "", repo1)
+		assert.Error(t, err)
+		assert.False(t, enabled)
+		assert.Contains(t, err.Error(), "owner")
+
+		// Test empty repository
+		enabled, err = client.IsCodeScanningEnabled(ctx, owner, "")
+		assert.Error(t, err)
+		assert.False(t, enabled)
+		assert.Contains(t, err.Error(), "repository")
+	})
+}

vcsclient/gitlab.go

@@ -827,6 +827,10 @@ func (client *GitLabClient) UploadSnapshotToDependencyGraph(ctx context.Context,
 	return errGitLabUploadSnapshotToDependencyGraphNotSupported
 }
 
+func (client *GitLabClient) IsCodeScanningEnabled(ctx context.Context, owner, repository string) (bool, error) {
+	return false, errGitLabCodeScanningNotSupported
+}
+
 func getProjectID(owner, project string) string {
 	return fmt.Sprintf("%s/%s", owner, project)
 }