Skip to content

Commit 3db313e

Browse files
authored
Merge pull request #2187 from Ishavyas9/main
Updated documentation
2 parents 294ecb8 + 719526a commit 3db313e

File tree

8 files changed

+39
-6
lines changed

8 files changed

+39
-6
lines changed
98.8 KB
Loading
98.3 KB
Loading
98.5 KB
Loading

docs/appium-lambdaHooks.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,7 @@ Any command logs executed between `lambda-testCase-start` and `lambda-testCase-e
158158
159159
You can also filter the command logs based on these labels.A screenshot has been provided below, demonstrating the use of labels and how to filter command logs based on them.
160160
161-
<img loading="lazy" src={require('../assets/images/appium-lambdaHooks/02.webp').default} alt="Test Case Filter" width="1200" height="550" className="doc_img"/>
162-
161+
![Test Cases](../assets/images/real-device-app-testing/Test-Cases.png)
163162
164163
<nav aria-label="breadcrumbs">
165164
<ul className="breadcrumbs">
@@ -179,4 +178,37 @@ You can also filter the command logs based on these labels.A screenshot has been
179178
</span>
180179
</li>
181180
</ul>
182-
</nav>
181+
</nav>
182+
183+
---
184+
185+
## Command Annotations
186+
187+
Command Annotations allow you to add metadata and debugging information to your test scripts. They work similarly to LambdaHooks by providing structured logs on the **LambdaTest Automation Dashboard**, making it easier to track test execution, debug failures, and navigate specific test sections.
188+
189+
![Command Annotation](../assets/images/real-device-app-testing/command-annotation.png)
190+
191+
### Using Command Annotations
192+
193+
#### Annotation Start
194+
```java
195+
driver.execute_script("lambdatest_executor: {\"action\": \"stepcontext\", \"arguments\": {\"data\": \"youtube\", \"level\": \"debug\"}}");
196+
```
197+
198+
**Arguments:**
199+
200+
| Argument | Description |
201+
|----------|-------------|
202+
| `data` | String value representing the information you want to log. |
203+
| `level` | Log severity level. Acceptable values: `info` (default), `debug`, `warn`, `error`. |
204+
205+
#### Annotation End
206+
To close the executor at the end of your script, pass `data` as an empty string:
207+
208+
```java
209+
driver.execute_script("lambdatest_executor: {\"action\": \"stepcontext\", \"arguments\": {\"data\": \"\"}}");
210+
```
211+
212+
:::info
213+
**Mutual exclusivity:** Test case and Command Annotations cannot be used together in the same script. You can only use **one** of them per session.
214+
:::

docs/apple-pay-auto.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,7 @@ Currently, the Device Passcode feature in App Automation is enabled on the follo
5454
| Capability | Type | Default | Required / Optional | Description |
5555
|----------------------------|------------|---------|---------------------|---------------------------------------------------------------------------------------------|
5656
| **applePay** | Boolean | true | Mandatory | Enables Apple Pay provisioning including Wallet, Sandbox card, AssistiveTouch, and Passcode on supported real iOS devices. |
57-
| **applePayCardType** | Array | None | Optional | Specify preferred payment networks. Currently, you can choose from four supported cards: ["American Express", "Visa", "MasterCard", "Discover Global Network"].
58-
|
57+
| **applePayCardType** | Array | None | Optional | Specify preferred payment networks. Currently, you can choose from four supported cards: ["American Express", "Visa", "MasterCard", "Discover Global Network"].|
5958

6059
---
6160

docs/espresso-supported-capabilities.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ This document provide details about the features and capabilities supported for
6868
| clearPackageData | Boolean | Set this to `true` if you want to clear the app data after each test has completed running. **Default**: `false` |
6969
| singleRunnerInvocation | Boolean | Set this to `true` if you want to execute test cases together with a `single test runner invocation`.This can help significantly speed up the test execution time. By default, each test case is invoked separately. **Default:** `false` |
7070
| testRemarks <br /> <br /> | Boolean | Set to `true` to surface failure remarks at the top of the dashboard when a test fails. Has no effect on passing tests. **Default**: `false`. |
71+
| retries <br /> <br /> | Integer |Defines the number of times a test should automatically retry if it fails. Maximum allowed value: 5.|
7172

7273
:::note
7374
Ensure that the latitude is between -90 and 90, and the longitude is between -180 and 180. Otherwise, an error will occur like "Invalid GPS location: Latitude must be between -90 and +90, Longitude must be between -180 and +180."

docs/install-apps-from-firebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Login to your LambdaTest account. Visit **Real Device** from the left panel and
7979
When you click on Add Project, you can integrate your Firebase account with LambdaTest either by uploading a **config file** or connecting **using credentials**. You should have these credentials from the prerequisite step.
8080

8181
**Upload a Config file -**
82-
<img loading="lazy" src={require('../assets/images/mobile-app-testing/firebase/2photo.png').default} alt="Real " className="doc_img" width="1366" height="629"/>
82+
<img loading="lazy" src={require('../assets/images/real-device-app-testing/firebase-application-upload-steps.png').default} alt="Real " className="doc_img" width="1366" height="629"/>
8383

8484
**Connect with credentials -**
8585
<img loading="lazy" src={require('../assets/images/mobile-app-testing/firebase/Animeshrox.png').default} alt="Real " className="doc_img" width="1366" height="629"/>

docs/xcui-supported-capibilities.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ This document provide details about the features and capabilities supported for
6565
| enableBluetooth | Boolean | Used to enable the bluetooth functionality during the session. Example: `enableBluetooth: true`|
6666
| resignApp <br /> <br />Not supported in **Virtual Devices** | Boolean | Set this to `false` if you want to to prevent the apps from being re-signed. The app should be built for enterprise distribution. |
6767
| testRemarks <br /> <br />| Boolean | Set to `true` to surface failure remarks at the top of the dashboard when a test fails. Has no effect on passing tests. **Default**: `false`. |
68+
| retries <br /> <br /> | Integer |Defines the number of times a test should automatically retry if it fails. Maximum allowed value: 5.|
6869

6970
:::note
7071
Ensure that the latitude is between -90 and 90, and the longitude is between -180 and 180. Otherwise, an error will occur like "Invalid GPS location: Latitude must be between -90 and +90, Longitude must be between -180 and +180."

0 commit comments

Comments
 (0)