如何在 Jest 的 globalSetup 函数中使用模块导入 (@) 和 TypeScript？

Question

使用 JS 挂钩调用 TS setupGlobal 函数（在模块导入时使用，例如 @app/blablabla.ts），我收到错误 Cannot find module '@config/config'。我已经描述了moduleNameMapper，它正在测试中工作，但似乎不在setupGlobal 函数中。我该如何解决？

正如我所写，moduleNameMapper 已被描述，Jest 可以理解测试中的那些（在模块中）导入。

jest.config.js

module.exports = {
  roots: ['<rootDir>/src'],
  transform: {
    '^.+\\.tsx?$': 'ts-jest',
  },
  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
  moduleDirectories: ['node_modules', 'src'],
  moduleNameMapper: {
    '@tests-suite/(.*)': '<rootDir>/src/tests/tests-suite/$1',
    '@config/(.*)': '<rootDir>/config/$1',
    '@tests/(.*)': '<rootDir>/src/tests/$1',
    '@src/(.*)': '<rootDir>/src/$1',
  },
  globalSetup: "<rootDir>/src/tests/unit/jestGlobalSetup.js"
}

jestGlobalSetup.js

require("ts-node/register");
module.exports = require('./setupTestEnvironment').default;

setupTestEnvironment.ts

import { dbConnectionManager } from '@src/dbConnectionManager'

// tslint:disable-next-line:no-default-export
export default async () => {
  if (process.env.NODE_ENV === 'test') {
    setupTestEnvironment()
  }
}

const setupTestEnvironment = async () => {
  await dbConnectionManager.awaitConnection()
}

我希望“at module”导入将在 setupGlobal 函数中执行，但它会引发错误。

Answer 1

好的。问题是我们使用绝对路径通过安装ts-jest 并添加下一个jest.config.js 得到解决：

    module.exports = {
  roots: [
    '<rootDir>/src',
  ],
  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
  moduleFileExtensions: [
    'js',
    'json',
    'jsx',
    'node',
    'ts',
    'tsx',
  ],
  moduleDirectories: [
    'node_modules',
    'src',
  ],
  moduleNameMapper: {
    '^@tests\\-suite/(.*)$': '<rootDir>/src/tests/tests-suite/$1',
    '^@admin/(.*)$': '<rootDir>/src/admin/$1',
    '^@common/(.*)$': '<rootDir>/src/common/$1',
    '^@app/(.*)$': '<rootDir>/src/app/$1',
    '^@partners/(.*)$': '<rootDir>/src/partners/$1',
    '^@config/(.*)$': '<rootDir>/config/$1',
    '^@tests/(.*)$': '<rootDir>/src/tests/$1',
    '^@src/(.*)$': '<rootDir>/src/$1',
  },
  setupFilesAfterEnv: [`<rootDir>/src/tests/setup/GlobalSetup.ts`],
  preset: 'ts-jest',
  testMatch: null,
};

我们的运行脚本看起来像这样"test:jest": "NODE_ENV=test yarn ts-node -r tsconfig-paths/register ./src/tests/setup/testInit.ts"

而 testInit 看起来像这样；

import { runCLI } from 'jest'

// globalSetup
async function init() {
  console.log('Initialization')

  await runCLI({ config: './jest.config.js', watch: true } as any, [__dirname])

  // Do all your initialization stuff
  // I use a setTimeout to simulate true async
  return new Promise<void>((resolve, _reject) => {
    setTimeout(() => {
      console.log('Init finished')
      resolve()
    }, 1000)
  })
}

// globalTeardown
async function afterTests(): Promise<void> {
  console.log('End of tests - Execute something')
}

init()
  .then(() => {
    afterTests()
  })
  // tslint:disable-next-line:no-console
  .catch(e => console.error(e))

GlobalSetup.ts 如下所示：

import { DBConnectionManager } from '@src/DBConnectionManager'

beforeAll(async () => {
  await DBConnectionManager
  .awaitConnection()
})

所以DBConnectionManager 只是 TypeORM 的包装器，它为我们提供了连接。它在每次测试之前连接到真正的测试数据库。它现在有效。