Skip to content

fix(@angular/build): expose unit test and karma builder API #30646

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

Merged
merged 1 commit into from
Jul 4, 2025
Merged
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
60 changes: 60 additions & 0 deletions goldens/public-api/angular/build/index.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import { BuilderContext } from '@angular-devkit/architect';
import { BuilderOutput } from '@angular-devkit/architect';
import type { ConfigOptions } from 'karma';
import type http from 'node:http';
import { OutputFile } from 'esbuild';
import type { Plugin as Plugin_2 } from 'esbuild';
Expand Down Expand Up @@ -151,9 +152,17 @@ export function executeDevServerBuilder(options: DevServerBuilderOptions, contex
// @public
export function executeExtractI18nBuilder(options: ExtractI18nBuilderOptions, context: BuilderContext, extensions?: ApplicationBuilderExtensions): Promise<BuilderOutput>;

// @public
export function executeKarmaBuilder(options: KarmaBuilderOptions, context: BuilderContext, transforms?: {
karmaOptions?: (options: KarmaConfigOptions) => KarmaConfigOptions;
}): AsyncIterable<BuilderOutput>;

// @public
export function executeNgPackagrBuilder(options: NgPackagrBuilderOptions, context: BuilderContext): AsyncIterableIterator<BuilderOutput>;

// @public
export function executeUnitTestBuilder(options: UnitTestBuilderOptions, context: BuilderContext, extensions?: ApplicationBuilderExtensions): AsyncIterable<BuilderOutput>;

// @public
export type ExtractI18nBuilderOptions = {
buildTarget?: string;
Expand All @@ -164,6 +173,40 @@ export type ExtractI18nBuilderOptions = {
progress?: boolean;
};

// @public
export type KarmaBuilderOptions = {
aot?: boolean;
assets?: AssetPattern_2[];
browsers?: Browsers;
codeCoverage?: boolean;
codeCoverageExclude?: string[];
define?: {
[key: string]: string;
};
exclude?: string[];
externalDependencies?: string[];
fileReplacements?: FileReplacement_2[];
include?: string[];
inlineStyleLanguage?: InlineStyleLanguage_2;
karmaConfig?: string;
loader?: {
[key: string]: any;
};
main?: string;
poll?: number;
polyfills?: string[];
preserveSymlinks?: boolean;
progress?: boolean;
reporters?: string[];
scripts?: ScriptElement_2[];
sourceMap?: SourceMapUnion_2;
stylePreprocessorOptions?: StylePreprocessorOptions_2;
styles?: StyleElement_2[];
tsConfig: string;
watch?: boolean;
webWorkerTsConfig?: string;
};

// @public
export type NgPackagrBuilderOptions = {
poll?: number;
Expand All @@ -172,6 +215,23 @@ export type NgPackagrBuilderOptions = {
watch?: boolean;
};

// @public
export type UnitTestBuilderOptions = {
browsers?: string[];
buildTarget: string;
codeCoverage?: boolean;
codeCoverageExclude?: string[];
codeCoverageReporters?: SchemaCodeCoverageReporter[];
debug?: boolean;
exclude?: string[];
include?: string[];
providersFile?: string;
reporters?: string[];
runner: Runner;
tsConfig: string;
watch?: boolean;
};

// (No @packageDocumentation comment for this package)

```
14 changes: 9 additions & 5 deletions packages/angular/build/src/builders/unit-test/builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,14 @@ import { OutputHashing } from '../application/schema';
import { writeTestFiles } from '../karma/application_builder';
import { findTests, getTestEntrypoints } from '../karma/find-tests';
import { useKarmaBuilder } from './karma-bridge';
import { NormalizedUnitTestOptions, injectTestingPolyfills, normalizeOptions } from './options';
import type { Schema as UnitTestOptions } from './schema';
import {
NormalizedUnitTestBuilderOptions,
injectTestingPolyfills,
normalizeOptions,
} from './options';
import type { Schema as UnitTestBuilderOptions } from './schema';

export type { UnitTestOptions };
export type { UnitTestBuilderOptions };

type VitestCoverageOption = Exclude<import('vitest/node').InlineConfig['coverage'], undefined>;

Expand All @@ -36,7 +40,7 @@ type VitestCoverageOption = Exclude<import('vitest/node').InlineConfig['coverage
*/
// eslint-disable-next-line max-lines-per-function
export async function* execute(
options: UnitTestOptions,
options: UnitTestBuilderOptions,
context: BuilderContext,
extensions: ApplicationBuilderExtensions = {},
): AsyncIterable<BuilderOutput> {
Expand Down Expand Up @@ -383,7 +387,7 @@ function generateOutputPath(): string {
return path.join('dist', 'test-out', `${datePrefix}-${uuidSuffix}`);
}
function generateCoverageOption(
codeCoverage: NormalizedUnitTestOptions['codeCoverage'],
codeCoverage: NormalizedUnitTestBuilderOptions['codeCoverage'],
workspaceRoot: string,
outputPath: string,
): VitestCoverageOption {
Expand Down
6 changes: 3 additions & 3 deletions packages/angular/build/src/builders/unit-test/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
*/

import { type Builder, createBuilder } from '@angular-devkit/architect';
import { type UnitTestOptions, execute } from './builder';
import { type UnitTestBuilderOptions, execute } from './builder';

export { type UnitTestOptions, execute };
export { type UnitTestBuilderOptions, execute };

const builder: Builder<UnitTestOptions> = createBuilder(execute);
const builder: Builder<UnitTestBuilderOptions> = createBuilder(execute);

export default builder;
4 changes: 2 additions & 2 deletions packages/angular/build/src/builders/unit-test/karma-bridge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
import type { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
import type { ApplicationBuilderInternalOptions } from '../application/options';
import type { KarmaBuilderOptions } from '../karma';
import { type NormalizedUnitTestOptions, injectTestingPolyfills } from './options';
import { type NormalizedUnitTestBuilderOptions, injectTestingPolyfills } from './options';

export async function useKarmaBuilder(
context: BuilderContext,
unitTestOptions: NormalizedUnitTestOptions,
unitTestOptions: NormalizedUnitTestBuilderOptions,
): Promise<AsyncIterable<BuilderOutput>> {
if (unitTestOptions.debug) {
context.logger.warn(
Expand Down
6 changes: 3 additions & 3 deletions packages/angular/build/src/builders/unit-test/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ import path from 'node:path';
import { normalizeCacheOptions } from '../../utils/normalize-cache';
import { getProjectRootPaths } from '../../utils/project-metadata';
import { isTTY } from '../../utils/tty';
import type { Schema as UnitTestOptions } from './schema';
import type { Schema as UnitTestBuilderOptions } from './schema';

export type NormalizedUnitTestOptions = Awaited<ReturnType<typeof normalizeOptions>>;
export type NormalizedUnitTestBuilderOptions = Awaited<ReturnType<typeof normalizeOptions>>;

export async function normalizeOptions(
context: BuilderContext,
projectName: string,
options: UnitTestOptions,
options: UnitTestBuilderOptions,
) {
// Setup base paths based on workspace root and project information
const workspaceRoot = context.workspaceRoot;
Expand Down
6 changes: 6 additions & 0 deletions packages/angular/build/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,9 @@ export {
execute as executeNgPackagrBuilder,
type NgPackagrBuilderOptions,
} from './builders/ng-packagr';
export {
execute as executeUnitTestBuilder,
type UnitTestBuilderOptions,
} from './builders/unit-test';

export { execute as executeKarmaBuilder, type KarmaBuilderOptions } from './builders/karma';