forked from jestjs/jest
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(jest-config): handle frozen config object (jestjs#14054)
* fix(jest-config): handle frozen config object * change log entry
- Loading branch information
1 parent
8a9609d
commit 08ef105
Showing
3 changed files
with
178 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
169 changes: 169 additions & 0 deletions
169
packages/jest-config/src/__tests__/readConfigFileAndSetRootDir.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,169 @@ | ||
/** | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import path = require('path'); | ||
import * as fs from 'graceful-fs'; | ||
import {requireOrImportModule} from 'jest-util'; | ||
import readConfigFileAndSetRootDir from '../readConfigFileAndSetRootDir'; | ||
|
||
jest.mock('graceful-fs').mock('jest-util'); | ||
|
||
describe('readConfigFileAndSetRootDir', () => { | ||
describe('JavaScript file', () => { | ||
test('reads config and sets `rootDir`', async () => { | ||
jest.mocked(requireOrImportModule).mockResolvedValueOnce({notify: true}); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({notify: true, rootDir}); | ||
}); | ||
|
||
test('handles exported function', async () => { | ||
jest | ||
.mocked(requireOrImportModule) | ||
.mockResolvedValueOnce(() => ({bail: 1})); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({bail: 1, rootDir}); | ||
}); | ||
|
||
test('handles exported async function', async () => { | ||
jest | ||
.mocked(requireOrImportModule) | ||
.mockResolvedValueOnce(async () => ({testTimeout: 10000})); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({rootDir, testTimeout: 10000}); | ||
}); | ||
}); | ||
|
||
describe('JSON file', () => { | ||
test('reads config and sets `rootDir`', async () => { | ||
jest.mocked(fs.readFileSync).mockReturnValueOnce('{ "verbose": true }'); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'jest.config.json'), | ||
); | ||
|
||
expect(config).toEqual({rootDir, verbose: true}); | ||
}); | ||
|
||
test('supports comments in JSON', async () => { | ||
jest | ||
.mocked(fs.readFileSync) | ||
.mockReturnValueOnce('{ // test comment\n "bail": true }'); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'jest.config.json'), | ||
); | ||
|
||
expect(config).toEqual({bail: true, rootDir}); | ||
}); | ||
}); | ||
|
||
describe('package.json file', () => { | ||
test('reads config from "jest" key and sets `rootDir`', async () => { | ||
jest | ||
.mocked(fs.readFileSync) | ||
.mockReturnValueOnce('{ "jest": { "coverage": true } }'); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'package.json'), | ||
); | ||
|
||
expect(config).toEqual({coverage: true, rootDir}); | ||
}); | ||
|
||
test('sets rootDir if "jest" is absent', async () => { | ||
jest.mocked(fs.readFileSync).mockReturnValueOnce('{ "name": "test" }'); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'package.json'), | ||
); | ||
|
||
expect(config).toEqual({rootDir}); | ||
}); | ||
}); | ||
|
||
describe('sets `rootDir`', () => { | ||
test('handles frozen config object', async () => { | ||
jest | ||
.mocked(requireOrImportModule) | ||
.mockResolvedValueOnce(Object.freeze({preset: 'some-preset'})); | ||
|
||
const rootDir = path.resolve('some', 'path', 'to'); | ||
const config = await readConfigFileAndSetRootDir( | ||
path.join(rootDir, 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({preset: 'some-preset', rootDir}); | ||
}); | ||
|
||
test('keeps the path if it is absolute', async () => { | ||
const rootDir = path.resolve('some', 'path', 'to'); | ||
jest.mocked(requireOrImportModule).mockResolvedValueOnce({ | ||
rootDir, | ||
testEnvironment: 'node', | ||
}); | ||
|
||
const config = await readConfigFileAndSetRootDir( | ||
path.join(path.resolve('other', 'path', 'to'), 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({rootDir, testEnvironment: 'node'}); | ||
}); | ||
|
||
test('resolves the path relative to dirname of the config file', async () => { | ||
jest.mocked(requireOrImportModule).mockResolvedValueOnce({ | ||
restoreMocks: true, | ||
rootDir: path.join('path', 'to'), | ||
}); | ||
|
||
const config = await readConfigFileAndSetRootDir( | ||
path.join(path.resolve('some'), 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({ | ||
restoreMocks: true, | ||
rootDir: path.resolve('some', 'path', 'to'), | ||
}); | ||
}); | ||
|
||
test('resolves relative path when the read config object if frozen', async () => { | ||
jest.mocked(requireOrImportModule).mockResolvedValueOnce( | ||
Object.freeze({ | ||
resetModules: true, | ||
rootDir: path.join('path', 'to'), | ||
}), | ||
); | ||
|
||
const config = await readConfigFileAndSetRootDir( | ||
path.join(path.resolve('some'), 'jest.config.js'), | ||
); | ||
|
||
expect(config).toEqual({ | ||
resetModules: true, | ||
rootDir: path.resolve('some', 'path', 'to'), | ||
}); | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters