v1alpha1

Standard object's metadata.

Configuration spec.

Standard object's metadata.

Test step spec.

Standard object's metadata.

Test spec.

Bindings defines additional binding key/values.

Check is an assertion tree to validate the operation outcome.

Check provides a check used in assertions.

Template determines whether resources should be considered for templating.

Cluster defines the target cluster (will be inherited if not specified).

Clusters holds a registry to clusters to support multi-cluster tests.

DryRun determines whether the file should be applied in dry run mode.

Env defines additional environment variables.

SkipLogOutput removes the output from the command. Useful for sensitive logs or to reduce noise.

Expect defines a list of matched checks to validate the operation outcome.

Format determines the output format (json or yaml).

Selector defines labels selector.

Outputs defines output bindings.

Resource provides a resource to be applied.

Template determines whether resources should be considered for templating.

Timeout for the operation. Overrides the global timeout set in the Configuration.

Name the name of the binding.

Compiler defines the default compiler to use when evaluating expressions.

Value value of the binding.

Description contains a description of the operation.

Compiler defines the default compiler to use when evaluating expressions.

PodLogs determines the pod logs collector to execute.

Events determines the events collector to execute.

Describe determines the resource describe collector to execute.

Wait determines the resource wait collector to execute.

Get determines the resource get collector to execute.

Delete represents a deletion operation.

Command defines a command to run.

Script defines a script to run.

Sleep defines zzzz.

Entrypoint is the command entry point to run.

Args is the command arguments.

WorkDir is the working directory for command.

Global timeouts configuration. Applies to all tests/test steps if not overridden.

If set, do not delete the resources after running the tests (implies SkipClusterDelete).

Template determines whether resources should be considered for templating.

Compiler defines the default compiler to use when evaluating expressions.

FailFast determines whether the test should stop upon encountering the first failure.

The maximum number of tests to run at once.

DeletionPropagationPolicy decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation.

