Skip to content

docs(k6): add usage example to module documentation #11238

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −33
Open

docs(k6): add usage example to module documentation #11238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 19 additions & 33 deletions docs/modules/k6.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,25 @@
# k6 Module

!!! note
This module is INCUBATING.
While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future.
See [our contributing guidelines](/contributing/#incubating-modules) for more information on our incubating modules policy.
!!! note
This module is INCUBATING.
While it is ready for use and operational in the current version of Testcontainers, it is possible that it may receive breaking changes in the future.
See [our contributing guidelines](/contributing/#incubating-modules) for more information on our incubating modules policy.

Testcontainers module for [k6](https://registry.hub.docker.com/r/grafana/k6).

[k6](https://k6.io/) is an extensible reliability testing tool built for developer happiness.

## Basic script execution

Execute a simple k6 test script, `test.js`, with commandline options and injected script variable.

Create a simple k6 test script to be executed as part of your tests:

<!--codeinclude-->
[Setup the container](../../modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java) inside_block:standard_k6
[Content of `scripts/test.js`](../../modules/k6/src/test/resources/scripts/test.js) inside_block:access_script_vars
<!--/codeinclude-->

## Adding this module to your project dependencies

Add the following dependency to your `pom.xml`/`build.gradle` file:

=== "Gradle"
```groovy
testImplementation "org.testcontainers:testcontainers-k6:{{latest_version}}"
```
=== "Maven"
```xml
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>testcontainers-k6</artifactId>
<version>{{latest_version}}</version>
<scope>test</scope>
</dependency>
```
## Usage

Here is a basic example of how to create and start a K6 container:

```java
try (
// k6_container {
K6Container container = new K6Container(DockerImageName.parse("grafana/k6:0.49.0"))
.withTestScript("scripts/test.js")
.withScriptVar("MY_VAR", "hello")
// }
) {
container.start();
// Perform assertions based on logs or container state
}