-
Notifications
You must be signed in to change notification settings - Fork 10.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
125 changed files
with
2,706 additions
and
1,021 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: Benchmark Docker Image CI | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - 'packages/benchmark/**' | ||
| - 'pnpm-lock.yaml' | ||
| - 'pnpm-workspace.yaml' | ||
| - '.github/workflows/docker-images-benchmark.yml' | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4.1.1 | ||
|
|
||
| - name: Set up QEMU | ||
| uses: docker/setup-qemu-action@v3.0.0 | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3.0.0 | ||
|
|
||
| - name: Login to GitHub Container Registry | ||
| uses: docker/login-action@v3.0.0 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Build | ||
| uses: docker/build-push-action@v5.1.0 | ||
| with: | ||
| context: . | ||
| file: ./packages/benchmark/Dockerfile | ||
| platforms: linux/amd64 | ||
| provenance: false | ||
| push: true | ||
| tags: | | ||
| ghcr.io/${{ github.repository_owner }}/n8n-benchmark:latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,8 @@ | ||
| name: Docker Image CI | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - 'n8n@*' | ||
| release: | ||
| types: [published] | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # syntax=docker/dockerfile:1 | ||
| FROM node:20.16.0 AS base | ||
|
|
||
| # Install required dependencies | ||
| RUN apt-get update && apt-get install -y gnupg2 curl | ||
|
|
||
| # Add k6 GPG key and repository | ||
| RUN mkdir -p /etc/apt/keyrings && \ | ||
| curl -sS https://dl.k6.io/key.gpg | gpg --dearmor --yes -o /etc/apt/keyrings/k6.gpg && \ | ||
| chmod a+x /etc/apt/keyrings/k6.gpg && \ | ||
| echo "deb [signed-by=/etc/apt/keyrings/k6.gpg] https://dl.k6.io/deb stable main" | tee /etc/apt/sources.list.d/k6.list | ||
|
|
||
| # Update and install k6 | ||
| RUN apt-get update && \ | ||
| apt-get install -y k6 tini && \ | ||
| apt-get clean && \ | ||
| rm -rf /var/lib/apt/lists/* | ||
|
|
||
| ENV PNPM_HOME="/pnpm" | ||
| ENV PATH="$PNPM_HOME:$PATH" | ||
| RUN corepack enable | ||
|
|
||
| # | ||
| # Builder | ||
| FROM base AS builder | ||
|
|
||
| WORKDIR /app | ||
|
|
||
| COPY --chown=node:node ./pnpm-lock.yaml /app/pnpm-lock.yaml | ||
| COPY --chown=node:node ./pnpm-workspace.yaml /app/pnpm-workspace.yaml | ||
| COPY --chown=node:node ./package.json /app/package.json | ||
| COPY --chown=node:node ./packages/@n8n/benchmark/package.json /app/packages/@n8n/benchmark/package.json | ||
| COPY --chown=node:node ./patches /app/patches | ||
| COPY --chown=node:node ./scripts /app/scripts | ||
|
|
||
| RUN pnpm install --frozen-lockfile | ||
|
|
||
| # TS config files | ||
| COPY --chown=node:node ./tsconfig.json /app/tsconfig.json | ||
| COPY --chown=node:node ./tsconfig.build.json /app/tsconfig.build.json | ||
| COPY --chown=node:node ./tsconfig.backend.json /app/tsconfig.backend.json | ||
| COPY --chown=node:node ./packages/@n8n/benchmark/tsconfig.json /app/packages/@n8n/benchmark/tsconfig.json | ||
| COPY --chown=node:node ./packages/@n8n/benchmark/tsconfig.build.json /app/packages/@n8n/benchmark/tsconfig.build.json | ||
|
|
||
| # Source files | ||
| COPY --chown=node:node ./packages/@n8n/benchmark/src /app/packages/@n8n/benchmark/src | ||
| COPY --chown=node:node ./packages/@n8n/benchmark/bin /app/packages/@n8n/benchmark/bin | ||
| COPY --chown=node:node ./packages/@n8n/benchmark/scenarios /app/packages/@n8n/benchmark/scenarios | ||
|
|
||
| WORKDIR /app/packages/@n8n/benchmark | ||
| RUN pnpm build | ||
|
|
||
| # | ||
| # Runner | ||
| FROM base AS runner | ||
|
|
||
| COPY --from=builder /app /app | ||
|
|
||
| WORKDIR /app/packages/@n8n/benchmark | ||
| USER node | ||
|
|
||
| ENTRYPOINT [ "/app/packages/@n8n/benchmark/bin/n8n-benchmark" ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # n8n benchmarking tool | ||
|
|
||
| Tool for executing benchmarks against an n8n instance. | ||
|
|
||
| ## Running locally with Docker | ||
|
|
||
| Build the Docker image: | ||
|
|
||
| ```sh | ||
| # Must be run in the repository root | ||
| # k6 doesn't have an arm64 build available for linux, we need to build against amd64 | ||
| docker build --platform linux/amd64 -t n8n-benchmark -f packages/@n8n/benchmark/Dockerfile . | ||
| ``` | ||
|
|
||
| Run the image | ||
|
|
||
| ```sh | ||
| docker run \ | ||
| -e N8N_USER_EMAIL=user@n8n.io \ | ||
| -e N8N_USER_PASSWORD=password \ | ||
| # For macos, n8n running outside docker | ||
| -e N8N_BASE_URL=http://host.docker.internal:5678 \ | ||
| n8n-benchmark | ||
| ``` | ||
|
|
||
| ## Running locally without Docker | ||
|
|
||
| Requirements: | ||
|
|
||
| - [k6](https://grafana.com/docs/k6/latest/set-up/install-k6/) | ||
| - Node.js v20 or higher | ||
|
|
||
| ```sh | ||
| pnpm build | ||
|
|
||
| # Run tests against http://localhost:5678 with specified email and password | ||
| N8N_USER_EMAIL=user@n8n.io N8N_USER_PASSWORD=password ./bin/n8n-benchmark run | ||
|
|
||
| # If you installed k6 using brew, you might have to specify it explicitly | ||
| K6_PATH=/opt/homebrew/bin/k6 N8N_USER_EMAIL=user@n8n.io N8N_USER_PASSWORD=password ./bin/n8n-benchmark run | ||
| ``` | ||
|
|
||
| ## Configuration | ||
|
|
||
| The configuration options the cli accepts can be seen from [config.ts](./src/config/config.ts) | ||
|
|
||
| ## Benchmark scenarios | ||
|
|
||
| A benchmark scenario defines one or multiple steps to execute and measure. It consists of: | ||
|
|
||
| - Manifest file which describes and configures the scenario | ||
| - Any test data that is imported before the scenario is run | ||
| - A [`k6`](https://grafana.com/docs/k6/latest/using-k6/http-requests/) script which executes the steps and receives `API_BASE_URL` environment variable in runtime. | ||
|
|
||
| Available scenarios are located in [`./scenarios`](./scenarios/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| // Check if version should be displayed | ||
| const versionFlags = ['-v', '-V', '--version']; | ||
| if (versionFlags.includes(process.argv.slice(-1)[0])) { | ||
| console.log(require('../package').version); | ||
| process.exit(0); | ||
| } | ||
|
|
||
| (async () => { | ||
| const oclif = require('@oclif/core'); | ||
| await oclif.execute({ dir: __dirname }); | ||
| })(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| { | ||
| "name": "@n8n/n8n-benchmark", | ||
| "version": "1.0.0", | ||
| "description": "Cli for running benchmark tests for n8n", | ||
| "main": "dist/index", | ||
| "scripts": { | ||
| "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json", | ||
| "start": "./bin/n8n-benchmark", | ||
| "test": "echo \"Error: no test specified\" && exit 1", | ||
| "typecheck": "tsc --noEmit", | ||
| "watch": "concurrently \"tsc -w -p tsconfig.build.json\" \"tsc-alias -w -p tsconfig.build.json\"" | ||
| }, | ||
| "engines": { | ||
| "node": ">=20.10" | ||
| }, | ||
| "keywords": [ | ||
| "automate", | ||
| "automation", | ||
| "IaaS", | ||
| "iPaaS", | ||
| "n8n", | ||
| "workflow", | ||
| "benchmark", | ||
| "performance" | ||
| ], | ||
| "dependencies": { | ||
| "@oclif/core": "4.0.7", | ||
| "axios": "catalog:", | ||
| "convict": "6.2.4", | ||
| "dotenv": "8.6.0", | ||
| "zx": "^8.1.4" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/convict": "^6.1.1", | ||
| "@types/k6": "^0.52.0", | ||
| "@types/node": "^20.14.8", | ||
| "tsc-alias": "^1.8.7", | ||
| "typescript": "^5.5.2" | ||
| }, | ||
| "bin": { | ||
| "n8n-benchmark": "./bin/n8n-benchmark" | ||
| }, | ||
| "oclif": { | ||
| "bin": "n8n-benchmark", | ||
| "commands": "./dist/commands", | ||
| "topicSeparator": " " | ||
| } | ||
| } |
Oops, something went wrong.