v1alpha2

type CleanupOptions struct {
	// If set, do not delete the resources after running a test.
	// +optional
	SkipDelete bool `json:"skipDelete,omitempty"`

	// DelayBeforeCleanup adds a delay between the time a test ends and the time cleanup starts.
	// +optional
	DelayBeforeCleanup *metav1.Duration `json:"delayBeforeCleanup,omitempty"`
}

type Clusters = v1alpha1.Clusters

type Compiler = v1alpha1.Compiler

type Configuration struct {
	metav1.TypeMeta `json:",inline"`

	// Standard object's metadata.
	// +optional
	metav1.ObjectMeta `json:"metadata"`

	// Configuration spec.
	Spec ConfigurationSpec `json:"spec"`
}

type ConfigurationSpec struct {
	// Cleanup contains cleanup configuration.
	// +optional
	// +kubebuilder:default:={}
	Cleanup CleanupOptions `json:"cleanup"`

	// Clusters holds a registry to clusters to support multi-cluster tests.
	// +optional
	Clusters Clusters `json:"clusters"`

	// Deletion contains the global deletion configuration.
	// +optional
	// +kubebuilder:default:={}
	Deletion DeletionOptions `json:"deletion"`

	// Discovery contains tests discovery configuration.
	// +optional
	// +kubebuilder:default:={}
	Discovery DiscoveryOptions `json:"discovery"`

	// Error contains the global error configuration.
	// +optional
	// +kubebuilder:default:={}
	Error ErrorOptions `json:"error"`

	// Execution contains tests execution configuration.
	// +optional
	// +kubebuilder:default:={}
	Execution ExecutionOptions `json:"execution"`

	// Namespace contains properties for the namespace to use for tests.
	// +optional
	// +kubebuilder:default:={}
	Namespace NamespaceOptions `json:"namespace"`

	// Report contains properties for the report.
	// +optional
	Report *ReportOptions `json:"report,omitempty"`

	// Templating contains the templating config.
	// +optional
	// +kubebuilder:default:={}
	Templating TemplatingOptions `json:"templating"`

	// Global timeouts configuration. Applies to all tests/test steps if not overridden.
	// +optional
	// +kubebuilder:default:={}
	Timeouts DefaultTimeouts `json:"timeouts"`
}

type DefaultTimeouts = v1alpha1.DefaultTimeouts

type DeletionOptions struct {
	// Propagation decides if a deletion will propagate to the dependents of
	// the object, and how the garbage collector will handle the propagation.
	// +optional
	// +kubebuilder:validation:Enum:=Orphan;Background;Foreground
	// +kubebuilder:default:=Background
	Propagation metav1.DeletionPropagation `json:"propagation,omitempty"`
}

type DiscoveryOptions struct {
	// ExcludeTestRegex is used to exclude tests based on a regular expression.
	// +optional
	ExcludeTestRegex string `json:"excludeTestRegex,omitempty"`

	// IncludeTestRegex is used to include tests based on a regular expression.
	// +optional
	IncludeTestRegex string `json:"includeTestRegex,omitempty"`

	// TestFile is the name of the file containing the test to run.
	// If no extension is provided, chainsaw will try with .yaml first and .yml if needed.
	// +optional
	// +kubebuilder:default:="chainsaw-test"
	TestFile string `json:"testFile,omitempty"`

	// FullName makes use of the full test case folder path instead of the folder name.
	// +optional
	FullName bool `json:"fullName,omitempty"`
}

type ErrorOptions struct {
	// Catch defines what the tests steps will execute when an error happens.
	// This will be combined with catch handlers defined at the test and step levels.
	// +optional
	Catch []v1alpha1.CatchFinally `json:"catch,omitempty"`
}

type ExecutionOptions struct {
	// FailFast determines whether the test should stop upon encountering the first failure.
	// +optional
	FailFast bool `json:"failFast,omitempty"`

	// The maximum number of tests to run at once.
	// +kubebuilder:validation:Format:=int
	// +kubebuilder:validation:Minimum:=1
	// +optional
	Parallel *int `json:"parallel,omitempty"`

	// RepeatCount indicates how many times the tests should be executed.
	// +kubebuilder:validation:Format:=int
	// +kubebuilder:validation:Minimum:=1
	// +optional
	RepeatCount *int `json:"repeatCount,omitempty"`

	// ForceTerminationGracePeriod forces the termination grace period on pods, statefulsets, daemonsets and deployments.
	// +optional
	ForceTerminationGracePeriod *metav1.Duration `json:"forceTerminationGracePeriod,omitempty"`
}

type NamespaceOptions struct {
	// Name defines the namespace to use for tests.
	// If not specified, every test will execute in a random ephemeral namespace
	// unless the namespace is overridden in a the test spec.
	// +optional
	Name string `json:"name,omitempty"`

	// Compiler defines the default compiler to use when evaluating expressions.
	// +optional
	Compiler *Compiler `json:"compiler,omitempty"`

	// Template defines a template to create the test namespace.
	// +optional
	Template *Projection `json:"template,omitempty"`
}

type Projection = v1alpha1.Projection

type ReportFormatType string

type ReportOptions struct {
	// ReportFormat determines test report format (JSON, XML, JUNIT-TEST, JUNIT-STEP, JUNIT-OPERATION).
	// +optional
	// +kubebuilder:validation:Enum:=JSON;XML;JUNIT-TEST;JUNIT-STEP;JUNIT-OPERATION
	// +kubebuilder:default:="JSON"
	Format ReportFormatType `json:"format,omitempty"`

	// ReportPath defines the path.
	// +optional
	Path string `json:"path,omitempty"`

	// ReportName defines the name of report to create. It defaults to "chainsaw-report".
	// +optional
	// +kubebuilder:default:="chainsaw-report"
	Name string `json:"name,omitempty"`
}

type TemplatingOptions struct {
	// Enabled determines whether resources should be considered for templating.
	// +optional
	// +kubebuilder:default:=true
	Enabled bool `json:"enabled"`

	// Compiler defines the default compiler to use when evaluating expressions.
	// +optional
	Compiler *Compiler `json:"compiler,omitempty"`
}