kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-20 12:46:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(jest): add types for implementing custom interfaces (#18034)

Browse Source 
* refactor(jest): enable tslint

* feat(jest): use global-modifying-module format

* feat(jest): add types for implementing custom interfaces

* fix(jest): should use interface instead of class, since it does not exist in jest environment

* docs(jest): fix typo

* revert: feat(jest): use global-modifying-module format

This reverts commit 99f7db4eac4530423f9de99f0553dbbc5043fc1d.

* docs(jest): fix typo

* feat(jest): update TS version to 2.2

* fix(jest): flow's Maybe type
This commit is contained in:
Ika
2017-07-18 02:12:12 +08:00
committed by Andy
parent d00caf8115
commit 2b52c98aea
3 changed files with 855 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

871
types/jest/index.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

219
types/jest/jest-tests.ts
View File

@@ -5,24 +5,24 @@ declare var require: {
requireMock(s: string): any;
};
// TODO: use real jquery types?
declare var $: any;
declare let $: any;
// Tests based on the Jest website
jest.unmock('../sum');
describe('sum', function() {
it('adds 1 + 2 to equal 3', function() {
var sum: (a: number, b: number) => number = require('../sum');
describe('sum', () => {
it('adds 1 + 2 to equal 3', () => {
let sum: (a: number, b: number) => number = require('../sum');
expect(sum(1, 2)).toBe(3);
});
});
describe('fetchCurrentUser', function() {
it('calls the callback when $.ajax requests are finished', function() {
var fetchCurrentUser = require('../fetchCurrentUser');
describe('fetchCurrentUser', () => {
it('calls the callback when $.ajax requests are finished', () => {
let fetchCurrentUser = require('../fetchCurrentUser');
// Create a mock function for our callback
var callback = jest.fn();
let callback = jest.fn();
fetchCurrentUser(callback);
// Now we emulate the process by which `$.ajax` would execute its own
@@ -42,10 +42,10 @@ describe('fetchCurrentUser', function() {
});
// unmock is the recommended approach for unmocking...
jest.unmock('../displayUser.js')
jest.unmock('../displayUser.js');
describe('displayUser', function() {
it('displays a user after a click', function() {
describe('displayUser', () => {
it('displays a user after a click', () => {
// Set up our document body
document.body.innerHTML =
'<div>' +
@@ -53,13 +53,13 @@ describe('displayUser', function() {
' <button id="button" />' +
'</div>';
var displayUser = require.requireActual('../displayUser');
var $ = require('jquery');
var fetchCurrentUser = require('../fetchCurrentUser');
let displayUser = require.requireActual('../displayUser');
let $ = require('jquery');
let fetchCurrentUser = require('../fetchCurrentUser');
// Tell the fetchCurrentUser mock function to automatically invoke
// its callback with some data
fetchCurrentUser.mockImplementation(function(cb: Function) {
fetchCurrentUser.mockImplementation((cb: (...args: any[]) => any) => {
cb({
loggedIn: true,
fullName: 'Johnny Cash'
@@ -77,14 +77,14 @@ describe('displayUser', function() {
});
jest.unmock('../CheckboxWithLabel.js');
describe('CheckboxWithLabel', function() {
it('changes the text after click', function() {
var React = require('react/addons');
var CheckboxWithLabel = require('../CheckboxWithLabel.js');
var TestUtils = React.addons.TestUtils;
describe('CheckboxWithLabel', () => {
it('changes the text after click', () => {
let React = require('react/addons');
let CheckboxWithLabel = require('../CheckboxWithLabel.js');
let TestUtils = React.addons.TestUtils;
// Render a checkbox with label in the document
var checkbox = TestUtils.renderIntoDocument(
let checkbox = TestUtils.renderIntoDocument(
CheckboxWithLabel({
labelOn: "On",
labelOff: "Off"
@@ -92,12 +92,12 @@ describe('CheckboxWithLabel', function() {
);
// Verify that it's Off by default
var label = TestUtils.findRenderedDOMComponentWithTag(
let label = TestUtils.findRenderedDOMComponentWithTag(
checkbox, 'label');
expect(label.getDOMNode().textContent).toEqual('Off');
// Simulate a click and verify that it is now On
var input = TestUtils.findRenderedDOMComponentWithTag(
let input = TestUtils.findRenderedDOMComponentWithTag(
checkbox, 'input');
TestUtils.Simulate.change(input);
expect(label.getDOMNode().textContent).toEqual('On');
@@ -105,92 +105,92 @@ describe('CheckboxWithLabel', function() {
});
jest.runAllTicks();
xdescribe('Hooks and Suits', function () {
xdescribe('Hooks and Suits', () => {
let tested: boolean;
beforeEach(function () {
beforeEach(() => {
tested = false;
});
afterEach(function () {
afterEach(() => {
tested = true;
});
test('tested', function () {
test('tested', () => {
expect(tested).toBeTruthy();
expect(tested).not.toBeFalsy();
});
fit('tested', function () {
fit('tested', () => {
expect(tested).toBeDefined();
expect(tested).not.toBeUndefined();
});
xit('expect null to be null', function () {
xit('expect null to be null', () => {
expect(null).toBeNull();
});
xit('expect NaN to be NaN', function () {
xit('expect NaN to be NaN', () => {
expect(NaN).toBeNaN();
});
});
describe('compartion', function () {
var sum: (a: number, b: number) => number = require.requireMock('../sum');
describe('compartion', () => {
let sum: (a: number, b: number) => number = require.requireMock('../sum');
it('compares is 7 + 2 greater than 3', function () {
it('compares is 7 + 2 greater than 3', () => {
expect(sum(7, 2)).toBeGreaterThan(3);
});
it('compares is 2 + 7 greater than or equal to 3', function () {
it('compares is 2 + 7 greater than or equal to 3', () => {
expect(sum(2, 7)).toBeGreaterThanOrEqual(3);
});
it('compares is 3 less than 3 + 4', function () {
it('compares is 3 less than 3 + 4', () => {
expect(3).toBeLessThan(sum(3, 4));
});
it('compares is 3 less than or equal to 4 + 3', function () {
it('compares is 3 less than or equal to 4 + 3', () => {
expect(3).toBeLessThanOrEqual(sum(4, 3));
});
it('works sanely with simple decimals', function () {
it('works sanely with simple decimals', () => {
expect(0.2 + 0.1).toBeCloseTo(0.3, 5);
});
it('works sanely with simple decimals and the default delta', function () {
it('works sanely with simple decimals and the default delta', () => {
expect(0.2 + 0.1).toBeCloseTo(0.3);
});
});
describe('toThrow API', function () {
describe('toThrow API', () => {
function throwTypeError(): void {
throw new TypeError('toThrow Definition was out of date');
}
it('throws', function () {
it('throws', () => {
expect(throwTypeError()).toThrow();
expect(throwTypeError()).toThrowError();
});
it('throws TypeError', function () {
it('throws TypeError', () => {
expect(throwTypeError()).toThrow(TypeError);
expect(throwTypeError()).toThrowError(TypeError);
});
it('throws \'Definition was out of date\'', function () {
it('throws \'Definition was out of date\'', () => {
expect(throwTypeError()).toThrow(/Definition was out of date/);
expect(throwTypeError()).toThrowError(/Definition was out of date/);
expect(throwTypeError()).toThrowError(/Definition was out of date/);
});
it('throws \'toThorow Definition was out of date\'', function () {
it('throws \'toThorow Definition was out of date\'', () => {
expect(throwTypeError()).toThrow('toThrow Definition was out of date');
expect(throwTypeError()).toThrowError('toThrow Definition was out of date');
expect(throwTypeError()).toThrowError('toThrow Definition was out of date');
});
});
describe('Assymetric matchers', function () {
it('works', function () {
describe('Assymetric matchers', () => {
it('works', () => {
expect({
timestamp: 1480807810388,
text: 'Some text content, but we care only about *this part*'
@@ -202,7 +202,7 @@ describe('Assymetric matchers', function () {
const callback = jest.fn();
expect(callback).toEqual(expect.any(Function));
callback(5, "test");
expect(callback).toBeCalledWith(expect.any(Number), expect.any(String))
expect(callback).toBeCalledWith(expect.any(Number), expect.any(String));
const obj = {
items: [1]
};
@@ -224,13 +224,13 @@ describe('Assymetric matchers', function () {
const test: Test = {
a: expect.any(Number),
b: expect.anything()
}
};
expect(callback).toHaveBeenCalledWith(test);
});
});
describe('Extending extend', function () {
it('works', function () {
describe('Extending extend', () => {
it('works', () => {
expect.extend({
toBeNumber(received: any, actual: any) {
const pass = received === actual;
@@ -256,20 +256,20 @@ describe('Extending extend', function () {
});
});
describe('missing tests', function () {
it('creates closures', function () {
describe('missing tests', () => {
it('creates closures', () => {
class Closure<T> {
private arg: T;
public constructor(private fn: (arg: T) => void) {
constructor(private fn: (arg: T) => void) {
this.fn = fn;
}
public bind(arg: T): void {
bind(arg: T): void {
this.arg = arg;
}
public call(): void {
call(): void {
this.fn(this.arg);
}
}
@@ -284,10 +284,10 @@ describe('missing tests', function () {
expect(jest.isMockFunction(spy)).toBeTruthy();
});
it('tests all mising Mocks functionality', function () {
type FruitsGetter = () => Array<string>;
it('tests all mising Mocks functionality', () => {
type FruitsGetter = () => string[];
let mock: jest.Mock<FruitsGetter> = jest.fn<FruitsGetter>();
mock.mockImplementationOnce(() => ['Orange', 'Apple', 'Plum'])
mock.mockImplementationOnce(() => ['Orange', 'Apple', 'Plum']);
jest.setMock('./../tesks/getFruits', mock);
const getFruits: FruitsGetter = require('./../tesks/getFruits');
expect(getFruits()).toContain('Orange');
@@ -295,53 +295,53 @@ describe('missing tests', function () {
expect(mock()).not.toContain('Orange');
const myBeverage: any = {delicious: true, sour: false};
expect(myBeverage).toContainEqual({delicious: true, sour: false});
mock.mockReturnValue([]); //Deprecated: Use jest.fn(() => value) instead.
mock.mockReturnValue([]); // Deprecated: Use jest.fn(() => value) instead.
mock.mockClear();
let thisMock: jest.Mock<any> = jest.fn<any>().mockReturnThis();
expect(thisMock()).toBe(this);
});
it('creates snapshoter', function () {
it('creates snapshoter', () => {
jest.disableAutomock().mock('./render', () => jest.fn((): string => "{Link to: \"facebook\"}"), { virtual: true });
const render: () => string = require('./render');
expect(render()).toMatch(/Link/);
jest.enableAutomock();
});
it('runs only pending timers', function () {
it('runs only pending timers', () => {
jest.useRealTimers();
setTimeout(() => expect(1).not.toEqual(0), 3000);
jest.runOnlyPendingTimers().runTimersToTime(300);
});
it('runs all timers', function () {
it('runs all timers', () => {
jest.clearAllTimers();
jest.useFakeTimers();
setTimeout(() => expect(0).not.toEqual(1), 3000);
jest.runAllTimers();
});
it('cleares cache', function () {
it('cleares cache', () => {
const sum1 = require('../sum');
jest.resetModules();
const sum2 = require('../sum');
expect(sum1).not.toBe(sum2);
})
});
});
describe('toMatchSnapshot', function () {
it('compares snapshots', function () {
describe('toMatchSnapshot', () => {
it('compares snapshots', () => {
expect({ type: 'a', props: { href: 'https://www.facebook.com/' }, children: [ 'Facebook' ] }).toMatchSnapshot();
});
it('can give name to snapshot', function () {
it('can give name to snapshot', () => {
expect({ type: 'a', props: { href: 'https://www.facebook.com/' }, children: [ 'Facebook' ] }).toMatchSnapshot('given name');
});
});
describe('toThrowErrorMatchingSnapshot', function () {
it('compares snapshots', function () {
expect(() => { throw new Error('descriptiton') }).toThrowErrorMatchingSnapshot();
describe('toThrowErrorMatchingSnapshot', () => {
it('compares snapshots', () => {
expect(() => { throw new Error('descriptiton'); }).toThrowErrorMatchingSnapshot();
});
});
@@ -357,8 +357,8 @@ expect.addSnapshotSerializer({
return val && val.willOverwrite && val.willOverwrite !== testSerializerPluginString;
},
});
describe('addSnapshotSerializer', function () {
it('the plugin does its work', function () {
describe('addSnapshotSerializer', () => {
it('the plugin does its work', () => {
testSerializerPluginCallCount = 0;
expect({ willOverwrite: { x: 1, y: 2, } }).toMatchSnapshot();
expect({ willOverwrite: "this will get overwritten by testSerializerPlugin" }).toMatchSnapshot();
@@ -368,23 +368,22 @@ describe('addSnapshotSerializer', function () {
});
});
function testInstances() {
var mockFn = jest.fn<Function>();
var a = new mockFn();
var b = new mockFn();
let mockFn = jest.fn<(...args: any[]) => any>();
let a = new mockFn();
let b = new mockFn();
mockFn.mock.instances[0] === a; // true
mockFn.mock.instances[1] === b; // true
}
function testMockImplementation() {
var mockFn = jest.fn<Function>().mockImplementation(function (scalar:number):number {
let mockFn = jest.fn<(...args: any[]) => any>().mockImplementation((scalar: number): number => {
return 42 + scalar;
});
var a = mockFn(0);
var b = mockFn(1);
let a = mockFn(0);
let b = mockFn(1);
a === 42; // true
b === 43; // true
@@ -394,15 +393,15 @@ function testMockImplementation() {
}
// Test from jest Docs: <http://facebook.github.io/jest/docs/manual-mocks.html#content>
describe('genMockFromModule', function () {
describe('genMockFromModule', () => {
// Interfaces:
interface MockFiles {
[index: string]: string;
}
interface MockedFS {
readdirSync: (dir: string) => string[];
__setMockFiles: (newMockFiles: MockFiles) => void ;
readdirSync(dir: string): string[];
__setMockFiles(newMockFiles: MockFiles): void ;
}
// ------------------------------------------------------------------------------------
@@ -417,7 +416,7 @@ describe('genMockFromModule', function () {
}));
}
//export default summarizeFilesInDirectorySync; // For sake of compilation
// export default summarizeFilesInDirectorySync; // For sake of compilation
// ------------------------------------------------------------------------------------
// __mocks__/fs.js
@@ -429,7 +428,7 @@ describe('genMockFromModule', function () {
let mockFiles: any = Object.create(null);
function __setMockFiles(newMockFiles: MockFiles): void {
mockFiles = Object.create(null);
for(const file in newMockFiles) {
for (const file in newMockFiles) {
const dir: string = path.dirname(file);
if (!mockFiles[dir]) {
@@ -446,7 +445,7 @@ describe('genMockFromModule', function () {
mockedFS.readdirSync = readdirSync;
mockedFS.__setMockFiles = __setMockFiles;
//export = mockedFS; // For sake of compilation
// export = mockedFS; // For sake of compilation
// ------------------------------------------------------------------------------------
// __tests__/FileSummarizer-test.js
@@ -475,14 +474,14 @@ describe('genMockFromModule', function () {
/**
* Pass strictNullChecks
*/
describe('strictNullChecks', function () {
describe('strictNullChecks', () => {
it('does not complain when using done callback', (done) => {
done();
})
});
});
class TestApi {
constructor() { };
constructor() { }
testProp: boolean;
private anotherProp: string;
testMethod(a: number): string { return ""; }
@@ -492,8 +491,8 @@ declare function mockedFunc(a: number): string;
declare function mockedFuncWithApi(api: TestApi): void;
describe('Mocked type', function () {
it('Works', function () {
describe('Mocked type', () => {
it('Works', () => {
const mock: jest.Mocked<TestApi> = new TestApi() as any;
mock.testProp;
mock.testMethod.mockImplementation(() => 'test');
@@ -503,8 +502,8 @@ describe('Mocked type', function () {
});
});
describe('Mocks', function () {
it('jest.fn() without args is a function type', function () {
describe('Mocks', () => {
it('jest.fn() without args is a function type', () => {
const test = jest.fn();
test();
new test();
@@ -512,7 +511,7 @@ describe('Mocks', function () {
test.mockImplementation(() => { });
});
it('jest.fn() with returned object infers type', function () {
it('jest.fn() with returned object infers type', () => {
const testMock = jest.fn(() => ({ a: 5, test: jest.fn() }));
testMock(5, 5, 'a');
@@ -537,14 +536,14 @@ describe('Mocks', function () {
});
// https://facebook.github.io/jest/docs/en/expect.html#resolves
describe('resolves', function() {
it('unwraps the expected Promise', function() {
describe('resolves', () => {
it('unwraps the expected Promise', () => {
const expectation = expect(Promise.resolve('test')).resolves.toEqual('test');
expect(expectation instanceof Promise).toBeTruthy();
return expectation;
});
it('unwraps a .toHaveBeenCalledX', function(done) {
it('unwraps a .toHaveBeenCalledX', done => {
expect.assertions(2);
const fn = jest.fn();
@@ -554,7 +553,7 @@ describe('resolves', function() {
});
});
it('unwraps a not.toHaveBeenCalledX', function(done) {
it('unwraps a not.toHaveBeenCalledX', done => {
expect.assertions(2);
const fn = jest.fn();
@@ -566,10 +565,30 @@ describe('resolves', function() {
});
// https://facebook.github.io/jest/docs/en/expect.html#rejects
describe('rejects', function() {
it('unwraps the expected Promise', function() {
describe('rejects', () => {
it('unwraps the expected Promise', () => {
const expectation = expect(Promise.reject(new Error('error'))).rejects.toMatch('error');
expect(expectation instanceof Promise).toBeTruthy();
return expectation;
});
});
class MyTransformer implements jest.Transformer {
process(text: string, path: string) {
return `
// some comments
${text}
`;
}
}
class MyReporter implements jest.Reporter {
onRunStart() {
console.log('hello world');
}
}
declare const testResult: jest.TestResult;
const myTestRunner: jest.TestFramework = () => Promise.resolve(testResult);
const testResultsProcessor: jest.TestResultsProcessor = result => ({...result, numFailedTests: 1});

1
types/jest/tslint.json Normal file
View File

@@ -0,0 +1 @@
{"extends": "dtslint/dt.json"}