@mikro-resources/fixtures NPM

@mikro-resources/fixtures

This package generates fixtures of your MikroORM entities on the fly, using their metadata from MikroORM's metadata provider. This relies on class-fixtures-factory, so all of its features are supported too. @mikro-resources/fixtures will automatically handle all fields and relations of your entities, but you can provide custom values as well.

This package can be used, both for seeding and generating fixtures for your tests.

Installation

yarn add -D @mikro-resources/fixtures 
# or
npm i -D @mikro-resources/fixtures

Usage

General

import { FixturesFactory } from '@mikro-resources/fixtures';

const factory = new FixturesFactory(orm);

// Generate a fixture
let author = factory.make(Author).one();
// Generate multiple fixtures
let authors = factory.make(Author).many(10);

// Generate and persist
author = await factory.make(Author).oneAndPersist();
authors = await factory.make(Author).manyAndPersist(10);

// Ignore some properties at runtime
const partialAuthor = factory
  .make(Author)
  .ignore('address', 'age')
  .one(); // address and age are undefined

// Override properties at runtime
const agedAuthor = factory
  .make(Author)
  .with({
    age: 70,
    address: specialAddr, // any actual address entity object
  })
  .one();

MikroORM Metadata Provider

This library relies first on MikroORM's metadata provider. You're expected to provides correct typings of your entities property for both Mikro ORM and this library to work.

class Author {
  /** 
   * This is bad. You'll probably end up with the "json" type in your metadata,
   * and this library will not work
  */
  @Property()
  mood: 'happy' | 'sad';

  // Correct way
  @Property({ type: 'string' })
  mood: 'happy' | 'sad';
}

Customization

Using the Fixture decorator on your entities, you can customize generated data.

import { Fixture } from "@mikro-resources/fixtures";

export enum Mood {
  GOOD,
  BAD,
  NEUTRAL
}

@Entity()
export class Author extends BaseEntity {

  @Fixture(faker => faker.name.firstName())
  @Property()
  firstName!: string;

  @Fixture('{{name.lastName}}')
  @Property()
  lastName!: string;

  @Fixture(() => 24)
  @Property()
  age!: number;

  @Enum()
  mood!: Mood;

  @Fixture({ min: 3, max: 5})
  @OneToMany(
    () => Book,
    book => book.author
  )
  books = new Collection<Book>(this);

  @Fixture({ ignore: true })
  @OneToOne(
    () => Address,
    addr => addr.author
  )
  address!: Address;
}

You can learn more about the usage of class-fixtures-factory here.