Skip to content

Gloss; add definition for happy path #997

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

Merged
merged 2 commits into from
Jan 24, 2023
Merged

Conversation

MattDodsonEnglish
Copy link
Contributor

part of #932

@github-actions
Copy link
Contributor

There's a version of the docs published here:

https://mdr-ci.staging.k6.io/docs/refs/pull/997/merge

It will be deleted automatically in 30 days.

Copy link
Contributor

@imiric imiric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

: A period that lets VUs finish an iteration at the end of a load test. Graceful stops prevent abrupt halts in execution.<br/><br/>[Graceful stop reference](/using-k6/scenarios/graceful-stop/)

Happy path
: The default system behavior that happens when a known input produces an expected output. A common mistake in performance testing happens when scripts account only for the happy path. Most load tests try to discover system errors, so test scripts should include exception handling.<br/><br/>[Happy path (Wikipedia)](https://en.wikipedia.org/wiki/Happy_path)
Copy link
Contributor

@imiric imiric Jan 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
: The default system behavior that happens when a known input produces an expected output. A common mistake in performance testing happens when scripts account only for the happy path. Most load tests try to discover system errors, so test scripts should include exception handling.<br/><br/>[Happy path (Wikipedia)](https://en.wikipedia.org/wiki/Happy_path)
: The default system behavior that happens when a known input produces an expected output. A common mistake in performance testing happens when scripts account only for the best case (in other words, the happy path). Most load tests try to discover system errors, so test scripts should include exception handling.<br/><br/>[Happy path (Wikipedia)](https://en.wikipedia.org/wiki/Happy_path)

To avoid using the term name in the definition.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've put it in parenthesis, because I want the text to drive home how the happy path relates specifically to testing. I want to be explicit that "best case" is synonymous with "happy path". And I avoided "scenario" only because it could mean something else in this gloss :-)

@MattDodsonEnglish MattDodsonEnglish merged commit 9e9fe63 into main Jan 24, 2023
@MattDodsonEnglish MattDodsonEnglish deleted the 932-happy-path branch January 24, 2023 13:12
oleiade pushed a commit that referenced this pull request Jan 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants