doc: add documentation and example for enttest (#453)

This commit is contained in:
Ariel Mashraki
2020-04-26 16:31:24 +03:00
committed by GitHub
parent 61c0f957b6
commit 7de4f4b758
3 changed files with 45 additions and 10 deletions

39
doc/md/testing.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: testing
title: Testing
---
If you're using `ent.Client` in your unit-tests, you can use the generated `enttest`
package for creating a client and auto-running the schema migration as follows:
```go
package main
import (
"testing"
"<project>/ent/enttest"
_ "github.com/mattn/go-sqlite3"
)
func TestXXX(t *testing.T) {
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1")
defer client.Close()
// ...
}
```
In order to pass functional options to `Open`, use `enttest.Option`:
```go
func TestXXX(t *testing.T) {
opts := []enttest.Option{
enttest.WithOptions(ent.Log(t.Log)),
enttest.WithMigrateOptions(migrate.WithGlobalUniqueID(true)),
}
client := enttest.Open(t, "sqlite3", "file:ent?mode=memory&cache=shared&_fk=1", opts...)
defer client.Close()
// ...
}
```