Skip to content
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

fix(testing): merge builder globals with jest.config.js globals #1827

Merged
merged 1 commit into from
Sep 16, 2019
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
48 changes: 47 additions & 1 deletion e2e/jest.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
import { runCLIAsync, ensureProject, uniq, runCLI, forEachCli } from './utils';
import {
runCLIAsync,
ensureProject,
uniq,
runCLI,
forEachCli,
updateFile
} from './utils';
import { stripIndents } from '@angular-devkit/core/src/utils/literals';

forEachCli(() => {
describe('Jest', () => {
Expand All @@ -21,5 +29,43 @@ forEachCli(() => {
expect(libResult.stderr).toContain('Test Suites: 3 passed, 3 total');
done();
}, 45000);

it('should merge with jest config globals', async done => {
ensureProject();
const testGlobal = `'My Test Global'`;
const mylib = uniq('mylib');
runCLI(`generate @nrwl/workspace:lib ${mylib} --unit-test-runner jest`);

updateFile(`libs/${mylib}/src/lib/${mylib}.ts`, `export class Test { }`);

updateFile(
`libs/${mylib}/src/lib/${mylib}.spec.ts`,
`
test('can access jest global', () => {
expect((global as any).testGlobal).toBe(${testGlobal});
});
`
);

updateFile(
`libs/${mylib}/jest.config.js`,
stripIndents`
module.exports = {
testMatch: ['**/+(*.)+(spec|test).+(ts|js)?(x)'],
transform: {
'^.+\\.(ts|js|html)$': 'ts-jest'
},
resolver: '@nrwl/jest/plugins/resolver',
moduleFileExtensions: ['ts', 'js', 'html'],
coverageReporters: ['html'],
passWithNoTests: true,
globals: { testGlobal: ${testGlobal} }
};`
);

const appResult = await runCLIAsync(`test ${mylib} --no-watch`);
expect(appResult.stderr).toContain('Test Suites: 1 passed, 1 total');
done();
}, 45000);
});
});
59 changes: 38 additions & 21 deletions packages/jest/src/builders/jest/jest.impl.spec.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// import JestBuilder from './jest.impl';
import { normalize, schema } from '@angular-devkit/core';
import {
TestLogger,
TestingArchitectHost
} from '@angular-devkit/architect/testing';
import { schema } from '@angular-devkit/core';
import { TestingArchitectHost } from '@angular-devkit/architect/testing';

jest.mock('jest');
const { runCLI } = require('jest');
const mockJestConfig: any = {};
jest.mock('/root/jest.config.js', () => mockJestConfig, { virtual: true });

import * as path from 'path';
import { Architect } from '@angular-devkit/architect';

Expand All @@ -17,6 +17,8 @@ describe('Jest Builder', () => {
registry.addPostTransform(schema.transforms.addUndefinedDefaults);
const testArchitectHost = new TestingArchitectHost('/root', '/root');

mockJestConfig.globals = {};

architect = new Architect(testArchitectHost, registry);
await testArchitectHost.addBuilderFromPackage(
path.join(__dirname, '../../..')
Expand Down Expand Up @@ -48,9 +50,6 @@ describe('Jest Builder', () => {
globals: JSON.stringify({
'ts-jest': {
tsConfig: '/root/tsconfig.test.json',
diagnostics: {
warnOnly: true
},
stringifyContentPathRegex: '\\.(html|svg)$',
astTransformers: [
'jest-preset-angular/InlineHtmlStripStylesTransformer'
Expand Down Expand Up @@ -92,9 +91,6 @@ describe('Jest Builder', () => {
globals: JSON.stringify({
'ts-jest': {
tsConfig: '/root/tsconfig.test.json',
diagnostics: {
warnOnly: true
},
stringifyContentPathRegex: '\\.(html|svg)$',
astTransformers: [
'jest-preset-angular/InlineHtmlStripStylesTransformer'
Expand Down Expand Up @@ -138,9 +134,6 @@ describe('Jest Builder', () => {
globals: JSON.stringify({
'ts-jest': {
tsConfig: '/root/tsconfig.test.json',
diagnostics: {
warnOnly: true
},
stringifyContentPathRegex: '\\.(html|svg)$',
astTransformers: [
'jest-preset-angular/InlineHtmlStripStylesTransformer'
Expand Down Expand Up @@ -195,9 +188,6 @@ describe('Jest Builder', () => {
globals: JSON.stringify({
'ts-jest': {
tsConfig: '/root/tsconfig.test.json',
diagnostics: {
warnOnly: true
},
stringifyContentPathRegex: '\\.(html|svg)$',
astTransformers: [
'jest-preset-angular/InlineHtmlStripStylesTransformer'
Expand Down Expand Up @@ -248,9 +238,36 @@ describe('Jest Builder', () => {
globals: JSON.stringify({
'ts-jest': {
tsConfig: '/root/tsconfig.test.json',
diagnostics: {
warnOnly: true
},
stringifyContentPathRegex: '\\.(html|svg)$',
astTransformers: [
'jest-preset-angular/InlineHtmlStripStylesTransformer'
]
}
}),
setupTestFrameworkScriptFile: '/root/test.ts',
watch: false
},
['/root/jest.config.js']
);
});

it('should merge the globals property from jest config', async () => {
mockJestConfig.globals = { hereToStay: true };

await architect.scheduleBuilder('@nrwl/jest:jest', {
jestConfig: './jest.config.js',
tsConfig: './tsconfig.test.json',
setupFile: './test.ts',
watch: false
});

expect(runCLI).toHaveBeenCalledWith(
{
_: [],
globals: JSON.stringify({
hereToStay: true,
'ts-jest': {
tsConfig: '/root/tsconfig.test.json',
stringifyContentPathRegex: '\\.(html|svg)$',
astTransformers: [
'jest-preset-angular/InlineHtmlStripStylesTransformer'
Expand Down
18 changes: 9 additions & 9 deletions packages/jest/src/builders/jest/jest.impl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,7 @@ function run(
options.jestConfig = path.resolve(context.workspaceRoot, options.jestConfig);

const tsJestConfig = {
tsConfig: path.resolve(context.workspaceRoot, options.tsConfig),
// Typechecking wasn't done in Jest 23 but is done in 24. This makes errors a warning to amend the breaking change for now
// Remove for v8 to fail on type checking failure
diagnostics: {
warnOnly: true
}
tsConfig: path.resolve(context.workspaceRoot, options.tsConfig)
};

// TODO: This is hacky, We should probably just configure it in the user's workspace
Expand All @@ -76,6 +71,13 @@ function run(
});
} catch (e) {}

// merge the jestConfig globals with our 'ts-jest' override
const jestConfig: { globals: any } = require(options.jestConfig);
const globals = jestConfig.globals || {};
Object.assign(globals, {
'ts-jest': tsJestConfig
});

const config: any = {
_: [],
config: options.config,
Expand All @@ -100,9 +102,7 @@ function run(
useStderr: options.useStderr,
watch: options.watch,
watchAll: options.watchAll,
globals: JSON.stringify({
'ts-jest': tsJestConfig
})
globals: JSON.stringify(globals)
};

if (options.setupFile) {
Expand Down