microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-15 06:02:57 +03:00
Code Issues Projects Releases Wiki Activity
6d491f928d
playwright/docs/src
History
Andrey Lushnikov 6d491f928d
feat(playwright-test): introduce snapshotPathTemplate configuration (#18568) 
This configuration option allows to set a string with template
values for precise control over snapshot path location.

An example of `snapshotPathTemplate` usage:

```ts
// playwright.config.ts
// Notice the `testDir` configuration!
export default {
  testDir: './tests',
  snapshotPathTemplate: './__screenshots__/{platform}/{projectName}/{testFilePath}/{arg}{ext}',
}
```

Currently supported "magic tokens" inside the `snapshotPathTemplate`
are:

- `{testDir}` - project's `testDir`
- `{snapshotDir}` - project's `snapshotDir`
- `{platform}` - `process.platform`
- `{projectName}` - Project's sanitized name
- `{testFileDir}` - Directories in relative path from `testDir` to test
  file path (e.g. `page/` in the example below)
- `{testFileName}` - Test file name (with extension) (e.g.
  `page-click.spec.ts` in the example below)
- `{testFilePath}` - Relative path from `testDir` to test file path
  (e.g. `page/page-click.spec.ts` in the example below)
- `{ext}` - snapshot extension (with dots)
- `{arg}` - joined snapshot name parts, without extension (e.g.
`foo/bar/baz` in the example below)
- `{snapshotSuffix}` - `testInfo.snapshotSuffix` value.

Consider the following file structure:

```
playwright.config.ts
tests/
└── page/
    └── page-click.spec.ts
```

The following `page-click.spec.ts`:

```ts
// page-click.spec.ts
import { test, expect } from '@playwright/test';

test('should work', async ({ page }) => {
  await expect(page).toHaveScreenshot(['foo', 'bar', 'baz.png']);
});
```

Fixes #7792
2022-11-09 15:29:07 -08:00
..
api feat(playwright-test): introduce snapshotPathTemplate configuration (#18568) 2022-11-09 15:29:07 -08:00
test-api feat(playwright-test): introduce snapshotPathTemplate configuration (#18568) 2022-11-09 15:29:07 -08:00
test-reporter-api chore: make Reporter.onExit an internal method (#16280) 2022-08-05 13:41:00 -07:00
accessibility-testing-java.md docs(accessibility-testing): create accessibility testing guide for Java (#16217) 2022-08-03 12:18:41 -07:00
accessibility-testing-js.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
actionability.md docs: migrate page actions to locator actions 1/n (#15586) 2022-07-12 22:39:31 +02:00
api-testing-csharp.md Revert "chore(generator): use new .NET test attributes (#17172)" (#17344) 2022-09-14 22:44:38 +02:00
api-testing-java.md docs: migrate page actions to locator actions 1/n (#15586) 2022-07-12 22:39:31 +02:00
api-testing-python.md docs: new Python onboarding story (#15782) 2022-07-21 00:57:09 +02:00
auth.md docs: delete old auth + pom guides (#18615) 2022-11-07 15:31:42 -08:00
browser-contexts.md docs: explanations for test isolation (#17582) 2022-10-25 08:01:47 +02:00
browsers.md feat(install): connection timeout (#18161) 2022-10-19 13:06:35 -07:00
canary-releases-js.md chore: add canary releases doc (#16375) 2022-08-09 15:31:29 +02:00
chrome-extensions-js-python.md docs(chrome-extensions): update test fixture grammar (#17770) 2022-10-04 12:18:01 +02:00
ci-intro-js.md docs(ci): update ci example to avoid warnings (#18405) 2022-10-31 12:19:10 -07:00
ci.md chore: cut v1.27.0 (#17859) 2022-10-05 15:30:35 -07:00
cli.md docs: csharp apostrophes (#17202) 2022-09-08 12:49:22 -07:00
codegen-intro.md docs: Codegen new screenshots (#18347) 2022-10-26 20:49:02 +02:00
codegen.md docs: Codegen new screenshots (#18347) 2022-10-26 20:49:02 +02:00
debug-selectors.md docs: have npm test -> npx playwright test (#17250) 2022-09-12 17:24:23 +02:00
debug.md docs: mention VSCode extension in debugging doc (#18261) 2022-10-21 16:29:59 -07:00
dialogs.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
docker.md docs(docker): remove array around seccomp profile (#18457) 2022-10-31 12:17:10 -07:00
downloads.md docs: remove api ref and improve text (#17099) 2022-09-07 12:41:12 +02:00
emulation.md docs(nodejs): extend geolocation context examples (#17587) 2022-10-31 09:39:44 -07:00
evaluating.md docs(python): fix missing await in JS evaluation example (#14426) 2022-05-27 12:21:13 +02:00
events.md docs: fix broken docslint (#17223) 2022-09-09 20:08:22 +02:00
extensibility.md docs: explain that the Selectors.register script is executed in the page context (#16917) 2022-08-30 09:17:17 -07:00
frames.md feat(api): shorted getByLabel, getByPlaceholder (#17816) 2022-10-04 10:29:26 -07:00
getting-started-vscode-js.md docs: add more content to getting started vscode (#18338) 2022-10-26 20:18:16 +02:00
handles.md docs: update locators doc to use new APIs (#18352) 2022-10-26 15:30:22 -07:00
input.md feat(api): shorted getByLabel, getByPlaceholder (#17816) 2022-10-04 10:29:26 -07:00
intro-csharp.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
intro-java.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
intro-js.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
intro-python.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
languages.md docs: update languages section (#18130) 2022-10-17 14:06:32 -07:00
library-csharp.md docs(dotnet): library-csharp.md - use new() syntax everywhere (#16666) 2022-08-19 09:51:38 +02:00
library-js.md docs: fix library-js (#18314) 2022-10-25 08:50:28 -07:00
library-python.md docs: new troubleshooting doc (#15876) 2022-07-22 13:26:35 +02:00
locators.md docs: support custom hrefs for api links (#18514) 2022-11-02 13:35:51 -07:00
mock-js.md docs: remove toc (#17626) 2022-09-27 08:45:32 -07:00
navigations.md docs(python): remove not-needed semicolons from code snippets (#18589) 2022-11-07 08:28:07 -08:00
network.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
pages.md docs: migrate page actions to locator actions 2/n (#15603) 2022-07-13 11:50:18 +02:00
pom.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
protractor-js.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
puppeteer-js.md docs(puppeteer): fix broken waitForLoadState code snippet (#18212) 2022-10-20 10:50:41 -07:00
release-notes-csharp.md fix(generator): .NET getByRole w/ name (#18060) 2022-10-13 08:23:43 -07:00
release-notes-java.md docs(release-notes): add missing reference to Page.getByTestId in 1.27 release notes (#17942) 2022-10-10 22:18:15 +03:00
release-notes-js.md docs: add release video (#18459) 2022-10-31 22:38:43 +01:00
release-notes-python.md docs(release-notes): add missing reference to Page.getByTestId in 1.27 release notes (#17942) 2022-10-10 22:18:15 +03:00
running-tests-csharp.md chore(docs): revert recent changes temporarily (#16590) 2022-08-16 22:00:54 -07:00
running-tests-java.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
running-tests-js.md docs: Codegen new screenshots (#18347) 2022-10-26 20:49:02 +02:00
running-tests-python.md chore(docs): revert recent changes temporarily (#16590) 2022-08-16 22:00:54 -07:00
screenshots.md chore(docs): revert recent changes temporarily (#16590) 2022-08-16 22:00:54 -07:00
selectors.md docs: add examples and clarifications to getByText (#18380) 2022-10-27 10:27:18 -07:00
selenium-grid.md feat(selenium): update docs and include SE_NODE_GRID_URL requirement (#16230) 2022-08-04 13:39:12 -07:00
service-workers-experimental-network-events-js.md docs: fix typos in docs (#16370) 2022-08-09 15:47:17 +02:00
showcase.md docs: update showcase playwright-go git url (#14780) 2022-06-10 10:09:11 +02:00
test-advanced-js.md feat(api): shorted getByLabel, getByPlaceholder (#17816) 2022-10-04 10:29:26 -07:00
test-annotations-js.md docs: fix typos (#17919) 2022-10-20 13:46:37 -07:00
test-api-testing-js.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
test-assertions-js.md chore: render typed locators in the recorder (#18162) 2022-10-18 16:39:58 -07:00
test-cli-js.md docs(test-cli): remove --ignore-snapshots alias (#18295) 2022-10-24 10:49:58 -07:00
test-components-js.md core(ct): import paths (#18131) 2022-10-19 19:41:21 -07:00
test-configuration-js.md feat(test runner): workers as percentage (#17400) 2022-09-21 11:17:36 -07:00
test-fixtures-js.md docs: delete old auth + pom guides (#18615) 2022-11-07 15:31:42 -08:00
test-parallel-js.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
test-parameterize-js.md feat(api): shorted getByLabel, getByPlaceholder (#17816) 2022-10-04 10:29:26 -07:00
test-reporters-js.md chore: render steps in list reporter (#18269) 2022-10-24 15:54:53 -07:00
test-retries-js.md feat(test runner): test.describe.configure({ retries, timeout }) (#18388) 2022-10-27 15:53:27 -07:00
test-runners-csharp.md Revert "chore(generator): use new .NET test attributes (#17172)" (#17344) 2022-09-14 22:44:38 +02:00
test-runners-java.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
test-runners-js.md docs: syntax highlighting in vitest example (#15585) 2022-07-12 21:37:04 +02:00
test-runners-python.md docs(pytest): by default it runs on chromium (#17967) 2022-10-10 22:42:50 +03:00
test-snapshots-js.md chore: cut v1.27.0 (#17859) 2022-10-05 15:30:35 -07:00
test-timeouts-js.md chore: render typed locators in the recorder (#18162) 2022-10-18 16:39:58 -07:00
test-typescript-js.md fix(tsconfig): remove TS_NODE envs, update docs (#17847) 2022-10-05 12:51:12 -07:00
testing-library-js.md feat(api): shorted getByLabel, getByPlaceholder (#17816) 2022-10-04 10:29:26 -07:00
threading-java.md docs(java): message loop, Thread.sleep vs waitForTimeot (#9978) 2021-11-02 10:17:35 -07:00
trace-viewer-intro-csharp-java-python.md docs(trace-viewer): fix broken examples (#18654) 2022-11-08 14:22:14 -08:00
trace-viewer-intro-js.md docs: improve screenshots getting started (#17222) 2022-09-09 20:32:40 +02:00
trace-viewer.md docs: improve trace viewer + add video (#17907) 2022-10-07 09:51:16 -07:00
troubleshooting.md docs: add note to docs about WebInspector (#18483) 2022-11-01 14:01:02 -07:00
videos.md docs: add non library solution for video page (#17094) 2022-09-07 20:38:23 +02:00
webview2.md docs: use getBy... in documentation (#17795) 2022-10-03 17:02:46 -07:00
why-playwright.md chore(docs): revert recent changes temporarily (#16590) 2022-08-16 22:00:54 -07:00
writing-tests-csharp.md docs: remove selectors from getting started (#18403) 2022-10-28 08:54:21 -07:00
writing-tests-java.md docs: add new java intro (#17695) 2022-10-21 09:52:36 -07:00
writing-tests-js.md docs: remove selectors from getting started (#18403) 2022-10-28 08:54:21 -07:00
writing-tests-python.md docs(python): remove not-needed semicolons from code snippets (#18589) 2022-11-07 08:28:07 -08:00