Skip to content

Commit

Permalink
Merge pull request #350 from k6io/fix/test-builder-docs
Browse files Browse the repository at this point in the history
[fix] Update test builder docs.
  • Loading branch information
legander authored Jul 13, 2021
2 parents bf2a045 + 95b72bb commit be75097
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,37 @@ Although we strongly believe that scriptable/code-based tools will help you get

3 - Select `Test builder`.

![k6 Test Builder](images/k6-create-new-test.png)
![k6 Test Builder](images/create-new-test.png)

4 - Now, you can start building your k6 test using the graphical interface.

![k6 Test Builder](images/test-builder.png)


## Test builder features

We are continuously improving and adding new capabilities to the test builder. A few of the most prominent features are:

**Test configuration**
**Load zones**

Configure the geographical zones that the load test should be run from. Select **even** to distribute load equally across all zones, and **manual** to set the percentage of load for each zone chosen.
Full list of available [load zones](/cloud/creating-and-running-a-test/cloud-tests-from-the-cli#list-of-supported-load-zones).

![Test Builder - Load Zones UI](images/load-zones.png)

**Ramping VUs**

Control the number of VUs (Virtual Users) throughout the test, including ramp up and ramp down phases.

![Test Builder - Ramping VUs UI](images/ramping-vus.png)

**Thresholds**

Thresholds are global pass/fail criteria that you can configure k6 to use, that can act on any result metrics.
Read more in depth about thresholds [here](/using-k6/thresholds/).

- Configure ramping (aka [stages](/using-k6/options#stages)) using VUs and duration.
- Configure [load zones](/cloud/creating-and-running-a-test/cloud-tests-from-the-cli#list-of-supported-load-zones) to run from the k6 Cloud.
![Test Builder - Thresholds UI](images/thresholds.png)

**HTTP Requests**
**Requests**

- Add a request and name it for better description.
- Change the URL/Endpoint.
Expand All @@ -55,14 +69,15 @@ We are continuously improving and adding new capabilities to the test builder. A
**k6 API**

- Define the [thresholds](/using-k6/thresholds) of your test.
- Control ramping [stages](/using-k6/options#stages).
- Add a [check](/javascript-api/k6/check-val-sets-tags) on a request response.
- Add [sleep](/javascript-api/k6/sleep-t) time between requests.
- Add a [group](/javascript-api/k6/group-name-fn) to the test.

**And more**

- Populate the test builder with the recorded requests using the [browser recorder](/test-authoring/recording-a-session/browser-recorder).
- Populate the test builder with the requests included in a [HAR file](https://en.wikipedia.org/wiki/HAR_(file_format)).
- Populate the test builder with the requests included in a [HAR file](<https://en.wikipedia.org/wiki/HAR_(file_format)>).
- Capture a variable when dealing with dynamic data, such as authentication tokens.
- Show examples for better onboarding.
- Toggle the view mode to see or copy the generated k6 script.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions src/templates/docs/cloud.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,7 @@ export default function ({ pageContext: { sidebarTree, navLinks } }) {
.
</Trait>
<Trait>
<Link
to={'/cloud/creating-and-running-a-test/test-builder'}
>
<Link to={'/test-authoring/test-builder'}>
Test Builder
</Link>{' '}
and{' '}
Expand Down

0 comments on commit be75097

Please sign in to comment.