Hyperfoil reports

Generate html reports from the Hyperfoil all.json output file. The report is a self contained html file with embedded javascript, css, and run data. Reports can easily grow to several MB. NOTE The reports do not embed the patternfly4 fonts. This results in several 404's when opening a report and is being discussed

Getting started

• Follow the instructions at https://nodejs.org/en/download
• Execute:
• nvm install 16
• nvm use 16
• npm install --global yarn
• yarn start

Generate the HTML report for testing

yarn run build
chmod +x build/report.sh
./build/report.sh /path/to/your/all.json > test-report.html

Open the HTML on your browser.

Building

This project uses yarn so ensure you have it available in your system.

yarn install
yarn run build

Usage

There are 3 supported use cases

1. Shell script build/report.sh accepts a json input and generates a standalone html document with the json and javascript embedded inside. It works from either a file path argument or piped input to support path selection from a later json document. The report can be opened in a browser without internet access or a local webserver.

./build/report.sh /tmp/all.json
cat bigFile.json | jq '$.hyperfoil' | ./build/report.sh

2. Hosted html with embedded javascript The report.sh script creates a standalone html page with embedded json and javascript but the template html page can also load json via the data query parameter. Copy the build/index.embedded.html as index.html into the webserver folder with any json files and open a browser to index.html?data=http://hostname/all.json

3. Hosted html with separate assets Hosting build/index.html along with the build/static folder (and all contents) supports the same ?data query parameter and will make better use of browser request caching

Developing

The project is based on create-react-app and uses yarn for package management. This means you need to download node and add it to the path Run yarn install from the base directory for first time setup. Use yarn start to launch the react hot reload server which will open localhost:3000 in your browser. The default index.html does not have embedded data. You can either add an all.json to the public folder and add ?data=http://localhost:3000/all.json to the url or embed json data by replacing [/**DATAKEY**/] with the json data.