From 1c3e01d601dcfcd58197e237bcce8fb198b49bbe Mon Sep 17 00:00:00 2001 From: Hiroki Okui Date: Mon, 23 Sep 2024 20:58:19 +0900 Subject: [PATCH] docs: Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d6d1d50..4c37490 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ testSuites: group: # Optional version: # Optional kind: # Required - namespace: # Optional: it is needed to match with namespaced resource + namespace: # Optional: It is needed to match with a resource whose namespace is set. name: # Required oldObject: group: # Optional @@ -91,7 +91,7 @@ testSuites: expect: ``` -Resources specified in the `object`, `oldObject`, and `params` fields of the test cases, as well as `Namespace` resources, must be described in the YAML files specified in `resources` field. +Resources specified in the `object`, `oldObject`, `params`, and `namespace` fields of the test cases must be described in the YAML files specified in the `resources` field. ### Run test @@ -101,7 +101,7 @@ The tests defined in the above manifest can be run with the following command: kaptest run ... ``` -You can specify multiple YAML files to display the test results together. +You can run test cases of multiple YAML files at once and display the test results together. ### Operation Type @@ -116,7 +116,7 @@ You can describe the cases for CREATE, UPDATE, and DELETE operations based on wh Kaptest focuses on evaluating CEL expressions, so even when an error occurs or `matchConditions` are not met it does not change the result to `allow` or `deny`. The test results of Kaptest will be one of the following four values: - **allow**: When all `matchConditions` and `validations` are evaluated as `true` -- **deny**: When all `matchConditions` are are evaluated as `true`, and at least one `validation` is evaluated as `false` +- **deny**: When all `matchConditions` are evaluated as `true`, and at least one `validation` is evaluated as `false` - **skip**: When at least one `matchCondition` is evaluated as `false` - **error**: When at least one `matchCondition` or `validation` cannot be evaluated