【发布时间】:2021-04-06 12:24:59
【问题描述】:
我试图在打字稿项目中使用 jest 来模拟 express。使用我在这里看到的解决方案尝试很多方法来做到这一点,并表达出来作为未定义或不是函数。我才刚刚开始使用 Jest 并进行一般测试。
这是测试,
import { Server } from '../app/index'
import { AppRouter } from '../app/AppRouter'
jest.mock('../app/AppRouter')
//mock express
const expressMock = {
use: jest.fn()
}
jest.mock('express', () => () => expressMock)
//mock decorators
jest.mock('../app/controllers/RootController', () => jest.fn())
jest.mock('../app/controllers/LoginController', () => jest.fn())
jest.mock('../app/controllers/decorators/controller', () => jest.fn())
describe('Server test suite', () => {
test('should create server on port 3000', () => {
new Server().startServer()
console.log('test ran')
})
})
这是我正在测试的代码,
import express from 'express'
import bodyParser from 'body-parser'
import cookieSession from 'cookie-session'
import { AppRouter } from './AppRouter'
import './controllers/LoginController'
import './controllers/RootController'
export class Server {
private app: express.Express = express()
public startServer() {
console.log('Express is:', express())
this.app.use(bodyParser.urlencoded({ extended: true }))
this.app.use(cookieSession({ keys: ['alsdfsdf'] }))
this.app.use(AppRouter.getInstance())
this.app.listen(3000, () => {
console.log('Listening on port 3000')
})
}
}
new Server().startServer()
和配置,
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./build", /* Redirect output structure to the directory. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
"moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
"allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
"experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
"emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
/* Advanced Options */
"skipLibCheck": true, /* Skip type checking of declaration files. */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}
【问题讨论】:
-
答案解释了模拟的问题,但它可能不会有帮助,因为目的不清楚。所以 Express 和控制器都被嘲笑了,还有什么需要测试的呢? Express 中没有控制器,因此它们可能不需要作为单独的单元进行测试。 Express 集成测试的一种常见方法是模拟其他单元(模型)和副作用,并使用 Supertest 执行请求。它不适合您的项目。
Server是一个无法有效测试的虚构实体。更好的方法是拥有App(不带app.listen)并在另一个入口点设置服务器 -
@EstusFlask 我的目标是单元测试而不是集成测试。也许测试使用被调用了 3 次,并且服务器启动了?我应该用实际的快递而不是嘲笑它吗?然后只是模拟我在其他测试中看到的请求和响应?不确定您的意思-“更好的方法是拥有 App(没有 app.listen)并在另一个入口点设置服务器”感谢您的帮助!
-
根据我的经验,对独立于框架的路由处理程序(控制器)进行单元测试是不值得的,因为它们非常特定于 Express 的行为方式。如果需要,您可以模拟一些中间件。我的意思是应该在不同的模块中分别创建应用程序实例(
app带有中间件的对象)和服务器实例(app.listen(...)对象`)。在测试中,您要导入应用程序实例而不是服务器实例。请参阅 Supertest 的示例。不这样做会使测试变得更加困难 - Jest 测试是并发的,并且会尝试同时收听 3000 个。
标签: javascript node.js typescript unit-testing jestjs