Angular 11 单元测试代码覆盖率现已突破

Posted 2023-03-16

【中文标题】Angular 11 单元测试代码覆盖率现已突破

【英文标题】：Angular 11 Unit Test Code Coverage is Now Breaking

【发布时间】：2021-02-24 20:02:28

【问题描述】：

在升级到 Angular 11 之前，我通过以下命令运行了包含代码覆盖率的单元测试：

ng test --project my-app --code-coverage true

当我将我的项目升级到 Angular 11 时，我仍然能够进行代码覆盖率测试，但我开始收到一条消息，说“自版本 11 以来，'karma-coverage-istanbul-reporter' 的使用已被弃用”。它要求我安装 karma-coverage 并更新 karma.conf.js。所以我按照它的要求做了。我通过这个命令安装了 karma-coverage 和 karma：

npm install karma karma-coverage --save-dev

因此，我在 package.json 中的 devDependencies 下看到了 karma 的条目：

"karma": "^5.2.3",<br>
"karma-coverage": "^2.0.3"

我更新了我的 karma.conf.js 文件。以下是存在的，除了我的cmets，一切都和原来一样：

module.exports = function (config) 
  config.set(
    basePath: '',
    frameworks: ['jasmine', '@angular-devkit/build-angular'],
    plugins: [
      require('karma-jasmine'),
      require('karma-chrome-launcher'),
      require('karma-jasmine-html-reporter'),
      require('karma-coverage'), // NEWLY ADDED
      // ORIGINALLY HERE NOW REMOVED require('karma-coverage-istanbul-reporter'),
      require('@angular-devkit/build-angular/plugins/karma')
    ],
    client: 
      clearContext: false // leave Jasmine Spec Runner output visible in browser
    ,
    reporters: ['progress', 'kjhtml', 'coverage'],
    // coverageIstanbulReporter NO LONGER HERE
    //coverageIstanbulReporter: 
    //  dir: require('path').join(__dirname, '../../coverage/my-app'),
    //  reports: ['html', 'lcovonly', 'text-summary'],
    //  fixWebpackSourcePaths: true
    //,
    // coverReporter NEWLY ADDED
    coverageReporter: 
      dir: 'build/reports/coverage',
      reporters: [
         type: 'html', subdir: 'report-html' ,
         type: 'lcov', subdir: 'report-lcov' 
      ]
    ,
    // THE FOLLOWING REMAINED AS IS
    port: 9876,
    colors: true,
    logLevel: config.LOG_INFO,
    autoWatch: true,
    browsers: ['Chrome'],
    singleRun: false,
    restartOnFileChange: true
  );
;

进行此更新后，发生了两件事，我不知道为什么。

当我运行正常的代码覆盖命令时，我收到以下错误：“端口 9876 上的服务器启动失败：错误：必须安装 karma-coverage 才能运行代码覆盖。”正如我的 package.json 所示，我确实安装了它，但由于某种原因，我的项目无法识别它。此外，如果我将 karma-coverage-istanbul-reporter 要求方法添加到我的 conf.js 文件中，覆盖工作正常，但我仍然收到该弃用消息。谁能向我解释为什么我会收到这个错误？

当我在没有覆盖的情况下运行测试时，我现在收到多个以前从未遇到过的警告，例如：“无法从文件扩展名确定文件类型，默认为 js。 要使警告静音，请在配置文件中为 C:/Angular/my-project/projects/my-app/src/app/app.component.spec.ts 指定一个有效类型。”我需要做些什么来解决这个问题?

编辑：我找到了答案。在coverageReporter 对象中，您需要将fixWebpackSourcePaths 属性添加为true：

coverageReporter: 
  dir: 'build/reports/coverage',
  reporters: [
     type: 'html', subdir: 'report-html' ,
     type: 'lcov', subdir: 'report-lcov' 
  ],
  fixWebpackSourcePaths: true
,

【参考方案1】：

对我来说，诀窍是从记者中删除'coverage'。它应该是：

reporters: ['progress', 'kjhtml'],

然后按预期创建覆盖率报告，而不会引发奇怪的警告。

这似乎是 Angular 的方式，看看karma.conf.js generated by the ng new schematics。

【讨论】：

这为我修好了！我现在可以创建覆盖率报告而不会出错。干得好！

我使用了上面的链接 karma.conf.js 并替换了 'dir' 行并且它起作用了。

嗯，我遵循了所有这些想法，但它总是说，“错误：必须安装 karma-coverage 才能运行代码覆盖率”，即使它已安装......

@Jim 您可能忘记将其添加到配置中的插件列表中

【参考方案2】：

另外，我发现reporters 必须有一个subdir 字段：

没用

reporters: [
     type: 'html' 

没用

reporters: [
     type: 'html', subdir: '' 

作品：

reporters: [
     type: 'html', subdir: 'report-html'