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.

Sign up for GitHub

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

chore: use jest.mocked helper in more tests #13117

Merged
merged 2 commits into from
Aug 11, 2022
Merged

chore: use jest.mocked helper in more tests #13117

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f37b267
chore: use `jest.mocked` helper in more tests
SimenB Aug 11, 2022
056509e
cleaner
SimenB Aug 11, 2022
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
4 changes: 2 additions & 2 deletions examples/typescript/__tests__/calc.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ jest.mock('../memory');
jest.mock('../sub');
jest.mock('../sum');

const mockSub = sub as jest.MockedFunction<typeof sub>;
const mockSum = sum as jest.MockedFunction<typeof sum>;
const mockSub = jest.mocked(sub);
const mockSum = jest.mocked(sum);
const MockMemory = Memory as jest.MockedClass<typeof Memory>;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mrazauskas Hiya! I cannot use jest.mocked here as it returns jets.MockedObject<typeof Memory> instead of MockedClass. This happens both with @jest/globals and @types/jest (whom I think just copied the implementation from @jest/globals). Any ideas on how we can make jest.mocked work for classes as well?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. I encountered this while working on #12727. That PR is fixing this issue. In general the work on types is finished in that PR, it just needs more tests. In this case these are rather complex ones. Indeed it would be nice to land it for Jest 29. I will try to push forward with the tests, if you can wait with the release for a couple of days (;

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks! Happy to wait with the release until next week, no rush 🙂


