goss-org / goss

Quick and Easy server testing/validation
https://goss.rocks
Apache License 2.0
5.53k stars 470 forks source link

missing documentation about goss_wait.yaml #404

Open gimler opened 5 years ago

gimler commented 5 years ago

The goss_wait.yaml feature is not documented, what is the purpose of this file?

JackLeo commented 5 years ago

The purpose is to create a condition and once it's met, the goss tests are run. For e.g. wait for a certain port to be open before running tests as otherwise, the service is booting and does not match the state desired. This is very useful for dgoss and docker whereby service always will need to boot before we can test.

I do agree it needs it's own proper documentation as there are magic associated to it.

aelsabbahy commented 4 years ago

Feel free to create a pull request adding more documentation to goss_wait.

I'm marking this issue as approved.