Skip to content

chore: update example api urls #20

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# k6 Typescript Framework
A starter framework for k6 load tests written in TypeScript.

We'll be using the [LoadImpact Test API](https://test-api.loadimpact.com/) as the website we'll be testing. This is a dummy application/api for crocodiles owners to use who want to keep track of their crocodiles. In the test we will **create a user**, **query** some crocodiles, and **create**, **update** and **delete** a crocodile.
We'll be using the [k6 Test API](https://test-api.k6.io) as the website we'll be testing. This is a dummy application/api for crocodiles owners to use who want to keep track of their crocodiles. In the test we will **create a user**, **query** some crocodiles, and **create**, **update** and **delete** a crocodile.

## Quick Start :zap:

Expand Down Expand Up @@ -58,7 +58,7 @@ This is just an example script and not needed for the test.

The test is based on the following sample script and API provided by k6:

https://test-api.loadimpact.com/
https://test-api.k6.io/

This is a dummy api for people who own crocodiles to keep track of their crocodiles.

Expand Down Expand Up @@ -120,7 +120,7 @@ It's easy to debug `k6` scripts. See the [k6 documentation](https://docs.k6.io/d

## Running in CI/CD Pipelines

`k6` has been designed to work with your `CI/CD` pipeline whatever tool you're using. There are examples for [GitHub Actions](https://blog.loadimpact.com/load-testing-using-github-actions), [GitLab](https://blog.loadimpact.com/integrating-load-testing-with-gitlab), [CircleCI](https://github.com/loadimpact/k6-circleci-example), [Jenkins](https://github.com/loadimpact/k6-jenkins-example) and many others.
`k6` has been designed to work with your `CI/CD` pipeline whatever tool you're using. There are examples for [GitHub Actions](https://k6.io/blog/load-testing-using-github-actions), [GitLab](https://k6.io/blog/integrating-load-testing-with-gitlab), [CircleCI](https://github.com/loadimpact/k6-circleci-example), [Jenkins](https://github.com/loadimpact/k6-jenkins-example) and many others.


## Problems with this Framework
Expand Down
6 changes: 3 additions & 3 deletions src/tests/create-crocs.seed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import { Counter } from 'k6/metrics';
* This is a SEEDING script. Do not run as a performance test.
*
* It creates crocodiles on the following app:
* https://test-api.loadimpact.com/
* https://test-api.k6.io/
* for use by the performance tests (a Soak test in this case).
*/

Expand All @@ -35,7 +35,7 @@ const CROCODILE_OWNER: User = {
password: 'superCroc2019'
}

const BASE_URL = 'https://test-api.loadimpact.com';
const BASE_URL = 'https://test-api.k6.io';

// The Setup Function is run once before the Load Test https://docs.k6.io/docs/test-life-cycle
export function setup() {
Expand Down Expand Up @@ -71,4 +71,4 @@ export default (_authToken: string) => {

export function teardown() {
// you can add functionality here to save the crocodile IDs to a JSON file for use by the performance tests.
}
}
6 changes: 3 additions & 3 deletions src/tests/soak.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import { Counter } from 'k6/metrics';
/**
* A soak test that runs through some common user actions
* for the Crocodile App:
* https://test-api.loadimpact.com/
* https://test-api.k6.io/
*
* P.s. the k6 Types can be found here for reference:
* https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/k6
Expand Down Expand Up @@ -62,7 +62,7 @@ const CROCODILE_OWNER: User = {
password: 'superCroc2019'
}

const BASE_URL = 'https://test-api.loadimpact.com';
const BASE_URL = 'https://test-api.k6.io';

// The Setup Function is run once before the Load Test https://docs.k6.io/docs/test-life-cycle
export function setup() {
Expand Down Expand Up @@ -107,4 +107,4 @@ export default (_authToken:string) => {

// sleeps help keep your script realistic https://docs.k6.io/docs/sleep-t-1
setSleep();
}
}