Skip to content

Commit 5f79e26

Browse files
committed
documentation: new capabilities management.
1 parent 5127a2b commit 5f79e26

File tree

1 file changed

+64
-1
lines changed

1 file changed

+64
-1
lines changed

source/src/main/resources/documentation/D1/include/en/testmanagement_runtestcase_en.adoc

+64-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,70 @@ However, if the user changes this value, it will be overriden by his selection.
5454

5555
'Save Robot Preferencies' button save these settings in the browser cache of the device.
5656

57-
The selected robot can be edited using the left button. A new robot can be created using the right one.
57+
The selected robot can be edited using the left button. A new robot can be created using the right one.
58+
59+
=== Robot Capabilities
60+
61+
When creating or updating a robot, you can specify capabilities in the 'Capabilities' tab of the robot modal window.
62+
Appium 2 and Selenium 4 use the W3C protocol to apply the capabilities to the robot. Therefore, it's essential to follow the correct syntax to ensure compliance with the W3C protocol.
63+
64+
==== Basic WebDriver Capabilities
65+
66+
The syntax remains mostly the same, with the exceptions of 'version' and 'platform', which have been replaced by 'browserVersion' and 'platformName' respectively.
67+
You can find the list of W3C WebDriver standard capabilities here:
68+
https://www.w3.org/TR/webdriver1/#capabilities.
69+
70+
==== Appium Capabilities
71+
72+
With Appium 2, each Appium capability name must be prefixed with the `appium` prefix.
73+
When defining Appium capabilities in the **Capabilities** tab, you must prefix the capability name like this: `<prefix>:<capability>`.
74+
75+
For example:
76+
77+
* `appium:app` (instead of just `app`)
78+
* `appium:appActivity` (instead of `appActivity`)
79+
* ...
80+
81+
You can find the official documentation provided by Appium:
82+
83+
* General capabilities: https://appium.io/docs/en/2.0/guides/caps/
84+
* UIAutomator2 driver capabilities: https://github.com/appium/appium-uiautomator2-driver
85+
* XCUITest driver capabilities: https://appium.github.io/appium-xcuitest-driver/latest/reference/capabilities/
86+
87+
==== Cloud Provider Capabilities
88+
89+
Cerberus supports the following 3 cloud testing providers:
90+
91+
* BrowserStack
92+
* LambdaTest
93+
* Kobiton
94+
95+
To define specific cloud capabilities, in addition to those generated by Cerberus when launching the test, you must prefix the capability name as follows: `<prefix>:<capability>`.
96+
97+
Prefixes are specific to each testing cloud provider:
98+
99+
* `bstack` for BrowserStack (e.g., `bstack:buildName`; `bstack:sessionName`; ...)
100+
* `lt` for LambdaTest (e.g., `lt:build`; `lt:name`; ...)
101+
* `kobiton` for Kobiton (e.g., `kobiton:sessionName`; `kobiton:sessionDescription`; ...)
102+
103+
Each of these testing cloud providers provides documentation on capabilities:
104+
105+
* BrowserStack:
106+
- Web Automate capabilities: https://www.browserstack.com/docs/automate/capabilities
107+
- App Automate capabilities: https://www.browserstack.com/docs/app-automate/capabilities
108+
* LambdaTest:
109+
- Capabilities Generator: https://www.lambdatest.com/capabilities-generator/
110+
* Kobiton:
111+
- Launching an Appium 2 session on Kobiton: https://docs.kobiton.com/automation-testing/basic-appium-server/launch-a-basic-appium-2-session
112+
- Available Kobiton capabilities: https://docs.kobiton.com/automation-testing/capabilities/available-capabilities#_kobiton_capabilities
113+
114+
==== Capabilities File
115+
116+
You can view the capabilities used in your tests by navigating to the **Robot** tab in the **Execution Report**.
117+
Two files are available:
118+
119+
* **Robot caps**: The list of capabilities provided by you and Cerberus to the robot.
120+
* **Robot server caps**: The capabilities generated by the server (Selenium or Appium). This file combines **Robot caps** and additional server-specific capabilities.
58121

59122
=== Execution settings
60123

0 commit comments

Comments
 (0)