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

Jump to bottom

chore: migrate some tests to TS #10073

Merged
merged 4 commits into from
Jul 30, 2020
Merged

chore: migrate some tests to TS #10073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa520b3
Migrate some tests to TS
ghostd May 21, 2020
0871a32
Remove useless undefined check
ghostd May 25, 2020
f6b431d
Replace require with import
ghostd May 31, 2020
b84ce97
Replace Function with stricter types
ghostd Jun 22, 2020
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
0 ..._snapshots__/assertionCounts.test.js.snap → ..._snapshots__/assertionCounts.test.ts.snap
View file
Open in desktop
File renamed without changes.
0 ...tests__/__snapshots__/extend.test.js.snap → ...tests__/__snapshots__/extend.test.ts.snap
View file
Open in desktop
File renamed without changes.
0 ...__/__snapshots__/spyMatchers.test.js.snap → ...__/__snapshots__/spyMatchers.test.ts.snap
View file
Open in desktop
File renamed without changes.
6 changes: 2 additions & 4 deletions ...ect/src/__tests__/assertionCounts.test.js → ...ect/src/__tests__/assertionCounts.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@
*
*/

'use strict';

const {alignedAnsiStyleSerializer} = require('@jest/test-utils');
const jestExpect = require('../');
import {alignedAnsiStyleSerializer} from '@jest/test-utils';
import jestExpect from '../';

expect.addSnapshotSerializer(alignedAnsiStyleSerializer);

Expand Down
23 changes: 12 additions & 11 deletions packages/expect/src/__tests__/extend.test.js → packages/expect/src/__tests__/extend.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,31 @@
*
*/

const matcherUtils = require('jest-matcher-utils');
const {alignedAnsiStyleSerializer} = require('@jest/test-utils');
const {iterableEquality, subsetEquality} = require('../utils');
const {equals} = require('../jasmineUtils');
const jestExpect = require('../');
import * as matcherUtils from 'jest-matcher-utils';
import {alignedAnsiStyleSerializer} from '@jest/test-utils';
import {iterableEquality, subsetEquality} from '../utils';
import {equals} from '../jasmineUtils';
import jestExpect from '../';

expect.addSnapshotSerializer(alignedAnsiStyleSerializer);

