使用 Sinon 来模拟服务模块
kat*_*son 1 unit-testing node.js sinon sinon-chai
我已经进入了单元测试阶段，说实话，网上所有不同的例子让我感到困惑。我对Mocha & Chai很了解，但Sinon却是另一回事。
所以我有一个我认为非常简单的设置。我有一个调用控制器的 POST 路由。这个控制器就像这样（删除了一些基本的验证代码）
const { createUser } = require('../services/user.service');
const apiResponse = require('../helpers/apiResponse');
const postUser = async (req, res) => {
const user = {
account_id: req.body.id,
status: req.body.status,
created_at: new Date(),
updated_at: new Date(),
};
const result = await createUser(user);
return apiResponse.successResponseWithData(res, 'User added.', result.affectedRows);
} catch (err) {
return apiResponse.errorResponse(res, err);
}
};
module.exports = {
postUser,
};
所以它真正做的就是验证，然后使用 req 创建一个用户对象并将其传递给服务类。该服务类只是将数据传递给数据库类。
const { addUserToDb } = require('../database/user.db');
const createUser = async (user) => {
try {
const createdUser = await addUserToDb(user);
return createdUser;
} catch (err) {
throw new Error(err);
}
};
module.exports = {
createUser,
};
我不会展示数据库类，因为我首先要关注的是控制器，然后我希望可以自己完成其余的工作。
所以根据我的理解，我应该测试功能。如果一个函数进行外部调用，我应该监视、模拟、存根该调用吗？我应该只监视、模拟或存根此函数依赖项，如果其中一个依赖项有自己的依赖项（如上面的服务模块具有数据库调用依赖项），这应该在另一个测试中执行吗？抱歉，只是问几个问题来帮助我理解。
无论如何，我创建了一个 user.controller.test.js 文件。我还没有走得太远，但这就是我到目前为止所拥有的
const chai = require('chai');
const sinon = require('sinon');
const { expect } = chai;
const faker = require('faker');
const controller = require('../controllers/user.controller');
const service = require('../services/user.service');
const flushPromises = () => new Promise(setImmediate);
describe('user.controller', () => {
describe('postUser', () => {
beforeEach(() => {
//I see a lot of code use a beforeEach, what should I be doing here?
});
it('should create a user when account_id and status params are provided', async () => {
const req = {
body: { account_id: faker.datatype.uuid(), status: 'true' },
};
const stubValue = {
id: faker.datatype.id(),
account_id: faker.datatype.uuid(),
status: 'true',
created_at: faker.date.past(),
updated_at: faker.date.past(),
};
});
});
});
如果我完全诚实的话，我对我应该在这里测试什么感到非常困惑。根据我的理解，我需要模拟我认为的服务模块。
有人可以提供一些关于我在这次测试中应该做什么的见解吗？
非常感谢
更新
感谢您的详细回复，我已经设法让间谍工作，这是向前迈出的一步。所以我想对我的服务模块、方法进行测试createUser。
您可以看到我的createUser方法采用用户对象作为参数，并将其传递到数据库模块，在数据库模块中将其插入数据库，然后返回用户对象。
因此，在测试我的服务类时，我需要模拟对我的数据库模块的调用。
const chai = require('chai');
const sinon = require('sinon');
const { expect } = chai;
const faker = require('faker');
const service = require('../services/user.service');
const database = require('../database/user.db');
describe('user.service', () => {
describe('createUser', () => {
it('should create a user when user object is provided', async () => {
const user = {
id: faker.datatype.string(),
status: 'true',
created_at: faker.date.past(),
updated_at: faker.date.past(),
};
const expectedUser = {
id: user.id,
status: user.status,
created_at: user.created_at,
updated_at: user.updated_at,
};
const mockedDatabase = sinon.mock(database);
mockedDatabase.expects('addUserToDb').once().withArgs(expectedUser);
await service.createUser(user);
mockedDatabase.verify();
mockedDatabase.restore();
});
});
});
当我测试这个时，我似乎得到了这个响应，并且它似乎仍然将记录插入到我的数据库中。
ExpectationError: Expected addUserToDb({
id: 'yX7AX\\J&gf',
status: 'true',
created_at: 2020-06-03T03:10:23.472Z,
updated_at: 2020-05-24T14:44:14.749Z
}, '[...]') once (never called)
at Object.fail (node_modules\sinon\lib\sinon\mock-expectation.js:314:25)
你知道我做错了什么吗？
谢谢
在我尝试之前，我想建议将try/catch块放在各处，我假设您在 Node 应用程序中使用expressJs，为此，请看一下express-promise-router使用该路由器（而不是默认路由器）会自动执行catch任何操作被抛出了，你只需要关注代码......
以你的例子为例，你会写：
const { addUserToDb } = require('../database/user.db');
const createUser = async (user) => addUserToDb(user);
module.exports = {
createUser,
};
和
const { createUser } = require('../services/user.service');
const apiResponse = require('../helpers/apiResponse');
const postUser = async (req, res) => {
const { id: account_id, status } = res.body;
const result = await createUser({ account_id, status }); // set the date in the fn
return apiResponse.successResponseWithData(res, 'User added.', result.affectedRows);
};
module.exports = {
postUser,
};
如果出现错误并且在路线上的某个地方抛出错误，您将在响应中收到一条带有错误的好消息
关于代码本身，阅读起来似乎更清晰 - 请记住，代码是为人类编写的，机器甚至不关心你如何命名变量
现在，关于测试......我确实倾向于将事情分为三部分
- 单元测试：函数本身，单个函数，如验证、帮助程序等
- 集成测试：当您调用 API 端点时应返回什么
- GUI 测试（或端到端/e2e）：当 GUI 存在时应用，暂时跳过此测试
因此，就您而言，首先要确定的是您正在测试什么......并采取这一点，从小块（单元测试）开始，然后向上移动到确保所有内容都粘合在一起的块（e2e）
所以它真正做的就是验证，然后使用 req 创建一个用户对象并将其传递给服务类。该服务类只是将数据传递给数据库类。
似乎是一个很好的开始方式，所以它“验证”...让我们测试我们的验证，让我们通过null, undefined,string当你想要的只是int等等，直到我们得到一个很好的想法，无论它通过，我们都会正确回复并且没有错误
注意我倾向于使用 OpenAPI 规范，这对我来说更容易，因为它提供了两件事
是的，我总是测试一些验证，只是为了确保它按预期工作，即使我 100% 信任该工具
所以根据我的理解，我应该测试功能。
嗯，应用程序是一组函数，所以一切都很好
如果一个函数进行外部调用，我应该监视、模拟、存根该调用吗？
我会尽力解释什么是诗农中的间谍、存根和嘲讽，请温柔点
间谍
它们告诉我们有关函数调用的信息，例如调用次数、参数、返回值等等 - 它们有两种类型：匿名间谍或在我们的代码中包装方法的间谍
function testMyCallback(callback) { callback(); }
describe('testMyCallback fn', function() {
it('should call the callback', function() {
const callbackSpy = sinon.spy(); // anonymous spy - no arguments
testMyCallback(callbackSpy);
expect(callbackSpy).to.have.been.calledOnce;
});
});
const user = {
setNname: function(name) {
this.name = name;
}
}
describe('setname fn', function() {
it('should be called with name', function() {
const setNameSpy = sinon.spy(user, 'setName'); // wrap method spy
user.setName('Katie');
expect(setNameSpy).to.have.been.calledOnce;
expect(setNameSpy).to.have.been.valledWith('Katie');
setNameSpy.restore(); // to remove the Spy and prevent future errors
});
});
存根
是强大的间谍，因为它们具有 Spies 的所有功能，但它们替换了目标函数，它们具有可以返回特定值或抛出特定异常等的方法
它们非常适合用于解决有关外部调用的问题，因为它们替换了调用（因此您可以模拟调用行为并且永远不要使用原始调用）
最简单的例子是：
function isAdult(age) {
return age > 21;
}
describe('Sinon Stub Example', () => {
it('should pass', (done) => {
const isAdult = sinon.stub().returns('something');
isAdult(0).should.eql('something');
isAdult(0).should.not.eql(false);
done();
});
});
我们已经对我们的函数进行了 STUB 处理，并明确表示它是一个返回字符串的“函数” something……从现在开始，我们将永远不需要去函数本身，因为我们已经对它进行了 STUB，我们已经替换了它我们自己的真实行为
在集成测试中调用 API 应用程序时使用 STUB 的另一个示例
describe('when we stub our API call', () => {
beforeEach(() => {
this.get = sinon.stub(request, 'get'); // stub "request.get" function
});
afterEach(() => {
request.get.restore(); // remove our power-spy
});
describe('GET /api/v1/accounts', () => {
const responseObject = {
status: 200,
headers: {
'content-type': 'application/json'
}
};
const responseBody = {
status: 'success',
data: [
{
accountId: 1,
status: 'active'
},
{
accountId: 2,
status: 'disabled'
}
]
};
it('should return all accounts', (done) => {
// the 3 objects of our callback (err, res, body)
this.get.yields(null, responseObject, JSON.stringify(responseBody));
request.get(`${base}/api/v1/movies`, (err, res, body) => {
expect(res.statusCode).to.be.eql(200);
expect(res.headers['content-type']).to.contain('application/json');
body = JSON.parse(body);
expect(body).to.be.an('array').that.includes(2);
done();
});
});
});
});
您还可以存根axios，但您将需要一个新的库，moxios或proxyquire或更多...
模拟
与存根（我们的 Power-Spies）有点相似，但它们可用于替换整个对象并改变其行为，它们主要用于当您需要从单个对象中存根多个函数时 - 如果您需要的只是替换单个函数，存根更容易使用
模拟会让事情变得过于简单，你甚至可能在不知情的情况下破坏你的应用程序，所以要注意......
通常的用途是，例如
function setupNewAccount(info, callback) {
const account = {
account_id: info.id,
status: info.status,
created_at: new Date(),
updated_at: new Date()
};
try { Database.save(account, callback); }
catch (err) { callback(err); }
}
describe('setupNewAccount', function() {
it('', function() {
const account = { account_id: 1, status: 'active' };
const expectedAccount = {
account_id: account.id, status: account.status
};
const database = sinon.mock(Database);
database.expectes('save').once().withArgs(expectedAccount);
setupNewAccount(account, function() {});
database.verify();
database.restore();
});
});
我们会一直忘记的是这个.restore()部分，为此，有一个包（还有一个......）称为sinon-test它将在测试结束时自动清理
我只是希望它能帮助您解决一些问题，现在更清楚了
顺便说一句，对于存根HTTP请求，我使用它nock是因为我认为它比Sinon更容易阅读和使用，特别是对于那些第一次阅读代码并且没有Sinon或Nock经验的人......
| 归档时间： |
|
| 查看次数： |
3011 次 |
| 最近记录： |