loopback-component-fixtures

Component for handling fixture data for client side tests

loopback-component-fixtures

This component was conceived by the desire to test client side applications without needing to mock API requests. It doesn't make sense to mock an API when Loopback is already being used. Environment specific datasource configurations were already available, the only piece missing was an easy way to add and remove fixtures when required. Hopefully this component will be useful for others as well, if you have any suggestions to improve the usefulness of this component please let me know, or even better feel free to submit a pull request.

Usage

Installation

  1. Install in you loopback project:

    npm install --save loopback-component-fixtures

  2. Create a component-config.json file in your server folder (if you don't already have one)

  3. Configure options inside component-config.json. (see configuration section)

    {
     "loopback-component-fixtures": {
       "{option}": "{value}"
     }
    }
  4. Create a folder for storing test fixtures.

    The default location is /server/test-fixtures. This can be set in component-config.json (see below)

  5. Create datasources.{env}.json file. This is the datasources definition that will be used depending on the value of NODE_ENV where you want to use fixture data. Example:

    {
     "db": {
       "name": "db",
       "connector": "memory"
     }
    }

Configuration

Options:

  • loadFixturesOnStartup

    [Boolean] : Defines whether the fixture data should be loaded on startup. (default: false)

  • errorOnSetupFailure

    [Boolean] : Defines whether the API shows/throws an error when fixtures fail to load. (default: false)

    If true:

    • Bad fixtures loaded on startup will cause the application to fail with an error.
    • Bad fixtures loaded via the REST endpoint will return a 500 status code and an error object with details about the specific fixture failures.

    If false:

    • App will continue running (but log an error) if bad fixtures are loaded on startup
    • App will return a 200 with no error details if bad fixtures are loaded when calling the fixture setup REST endpoint, but will log an error to the console.
  • environments

    [String/Array] : The name(s) of the environment(s) where the fixtures should be used. (default: 'test')

  • fixturesPath

    [String] : The location of of the fixture definitions relative to the project root. (default: '/server/test-fixtures/')

Fixture Files

Fixtures are stored in .json files and should have the same name as the loopback model definitions they correspond to. The content should be either an object (for a single item) or an array of objects for multiple items.

Setup/Teardown Fixtures

Fixtures can be setup at startup by setting loadFixturesOnStartup to true in the component-config file. The fixtures can be setup manually by making a GET request to the endpoint <api-root>/fixtures/setup and a GET request to <api-root>/fixtures/teardown will clear all data.

These actions are also available on the server as app.setupFixtures(callback) and app.teardownFixtures(callback).

Repository

https+https://github.com/JonathanPrince/loopback-component-fixtures


上一篇:loopback-component-jsonapi
下一篇:eslint-config-fullcube

相关推荐

  • 配置节点表示为静态bower_components?

    Amol M KulkarniConnor Leech提出了一个问题:configure node express to serve static bower_components?,或许与您遇到的问...

    3 年前
  • 邂逅react(九)-component组件化开发

    今天想分享一下react的核心知识之组件化开发~~1.关于组件化的理解:组件化就是把一个页面或者复杂的功能拆解成一个个小组件,让这些小组件各自分工有序配合构成我们的页面或复杂的程序. 2.为什么要组件...

    5 个月前
  • 解读 vue-class-component 源码实现原理

    导读 使用过一段时间 class 来定义组件,要用 vue-property-decorator 提供定义好的装饰器,辅助完成所需功能,对这个过程好奇,就研究了源码。

    7 个月前
  • 解决vue报错Failed to mount component

    [Vue warn]: Failed to mount component: template or render function not defined. 今天上班运行vue项目,当我进入昨天写的...

    2 年前
  • 解决react:Warning: componentWillMount has been renamed问题

    1. 问题描述 当我新克隆一个react项目,然后安装好依赖包后,启动服务,发现浏览器控制台报如下warning: VM25 common.bundle.js:36926 Warning: compo...

    1 年前
  • 精读《Function Component 入门》

    1. 引言 如果你在使用 React 16,可以尝试 Function Component 风格,享受更大的灵活性。但在尝试之前,最好先阅读本文,对 Function Component 的思维模式有...

    1 年前
  • 白话速述 styled-components 4.x 的使用

    废话不多话,来上车! 安装: npm install --save styled-components (或者 yarn add styled-components)简述使用: 1、 创建全局...

    2 年前
  • 用slot和component实现表单共用

    业务需求 在oa开发中,有许多流程,每个流程里都会有很多字段,比如流程标题、拉下选择,附件等等,有些是每个流程都会有的,有些是特有的,按常规的方法开发,就为为一个流程写一个表单,校验,提交。

    2 年前
  • 用 shell 脚本批量拉取更新 Antd 依赖库,rc-component

    用 shell 脚本批量拉取更新 Antd 依赖库,rc-component仓库的项目 项目地址 需求背景 实现思路 技术实现 demo 步骤 需求背景 有时候看 api 无法实现的需求、想看下源码...

    5 个月前
  • 深入理解styled-components运行机制

    前言 前些天看到塔希同学分享的《Linaria 也许是现在 React 最佳的 JSS 方案》文章后, 让我对JSS的理解又更进了一步, 为了更加深入地了解JSS, 我花了几天的时间阅读了各个JS...

    1 个月前

官方社区

扫码加入 JavaScript 社区