docs: add the Test Kitchen path and a "nothing ran" guide - #90
Merged
Conversation
The README described the layout and the glob accurately but never joined them up. Someone arriving at this plugin could read it end to end and still not know how it gets invoked, or what to do when a suite appears to be skipped. **Using it with Test Kitchen.** This is how nearly everyone runs these plugins, and the README never mentioned it -- no `kitchen.yml`, no `verifier:` block, no statement that the suite directory name alone is what selects the plugin. **When nothing runs.** The most confusing failure in the family: a suite whose filenames do not match the glob prints one banner line and **exits `0`**. Green, and no tests ran. The section shows exactly that output and walks the four causes in order -- wrong directory name, wrong filename pattern, plugin not installed, unexpected BUSSER_ROOT -- naming the two commands that answer the last two. The `exits 0` behaviour was confirmed by running it, not assumed. Signed-off-by: Tim Smith <tsmith84@proton.me>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
docs: add the Test Kitchen path and a "nothing ran" guide
The README described the layout and the glob accurately but never joined them
up. Someone arriving at this plugin could read it end to end and still not know
how it gets invoked, or what to do when a suite appears to be skipped.
Using it with Test Kitchen. This is how nearly everyone runs these plugins,
and the README never mentioned it -- no
kitchen.yml, noverifier:block, nostatement that the suite directory name alone is what selects the plugin.
When nothing runs. The most confusing failure in the family: a suite whose
filenames do not match the glob prints one banner line and exits
0. Green,and no tests ran. The section shows exactly that output and walks the four
causes in order -- wrong directory name, wrong filename pattern, plugin not
installed, unexpected BUSSER_ROOT -- naming the two commands that answer the
last two.
The
exits 0behaviour was confirmed by running it, not assumed.