Skip to content
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
45 changes: 44 additions & 1 deletion packages/angular/build/src/builders/unit-test/builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import type { BuilderContext, BuilderOutput } from '@angular-devkit/architect';
import assert from 'node:assert';
import { randomUUID } from 'node:crypto';
import { createRequire } from 'node:module';
import path from 'node:path';
import { createVirtualModulePlugin } from '../../tools/esbuild/virtual-module-plugin';
import { loadEsmModule } from '../../utils/load-esm';
Expand Down Expand Up @@ -133,6 +134,28 @@ export async function* execute(

let instance: import('vitest/node').Vitest | undefined;

// Setup vitest browser options if configured
let browser: import('vitest/node').BrowserConfigOptions | undefined;
if (normalizedOptions.browsers) {
const provider = findBrowserProvider(projectSourceRoot);
if (!provider) {
context.logger.error(
'The "browsers" option requires either "playwright" or "webdriverio" to be installed within the project.' +
' Please install one of these packages and rerun the test command.',
);

return { success: false };
}

browser = {
enabled: true,
provider,
instances: normalizedOptions.browsers.map((browserName) => ({
browser: browserName,
})),
};
}

for await (const result of buildApplicationInternal(buildOptions, context, extensions)) {
if (result.kind === ResultKind.Failure) {
continue;
Expand All @@ -153,8 +176,11 @@ export async function* execute(
test: {
root: outputPath,
setupFiles,
environment: 'jsdom',
// Use `jsdom` if no browsers are explicitly configured.
// `node` is effectively no "environment" and the default.
environment: browser ? 'node' : 'jsdom',
watch: normalizedOptions.watch,
browser,
coverage: {
enabled: normalizedOptions.codeCoverage,
exclude: normalizedOptions.codeCoverageExclude,
Expand All @@ -169,3 +195,20 @@ export async function* execute(
yield { success: testModules.every((testModule) => testModule.ok()) };
}
}

function findBrowserProvider(
projectSourceRoot: string,
): import('vitest/node').BrowserBuiltinProvider | undefined {
const projectResolver = createRequire(projectSourceRoot + '/').resolve;

// These must be installed in the project to be used
const vitestBuiltinProviders = ['playwright', 'webdriverio'] as const;

for (const providerName of vitestBuiltinProviders) {
try {
projectResolver(providerName);

return providerName;
} catch {}
}
}
3 changes: 2 additions & 1 deletion packages/angular/build/src/builders/unit-test/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export async function normalizeOptions(
const buildTargetSpecifier = options.buildTarget ?? `::development`;
const buildTarget = targetFromTargetString(buildTargetSpecifier, projectName, 'build');

const { codeCoverage, codeCoverageExclude, tsConfig, runner, reporters } = options;
const { codeCoverage, codeCoverageExclude, tsConfig, runner, reporters, browsers } = options;

return {
// Project/workspace information
Expand All @@ -53,6 +53,7 @@ export async function normalizeOptions(
codeCoverageExclude,
tsConfig,
reporters,
browsers,
// TODO: Implement watch support
watch: false,
};
Expand Down
8 changes: 8 additions & 0 deletions packages/angular/build/src/builders/unit-test/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@
"description": "The name of the test runner to use for test execution.",
"enum": ["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.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"include": {
"type": "array",
"items": {
Expand Down
Loading