javascript - 如何使用 karma 在我的 Aurelia 应用程序中获得代码覆盖率结果？

Question

我au new使用Aurelia CLI （

然后我首先将任务npm install karma-coverage --save-dev复制test.js到 a cover.js（以便我可以运行au cover）。

封面.js

import {Server as Karma} from 'karma';
import {CLIOptions} from 'aurelia-cli';
// import project from "../aurelia.json";

export function cover(done) {
  new Karma({
    // This is the same as what's in karma.conf.js after running
    // Except I added the 'src\\**\\*.js' part
    files: [
      'scripts\\vendor-bundle.js',
      {pattern: 'test\\unit\\**\\*.js', included: false},
      'test/aurelia-karma.js',
      'scripts\\app-bundle.js',
      'scripts\\materialize-bundle.js',
      {pattern: 'src\\**\\*.js', included: false}
    ],
    configFile: __dirname + '/../../karma.conf.js',
    singleRun: !CLIOptions.hasFlag('watch'),
    reporters: ['progress', 'coverage'],
    //logLevel: 'debug',
    preprocessors: {
      // [project.unitTestRunner.source]: [project.transpiler.id],  // Is this actually needed? Nothing changes if I add or remove this...
      'src/**/*.js': ['babel', 'coverage']
    },
    coverageReporter: {
      includeAllSources: true,
      reporters: [
        {type: 'html', dir: 'coverage'},
        {type: 'text'}
      ]
    }
  }, done).start();
}

export default cover;

这……把我带到某个地方？

但我不认为测试链接到单个 src 文件（而是链接到app-bundle.js）。

有没有办法在 src 文件级别（即不是捆绑级别）获得 Aurelia 应用程序的代码覆盖率？

其他感兴趣的文件

应用程序.js

export class App {
  constructor() {
    this.message = 'Hello World!';
  }
}

业力.conf.js

"use strict";
const path = require('path');
const project = require('./aurelia_project/aurelia.json');

let testSrc = [
  { pattern: project.unitTestRunner.source, included: false },
  'test/aurelia-karma.js'
];

let output = project.platform.output;
let appSrc = project.build.bundles.map(x => path.join(output, x.name));
let entryIndex = appSrc.indexOf(path.join(output, project.build.loader.configTarget));
let entryBundle = appSrc.splice(entryIndex, 1)[0];
let files = [entryBundle].concat(testSrc).concat(appSrc); console.log(files);

module.exports = function(config) {
  config.set({
    basePath: '',
    frameworks: [project.testFramework.id],
    files: files,
    exclude: [],
    preprocessors: {
      [project.unitTestRunner.source]: [project.transpiler.id]
    },
    'babelPreprocessor': { options: project.transpiler.options },
    reporters: ['progress'],
    port: 9876,
    colors: true,
    logLevel: config.LOG_INFO,
    autoWatch: true,
    browsers: ['Chrome'],
    singleRun: false,
    // client.args must be a array of string.
    // Leave 'aurelia-root', project.paths.root in this order so we can find
    // the root of the aurelia project.
    client: {
      args: ['aurelia-root', project.paths.root]
    }
  });
};

Answer 1

从您的终端屏幕截图中，除了捆绑文件之外，您似乎还覆盖了您的单个文件src/app.js(12.5%)、src/environment.js(0%) 和(12.5%)。src/main.js它与您添加的额外行有关，包括src/.

我怀疑如果你去你的覆盖目录并在浏览器中查看它，你会看到更详细的结果。

我不确定 Aurelia 应用程序的具体情况，但要获得单个文件覆盖率，您希望针对原始文件而不是捆绑版本运行测试，并且您希望原始文件的相同路径也位于预处理器中。

files: [
    ...
    'src/**/*.js',
    'path/to/tests/*.spec.js'
    ...
],
preprocessors: {
    'src/**/*.js': ['coverage']
}

这种模式（您已经完成）告诉 Karma 加载单个文件，并将它们包含在覆盖范围中。在这一点上，我不会费心加载捆绑的应用程序代码，因为您已经加载了所有原始内容。

