Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support taking arbitrary actions upon test failure #12

Open
jaypipes opened this issue Aug 8, 2023 · 1 comment
Open

Support taking arbitrary actions upon test failure #12

jaypipes opened this issue Aug 8, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@jaypipes
Copy link
Member

jaypipes commented Aug 8, 2023

Users would like to be able to execute commands, collect log information, grep for errors in output and other actions when a test assertion fails.

For instance, if an application is deployed using Kubernetes and network connectivity doesn't work for the application, the test author might want to call kubectl logs in the event of a test failure.

Another example might be if you wanted to grep a log file in the event that no connectivity on a particular IP:PORT combination could be made you might do this:

tests:
 - exec: nc -z $HOST $PORT
   on:
     fail:
       exec: grep ERROR /var/log/myapp.log

The grep ERROR /var/log/myapp.log command will only be executed if there is no connectivity to $HOST:$PORT and the results of that grep will be directed to the test's output. You can use the gdt.WithDebug() function to configure additional io.Writers to direct this output to.

@jaypipes jaypipes added the enhancement New feature or request label Aug 8, 2023
jaypipes added a commit that referenced this issue Aug 8, 2023
Users would like to be able to execute commands, collect log
information, grep for errors in output and other actions when a test
assertion fails.

For instance, if an application is deployed using Kubernetes and network
connectivity doesn't work for the application, the test author might
want to call kubectl logs in the event of a test failure.

Another example might be if you wanted to grep a log file in the event
that no connectivity on a particular IP:PORT combination could be made
you might do this:

```yaml
tests:
 - exec: nc -z $HOST $PORT
   on:
     fail:
       exec: grep ERROR /var/log/myapp.log
```

The grep ERROR /var/log/myapp.log command will only be executed if there
is no connectivity to $HOST:$PORT and the results of that grep will be
directed to the test's output. You can use the gdt.WithDebug() function
to configure additional io.Writers to direct this output to.

This patch adds support for the exec plugin's `on.fail` field, hopefully
in a way that is extensible for other plugins to use as an example (and
possible embed the `plugin/exec.Action` struct).

Addresses Issue #12

Signed-off-by: Jay Pipes <jaypipes@gmail.com>
@a-hilaly a-hilaly closed this as completed Aug 9, 2023
@jaypipes jaypipes reopened this Aug 9, 2023
@jaypipes
Copy link
Member Author

jaypipes commented Aug 9, 2023

Still need to implement this for the HTTP and Kube plugins.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants