Code Monkey home page Code Monkey logo

loopback-fixtures's Introduction

loopback-fixtures

Expressive fixtures generator for Loopback

Build Status dependencies Status

Installation

Basic usage

Add the following entry to your package.json:

"loopback-fixtures": "git://github.com/Octopixell/loopback-fixtures.git"

Then, in your server/component-config.json, add :

{
  "loopback-fixtures": {
    "fixturePath": "/fixtures/data/",
    "append": false,
    "autoLoad": false
  }
}

Write your YML fixture file /fixture/data/data.yml (adapt according your model) :

Group:
  group{1..10}:
    name: "Groupe {#} depuis les fixtures"

User:
  user{1..10}:
    name: "User {#} : {{name.lastName}}"
    groupId: @{group{#}}
    email: "{{internet.email}}"
    birthDate: "2016-01-01"
    favoriteNumber: "(function() { return Math.round(Math.random()*1000);})()"

How to load fixtures ?

  • If autoLoad is set to true, fixtures will be loaded when you start your application

  • With the server:

    app.loadFixtures() (return a promise)

    e.g:

    app.loadFixtures()
    .then(function() {
      console.log('Done!');
    })
    .catch(function(err) {
      console.log('Errors:', err);
    });
  • With a node command:

    node ./node_modules/loopback-fixtures/lib/load-fixtures.js
    

Configuration options

  • fixturePath (default value '/fixtures/data')

    The directory to load data fixtures from

  • append (default value true)

    If set to true, data fixtures will be append instead of deleting all data from the database first. WARNING false will erase your database

  • autoLoad (default value false)

Features

  • Load data according your model

  • Multiple generators :

    User:
      user{1..45}:
        name: "User number {#}"

    {#} represents the current identifier for the generator

  • References :

    Group:
      group{1..3}:
        name: "Groupe number {#}"
    
    User:
      user{1..9}:
        name: "User number {#}"
        group: @{group1}  # Reference to group1
        owner: @{group1.owner} # Reference the owner of group1
    
      user{10..19}:
        name: "User number {#}"
        group: @{group.*} # Reference to any random matching group

    @{group1} represents the reference for group1 and can be used in other fixtures @{group1.name} represents the reference for the property name within group1 and can be used in other fixtures @{group.*} represents the reference for a random matching group and can be used in other fixtures

  • JSON

    User:
      userWithJson:
        data: '{"key":"value","key2":"value2"}'
  • Fakers :

    User:
      user{1..10}:
        name: "User n°{#} : {{name.lastName}} {{name.firstName}}"
        email: "{{internet.email}}"

    You can use Faker.js API to provide fake data

  • Custom function :

    User:
      user{1..10}:
        favoriteNumber: "(function() { return Math.round(Math.random()*1000); })()"

    You can use custom functions too

Credits

Samy Ghribi - For creating the initial version of this LoopBack component. Thanks Samy!

License

ISC

loopback-fixtures's People

Contributors

octopixell avatar sghribi avatar aaronbuchanan avatar kraynel avatar pdehaan avatar dmtrs avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.