feat(cli): exposes max concurrency and timeout as config options

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Author: jpower432

cmd/c2pcli/cli/subcommands/config.go

@@ -24,9 +24,6 @@ import (
 	"github.com/oscal-compass/compliance-to-policy-go/v2/framework/actions"
 )
 
-// Plugin running times might be highly variable this is maximum timeout value.
-var pluginTimeout = 5 * time.Minute
-
 // Config returns a populated C2PConfig for the CLI to use.
 func Config(option *Options) (*framework.C2PConfig, error) {
 	c2pConfig := framework.DefaultConfig()
@@ -40,7 +37,7 @@ func Config(option *Options) (*framework.C2PConfig, error) {
 	return c2pConfig, nil
 }
 
-func Context(ap *oscalTypes.AssessmentPlan) (*actions.InputContext, error) {
+func Context(option *Options, ap *oscalTypes.AssessmentPlan) (*actions.InputContext, error) {
 	if ap.LocalDefinitions == nil || ap.LocalDefinitions.Activities == nil || ap.AssessmentAssets.Components == nil {
 		return nil, errors.New("error converting component definition to assessment plan")
 	}
@@ -59,6 +56,12 @@ func Context(ap *oscalTypes.AssessmentPlan) (*actions.InputContext, error) {
 	apSettings := settings.NewAssessmentActivitiesSettings(*ap.LocalDefinitions.Activities)
 	inputCtx.Settings = apSettings
 
+	// Set the max concurrency if set by the user
+	if option.AdvancedOptions.MaxConcurrency != 0 {
+		option.logger.Debug("Setting max concurrency", "max", option.AdvancedOptions.MaxPluginTimeout)
+		inputCtx.MaxConcurrency = option.AdvancedOptions.MaxConcurrency
+	}
+
 	return inputCtx, nil
 }
 
@@ -114,3 +117,14 @@ func loadPlan(path string) (*oscalTypes.AssessmentPlan, error) {
 	}
 	return plan, nil
 }
+
+func maxTimeout(options *Options) time.Duration {
+	// Plugin running times might be highly variable.
+	// This is default maximum timeout value.
+	pluginTimeout := 5
+	if options.AdvancedOptions.MaxPluginTimeout != 0 {
+		pluginTimeout = options.AdvancedOptions.MaxPluginTimeout
+	}
+	options.logger.Debug("Setting plugin timeout:", "minutes", pluginTimeout)
+	return time.Duration(pluginTimeout) * time.Minute
+}

cmd/c2pcli/cli/subcommands/options.go

@@ -53,9 +53,17 @@ type Options struct {
 	AssessmentResults string                       `yaml:"assessment-results" mapstructure:"assessment-results"`
 	Plugins           map[string]map[string]string `yaml:"plugins" mapstructure:"plugins"`
 	Output            string                       `yaml:"out" mapstructure:"out"`
+	AdvancedOptions   AdvancedOptions              `yaml:"advanced" mapstructure:"advanced"`
 	logger            hclog.Logger
 }
 
+type AdvancedOptions struct {
+	// MaxConcurrency defines the maximum number of goroutines for plugin operations
+	MaxConcurrency int `yaml:"max-concurrency" mapstructure:"max-concurrency"`
+	// MaxPluginTimeout is maximum time a plugin has to complete operations in minutes.
+	MaxPluginTimeout int `yaml:"max-plugin-timeout" mapstructure:"max-plugin-timeout"`
+}
+
 // NewOptions returns an initialized Options struct.
 func NewOptions() *Options {
 	return &Options{

cmd/c2pcli/cli/subcommands/oscal2policy.go

@@ -59,7 +59,7 @@ func runOSCAL2Policy(ctx context.Context, option *Options) error {
 		return err
 	}
 
-	inputContext, err := Context(plan)
+	inputContext, err := Context(option, plan)
 	if err != nil {
 		return err
 	}
@@ -83,7 +83,7 @@ func runOSCAL2Policy(ctx context.Context, option *Options) error {
 		return err
 	}
 
-	pluginCtx, cancel := context.WithTimeout(ctx, pluginTimeout)
+	pluginCtx, cancel := context.WithTimeout(ctx, maxTimeout(option))
 	defer cancel()
 
 	err = actions.GeneratePolicy(pluginCtx, inputContext, launchedPlugins)

cmd/c2pcli/cli/subcommands/result2oscal.go

@@ -66,7 +66,7 @@ func runResult2Policy(ctx context.Context, option *Options) error {
 	if err != nil {
 		return err
 	}
-	inputContext, err := Context(plan)
+	inputContext, err := Context(option, plan)
 	if err != nil {
 		return err
 	}
@@ -90,7 +90,7 @@ func runResult2Policy(ctx context.Context, option *Options) error {
 		return err
 	}
 
-	pluginCtx, cancel := context.WithTimeout(ctx, pluginTimeout)
+	pluginCtx, cancel := context.WithTimeout(ctx, maxTimeout(option))
 	defer cancel()
 
 	results, err := actions.AggregateResults(pluginCtx, inputContext, launchedPlugins)

docs/c2p-config.yaml

@@ -13,3 +13,5 @@ plugins:
     policy-results-dir: ./internal/testdata/kyverno/policy-reports
     temp-dir: /tmp/kyverno
     output-dir: /tmp/outputs
+advanced:
+  max-plugin-timeout: 3