Добавление покрытия кода в приложение ASP.NET Core Angular 2 Starter
Я начал проект с использованием шаблона Angular ASP.NET Core 2.0, который можно найти в Visual Studio 2017 Update 3 после установки.NET Core 2.0 SDK.
Тесты в Карме работают нормально, но я хочу добавить покрытие кода в Карму. Я пробовал несколько разных решений, но, похоже, ничего не работает полностью. Лучшее, что я придумал, это то, что классы, на которые ссылаются тесты, покрыты (но не все классы машинописи в ClientApp), но выделение в сгенерированном отчете отключено, и сообщения не имеют смысла.
Вот что я сделал:
package.json
"devDependencies": {
"@types/chai": "4.0.1",
"@types/jasmine": "2.5.53",
"chai": "4.0.2",
"istanbul-instrumenter-loader": "^3.0.0",
"jasmine-core": "2.6.4",
"karma": "https://registry.npmjs.org/karma/-/karma-1.7.0.tgz",
"karma-chai": "0.1.0",
"karma-chrome-launcher": "2.2.0",
"karma-cli": "1.0.1",
"karma-coverage": "^1.1.1",
"karma-jasmine": "1.1.0",
"karma-remap-istanbul": "https://registry.npmjs.org/karma-remap-istanbul/-/karma-remap-istanbul-0.6.0.tgz",
"karma-sourcemap-loader": "^0.3.7",
"karma-webpack": "2.0.3"
}
Karma.conf.js:
module.exports = function (config) {
var webpackConfig = require('../../webpack.config.js')().filter(config => config.target !== 'node');
webpackConfig[0].devtool = 'inline-source-map';
config.set({
basePath: '.',
frameworks: ['jasmine'],
files: [
'../../wwwroot/dist/vendor.js',
'./boot-tests.ts'
],
preprocessors: {
'./boot-tests.ts': ['webpack', 'sourcemap']
},
reporters: ['progress', 'coverage', 'karma-remap-istanbul'],
port: 9876,
colors: true,
logLevel: config.LOG_INFO,
autoWatch: true,
browsers: ['Chrome'],
mime: { 'application/javascript': ['ts','tsx'] },
singleRun: false,
webpack: webpackConfig, // Test against client bundle, because tests run in a browser
webpackMiddleware: { stats: 'errors-only' },
remapIstanbulReporter: {
reports: {
html: 'coverage'
}
}
});
};
webpack.config.js:
const path = require('path');
const webpack = require('webpack');
const merge = require('webpack-merge');
const AotPlugin = require('@ngtools/webpack').AotPlugin;
const CheckerPlugin = require('awesome-typescript-loader').CheckerPlugin;
module.exports = (env) => {
// Configuration in common to both client-side and server-side bundles
const isDevBuild = !(env && env.prod);
const tsUse = isDevBuild ? [
{
loader: 'istanbul-instrumenter-loader',
options: {
esModules: true
}
},
'awesome-typescript-loader?silent=true',
'angular2-template-loader'
] : '@ngtools/webpack';
const sharedConfig = {
stats: { modules: false },
context: __dirname,
resolve: { extensions: ['.js', '.ts'] },
output: {
filename: '[name].js',
publicPath: 'dist/' // Webpack dev middleware, if enabled, handles requests for this URL prefix
},
module: {
rules: [
{
test: /\.ts$/, include: /ClientApp/,
use: tsUse
},
{ test: /\.html$/, use: 'html-loader?minimize=false' },
{
test: /\.css$/, use: ['to-string-loader', isDevBuild ? 'css-loader' : 'css-loader?minimize']
},
{ test: /\.(png|jpg|jpeg|gif|svg)$/, use: 'url-loader?limit=25000' }
]
},
plugins: [new CheckerPlugin()]
};
// Configuration for client-side bundle suitable for running in browsers
const clientBundleOutputDir = './wwwroot/dist';
const clientBundleConfig = merge(sharedConfig, {
entry: { 'main-client': './ClientApp/boot.browser.ts' },
output: { path: path.join(__dirname, clientBundleOutputDir) },
plugins: [
new webpack.DllReferencePlugin({
context: __dirname,
manifest: require('./wwwroot/dist/vendor-manifest.json')
})
].concat(isDevBuild ? [
// Plugins that apply in development builds only
new webpack.SourceMapDevToolPlugin({
filename: '[file].map', // Remove this line if you prefer inline source maps
moduleFilenameTemplate: path.relative(clientBundleOutputDir, '[resourcePath]') // Point sourcemap entries to the original file locations on disk
})
] : [
// Plugins that apply in production builds only
new webpack.optimize.UglifyJsPlugin(),
new AotPlugin({
tsConfigPath: './tsconfig.json',
entryModule: path.join(__dirname, 'ClientApp/app/app.module.browser#AppModule'),
exclude: ['./**/*.server.ts']
})
])
});
// Configuration for server-side (prerendering) bundle suitable for running in Node
const serverBundleConfig = merge(sharedConfig, {
resolve: { mainFields: ['main'] },
entry: { 'main-server': './ClientApp/boot.server.ts' },
plugins: [
new webpack.DllReferencePlugin({
context: __dirname,
manifest: require('./ClientApp/dist/vendor-manifest.json'),
sourceType: 'commonjs2',
name: './vendor'
})
].concat(isDevBuild ? [] : [
// Plugins that apply in production builds only
new AotPlugin({
tsConfigPath: './tsconfig.json',
entryModule: path.join(__dirname, 'ClientApp/app/app.module.server#AppModule'),
exclude: ['./**/*.browser.ts']
})
]),
output: {
libraryTarget: 'commonjs',
path: path.join(__dirname, './ClientApp/dist')
},
target: 'node',
devtool: 'inline-source-map'
});
return [clientBundleConfig, serverBundleConfig];
};
1 ответ
Я работал над этим в последнее время, и после некоторого копания я получил решение ниже.
ПРИМЕЧАНИЕ. См. Ссылки в нижней части этого поста, чтобы узнать, что я нашел в итоге для этого решения. Достаточно этого (обязательно) отличается от источника, поэтому я не думаю, что у меня должны быть проблемы с авторскими правами.
Сначала я добавил их в package.json для своего решения, которое было запущено с использованием нового углового шаблона ASP.NET Core 2.0, который доступен в Visual Studio 2017 (думаю, версии 15.3 и выше). Добавьте это к devDependencies
раздел package.json.
"karma-sourcemap-loader": "^0.3.7",
"karma-remap-istanbul": "^0.6.0",
"istanbul-instrumenter-loader": "^3.0.0"
Бежать npm install
добавить биты в приложение или сохранить package.json и позволить VS сделать свое дело.
Затем я изменил файл ClientApp/test/boot-tests.ts.
Измените эту строку:
const context = require.context('../app/', true, /\.spec\.ts$/);
к этому:
const context = require.context('../app', true, /\.ts$/);
Это (выше) непосредственно из первой ссылки ниже.
Затем я заменил содержимое ClientApp/test/karma.conf.js следующим образом:
const path = require('path');
var webpackConfig = require('../../webpack.config.js')().filter(config => config.target !== 'node')[0];
webpackConfig.module.rules.push({
test: /\.ts$/,
include: [path.resolve(__dirname, '../app')],
use: {
loader: 'istanbul-instrumenter-loader?force-sourcemap=true',
options: { esModules: true }
},
enforce: 'post',
exclude: [/\.spec\.ts$/]
});
module.exports = function (config) {
config.set({
basePath: '.',
frameworks: ['jasmine'],
files: ['../../wwwroot/dist/vendor.js', './boot-tests.ts'],
preprocessors: {
'./boot-tests.ts': ['webpack']
},
reporters: ['progress', 'karma-remap-istanbul'],
port: 9876,
colors: true,
logLevel: config.LOG_INFO,
autoWatch: true,
browsers: ['Chrome'],
mime: { 'application/javascript': ['ts', 'tsx'] },
singleRun: true,
webpack: webpackConfig,
webpackMiddleware: { stats: 'errors-only' },
remapIstanbulReporter: {
reports: {
html: 'ClientApp/test/coverage',
'text-summary': null
}
}
});
};
Теперь, когда я бегу npm test
Из корня приложения я получаю отчеты о покрытии, встроенные в папку ClientApp/test/cover (откройте index.html в выбранном вами браузере). Я также добавил text-summary
к параметрам отчетов в karma.conf.js, так что вы также получите сводку в командной строке.
Вы можете изменить singleRun
в karma.conf.js значение false, если вы хотите, чтобы это запускалось и обновлялось по мере обновления кода и модульных тестов. Я столкнулся с проблемой, где это, когда я попробовал все это с шаблоном после перехода на Angular 5.0.0. С ng 5.0.0 выводится предупреждение о времени компиляции, которое заставляет карму перекомпилироваться снова и снова, независимо от того, есть изменения в коде или нет. У меня не было этой проблемы с ng 4.2.5, которая является версией, которую шаблон Core 2.0 использует из коробки.
В QIQO.Core.Ng.Coverage у меня есть проект, в который я добавил эти изменения, чтобы вы могли на них посмотреть, если хотите.
Рекомендации:
Angular2SpaCodeCoverage из вики JavaScriptServices.
Это поможет вам в этом, но раздел с изменениями в karma.conf.js был не совсем верным и не работал с последней версией шаблона или веб-пакетом (и я использую 3.8.1 в то время, когда я пишу это). Это использование sourcemap-istanbul-instrumenter-loader
пакет, похоже, больше не работает. Что приводит меня к следующей ссылке.
Проблема: покрытие кода для Angular 2 и webpack 2
Это была информация в последних 2 сообщениях в этой теме, которая помогла мне обернуть это. Благодаря Тдортиз! Добавление options: { esModules: true }
к karma.conf.js и используя istanbul-instrumenter-loader
скорее, чем sourcemap-istanbul-instrumenter-loader
были хитрости