如何从代码覆盖率伊斯坦布尔记者中排除模拟文件

Posted 2023-02-22

【中文标题】如何从代码覆盖率伊斯坦布尔记者中排除模拟文件

【英文标题】：How to exclude mock files from Code Coverage Istanbul Reporter

【发布时间】：2019-03-03 11:07:27

【问题描述】：

我有一个关于伊斯坦布尔记者在我的 Angular 6 应用程序中用于报告我的单元测试覆盖率的问题。

我的问题是：当渲染覆盖时，我在测试文件列表中看到了模拟，显然模拟没有经过测试，这给了我错误的覆盖统计。

这是我同事设置的 karma.conf 文件，我想知道您是否知道如何排除这些模拟文件。

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-istanbul-reporter'),
      require('@angular-devkit/build-angular/plugins/karma')
    ],
    client:
      clearContext: false // leave Jasmine Spec Runner output visible in browser
    ,
    coverageIstanbulReporter: 
      dir: require('path').join(__dirname, 'coverage'), reports: [ 'html', 'lcovonly' ],
      fixWebpackSourcePaths: true
    ,
    angularCli: 
      environment: 'local'
    ,
    reporters: ['progress', 'kjhtml'],
    port: 9876,
    colors: true,
    logLevel: config.LOG_INFO,
    autoWatch: true,
    browsers: ['Chrome'],
    singleRun: false
  );
;

我在 *** 上看到可以通过在 tsconfig.spec.json 中添加排除来完成，但即使重新运行代码覆盖率，它仍然包含它们。

  "extends": "../../tsconfig.json",
  "compilerOptions": 
    "outDir": "../../out-tsc/spec",
    "module": "commonjs",
    "types": [
      "jasmine",
      "node"
    ],
    "typeRoots": [ "../node_modules/@types" ]
  ,
  "files": [
    "src/test.ts",
    "src/polyfills.ts"
  ],
  "include": [
    "**/*.spec.ts",
    "**/*.d.ts"
  ],
  "exclude": [
    "/**/*mock*.ts"
  ]

我的模拟文件位于每个模块/功能的 tests/mocks 文件夹中，被称为“mock-whatevertheymock.ts”

运行它的命令是

test:wc-dogs": "ng test --project=wc-dogs--code-coverage

感谢您的帮助

【参考方案1】：

谢谢大家，解决方法是在 angular.json 中添加codeCoverageExclude 选项

   "test": 
              "builder": "@angular-devkit/build-angular:karma",
              "options": 
                "main": "projects/wc-claims/src/test.ts",
                "polyfills": "projects/wc-claims/src/polyfills.ts",
                "tsConfig": "projects/wc-claims/tsconfig.spec.json",
                "karmaConfig": "projects/wc-claims/karma.conf.js",
                "styles": [
                  "projects/wc-claims/src/styles.css"
                ],
                "scripts": [],
                "assets": [
                  "projects/wc-claims/src/favicon.ico",
                  "projects/wc-claims/src/assets"
                ],
                "codeCoverageExclude": [
                    "/**/*mock*.ts"
                ]
              
            ,

【讨论】：

我搜索这个。

当我在 codeCoverageExclude 下添加一个目录时，它对某些文件不起作用，这也是我在其中提供的目录

【参考方案2】：

您应该将 exclude 添加到 karma 配置中。

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-istanbul-reporter'),
      require('@angular-devkit/build-angular/plugins/karma')
    ],
    client:
      clearContext: false // leave Jasmine Spec Runner output visible in browser
    ,
    coverageIstanbulReporter: 
      dir: require('path').join(__dirname, 'coverage'), reports: [ 'html', 'lcovonly' ],
      fixWebpackSourcePaths: true
    ,
    angularCli: 
      environment: 'local'
    ,
    reporters: ['progress', 'kjhtml'],
    port: 9876,
    colors: true,
    logLevel: config.LOG_INFO,
    autoWatch: true,
    browsers: ['Chrome'],
    exclude: ["/**/*mock*.ts"],
    singleRun: false
  );
;

【讨论】：

不幸的是没有工作：/它们仍然出现在覆盖结果中

ts 文件在您的模拟文件夹中，对吗？它是 mock/test.ts ??

例如，假设 Dogs 文件夹 `` - Dog -- dog.service.ts -- dog.component.ts -- dog.component.html -- tests - -- dog.component.spec.ts --- 模拟 ---- mock-dog.service.ts ``

@Dinosan0908 在这种情况下，这个正则表达式不正确 ["/**/*mock*.ts"] 它应该是 ["/**/mock/*.ts"]。尝试更新它，因为我已经从测试覆盖范围中排除了文件。

好的，我在另一个答案上找到了一些东西，我会把它作为我问题的答案发布，谢谢先生的帮助！