Merge pull request #40 from snyk/feat(reachability)/pass-local-policy-to-test

feat(reachability): pass local policy to test

Author: bengro

internal/commands/ostest/depgraph_flow.go

@@ -25,12 +25,11 @@ func RunUnifiedTestFlow(
 	ctx context.Context,
 	ictx workflow.InvocationContext,
 	testClient testapi.TestClient,
-	riskScoreThreshold *uint16,
-	severityThreshold *testapi.Severity,
 	orgID string,
 	orgSlugOrID string,
 	errFactory *errors.ErrorFactory,
 	logger *zerolog.Logger,
+	localPolicy *testapi.LocalPolicy,
 ) ([]workflow.Data, error) {
 	logger.Info().Msg("Starting open source test")
 
@@ -40,8 +39,6 @@ func RunUnifiedTestFlow(
 		return nil, err
 	}
 
-	localPolicy := createLocalPolicy(riskScoreThreshold, severityThreshold)
-
 	allLegacyFindings, allOutputData, err := testAllDepGraphs(
 		ctx,
 		ictx,
@@ -230,18 +227,6 @@ func prepareJSONOutput(
 	return bytes.TrimRight(buffer.Bytes(), "\n"), nil
 }
 
-// Create local policy only if risk score or severity threshold are specified.
-func createLocalPolicy(riskScoreThreshold *uint16, severityThreshold *testapi.Severity) *testapi.LocalPolicy {
-	if riskScoreThreshold == nil && severityThreshold == nil {
-		return nil
-	}
-
-	return &testapi.LocalPolicy{
-		RiskScoreThreshold: riskScoreThreshold,
-		SeverityThreshold:  severityThreshold,
-	}
-}
-
 // createDepGraphs creates depgraphs from the file parameter in the context.
 func createDepGraphs(ictx workflow.InvocationContext) ([]*testapi.IoSnykApiV1testdepgraphRequestDepGraph, []string, error) {
 	depGraphResult, err := service.GetDepGraph(ictx)

internal/commands/ostest/sbom_reachability_flow.go

@@ -26,6 +26,7 @@ func RunSbomReachabilityFlow(
 	bsClient bundlestore.Client,
 	orgID string,
 	orgSlugOrID string,
+	localPolicy *testapi.LocalPolicy,
 ) ([]workflow.Data, error) {
 	if sourceCodePath == "" {
 		sourceCodePath = "."
@@ -68,7 +69,7 @@ func RunSbomReachabilityFlow(
 		return nil, fmt.Errorf("failed to create sbom test reachability subject: %w", err)
 	}
 
-	findings, summary, err := RunTest(ctx, ictx, testClient, subject, "", "", int(0), sbomPath, orgID, orgSlugOrID, errFactory, logger, nil)
+	findings, summary, err := RunTest(ctx, ictx, testClient, subject, "", "", int(0), sbomPath, orgID, orgSlugOrID, errFactory, logger, localPolicy)
 	if err != nil {
 		return nil, err
 	}

internal/commands/ostest/sbom_reachability_flow_test.go

@@ -42,7 +42,7 @@ func Test_RunSbomReachabilityFlow_JSON(t *testing.T) {
 	mockIctx, mockTestClient, mockBsClient, orgID, orgSlug, sbomPath, sourceCodePath := setupTest(ctx, t, ctrl, true)
 
 	// This should now succeed with proper finding data
-	result, err := ostest.RunSbomReachabilityFlow(ctx, mockIctx, mockTestClient, ef, &nopLogger, sbomPath, sourceCodePath, mockBsClient, orgID, orgSlug)
+	result, err := ostest.RunSbomReachabilityFlow(ctx, mockIctx, mockTestClient, ef, &nopLogger, sbomPath, sourceCodePath, mockBsClient, orgID, orgSlug, nil)
 
 	require.NoError(t, err)
 	require.NotNil(t, result)
@@ -67,7 +67,7 @@ func Test_RunSbomReachabilityFlow_HumanReadable(t *testing.T) {
 	mockIctx, mockTestClient, mockBsClient, orgID, orgSlug, sbomPath, sourceCodePath := setupTest(ctx, t, ctrl, false)
 
 	// This should now succeed with proper finding data
-	result, err := ostest.RunSbomReachabilityFlow(ctx, mockIctx, mockTestClient, ef, &nopLogger, sbomPath, sourceCodePath, mockBsClient, orgID, orgSlug)
+	result, err := ostest.RunSbomReachabilityFlow(ctx, mockIctx, mockTestClient, ef, &nopLogger, sbomPath, sourceCodePath, mockBsClient, orgID, orgSlug, nil)
 
 	require.NoError(t, err)
 	require.NotNil(t, result)

internal/commands/ostest/workflow.go

@@ -82,6 +82,7 @@ func setupSBOMReachabilityFlow(
 	errFactory *errors.ErrorFactory,
 	logger *zerolog.Logger,
 	sbom, sourceDir string,
+	localPolicy *testapi.LocalPolicy,
 ) ([]workflow.Data, error) {
 	config := ictx.GetConfiguration()
 
@@ -105,55 +106,38 @@ func setupSBOMReachabilityFlow(
 	)
 
 	bsClient := bundlestore.NewClient(ictx.GetNetworkAccess().GetHttpClient(), codeScannerConfig, cScanner, logger)
-	return RunSbomReachabilityFlow(ctx, ictx, testClient, errFactory, logger, sbom, sourceDir, bsClient, orgID, orgSlugOrID)
+	return RunSbomReachabilityFlow(ctx, ictx, testClient, errFactory, logger, sbom, sourceDir, bsClient, orgID, orgSlugOrID, localPolicy)
 }
 
-// setupDefaultTestFlow sets up and runs the default test flow with risk score and severity thresholds.
-func setupDefaultTestFlow(
-	ctx context.Context,
-	ictx workflow.InvocationContext,
-	testClient testapi.TestClient,
-	orgID string,
-	orgSlugOrID string,
-	errFactory *errors.ErrorFactory,
-	logger *zerolog.Logger,
-	riskScoreThreshold int,
-) ([]workflow.Data, error) {
-	config := ictx.GetConfiguration()
-
-	// Risk Score FFs
-	ffRiskScore := config.GetBool(FeatureFlagRiskScore)
-	ffRiskScoreInCLI := config.GetBool(FeatureFlagRiskScoreInCLI)
-	riskScoreFFsEnabled := ffRiskScore && ffRiskScoreInCLI
-
-	if riskScoreThreshold != -1 && !riskScoreFFsEnabled {
-		// The user tried to use a risk score threshold without the required feature flags.
-		// Return a specific error for the first missing flag found.
-		if !ffRiskScore {
-			return nil, errFactory.NewFeatureNotPermittedError(FeatureFlagRiskScore)
-		}
-		return nil, errFactory.NewFeatureNotPermittedError(FeatureFlagRiskScoreInCLI)
-	}
-
-	var riskScorePtr *uint16
-	if riskScoreThreshold >= math.MaxUint16 {
+// CreateLocalPolicy will create a local policy only if risk score or severity threshold are specified in the config.
+func CreateLocalPolicy(config configuration.Configuration, logger *zerolog.Logger) *testapi.LocalPolicy {
+	var riskScoreThreshold *uint16
+	riskScoreThresholdInt := config.GetInt(flags.FlagRiskScoreThreshold)
+	if riskScoreThresholdInt >= math.MaxUint16 {
 		// the API will enforce a range from the test spec
-		logger.Warn().Msgf("Risk score threshold %d exceeds maximum uint16 value. Setting to maximum.", riskScoreThreshold)
+		logger.Warn().Msgf("Risk score threshold %d exceeds maximum uint16 value. Setting to maximum.", riskScoreThresholdInt)
 		maxVal := uint16(math.MaxUint16)
-		riskScorePtr = &maxVal
-	} else if riskScoreThreshold >= 0 {
-		rs := uint16(riskScoreThreshold)
-		riskScorePtr = &rs
+		riskScoreThreshold = &maxVal
+	} else if riskScoreThresholdInt >= 0 {
+		rs := uint16(riskScoreThresholdInt)
+		riskScoreThreshold = &rs
 	}
 
-	var severityThresholdPtr *testapi.Severity
+	var severityThreshold *testapi.Severity
 	severityThresholdStr := config.GetString(flags.FlagSeverityThreshold)
 	if severityThresholdStr != "" {
 		st := testapi.Severity(severityThresholdStr)
-		severityThresholdPtr = &st
+		severityThreshold = &st
 	}
 
-	return RunUnifiedTestFlow(ctx, ictx, testClient, riskScorePtr, severityThresholdPtr, orgID, orgSlugOrID, errFactory, logger)
+	if riskScoreThreshold == nil && severityThreshold == nil {
+		return nil
+	}
+
+	return &testapi.LocalPolicy{
+		RiskScoreThreshold: riskScoreThreshold,
+		SeverityThreshold:  severityThreshold,
+	}
 }
 
 // OSWorkflow is the entry point for the Open Source Test workflow.
@@ -203,6 +187,17 @@ func OSWorkflow(
 		orgSlugOrID = orgID
 	}
 
+	if riskScoreThreshold != -1 && !riskScoreFFsEnabled {
+		// The user tried to use a risk score threshold without the required feature flags.
+		// Return a specific error for the first missing flag found.
+		if !ffRiskScore {
+			return nil, errFactory.NewFeatureNotPermittedError(FeatureFlagRiskScore)
+		}
+		return nil, errFactory.NewFeatureNotPermittedError(FeatureFlagRiskScoreInCLI)
+	}
+
+	localPolicy := CreateLocalPolicy(config, logger)
+
 	// Create Snyk client
 	httpClient := ictx.GetNetworkAccess().GetHttpClient()
 	snykClient := snykclient.NewSnykClient(httpClient, ictx.GetConfiguration().GetString(configuration.API_URL), orgID)
@@ -220,8 +215,8 @@ func OSWorkflow(
 	// Route to the appropriate flow based on flags
 	switch {
 	case sbomReachabilityTest:
-		return setupSBOMReachabilityFlow(ctx, ictx, testClient, orgID, orgSlugOrID, errFactory, logger, sbom, sourceDir)
+		return setupSBOMReachabilityFlow(ctx, ictx, testClient, orgID, orgSlugOrID, errFactory, logger, sbom, sourceDir, localPolicy)
 	default:
-		return setupDefaultTestFlow(ctx, ictx, testClient, orgID, orgSlugOrID, errFactory, logger, riskScoreThreshold)
+		return RunUnifiedTestFlow(ctx, ictx, testClient, orgID, orgSlugOrID, errFactory, logger, localPolicy)
 	}
 }

internal/commands/ostest/workflow_test.go

@@ -3,6 +3,7 @@ package ostest_test
 import (
 	"encoding/json"
 	"fmt"
+	"math"
 	"net/http"
 	"net/http/httptest"
 	"strings"
@@ -30,6 +31,59 @@ import (
 
 var legacyWorkflowID = workflow.NewWorkflowIdentifier("legacycli")
 
+var logger = zerolog.Nop()
+
+func TestOSWorkflow_CreateLocalPolicy(t *testing.T) {
+	// Setup - No special flags set
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	mockEngine := mocks.NewMockEngine(ctrl)
+	mockInvocationCtx := createMockInvocationCtxWithURL(t, ctrl, mockEngine, "")
+	mockConfig := mockInvocationCtx.GetConfiguration()
+	mockConfig.Set(flags.FlagRiskScoreThreshold, 100)
+	mockConfig.Set(flags.FlagSeverityThreshold, "high")
+
+	localPolicy := ostest.CreateLocalPolicy(mockConfig, &logger)
+	require.NotNil(t, localPolicy)
+
+	require.NotNil(t, localPolicy.RiskScoreThreshold)
+	assert.Equal(t, uint16(100), *localPolicy.RiskScoreThreshold)
+	require.NotNil(t, localPolicy.SeverityThreshold)
+	assert.Equal(t, "high", string(*localPolicy.SeverityThreshold))
+}
+
+func TestOSWorkflow_CreateLocalPolicy_NoValues(t *testing.T) {
+	// Setup - No special flags set
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	mockEngine := mocks.NewMockEngine(ctrl)
+	mockInvocationCtx := createMockInvocationCtxWithURL(t, ctrl, mockEngine, "")
+	mockConfig := mockInvocationCtx.GetConfiguration()
+
+	localPolicy := ostest.CreateLocalPolicy(mockConfig, &logger)
+
+	assert.Nil(t, localPolicy)
+}
+
+func TestOSWorkflow_CreateLocalPolicy_RiskScoreOverflow(t *testing.T) {
+	// Setup - No special flags set
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	mockEngine := mocks.NewMockEngine(ctrl)
+	mockInvocationCtx := createMockInvocationCtxWithURL(t, ctrl, mockEngine, "")
+	mockConfig := mockInvocationCtx.GetConfiguration()
+	mockConfig.Set(flags.FlagRiskScoreThreshold, math.MaxUint16+10)
+
+	localPolicy := ostest.CreateLocalPolicy(mockConfig, &logger)
+	require.NotNil(t, localPolicy)
+
+	assert.NotNil(t, localPolicy.RiskScoreThreshold)
+	assert.Equal(t, uint16(math.MaxUint16), *localPolicy.RiskScoreThreshold)
+}
+
 func TestOSWorkflow_LegacyFlow(t *testing.T) {
 	// Setup - No special flags set
 	ctrl := gomock.NewController(t)