# k6-html-result-reporter

> Generate k6 html test result report from CSV output data.

Latest version **1.0.16** (published 2024-02-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install k6-html-result-reporter
pnpm add k6-html-result-reporter
yarn add k6-html-result-reporter
bun add k6-html-result-reporter
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.16 |
| Published | 2024-02-05 |
| First published | 2023-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 6 |
| Unpacked size | 245.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pramod Moudgalya |
| Maintainers | pkmleo |
| Keywords | k6, load-testing, performance-testing, html-reporter, k6-html-statistics-report |

## Links

- npm: https://www.npmjs.com/package/k6-html-result-reporter
- Repository: https://github.com/pkmleo/k6-html-result-reporter
- Issues: https://github.com/pkmleo/k6-html-result-reporter/issues
- npm.io page: https://npm.io/package/k6-html-result-reporter

## Dependencies (6)

- [ejs](https://npm.io/package/ejs.md) ^3.1.9
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [papaparse](https://npm.io/package/papaparse.md) ^5.4.1
- [plotly.js](https://npm.io/package/plotly.js.md) ^2.27.1
- [http-status-codes](https://npm.io/package/http-status-codes.md) ^2.3.0
- [simple-statistics](https://npm.io/package/simple-statistics.md) ^7.8.3

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 1.0.16 (latest) — 2024-02-05
- 1.0.15 — 2024-02-05
- 1.0.14 — 2024-02-04
- 1.0.13 — 2024-01-18
- 1.0.12 — 2024-01-14
- 1.0.11 — 2024-01-10
- 1.0.10 — 2024-01-09
- 1.0.9 — 2024-01-08
- 1.0.8 — 2024-01-08
- 1.0.7 — 2024-01-07
- 1.0.6 — 2024-01-06
- 1.0.5 — 2024-01-05
- 1.0.4 — 2024-01-04
- 1.0.3 — 2024-01-02
- 1.0.2 — 2024-01-01
- … 9 more at https://npm.io/package/k6-html-result-reporter/versions

## README

# k6 HTML Result Reporter

### Note
> This k6 HTML result report generator is inspired from https://github.com/benc-uk/k6-reporter which provides pretty good report after the completion of performance test.

The report will provide the transaction response times and performance statistics using the data from CSV output file.

The report includes summary report along with response times charts and full transaction list in a table.

## Prerequisites
The report is generated from the `csv` result output when the test is executed. For example if the script is `test.js` use `-o csv=<path of the output file>`. Example:

```shell
-% k6 run -o csv=./results/result.csv test.js
````

> HTML report is not generated if result is not output to CSV file. The report is generated using the data from the output file. More information https://k6.io/docs/get-started/results-output/

## Installation

```shell
npm i k6-html-result-reporter
```
## Usage

The report generation should be executed after the whole test is completed. For example create `execute-report.ts` file with the following code. Replace the file paths.

```ts
import {readFileSync, writeFileSync} from 'fs';
import Papa from 'papaparse';

const filePath = '<csv_result_file>';
const reportFilePath = '<path to save html file>';

export function execute() {
    let fileData: Buffer = readFileSync(filePath);
    let data: any = Papa.parse(fileData.toString(), { header: true, skipEmptyLines: true }).data;
    let htmlReport: string = generateReport(data);
    writeFileSync(reportFilePath, htmlReport);
}

execute();
```
> The example above uses papaparse to read from CSV file. For more information visit: https://www.papaparse.com/

Execute the commands to first create a JS file and then execute the JS file.
```shell
-% tsc execute-report.ts
-% node execute-report.js
```
> The above step is required if the scripts are developed using TypeScript.

For convenience put all the commands in shell script and execute it. Example:
```shell
#!/bin/zsh

k6 run -o csv=output_file_path test_file_path

tsc execute-report.ts

node execute-report.js
```
> Replace the file paths with actual file names and paths used in the test.

> Should also work if the result is output as JSON using `-o json=output_file_path` and sending the JSON file data as input parameter to the function. The input data should be an array.

Function accepts two parameters.
```
inputData: any - CSV data read from the result file.
title: string (optional) - Report title. Defaults to k6 Performance Test Report - yyyy-mm-dd
```

## Report
![Summary](assets/summary.png)
![Charts](assets/charts_1.png)
![Charts](assets/charts_2.png)
![Transactions](assets/transactions.png)

---
_Source: https://npm.io/package/k6-html-result-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._