Extend info about group with an antipattern section
#210
Conversation
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/210/merge It will be deleted automatically in 30 days. |
src/data/markdown/docs/01 guides/02 Using k6/08 Tags and Groups.md
Outdated
Show resolved
Hide resolved
| group('add several products to the shopping cart', function () { | ||
| // ... | ||
| }); | ||
| group('go to login and authenticate', function () { | ||
| // ... | ||
| }); | ||
| group('checkout process', function () { | ||
| // ... |
There was a problem hiding this comment.
I am for at least one example with nested groups, but it should probably be not an anti-pattern one ;)
There was a problem hiding this comment.
I intentionally removed it to simplify the example.
Not saying that is the best option.
It is mentioned in the description.
There was a problem hiding this comment.
Should the content of the groups be more granular? Those groups could involve many actions/requests that aren't necessarily similar, so I'm not sure why someone would group them together.
"Add several products to the shopping cart" could be interpreted to mean going to many pages, such as individual product pages, in addition to the POST for adding to the cart. "Go to login and authenticate" could mean both the login page and the actual submission of credentials. "Checkout process" could be several pages including the checkout button, a call to an external payment system, and filling out address details.
Personally, I would probably use a group for all the resources on a single page. I would not combine requests from more than one page or action in a group. Then, if I needed a higher-level group, instead of nesting groups I would use a function.
There was a problem hiding this comment.
I agree that it doesn't make sense to have a group for just one request. But I think we should recommend using groups for multiple requests that are still a result of only one page/action. For those spanning more than one action, I think we should recommend functions rather than groups.
| group('add several products to the shopping cart', function () { | ||
| // ... | ||
| }); | ||
| group('go to login and authenticate', function () { | ||
| // ... | ||
| }); | ||
| group('checkout process', function () { | ||
| // ... |
There was a problem hiding this comment.
Should the content of the groups be more granular? Those groups could involve many actions/requests that aren't necessarily similar, so I'm not sure why someone would group them together.
"Add several products to the shopping cart" could be interpreted to mean going to many pages, such as individual product pages, in addition to the POST for adding to the cart. "Go to login and authenticate" could mean both the login page and the actual submission of credentials. "Checkout process" could be several pages including the checkout button, a call to an external payment system, and filling out address details.
Personally, I would probably use a group for all the resources on a single page. I would not combine requests from more than one page or action in a group. Then, if I needed a higher-level group, instead of nesting groups I would use a function.
src/data/markdown/docs/01 guides/02 Using k6/08 Tags and Groups.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/01 guides/02 Using k6/08 Tags and Groups.md
Outdated
Show resolved
Hide resolved
src/data/markdown/docs/01 guides/02 Using k6/08 Tags and Groups.md
Outdated
Show resolved
Hide resolved
|
@nicolek6 Please, let me know if the latest changes address your points. You can read it https://mdr-ci.staging.k6.io/docs/refs/pull/210/merge/using-k6/tags-and-groups |
Discourage the usage of
groupin some cases and provide alternatives.