Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix trailing slash issues and add assertView options #15

Merged
merged 2 commits into from
Jul 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/commands/browser/$$.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
slug: _dollardollar
sidebar_label: $$
---

import Admonition from "@theme/Admonition";

# $$
Expand Down Expand Up @@ -79,9 +84,9 @@ it("should get text a menu link - JS Function", async ({ browser }) => {

## Связанные команды {#related}

- [browser.$](./$)
- [element.$](../element/$)
- [element.$$](../element/$$)
- [browser.$](../_dollar)
- [element.$](../../element/_dollar)
shadowusr marked this conversation as resolved.
Show resolved Hide resolved
- [element.$$](../../element/_dollardollar)

[find-elements]: https://webdriver.io/docs/api/webdriver/#findelements
[how-to-use-selectors]: https://webdriver.io/docs/selectors
7 changes: 4 additions & 3 deletions docs/commands/browser/$.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
slug: _dollar
sidebar_position: 1
---

Expand Down Expand Up @@ -106,9 +107,9 @@ it("should use Androids DataMatcher or ViewMatcher selector", async ({ browser }

## Связанные команды {#related}

- [browser.$$](./$$)
- [element.$](../element/$)
- [element.$$](../element/$$)
- [browser.$$](../_dollardollar)
- [element.$](../../element/_dollar)
- [element.$$](../../element/_dollardollar)

[find-element]: https://webdriver.io/docs/api/webdriver/#findelement
[how-to-use-selectors]: https://webdriver.io/docs/selectors
6 changes: 3 additions & 3 deletions docs/commands/browser/action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,10 @@ it("should scroll using wheel action commands", async ({ browser }) => {

## Связанные команды {#related}

- [actions](./actions)
- [actions](../actions)

[scrollIntoView]: ../element/scrollIntoView
[doubleClick]: ../element/doubleClick
[scrollIntoView]: ../../element/scrollIntoView
[doubleClick]: ../../element/doubleClick
[web-platform-tests]: https://wpt.fyi/results/webdriver/tests/perform_actions?label=experimental&label=master&aligned
[appium]: http://appium.io
[appium-ios]: https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-pinch
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/browser/actions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ it("run multiple actions at once for a pinch zoom", async ({ browser }) => {

## Связанные команды {#related}

- [action](./action)
- [action](../action)

[action]: ./action
[action]: ../action
2 changes: 1 addition & 1 deletion docs/commands/browser/addCommand.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ it("should use my add command", async ({ browser }) => {

## Связанные команды {#related}

- [overwriteCommand](./overwriteCommand)
- [overwriteCommand](../overwriteCommand)

[how-to-add-custom-commands]: https://webdriver.io/docs/customcommands/#adding-custom-commands
128 changes: 107 additions & 21 deletions docs/commands/browser/assertView.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Admonition from "@theme/Admonition";
Используйте команду `assertView`, чтобы снять скриншот для определенного состояния теста и сравнить его с эталонным.

<Admonition type="info">
Эта команда реализована внутри testplane, в [API WebDriverIO][webdriverio-api] её нет.
Эта команда реализована внутри Testplane, в [API WebDriverIO][webdriverio-api] её нет.
</Admonition>

## Использование {#usage}
Expand Down Expand Up @@ -43,20 +43,106 @@ await browser.assertView(state, selector, options);
Задает настройки команды `assertView`:

<table>
<thead>
<tr><td>**Опция**</td><td>**Тип**</td><td>**Описание**</td></tr>
</thead>
<tbody>
<tr><td>ignoreElements</td><td>Array или String</td><td>Элементы (задаются как селекторы), которые будут проигнорированы при сравнении скриншотов. Игнор реализуется с помощью закраски перечисленных элементов черным цветом. В случае одного элемента параметр можно задавать как строку.</td></tr>
<tr><td>tolerance</td><td>Number</td><td>Чувствительность к разнице в цветам. Значение перетирает [browsers.tolerance][browsers-tolerance].</td></tr>
<tr><td>antialiasingTolerance</td><td>Number</td><td>Чувствительность в антиалиасинге. Значение перетирает [browsers.antialiasingTolerance][browsers-antialiasing-tolerance].</td></tr>
<tr><td>allowViewportOverflow</td><td>Boolean</td><td>По умолчанию testplane выдает ошибку, если элемент находится за пределами границ вьюпорта. Этот параметр отключает проверку на границы, позволяя снимать скриншоты элементов, не влезающих во вьюпорт. При этом на скриншоте будут видны только те части элемента, которые влезли во вьюпорт. Однако если _compositeImage_ равен _true_, то части элемента, которые оказались за _нижней_ границей вьюпорта, тоже будут видны на скриншоте. Аналогично если _captureElementFromTop_ равен _true_, то на скриншот попадут и те части элемента, которые оказались за пределами _верхней_ границы вьюпорта.</td></tr>
<tr><td>captureElementFromTop</td><td>Boolean</td><td>Снимать скриншот элемента с самого верха. Если элемент находится за пределами вьюпорта, то к нему будет выполнен подскролл.</td></tr>
<tr><td>compositeImage</td><td>Boolean</td><td>Позволяет тестировать элементы, не влезающие во вьюпорт по высоте.</td></tr>
<tr><td>screenshotDelay</td><td>Number</td><td>Задержка в миллисекундах перед снятием скриншота. Может пригодиться, когда на странице есть элементы, использующие анимацию, или скроллбар, который исчезает не сразу и попадает на результирующий скриншот.</td></tr>
<tr><td>selectorToScroll</td><td>String</td><td>Селектор, который нужно скроллировать. Может пригодиться, когда надо сделать скриншот модального окна, которое не помещается на экране. Иначе без указания селектора скролл будет применяться к объекту _window_, и скроллироваться будет задний фон, оставляя попап-окно на месте.</td></tr>

</tbody>
<thead>
<tr>
<td>**Опция**</td>
<td>**Тип**</td>
<td>**Описание**</td>
</tr>
</thead>
<tbody>
<tr>
<td>ignoreElements</td>
<td>Array или String</td>
<td>
Элементы (задаются как селекторы), которые будут проигнорированы при сравнении
скриншотов. Игнор реализуется с помощью закраски перечисленных элементов черным
цветом. В случае одного элемента параметр можно задавать как строку.
</td>
</tr>
<tr>
<td>tolerance</td>
<td>Number</td>
<td>
Чувствительность к разнице в цветам. Значение перетирает
[browsers.tolerance][browsers-tolerance].
</td>
</tr>
<tr>
<td>antialiasingTolerance</td>
<td>Number</td>
<td>
Чувствительность в антиалиасинге. Значение перетирает
[browsers.antialiasingTolerance][browsers-antialiasing-tolerance].
</td>
</tr>
<tr>
<td>allowViewportOverflow</td>
<td>Boolean</td>
<td>
По умолчанию Testplane выдает ошибку, если элемент находится за пределами границ
вьюпорта. Этот параметр отключает проверку на границы, позволяя снимать скриншоты
элементов, не влезающих во вьюпорт. При этом на скриншоте будут видны только те
части элемента, которые влезли во вьюпорт. Однако если _compositeImage_ равен
_true_, то части элемента, которые оказались за _нижней_ границей вьюпорта, тоже
будут видны на скриншоте. Аналогично если _captureElementFromTop_ равен _true_, то
на скриншот попадут и те части элемента, которые оказались за пределами _верхней_
границы вьюпорта.
</td>
</tr>
<tr>
<td>captureElementFromTop</td>
<td>Boolean</td>
<td>
Снимать скриншот элемента с самого верха. Если элемент находится за пределами
вьюпорта, то к нему будет выполнен подскролл.
</td>
</tr>
<tr>
<td>compositeImage</td>
<td>Boolean</td>
<td>
Если элемент не влазит во вьюпорт, то при включении этой опции поочередно будет
сделано несколько скриншотов разных частей элемента, после чего скриншоты будут
склеены в один, чтобы отобразить элемент полностью.
</td>
</tr>
<tr>
<td>screenshotDelay</td>
<td>Number</td>
<td>
Задержка в миллисекундах перед снятием скриншота. Может пригодиться, когда на
странице есть элементы, использующие анимацию, или скроллбар, который исчезает не
сразу и попадает на результирующий скриншот.
</td>
</tr>
<tr>
<td>selectorToScroll</td>
<td>String</td>
<td>
Селектор, который нужно скроллировать. Может пригодиться, когда надо сделать
скриншот модального окна, которое не помещается на экране. Иначе без указания
селектора скролл будет применяться к объекту _window_, и скроллироваться будет
задний фон, оставляя попап-окно на месте.
</td>
</tr>
<tr>
<td>disableAnimation</td>
<td>Boolean</td>
<td>
Отключение анимаций и переходов при снятии скриншота. По умолчанию `true` начиная с
версии `8.0.0`.
</td>
</tr>
<tr>
<td>ignoreDiffPixelCount</td>
<td>`` `${number}%` `` или Number</td>
<td>
Процент пикселей, которые нужно игнорировать при диффе. Удобно для игнорирования
очень маленьких диффов. По умолчанию `0`. Доступен начиная с версии `8.2.0`.
</td>
</tr>
</tbody>
</table>

## Примеры использования {#examples}
Expand Down Expand Up @@ -93,11 +179,11 @@ it("should assert view with given options", async ({ browser }) => {

## Связанные команды {#related}

- [element.assertView](../element/assertView)
- [browser.saveRecordingScreen](./saveRecordingScreen)
- [browser.saveScreenshot](./saveScreenshot)
- [element.saveScreenshot](../element/saveScreenshot)
- [element.assertView](../../element/assertView)
- [browser.saveRecordingScreen](../saveRecordingScreen)
- [browser.saveScreenshot](../saveScreenshot)
- [element.saveScreenshot](../../element/saveScreenshot)

[webdriverio-api]: https://webdriver.io/docs/api
[browsers-tolerance]: ../../config/browsers#tolerance
[browsers-antialiasing-tolerance]: ../../config/browsers#antialiasing_tolerance
[browsers-tolerance]: ../../../config/browsers#tolerance
[browsers-antialiasing-tolerance]: ../../../config/browsers#antialiasing_tolerance
4 changes: 2 additions & 2 deletions docs/commands/browser/deleteCookies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,5 @@ it("should delete cookies", async ({ browser }) => {

## Связанные команды {#related}

- [getCookies](./getCookies)
- [setCookies](./setCookies)
- [getCookies](../getCookies)
- [setCookies](../setCookies)
4 changes: 2 additions & 2 deletions docs/commands/browser/execute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ it("should inject javascript on the page", async ({ browser }) => {

## Связанные команды {#related}

- [executeAsync](./executeAsync)
- [setTimeout](./setTimeout)
- [executeAsync](../executeAsync)
- [setTimeout](../setTimeout)
4 changes: 2 additions & 2 deletions docs/commands/browser/executeAsync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ it("should execute async JavaScript on the page", async ({ browser }) => {

## Связанные команды {#related}

- [execute](./execute)
- [setTimeout](./setTimeout)
- [execute](../execute)
- [setTimeout](../setTimeout)
2 changes: 1 addition & 1 deletion docs/commands/browser/getConfig.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ it("some test", async ({ browser }) => {
});
```

[browser-config]: ../../config/browsers#browser_main_settings
[browser-config]: ../../../config/browsers#browser_main_settings
4 changes: 2 additions & 2 deletions docs/commands/browser/getCookies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ it("should return a cookie for me", async ({ browser }) => {

## Связанные команды {#related}

- [setCookies](./setCookies)
- [deleteCookies](./deleteCookies)
- [setCookies](../setCookies)
- [deleteCookies](../deleteCookies)
4 changes: 2 additions & 2 deletions docs/commands/browser/getMeta.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Admonition from "@theme/Admonition";
Если указать ключ, то команда возвращает значение для конкретного ключа.
Если ключ не указан, команда вернет объект со всей мета-информацией теста.

Для установки значений в мета-информации используйте команду [setMeta](./setMeta).
Для установки значений в мета-информации используйте команду [setMeta](../setMeta).

<Admonition type="info">
Эта команда реализована внутри testplane, в [API WebDriverIO][webdriverio-api] её нет.
Expand Down Expand Up @@ -59,6 +59,6 @@ it("should get meta info of test", async ({ browser }) => {

## Связанные команды {#related}

- [setMeta](./setMeta)
- [setMeta](../setMeta)

[webdriverio-api]: https://webdriver.io/docs/api
4 changes: 2 additions & 2 deletions docs/commands/browser/getPuppeteer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ it('should allow me to use Puppeteer', async ({ browser }) => {
});
```

[how-to-use-cdp]: ../../guides/how-to-use-cdp
[how-to-use-cdp]: ../../../guides/how-to-use-cdp
[puppeteer]: https://pptr.dev/#?product=Puppeteer&version=v5.1.0&show=api-class-browser
[browser-call]: ./call
[browser-call]: ../call
2 changes: 1 addition & 1 deletion docs/commands/browser/getWindowSize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ it("should return browser window size", async ({ browser }) => {

## Связанные команды {#related}

- [setWindowSize](./setWindowSize)
- [setWindowSize](../setWindowSize)
8 changes: 4 additions & 4 deletions docs/commands/browser/mock.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ it("should redirect web resources", async ({ browser }) => {

## Связанные команды {#related}

- [mockClearAll](./mockClearAll)
- [mockRestoreAll](./mockRestoreAll)
- [mockClearAll](../mockClearAll)
- [mockRestoreAll](../mockRestoreAll)

[how-to-use-cdp]: ../../guides/how-to-use-cdp
[how-to-intercept-requests-and-responses]: ../../guides/how-to-intercept-requests-and-responses
[how-to-use-cdp]: ../../../guides/how-to-use-cdp
[how-to-intercept-requests-and-responses]: ../../../guides/how-to-intercept-requests-and-responses
4 changes: 2 additions & 2 deletions docs/commands/browser/mockClearAll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ it("should clear all mocks", async ({ browser }) => {
## Связанные команды {#related}

- [mock][mock]
- [mockRestoreAll](./mockRestoreAll)
- [mockRestoreAll](../mockRestoreAll)

[mock]: ./mock
[mock]: ../mock
4 changes: 2 additions & 2 deletions docs/commands/browser/mockRestoreAll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ it("should restore all mocks", async ({ browser }) => {
## Связанные команды {#related}

- [mock][mock]
- [mockClearAll](./mockClearAll)
- [mockClearAll](../mockClearAll)

[mock]: ./mock
[mock]: ../mock
2 changes: 1 addition & 1 deletion docs/commands/browser/overwriteCommand.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ it("should use my overwrite command", async ({ browser }) => {

## Связанные команды {#related}

- [addCommand](./addCommand)
- [addCommand](../addCommand)

[how-to-add-custom-commands]: https://webdriver.io/docs/customcommands/#adding-custom-commands
2 changes: 1 addition & 1 deletion docs/commands/browser/pause.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ it("should pause the execution", async ({ browser }) => {
});
```

[wait-for-exist]: ../element/waitForExist
[wait-for-exist]: ../../element/waitForExist
6 changes: 3 additions & 3 deletions docs/commands/browser/reactDollar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ it("should calculate 7 * 6", async ({ browser }) => {

## Связанные команды {#related}

- [browser.react$$](./reactDollarDollar)
- [element.react$](../element/reactDollar)
- [element.react$$](../element/reactDollarDollar)
- [browser.react$$](../reactDollarDollar)
- [element.react$](../../element/reactDollar)
- [element.react$$](../../element/reactDollarDollar)

[how-to-use-selectors]: https://webdriver.io/docs/selectors
6 changes: 3 additions & 3 deletions docs/commands/browser/reactDollarDollar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ it("should calculate 7 * 6", async ({ browser }) => {

## Связанные команды {#related}

- [browser.react$](./reactDollar)
- [element.react$](../element/reactDollar)
- [element.react$$](../element/reactDollarDollar)
- [browser.react$](../reactDollar)
- [element.react$](../../element/reactDollar)
- [element.react$$](../../element/reactDollarDollar)

[how-to-use-selectors]: https://webdriver.io/docs/selectors
4 changes: 2 additions & 2 deletions docs/commands/browser/savePDF.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ it("should save a PDF screenshot of the browser view", async ({ browser }) => {

## Связанные команды {#related}

- [saveRecordingScreen](./saveRecordingScreen)
- [saveScreenshot](./saveScreenshot)
- [saveRecordingScreen](../saveRecordingScreen)
- [saveScreenshot](../saveScreenshot)
4 changes: 2 additions & 2 deletions docs/commands/browser/saveRecordingScreen.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ it("should save a video", async ({ browser }) => {

## Связанные команды {#related}

- [savePDF](./savePDF)
- [saveScreenshot](./saveScreenshot)
- [savePDF](../savePDF)
- [saveScreenshot](../saveScreenshot)

[start-recording-screen]: https://webdriver.io/docs/api/appium/#startrecordingscreen
[appium]: http://appium.io/docs/en/commands/device/recording-screen/start-recording-screen/
6 changes: 3 additions & 3 deletions docs/commands/browser/saveScreenshot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ it("should save a screenshot of the browser view", async ({ browser }) => {

## Связанные команды {#related}

- [browser.savePDF](./savePDF)
- [browser.saveRecordingScreen](./saveRecordingScreen)
- [element.saveScreenshot](../element/saveScreenshot)
- [browser.savePDF](../savePDF)
- [browser.saveRecordingScreen](../saveRecordingScreen)
- [element.saveScreenshot](../../element/saveScreenshot)

[gecko]: https://github.com/mozilla/geckodriver
[chromedriver]: https://chromedriver.chromium.org/
2 changes: 1 addition & 1 deletion docs/commands/browser/scroll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ it("should demonstrate the scroll command", async ({ browser }) => {

## Связанные команды {#related}

- [element.scrollIntoView](../element/scrollIntoView)
- [element.scrollIntoView](../../element/scrollIntoView)
Loading
Loading