Skip to content

Commit 36e7001

Browse files
shadowusrshadowusr
authored
fix: fix trailing slash issues and add assertView options (#15)
* fix: fix trailing slash issues and add assertView options
1 parent e086ab3 commit 36e7001

File tree

119 files changed

+539
-354
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+539
-354
lines changed

‎docs/commands/browser/$$.mdx

+8-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
slug: _dollardollar
3+
sidebar_label: $$
4+
---
5+
16
import Admonition from "@theme/Admonition";
27

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

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

82-
- [browser.$](./$)
83-
- [element.$](../element/$)
84-
- [element.$$](../element/$$)
87+
- [browser.$](../_dollar)
88+
- [element.$](../../element/_dollar)
89+
- [element.$$](../../element/_dollardollar)
8590

8691
[find-elements]: https://webdriver.io/docs/api/webdriver/#findelements
8792
[how-to-use-selectors]: https://webdriver.io/docs/selectors

‎docs/commands/browser/$.mdx

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
slug: _dollar
23
sidebar_position: 1
34
---
45

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

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

109-
- [browser.$$](./$$)
110-
- [element.$](../element/$)
111-
- [element.$$](../element/$$)
110+
- [browser.$$](../_dollardollar)
111+
- [element.$](../../element/_dollar)
112+
- [element.$$](../../element/_dollardollar)
112113

113114
[find-element]: https://webdriver.io/docs/api/webdriver/#findelement
114115
[how-to-use-selectors]: https://webdriver.io/docs/selectors

‎docs/commands/browser/action.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ it("should scroll using wheel action commands", async ({ browser }) => {
146146

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

149-
- [actions](./actions)
149+
- [actions](../actions)
150150

151-
[scrollIntoView]: ../element/scrollIntoView
152-
[doubleClick]: ../element/doubleClick
151+
[scrollIntoView]: ../../element/scrollIntoView
152+
[doubleClick]: ../../element/doubleClick
153153
[web-platform-tests]: https://wpt.fyi/results/webdriver/tests/perform_actions?label=experimental&label=master&aligned
154154
[appium]: http://appium.io
155155
[appium-ios]: https://appium.github.io/appium-xcuitest-driver/latest/reference/execute-methods/#mobile-pinch

‎docs/commands/browser/actions.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ it("run multiple actions at once for a pinch zoom", async ({ browser }) => {
2323

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

26-
- [action](./action)
26+
- [action](../action)
2727

28-
[action]: ./action
28+
[action]: ../action

‎docs/commands/browser/addCommand.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ it("should use my add command", async ({ browser }) => {
6060

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

63-
- [overwriteCommand](./overwriteCommand)
63+
- [overwriteCommand](../overwriteCommand)
6464

6565
[how-to-add-custom-commands]: https://webdriver.io/docs/customcommands/#adding-custom-commands

‎docs/commands/browser/assertView.mdx

+107-21
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Admonition from "@theme/Admonition";
77
Используйте команду `assertView`, чтобы снять скриншот для определенного состояния теста и сравнить его с эталонным.
88

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

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

4545
<table>
46-
<thead>
47-
<tr><td>**Опция**</td><td>**Тип**</td><td>**Описание**</td></tr>
48-
</thead>
49-
<tbody>
50-
<tr><td>ignoreElements</td><td>Array или String</td><td>Элементы (задаются как селекторы), которые будут проигнорированы при сравнении скриншотов. Игнор реализуется с помощью закраски перечисленных элементов черным цветом. В случае одного элемента параметр можно задавать как строку.</td></tr>
51-
<tr><td>tolerance</td><td>Number</td><td>Чувствительность к разнице в цветам. Значение перетирает [browsers.tolerance][browsers-tolerance].</td></tr>
52-
<tr><td>antialiasingTolerance</td><td>Number</td><td>Чувствительность в антиалиасинге. Значение перетирает [browsers.antialiasingTolerance][browsers-antialiasing-tolerance].</td></tr>
53-
<tr><td>allowViewportOverflow</td><td>Boolean</td><td>По умолчанию testplane выдает ошибку, если элемент находится за пределами границ вьюпорта. Этот параметр отключает проверку на границы, позволяя снимать скриншоты элементов, не влезающих во вьюпорт. При этом на скриншоте будут видны только те части элемента, которые влезли во вьюпорт. Однако если _compositeImage_ равен _true_, то части элемента, которые оказались за _нижней_ границей вьюпорта, тоже будут видны на скриншоте. Аналогично если _captureElementFromTop_ равен _true_, то на скриншот попадут и те части элемента, которые оказались за пределами _верхней_ границы вьюпорта.</td></tr>
54-
<tr><td>captureElementFromTop</td><td>Boolean</td><td>Снимать скриншот элемента с самого верха. Если элемент находится за пределами вьюпорта, то к нему будет выполнен подскролл.</td></tr>
55-
<tr><td>compositeImage</td><td>Boolean</td><td>Позволяет тестировать элементы, не влезающие во вьюпорт по высоте.</td></tr>
56-
<tr><td>screenshotDelay</td><td>Number</td><td>Задержка в миллисекундах перед снятием скриншота. Может пригодиться, когда на странице есть элементы, использующие анимацию, или скроллбар, который исчезает не сразу и попадает на результирующий скриншот.</td></tr>
57-
<tr><td>selectorToScroll</td><td>String</td><td>Селектор, который нужно скроллировать. Может пригодиться, когда надо сделать скриншот модального окна, которое не помещается на экране. Иначе без указания селектора скролл будет применяться к объекту _window_, и скроллироваться будет задний фон, оставляя попап-окно на месте.</td></tr>
58-
59-
</tbody>
46+
<thead>
47+
<tr>
48+
<td>**Опция**</td>
49+
<td>**Тип**</td>
50+
<td>**Описание**</td>
51+
</tr>
52+
</thead>
53+
<tbody>
54+
<tr>
55+
<td>ignoreElements</td>
56+
<td>Array или String</td>
57+
<td>
58+
Элементы (задаются как селекторы), которые будут проигнорированы при сравнении
59+
скриншотов. Игнор реализуется с помощью закраски перечисленных элементов черным
60+
цветом. В случае одного элемента параметр можно задавать как строку.
61+
</td>
62+
</tr>
63+
<tr>
64+
<td>tolerance</td>
65+
<td>Number</td>
66+
<td>
67+
Чувствительность к разнице в цветам. Значение перетирает
68+
[browsers.tolerance][browsers-tolerance].
69+
</td>
70+
</tr>
71+
<tr>
72+
<td>antialiasingTolerance</td>
73+
<td>Number</td>
74+
<td>
75+
Чувствительность в антиалиасинге. Значение перетирает
76+
[browsers.antialiasingTolerance][browsers-antialiasing-tolerance].
77+
</td>
78+
</tr>
79+
<tr>
80+
<td>allowViewportOverflow</td>
81+
<td>Boolean</td>
82+
<td>
83+
По умолчанию Testplane выдает ошибку, если элемент находится за пределами границ
84+
вьюпорта. Этот параметр отключает проверку на границы, позволяя снимать скриншоты
85+
элементов, не влезающих во вьюпорт. При этом на скриншоте будут видны только те
86+
части элемента, которые влезли во вьюпорт. Однако если _compositeImage_ равен
87+
_true_, то части элемента, которые оказались за _нижней_ границей вьюпорта, тоже
88+
будут видны на скриншоте. Аналогично если _captureElementFromTop_ равен _true_, то
89+
на скриншот попадут и те части элемента, которые оказались за пределами _верхней_
90+
границы вьюпорта.
91+
</td>
92+
</tr>
93+
<tr>
94+
<td>captureElementFromTop</td>
95+
<td>Boolean</td>
96+
<td>
97+
Снимать скриншот элемента с самого верха. Если элемент находится за пределами
98+
вьюпорта, то к нему будет выполнен подскролл.
99+
</td>
100+
</tr>
101+
<tr>
102+
<td>compositeImage</td>
103+
<td>Boolean</td>
104+
<td>
105+
Если элемент не влазит во вьюпорт, то при включении этой опции поочередно будет
106+
сделано несколько скриншотов разных частей элемента, после чего скриншоты будут
107+
склеены в один, чтобы отобразить элемент полностью.
108+
</td>
109+
</tr>
110+
<tr>
111+
<td>screenshotDelay</td>
112+
<td>Number</td>
113+
<td>
114+
Задержка в миллисекундах перед снятием скриншота. Может пригодиться, когда на
115+
странице есть элементы, использующие анимацию, или скроллбар, который исчезает не
116+
сразу и попадает на результирующий скриншот.
117+
</td>
118+
</tr>
119+
<tr>
120+
<td>selectorToScroll</td>
121+
<td>String</td>
122+
<td>
123+
Селектор, который нужно скроллировать. Может пригодиться, когда надо сделать
124+
скриншот модального окна, которое не помещается на экране. Иначе без указания
125+
селектора скролл будет применяться к объекту _window_, и скроллироваться будет
126+
задний фон, оставляя попап-окно на месте.
127+
</td>
128+
</tr>
129+
<tr>
130+
<td>disableAnimation</td>
131+
<td>Boolean</td>
132+
<td>
133+
Отключение анимаций и переходов при снятии скриншота. По умолчанию `true` начиная с
134+
версии `8.0.0`.
135+
</td>
136+
</tr>
137+
<tr>
138+
<td>ignoreDiffPixelCount</td>
139+
<td>`` `${number}%` `` или Number</td>
140+
<td>
141+
Процент пикселей, которые нужно игнорировать при диффе. Удобно для игнорирования
142+
очень маленьких диффов. По умолчанию `0`. Доступен начиная с версии `8.2.0`.
143+
</td>
144+
</tr>
145+
</tbody>
60146
</table>
61147

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

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

96-
- [element.assertView](../element/assertView)
97-
- [browser.saveRecordingScreen](./saveRecordingScreen)
98-
- [browser.saveScreenshot](./saveScreenshot)
99-
- [element.saveScreenshot](../element/saveScreenshot)
182+
- [element.assertView](../../element/assertView)
183+
- [browser.saveRecordingScreen](../saveRecordingScreen)
184+
- [browser.saveScreenshot](../saveScreenshot)
185+
- [element.saveScreenshot](../../element/saveScreenshot)
100186

101187
[webdriverio-api]: https://webdriver.io/docs/api
102-
[browsers-tolerance]: ../../config/browsers#tolerance
103-
[browsers-antialiasing-tolerance]: ../../config/browsers#antialiasing_tolerance
188+
[browsers-tolerance]: ../../../config/browsers#tolerance
189+
[browsers-antialiasing-tolerance]: ../../../config/browsers#antialiasing_tolerance

‎docs/commands/browser/deleteCookies.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ it("should delete cookies", async ({ browser }) => {
6161

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

64-
- [getCookies](./getCookies)
65-
- [setCookies](./setCookies)
64+
- [getCookies](../getCookies)
65+
- [setCookies](../setCookies)

‎docs/commands/browser/execute.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,5 +51,5 @@ it("should inject javascript on the page", async ({ browser }) => {
5151

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

54-
- [executeAsync](./executeAsync)
55-
- [setTimeout](./setTimeout)
54+
- [executeAsync](../executeAsync)
55+
- [setTimeout](../setTimeout)

‎docs/commands/browser/executeAsync.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ it("should execute async JavaScript on the page", async ({ browser }) => {
5555

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

58-
- [execute](./execute)
59-
- [setTimeout](./setTimeout)
58+
- [execute](../execute)
59+
- [setTimeout](../setTimeout)

‎docs/commands/browser/getConfig.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ it("some test", async ({ browser }) => {
2424
});
2525
```
2626

27-
[browser-config]: ../../config/browsers#browser_main_settings
27+
[browser-config]: ../../../config/browsers#browser_main_settings

‎docs/commands/browser/getCookies.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ it("should return a cookie for me", async ({ browser }) => {
5252

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

55-
- [setCookies](./setCookies)
56-
- [deleteCookies](./deleteCookies)
55+
- [setCookies](../setCookies)
56+
- [deleteCookies](../deleteCookies)

‎docs/commands/browser/getMeta.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Admonition from "@theme/Admonition";
99
Если указать ключ, то команда возвращает значение для конкретного ключа.
1010
Если ключ не указан, команда вернет объект со всей мета-информацией теста.
1111

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

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

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

62-
- [setMeta](./setMeta)
62+
- [setMeta](../setMeta)
6363

6464
[webdriverio-api]: https://webdriver.io/docs/api

‎docs/commands/browser/getPuppeteer.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ it('should allow me to use Puppeteer', async ({ browser }) => {
4242
});
4343
```
4444

45-
[how-to-use-cdp]: ../../guides/how-to-use-cdp
45+
[how-to-use-cdp]: ../../../guides/how-to-use-cdp
4646
[puppeteer]: https://pptr.dev/#?product=Puppeteer&version=v5.1.0&show=api-class-browser
47-
[browser-call]: ./call
47+
[browser-call]: ../call

‎docs/commands/browser/getWindowSize.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ it("should return browser window size", async ({ browser }) => {
2222

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

25-
- [setWindowSize](./setWindowSize)
25+
- [setWindowSize](../setWindowSize)

‎docs/commands/browser/mock.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ it("should redirect web resources", async ({ browser }) => {
128128

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

131-
- [mockClearAll](./mockClearAll)
132-
- [mockRestoreAll](./mockRestoreAll)
131+
- [mockClearAll](../mockClearAll)
132+
- [mockRestoreAll](../mockRestoreAll)
133133

134-
[how-to-use-cdp]: ../../guides/how-to-use-cdp
135-
[how-to-intercept-requests-and-responses]: ../../guides/how-to-intercept-requests-and-responses
134+
[how-to-use-cdp]: ../../../guides/how-to-use-cdp
135+
[how-to-intercept-requests-and-responses]: ../../../guides/how-to-intercept-requests-and-responses

‎docs/commands/browser/mockClearAll.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ it("should clear all mocks", async ({ browser }) => {
3535
## Связанные команды {#related}
3636

3737
- [mock][mock]
38-
- [mockRestoreAll](./mockRestoreAll)
38+
- [mockRestoreAll](../mockRestoreAll)
3939

40-
[mock]: ./mock
40+
[mock]: ../mock

‎docs/commands/browser/mockRestoreAll.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ it("should restore all mocks", async ({ browser }) => {
3232
## Связанные команды {#related}
3333

3434
- [mock][mock]
35-
- [mockClearAll](./mockClearAll)
35+
- [mockClearAll](../mockClearAll)
3636

37-
[mock]: ./mock
37+
[mock]: ../mock

‎docs/commands/browser/overwriteCommand.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ it("should use my overwrite command", async ({ browser }) => {
5252

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

55-
- [addCommand](./addCommand)
55+
- [addCommand](../addCommand)
5656

5757
[how-to-add-custom-commands]: https://webdriver.io/docs/customcommands/#adding-custom-commands

‎docs/commands/browser/pause.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ it("should pause the execution", async ({ browser }) => {
4242
});
4343
```
4444

45-
[wait-for-exist]: ../element/waitForExist
45+
[wait-for-exist]: ../../element/waitForExist

‎docs/commands/browser/reactDollar.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ it("should calculate 7 * 6", async ({ browser }) => {
6969

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

72-
- [browser.react$$](./reactDollarDollar)
73-
- [element.react$](../element/reactDollar)
74-
- [element.react$$](../element/reactDollarDollar)
72+
- [browser.react$$](../reactDollarDollar)
73+
- [element.react$](../../element/reactDollar)
74+
- [element.react$$](../../element/reactDollarDollar)
7575

7676
[how-to-use-selectors]: https://webdriver.io/docs/selectors

‎docs/commands/browser/reactDollarDollar.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ it("should calculate 7 * 6", async ({ browser }) => {
5050

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

53-
- [browser.react$](./reactDollar)
54-
- [element.react$](../element/reactDollar)
55-
- [element.react$$](../element/reactDollarDollar)
53+
- [browser.react$](../reactDollar)
54+
- [element.react$](../../element/reactDollar)
55+
- [element.react$$](../../element/reactDollarDollar)
5656

5757
[how-to-use-selectors]: https://webdriver.io/docs/selectors

‎docs/commands/browser/savePDF.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,5 +55,5 @@ it("should save a PDF screenshot of the browser view", async ({ browser }) => {
5555

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

58-
- [saveRecordingScreen](./saveRecordingScreen)
59-
- [saveScreenshot](./saveScreenshot)
58+
- [saveRecordingScreen](../saveRecordingScreen)
59+
- [saveScreenshot](../saveScreenshot)

‎docs/commands/browser/saveRecordingScreen.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ it("should save a video", async ({ browser }) => {
4141

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

44-
- [savePDF](./savePDF)
45-
- [saveScreenshot](./saveScreenshot)
44+
- [savePDF](../savePDF)
45+
- [saveScreenshot](../saveScreenshot)
4646

4747
[start-recording-screen]: https://webdriver.io/docs/api/appium/#startrecordingscreen
4848
[appium]: http://appium.io/docs/en/commands/device/recording-screen/start-recording-screen/

‎docs/commands/browser/saveScreenshot.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ it("should save a screenshot of the browser view", async ({ browser }) => {
3434

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

37-
- [browser.savePDF](./savePDF)
38-
- [browser.saveRecordingScreen](./saveRecordingScreen)
39-
- [element.saveScreenshot](../element/saveScreenshot)
37+
- [browser.savePDF](../savePDF)
38+
- [browser.saveRecordingScreen](../saveRecordingScreen)
39+
- [element.saveScreenshot](../../element/saveScreenshot)
4040

4141
[gecko]: https://github.com/mozilla/geckodriver
4242
[chromedriver]: https://chromedriver.chromium.org/

‎docs/commands/browser/scroll.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ it("should demonstrate the scroll command", async ({ browser }) => {
3737

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

40-
- [element.scrollIntoView](../element/scrollIntoView)
40+
- [element.scrollIntoView](../../element/scrollIntoView)

0 commit comments

Comments
 (0)