使用 sinon 和 mocha 存根 pg-promise

Question

假设我有以下模块，如 database.js

const initOptions = {}
const pgp = require('pg-promise')(initOptions)
const config = require('../../config')

const db = pgp({
  host: config.database.host,
  port: config.database.port,
  database: config.database.database,
  user: config.database.user,
  password: config.database.password
})

module.exports = db

下面的模块作为create.js

const db = require('./database')

function create (name) {
  return new Promise((resolve, reject) => {
      db.func('create', name)
      .then(data => {
        return resolve(data)
      })
      .catch(err => {
        return reject(err)
      })
  })
}

module.exports = create

我正在尝试在 create.js 上运行一个单元测试，它将测试 db.func 是否以“create”作为第一个参数和“name”作为第二个参数调用，但实际上不需要设置数据库连接（因此测试可以离线运行）。

据我所知，这就是 sinon.JS 等库的用途，因此我尝试创建一个测试并将 db 对象存根。

const chai = require('chai')
const chaiAsPromised = require('chai-as-promised')

chai.use(chaiAsPromised)

const sinon = require('sinon')

const expect = chai.expect

const create = require('./create.js')

describe('Test Module', () => {
  it('should test stuff', () => {
    const db = require('./database')
    const dbStub = sinon.stub(db, 'func').callsFake(Promise.resolve(null))
    expect(create('test').then).to.be.a('Function')
  })
})

但是，它失败了

TypeError: Cannot redefine property: func

很可能是因为我接触诗侬的机会有限……

如何对 db 函数进行存根（或者我可能需要模拟？）以便我可以测试它以确保调用 db.func？

Answer 1

您可以通过在Initialization Options 中使用无noLocking 选项禁用锁定来使属性可配置。这允许 sinon 替换属性：

const initOptions = { noLocking : true };

关于相关说明：

您的 create 函数正在创建一个不必要的 promise 包装器，这是一个 promise 反模式。您应该只返回来自db.func 的结果，这已经是一个承诺：

function create(name) {
      return db.func('create', name);
}

另外callsFake 接受一个函数，你给它一个承诺。请改用returns：

const dbStub = sinon.stub(db, 'func').returns(Promise.resolve(null))

我在设置noLocking 选项时遇到问题。文档声明它可以在初始化后设置，但是如果我使用db.$config.options.noLocking = true 设置它，则会发生同样的错误。但是，如果我在 database.js 初始化选项中设置它，它就可以正常工作。

来自pg-promise的作者...

这是因为此时noLocking 只能影响任务和事务。并且由于协议的db级别只启动一次，所以在库初始化后设置noLocking并没有影响。

我刚刚更新了documentation 以澄清它： This option is dynamic (can be set before or after initialization). However, changing it after the library's initialization will not affect Database objects that have already been created.