diff --git a/docs/modules/k6.md b/docs/modules/k6.md index 4783ca1e5ad..13e0ddc9252 100644 --- a/docs/modules/k6.md +++ b/docs/modules/k6.md @@ -11,12 +11,23 @@ Testcontainers module for [k6](https://registry.hub.docker.com/r/grafana/k6). ## Basic script execution -Execute a simple k6 test script, `test.js`, with commandline options and injected script variable. +You can start a K6 container instance from any Java application by using: + + +[Setup the container](../../modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java) inside_block:standard_k6 + + +The test above uses a simple k6 script, `test.js`, with command line options and an injected script variable. + +Once the container is started, you can wait for the test results to be collected: + + +[Wait for test results](../../modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java) inside_block:wait + Create a simple k6 test script to be executed as part of your tests: -[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 diff --git a/modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java b/modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java index 255cb376b4f..43b390c4db4 100644 --- a/modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java +++ b/modules/k6/src/test/java/org/testcontainers/k6/K6ContainerTests.java @@ -23,6 +23,7 @@ void k6StandardTest() throws Exception { ) { container.start(); + // wait { WaitingConsumer consumer = new WaitingConsumer(); container.followOutput(consumer); @@ -34,6 +35,7 @@ void k6StandardTest() throws Exception { 3, TimeUnit.SECONDS ); + // } assertThat(container.getLogs()).contains("k6 tests are cool!"); }