jestExpect.extend({
toBeDivisibleBy(actual, expected) {
toBeDivisibleBy(actual: number, expected: number) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose in a real matcher actual would always be unknown, but here for simplicity we can ignore that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If i use unknown, TS does not allow the %operation on the next line (i guess i should add a if typeof before)

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes I understand, it was more of a loud thought. Could introduce a type check so that this would be more of a 'proper' matcher implementation. In a test where it's just supposed to be some example matcher, I'd be fine with keeping it as is. Your call 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, i didn't understand your comment. You mean something like that:

  toBeDivisibleBy(actual: unknown, expected: number) {
    let pass = false;
    if (typeof actual === 'number') {
      pass = actual % expected === 0;
    }
    const message = pass
      ? () => `expected ${actual} not to be divisible by ${expected}`
      : () => `expected ${actual} to be divisible by ${expected}`;

    return {message, pass};
  },

const pass = actual % expected === 0;
const message = pass
? () => `expected ${actual} not to be divisible by ${expected}`
: () => `expected ${actual} to be divisible by ${expected}`;

return {message, pass};
},
toBeSymbol(actual, expected) {
toBeSymbol(actual: symbol, expected: symbol) {
const pass = actual === expected;
const message = () => `expected ${actual} to be Symbol ${expected}`;
const message = () =>
`expected ${actual.toString()} to be Symbol ${expected.toString()}`;

return {message, pass};
},
toBeWithinRange(actual, floor, ceiling) {
toBeWithinRange(actual: number, floor: number, ceiling: number) {
const pass = actual >= floor && actual <= ceiling;
const message = pass
? () => `expected ${actual} not to be within range ${floor} - ${ceiling}`
Expand Down Expand Up @@ -60,7 +61,7 @@ it('is available globally when matcher is variadic', () => {

it('exposes matcherUtils in context', () => {
jestExpect.extend({
_shouldNotError(actual, expected) {
_shouldNotError(_actual: unknown, _expected: unknown) {
const pass = this.equals(
this.utils,
Object.assign(matcherUtils, {
Expand All @@ -81,7 +82,7 @@ it('exposes matcherUtils in context', () => {

it('is ok if there is no message specified', () => {
jestExpect.extend({
toFailWithoutMessage(expected) {
toFailWithoutMessage(_expected: unknown) {
return {pass: false};
},
});
Expand Down
1 change: 0 additions & 1 deletion ...es/expect/src/__tests__/fakeChalk.test.js → ...es/expect/src/__tests__/fakeChalk.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
'use strict';

const fakeChalk = jest.requireActual('../fakeChalk');

Expand Down
10 changes: 6 additions & 4 deletions ...ages/expect/src/__tests__/isError.test.js → ...ages/expect/src/__tests__/isError.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ import {isError} from '../utils';

// Copied from https://github.com/graingert/angular.js/blob/a43574052e9775cbc1d7dd8a086752c979b0f020/test/AngularSpec.js#L1883
describe('isError', () => {
function testErrorFromDifferentContext(createError) {
function testErrorFromDifferentContext(
createError: (win: Window | null) => Error,
) {
const iframe = document.createElement('iframe');
document.body.appendChild(iframe);
try {
const error = createError(iframe.contentWindow);
expect(isError(error)).toBe(true);
} finally {
iframe.parentElement.removeChild(iframe);
iframe.parentElement!.removeChild(iframe);
}
}

Expand All @@ -34,11 +36,11 @@ describe('isError', () => {
});

it('should detect errors from another context', () => {
testErrorFromDifferentContext(win => new win.Error());
testErrorFromDifferentContext((win: Window) => new win.Error());
});

it('should detect DOMException errors from another context', () => {
testErrorFromDifferentContext(win => {
testErrorFromDifferentContext((win: Window) => {
try {
win.document.querySelectorAll('');
} catch (e) {
Expand Down
40 changes: 23 additions & 17 deletions .../expect/src/__tests__/spyMatchers.test.js → .../expect/src/__tests__/spyMatchers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
* LICENSE file in the root directory of this source tree.
*/

const Immutable = require('immutable');
const {alignedAnsiStyleSerializer} = require('@jest/test-utils');
const jestExpect = require('../');
import * as Immutable from 'immutable';
import {alignedAnsiStyleSerializer} from '@jest/test-utils';
import jestExpect from '../';

expect.addSnapshotSerializer(alignedAnsiStyleSerializer);

// Given a Jest mock function, return a minimal mock of a Jasmine spy.
const createSpy = fn => {
const createSpy = (fn: jest.Mock) => {
const spy = function () {};

spy.calls = {
Expand Down Expand Up @@ -177,7 +177,10 @@ const createSpy = fn => {
'toBeCalledWith',
'toHaveBeenCalledWith',
].forEach(calledWith => {
const caller = function (callee, ...args) {
const caller = function (
callee: (...a: Array<unknown>) => void,
...args: any
) {
if (
calledWith === 'nthCalledWith' ||
calledWith === 'toHaveBeenNthCalledWith'
Expand Down Expand Up @@ -295,8 +298,8 @@ const createSpy = fn => {

test(`works with Immutable.js objects`, () => {
const fn = jest.fn();
const directlyCreated = new Immutable.Map([['a', {b: 'c'}]]);
const indirectlyCreated = new Immutable.Map().set('a', {b: 'c'});
const directlyCreated = Immutable.Map([['a', {b: 'c'}]]);
const indirectlyCreated = Immutable.Map().set('a', {b: 'c'});
fn(directlyCreated, indirectlyCreated);

caller(jestExpect(fn)[calledWith], indirectlyCreated, directlyCreated);
Expand Down Expand Up @@ -534,7 +537,7 @@ const createSpy = fn => {

test(`incomplete recursive calls are handled properly`, () => {
// sums up all integers from 0 -> value, using recursion
const fn = jest.fn(value => {
const fn: jest.Mock = jest.fn(value => {
if (value === 0) {
// Before returning from the base case of recursion, none of the
// calls have returned yet.
Expand Down Expand Up @@ -703,7 +706,7 @@ const createSpy = fn => {

test(`incomplete recursive calls are handled properly`, () => {
// sums up all integers from 0 -> value, using recursion
const fn = jest.fn(value => {
const fn: jest.Mock = jest.fn(value => {
if (value === 0) {
return 0;
} else {
Expand Down Expand Up @@ -734,7 +737,10 @@ const createSpy = fn => {
'toReturnWith',
'toHaveReturnedWith',
].forEach(returnedWith => {
const caller = function (callee, ...args) {
const caller = function (
callee: (...a: Array<unknown>) => void,
...args: any
) {
if (
returnedWith === 'nthReturnedWith' ||
returnedWith === 'toHaveNthReturnedWith'
Expand Down Expand Up @@ -850,7 +856,7 @@ const createSpy = fn => {
});

test(`works with Immutable.js objects directly created`, () => {
const directlyCreated = new Immutable.Map([['a', {b: 'c'}]]);
const directlyCreated = Immutable.Map([['a', {b: 'c'}]]);
const fn = jest.fn(() => directlyCreated);
fn();

Expand All @@ -862,7 +868,7 @@ const createSpy = fn => {
});

test(`works with Immutable.js objects indirectly created`, () => {
const indirectlyCreated = new Immutable.Map().set('a', {b: 'c'});
const indirectlyCreated = Immutable.Map().set('a', {b: 'c'});
const fn = jest.fn(() => indirectlyCreated);
fn();

Expand Down Expand Up @@ -944,7 +950,7 @@ const createSpy = fn => {

test(`incomplete recursive calls are handled properly`, () => {
// sums up all integers from 0 -> value, using recursion
const fn = jest.fn(value => {
const fn: jest.Mock = jest.fn(value => {
if (value === 0) {
// Before returning from the base case of recursion, none of the
// calls have returned yet.
Expand Down Expand Up @@ -1032,7 +1038,7 @@ const createSpy = fn => {
});

test('positive throw matcher error for n that is not integer', async () => {
const fn = jest.fn(() => 'foo');
const fn: jest.Mock = jest.fn(() => 'foo');
fn('foo');

expect(() => {
Expand All @@ -1041,7 +1047,7 @@ const createSpy = fn => {
});

test('negative throw matcher error for n that is not number', async () => {
const fn = jest.fn(() => 'foo');
const fn: jest.Mock = jest.fn(() => 'foo');
fn('foo');

expect(() => {
Expand All @@ -1051,7 +1057,7 @@ const createSpy = fn => {

test(`incomplete recursive calls are handled properly`, () => {
// sums up all integers from 0 -> value, using recursion
const fn = jest.fn(value => {
const fn: jest.Mock = jest.fn(value => {
if (value === 0) {
return 0;
} else {
Expand Down Expand Up @@ -1108,7 +1114,7 @@ const createSpy = fn => {

test(`incomplete recursive calls are handled properly`, () => {
// sums up all integers from 0 -> value, using recursion
const fn = jest.fn(value => {
const fn: jest.Mock = jest.fn(value => {
if (value === 0) {
// Before returning from the base case of recursion, none of the
// calls have returned yet.
Expand Down
14 changes: 7 additions & 7 deletions ...s/expect/src/__tests__/stacktrace.test.js → ...s/expect/src/__tests__/stacktrace.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
*
*/

const jestExpect = require('../');
import jestExpect from '../';

jestExpect.extend({
toCustomMatch(callback, expectation) {
toCustomMatch(callback: () => unknown, expectation: unknown) {
const actual = callback();

if (actual !== expectation) {
Expand All @@ -21,7 +21,7 @@ jestExpect.extend({

return {pass: true};
},
toMatchPredicate(received, argument) {
toMatchPredicate(received: unknown, argument: (a: unknown) => void) {
argument(received);
return {
message: () => '',
Expand All @@ -34,17 +34,17 @@ it('stack trace points to correct location when using matchers', () => {
try {
jestExpect(true).toBe(false);
} catch (error) {
expect(error.stack).toContain('stacktrace.test.js:35');
expect(error.stack).toContain('stacktrace.test.ts:35');
}
});

it('stack trace points to correct location when using nested matchers', () => {
try {
jestExpect(true).toMatchPredicate(value => {
jestExpect(true).toMatchPredicate((value: unknown) => {
jestExpect(value).toBe(false);
});
} catch (error) {
expect(error.stack).toContain('stacktrace.test.js:44');
expect(error.stack).toContain('stacktrace.test.ts:44');
}
});

Expand All @@ -60,6 +60,6 @@ it('stack trace points to correct location when throwing from a custom matcher',
foo();
}).toCustomMatch('bar');
} catch (error) {
expect(error.stack).toContain('stacktrace.test.js:57');
expect(error.stack).toContain('stacktrace.test.ts:57');
}
});
2 changes: 0 additions & 2 deletions ...ect/src/__tests__/symbolInObjects.test.js → ...ect/src/__tests__/symbolInObjects.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
*
*/

'use strict';

describe('Symbol in objects', () => {
test('should compare objects with Symbol keys', () => {
const sym = Symbol('foo');
Expand Down
6 changes: 3 additions & 3 deletions .../expect/src/__tests__/toEqual-dom.test.js → .../expect/src/__tests__/toEqual-dom.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ describe('toEqual', () => {
describe('duck type', () => {
// https://github.com/facebook/jest/issues/7786

const createElement = (name, ...childNodes) => ({
const createElement = (name: string, ...childNodes: Array<unknown>) => ({
childNodes,
nodeType: 1,
tagName: name.toUpperCase(),
});

const createTextNode = data => ({
const createTextNode = (data: unknown) => ({
data,
nodeType: 3,
});

const createDocumentFragment = (...children) => ({
const createDocumentFragment = (...children: Array<unknown>) => ({
children,
nodeType: 11,
});
Expand Down
Loading