Added example for running specific scenario via cli #1762

taylorflatt · 2024-10-04T17:39:33Z

Why?

On a number of occasions I have found colleagues wanting to run a specific scenario of a given test script. Early on I saw folks would just comment things out to get to the behavior they wanted or would start nesting scripts and fanning tests out.

What?

Added an example to the scenario section outlining how to effectively use an environment variable to run a specific scenario among a group.
Tested example in all versions that it works as expected.

Checklist

I have used a meaningful title for the PR.
I have described the changes I've made in the "What?" section above.
I have performed a self-review of my changes.
I have run the npm start command locally and verified that the changes look good.

I have made my changes in the docs/sources/next folder of the documentation.
I have reflected my changes in the docs/sources/v{most_recent_release} folder of the documentation.
I have reflected my changes in the relevant folders of the two previous k6 versions of the documentation (if still applicable to previous versions).

Related PR(s)/Issue(s)

Option to toggle the scenario run k6#2780

taylorflatt · 2024-10-11T12:43:43Z

Any thoughts @heitortsergent?

heitortsergent · 2024-10-17T18:45:10Z

Hi @taylorflatt! Sorry for the delay here 🙏 .

I checked with the team and they agreed that this is a good suggestion! I just want to review some of the wording, I should be able to do that tomorrow and then we can get this merged. And thanks for opening the PR! 🙇

taylorflatt · 2024-10-18T13:34:38Z

Excellent! No problemo.

I installed vale locally and it doesn't seem like it is picking up any blockers when I point to either the .vale configuration in k6-docs or the writers-toolkit. The error in the action for prose linting is odd and if a real error on my side a bit confusing:

  E100 [loadINI/homedir] Runtime error
  
  $HOME is not defined

Do you have any direction on this?

heitortsergent

@taylorflatt I left some suggestions on the wording, let me know what you think. 🙏

heitortsergent · 2024-10-18T21:46:28Z

docs/sources/next/using-k6/scenarios/advanced-examples.md

+
+## Run specific scenario via environment variable
+
+Utilizing an [environment variable](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables) and a bit of code, you can run a specific scenario via command line as opposed to running all configured scenarios. By default, [k6 runs all scenarios listed in a file](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios).


Suggested change

Utilizing an [environment variable](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables) and a bit of code, you can run a specific scenario via command line as opposed to running all configured scenarios. By default, [k6 runs all scenarios listed in a file](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios).

k6 runs all [scenarios](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios) listed in a test script by default. But, with some small code changes and using [environment variables](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables), you can tell k6 to only run a specific scenario via the command-line.

I think if we change the order of the sentences here, it might be a little bit easier to read.

Fixed: a4419e9

heitortsergent · 2024-10-18T21:51:08Z

docs/sources/next/using-k6/scenarios/advanced-examples.md

+
+Utilizing an [environment variable](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables) and a bit of code, you can run a specific scenario via command line as opposed to running all configured scenarios. By default, [k6 runs all scenarios listed in a file](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios).
+
+The following provides an example of how to add the ability to run a specific scenario among multiple configured scenarios:


Suggested change

The following provides an example of how to add the ability to run a specific scenario among multiple configured scenarios:

The following example shows a test script that uses a `SCENARIO` environment variable, if it exists, to choose which scenario to execute:

Fixed: a4419e9

heitortsergent · 2024-10-18T21:52:05Z

docs/sources/next/using-k6/scenarios/advanced-examples.md

