Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paperstrike/playwright-fixtures
Wrap your tests with Playwright-like test fixtures in node & browsers
https://github.com/paperstrike/playwright-fixtures
folio playwright test-fixtures testing
Last synced: 15 days ago
JSON representation
Wrap your tests with Playwright-like test fixtures in node & browsers
- Host: GitHub
- URL: https://github.com/paperstrike/playwright-fixtures
- Owner: PaperStrike
- License: isc
- Created: 2021-08-28T17:29:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-09-24T19:43:41.000Z (about 3 years ago)
- Last Synced: 2024-11-27T22:05:44.450Z (25 days ago)
- Topics: folio, playwright, test-fixtures, testing
- Language: TypeScript
- Homepage:
- Size: 480 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# playwright-fixtures
[](https://www.npmjs.com/package/playwright-fixtures)
Wrap your tests with Playwright-like test fixtures in node & browsers.
```shell
npm install playwright-fixtures --save-dev
```
> Playwright Test is based on the concept of the test fixtures. Test fixtures are used to establish environment for each test, giving the test everything it needs and nothing else.
>
> For more information, check [Advanced: fixtures | Playwright][playwright-docs-test-fixtures].
🐿️ Jump to [Entry](#entry).
[playwright-docs-test-fixtures]: https://playwright.dev/docs/test-fixtures/
## API
### Type BaseTest
Supported base tests. Generally, tests that accepts a string (as its name) and a function that can return a promise.
```ts
export type BaseTest =
(name: string, inner: (...args: unknown[]) => Promise | void) => unknown;
```
### Type Test
The test you get from this wrapper. All properties in the base test are retained, and the call signature is replaced.
```ts
type KeyValue = Record;
type TestCall =
B extends (name: string, inner: (...args: infer BaseArgs) => infer InnerReturn) => infer Return
? (name: string, inner: (args: Args, ...baseArgs: BaseArgs) => InnerReturn) => Return
: never;
type Test = Pick & TestCall & {
extend(
fixtures: Fixtures,
): Test;
};
```
#### Method extend
Extend fixtures like you do in Playwright. Parameters given by the base test will move right one position for it.
Example on [tape](https://github.com/substack/tape):
```ts
type TestFixtures = {
input: HTMLInputElement;
};
const inputTest = test.extend({
input: async (baseFixtures, use) => {
const input = document.createElement('input');
document.body.append(input);
await use(input);
input.remove();
},
});
inputTest('focusable', ({ input }, t) => {
input.focus();
t.equal(document.activeElement, input);
t.end();
});
```
```tap
TAP version 13
# focusable
ok 1 should be strictly equal
# ...
```
The report format depends entirely on your base test.
### Entry
The wrap function. Accepts one single argument, the base test. Returns the wrapped test.
```ts
declare const wrap: (baseTest: B) => Test<{}, B>;
export default wrap;
```
Use it like:
```ts
import { test as base } from 'uvu'; // mocha, tape, zora, etc.
import fixtureWrap from 'playwright-fixtures';
const test = fixtureWrap(base);
test('your tests', () => {
// ...
});
```
## [LICENSE](LICENSE)