Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

fix(test runner): remove folio/jest namespaces in expect matchers (#6930)

Browse source
This commit is contained in:
Dmitry Gozman 2021-06-07 08:02:01 -07:00 committed by GitHub
parent cfd49b5c01
commit 8c13f679b7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/src/test-advanced.md
View file

@ -467,16 +467,9 @@ For TypeScript, also add the following to `global.d.ts`. You don't need it for J
```js
// global.d.ts
declare namespace folio {
declare namespace PlaywrightTest {
interface Matchers<R> {
toBeWithinRange(a: number, b: number): R;
}
}
```
To import expect matching libraries like [jest-extended](https://github.com/jest-community/jest-extended#installation) you can import it from your `global.d.ts`:
```js
// global.d.ts
import 'jest-extended';
```

30
tests/playwright-test/expect.spec.ts
View file

@ -16,7 +16,7 @@
import { test, expect } from './playwright-test-fixtures';
test('should be able to extend the expect matchers with test.extend in the folio config', async ({ runInlineTest }) => {
test('should be able to call expect.extend in config', async ({ runInlineTest }) => {
const result = await runInlineTest({
'helper.ts': `
pwt.expect.extend({
@ -73,36 +73,12 @@ test('should work with default expect matchers', async ({runTSC}) => {
expect(result.exitCode).toBe(0);
});
test('should work with jest-community/jest-extended', async ({runTSC}) => {
test('should work with custom PlaywrightTest namespace', async ({runTSC}) => {
const result = await runTSC({
'global.d.ts': `
// Extracted example from their typings.
// Reference: https://github.com/jest-community/jest-extended/blob/master/types/index.d.ts
declare namespace jest {
interface Matchers<R> {
toBeEmpty(): R;
}
}
`,
'a.spec.ts': `
const { test } = pwt;
test.expect('').toBeEmpty();
test.expect('hello').not.toBeEmpty();
test.expect([]).toBeEmpty();
test.expect(['hello']).not.toBeEmpty();
test.expect({}).toBeEmpty();
test.expect({ hello: 'world' }).not.toBeEmpty();
`
});
expect(result.exitCode).toBe(0);
});
test('should work with custom folio namespace', async ({runTSC}) => {
const result = await runTSC({
'global.d.ts': `
// Extracted example from their typings.
// Reference: https://github.com/jest-community/jest-extended/blob/master/types/index.d.ts
declare namespace folio {
declare namespace PlaywrightTest {
interface Matchers<R> {
toBeEmpty(): R;
}

15
types/testExpect.d.ts vendored
View file

@ -12,7 +12,7 @@ import type { ExpectedAssertionsErrors } from 'expect/build/types';
export declare type AsymmetricMatcher = Record<string, any>;
export declare type Expect = {
<T = unknown>(actual: T): folio.Matchers<T>;
<T = unknown>(actual: T): PlaywrightTest.Matchers<T>;
// Sourced from node_modules/expect/build/types.d.ts
assertions(arg0: number): void;
@ -30,27 +30,22 @@ export declare type Expect = {
};
declare global {
export namespace jest {
export namespace PlaywrightTest {
export interface Matchers<R> extends expect.Matchers<R> {
}
}
export namespace folio {
export interface Matchers<R> extends jest.Matchers<R> {
/**
* If you know how to test something, `.not` lets you test its opposite.
*/
not: folio.Matchers<R>;
not: PlaywrightTest.Matchers<R>;
/**
* Use resolves to unwrap the value of a fulfilled promise so any other
* matcher can be chained. If the promise is rejected the assertion fails.
*/
resolves: folio.Matchers<Promise<R>>;
resolves: PlaywrightTest.Matchers<Promise<R>>;
/**
* Unwraps the reason of a rejected promise so any other matcher can be chained.
* If the promise is fulfilled the assertion fails.
*/
rejects: folio.Matchers<Promise<R>>;
rejects: PlaywrightTest.Matchers<Promise<R>>;
/**
* Match snapshot
*/