|
| 1 | +import type { Mock, MockResult, MockSettledResult, Procedure } from '@vitest/spy' |
| 2 | +import { expectTypeOf, test } from 'vitest' |
| 3 | + |
| 4 | +test('spy.mock when implementation is a class', () => { |
| 5 | + class Klass { |
| 6 | + constructor(_a: string, _b?: number) { |
| 7 | + // ... |
| 8 | + } |
| 9 | + |
| 10 | + static getType() { |
| 11 | + return 'Klass' |
| 12 | + } |
| 13 | + } |
| 14 | + |
| 15 | + const Mock = vi.fn(Klass) |
| 16 | + |
| 17 | + expectTypeOf(Mock.mock.calls).toEqualTypeOf<[a: string, b?: number][]>() |
| 18 | + expectTypeOf(Mock.mock.results).toEqualTypeOf<MockResult<void>[]>() |
| 19 | + expectTypeOf(Mock.mock.contexts).toEqualTypeOf<Klass[]>() |
| 20 | + expectTypeOf(Mock.mock.instances).toEqualTypeOf<Klass[]>() |
| 21 | + expectTypeOf(Mock.mock.invocationCallOrder).toEqualTypeOf<number[]>() |
| 22 | + expectTypeOf(Mock.mock.settledResults).toEqualTypeOf<MockSettledResult<void>[]>() |
| 23 | + expectTypeOf(Mock.mock.lastCall).toEqualTypeOf<[a: string, b?: number] | undefined>() |
| 24 | + |
| 25 | + // static properties are defined |
| 26 | + expectTypeOf(Mock.getType).toBeFunction() |
| 27 | + expectTypeOf(Mock.getType).returns.toBeString() |
| 28 | + |
| 29 | + expectTypeOf(Mock).constructorParameters.toEqualTypeOf<[a: string, b?: number]>() |
| 30 | + expectTypeOf(Mock).instance.toEqualTypeOf<Klass>() |
| 31 | +}) |
| 32 | + |
| 33 | +test('spy.mock when implementation is a class-like function', () => { |
| 34 | + function Klass(this: typeof Klass, _a: string, _b?: number) { |
| 35 | + // ... |
| 36 | + } |
| 37 | + |
| 38 | + const Mock = vi.fn(Klass) |
| 39 | + |
| 40 | + expectTypeOf(Mock.mock.calls).toEqualTypeOf<[a: string, b?: number][]>() |
| 41 | + expectTypeOf(Mock.mock.results).toEqualTypeOf<MockResult<void>[]>() |
| 42 | + expectTypeOf(Mock.mock.contexts).toEqualTypeOf<typeof Klass[]>() |
| 43 | + expectTypeOf(Mock.mock.instances).toEqualTypeOf<typeof Klass[]>() |
| 44 | + expectTypeOf(Mock.mock.invocationCallOrder).toEqualTypeOf<number[]>() |
| 45 | + expectTypeOf(Mock.mock.settledResults).toEqualTypeOf<MockSettledResult<void>[]>() |
| 46 | + expectTypeOf(Mock.mock.lastCall).toEqualTypeOf<[a: string, b?: number] | undefined>() |
| 47 | + |
| 48 | + expectTypeOf(Mock).constructorParameters.toEqualTypeOf<[a: string, b?: number]>() |
| 49 | +}) |
| 50 | + |
| 51 | +test('spy.mock when implementation is a normal function', () => { |
| 52 | + function FN(_a: string, _b?: number) { |
| 53 | + return 42 |
| 54 | + } |
| 55 | + |
| 56 | + const Mock = vi.fn(FN) |
| 57 | + |
| 58 | + expectTypeOf(Mock.mock.calls).toEqualTypeOf<[a: string, b?: number][]>() |
| 59 | + expectTypeOf(Mock.mock.results).toEqualTypeOf<MockResult<number>[]>() |
| 60 | + expectTypeOf(Mock.mock.contexts).toEqualTypeOf<unknown[]>() |
| 61 | + expectTypeOf(Mock.mock.instances).toEqualTypeOf<unknown[]>() |
| 62 | + expectTypeOf(Mock.mock.invocationCallOrder).toEqualTypeOf<number[]>() |
| 63 | + expectTypeOf(Mock.mock.settledResults).toEqualTypeOf<MockSettledResult<number>[]>() |
| 64 | + expectTypeOf(Mock.mock.lastCall).toEqualTypeOf<[a: string, b?: number] | undefined>() |
| 65 | + |
| 66 | + expectTypeOf(Mock).constructorParameters.toEqualTypeOf<[a: string, b?: number]>() |
| 67 | +}) |
| 68 | + |
| 69 | +test('cann call a function mock with and without new', () => { |
| 70 | + const Mock = vi.fn(function fn(this: any) { |
| 71 | + this.test = true |
| 72 | + }) |
| 73 | + |
| 74 | + const _mockClass = new Mock() |
| 75 | + const _mockFn = Mock() |
| 76 | +}) |
| 77 | + |
| 78 | +test('cannot call class mock without new', () => { |
| 79 | + const Mock = vi.fn(class {}) |
| 80 | + |
| 81 | + const _mockClass = new Mock() |
| 82 | + // @ts-expect-error value is not callable |
| 83 | + const _mockFn = Mock() |
| 84 | +}) |
| 85 | + |
| 86 | +test('spying on a function that supports new', () => { |
| 87 | + interface ReturnClass {} |
| 88 | + interface BothFnAndClass { |
| 89 | + new (): ReturnClass |
| 90 | + (): ReturnClass |
| 91 | + } |
| 92 | + |
| 93 | + const Mock = vi.fn(function R() {} as BothFnAndClass) |
| 94 | + |
| 95 | + // supports new |
| 96 | + const _mockClass = new Mock() |
| 97 | + // supports T() |
| 98 | + const _mockFn = Mock() |
| 99 | +}) |
| 100 | + |
| 101 | +test('withImplementation returns correct type', () => { |
| 102 | + const spy = vi.fn() |
| 103 | + |
| 104 | + const result42 = spy.withImplementation(() => {}, () => { |
| 105 | + return 42 |
| 106 | + }) |
| 107 | + expectTypeOf(result42).toEqualTypeOf<Mock<Procedure>>() |
| 108 | + |
| 109 | + const resultObject = spy.withImplementation(() => {}, () => { |
| 110 | + return { then: () => 42 } |
| 111 | + }) |
| 112 | + expectTypeOf(resultObject).toEqualTypeOf<Mock<Procedure>>() |
| 113 | + |
| 114 | + const resultVoid = spy.withImplementation(() => {}, () => {}) |
| 115 | + expectTypeOf(resultVoid).toEqualTypeOf<Mock<Procedure>>() |
| 116 | + |
| 117 | + const promise42 = spy.withImplementation(() => {}, async () => { |
| 118 | + return 42 |
| 119 | + }) |
| 120 | + expectTypeOf(promise42).toEqualTypeOf<Promise<Mock<Procedure>>>() |
| 121 | + |
| 122 | + const promiseObject = spy.withImplementation(() => {}, async () => { |
| 123 | + return { hello: () => 42 } |
| 124 | + }) |
| 125 | + expectTypeOf(promiseObject).toEqualTypeOf<Promise<Mock<Procedure>>>() |
| 126 | + |
| 127 | + const promiseVoid = spy.withImplementation(() => {}, async () => {}) |
| 128 | + expectTypeOf(promiseVoid).toEqualTypeOf<Promise<Mock<Procedure>>>() |
| 129 | + |
| 130 | + const promisePromise = spy.withImplementation(() => {}, () => { |
| 131 | + return Promise.resolve() |
| 132 | + }) |
| 133 | + expectTypeOf(promisePromise).toEqualTypeOf<Promise<Mock<Procedure>>>() |
| 134 | +}) |
0 commit comments