workflows

type Action struct {
	Identifier    string         `yaml:"Identifier"`
	DependsOn     []string       `yaml:"DependsOn"`
	Configuration map[string]any `yaml:"Configuration"`
	Inputs        struct {
		Sources   []string `yaml:"Sources"`
		Artifacts []string `yaml:"Artifacts"`
		Variables []struct {
			Name  string `yaml:"Name"`
			Value string `yaml:"Value"`
		} `yaml:"Variables"`
	} `yaml:"Inputs"`
	Outputs struct {
		Sources   []string          `yaml:"Sources"`
		Artifacts []*OutputArtifact `yaml:"Artifacts"`
		Variables []string          `yaml:"Variables"`
	} `yaml:"Outputs"`
	Caching struct {
		FileCaching FileCaching `yaml:"FileCaching"`
	} `yaml:"Caching"`
	Environment struct {
		Name        string `yaml:"Name"`
		Connections []struct {
			Name string `yaml:"Name"`
			Role string `yaml:"Role"`
		} `yaml:"Connections"`
	} `yaml:"Environment"`
}

type ActionGroup struct {
	Actions map[string]*Action `yaml:"Actions"`
}

type ActionOrGroup struct {
	Action      `yaml:",inline"`
	ActionGroup `yaml:",inline"`
}

type FileCacheDirProvider func(ctx context.Context, plan runner.Plan) (string, error)

type FileCaching map[string]FileCachingEntry

type FileCachingEntry struct {
	Path        string   `yaml:"Path"`        // Path to cache
	RestoreKeys []string `yaml:"RestoreKeys"` // Fallback cache keys if this one misses
}

type Location struct {
	URI       string // uri of the location
	StartLine *int   `json:",omitempty"` // first line number of a location
	EndLine   *int   `json:",omitempty"` // last line number of a location
	Snippet   string // portion of the artifact identified in the location
}

type NewWorkflowFeaturesProviderParams struct {
	runner.EnvironmentConfiguration                   // The configuration of the environments
	OutputMode                      OutputMode        // Mode to use for output
	NoOutput                        bool              // Disable output from the action execution
	NoCache                         bool              // Disable file caches
	Dryrun                          bool              // Dryrun skips execution of the action
	BindWorkingDir                  bool              // BindWorkingDir will mount the working directory into the container, rather than copying
	EnvironmentProfiles             map[string]string // Map of workflow environment names to AWS CLI profile names
	Workflow                        *Workflow         // Workflow to load features for
	SecretProvider                  SecretProvider    // Secret provider to use for secrets
}

type NewWorkflowPlansProviderParams struct {
	ExecutionType runner.ExecutionType // The [ExecutionType] to use in the created plans
	WorkingDir    string               // The working directory to use for each plan
	Action        string               // the name of the action to run
	Workflow      *Workflow            // The [Workflow] to use
}

type OutputArtifact struct {
	Name  string `yaml:"Name"`  // Name of the output artifact
	Files any    `yaml:"Files"` // List of file patterns to include
}

type OutputMode string

type Report struct {
	Result          Result          `json:"codecatalyst_action_result"`                   // result of the report
	PassRate        *float32        `json:"codecatalyst_action_passRate,omitempty"`       // number between 0 and 100 representing the percentage of tests that passed
	LineCoverage    *float32        `json:"codecatalyst_action_lineCoverage,omitempty"`   // number between 0 and 100 representing the percentage of lines that were covered by tests
	BranchCoverage  *float32        `json:"codecatalyst_action_branchCoverage,omitempty"` // number between 0 and 100 representing the percentage of branches that were covered by tests
	Vulnerabilities []Vulnerability `json:"codecatalyst_action_vulnerabilities"`          // list of vulnerabilities found
}

type Result string

type RunParams struct {
	NewWorkflowPlansProviderParams
	NewWorkflowFeaturesProviderParams
	Concurrency  int
	WorkflowPath string
	WorkflowName string
}

type SecretProvider interface {
	GetSecret(ctx context.Context, name string) (string, error)
}

type SuccessCriteria struct {
	PassRate               float32               `yaml:"passRate"`               // number between 0 and 100 representing the percentage of tests that must pass
	LineCoverage           float32               `yaml:"lineCoverage"`           // number between 0 and 100 representing the percentage of lines that must be covered by tests
	BranchCoverage         float32               `yaml:"branchCoverage"`         // number between 0 and 100 representing the percentage of branches that must be covered by tests
	VulnerabilityThreshold VulnerabilitySeverity `yaml:"vulnerabilityThreshold"` // the max severity of the vulnerabilities allowed
}

type Suppression struct {
	Kind          string // type of suppression, one of: inSource or external
	Justification string // user-supplied string explaining why the result was suppressed
}

type Vulnerability struct {
	Severity     VulnerabilitySeverity // severity of the vulnerability
	RuleID       string                // ID of the rule that found the vulnerability
	Message      string                // description of the vulnerability
	Locations    []Location            // locations of the vulnerability
	Suppressions []Suppression         // list of suppressions applied to the vulnerability
}

type VulnerabilitySeverity string

type Workflow struct {
	Path          string        `yaml:"-"`
	Name          string        `yaml:"Name"`
	SchemaVersion string        `yaml:"SchemaVersion"`
	Actions       yaml.MapSlice `yaml:"Actions"`
	Compute       struct {
		Type           string `yaml:"Type"`
		SharedInstance bool   `yaml:"SharedInstance"`
	} `yaml:"Compute"`
}