https://github.com/martinthenth/factoid
A test fixtures library - based on Ecto
https://github.com/martinthenth/factoid
ecto elixir exunit phoenix testing
Last synced: 6 months ago
JSON representation
A test fixtures library - based on Ecto
- Host: GitHub
- URL: https://github.com/martinthenth/factoid
- Owner: martinthenth
- License: mit
- Created: 2023-03-30T22:21:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-23T08:35:09.000Z (almost 2 years ago)
- Last Synced: 2025-03-17T03:44:16.048Z (over 1 year ago)
- Topics: ecto, elixir, exunit, phoenix, testing
- Language: Elixir
- Homepage: https://hex.pm/packages/factoid
- Size: 40 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Factoid
Documentation for `Factoid`.
Factoid is a library for generating test data using factories build on Ecto.Schemas.
It's similar to [ExMachina](https://github.com/thoughtbot/ex_machina) but it is not a drop-in
replacement. Where ExMachina builds and keeps associations in the returned records, Factoid drops
the associations and keeps the associated `id` fields. This opinionated approach helps building
simpler tests.
## Installation
Add `factoid` to the list of dependencies in `mix.exs`:
```elixir
def deps do
[{:factoid, "~> 0.1"}]
end
```
## Usage
Define a factory module that uses the `Factoid` behaviour, select the repo module, and define
`build/2` functions for each factory.
```elixir
def App.Factory do
@behaviour Factoid
use Factoid, repo: App.Repo
alias App.Schemas.User
alias App.Schemas.UserAvatar
@impl Factoid
def build(factory, attrs \\ %{})
def build(:user, attrs) do
%User{
first_name: "Jane",
last_name: "Doe",
email_address: "jane-#{unique_integer()}@example.com",
}
|> Map.merge(attrs)
end
def build(:user_avatar, attrs) do
%UserAvatar{
user: build(:user)
}
|> Map.merge(attrs)
end
end
```
In your tests you can import your factory and use it to create test data.
```elixir
def App.ModuleTest do
use DataCase
import App.Factory
alias App.Repo
alias App.Schemas.User
test "creates a user" do
user_1 = insert(:user)
user_2 = insert(:user, name: "John")
assert user_1 != user_2
assert user_1 == Repo.get(User, user_1.id)
assert user_2.name == "John"
end
end
```