Skip to content

refactor(@angular/build): provide karma runner for unit-test builder #30169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/angular/build/src/builders/unit-test/builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { ResultKind } from '../application/results';
import { OutputHashing } from '../application/schema';
import { writeTestFiles } from '../karma/application_builder';
import { findTests, getTestEntrypoints } from '../karma/find-tests';
import { useKarmaBuilder } from './karma-bridge';
import { normalizeOptions } from './options';
import type { Schema as UnitTestOptions } from './schema';

Expand Down Expand Up @@ -52,6 +53,14 @@ export async function* execute(
const normalizedOptions = await normalizeOptions(context, projectName, options);
const { projectSourceRoot, workspaceRoot, runnerName } = normalizedOptions;

// Translate options and use karma builder directly if specified
if (runnerName === 'karma') {
const karmaBridge = await useKarmaBuilder(context, normalizedOptions);
yield* karmaBridge;

return;
}

if (runnerName !== 'vitest') {
context.logger.error('Unknown test runner: ' + runnerName);

Expand Down
53 changes: 53 additions & 0 deletions packages/angular/build/src/builders/unit-test/karma-bridge.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/**
* @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.dev/license
*/

import type { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
import type { ApplicationBuilderInternalOptions } from '../application/options';
import type { KarmaBuilderOptions } from '../karma';
import type { NormalizedUnitTestOptions } from './options';

export async function useKarmaBuilder(
context: BuilderContext,
unitTestOptions: NormalizedUnitTestOptions,
): Promise<AsyncIterable<BuilderOutput>> {
const buildTargetOptions = (await context.validateOptions(
await context.getTargetOptions(unitTestOptions.buildTarget),
await context.getBuilderNameForTarget(unitTestOptions.buildTarget),
)) as unknown as ApplicationBuilderInternalOptions;

const options: KarmaBuilderOptions = {
tsConfig: unitTestOptions.tsConfig,
polyfills: buildTargetOptions.polyfills,
assets: buildTargetOptions.assets,
scripts: buildTargetOptions.scripts,
styles: buildTargetOptions.styles,
inlineStyleLanguage: buildTargetOptions.inlineStyleLanguage,
stylePreprocessorOptions: buildTargetOptions.stylePreprocessorOptions,
externalDependencies: buildTargetOptions.externalDependencies,
loader: buildTargetOptions.loader,
define: buildTargetOptions.define,
include: unitTestOptions.include,
exclude: unitTestOptions.exclude,
sourceMap: buildTargetOptions.sourceMap,
progress: buildTargetOptions.progress,
watch: unitTestOptions.watch,
poll: buildTargetOptions.poll,
preserveSymlinks: buildTargetOptions.preserveSymlinks,
browsers: unitTestOptions.browsers?.join(','),
codeCoverage: unitTestOptions.codeCoverage,
codeCoverageExclude: unitTestOptions.codeCoverageExclude,
fileReplacements: buildTargetOptions.fileReplacements,
reporters: unitTestOptions.reporters,
webWorkerTsConfig: buildTargetOptions.webWorkerTsConfig,
aot: buildTargetOptions.aot,
};

const { execute } = await import('../karma');

return execute(options, context);
}
2 changes: 1 addition & 1 deletion packages/angular/build/src/builders/unit-test/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"runner": {
"type": "string",
"description": "The name of the test runner to use for test execution.",
"enum": ["vitest"]
"enum": ["karma", "vitest"]
},
"browsers": {
"description": "A list of browsers to use for test execution. If undefined, jsdom on Node.js will be used instead of a browser.",
Expand Down
Loading