v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group.
Resource Types¶
Configuration¶
Configuration is the resource that contains the configuration used to run tests.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
apiVersion | string |  | chainsaw.kyverno.io/v1alpha1 | |
kind | string | | Configuration | |
metadata | meta/v1.ObjectMeta | Standard object's metadata. | ||
spec | ConfigurationSpec | | Configuration spec. |
Test¶
Test is the resource that contains aa test definition.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
apiVersion | string | | chainsaw.kyverno.io/v1alpha1 | |
kind | string | | Test | |
metadata | meta/v1.ObjectMeta | Standard object's metadata. | ||
spec | TestSpec | | Test spec. |
TestStep¶
TestStep is the resource that contains the testStep used to run tests.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
apiVersion | string | | chainsaw.kyverno.io/v1alpha1 | |
kind | string | | TestStep | |
metadata | meta/v1.ObjectMeta | Standard object's metadata. | ||
spec | TestStepSpec | | TestStep spec. |
Apply¶
Appears in:
Apply represents a set of configurations or resources that should be applied during testing.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
FileRef | FileRef | | | FileRef provides a reference to the file containing the |
Assert¶
Appears in:
Assert represents a test condition that is expected to hold true during the testing process.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
FileRef | FileRef | | | FileRef provides a reference to the file containing the assertion. |
ConfigurationSpec¶
Appears in:
ConfigurationSpec contains the configuration used to run tests.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
timeout | meta/v1.Duration | Timeout per test step. | ||
testDirs | []string | Directories containing test cases to run. | ||
skipDelete | bool | If set, do not delete the resources after running the tests (implies SkipClusterDelete). | ||
failFast | bool | FailFast determines whether the test should stop upon encountering the first failure. | ||
parallel | int | | The maximum number of tests to run at once. | |
reportFormat | ReportFormatType | ReportFormat determines test report format (JSON | ||
reportName | string | ReportName defines the name of report to create. It defaults to "chainsaw-report". | ||
namespace | string | Namespace defines the namespace to use for tests. | ||
suppress | []string | Suppress is used to suppress logs. | ||
fullName | bool | FullName makes use of the full test case folder path instead of the folder name. | ||
excludeTestRegex | string | ExcludeTestRegex is used to exclude tests based on a regular expression. | ||
includeTestRegex | string | IncludeTestRegex is used to include tests based on a regular expression. | ||
repeatCount | int | RepeatCount indicates how many times the tests should be executed. |
Delete¶
Appears in:
Delete is a reference to an object that should be deleted
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
apiVersion | string | | API version of the referent. | |
kind | string | | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | |
namespace | string | Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | ||
name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names | ||
labels | map[string]string | Label selector to match objects to delete |
Error¶
Appears in:
Error represents an anticipated error condition that may arise during testing. Instead of treating such an error as a test failure, it acknowledges it as expected.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
FileRef | FileRef | | | FileRef provides a reference to the file containing the expected error. |
FileRef¶
Appears in:
FileRef represents a file reference.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
file | string | | File is the path to the referenced file. |
ReportFormatType¶
(Alias of string)
Appears in:
TestSpec¶
Appears in:
TestSpec contains the test spec.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
steps | []TestStepSpec | | Steps defining the test. |
TestStepSpec¶
Appears in:
TestStepSpec defines the desired state and behavior for each test step.
| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
assert | []Assert | Assert represents the assertions to be made for this test step. It checks whether the conditions specified in each assertion hold true. | ||
apply | []Apply | Apply lists the 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. | ||
error | []Error | Error lists 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. | ||
delete | []Delete | Delete provides a list of objects that should be deleted before this test step is executed. This helps in ensuring that the environment is set up correctly before the test step runs. |