first commit
This commit is contained in:
43
docs/testkit/testing/testing-integration-redis/README.md
Normal file
43
docs/testkit/testing/testing-integration-redis/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# @suaveplan/testing-integration-redis - Redis 7 testcontainers fixture for @suaveplan/testing-integration
|
||||
|
||||
## Summary
|
||||
|
||||
Redis 7 testcontainers fixture for `@suaveplan/testing-integration`.
|
||||
|
||||
Implements `ServiceFixture<RedisConfig>` — manages a Redis container lifecycle with env-bridge passthrough and TCP PING health checks. Returns a plain config; consumers bring their own Redis client.
|
||||
|
||||
<!-- begin:auto-docs -->
|
||||
## Documentation tree
|
||||
|
||||
- [fixture](./src/fixture/redis-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
- [redis-fixture](./src/fixture/redis-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
||||
<!-- end:auto-docs --> - [redis-fixture](./src/fixture/redis-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-fixture](./src/fixture/redis-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-fixture](./src/fixture/redis-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_- [redis-fixture](./src/fixture/redis-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_
|
||||
## Install
|
||||
|
||||
```bash
|
||||
bun add -D @suaveplan/testing-integration-redis
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```typescript
|
||||
import { RedisFixture } from "@suaveplan/testing-integration-redis";
|
||||
|
||||
const fixture = new RedisFixture();
|
||||
const config = await fixture.start();
|
||||
// config.url, config.host, config.port
|
||||
await fixture.stop();
|
||||
```
|
||||
|
||||
## Env-bridge passthrough
|
||||
|
||||
Set the env var to skip container startup:
|
||||
|
||||
```text
|
||||
REDIS_URL=redis://localhost:6379
|
||||
```
|
||||
|
||||
## Docs
|
||||
|
||||
- [RedisFixture](src/fixture/redis-fixture.md)
|
||||
|
||||
Reference in New Issue
Block a user