Typescript 测试中的模拟中间件调用

Question

我正在尝试为我的 Typescript Node.js 应用程序编写测试。我正在使用 Mocha 框架和 Chai 断言库。在添加自定义中间件（如身份验证检查）之前，一切都运行良好。我尝试使用 Sinon.JS 来模拟对此中间件的调用，但我无法让它正常工作。任何帮助，将不胜感激。

我的 app.ts 文件如下所示：

class App {
public express: express.Application;

constructor() {
this.express = express();
this.routeConfig();
}

private routeConfig(): void {
CustomRouteConfig.init(this.express);
}
}

自定义路由配置文件：

export default class CustomRouteConfig {
static init(app: express.Application) {
app.use('/:something', SomethingMiddleware);
app.use('/:something', SomeAuthenticationMiddleware);
app.use('/:something/route1/endpointOne', ControllerToTest);

app.use(NotFoundHandler);
app.use(ErrorHandler);
}
}

我的 ControllerToTest.ts 文件如下所示：

export class ControllerToTest {
router  : Router;  

constructor() {   
this.router = Router();
this.registerRoutes();
}

public getData(req: Request, res: Response, next: NextFunction) {
//some logic to call Restful API and return data
}

private registerRoutes() {
this.router.get('/', this.getData.bind(this));
}
}

export default new ControllerToTest().router;

我的 SomethingMiddleware 如下所示：

export class SomethingMiddleware {
something = (req: Request, res: Response, next: NextFunction) => {
//some logic to check if request is valid, and call next function for either valid or error situation
}
}

export default new SomethingMiddleware().something;

此场景的测试文件如下所示：

describe('baseRoute', () => {

it('should be json', () => {

return chai.request(app).get('/something/route1/endPointOne')
  .then(res => {
     expect(res.type).to.eql('application/json');
  });
});

});

在这种情况下，使用 Sinon.JS 模拟或存根的最佳方法是什么？此外，如果您认为有更好的方法来为这种情况编写测试，我们也将不胜感激。

Answer 1

我最终使用了 sinon 存根。我将这些与 Mocha 的 before 和 after 函数结合起来，以控制在测试期间调用某些外部库时发生的情况。此外，我在数据库调用和中间件检查中使用了它，因为这些对我的单元测试不感兴趣。下面是我如何做的一个例子。

describe("ControllerToTest", () => {

// Sinon stubs for mocking API calls
before(function () {
    let databaseCallStub= sinon.stub(DatabaseClass, "methodOfInterest", () => {
        return "some dummy content for db call";
    });

    let customMiddlewareStub= sinon.stub(MyCustomMiddleware, "customMiddlewareCheckMethod", () => {
        return true;
    });
    let someExternalLibraryCall= sinon.stub(ExternalLibrary, "methodInExternalLibrary", () => {
        return "some dummy data"
    });

});

after(function () {
    sinon.restore(DatabaseClass.methodOfInterest);
    sinon.restore(MyCustomMiddleware.customMiddlewareCheckMethod);
    sinon.restore(ExternalLibrary.methodInExternalLibrary);
});

it("should return data", () => {
    return chai.request(app).get('/something/route1/endPointOne')
.then(res => {
 expect(res.type).to.eql('application/json');
});
});

Typescript 测试中的模拟中间件调用

Mock middleware calls in Typescript testing

mocha.js

node.js

sinon

chai

typescript