describe('calc - mocks', () => {
Expand Down
14 changes: 6 additions & 8 deletions packages/jest-config/src/__tests__/normalize.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ beforeEach(() => {
});

afterEach(() => {
(console.warn as unknown as jest.SpyInstance).mockRestore();
jest.mocked(console.warn).mockRestore();
});

it('picks an id based on the rootDir', async () => {
Expand Down Expand Up @@ -148,7 +148,7 @@ describe('rootDir', () => {

describe('automock', () => {
it('falsy automock is not overwritten', async () => {
(console.warn as unknown as jest.SpyInstance).mockImplementation(() => {});
jest.mocked(console.warn).mockImplementation(() => {});
const {options} = await normalize(
{
automock: false,
Expand Down Expand Up @@ -1639,9 +1639,7 @@ describe('testPathPattern', () => {
const {options} = await normalize(initialOptions, argv);

expect(options.testPathPattern).toBe('');
expect(
(console.log as unknown as jest.SpyInstance).mock.calls[0][0],
).toMatchSnapshot();
expect(jest.mocked(console.log).mock.calls[0][0]).toMatchSnapshot();
});

it(`joins multiple ${opt.name} if set`, async () => {
Expand Down Expand Up @@ -1783,7 +1781,7 @@ describe('cwd', () => {
});

it('is not lost if the config has its own cwd property', async () => {
(console.warn as unknown as jest.SpyInstance).mockImplementation(() => {});
jest.mocked(console.warn).mockImplementation(() => {});
const {options} = await normalize(
{
cwd: '/tmp/config-sets-cwd-itself',
Expand Down Expand Up @@ -1851,7 +1849,7 @@ describe('displayName', () => {

describe('testTimeout', () => {
it('should return timeout value if defined', async () => {
(console.warn as unknown as jest.SpyInstance).mockImplementation(() => {});
jest.mocked(console.warn).mockImplementation(() => {});
const {options} = await normalize(
{rootDir: '/root/', testTimeout: 1000},
{} as Config.Argv,
Expand Down Expand Up @@ -2001,7 +1999,7 @@ describe('shards', () => {

describe('logs a deprecation warning', () => {
beforeEach(() => {
(console.warn as unknown as jest.SpyInstance).mockImplementation(() => {});
jest.mocked(console.warn).mockImplementation(() => {});
});

test("when 'browser' option is passed", async () => {
Expand Down
4 changes: 2 additions & 2 deletions packages/jest-resolve/src/__mocks__/userResolver.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
* LICENSE file in the root directory of this source tree.
*/

import type {Resolver} from '../defaultResolver';
import type {SyncResolver} from '../defaultResolver';

declare const userResolver: Resolver;
declare const userResolver: SyncResolver;

export default userResolver;
6 changes: 4 additions & 2 deletions packages/jest-resolve/src/__mocks__/userResolverAsync.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
* LICENSE file in the root directory of this source tree.
*/

import type {Resolver} from '../defaultResolver';
import type {AsyncResolver} from '../defaultResolver';

// todo: can be replaced with jest.MockedFunction
declare const userResolver: Resolver;
declare const userResolver: {
async: AsyncResolver;
};

export default userResolver;
48 changes: 27 additions & 21 deletions packages/jest-resolve/src/__tests__/resolve.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,13 @@ jest.mock('resolve', () => {
return m;
});

const mockUserResolver = jest.mocked(userResolver);
const mockUserResolverAsync = jest.mocked(userResolverAsync);
const mockResolveSync = jest.mocked(resolveSync);

beforeEach(() => {
userResolver.mockClear();
userResolverAsync.async.mockClear();
mockUserResolver.mockClear();
mockUserResolverAsync.async.mockClear();
mockResolveSync.mockClear();

Resolver.clearDefaultResolverCache();
Expand Down Expand Up @@ -104,7 +106,7 @@ describe('findNodeModule', () => {
.map(p => path.resolve(resolvedCwd, p))
: null;

userResolver.mockImplementation(() => 'module');
mockUserResolver.mockImplementation(() => 'module');

const newPath = Resolver.findNodeModule('test', {
basedir: '/',
Expand All @@ -116,8 +118,8 @@ describe('findNodeModule', () => {
});

expect(newPath).toBe('module');
expect(userResolver.mock.calls[0][0]).toBe('test');
expect(userResolver.mock.calls[0][1]).toStrictEqual({
expect(mockUserResolver.mock.calls[0][0]).toBe('test');
expect(mockUserResolver.mock.calls[0][1]).toStrictEqual({
basedir: '/',
conditions: ['conditions, woooo'],
defaultResolver,
Expand All @@ -132,7 +134,7 @@ describe('findNodeModule', () => {
const packageFilter = jest.fn();

// A resolver that delegates to defaultResolver with a packageFilter implementation
userResolver.mockImplementation((request, opts) =>
mockUserResolver.mockImplementation((request, opts) =>
opts.defaultResolver(request, {...opts, packageFilter}),
);

Expand Down Expand Up @@ -309,7 +311,7 @@ describe('findNodeModuleAsync', () => {
.map(p => path.resolve(resolvedCwd, p))
: null;

userResolverAsync.async.mockImplementation(() => Promise.resolve('module'));
mockUserResolverAsync.async.mockResolvedValue('module');

const newPath = await Resolver.findNodeModuleAsync('test', {
basedir: '/',
Expand All @@ -321,8 +323,8 @@ describe('findNodeModuleAsync', () => {
});

expect(newPath).toBe('module');
expect(userResolverAsync.async.mock.calls[0][0]).toBe('test');
expect(userResolverAsync.async.mock.calls[0][1]).toStrictEqual({
expect(mockUserResolverAsync.async.mock.calls[0][0]).toBe('test');
expect(mockUserResolverAsync.async.mock.calls[0][1]).toStrictEqual({
basedir: '/',
conditions: ['conditions, woooo'],
defaultResolver,
Expand All @@ -337,7 +339,7 @@ describe('findNodeModuleAsync', () => {
const packageFilter = jest.fn();

// A resolver that delegates to defaultResolver with a packageFilter implementation
userResolverAsync.async.mockImplementation((request, opts) =>
mockUserResolverAsync.async.mockImplementation((request, opts) =>
Promise.resolve(opts.defaultResolver(request, {...opts, packageFilter})),
);

Expand Down Expand Up @@ -445,7 +447,7 @@ describe('resolveModule', () => {
});

it('custom resolver can resolve node modules', () => {
userResolver.mockImplementation(() => 'module');
mockUserResolver.mockImplementation(() => 'module');

const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
Expand All @@ -455,8 +457,8 @@ describe('resolveModule', () => {
const src = require.resolve('../');
resolver.resolveModule(src, 'fs');

expect(userResolver).toHaveBeenCalled();
expect(userResolver.mock.calls[0][0]).toBe('fs');
expect(mockUserResolver).toHaveBeenCalled();
expect(mockUserResolver.mock.calls[0][0]).toBe('fs');
});
});

Expand Down Expand Up @@ -559,7 +561,7 @@ describe('resolveModuleAsync', () => {

describe('getMockModule', () => {
it('is possible to use custom resolver to resolve deps inside mock modules with moduleNameMapper', () => {
userResolver.mockImplementation(() => 'module');
mockUserResolver.mockImplementation(() => 'module');

const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
Expand All @@ -575,9 +577,9 @@ describe('getMockModule', () => {
const src = require.resolve('../');
resolver.getMockModule(src, 'dependentModule');

expect(userResolver).toHaveBeenCalled();
expect(userResolver.mock.calls[0][0]).toBe('dependentModule');
expect(userResolver.mock.calls[0][1]).toHaveProperty(
expect(mockUserResolver).toHaveBeenCalled();
expect(mockUserResolver.mock.calls[0][0]).toBe('dependentModule');
expect(mockUserResolver.mock.calls[0][1]).toHaveProperty(
'basedir',
path.dirname(src),
);
Expand All @@ -586,7 +588,9 @@ describe('getMockModule', () => {

describe('getMockModuleAsync', () => {
it('is possible to use custom resolver to resolve deps inside mock modules with moduleNameMapper', async () => {
userResolverAsync.async.mockImplementation(() => Promise.resolve('module'));
mockUserResolverAsync.async.mockImplementation(() =>
Promise.resolve('module'),
);

const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
Expand All @@ -603,9 +607,11 @@ describe('getMockModuleAsync', () => {

await resolver.resolveModuleAsync(src, 'dependentModule');

expect(userResolverAsync.async).toHaveBeenCalled();
expect(userResolverAsync.async.mock.calls[0][0]).toBe('dependentModule');
expect(userResolverAsync.async.mock.calls[0][1]).toHaveProperty(
expect(mockUserResolverAsync.async).toHaveBeenCalled();
expect(mockUserResolverAsync.async.mock.calls[0][0]).toBe(
'dependentModule',
);
expect(mockUserResolverAsync.async.mock.calls[0][1]).toHaveProperty(
'basedir',
path.dirname(src),
);
Expand Down
24 changes: 12 additions & 12 deletions packages/jest-snapshot/src/__tests__/InlineSnapshots.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ jest.mock('prettier', () => {
return mockPrettier;
});

let dir;
let dir: string;
beforeEach(() => {
(prettier.resolveConfig.sync as jest.Mock).mockReset();
jest.mocked(prettier.resolveConfig.sync).mockReset();
});

beforeEach(() => {
Expand Down Expand Up @@ -262,7 +262,7 @@ test.each([['babel'], ['flow'], ['typescript']])(
const filename = path.join(dir, 'my.test.js');
fs.writeFileSync(filename, 'expect(1).toMatchInlineSnapshot(`2`);\n');

(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({parser});
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({parser});

saveInlineSnapshots(
[
Expand All @@ -275,7 +275,7 @@ test.each([['babel'], ['flow'], ['typescript']])(
);

expect(
(prettier.resolveConfig.sync as jest.Mock).mock.results[0].value,
jest.mocked(prettier.resolveConfig.sync).mock.results[0].value,
).toEqual({parser});

expect(fs.readFileSync(filename, 'utf-8')).toBe(
Expand Down Expand Up @@ -381,7 +381,7 @@ test('saveInlineSnapshots() uses escaped backticks', () => {
test('saveInlineSnapshots() works with non-literals in expect call', () => {
const filename = path.join(dir, 'my.test.js');
fs.writeFileSync(filename, "expect({a: 'a'}).toMatchInlineSnapshot();\n");
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down Expand Up @@ -409,7 +409,7 @@ test('saveInlineSnapshots() indents multi-line snapshots with spaces', () => {
" expect({a: 'a'}).toMatchInlineSnapshot();\n" +
'});\n',
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down Expand Up @@ -451,7 +451,7 @@ test('saveInlineSnapshots() does not re-indent error snapshots', () => {
" expect({a: 'a'}).toMatchInlineSnapshot();\n" +
'});\n',
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down Expand Up @@ -500,7 +500,7 @@ test('saveInlineSnapshots() does not re-indent already indented snapshots', () =
' `);\n' +
'});\n',
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down Expand Up @@ -541,7 +541,7 @@ test('saveInlineSnapshots() indents multi-line snapshots with tabs', () => {
" expect({a: 'a'}).toMatchInlineSnapshot();\n" +
'});\n',
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
useTabs: true,
Expand Down Expand Up @@ -574,7 +574,7 @@ test('saveInlineSnapshots() indents snapshots after prettier reformats', () => {
filename,
"it('is a test', () => expect({a: 'a'}).toMatchInlineSnapshot());\n",
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down Expand Up @@ -605,7 +605,7 @@ test('saveInlineSnapshots() does not indent empty lines', () => {
filename,
"it('is a test', () => expect(`hello\n\nworld`).toMatchInlineSnapshot());\n",
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down Expand Up @@ -639,7 +639,7 @@ test('saveInlineSnapshots() indents awaited snapshots with spaces', () => {
' await expect(a).resolves.toMatchInlineSnapshot();\n' +
'});\n',
);
(prettier.resolveConfig.sync as jest.Mock).mockReturnValue({
jest.mocked(prettier.resolveConfig.sync).mockReturnValue({
bracketSpacing: false,
singleQuote: true,
});
Expand Down
Loading