46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# @suaveplan/testing-integration-surrealdb - SurrealDB v3 testcontainers fixture for @suaveplan/testing-integration
|
|
|
|
## Summary
|
|
|
|
SurrealDB v3 testcontainers fixture for `@suaveplan/testing-integration`.
|
|
|
|
Implements `ServiceFixture<SurrealDBConfig>` — manages a SurrealDB container lifecycle with env-bridge passthrough, HTTP health checks, and random password generation per run.
|
|
|
|
<!-- begin:auto-docs -->
|
|
## Documentation tree
|
|
|
|
- [fixture](./src/fixture/surrealdb-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
- [surrealdb-fixture](./src/fixture/surrealdb-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_ <!-- end:auto-docs -->
|
|
<!-- end:auto-docs --> - [surrealdb-fixture](./src/fixture/surrealdb-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_- [surrealdb-fixture](./src/fixture/surrealdb-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_- [surrealdb-fixture](./src/fixture/surrealdb-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_- [surrealdb-fixture](./src/fixture/surrealdb-fixture.md) — <!-- begin:auto-docs --> _(no submodules)_
|
|
## Install
|
|
|
|
```bash
|
|
bun add -D @suaveplan/testing-integration-surrealdb
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```typescript
|
|
import { SurrealDBFixture } from "@suaveplan/testing-integration-surrealdb";
|
|
|
|
const fixture = new SurrealDBFixture();
|
|
const config = await fixture.start();
|
|
// config.url, config.username, config.password, config.namespace, config.database
|
|
await fixture.stop();
|
|
```
|
|
|
|
## Env-bridge passthrough
|
|
|
|
Set all three env vars to skip container startup:
|
|
|
|
```text
|
|
SURREALDB_URL=ws://localhost:8000
|
|
SURREALDB_USERNAME=root
|
|
SURREALDB_PASSWORD=yourpassword
|
|
```
|
|
|
|
## Docs
|
|
|
|
- [SurrealDBFixture](src/fixture/surrealdb-fixture.md)
|
|
|