feature: skip-if conditional scenario skip #5
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jaypipes
commented
Jul 28, 2023
| "github.com/gdt-dev/gdt/scenario" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func (s *fooSpec) Eval(ctx context.Context, t *testing.T) *result.Result { |
There was a problem hiding this comment.
note to @a-hilaly I just moved this into the scenario/stub_plugins_test.go file along with all the other stub plugin and spec definitions used in unit testing.
Adds support for `skip-if` collection of evaluable conditions for a
scenario. If any of these conditions succeed, the test will be skipped.
This allows test authors to specify "pre-flight checks" before
attempting any of the actions in the scenario's tests.
For example, let's assume you have a `gdt-kube` scenario that looks like
this:
```yaml
tests:
- kube.create: manifests/nginx-deployment.yaml
- kube:
get: deployments/nginx
assert:
matches:
status:
readyReplicas: 2
- kube.delete: deployments/nginx
```
If you execute the above test and there is already an 'nginx'
deployment, the `kube.create` test will fail. To prevent the scenario
from proceeding with the tests if an 'nginx' deployment already exists,
you could add the following
```yaml
skip-if:
- kube.get: deployments/nginx
tests:
- kube.create: manifests/nginx-deployment.yaml
- kube:
get: deployments/nginx
assert:
matches:
status:
readyReplicas: 2
- kube.delete: deployments/nginx
```
With the above, if an 'nginx' deployment exists already, the scenario
will skip all the tests.
Signed-off-by: Jay Pipes <[email protected]>
a-hilaly
approved these changes
Jul 28, 2023
| @@ -89,8 +89,9 @@ func (s *Scenario) UnmarshalYAML(node *yaml.Node) error { | |||
| return gdterrors.ExpectedScalarAt(keyNode) | |||
| } | |||
| key := keyNode.Value | |||
| if key == "tests" { | |||
| valNode := node.Content[i+1] | |||
| valNode := node.Content[i+1] | |||
There was a problem hiding this comment.
Still need to dig deeper in the yaml library to understand why we do i += 2 and not just a i++.
But overall looks good!
/lgtm
There was a problem hiding this comment.
@a-hilaly yeah, it's weird... see the comment above:
// maps/structs are stored in a top-level Node.Content field which is a
// concatenated slice of Node pointers in pairs of key/values.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds support for
skip-ifcollection of evaluable conditions for a scenario. If any of these conditions fails, the test will be skipped.SkipIf contains a list of evaluable conditions that must evaluate successfully before the scenario's tests are executed. This allows test authors to specify "pre-flight checks" that should pass before attempting any of the actions in the scenario's tests.
For example, let's assume you have a
gdt-kubescenario that looks like this:If you execute the above test and there is already an 'nginx' deployment, the
kube.createtest will fail. To prevent the scenario from proceeding with the tests if an 'nginx' deployment already exists, you could add the followingWith the above, if an 'nginx' deployment exists already, the scenario will skip all the tests.