fix: using getSastSettingsConfig for sastsettings (#321)

Author: acke

internal/api/api.go

@@ -11,6 +11,8 @@ import (
 
 	"github.com/snyk/go-application-framework/internal/api/contract"
 	"github.com/snyk/go-application-framework/internal/constants"
+
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 )
 
 type ApiClient interface {
@@ -21,7 +23,7 @@ type ApiClient interface {
 	GetFeatureFlag(flagname string, origId string) (bool, error)
 	GetUserMe() (string, error)
 	GetSelf() (contract.SelfResponse, error)
-	GetSastSettings(orgId string) (contract.SastResponse, error)
+	GetSastSettings(orgId string) (sast_contract.SastResponse, error)
 }
 
 var _ ApiClient = (*snykApiClient)(nil)
@@ -196,9 +198,9 @@ func (a *snykApiClient) GetSelf() (contract.SelfResponse, error) {
 	return selfData, nil
 }
 
-func (a *snykApiClient) GetSastSettings(orgId string) (contract.SastResponse, error) {
-	var response contract.SastResponse
-	var defaultResult contract.SastResponse
+func (a *snykApiClient) GetSastSettings(orgId string) (sast_contract.SastResponse, error) {
+	var response sast_contract.SastResponse
+	var defaultResult sast_contract.SastResponse
 
 	endpoint := a.url + "/v1/cli-config/settings/sast?org=" + url.QueryEscape(orgId)
 	res, err := a.client.Get(endpoint)

internal/mocks/api.go

@@ -8,12 +8,13 @@ import (
 	"github.com/spf13/pflag"
 
 	"github.com/snyk/go-application-framework/internal/api"
-	"github.com/snyk/go-application-framework/internal/api/contract"
 	"github.com/snyk/go-application-framework/internal/utils"
 	"github.com/snyk/go-application-framework/pkg/configuration"
 	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow"
 	"github.com/snyk/go-application-framework/pkg/local_workflows/config_utils"
 	"github.com/snyk/go-application-framework/pkg/workflow"
+
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 )
 
 const (
@@ -45,19 +46,9 @@ func GetCodeFlagSet() *pflag.FlagSet {
 // WORKFLOWID_CODE defines a new workflow identifier
 var WORKFLOWID_CODE workflow.Identifier = workflow.NewWorkflowIdentifier(codeWorkflowName)
 
-func getSastSettings(engine workflow.Engine) (*contract.SastResponse, error) {
+func getSastSettings(engine workflow.Engine) (*sast_contract.SastResponse, error) {
 	config := engine.GetConfiguration()
 	org := config.GetString(configuration.ORGANIZATION)
-	key := fmt.Sprintf("CACHE_SAST_RESPONSE_%s", org)
-
-	cachedContent := config.Get(key)
-	if cachedContent != nil {
-		cachedResponse, ok := cachedContent.(*contract.SastResponse)
-		if ok {
-			return cachedResponse, nil
-		}
-	}
-
 	client := engine.GetNetworkAccess().GetHttpClient()
 	url := config.GetString(configuration.API_URL)
 	apiClient := api.NewApi(url, client)
@@ -67,10 +58,27 @@ func getSastSettings(engine workflow.Engine) (*contract.SastResponse, error) {
 		return &tmp, err
 	}
 
-	engine.GetConfiguration().Set(key, &tmp)
+	engine.GetConfiguration().Set(code_workflow.ConfigurationSastSettings, &tmp)
 	return &tmp, nil
 }
 
+func getSastSettingsConfig(engine workflow.Engine) configuration.DefaultValueFunction {
+	callback := func(existingValue interface{}) (interface{}, error) {
+		if existingValue != nil {
+			return existingValue, nil
+		}
+
+		response, err := getSastSettings(engine)
+		if err != nil {
+			engine.GetLogger().Err(err).Msg("Failed to access settings.")
+			return false, err
+		}
+
+		return response, nil
+	}
+	return callback
+}
+
 func getSastEnabled(engine workflow.Engine) configuration.DefaultValueFunction {
 	callback := func(existingValue interface{}) (interface{}, error) {
 		if existingValue != nil {
@@ -132,6 +140,7 @@ func InitCodeWorkflow(engine workflow.Engine) error {
 		return err
 	}
 
+	engine.GetConfiguration().AddDefaultValue(code_workflow.ConfigurationSastSettings, getSastSettingsConfig(engine))
 	engine.GetConfiguration().AddDefaultValue(code_workflow.ConfigurationSastEnabled, getSastEnabled(engine))
 	engine.GetConfiguration().AddDefaultValue(code_workflow.ConfigurarionSlceEnabled, getSlceEnabled(engine))
 	engine.GetConfiguration().AddDefaultValue(code_workflow.ConfigurationTestFLowName, configuration.StandardDefaultValueFunction("cli_test"))

pkg/local_workflows/code_workflow.go

@@ -39,6 +39,7 @@ const (
 	ConfigurationProjectId             = "project-id"
 	ConfigurationCommitId              = "commit-id"
 	ConfigurationSastEnabled           = "internal_sast_enabled"
+	ConfigurationSastSettings          = "internal_sast_settings"
 	ConfigurarionSlceEnabled           = "internal_snyk_scle_enabled"
 	FfNameNativeImplementation         = "snykCodeClientNativeImplementation"
 )

pkg/local_workflows/code_workflow/native_workflow.go

@@ -1,4 +1,4 @@
-package contract
+package sast_contract
 
 type LocalCodeEngine struct {
 	AllowCloudUpload bool   `json:"allowCloudUpload"`

internal/api/contract/SastSettings.go renamed to pkg/local_workflows/code_workflow/sast_contract/sast_settings.go

@@ -21,6 +21,7 @@ import (
 	"github.com/snyk/go-application-framework/internal/api/contract"
 	"github.com/snyk/go-application-framework/pkg/configuration"
 	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow"
+	"github.com/snyk/go-application-framework/pkg/local_workflows/code_workflow/sast_contract"
 	"github.com/snyk/go-application-framework/pkg/local_workflows/content_type"
 	"github.com/snyk/go-application-framework/pkg/local_workflows/json_schemas"
 	"github.com/snyk/go-application-framework/pkg/mocks"
@@ -37,9 +38,9 @@ func Test_Code_entrypoint(t *testing.T) {
 		fmt.Println(r.URL)
 		if strings.HasSuffix(r.URL.String(), "/v1/cli-config/settings/sast?org="+org) {
 			sastSettingsCalled++
-			sastSettings := &contract.SastResponse{
+			sastSettings := &sast_contract.SastResponse{
 				SastEnabled: true,
-				LocalCodeEngine: contract.LocalCodeEngine{
+				LocalCodeEngine: sast_contract.LocalCodeEngine{
 					Enabled: true, /* ensures that legacycli will be called */
 				},
 			}
@@ -98,7 +99,7 @@ func Test_Code_entrypoint(t *testing.T) {
 	assert.NoError(t, err)
 	assert.NotNil(t, rs)
 	assert.Equal(t, expectedData, rs[0].GetPayload().(string))
-	assert.Equal(t, 1, sastSettingsCalled)
+	assert.Equal(t, 2, sastSettingsCalled)
 }
 
 func Test_Code_legacyImplementation_happyPath(t *testing.T) {

pkg/local_workflows/code_workflow_test.go

@@ -41,6 +41,8 @@ type NetworkAccess interface {
 	AddHeaderField(key, value string)
 	// AddDynamicHeaderField adds a dynamic header field to the request.
 	AddDynamicHeaderField(key string, f DynamicHeaderFunc)
+	// RemoveHeaderField removes a static header field value from requests.
+	RemoveHeaderField(key string)
 	// AddRootCAs adds the root CAs from the given PEM file.
 	AddRootCAs(pemFileLocation string) error
 	// AddErrorHandler registers an error handler for the underlying http.RoundTripper.
@@ -172,6 +174,12 @@ func (n *networkImpl) AddHeaderField(key, value string) {
 	n.staticHeader.Add(key, value)
 }
 
+// RemoveHeaderField removes a static header field value from requests.
+func (n *networkImpl) RemoveHeaderField(key string) {
+	// Remove the specified header from the request
+	n.staticHeader.Del(key)
+}
+
 // AddErrorHandler registers an error handler for the underlying http.RoundTripper and registers the response middleware
 // that maps non 2xx status codes to Error Catalog errors.
 func (n *networkImpl) AddErrorHandler(handler networktypes.ErrorHandlerFunc) {