Skip to content

docs(gin-redis, sse-redis): Redis mocks need Keploy Enterprise #251

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

Draft
slayerjain wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(gin-redis, sse-redis): Redis mocks need Keploy Enterprise #251

Show file tree
Hide file tree
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
20 changes: 9 additions & 11 deletions gin-redis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

A sample user authentication to test Keploy integration capabilities using [Gin](https://gin-gonic.com/) and [Redis](https://redis.io/).

> **Note:** Keploy records and mocks Redis only in [Keploy Enterprise](https://keploy.io/docs/keploy-cloud/cloud-installation/), the `keploy` that `curl --silent -O -L https://keploy.io/install.sh && source install.sh` installs; a free account is enough for it (free-tier runs are subject to a usage allowance). The open-source `keploy` that this README installs (the `ghcr.io/keploy/keploy` image or the keploy/keploy GitHub release binary) passes the app's Redis calls through to the real Redis server in record and in test mode, records no Redis mocks, and logs that the Redis calls are skipped. With it, keep the Redis container running while `keploy test` runs, and expect the OTP verification test to fail (see below).

## Setup URL shortener

```bash
Expand Down Expand Up @@ -92,7 +94,7 @@ this will return the OTP verification response.

_Now, let's see the magic! 🪄💫_

Now both these API calls were captured as a testcase and should be visible on the Keploy CLI. You should be seeing an app named `keploy folder` with the test cases we just captured and data mocks created.
Now both these API calls were captured as a testcase and should be visible on the Keploy CLI. You should be seeing an app named `keploy folder` with the test cases we just captured and, with Keploy Enterprise, the Redis mocks created.

### Run the captured testcases

Expand All @@ -102,9 +104,7 @@ Now that we have our testcase captured, run the test file.
keploy test -c "sudo docker run -p 3001:3001 --rm --network <networkName> --name ginRedisApp gin-app:1.0" --delay 10
```

So no need to setup dependencies like Redis, web-go locally or write mocks for your testing.

**The application thinks it's talking to Redis 😄**
The open-source `keploy` passes the Redis calls through, so keep the Redis container running while the tests run. Even then, the OTP verification test fails with it: the replayed request for an OTP stores a new random OTP in the live Redis, so the recorded OTP no longer matches. With [Keploy Enterprise](https://keploy.io/docs/keploy-cloud/cloud-installation/), Keploy replays the Redis calls from the recorded mocks instead, so there is no need to set up Redis or write mocks for your testing: **the application thinks it's talking to Redis 😄**

We will get output something like this:

Expand All @@ -118,7 +118,7 @@ In `test-2.yml` go to the noisefield and `-body.token` in noise. Now, it's the t
keploy test -c "sudo docker run -p 3001:3001 --rm --network <networkName> --name ginRedisApp gin-app:1.0" --delay 10
```

This time all the test cases will pass.
With the open-source `keploy`, the OTP verification test still fails. With Keploy Enterprise, all the test cases pass this time:
![testruns](./img/testRunPass.png?raw=true "Recent testruns")

## Run app Natively on local machine
Expand Down Expand Up @@ -166,7 +166,7 @@ Once we have our binary file ready,this command will start the recording of API
sudo -E keploy record -c "./gin-redis"
```

Make API Calls using Hoppscotch, Postman or cURL command. Keploy with capture those calls to generate the test-suites containing testcases and data mocks.
Make API Calls using Hoppscotch, Postman or cURL command. Keploy will capture those calls to generate the test-suites containing testcases and, with Keploy Enterprise, Redis mocks.

### Generate testcases

Expand Down Expand Up @@ -210,7 +210,7 @@ this will return the OTP verification response.
}
```

You'll be able to see new test file and mock file generated in your project codebase locally.
You'll be able to see new test file and, with Keploy Enterprise, mock file generated in your project codebase locally.

### Run the Test Mode

Expand All @@ -222,9 +222,7 @@ sudo -E keploy test -c "./gin-redis" --delay 10

> Note: If delay value is not defined, by default it would be `5`.

So no need to setup dependencies like Redis, web-go locally or write mocks for your testing.

**The application thinks it's talking to Redis 😄**
The open-source `keploy` passes the Redis calls through, so keep the Redis container running while the tests run. Even then, the OTP verification test fails with it: the replayed request for an OTP stores a new random OTP in the live Redis, so the recorded OTP no longer matches. With [Keploy Enterprise](https://keploy.io/docs/keploy-cloud/cloud-installation/), Keploy replays the Redis calls from the recorded mocks instead, so there is no need to set up Redis or write mocks for your testing: **the application thinks it's talking to Redis 😄**

We will get output something like this:

Expand All @@ -238,6 +236,6 @@ In `test-2.yml` go to the noisefield and `-body.token` in noise. Now, it's the t
sudo -E keploy test -c "./gin-redis" --delay 10
```

This time all the test cases will pass.
With the open-source `keploy`, the OTP verification test still fails. With Keploy Enterprise, all the test cases pass this time:

![testruns](./img/testRunPass.png?raw=true "Recent testruns")
17 changes: 16 additions & 1 deletion sse-redis/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ streaming test-case support** — it produces responses with a mix of stable
fields (served from Redis mocks during replay) and flaky runtime fields
(timestamps, UUIDs) that exercise noise configuration.

> **Note:** Keploy records and mocks Redis only in
> [Keploy Enterprise](https://keploy.io/docs/keploy-cloud/cloud-installation/),
> the `keploy` that `curl --silent -O -L https://keploy.io/install.sh && source install.sh`
> installs; a free account is enough for it (free-tier runs are subject to
> a usage allowance). The open-source `keploy` (installed with
> `curl --silent -O -L https://keploy.io/install.sh && source install.sh --oss`,
> the keploy/keploy GitHub release binary, or the `ghcr.io/keploy/keploy`
> image) passes this app's Redis calls through
> to the real Redis server in record and in test mode, records no Redis mocks,
> and logs that the Redis calls are skipped. With it, keep Redis running while
> `keploy test` runs. Every mention of Redis mocks in this README applies to
> Keploy Enterprise.

## Prerequisites

| Tool | Purpose |
Expand Down Expand Up @@ -110,7 +123,9 @@ keploy test -c "./sse-redis-app" --delay 7
During replay keploy:

1. Starts the app.
2. Mocks all outgoing Redis calls (no live Redis needed).
2. Mocks all outgoing Redis calls (no live Redis needed). This is Keploy
Enterprise only: the open-source `keploy` passes them through, so Redis
must be running.
3. Replays each recorded HTTP request.
4. For streaming responses, validates the body incrementally:
- **SSE**: compares field keys, event names, and JSON `data` payloads per
Expand Down
Loading