Refactor new command
#4153
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| import { browser } from "k6/browser"; | ||
| import http from "k6/http"; | ||
| import { sleep, check } from 'k6'; | ||
|
|
||
| const BASE_URL = __ENV.BASE_URL || "https://quickpizza.grafana.com"; | ||
|
|
||
| export const options = { | ||
| scenarios: { | ||
| ui: { | ||
| executor: "shared-iterations", | ||
|
There was a problem hiding this comment. I see in other examples we set duration/vus, should we set some "scope" here as well? There was a problem hiding this comment. 👍🏻 Furthermore, my understanding is that in general users tend to run browser tests with 1 VU/1 iteration, at least when they get started. I know it's the default anyway, but as we're all addressing beginners with this command, it could be helpful to remove as much implicit as possible? There was a problem hiding this comment. Makes sense! I have added VUs/Iterations.
It is needed to be able to run a browser test. You must use scenarios, and scenarios must have an executor. Btw... we do this same thing in lots of other places; maybe it is something we should change? cc @ankur22 There was a problem hiding this comment. You mean adding the VU/iteration to all the other examples too? The situation with scenarios and browser tests isn't great tbh, and being forced to add an executor. I think we wanted to avoid making a very large options block, and the minimal is: export const options = {
scenarios: {
ui: {
executor: 'shared-iterations',
options: {
browser: {
type: 'chromium',
},
},
},
},
};Adding iteration and vus adds a couple more lines to it. If the general consensus is that it makes is clearer for new users then it's something to consider. CC @inancgumus There was a problem hiding this comment. I like being explicit in this k6 new command’s output and including VUs and iterations as outputted examples. Sure, we can also mention VUs and iterations in k6-docs here and there, but in general (all k6-docs, if that’s what we mean), I don’t believe we should add more clutter to that already crowded browser options block. |
||
| options: { | ||
| browser: { | ||
| type: "chromium", | ||
| }, | ||
| }, | ||
| }, | ||
| },{{ if .ProjectID }} | ||
| cloud: { | ||
| projectID: {{ .ProjectID }}, | ||
| name: "{{ .ScriptName }}", | ||
| },{{ end }} | ||
| }; | ||
|
|
||
| export function setup() { | ||
| let res = http.get(BASE_URL); | ||
| if (res.status !== 200) { | ||
| throw new Error( | ||
| `Got unexpected status code ${res.status} when trying to setup. Exiting.` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| export default async function() { | ||
oleiade marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let checkData; | ||
| const page = await browser.newPage(); | ||
| try { | ||
|
There was a problem hiding this comment. Would adding a There was a problem hiding this comment. I believe in this case, if the error is not caught, the iteration will be aborted with an error anyway. But it would make sense indeed, if possible to catch the error in order to maybe explicitly call There was a problem hiding this comment. I have added catch + fail 👀 Also, another thing we can maybe use in all examples cc @ankur22 There was a problem hiding this comment. I have also changed the |
||
| await page.goto(BASE_URL); | ||
| checkData = await page.locator("h1").textContent(); | ||
| check(page, { | ||
| header: checkData === "Looking to break out of your pizza routine?", | ||
| }); | ||
| await page.locator('//button[. = "Pizza, Please!"]').click(); | ||
| await page.waitForTimeout(500); | ||
| await page.screenshot({ path: "screenshot.png" }); | ||
| checkData = await page.locator("div#recommendations").textContent(); | ||
| check(page, { | ||
| recommendation: checkData !== "", | ||
| }); | ||
| } finally { | ||
| await page.close(); | ||
| } | ||
| sleep(1); | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import http from 'k6/http'; | ||
| import { sleep, check } from 'k6'; | ||
|
|
||
| export const options = { | ||
| vus: 10, | ||
| duration: '30s',{{ if .ProjectID }} | ||
| cloud: { | ||
| projectID: {{ .ProjectID }}, | ||
| name: "{{ .ScriptName }}", | ||
| },{{ end }} | ||
| }; | ||
|
|
||
| export default function() { | ||
| let res = http.get('https://quickpizza.grafana.com'); | ||
| check(res, { "status is 200": (res) => res.status === 200 }); | ||
| sleep(1); | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import http from "k6/http"; | ||
| import { check, sleep } from "k6"; | ||
|
|
||
| const BASE_URL = __ENV.BASE_URL || 'https://quickpizza.grafana.com'; | ||
|
|
||
| export const options = { | ||
| vus: 10, | ||
| stages: [ | ||
| { duration: "10s", target: 5 }, | ||
| { duration: "20s", target: 10 }, | ||
| { duration: "1s", target: 0 }, | ||
| ], | ||
| thresholds: { | ||
| http_req_failed: ["rate<0.01"], | ||
| http_req_duration: ["p(95)<500", "p(99)<1000"], | ||
| },{{ if .ProjectID }} | ||
| cloud: { | ||
| projectID: {{ .ProjectID }}, | ||
| name: "{{ .ScriptName }}", | ||
| },{{ end }} | ||
| }; | ||
|
|
||
| export function setup() { | ||
| let res = http.get(BASE_URL); | ||
| if (res.status !== 200) { | ||
| throw new Error( | ||
| `Got unexpected status code ${res.status} when trying to setup. Exiting.` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| export default function() { | ||
| let restrictions = { | ||
| maxCaloriesPerSlice: 500, | ||
| mustBeVegetarian: false, | ||
| excludedIngredients: ["pepperoni"], | ||
| excludedTools: ["knife"], | ||
| maxNumberOfToppings: 6, | ||
| minNumberOfToppings: 2 | ||
| }; | ||
|
|
||
| let res = http.post(BASE_URL + "/api/pizza", JSON.stringify(restrictions), { | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| 'Authorization': 'token abcdef0123456789', | ||
| }, | ||
| }); | ||
|
|
||
| check(res, { "status is 200": (res) => res.status === 200 }); | ||
| console.log(res.json().pizza.name + " (" + res.json().pizza.ingredients.length + " ingredients)"); | ||
| sleep(1); | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.