Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /* eslint-disable @typescript-eslint/no-explicit-any */
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
import {
BuilderContext,
BuilderOutput,
createBuilder,
} from '@angular-devkit/architect';
import {
BrowserBuilderOptions,
OutputHashing,
} from '@angular-devkit/build-angular';
import type {
ExecutionTransformer,
KarmaBuilderOptions,
} from '@angular-devkit/build-angular';
import { FindTestsPlugin } from '@angular-devkit/build-angular/src/builders/karma/find-tests-plugin';
import {
getCommonConfig,
getStylesConfig,
} from '@angular-devkit/build-angular/src/tools/webpack/configs';
import { purgeStaleBuildCache } from '@angular-devkit/build-angular/src/utils/purge-cache';
import { assertCompatibleAngularVersion } from '@angular-devkit/build-angular/src/utils/version';
import { generateBrowserWebpackConfigFromContext } from '@angular-devkit/build-angular/src/utils/webpack-browser-config';
import { Config, ConfigOptions } from 'karma';
import * as path from 'path';
import { dirname, resolve } from 'path';
import { Observable, from } from 'rxjs';
import { defaultIfEmpty, switchMap } from 'rxjs/operators';
import type { Configuration } from 'webpack';
export type KarmaConfigOptions = ConfigOptions & {
buildWebpack?: unknown;
configFile?: string;
};
async function initialize(
options: KarmaBuilderOptions,
context: BuilderContext,
webpackConfigurationTransformer?: ExecutionTransformer<Configuration>
): Promise<[typeof import('karma'), Configuration]> {
// Purge old build disk cache.
await purgeStaleBuildCache(context);
const { config } = await generateBrowserWebpackConfigFromContext(
// only two properties are missing:
// * `outputPath` which is fixed for tests
// * `budgets` which might be incorrect due to extra dev libs
{
...(options as unknown as BrowserBuilderOptions),
outputPath: '',
budgets: undefined,
optimization: false,
buildOptimizer: false,
aot: true,
vendorChunk: true,
namedChunks: true,
extractLicenses: false,
outputHashing: OutputHashing.None,
// The webpack tier owns the watch behavior so we want to force it in the config.
// When not in watch mode, webpack-dev-middleware will call `compiler.watch` anyway.
// https://github.com/webpack/webpack-dev-middleware/blob/698c9ae5e9bb9a013985add6189ff21c1a1ec185/src/index.js#L65
// https://github.com/webpack/webpack/blob/cde1b73e12eb8a77eb9ba42e7920c9ec5d29c2c9/lib/Compiler.js#L379-L388
watch: true,
},
context,
(wco) => [
getCommonConfig(wco),
// getBrowserConfig(wco),
getStylesConfig(wco),
// getTypeScriptConfig(wco),
]
);
const karma = await import('karma');
return [
karma,
webpackConfigurationTransformer
? await webpackConfigurationTransformer(config)
: config,
];
}
/**
* @experimental Direct usage of this function is considered experimental.
*/
export function execute(
options: KarmaBuilderOptions,
context: BuilderContext,
transforms: {
webpackConfiguration?: ExecutionTransformer<Configuration>;
// The karma options transform cannot be async without a refactor of the builder implementation
karmaOptions?: (options: KarmaConfigOptions) => KarmaConfigOptions;
} = {}
): Observable<BuilderOutput> {
// Check Angular version.
assertCompatibleAngularVersion(context.workspaceRoot);
let singleRun: boolean | undefined;
if (options.watch !== undefined) {
singleRun = !options.watch;
}
return from(
initialize(options, context, transforms.webpackConfiguration)
).pipe(
switchMap(async ([karma, webpackConfig]) => {
const karmaOptions: KarmaConfigOptions = {
singleRun,
};
// Convert browsers from a string to an array
if (options.browsers) {
karmaOptions.browsers = (options.browsers as string)!.split(',');
}
if (options.reporters) {
// Split along commas to make it more natural, and remove empty strings.
const reporters = options.reporters
.reduce<string[]>((acc, curr) => acc.concat(curr.split(',')), [])
.filter((x) => !!x);
if (reporters.length > 0) {
karmaOptions.reporters = reporters;
}
}
const projectName = context.target?.project;
if (!projectName) {
throw new Error('The builder requires a target.');
}
const projectMetadata = await context.getProjectMetadata(projectName);
const sourceRoot = (projectMetadata.sourceRoot ??
projectMetadata.root ??
'') as string;
webpackConfig.plugins ??= [];
webpackConfig.plugins.push(
new FindTestsPlugin({
// include: options.include,
workspaceRoot: context.workspaceRoot,
projectSourceRoot: path.join(context.workspaceRoot, sourceRoot),
})
);
karmaOptions.buildWebpack = {
options,
webpackConfig,
logger: context.logger,
};
const config = await karma.config.parseConfig(
resolve(context.workspaceRoot, options.karmaConfig!),
transforms.karmaOptions
? transforms.karmaOptions(karmaOptions)
: karmaOptions,
{ promiseConfig: true, throwErrors: true }
);
return [karma, config] as [typeof karma, KarmaConfigOptions];
}),
switchMap(
([karma, karmaConfig]) =>
new Observable<BuilderOutput>((subscriber) => {
// Pass onto Karma to emit BuildEvents.
karmaConfig.buildWebpack ??= {};
if (typeof karmaConfig.buildWebpack === 'object') {
(karmaConfig.buildWebpack as any).failureCb ??= () =>
subscriber.next({ success: false });
(karmaConfig.buildWebpack as any).successCb ??= () =>
subscriber.next({ success: true });
(karmaConfig.buildWebpack as any).testContext = (
context as any
).testContext;
}
// Complete the observable once the Karma server returns.
const karmaServer = new karma.Server(
karmaConfig as Config,
(exitCode) => {
subscriber.next({ success: exitCode === 0 });
subscriber.complete();
}
);
const karmaStart = karmaServer.start();
// Cleanup, signal Karma to exit.
return () => karmaStart.then(() => karmaServer.stop());
})
),
defaultIfEmpty({ success: false })
);
}
export { KarmaBuilderOptions };
export default createBuilder<Record<string, string> & KarmaBuilderOptions>(
execute
);
|