k6-test-template

This project provides a structured template for developing load tests with k6, a popular open-source load testing tool. It streamlines test creation, execution, and reporting by offering pre-configured scripts, helpers, and examples.

Key Features

• Pre-configured Environments — Setup scripts for Windows and Unix-based systems to install dependencies and set environment variables.
• Multiple Execution Modes — Run tests locally, on k6 Cloud, or in CI environments with dedicated npm scripts.
• Modular Test Structure — Organize load scenarios, endpoints, and request functions in separate files for maintainability.
• TypeScript Support — Write tests in TypeScript, which are compiled to JavaScript for k6 execution.
• Comprehensive Metrics — Built-in reporting for key performance indicators like HTTP request duration, error rates, and virtual user activity.
• Cleanup Utilities — Optional cleanup scripts to manage test data and resources post-execution.

Philosophy

The template emphasizes a modular and repeatable approach to load testing, enabling teams to quickly build, share, and scale performance tests with consistent configurations.