Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add readme for how to run k6 tests locally #36

Merged
merged 1 commit into from
Oct 28, 2024
+38 −0
Merged

docs: add readme for how to run k6 tests locally #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions k6/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# k6 (Integration Tests)

This directory contains integration tests for the k6 project. In
summary, this folder does the following:
1. Start a ruby server, with hive enabled
2. Start a ruby server, with hive disabled
3. Start a mock GraphQL Hive `/usage` api
4. Run GraphQL Requests against the 2 servers
5. Compare the results

## Prerequisites
1. Ruby > 3.0.0
2. Node > 14.0.0
3. [k6 installed](https://grafana.com/docs/k6/latest/set-up/install-k6/)

## Running the tests (locally)

Start the ruby server with HIVE_ENABLED=true
```bash
cd graphql-api
HIVE_ENABLED=true bundle exec puma -t 0:1 -p 9291
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
HIVE_ENABLED=true bundle exec puma -t 0:1 -p 9291
HIVE_ENABLED=true bundle exec puma -t 0:1 -p 9292

```

Start the ruby server with HIVE_ENABLED=false
```bash
cd graphql-api
bundle exec puma -t 0:1 -p 9291
```

Start the usage mock server
```bash
node usage-mock.js
```

Run k6 tests:
```bash
k6 run k6.js
```