k6-accelerator

Nest.js API

Installation

npm install

Running the example nest-app

npm run api:start:verify:api

The Nest.js API server is then accessible on port 3000. The swagger documentation can be viewed by navigating to http://localhost:3000/api.

k6 Tests

Technologies used

• k6
• xk6
• xk6 dashboard
• k6chaijs

Running the k6 Tests

Pre-requisites

• It is assumed that you already have the backend running on port 3000. If not, execute npm run api:start:verify:api
• Execute the relevant npm script npm run k6:xk6-dashboard:build:linux (Linux & WSL) / npm run k6:xk6-dashboard:build:mac (Mac)

Test Execution

• To run the performance tests npm run k6:performance:tests
• To run the positive tests npm run k6:positive:tests
• To run the negative tests npm run k6:negative:tests
• To run the performance tests in debugging mode in order to log the HTTP requests and responses, including the full body npm run k6:performance:tests:http-debugging
• To run the positive tests in debugging mode in order to log the HTTP requests and responses, including the full body npm run k6:positive:tests:http-debugging
• To run the negative tests in debugging mode in order to log the HTTP requests and responses, including the full body npm run k6:negative:tests:http-debugging

Test Results

Test results are visible via your terminal after execution, however, specific metrics can be viewed by opening the generated html report, e.g. k6-test-performance-report.html within your browser after executing npm run k6:performance:tests.