You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

factory.io

Package Overview
Dependencies
2
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

factory.io

Modern class based mock data generation with typescript support.


Version published
Maintainers
1
Created

Readme

Source

Test Codecov License Downloads Version

factory.io

A modern class-based test factory generation with TypeScript support. It integrates exceptionally well with popular TypeScript class-based libraries such as TypeORM.

Table of contents

Usage

Factories can be constructed with the following (chaining) methods.

  • ctor (constructor arguments)
  • props or prop (properties to be assigned)
  • computed (values calculated based on props or default object properties)
  • mixins (factories expanded by current factory)
  • build (returns class factory)

Things to remember

  • Methods can be called in any order - execution order is predefined
  • Execution order:
    • constructor
    • removeUnassignedProperties (if set in options)
    • mixins
    • props
    • computed
    • partial
  • Relations between objects can be assigned with computed method.

Ctor

Ctor arguments are passed to class constructor during object initialization. This is useful when a class cannot be initialized without certain constructor arguments.

  • Plain values are always the same.
  • Functions are recalculated each time an object is built.
const userFactory = FactoryBuilder.of(User)
  .ctor([faker.random.number, 12])
  .build();

const result = userFactory.buildOne();

Props

Props should be provided as values, functions or nested objects consisting of values and functions.

  • Plain values are always the same.
  • Functions are recalculated each time an object is built.
const userFactory = FactoryBuilder.of(User)
  .props({
    age: faker.random.number,
    username: faker.internet.userName,
    friend: {
      username: faker.internet.userName,
    },
  })
  .build();

const result = userFactory.buildOne();

Computed

Computed properties should be provided as functions or nested objects. They can reference the main object (and objects it references) after mixins and props are assigned.

const userFactory = FactoryBuilder.of(User)
  .computed({
    age: (e) => e.age * 2,
  })
  .props({
    age,
  })
  .build();

const result = userFactory.buildOne();

Mixins

Use mixins to extend previously constructed factories. Remember that mixins are resolved in provided order and before props and computed of factory currently being expanded.

const mixinUserFactory = FactoryBuilder.of(User)
  .props({
    age: faker.random.number,
    username: faker.internet.userName,
  })
  .build();

const userFactory = FactoryBuilder.of(User)
  .props({
    /*
      Mixin age value is overridden
    */
    age: faker.random.number,
  })
  .mixins([mixinUserFactory])
  .build();

const result = userFactory.buildOne();

Options

  • sequenceField - Object property to which sequence value should be assigned
  • sequenceTransformer - Custom function responsible for sequence assignment (allows to modify the value pre-assignment)
  • removeUnassignedProperties - Whether undefined properties should be removed (as the constructor is passed with no arguments, fields without default values are assigned undefined)
  • defaultSequenceValue - Initial sequence value, incremented by one each time an object is build

Build

build() method transforms FactoryBuilder into Factory. This process cannot be reversed. Factories cannot be assigned new properties.

Factory

Factory object has the following methods.

  • buildOne
  • buildMany
  • resetSequence

Examples

Classes

const userFactory = FactoryBuilder.of(User)
  .props({
    age: faker.random.number,
    username: faker.internet.userName,
  })
  .build();

const result = userFactory.buildOne({ id: 1 });
const userFactory = FactoryBuilder.of(User)
  .props({
    age: faker.random.number,
    username: faker.internet.userName,
  })
  .build();

const result = userFactory.buildOne({ id: 1 });

Interfaces

const userFactory = FactoryBuilder<IUser>.of()
  .props({ age: faker.random.number, username: faker.internet.userName })
  .computed({
    monthsAlive: (user) => user.age * 12,
  })
  .build();

const result = userFactory.buildMany(4);
const userFactory = FactoryBuilder<IUser>.of()
  .props({ age: faker.random.number, username: faker.internet.userName })
  .build();

const result = userFactory.buildMany(5);

TypeORM integration

Entity
@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column({ unique: true })
  username: string;

  @Column()
  email: string;
}
Factory
export const userFactory = FactoryBuilder.of(User)
  .options({ sequenceField: 'id' })
  .props({
    email: faker.internet.email,
    password: faker.internet.password,
  })
  .build();
Utils
async function saveOne(current: any) {
  try {
    const repository = getConnection().getRepository(current.constructor.name);
    return await repository.save(current);
  } catch (e) {
    console.log(e);
  }
}
Usage
it('should save data to db', async () => {
  const user = await saveOne(userFactory.buildOne());

  const result = await getConnection()
    .getRepository(user.constructor.name)
    .findOne({ id: user.id });

  expect(result).toEqual(user);
});

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Keywords

FAQs

Package last updated on 20 Dec 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc