Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
test
README.md
index.ts
mocha.opts
package-lock.json
package.json
tsconfig.json

README.md

RxStack DataFixtures Module

This module aims to provide a simple way to manage and execute the loading of data fixtures.

Installation

npm install @rxstack/data-fixtures --save

// peerDependencies
npm install @rxstack/core@^0.4 @rxstack/exceptions@^0.4 @rxstack/service-registry@^0.4 @rxstack/async-event-dispatcher@^0.4

Documentation

Setup

DataFixtures module needs to be registered in the application.

Let's create the application:

import {Application, ApplicationOptions} from '@rxstack/core';
import {DataFixtureModule} from '@rxstack/data-fixtures';

export const APP_OPTIONS: ApplicationOptions = {
  imports: [
    // ...
    DataFixtureModule,
  ],
  servers: [
    // ...
  ], 
  providers: [
    // ...
  ], 
  logger: {
    // ....
  }
};

new Application(APP_OPTIONS).start();

Purger

Purger is a service responsible to purge the database. By default a NoopPurger is registered (which does nothing) but you can register your own by implementing PurgerInterface:

import {Injectable} from 'injection-js';
import {PurgerInterface} from '@rxstack/data-fixtures';

@Injectable()
export class MyPurger implements PurgerInterface {
  async purge(): Promise<void> { 
    // purge database
  }
}

then you need to register it in the application providers:

import {PURGER_SERVICE} from '@rxstack/data-fixtures';

{
  providers: [
    // ...
    { provide: PURGER_SERVICE, useClass: MyPurger },
  ]
}

Create a fixture

Let's create a fixture:

import {AbstractFixture} from '@rxstack/data-fixtures';
import {Injectable} from 'injection-js';

@Injectable()
export class MyFixture extends AbstractFixture {

  async load(): Promise<void> {
    const service = '...'; // any persistent service
    
    // save the data
    const result = await service.insertOne({
      'name': 'Nikolay',
      'pasword': 'secret'
    });
    
    // share the result with other fixtures
    this.addReference('result-1', result);
  }
  
  getName(): string {
    return 'my-fixture';
  }
  
  // fixture ordering, defaults to 0
  getOrder(): number {
    return 1;
  }
}

and now we need to register it in the application providers:

import {FIXTURE_REGISTRY} from '@rxstack/data-fixtures';

{
  providers: [
    // ...
    { provide: FIXTURE_REGISTRY, useClass: MyFixture, multi: true },
  ]
}

Share fixture result

Fixtures can be shared using the following methods:

import {AbstractFixture} from '@rxstack/data-fixtures';
import {Injectable} from 'injection-js';

@Injectable()
export class MySecondFixture extends AbstractFixture {

  async load(): Promise<void> {
    const result = '...';
    
    // adds the result to the `ReferenceRepository`, if name exists an exception will be thrown
    this.addReference('result-2', result);
    
    // sets the result to the `ReferenceRepository`
    this.setReference('result-2', result);
    
    // gets already added reference from the `ReferenceRepository`, if name does not exist an exception will be thrown
    this.getReference('result-1');
  }

  // ...
}

Usage in tests

Let's assume you need to load fixtures before you execute a testcase.

import 'reflect-metadata';
// ...
import {Application} from '@rxstack/core';
import {Injector} from 'injection-js';
import {FixtureManager} from '@rxstack/data-fixtures';

describe('TestcaseWithFixtures', () => {
  // Setup application
  const app = new Application(APP_OPTIONS);
  let injector: Injector;

  before(async() =>  {
    await app.start();
    injector = app.getInjector();
    // purge the database and load fixtures
    await this.injector.get(FixtureManager).execute(true);
  });

  after(async() =>  {
    await app.stop();
  });
  
  // ...
});

CLI command

You can load fixtures from the command line:

$ npm run cli data-fixtures:load -- --purge=true

License

Licensed under the MIT license.

You can’t perform that action at this time.