ReportFormat determines test report format (JSON

ReportPath defines the path.

ReportName defines the name of report to create. It defaults to "chainsaw-report".

Namespace 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.

NamespaceTemplateCompiler defines the default compiler to use when evaluating expressions.

NamespaceTemplate defines a template to create the test namespace.

FullName makes use of the full test case folder path instead of the folder name.

ExcludeTestRegex is used to exclude tests based on a regular expression.

IncludeTestRegex is used to include tests based on a regular expression.

RepeatCount indicates how many times the tests should be executed.

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.

ForceTerminationGracePeriod forces the termination grace period on pods, statefulsets, daemonsets and deployments.

DelayBeforeCleanup adds a delay between the time a test ends and the time cleanup starts.

Clusters holds a registry to clusters to support multi-cluster tests.

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.

Apply defines the timeout for the apply operation

Assert defines the timeout for the assert operation

Cleanup defines the timeout for the cleanup operation

Delete defines the timeout for the delete operation

Error defines the timeout for the error operation

Exec defines the timeout for exec operations

Template determines whether resources should be considered for templating.

File is the path to the referenced file. This can be a direct path to a file or an expression that matches multiple files, such as "manifest/*.yaml" for all YAML files within the "manifest" directory.

Ref determines objects to be deleted.

DeletionPropagationPolicy decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation. Overrides the deletion propagation policy set in the Configuration, the Test and the TestStep.

Show Events indicates whether to include related events.

Match defines the matching statement.

Check defines the verification statement.

File is the path to the referenced file. This can be a direct path to a file or an expression that matches multiple files, such as "manifest/*.yaml" for all YAML files within the "manifest" directory.

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Label selector to match objects to delete

API version of the referent.

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

OperationBase defines common elements to all operations.

Apply represents resources that should be applied for this test step. This can include things like configuration settings or any other resources that need to be available during the test.

Assert represents an assertion to be made. It checks whether the conditions specified in the assertion hold true.

Command defines a command to run.

Create represents a creation operation.

Delete represents a deletion operation.

Describe determines the resource describe collector to execute.

Error represents the expected errors for this test step. If any of these errors occur, the test will consider them as expected; otherwise, they will be treated as test failures.

Events determines the events collector to execute.

Get determines the resource get collector to execute.

Patch represents a patch operation.

PodLogs determines the pod logs collector to execute.

Proxy runs a proxy request.

Script defines a script to run.

Sleep defines zzzz.

Update represents an update operation.

Wait determines the resource wait collector to execute.

Description contains a description of the operation.

ContinueOnError determines whether a test should continue or not in case the operation was not successful. Even if the test continues executing, it will still be reported as failed.

Compiler defines the default compiler to use when evaluating expressions.

Binding determines the binding to create when the match succeeds.

Match defines the matching statement.

Container in pod to get logs from else --all-containers is used.

Tail is the number of last lines to collect from pods. If omitted or zero, then the default is 10 if you use a selector, or -1 (all) if you use a pod name. This matches default behavior of kubectl logs.

TargetPort defines the target port to proxy the request.

TargetPath defines the target path to proxy the request.

Bindings defines binding key/values.

Content defines a shell script (run with "sh -c ...").

WorkDir is the working directory for script.

Duration is the delay used for sleeping.

Bindings defines additional binding key/values.

Try defines what the step will try to execute.

Catch defines what the step will execute when an error happens.

Finally defines what the step will execute after the step is terminated.

Cleanup defines what will be executed after the test is terminated.

Description contains a description of the test.

FailFast determines whether the test should stop upon encountering the first failure.

Timeouts for the test. Overrides the global timeouts set in the Configuration on a per operation basis.

Cluster defines the target cluster (will be inherited if not specified).

Clusters holds a registry to clusters to support multi-cluster tests.

Skip determines whether the test should skipped.

Concurrent determines whether the test should run concurrently with other tests.

SkipDelete determines whether the resources created by the test should be deleted after the test is executed.

Template determines whether resources should be considered for templating.

Compiler defines the default compiler to use when evaluating expressions.

Namespace determines whether the test should run in a random ephemeral namespace or not.

NamespaceTemplate defines a template to create the test namespace.

NamespaceTemplateCompiler defines the default compiler to use when evaluating expressions.

Scenarios defines test scenarios.

Bindings defines additional binding key/values.

Steps defining the test.

Catch defines what the steps will execute when an error happens. This will be combined with catch handlers defined at the step level.

ForceTerminationGracePeriod forces the termination grace period on pods, statefulsets, daemonsets and deployments.

DelayBeforeCleanup adds a delay between the time a test ends and the time cleanup starts.

DeletionPropagationPolicy decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation. Overrides the deletion propagation policy set in the Configuration.

Name of the step.

Use defines a reference to a step template.

TestStepSpec of the step.

Description contains a description of the test step.

Timeouts for the test step. Overrides the global timeouts set in the Configuration and the timeouts eventually set in the Test.

DeletionPropagationPolicy decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation. Overrides the deletion propagation policy set in both the Configuration and the Test.

Cluster defines the target cluster (will be inherited if not specified).

Clusters holds a registry to clusters to support multi-cluster tests.

SkipDelete determines whether the resources created by the step should be deleted after the test step is executed.

Template determines whether resources should be considered for templating.

Compiler defines the default compiler to use when evaluating expressions.

Bindings defines additional binding key/values.

Try defines what the step will try to execute.

Catch defines what the step will execute when an error happens.

Finally defines what the step will execute after the step is terminated.

Cleanup defines what will be executed after the test is terminated.

Apply defines the timeout for the apply operation

Assert defines the timeout for the assert operation

Cleanup defines the timeout for the cleanup operation

Delete defines the timeout for the delete operation

Error defines the timeout for the error operation

Exec defines the timeout for exec operations

Template references a step template.

With defines arguments passed to the step template.

WaitFor specifies the condition to wait for.

Deletion specifies parameters for waiting on a resource's deletion.

Condition specifies the condition to wait for.

JsonPath specifies the json path condition to wait for.

Name defines the specific condition to wait for, e.g., "Available", "Ready".

Value defines the specific condition status to wait for, e.g., "True", "False".

Path defines the json path to wait for, e.g. '{.status.phase}'.

Value defines the expected value to wait for, e.g., "Running".

Bindings defines additional binding key/values.