e2e

type CliTestSuite struct {
	// The path of the directory containing the test cases.
	TestDataPath string
	// SearchAndReplace contains (search, replace) pairs that will be applied to the command output before comparison.
	SearchAndReplace map[string]string
	// GitServerURL is the URL of the git server to use for the tests.
	GitServerURL string
	// PorchctlCommand is the full path to the porchctl command to be tested.
	PorchctlCommand string
	// DeleteNamespaceFunc is the function used to clean up test namespaces.
	// Defaults to KubectlDeleteNamespace. Override for v1alpha2 to handle CRD finalizers.
	DeleteNamespaceFunc func(t *testing.T, name string)
}

type Command struct {
	// Args is a list of args for the kpt CLI.
	Args []string `yaml:"args,omitempty"`
	// StdIn contents will be passed as the command's standard input, if not empty.
	Stdin string `yaml:"stdin,omitempty"`
	// StdOut is the standard output expected from the command.
	Stdout string `yaml:"stdout,omitempty"`
	// StdErr is the standard error output expected from the command.
	Stderr string `yaml:"stderr,omitempty"`
	// ExitCode is the expected exit code frm the command.
	ExitCode int `yaml:"exitCode,omitempty"`
	// Yaml indicates that stdout is yaml and the test will reformat it for stable ordering
	Yaml bool `yaml:"yaml,omitempty"`
	// IgnoreWhitespace indicates that whitespace differences should be ignored in the output
	IgnoreWhitespace bool `yaml:"ignoreWhitespace,omitempty"`
	// IgnoreColumns lists column names to strip from both expected and actual table output
	// before comparison. Useful for non-deterministic columns like AGE.
	IgnoreColumns []string `yaml:"ignoreColumns,omitempty"`
	// StdErrTabToWhitespace replaces "\t" (tab) character with whitespace "  "
	StdErrTabToWhitespace bool `yaml:"stdErrTabToWhitespace,omitempty"`
	// ContainsErrorString changes Stderr check from exact string match to contains string match
	ContainsErrorString bool `yaml:"containsErrorString,omitempty"`
	// WaitForReady waits for the PackageRevision named in stdout to become Ready.
	// Use for v1alpha2 async operations (clone, init, copy, push, etc.).
	WaitForReady bool `yaml:"waitForReady,omitempty"`
	// WaitForPublished waits for the PackageRevision named in stdout to be Published
	// with a non-zero status.revision. Use after approve commands where downstream
	// consumers need the revision number to be set.
	WaitForPublished bool `yaml:"waitForPublished,omitempty"`
}

type TestCaseConfig struct {
	// TestCase is the name of the test case.
	TestCase string `yaml:"-"`
	// ConfigFile stores the name of the config file from which the config was loaded.
	// Used when generating or updating golden files.
	ConfigFile string `yaml:"-"`
	// UsesPorchTestRepo indicates if this test modifies the porch-test repo and needs it recreated after
	UsesPorchTestRepo bool `yaml:"usesPorchTestRepo,omitempty"`
	// Commands is a list of porchctl commands to be executed by the test.
	Commands []Command `yaml:"commands,omitempty"`
	// Skip the test? If the value is not empty, it will be used as a message with which to skip the test.
	Skip string `yaml:"skip,omitempty"`
}