还要确保按照它们可能捆绑的顺序加载它们，以便您可以确保 Karma 可以首先初始化应用程序。

files: [
    'src/app.js',
    'src/environment.js',
    'src/main.js'
]

如果您将您的规范命名myTest.spec.js在他们测试的文件旁边，您可以使用src/!(*.spec).js它来确保您包含没有测试的应用程序代码。

Answer 2

@lebolo 这些是我必须做的调整才能让事情在这里工作：

aurelia_project/tasks/cover.js

在封面函数的开头包含一个供应商路径常量：

const VENDORS_PATH = __dirname + '/../../node_modules/';

使用 VENDORS_PATH 将我依赖的库包含在文件中：

files: [
  {pattern: VENDORS_PATH + 'moment/min/moment.min.js', included: false},
  {pattern: 'src/**/*.js', included: false},
  {pattern: 'test/unit/**/*.js', included: false},
  'test/aurelia-karma-cover.js'
]

预处理器中包含的测试文件：

preprocessors: {
  'src/**/*.js': ['babel'],
  'test/unit/**/*.js': ['babel']
}

测试/单元/aurelia-karma-cover.js

更改 url 内置requirejs.load函数的方式：

url = '/base/' + url;=>url = ['/base', root, url].join('/');

包括另外一个功能来配置 requirejs 路径并在调用后调用它patchRequireJS()：

  function configRequire() {
    var VENDORS_PATH = '../node_modules/';

    requirejs.config({
      paths: {
        'moment': VENDORS_PATH + 'moment/min/moment.min'
      }
    });
  }

Answer 3

我终于让它工作了，但它需要大量的底层修改=\

首先我必须安装以下软件包

npm install karma-coverage --save-dev
npm install karma-requirejs --save-dev
npm install babel-plugin-istanbul --save-dev

aurelia_project/tasks/cover.js

这是基于test.js.

• 添加requirejs到frameworks（来自karma-requirejs包）的列表
• 添加单独的 src/test 文件（带有included: false）以及test/aurelia-karma-cover.js，它会执行require测试文件的实际操作。
• 修改aurelia-karma.js为aurelia-karma-cover.js不包含/test/unit/setup.js（它给我aurelia-browser-pal依赖项带来了麻烦）
• "coverage"从 src 文件预处理中删除（babel -plugin-istanbul现在将处理代码检测 - 有关详细信息，请参阅末尾的语句）。

import {Server as Karma} from 'karma';
import {CLIOptions} from 'aurelia-cli';
import project from "../aurelia.json";

export function cover(done) {
  new Karma({
    configFile: __dirname + '/../../karma.conf.js',
    frameworks: [project.testFramework.id, 'requirejs'],
    files: [
      {pattern: 'src\\**\\*.js', included: false},
      {pattern: 'test\\unit\\**\\*.js', included: false},
      // This file actually loads the spec files via require - it's based on aurelia-karma.js
      // but removes setup.js and its dependencies
      'test/aurelia-karma-cover.js'
    ],
    exclude: [
      'src/environment.js',
      'src/main.js',
      'src/resources/index.js'
    ],
    preprocessors: {
      'src/**/*.js': ['babel'],
    },
    reporters: ['progress', 'coverage'],
    singleRun: !CLIOptions.hasFlag('watch'),
    coverageReporter: {
      includeAllSources: true,
      reporters: [
        {type: 'html', dir: 'coverage'},
        {type: 'text'}
      ]
    }
  }, done).start();
}

export default cover;

测试/单元/aurelia-karma-cover.js

只需更改var allTestFiles = ['/base/test/unit/setup.js'];为var allTestFiles = [];避免aurelia-pal-browser依赖错误。

aurelia_project/aurelia.json

如果使用babel-plugin-istanbul ，则添加"istanbul"到列表中。transpiler.options.plugins

* 如果没有babel-plugin-istanbul，代码覆盖适用于后转译的代码，这会增加无法真正测试的样板。这使您可以达到 100% 的代码覆盖率；）