实例的存根方法

Question

我有一个使用node-slack-sdk的Express应用程序，当某些endpoint被击中时，它会使帖子松弛。我正在尝试为一个路由编写集成测试，其中包括调用该库中的方法。

我想从Slack库中阻止某些方法的所有默认行为，并简单地断言这些方法是用某些参数调用的。

我试图把问题简单化。如何建立webclient实例的方法（实际上嵌套在chat中）的存根，阻止原始功能，并断言它是用什么参数调用的？

我尝试了很多没有成功的东西，所以我在这里编辑了这个，并提供了一个大大简化的设置：

index.html:

const express = require('express');
const {WebClient} = require('@slack/client');
const app = express();
const web = new WebClient('token');

app.post('/', (req, res) => {

    web.chat.postMessage({
        text: 'Hello world!',
        token: '123'
    })
        .then(() => {
            res.json({});
        })
        .catch(err => {
            res.sendStatus(500);
        });
});

module.exports = app;

'use strict';
const app = require('../index');
const chai = require('chai');
const chaiHttp = require('chai-http');
const sinon = require('sinon');

const expect = chai.expect;
chai.use(chaiHttp);

const {WebClient} = require('@slack/client');


describe('POST /', function() {
    before(function() {
        // replace WebClient with a simplified implementation, or replace the whole module.
    });

    it('should call chat.update with specific arguments', function() {
        return chai.request(app).post('/').send({})
            .then(function(res) {
                expect(res).to.have.status(200);
                // assert that web.chat.postMessage was called with {message: 'Hello world!'}, etc
        });
    });
});

Answer 1

您的示例的设计不是非常可测试的，这就是为什么您有这些问题。为了使其更具可测试性和内聚性，最好传入您的WebClient对象和其他依赖项，而不是在您的路由中创建它们。

const express = require('express');
const {WebClient} = require('@slack/client');
const app = express();//you should be passing this in as well. But for the sake of this example i'll leave it


module.exports = function(webClient) {
   app.post('/', (req, res) => {

       web.chat.postMessage({
          text: 'Hello world!',
          token: '123'
       })
           .then(() => {
              res.json({});
           })
           .catch(err => {
              res.sendStatus(500);
           });
   })
   return app;
};

为了实现这一点，请在更高的模块上构建对象/路由。（您可能必须编辑express为您生成的内容。我不确定，就我个人而言，我使用的是一个经过大量重构的express版本，以满足我的需要。）通过传入WebClient，现在可以为测试创建存根。

'use strict';

const chai = require('chai');
const chaiHttp = require('chai-http');
const sinon = require('sinon');

const expect = chai.expect;
chai.use(chaiHttp);
const {WebClient} = require('@slack/client');
const web = new WebClient('token');
let app = require('../index')(web);

describe('POST /', function() {

    it('should call chat.update with specific arguments', function() {
        const spy = sinon.spy();
        sinon.stub(web.chat, 'postMessage').callsFake(spy);

        return chai.request(app).post('/').send({})
            .then(function(res) {
                expect(res).to.have.status(200);
                assert(spy.calledWith({message: 'Hello world!'}));
        });
    });
});

这称为依赖注入。不是让索引模块构建它的依赖项WebClient，而是让较高的模块传入依赖项，以便它们控制它的较低模块的状态。您的较高模块，即您的测试，现在拥有了为较低模块，即索引创建存根所需的控件。

上面的代码只是快速工作。我还没有测试过它是否管用，但它应该能回答你的问题。