Fluse

Build composable and type-safe data-fixtures.

Getting started

Install Fluse using yarn:

``
yarn add -D fluse
`

or npm:

`
npm install --save-dev fluse
`

Documentation

Check out the official documentation.

The gist

Define fixtures based on your own data models.

`typescript
import { fluse } from "fluse";
import faker from "faker";
import { Comment } from "./model/Comment";
import { Post } from "./model/Post";
import { User } from "./model/User";

// Initialize fluse once
export const { fixture, scenario } = fluse();

// Define fixture definitions
export const userFixture = fixture({
create() {
return new User({
username: faker.internet.userName(),
});
},
});

export interface CommentArgs {
author: User;
}

export const commentFixture = fixture({
create(_ctx, args) {
return new Comment({
message: faker.lorem.slug(),
author: args.author,
});
},
});

export interface PostArgs {
author: User;
comments: Comment[];
}

export const postFixture = fixture({
create(_ctx, args) {
return new Post({
title: faker.lorem.slug(),
body: faker.lorem.paragraphs(4),
author: args.author,
comments: args.comments,
});
},
});
`

Supercharge your tests!

`typescript
// Consume a fixture directly and let Fluse do the heavy lifting
it("should create many posts", async () => {
const posts = await postFixture({
author: userFixture(),
comments: commentFixture({ author: userFixture() }).list(3),
})
.list(3)
.execute();
});

// Compose fixtures together and make scenario's
it("should create a fixture scenario", async () => {
const { bob, alice, bobsPosts, alicesPosts } = await scenario()
.with("bob", userFixture())
.with("alice", userFixture())
.with("bobsPosts", ({ bob }) =>
postFixture({
author: bob,
comments: commentFixture({
author: userFixture(),
}).list(3),
}).list(5)
)
.with("alicesPosts", ({ alice }) =>
postFixture({
author: alice,
comments: commentFixture({
author: userFixture(),
}).list(3),
}).list(5)
)
.compose()
.execute();
});
``

Find out more of the core concepts of Fluse like:

- Supplying arguments
- Lists
- Scenarios
- Plugins

License

MIT