+
+const { SCENARIO } = __ENV;
+export const options = {
+  // if a scenario is supplied via cli env, then run that scenario. Otherwise, run like normal


Suggested change

// if a scenario is supplied via cli env, then run that scenario. Otherwise, run like normal

// if a scenario is passed via a CLI env variable, then run that scenario. Otherwise, run

Fixed: a4419e9

heitortsergent · 2024-10-18T21:55:51Z

docs/sources/next/using-k6/scenarios/advanced-examples.md

+
+{{< /code >}}
+
+Alternatively, slightly modifying this approach, it can instead be used as a skip feature. Reading from the custom environment variable allows calling a specific scenario via command line:


Suggested change

Alternatively, slightly modifying this approach, it can instead be used as a skip feature. Reading from the custom environment variable allows calling a specific scenario via command line:

Then from the command line, you could run the test script and only execute the `my_web_test` scenario by running:

I think we can just give an instruction for the user as to how they can execute this from the command line. If we want to mention using this as a skip feature, I think we should do it after the command line examples, or in the first section.

I think it is fine that we explain how to call a scenario from the command line and then the user can utilize that information 12 different ways to do what they would like.

Fixed: a4419e9

heitortsergent · 2024-10-18T22:01:25Z

Oh, and don't worry about the Vale check in the PR. I need to fix it so it's consistent with the writers-toolkit one we use in other repositories.

heitortsergent

LGTM! Thank you so much for opening the PR and for making all the changes. 🙇

Also, there are some merge conflicts now because of some changes we made to the folders. 😞 If you don't mind, I can fix them and get this PR merged, would that be ok?

taylorflatt · 2024-10-29T01:31:03Z

LGTM! Thank you so much for opening the PR and for making all the changes. 🙇

Also, there are some merge conflicts now because of some changes we made to the folders. 😞 If you don't mind, I can fix them and get this PR merged, would that be ok?

I appreciate that! I went ahead and rebased it. Should be good to go now.

heitortsergent · 2024-10-29T18:02:20Z

Thank you again for opening the PR and for your patience @taylorflatt! 🙇 🙇

taylorflatt requested a review from heitortsergent as a code owner October 4, 2024 17:39

taylorflatt changed the title ~~Added ex for custom cli env exec.~~ Added example for running specific scenario via cli Oct 4, 2024

heitortsergent reviewed Oct 18, 2024

View reviewed changes

taylorflatt requested a review from heitortsergent October 25, 2024 14:04

heitortsergent approved these changes Oct 28, 2024

View reviewed changes

taylorflatt added 2 commits October 28, 2024 20:27

Added ex for custom cli env exec.

7de8681

fix: reworded several sections for clarity

babeae9

taylorflatt force-pushed the feat/scenario-cli-adv-ex branch from cf38c71 to babeae9 Compare October 29, 2024 01:28

heitortsergent merged commit fb698a3 into grafana:main Oct 29, 2024
3 of 4 checks passed

taylorflatt deleted the feat/scenario-cli-adv-ex branch October 30, 2024 00:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added example for running specific scenario via cli #1762

Added example for running specific scenario via cli #1762

taylorflatt commented Oct 4, 2024

taylorflatt commented Oct 11, 2024

heitortsergent commented Oct 17, 2024

taylorflatt commented Oct 18, 2024

heitortsergent left a comment

heitortsergent Oct 18, 2024

taylorflatt Oct 25, 2024

heitortsergent Oct 18, 2024

taylorflatt Oct 25, 2024

heitortsergent Oct 18, 2024

taylorflatt Oct 25, 2024

heitortsergent Oct 18, 2024

taylorflatt Oct 25, 2024

taylorflatt Oct 25, 2024

heitortsergent commented Oct 18, 2024

heitortsergent left a comment

taylorflatt commented Oct 29, 2024

heitortsergent commented Oct 29, 2024


		## Run specific scenario via environment variable

		Utilizing an [environment variable](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables) and a bit of code, you can run a specific scenario via command line as opposed to running all configured scenarios. By default, [k6 runs all scenarios listed in a file](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios).

	Utilizing an [environment variable](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables) and a bit of code, you can run a specific scenario via command line as opposed to running all configured scenarios. By default, [k6 runs all scenarios listed in a file](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios).
	k6 runs all [scenarios](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios) listed in a test script by default. But, with some small code changes and using [environment variables](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables), you can tell k6 to only run a specific scenario via the command-line.


		Utilizing an [environment variable](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/environment-variables/#environment-variables) and a bit of code, you can run a specific scenario via command line as opposed to running all configured scenarios. By default, [k6 runs all scenarios listed in a file](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/#scenarios).

		The following provides an example of how to add the ability to run a specific scenario among multiple configured scenarios:

	The following provides an example of how to add the ability to run a specific scenario among multiple configured scenarios:
	The following example shows a test script that uses a `SCENARIO` environment variable, if it exists, to choose which scenario to execute:

	// if a scenario is supplied via cli env, then run that scenario. Otherwise, run like normal
	// if a scenario is passed via a CLI env variable, then run that scenario. Otherwise, run


		{{< /code >}}

		Alternatively, slightly modifying this approach, it can instead be used as a skip feature. Reading from the custom environment variable allows calling a specific scenario via command line:

	Alternatively, slightly modifying this approach, it can instead be used as a skip feature. Reading from the custom environment variable allows calling a specific scenario via command line:
	Then from the command line, you could run the test script and only execute the `my_web_test` scenario by running:

Added example for running specific scenario via cli #1762

Added example for running specific scenario via cli #1762

Conversation

taylorflatt commented Oct 4, 2024

Why?

What?

Checklist

Related PR(s)/Issue(s)

taylorflatt commented Oct 11, 2024

heitortsergent commented Oct 17, 2024

taylorflatt commented Oct 18, 2024

heitortsergent left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heitortsergent commented Oct 18, 2024

heitortsergent left a comment

Choose a reason for hiding this comment

taylorflatt commented Oct 29, 2024

heitortsergent commented Oct 29, 2024