https://github.com/nicholasvuono/playwright-load-test
Load test your apps using Playwright's APIRequestContext 🚀
https://github.com/nicholasvuono/playwright-load-test
api-testing automation load-testing open-source performance playwright typescript
Last synced: 3 months ago
JSON representation
Load test your apps using Playwright's APIRequestContext 🚀
- Host: GitHub
- URL: https://github.com/nicholasvuono/playwright-load-test
- Owner: nicholasvuono
- License: apache-2.0
- Created: 2024-03-14T20:33:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-01T18:03:27.000Z (5 months ago)
- Last Synced: 2025-02-01T19:19:54.525Z (5 months ago)
- Topics: api-testing, automation, load-testing, open-source, performance, playwright, typescript
- Language: TypeScript
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎠playwright-load-test
[](https://www.npmjs.com/package/@nickvuono/playwright-load-test)
[]([http://opensource.org/licenses/MIT](https://github.com/nicholasvuono/playwright-load-test/blob/main/LICENSE))
NPM Registry Page: [@nickvuono/playwright-load-test](https://www.npmjs.com/package/@nickvuono/playwright-load-test)
A load testing harness for [Playwright API testing](https://playwright.dev/docs/api-testing)
Although this is inteded for use with the default Playwright API Request Context, this is a general load testing harness that could also be used with Axios, Fetch, etc.
### Prerequisites
`npm i @playwright/test`
### Installation
`npm i @nickvuono/playwright-load-test`
### Executors
| Executor | Description |
| -------- | ------- |
| `iterations` | runs a specified number of iterations syncronously |
| `duration` | runs iterations syncrounously for a given duration in seconds |
| `iterations-per-second` | run a specified number of iterations per second for a given duration in seconds |
| `variable-rate` | configure stages to ramp up and ramp down iterations per second over given durations in seconds |
Thes can be specified using the `config()` function like so:
```typescript
loadtest.config({
executor: "iterations-per-second",
duration: 15,
ips: 1,
});
```
### Iterations Executor Example
```typescript
import { test, expect } from "@playwright/test";
import loadtest from "@nickvuono/playwright-load-test";
loadtest.config({
executor: "iterations",
iterations: 10,
});
test("Iterations Executor Test @iterations-executor", async ({ request }) => {
await loadtest.exec(async () => {
const response = await request.get("https://yesno.wtf/api");
expect(response.ok()).toBeTruthy();
});
});
```
### Duration Executor Example
```typescript
import { test, expect } from "@playwright/test";
import loadtest from "@nickvuono/playwright-load-test";
loadtest.config({
executor: "duration",
duration: 10,
});
test("Duration Executor Test @duration-executor", async ({ request }) => {
await loadtest.exec(async () => {
const response = await request.get("https://yesno.wtf/api");
expect(response.ok()).toBeTruthy();
});
});
```
### Iterations per Second Executor Example
```typescript
import { test, expect } from "@playwright/test";
import loadtest from "@nickvuono/playwright-load-test";
loadtest.config({
executor: "iterations-per-second",
duration: 15,
ips: 1,
});
test("Iterations per Second Executor Test @iterations-per-second-executor", async ({
request,
}) => {
await loadtest.exec(async () => {
const response = await request.get("https://yesno.wtf/api");
expect(response.ok()).toBeTruthy();
});
});
```
### Varaible Rate Executor Example
```typescript
import { test, expect } from "@playwright/test";
import loadtest from "@nickvuono/playwright-load-test";
loadtest.config({
executor: "variable-rate",
stages: [
{
ips: 1,
duration: 5,
},
{
ips: 2,
duration: 5,
},
{
ips: 1,
duration: 10,
},
],
});
test("Variable Rate Executor Test @variable-rate-executor", async ({
request,
}) => {
await loadtest.exec(async () => {
const response = await request.get("https://yesno.wtf/api");
expect(response.ok()).toBeTruthy();
});
});
```
### Contributors
[Nick Vuono](https://github.com/nicholasvuono) - creator and maintainer