测试嵌套在 Promise 中的回调

Question

tl;dr 我需要测试我的方法是否会在成功加载 Google 电子表格时向电子表格添加一行。

saveDataToGoogleSpreadSheet(conversationData){
  return new Promise((resolve, reject) => {
    Spreadsheet.load(this.getGoogleAPISettings(), (err, spreadsheet) => {
      if (err) {
        return reject(err);
      }

      return spreadsheet.receive((receivedError, rows, info) => {
        if (receivedError) {
          return reject(receivedError);
        }
        const rowData = this.getSpreadsheetRowData(conversationData, info.totalRows);
        spreadsheet.add(rowData);
        return spreadsheet.send(sendError => (sendError ? reject(sendError) : resolve()));
      });
    });
  });
}

我测试了函数的案例一和案例二（两个第一个错误），但我无法为最后一个，我们在电子表格中添加一行的成功案例。

我需要一些关于测试结构的帮助，或者关于我的测试如何的提示。

编辑：之前的测试是如何进行的

it('should add a row to a Google Spreadsheet', (done) => {
      nock('https://spreadsheets.google.com')
      .post('/feeds/cells/1ZOd7Sysc-JNa-D5AHb7ZJkwBRMBGaeKpzIwEl7B8RbQ/1/private/full/batch')
      .replyWithError({ message: 'abcde' });
      api.saveDataToGoogleSpreadSheet({ data: 'some data' })
      .then(() => done(new Error('should not have made the call')))
      .catch((err) => {
        expect(err).to.equal('Error Reading Spreadsheet');
        done();
      });
    }).timeout(4000);

Answer 1

很难从您拥有的小代码中判断测试的问题是什么，并且没有关于各种对象是什么以及它们如何产生的背景，所以我将假设Spreadsheet 是一个对象它是通过您需要的库创建的，除此之外，所有其他对象都是由模块创建的。即我假设您在某处有类似这样的线：

const Spreadsheet = require('some-google-docs-spreadsheet-lib');

这意味着一个问题是找出如何控制Spreadsheet 对象，以便我们可以消除它的行为。

刚开始，您可能会从这两个答案中获得一些关于通用代码和测试结构的良好指示，以便于测试，因为它们涵盖了两种最相关的技术：依赖注入和利用链接接缝。

• Mocking Redis Constructor with Sinon
• How to test an ES6 class that needs jquery?

据我所知，您可能已经使用了其中一种技术，正如您所说，您已经能够测试这两种错误情况。但也许您并没有真正进行单元测试，而是对服务进行了实际的网络调用（这更像是一个集成测试）？无论如何，我假设不会超过我上面写的内容，并向您展示如何使用 proxyquire 进行测试：

const assert = require('assert');
const dummy = ()=> {};
const SpreadSheetStubLibrary = { load: dummy };
const MyClassToTest = proxyquire('../src/my-module', { 
    'some-google-docs-spreadsheet-lib': SpreadSheetStubLibrary
})
const config = {};
const conversationData = {};

let stubSetup;
let spreadsheet;
let myObj;

function setupStubs() {
    stubSetup = stubSpreadsheetLoadFunction();
    spreadsheet = stubSetup.spreadsheet;
    SpreadSheetStubLibrary.load = stubSetup.load;

    myObj = new MyClassToTest(config);
    conversationData = {};
};

function createSpreadsheetStubObj(){
    return {
        receive: sinon.stub(),
        add: sinon.stub(),
        send: sinon.stub()
    }
}

function stubSpreadsheetLoadFunction(){
    const spreadsheet = createSpreadsheetStubObj();

    return { 
        load: (settings, cb) => cb(null, spreadsheet),
        spreadSheetStubObj: spreadsheet
    };
}


it('should add a row to the spreadsheet on successful load', () => {
    // Arrange
    setupStubs();
    const rowData = { foo: 1, bar: 2};
    spreadsheet.receive.yields(); // calls any callback given
    myObj.getSpreadsheetRowData = () => rowData; // see lines below

    // if you want to use the real getSpreadsheetRowData, uncomment these lines
    //const rows = []; // not used in the method?
    //const info = { totalRows : 100 };
    //spreadsheet.receive.yields(null, rows, info);

    // Act
    return myObj.saveDataToGoogleSpreadSheet(conversationData).then(()=>{
        // Assert
        assert(spreadsheet.add.calledOnce);
        assert(spreadsheet.add.calledWith(rowData));
    });
});


it('should add a row to the spreadsheet on successful load', () => {
    // reuse the above
});

请参阅Sinon docs for the stub API。

披露：我是 Sinon 维护团队的一员。