Skip to content

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

Draft
slayerjain wants to merge 1 commit into
mainfrom
train/docs/redis-enterprise-only
Draft

slayerjain wants to merge 1 commit into
mainfrom
train/docs/redis-enterprise-only

Conversation

@slayerjain

@slayerjain slayerjain commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

What changes

gin-redis/README.md

  • A note at the top: Keploy records and mocks Redis only in Keploy Enterprise, which is the keploy that install.sh installs by default; a free account is enough for it.
  • The open-source keploy that this README installs (the ghcr.io/keploy/keploy image or the GitHub release binary) does three things:
    • it passes the app's Redis calls through to the real Redis server in record and test mode;
    • it records no Redis mocks;
    • it logs that the Redis calls are skipped.
  • So the Redis container must keep running during keploy test.
  • The "no need to set up Redis / the application thinks it's talking to Redis" and "all test cases pass" lines now say that this holds for Keploy Enterprise.
  • With the open-source keploy, the OTP verification test fails: the replayed OTP request stores a new random OTP in the live Redis, so the recorded OTP no longer matches.
  • The record steps say that the Redis mocks come with Keploy Enterprise, and the typo "Keploy with capture" now reads "Keploy will capture".

sse-redis/README.md

  • A similar note at the top, with the free-account sentence and the --oss install command. It says that every mention of Redis mocks in the README applies to Keploy Enterprise.
  • "Mocks all outgoing Redis calls (no live Redis needed)" is marked as Keploy Enterprise only.

go-redis is also a Redis sample, but its README makes no keploy claim, so there is nothing to change there.

Why

The open-source keploy no longer records or mocks Redis. It relays Redis to the real server and points users to Keploy Enterprise. A user who followed these READMEs with the open-source keploy would stop Redis at replay and see the tests fail with no explanation.

How it is tested

  • These are README-only changes, so there is nothing to build.
  • commitlint is clean.
  • The Keploy Enterprise link (https://keploy.io/docs/keploy-cloud/cloud-installation/, the page the open-source keploy's Redis warning links) returns 200.
  • No CI in this repo runs keploy against Redis: golangci-lint.yml only lists the directories.
  • Keploy Enterprise's CI records sse-redis with its Redis parser. A README change does not affect that.

When to merge

After the open-source keploy release with the Redis skip has shipped. Until then, the note describes behaviour that no released open-source keploy has yet.

Changes since opening

  • The Keploy Enterprise link goes to https://keploy.io/docs/keploy-cloud/cloud-installation/, the page the open-source keploy's Redis warning links, so the README and the warning point to the same page. The install commands are unchanged.
  • The note says again that a free account is enough for Keploy Enterprise, in the words keploy's install pages use. The branch is one commit.

@slayerjain
slayerjain force-pushed the train/docs/redis-enterprise-only branch from 1a2b9c3 to 5725190 Compare October 23, 2026 11:24
The open-source keploy no longer records or mocks Redis: it passes Redis
calls through to the real server in record and test mode and logs that
they are skipped, with the Keploy Enterprise link. gin-redis's README
installs the open-source keploy and promised that Redis need not run at
replay, and sse-redis's README said replay needs no live Redis.

Both now say that Keploy Enterprise, which the install script installs
by default, records and mocks Redis, that a free account is enough for
it, and what the open-source keploy does. gin-redis says which test
fails with it (OTP verification: a replayed OTP request stores a new
random OTP in the live Redis), and its record steps say that the Redis
mocks come with Keploy Enterprise; it also fixes the typo "Keploy with
capture". sse-redis says that every mention of Redis mocks in its README
applies to Keploy Enterprise. "Keploy Enterprise" links
https://keploy.io/docs/keploy-cloud/cloud-installation/, the page the
open-source keploy's Redis warning links.

Signed-off-by: slayerjain <shubhamkjain@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant