iactest

Documentation

Index

• Constants
• Variables
• func DetermineInputPaths(args []string, cwd string) []string
• func GetIaCTestFlagSet() *pflag.FlagSet
• func GetPolicyFile(policyPathFlag string, rootDir string, logger *zerolog.Logger) string
• func NewUI(config UIConfig) *iacTestUI
• func RegisterWorkflows(e workflow.Engine) error
• func TestWorkflow(ictx workflow.InvocationContext, _ []workflow.Data) ([]workflow.Data, error)
• type ProjectAttributes
  • func GetProjectAttributes(config configuration.Configuration) ProjectAttributes
• type UIConfig

Constants

const (
	FlagReport                     = "report"
	FlagSeverityThreshold          = "severity-threshold"
	FlagIgnorePolicy               = "ignore-policy"
	FlagPolicyPath                 = "policy-path"
	FlagTargetReference            = "target-reference"
	FlagTargetName                 = "target-name"
	FlagRemoteRepoURL              = "remote-repo-url"
	FlagSnykCloudEnvironment       = "snyk-cloud-environment"
	FlagScan                       = "scan"
	FlagDepthDetection             = "detection-depth"
	FlagVarFile                    = "var-file"
	FlagJson                       = "json"
	FlagJsonFileOutput             = "json-file-output"
	FlagSarif                      = "sarif"
	FlagSarifFileOutput            = "sarif-file-output"
	FlagProjectBusinessCriticality = "project-business-criticality"
	FlagProjectEnvironment         = "project-environment"
	FlagProjectLifecycle           = "project-lifecycle"
	FlagProjectTags                = "project-tags"
	FlagRules                      = "rules"
)

const (
	LegacyFlagOutputFile = "iac-test-output-file"

	FeatureFlagNewEngine            = "iacNewEngine"
	FeatureFlagIntegratedExperience = "iacIntegratedExperience"

	// configuration keys.
	RulesClientURL  = "snyk_iac_rules_client_url"
	RulesBundlePath = "snyk_iac_bundle_path"

	DotSnykPolicy = ".snyk"
)

const (
	Title          = "Snyk Infrastructure As Code"
	ProgressText   = "Snyk testing Infrastructure as Code configuration issues."
	CompletionText = "Test completed."
)

Variables

var WorkflowID = workflow.NewWorkflowIdentifier("iac.test")

Functions

func DetermineInputPaths

func DetermineInputPaths(args []string, cwd string) []string

func GetIaCTestFlagSet

func GetIaCTestFlagSet() *pflag.FlagSet

func GetPolicyFile

func GetPolicyFile(policyPathFlag string, rootDir string, logger *zerolog.Logger) string

Preserves the original behavior for IaC+ in the CLI, found at: https://github.com/snyk/cli/blob/2051a6d38071a304dbef97784cfeac20c7f56d09/src/cli/commands/test/iac/v2/index.ts#L63

func NewUI

func NewUI(config UIConfig) *iacTestUI

func RegisterWorkflows

func RegisterWorkflows(e workflow.Engine) error

func TestWorkflow

func TestWorkflow(
	ictx workflow.InvocationContext,
	_ []workflow.Data,
) ([]workflow.Data, error)

Types

type ProjectAttributes

type ProjectAttributes struct {
	ProjectEnvironment         *string
	ProjectBusinessCriticality *string
	ProjectLifecycle           *string
	ProjectTags                *string
}

func GetProjectAttributes

func GetProjectAttributes(config configuration.Configuration) ProjectAttributes

type UIConfig

type UIConfig struct {
	Disabled bool
	Backend  ui.UserInterface
	Logger   *zerolog.Logger
}