mirror of
https://github.com/microsoft/playwright.git
synced 2024-12-15 14:11:50 +03:00
4bb563b015
A few changes: - `Matchers<R, T>` now carries both return and argument type. - Based on the argument type, we apply playwright-specific Page/Locator matchers. - Return type is usually void, unless wrapped with `expect.resolves`, `expect.rejects` or `expect.poll()`. - To preserve compatibility with any extended types in the wild, argument type is optional.
348 lines
9.6 KiB
TypeScript
348 lines
9.6 KiB
TypeScript
/**
|
|
* Copyright Microsoft Corporation. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { test, expect, stripAnsi } from './playwright-test-fixtures';
|
|
|
|
test('should be able to call expect.extend in config', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'helper.ts': `
|
|
pwt.expect.extend({
|
|
toBeWithinRange(received, floor, ceiling) {
|
|
const pass = received >= floor && received <= ceiling;
|
|
if (pass) {
|
|
return {
|
|
message: () =>
|
|
'passed',
|
|
pass: true,
|
|
};
|
|
} else {
|
|
return {
|
|
message: () => 'failed',
|
|
pass: false,
|
|
};
|
|
}
|
|
},
|
|
});
|
|
export const test = pwt.test;
|
|
`,
|
|
'expect-test.spec.ts': `
|
|
import { test } from './helper';
|
|
test('numeric ranges', () => {
|
|
test.expect(100).toBeWithinRange(90, 110);
|
|
test.expect(101).not.toBeWithinRange(0, 100);
|
|
});
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
expect(result.passed).toBe(1);
|
|
});
|
|
|
|
test('should not expand huge arrays', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'expect-test.spec.ts': `
|
|
const { test } = pwt;
|
|
test('numeric ranges', () => {
|
|
const a1 = Array(100000).fill(1);
|
|
const a2 = Array(100000).fill(1);
|
|
a2[500] = 2;
|
|
test.expect(a1).toEqual(a2);
|
|
});
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(1);
|
|
expect(result.passed).toBe(0);
|
|
expect(result.output.length).toBeLessThan(100000);
|
|
});
|
|
|
|
test('should include custom error message', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'expect-test.spec.ts': `
|
|
const { test } = pwt;
|
|
test('custom expect message', () => {
|
|
test.expect(1+1, 'one plus one is two!').toEqual(3);
|
|
});
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(1);
|
|
expect(result.passed).toBe(0);
|
|
expect(stripAnsi(result.output)).toContain([
|
|
` Error: one plus one is two!`,
|
|
``,
|
|
` Expected: 3`,
|
|
` Received: 2`,
|
|
].join('\n'));
|
|
});
|
|
|
|
test('should include custom error message with web-first assertions', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'expect-test.spec.ts': `
|
|
const { test } = pwt;
|
|
test('custom expect message', async ({page}) => {
|
|
await expect(page.locator('x-foo'), { message: 'x-foo must be visible' }).toBeVisible({timeout: 1});
|
|
});
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(1);
|
|
expect(result.passed).toBe(0);
|
|
expect(result.output).toContain([
|
|
` Error: x-foo must be visible`,
|
|
``,
|
|
` Call log:`,
|
|
].join('\n'));
|
|
});
|
|
|
|
test('should work with default expect prototype functions', async ({ runTSC, runInlineTest }) => {
|
|
const spec = `
|
|
const { test } = pwt;
|
|
test('pass', async () => {
|
|
const expected = [1, 2, 3, 4, 5, 6];
|
|
test.expect([4, 1, 6, 7, 3, 5, 2, 5, 4, 6]).toEqual(
|
|
expect.arrayContaining(expected),
|
|
);
|
|
expect('foo').toEqual(expect.any(String));
|
|
expect('foo').toEqual(expect.anything());
|
|
});
|
|
`;
|
|
{
|
|
const result = await runTSC({
|
|
'a.spec.ts': spec,
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
}
|
|
{
|
|
const result = await runInlineTest({
|
|
'a.spec.ts': spec,
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
expect(result.passed).toBe(1);
|
|
}
|
|
});
|
|
|
|
test('should work with default expect matchers', async ({ runTSC }) => {
|
|
const result = await runTSC({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test.expect(42).toBe(42);
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
});
|
|
|
|
test('should work with expect message', async ({ runTSC }) => {
|
|
const result = await runTSC({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test.expect(42, 'this is expect message').toBe(42);
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
});
|
|
|
|
test('should work with default expect matchers and esModuleInterop=false', async ({ runTSC }) => {
|
|
const result = await runTSC({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test.expect(42).toBe(42);
|
|
`,
|
|
'tsconfig.json': JSON.stringify({
|
|
'compilerOptions': {
|
|
'target': 'ESNext',
|
|
'moduleResolution': 'node',
|
|
'module': 'commonjs',
|
|
'strict': true,
|
|
'rootDir': '.',
|
|
'esModuleInterop': false,
|
|
'allowSyntheticDefaultImports': false,
|
|
'lib': ['esnext', 'dom', 'DOM.Iterable']
|
|
},
|
|
'exclude': [
|
|
'node_modules'
|
|
]
|
|
}),
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
});
|
|
|
|
test('should work with custom PlaywrightTest namespace', async ({ runTSC }) => {
|
|
const result = await runTSC({
|
|
'global.d.ts': `
|
|
declare namespace PlaywrightTest {
|
|
interface Matchers<R> {
|
|
toBeEmpty(): R;
|
|
}
|
|
interface Matchers<R, T> {
|
|
toBeNonEmpty(): R;
|
|
}
|
|
}
|
|
`,
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test.expect.extend({
|
|
toBeWithinRange() { },
|
|
});
|
|
|
|
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();
|
|
test.expect('').toBeNonEmpty();
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
});
|
|
|
|
test('should propose only the relevant matchers when custom expect matcher classes were passed', async ({ runTSC }) => {
|
|
const result = await runTSC({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test('custom matchers', async ({ page }) => {
|
|
await test.expect(page).toHaveURL('https://example.com');
|
|
await test.expect(page).toBe(true);
|
|
// @ts-expect-error
|
|
await test.expect(page).toBeEnabled();
|
|
|
|
await test.expect(page.locator('foo')).toBeEnabled();
|
|
await test.expect(page.locator('foo')).toBe(true);
|
|
// @ts-expect-error
|
|
await test.expect(page.locator('foo')).toHaveURL('https://example.com');
|
|
|
|
const res = await page.request.get('http://i-do-definitely-not-exist.com');
|
|
await test.expect(res).toBeOK();
|
|
await test.expect(res).toBe(true);
|
|
// @ts-expect-error
|
|
await test.expect(res).toHaveURL('https://example.com');
|
|
|
|
await test.expect(res as any).toHaveURL('https://example.com');
|
|
// @ts-expect-error
|
|
await test.expect(123).toHaveURL('https://example.com');
|
|
});
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
});
|
|
|
|
test('should return void/Promise when appropriate', async ({ runTSC }) => {
|
|
const result = await runTSC({
|
|
'a.spec.ts': `
|
|
type AssertType<T, S> = S extends T ? AssertNotAny<S> : false;
|
|
type AssertNotAny<S> = {notRealProperty: number} extends S ? false : true;
|
|
|
|
pwt.test('example', async ({ page }) => {
|
|
{
|
|
const value = expect(1).toBe(2);
|
|
const assertion: AssertType<void, typeof value> = true;
|
|
}
|
|
|
|
{
|
|
const value = expect(1).not.toBe(2);
|
|
const assertion: AssertType<void, typeof value> = true;
|
|
}
|
|
|
|
{
|
|
const value = expect(page).toHaveURL('');
|
|
const assertion: AssertType<Promise<void>, typeof value> = true;
|
|
}
|
|
|
|
{
|
|
const value = expect(Promise.resolve(1)).resolves.toBe(1);
|
|
const assertion: AssertType<Promise<void>, typeof value> = true;
|
|
}
|
|
|
|
{
|
|
const value = expect.soft(1).toBe(2);
|
|
const assertion: AssertType<void, typeof value> = true;
|
|
}
|
|
|
|
{
|
|
const value = expect.poll(() => true).toBe(2);
|
|
const assertion: AssertType<Promise<void>, typeof value> = true;
|
|
}
|
|
});
|
|
`
|
|
});
|
|
expect(result.exitCode).toBe(0);
|
|
});
|
|
|
|
test.describe('helpful expect errors', () => {
|
|
test('top-level', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test('explodes', () => {
|
|
expect(1).nope();
|
|
});
|
|
`
|
|
});
|
|
|
|
expect(result.output).toContain(`expect: Property 'nope' not found.`);
|
|
});
|
|
|
|
test('soft', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test('explodes', () => {
|
|
expect.soft(1).nope();
|
|
});
|
|
`
|
|
});
|
|
|
|
expect(result.output).toContain(`expect: Property 'nope' not found.`);
|
|
});
|
|
|
|
test('poll', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test('explodes', () => {
|
|
expect.poll(() => {}).nope();
|
|
});
|
|
`
|
|
});
|
|
|
|
expect(result.output).toContain(`expect: Property 'nope' not found.`);
|
|
});
|
|
|
|
test('not', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test('explodes', () => {
|
|
expect(1).not.nope();
|
|
});
|
|
`
|
|
});
|
|
|
|
expect(result.output).toContain(`expect: Property 'nope' not found.`);
|
|
});
|
|
|
|
test('bare', async ({ runInlineTest }) => {
|
|
const result = await runInlineTest({
|
|
'a.spec.ts': `
|
|
const { test } = pwt;
|
|
test('explodes', () => {
|
|
expect('');
|
|
});
|
|
`
|
|
});
|
|
|
|
expect(result.exitCode).toBe(0);
|
|
expect(result.passed).toBe(1);
|
|
});
|
|
});
|