From 80bbbf6af88ff61d828b223022b00838366c61c2 Mon Sep 17 00:00:00 2001 From: Timon Jurschitsch Date: Mon, 17 Apr 2023 17:34:49 +0200 Subject: [PATCH] Add integration test for .cts config files --- e2e/__tests__/tsIntegration.test.ts | 308 ++++++++++++++++++++++++++++ 1 file changed, 308 insertions(+) diff --git a/e2e/__tests__/tsIntegration.test.ts b/e2e/__tests__/tsIntegration.test.ts index 32d9f01ccd66..57c79a9a782c 100644 --- a/e2e/__tests__/tsIntegration.test.ts +++ b/e2e/__tests__/tsIntegration.test.ts @@ -54,6 +54,45 @@ describe('when `Config` type is imported from "@jest/types"', () => { expect(globalConfig.verbose).toBe(true); }); + test('with object config exported from CTS file', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + const config: Config.InitialOptions = {displayName: 'ts-object-config', verbose: true}; + export default config; + `, + 'package.json': '{}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-object-config'); + expect(globalConfig.verbose).toBe(true); + }); + + test('with function config exported from CTS file', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + async function getVerbose() {return true;} + export default async (): Promise => { + const verbose: Config.InitialOptions['verbose'] = await getVerbose(); + return {displayName: 'ts-async-function-config', verbose}; + }; + `, + 'package.json': '{}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-async-function-config'); + expect(globalConfig.verbose).toBe(true); + }); + test('throws if type errors are encountered', () => { writeFiles(DIR, { '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", @@ -92,6 +131,44 @@ describe('when `Config` type is imported from "@jest/types"', () => { expect(exitCode).toBe(1); }); + test('throws if type errors are encountered with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + const config: Config.InitialOptions = {testTimeout: '10000'}; + export default config; + `, + 'package.json': '{}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(2,40): error TS2322: Type 'string' is not assignable to type 'number'.", + ); + expect(exitCode).toBe(1); + }); + + test('throws if syntax errors are encountered with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + const config: Config.InitialOptions = {verbose: true}; + export default get config; + `, + 'package.json': '{}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(3,16): error TS2304: Cannot find name 'get'.", + ); + expect(exitCode).toBe(1); + }); + test('works with object config exported from TS file when package.json#type=module', () => { writeFiles(DIR, { '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", @@ -114,6 +191,45 @@ describe('when `Config` type is imported from "@jest/types"', () => { writeFiles(DIR, { '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", 'jest.config.ts': ` + import type {Config} from '@jest/types'; + async function getVerbose() {return true;} + export default async (): Promise => { + const verbose: Config.InitialOptions['verbose'] = await getVerbose(); + return {displayName: 'ts-esm-async-function-config', verbose}; + }; + `, + 'package.json': '{"type": "module"}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-esm-async-function-config'); + expect(globalConfig.verbose).toBe(true); + }); + + test('works with object config exported from CTS file when package.json#type=module', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + const config: Config.InitialOptions = {displayName: 'ts-esm-object-config', verbose: true}; + export default config; + `, + 'package.json': '{"type": "module"}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-esm-object-config'); + expect(globalConfig.verbose).toBe(true); + }); + + test('works with function config exported from CTS file when package.json#type=module', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", + 'jest.config.cts': ` import type {Config} from '@jest/types'; async function getVerbose() {return true;} export default async (): Promise => { @@ -168,6 +284,44 @@ describe('when `Config` type is imported from "@jest/types"', () => { ); expect(exitCode).toBe(1); }); + + test('throws if type errors are encountered when package.json#type=module with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + const config: Config.InitialOptions = {testTimeout: '10000'}; + export default config; + `, + 'package.json': '{"type": "module"}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(2,40): error TS2322: Type 'string' is not assignable to type 'number'.", + ); + expect(exitCode).toBe(1); + }); + + test('throws if syntax errors are encountered when package.json#type=module with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from '@jest/types'; + const config: Config.InitialOptions = {verbose: true}; + export default get config; + `, + 'package.json': '{"type": "module"}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(3,16): error TS2304: Cannot find name 'get'.", + ); + expect(exitCode).toBe(1); + }); }); describe('when `Config` type is imported from "jest"', () => { @@ -210,6 +364,45 @@ describe('when `Config` type is imported from "jest"', () => { expect(globalConfig.verbose).toBe(true); }); + test('with object config exported from CTS file', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + const config: Config = {displayName: 'ts-object-config', verbose: true}; + export default config; + `, + 'package.json': '{}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-object-config'); + expect(globalConfig.verbose).toBe(true); + }); + + test('with function config exported from CTS file', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + async function getVerbose() {return true;} + export default async (): Promise => { + const verbose: Config['verbose'] = await getVerbose(); + return {displayName: 'ts-async-function-config', verbose}; + }; + `, + 'package.json': '{}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-async-function-config'); + expect(globalConfig.verbose).toBe(true); + }); + test('throws if type errors are encountered', () => { writeFiles(DIR, { '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", @@ -248,6 +441,44 @@ describe('when `Config` type is imported from "jest"', () => { expect(exitCode).toBe(1); }); + test('throws if type errors are encountered with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + const config: Config = {testTimeout: '10000'}; + export default config; + `, + 'package.json': '{}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(2,25): error TS2322: Type 'string' is not assignable to type 'number'.", + ); + expect(exitCode).toBe(1); + }); + + test('throws if syntax errors are encountered with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + const config: Config = {verbose: true}; + export default get config; + `, + 'package.json': '{}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(3,16): error TS2304: Cannot find name 'get'.", + ); + expect(exitCode).toBe(1); + }); + test('works with object config exported from TS file when package.json#type=module', () => { writeFiles(DIR, { '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", @@ -287,6 +518,45 @@ describe('when `Config` type is imported from "jest"', () => { expect(globalConfig.verbose).toBe(true); }); + test('works with object config exported from CTS file when package.json#type=module', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + const config: Config = {displayName: 'ts-esm-object-config', verbose: true}; + export default config; + `, + 'package.json': '{"type": "module"}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-esm-object-config'); + expect(globalConfig.verbose).toBe(true); + }); + + test('works with function config exported from CTS file when package.json#type=module', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + async function getVerbose() {return true;} + export default async (): Promise => { + const verbose: Config['verbose'] = await getVerbose(); + return {displayName: 'ts-esm-async-function-config', verbose}; + }; + `, + 'package.json': '{"type": "module"}', + }); + + const {configs, globalConfig} = getConfig(path.join(DIR)); + + expect(configs).toHaveLength(1); + expect(configs[0].displayName?.name).toBe('ts-esm-async-function-config'); + expect(globalConfig.verbose).toBe(true); + }); + test('throws if type errors are encountered when package.json#type=module', () => { writeFiles(DIR, { '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", @@ -324,4 +594,42 @@ describe('when `Config` type is imported from "jest"', () => { ); expect(exitCode).toBe(1); }); + + test('throws if type errors are encountered when package.json#type=module with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(12).toBe(12));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + const config: Config = {testTimeout: '10000'}; + export default config; + `, + 'package.json': '{"type": "module"}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(2,25): error TS2322: Type 'string' is not assignable to type 'number'.", + ); + expect(exitCode).toBe(1); + }); + + test('throws if syntax errors are encountered when package.json#type=module with CTS config', () => { + writeFiles(DIR, { + '__tests__/dummy.test.js': "test('dummy', () => expect(123).toBe(123));", + 'jest.config.cts': ` + import type {Config} from 'jest'; + const config: Config = {verbose: true}; + export default get config; + `, + 'package.json': '{"type": "module"}', + }); + + const {stderr, exitCode} = runJest(DIR); + + expect(stderr).toMatch( + "jest.config.cts(3,16): error TS2304: Cannot find name 'get'.", + ); + expect(exitCode).toBe(1); + }); });