Document assertions & testing library #2010
Open
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.
What?
This Pull Request adds documentation for the k6-testing jslib, and adds an Assertion category to the
using-k6
category.The initial plan was to introduce the test framework as a
k6/testing
module. The idea is not abandoned, but we'd rather wait to see how our k6 ecosystem improvement story unfolds before commiting. As such, because assertions where designed to be a prime feature of k6, I took the liberty to add it next to checks and thresholds in the documentation, but adding an "admonition" that it is a preview feature.This is a massive PR, apologies for this, there are no easy way to document a massive feature without spawning a lot of content at once. I suggest reviewing this by starting the docs locally, and going through it 🙇🏻
Checklist
npm start
command locally and verified that the changes look good.docs/sources/k6/next
folder of the documentation.docs/sources/k6/next
folder of the documentation.References
grafana/k6#4805