From 721c8dd98f42b3f854237add45d18af5778f3156 Mon Sep 17 00:00:00 2001 From: <> Date: Sun, 29 Oct 2023 22:18:52 +0000 Subject: [PATCH] Deployed 6590ccf with MkDocs version: 1.5.3 --- .nojekyll | 0 404.html | 1 + apis/chainsaw.v1alpha1/index.html | 1 + assets/images/favicon.png | Bin 0 -> 1870 bytes assets/javascripts/bundle.aecac24b.min.js | 29 + assets/javascripts/bundle.aecac24b.min.js.map | 7 + assets/javascripts/lunr/min/lunr.ar.min.js | 1 + assets/javascripts/lunr/min/lunr.da.min.js | 18 + assets/javascripts/lunr/min/lunr.de.min.js | 18 + assets/javascripts/lunr/min/lunr.du.min.js | 18 + assets/javascripts/lunr/min/lunr.el.min.js | 1 + assets/javascripts/lunr/min/lunr.es.min.js | 18 + assets/javascripts/lunr/min/lunr.fi.min.js | 18 + assets/javascripts/lunr/min/lunr.fr.min.js | 18 + assets/javascripts/lunr/min/lunr.he.min.js | 1 + assets/javascripts/lunr/min/lunr.hi.min.js | 1 + assets/javascripts/lunr/min/lunr.hu.min.js | 18 + assets/javascripts/lunr/min/lunr.hy.min.js | 1 + assets/javascripts/lunr/min/lunr.it.min.js | 18 + assets/javascripts/lunr/min/lunr.ja.min.js | 1 + assets/javascripts/lunr/min/lunr.jp.min.js | 1 + assets/javascripts/lunr/min/lunr.kn.min.js | 1 + assets/javascripts/lunr/min/lunr.ko.min.js | 1 + assets/javascripts/lunr/min/lunr.multi.min.js | 1 + assets/javascripts/lunr/min/lunr.nl.min.js | 18 + assets/javascripts/lunr/min/lunr.no.min.js | 18 + assets/javascripts/lunr/min/lunr.pt.min.js | 18 + assets/javascripts/lunr/min/lunr.ro.min.js | 18 + assets/javascripts/lunr/min/lunr.ru.min.js | 18 + assets/javascripts/lunr/min/lunr.sa.min.js | 1 + .../lunr/min/lunr.stemmer.support.min.js | 1 + assets/javascripts/lunr/min/lunr.sv.min.js | 18 + assets/javascripts/lunr/min/lunr.ta.min.js | 1 + assets/javascripts/lunr/min/lunr.te.min.js | 1 + assets/javascripts/lunr/min/lunr.th.min.js | 1 + assets/javascripts/lunr/min/lunr.tr.min.js | 18 + assets/javascripts/lunr/min/lunr.vi.min.js | 1 + assets/javascripts/lunr/min/lunr.zh.min.js | 1 + assets/javascripts/lunr/tinyseg.js | 206 + assets/javascripts/lunr/wordcut.js | 6708 +++++++++++++++++ .../workers/search.f886a092.min.js | 42 + .../workers/search.f886a092.min.js.map | 7 + assets/stylesheets/main.4b4a2bd9.min.css | 1 + assets/stylesheets/main.4b4a2bd9.min.css.map | 1 + assets/stylesheets/palette.356b1318.min.css | 1 + .../stylesheets/palette.356b1318.min.css.map | 1 + .../index.html | 71 + blog/archive/2023/index.html | 71 + blog/category/announcements/index.html | 1 + blog/category/writing-tests/index.html | 71 + blog/first-test/index.html | 60 + blog/img/chainsaw.png | Bin 0 -> 685790 bytes blog/index.html | 71 + blog/wip/index.html | 1 + commands/chainsaw/index.html | 3 + commands/chainsaw_completion/index.html | 2 + commands/chainsaw_completion_bash/index.html | 7 + commands/chainsaw_completion_fish/index.html | 6 + .../chainsaw_completion_powershell/index.html | 5 + commands/chainsaw_completion_zsh/index.html | 8 + commands/chainsaw_docs/index.html | 6 + commands/chainsaw_kuttl/index.html | 3 + commands/chainsaw_kuttl_migrate/index.html | 5 + commands/chainsaw_test/index.html | 36 + commands/chainsaw_version/index.html | 3 + index.html | 98 + install/index.html | 8 + intro/index.html | 1 + more/crds/index.html | 32 + more/events/index.html | 10 + more/ide-completion/index.html | 4 + more/kuttl-migration/index.html | 6 + overrides/home.html | 128 + overrides/main.html | 22 + quick-start/index.html | 72 + search/search_index.json | 1 + sitemap.xml | 193 + sitemap.xml.gz | Bin 0 -> 530 bytes static/Kyverno_320x320.png | Bin 0 -> 19721 bytes static/WIP.jpg | Bin 0 -> 25332 bytes static/extra.css | 4 + static/favicon.ico | Bin 0 -> 1150 bytes tests/collectors/commands/index.html | 57 + tests/collectors/events/index.html | 92 + tests/collectors/index.html | 20 + tests/collectors/pod-logs/index.html | 126 + tests/collectors/scripts/index.html | 34 + tests/configuration/index.html | 26 + tests/index.html | 1 + tests/what-is-a-test/index.html | 21 + tests/with-manifests/index.html | 19 + tests/with-test-steps/index.html | 45 + tests/with-test/index.html | 32 + 93 files changed, 8774 insertions(+) create mode 100644 .nojekyll create mode 100644 404.html create mode 100644 apis/chainsaw.v1alpha1/index.html create mode 100644 assets/images/favicon.png create mode 100644 assets/javascripts/bundle.aecac24b.min.js create mode 100644 assets/javascripts/bundle.aecac24b.min.js.map create mode 100644 assets/javascripts/lunr/min/lunr.ar.min.js create mode 100644 assets/javascripts/lunr/min/lunr.da.min.js create mode 100644 assets/javascripts/lunr/min/lunr.de.min.js create mode 100644 assets/javascripts/lunr/min/lunr.du.min.js create mode 100644 assets/javascripts/lunr/min/lunr.el.min.js create mode 100644 assets/javascripts/lunr/min/lunr.es.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.fr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.he.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hu.min.js create mode 100644 assets/javascripts/lunr/min/lunr.hy.min.js create mode 100644 assets/javascripts/lunr/min/lunr.it.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ja.min.js create mode 100644 assets/javascripts/lunr/min/lunr.jp.min.js create mode 100644 assets/javascripts/lunr/min/lunr.kn.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ko.min.js create mode 100644 assets/javascripts/lunr/min/lunr.multi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.nl.min.js create mode 100644 assets/javascripts/lunr/min/lunr.no.min.js create mode 100644 assets/javascripts/lunr/min/lunr.pt.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ro.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ru.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sa.min.js create mode 100644 assets/javascripts/lunr/min/lunr.stemmer.support.min.js create mode 100644 assets/javascripts/lunr/min/lunr.sv.min.js create mode 100644 assets/javascripts/lunr/min/lunr.ta.min.js create mode 100644 assets/javascripts/lunr/min/lunr.te.min.js create mode 100644 assets/javascripts/lunr/min/lunr.th.min.js create mode 100644 assets/javascripts/lunr/min/lunr.tr.min.js create mode 100644 assets/javascripts/lunr/min/lunr.vi.min.js create mode 100644 assets/javascripts/lunr/min/lunr.zh.min.js create mode 100644 assets/javascripts/lunr/tinyseg.js create mode 100644 assets/javascripts/lunr/wordcut.js create mode 100644 assets/javascripts/workers/search.f886a092.min.js create mode 100644 assets/javascripts/workers/search.f886a092.min.js.map create mode 100644 assets/stylesheets/main.4b4a2bd9.min.css create mode 100644 assets/stylesheets/main.4b4a2bd9.min.css.map create mode 100644 assets/stylesheets/palette.356b1318.min.css create mode 100644 assets/stylesheets/palette.356b1318.min.css.map create mode 100644 blog/How-to-Perform-Efficient-E2E-Testing-with-Chainsaw/index.html create mode 100644 blog/archive/2023/index.html create mode 100644 blog/category/announcements/index.html create mode 100644 blog/category/writing-tests/index.html create mode 100644 blog/first-test/index.html create mode 100644 blog/img/chainsaw.png create mode 100644 blog/index.html create mode 100644 blog/wip/index.html create mode 100644 commands/chainsaw/index.html create mode 100644 commands/chainsaw_completion/index.html create mode 100644 commands/chainsaw_completion_bash/index.html create mode 100644 commands/chainsaw_completion_fish/index.html create mode 100644 commands/chainsaw_completion_powershell/index.html create mode 100644 commands/chainsaw_completion_zsh/index.html create mode 100644 commands/chainsaw_docs/index.html create mode 100644 commands/chainsaw_kuttl/index.html create mode 100644 commands/chainsaw_kuttl_migrate/index.html create mode 100644 commands/chainsaw_test/index.html create mode 100644 commands/chainsaw_version/index.html create mode 100644 index.html create mode 100644 install/index.html create mode 100644 intro/index.html create mode 100644 more/crds/index.html create mode 100644 more/events/index.html create mode 100644 more/ide-completion/index.html create mode 100644 more/kuttl-migration/index.html create mode 100644 overrides/home.html create mode 100644 overrides/main.html create mode 100644 quick-start/index.html create mode 100644 search/search_index.json create mode 100644 sitemap.xml create mode 100644 sitemap.xml.gz create mode 100644 static/Kyverno_320x320.png create mode 100644 static/WIP.jpg create mode 100644 static/extra.css create mode 100644 static/favicon.ico create mode 100644 tests/collectors/commands/index.html create mode 100644 tests/collectors/events/index.html create mode 100644 tests/collectors/index.html create mode 100644 tests/collectors/pod-logs/index.html create mode 100644 tests/collectors/scripts/index.html create mode 100644 tests/configuration/index.html create mode 100644 tests/index.html create mode 100644 tests/what-is-a-test/index.html create mode 100644 tests/with-manifests/index.html create mode 100644 tests/with-test-steps/index.html create mode 100644 tests/with-test/index.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/404.html b/404.html new file mode 100644 index 000000000..31f2c0c25 --- /dev/null +++ b/404.html @@ -0,0 +1 @@ +
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group.
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 | ||
shouldFail | bool | ShouldFail determines whether applying the file is expected to fail. | ||
continueOnError | bool | 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. |
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. | ||
continueOnError | bool | 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. |
Collect
¶Appears in:
Collect defines a set of collectors.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
podLogs | PodLogs | PodLogs determines the pod logs collector to execute. | ||
events | Events | Events determines the events collector to execute. |
Command
¶Appears in:
Command describes a command to run as a part of a test step.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
entrypoint | string | Entrypoint is the command entry point to run. | ||
args | []string | Args is the command arguments. |
ConfigurationSpec
¶Appears in:
ConfigurationSpec contains the configuration used to run tests.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
timeout | meta/v1.Duration | Global timeout configuration. Applies to all tests/test steps if not overridden. | ||
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. If not specified, every test will execute in a random ephemeral namespace unless the namespace is overridden in a the test spec. | ||
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 |
---|---|---|---|---|
ObjectReference | ObjectReference | ObjectReference determines objects to be deleted. | ||
continueOnError | bool | 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. |
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. | ||
continueOnError | bool | 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. |
Events
¶Appears in:
Events defines how to collects events.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
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 | ||
selector | string | Selector defines labels selector. |
Exec
¶Appears in:
Exec describes a command or script.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
timeout | meta/v1.Duration | Timeout for the command. Overrides the global timeout set in the Configuration. | ||
command | Command | Command defines a command to run. | ||
script | Script | Script defines a script to run. |
ExecOperation
¶Appears in:
Exec describes a command and/or script operation.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
Exec | Exec | Exec defines the command and/or script. | ||
skipLogOutput | bool | SkipLogOutput removes the output from the command. Useful for sensitive logs or to reduce noise. | ||
continueOnError | bool | 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. |
FileRef
¶Appears in:
FileRef represents a file reference.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
file | string | File is the path to the referenced file. |
ObjectReference
¶Appears in:
ObjectReference represents one or more objects with a specific apiVersion and kind. For a single object name and namespace are used to identify the object. For multiple objects use labels.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
ObjectSelector | ObjectSelector | ObjectSelector determines the selection process of referenced objects. | ||
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 |
ObjectSelector
¶Appears in:
ObjectSelector represents a strategy to select objects. For a single object name and namespace are used to identify the object. For multiple objects use labels.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
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 |
OnFailure
¶Appears in:
OnFailure defines actions to be executed on failure.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
collect | Collect | Collect define the collectors to run. | ||
exec | Exec | Exec define the commands and/or scripts to run. |
PodLogs
¶Appears in:
PodLogs defines how to collects pod logs.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
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 | ||
selector | string | Selector defines labels selector. | ||
container | string | Container in pod to get logs from else --all-containers is used. | ||
tail | int | 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 |
ReportFormatType
¶(Alias of string
)
Appears in:
Script
¶Appears in:
Script describes a script to run as a part of a test step.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
content | string | Content defines a shell script (run with "sh -c ..."). |
TestSpec
¶Appears in:
TestSpec contains the test spec.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
timeout | meta/v1.Duration | Timeout for the test. Overrides the global timeout set in the Configuration. | ||
skip | bool | Skip determines whether the test should skipped. | ||
concurrent | bool | Concurrent determines whether the test should run concurrently with other tests. | ||
skipDelete | bool | SkipDelete determines whether the resources created by the test should be deleted after the test is executed. | ||
namespace | string | Namespace determines whether the test should run in a random ephemeral namespace or not. | ||
steps | []TestSpecStep | Steps defining the test. |
TestSpecStep
¶Appears in:
TestSpecStep contains the test step definition used in a test spec.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
name | string | Name of the step. | ||
spec | TestStepSpec | Spec of the step. |
TestStepSpec
¶Appears in:
TestStepSpec defines the desired state and behavior for each test step.
Field | Type | Required | Inline | Description |
---|---|---|---|---|
timeout | meta/v1.Duration | Timeout for the test step. Overrides the global timeout set in the Configuration and the timeout eventually set in the Test. | ||
skipDelete | bool | SkipDelete determines whether the resources created by the step should be deleted after the test step is executed. | ||
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. | ||
exec | []ExecOperation | Exec provides a list of commands and/or scripts that should be executed as a part of this test step. | ||
onFailure | []OnFailure | OnFailure defines actions to be executed in case of step failure. |
{"use strict";/*!
+ * escape-html
+ * Copyright(c) 2012-2013 TJ Holowaychuk
+ * Copyright(c) 2015 Andreas Lubbe
+ * Copyright(c) 2015 Tiancheng "Timothy" Gu
+ * MIT Licensed
+ */var Ha=/["'&<>]/;Un.exports=$a;function $a(e){var t=""+e,r=Ha.exec(t);if(!r)return t;var o,n="",i=0,s=0;for(i=r.index;i