2021-04-29 21:11:32 +03:00
|
|
|
/**
|
|
|
|
* Copyright (c) Microsoft Corporation.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2022-04-07 00:57:14 +03:00
|
|
|
import type { TestType, Fixtures } from '@playwright/test';
|
|
|
|
import { test } from '@playwright/test';
|
|
|
|
import type { CommonFixtures } from './commonFixtures';
|
|
|
|
import { commonFixtures } from './commonFixtures';
|
|
|
|
import type { ServerFixtures, ServerWorkerOptions } from './serverFixtures';
|
|
|
|
import { serverFixtures } from './serverFixtures';
|
feat(test runner): replace declare/define with "options" (#10293)
1. Fixtures defined in test.extend() can now have `{ option: true }` configuration that makes them overridable in the config. Options support all other properties of fixtures - value/function, scope, auto.
```
const test = base.extend<MyOptions>({
foo: ['default', { option: true }],
});
```
2. test.declare() and project.define are removed.
3. project.use applies overrides to default option values and nothing else. Any test.extend() and test.use() calls take priority over config options.
Required user changes: if someone used to define fixture options with test.extend(), overriding them in config will stop working. The solution is to add `{ option: true }`.
```
// Old code
export const test = base.extend<{ myOption: number, myFixture: number }>({
myOption: 123,
myFixture: ({ myOption }, use) => use(2 * myOption),
});
// New code
export const test = base.extend<{ myOption: number, myFixture: number }>({
myOption: [123, { option: true }],
myFixture: ({ myOption }, use) => use(2 * myOption),
});
```
2021-11-19 02:45:52 +03:00
|
|
|
import { coverageTest } from './coverageFixtures';
|
|
|
|
import { platformTest } from './platformFixtures';
|
|
|
|
import { testModeTest } from './testModeFixtures';
|
2021-10-28 18:31:30 +03:00
|
|
|
|
2022-01-06 02:54:00 +03:00
|
|
|
interface TestTypeEx<TestArgs, WorkerArgs> extends TestType<TestArgs, WorkerArgs> {
|
|
|
|
extend<T, W = {}>(fixtures: Fixtures<T, W, TestArgs, WorkerArgs>): TestTypeEx<TestArgs & T, WorkerArgs & W>;
|
|
|
|
_extendTest<T, W>(other: TestType<T, W>): TestTypeEx<TestArgs & T, WorkerArgs & W>;
|
|
|
|
}
|
|
|
|
type BaseT = (typeof test) extends TestType<infer T, infer W> ? T : never; // eslint-disable-line
|
|
|
|
type BaseW = (typeof test) extends TestType<infer T, infer W> ? W : never; // eslint-disable-line
|
|
|
|
export const base = test as TestTypeEx<BaseT, BaseW>;
|
|
|
|
|
|
|
|
export const baseTest = base
|
|
|
|
._extendTest(coverageTest)
|
|
|
|
._extendTest(platformTest)
|
|
|
|
._extendTest(testModeTest)
|
2021-10-27 18:28:53 +03:00
|
|
|
.extend<CommonFixtures>(commonFixtures)
|
2022-01-06 20:29:05 +03:00
|
|
|
.extend<ServerFixtures, ServerWorkerOptions>(serverFixtures)
|
feat(test runner): replace declare/define with "options" (#10293)
1. Fixtures defined in test.extend() can now have `{ option: true }` configuration that makes them overridable in the config. Options support all other properties of fixtures - value/function, scope, auto.
```
const test = base.extend<MyOptions>({
foo: ['default', { option: true }],
});
```
2. test.declare() and project.define are removed.
3. project.use applies overrides to default option values and nothing else. Any test.extend() and test.use() calls take priority over config options.
Required user changes: if someone used to define fixture options with test.extend(), overriding them in config will stop working. The solution is to add `{ option: true }`.
```
// Old code
export const test = base.extend<{ myOption: number, myFixture: number }>({
myOption: 123,
myFixture: ({ myOption }, use) => use(2 * myOption),
});
// New code
export const test = base.extend<{ myOption: number, myFixture: number }>({
myOption: [123, { option: true }],
myFixture: ({ myOption }, use) => use(2 * myOption),
});
```
2021-11-19 02:45:52 +03:00
|
|
|
.extend<{}, { _snapshotSuffix: string }>({
|
2021-10-28 18:31:30 +03:00
|
|
|
_snapshotSuffix: ['', { scope: 'worker' }],
|
|
|
|
});
|