使用sinon存入表达中间件的功能是

时间:2018-08-30 11:29:24

标签: javascript node.js testing mocha sinon

说明

我尝试为快速的中间件功能设置存根伪造品,并且它不会替代。

我正在尝试(如何复制)

我正尝试通过callsFake函数使用sinon存根,就像他们的最新文档所建议的那样。

即使我需要模块并在导出时从属性中替换功能。我一直看到原始的函数行为在起作用。

我知道我应该尝试在设置中间件功能之前将功能存根,那是在第一次导入express app时。

这是我要存根的函数,定义为函数并也导出为对象。它是在脚本文件中定义的,其路径类似于api/middlewares/stripe/signature

const stripeHelper = require('../../../lib/stripe')
const logger = require('../../../lib/logger')
const verifySignature = (req, res, next) => {
  var event
  let eventName = req.url.replace('/', '')
  try {
      // Try adding the Event as `request.event`
    event = stripeHelper.signatureCheck(
        eventName,
        req.body,
        req.headers['stripe-signature']
      )
  } catch (e) {
      // If `constructEvent` throws an error, respond with the message and return.
    logger.error('Error while verifying webhook request signature', e.message, e)
    return res.status(400).send('Webhook Error:' + e.message)
  }
  req.event = event
  next()
}
module.exports.verifySignature = verifySignature

我已经尝试过的东西

  • 使用decache来确保express应用实例是原始的,并且没有使用先前的原始中间件进行初始化
  • 设置多个beforEach钩子以组织我的存根和前提条件或测试

正在发生的事情

  • 原始的中间件功能被执行
  • 我没有看到存根函数的任何日志(这是sinon存根不起作用的第二个证据

这是我的存根和测试钩子设置:

const chai = require('chai')
const chaiHttp = require('chai-http')
const dirtyChai = require('dirty-chai')
const sinon = require('sinon')
const decache = require('decache')
const signatureMiddleware = require('../../../api/middlewares/stripe/signature')
const bp = require('body-parser')
let verifySignatureStub, rawStub

chai.should()
chai.use(dirtyChai)
chai.use(chaiHttp)

const API_BASE = '/api/subscriptions'
const planId = 'NYA-RUST-MONTHLY'
const utils = require('../../utils')
const {
  hooks: {createSubscription, emitPaymentSucceeded},
  stripe: {generateEventFromMock}
} = utils

let testUser, testToken, testSubscription, server

describe.only('Subscriptions renewal (invoice.payment_succeeded)', function () {
  this.timeout(30000)

  beforeEach(function (done) {
    createSubscription(server, {planId}, function (err, resp) {
      if (err) return done(err)
      const {user, jwt, subscription} = resp
      console.log(user, jwt)
      testUser = user
      testToken = jwt
      testSubscription = subscription
      done()
    })
  })

  beforeEach(function (done) {
    verifySignatureStub = sinon.stub(signatureMiddleware, 'verifySignature')
    rawStub = sinon.stub(bp, 'raw')
    rawStub.callsFake(function (req, res, next) {
      console.log('bp raw')
      return next()
    })
    verifySignatureStub.callsFake(function (req, res, next) {
      const {customerId} = testUser.stripe
      const subscriptionId = testSubscription.id
      console.log('fake verify')
      req.event = generateEventFromMock('invoice.payment_failed', {subscriptionId, customerId, planId})
      return next()
    })
    done()
  })

  beforeEach(function (done) {
    decache('../../../index')
    server = require('../../../index')
    const {customerId} = testUser.stripe
    const {id: subscriptionId} = testSubscription
    console.log(`emitting payment succeeded with ${customerId}, ${subscriptionId} ${planId}`)
    emitPaymentSucceeded(server, testToken, function (err, response) {
      if (err) return done(err)
      done()
    })
  })

  afterEach(function (done) {
    verifySignatureStub.restore()
    done()
  })

  it('Date subscription will renew gets set to a valid number roughly one month', function () {
    // Not even getting here becasue calling the original function contains verifyMiddleware which should be replaced
  })

  it('Current period end is modified')

  it('An invoice for the new starting period is generated')

  it('Subscription status keeps active')
})

上下文(请填写以下信息):

所有程序都在Node 8上运行,而我正在使用mocha进行测试,并使用脏柴进行了设置。

这些是我的开发依赖项:

"devDependencies": { "base64url": "^2.0.0", "cross-env": "^5.0.5", "decache": "^4.4.0", "dirty-chai": "^2.0.1", "faker": "^4.1.0", "google-auth-library": "^0.12.0", "googleapis": "^23.0.0", "minimist": "^1.2.0", "mocha": "^5.2.0", "nodemon": "^1.12.0", "nyc": "^11.2.1", "sinon": "^6.1.5", "standard": "^10.0.3", "stripe-local": "^0.1.1" }

公开问题

https://github.com/sinonjs/sinon/issues/1889

1 个答案:

答案 0 :(得分:1)

根据经验,应根据测试设置存根,即在beforeEachit中而不是在before中进行。在这里,它们似乎不包含每次测试逻辑,但可以包含它们,在这种情况下,它们将无法像预期的那样before起作用。 mocha-sinon最好用于将Mocha与Sinon沙箱集成,因此无需afterEach即可恢复存根,这是自动完成的。

由于verifySignature是导出属性,而不是导出本身,因此signatureMiddleware模块可以保留原样,但是使用该模块的模块应该在期望的测试中进行缓存和重新导入使用verifySignature。如果整个测试套件的行为相同,则也应在beforeEach中执行。例如。如果直接在app模块中使用这些中间件,则为:

const decache = require('decache');

...

  describe(() => {
    let app;

    beforeEach(() => {
      verifySignatureStub = sinon.stub(signatureMiddleware, 'verifySignature');
      ...
    });

    beforeEach(() => {
      decache('./app');
      app = require('./app');
    });