Skip to content

[MPC-293] Clarify test data file access in k6 scripts #403

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

Merged
tsobe merged 1 commit into from
Jan 9, 2026
Merged

[MPC-293] Clarify test data file access in k6 scripts #403

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
5 changes: 3 additions & 2 deletions docs/k6/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Kangal also supports test data with K6, the supported format file is `.csv`.
1. Prepare your test data in a `.csv` file
2. Configure test script accordingly. See [the k6 data parameterization from a CSV file example](https://k6.io/docs/examples/data-parameterization/#from-a-csv-file).
* **Important**: _"k6 doesn't parse CSV files natively, but you can use an external library, [Papa Parse](https://www.papaparse.com/)."_
* **Important**: When accessing the test data file in your k6 script, use the hardcoded filename `testdata` (e.g., `open('testdata')`), not the original filename you uploaded.
Copy link
Contributor Author

@tsobe tsobe Jan 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example usage: https://github.com/hellofresh/customer-plans-service/blob/9325cf44a7e8bd799442cff3d55b3dd8e8ebe033/performance/main.js#L9

3. Add the file in the `testData` field:

```shell
Expand Down Expand Up @@ -137,7 +138,7 @@ export function handleSummary(data) {

You can use <https://github.com/benc-uk/k6-reporter> to create an HTML Report.

> Note: There aren't any concept of master/worker in k6. Metrics will not be automatically aggregated. To be able to aggregate your metrics and analyse them together, you’ll need to set K6_OUT env to send statics to another service (influxdb, prometheus, etc.).
> Note: There aren't any concept of master/worker in k6. Metrics will not be automatically aggregated. To be able to aggregate your metrics and analyse them together, you'll need to set K6_OUT env to send statics to another service (influxdb, prometheus, etc.).

## Logs

Expand All @@ -164,4 +165,4 @@ RUN xk6 build --output /k6 --with github.com/walterwanderley/xk6-stomp@latest
# Use the official base image and override the k6 binary
FROM grafana/k6:latest
COPY --from=builder /k6 /usr/bin/k6
```
```
Loading