Accessibility App Automation

docs/accessibility-android-automation-test.md

@@ -42,114 +42,165 @@ import TabItem from '@theme/TabItem';
       })
     }}
 ></script>
+LambdaTest now enables native Accessibility Automation Testing for Android apps using HyperExecute and Appium. This feature helps developers and QA teams to validate the accessibility of their mobile apps programmatically by leveraging LambdaTest's device cloud.
 
-This guide walks you through automating accessibility testing of a native Android app using **LambdaTest's Accessibility Automation Tool (Beta) via Appium**. You'll run an automated accessibility scan on a real Android device hosted on LambdaTest’s real device cloud infrastructure.
+With built-in support for `lambda-accessibility-scan`, this integration ensures that your apps are tested for compliance with accessibility standards and best practices like WCAG (Web Content Accessibility Guidelines).
 
 ## Prerequisites
+Before getting started, ensure the following:
 
-- Your [LambdaTest Username and Access key](/support/docs/using-environment-variables-for-authentication-credentials/)
-- Python 3.x or Java JDK 8+ installed
-- Appium Python Client or Java Client Library
+- You have a LambdaTest account.
+- LambdaTest credentials (username & access key).
+- Android app uploaded to LambdaTest App Storage (lt://APP_ID).
+- Python 3 installed locally.
+- Appium-Python-Client installed
+- Access to a valid Android device on LambdaTest (real or virtual).
 
-## Step-by-Step Guide to Trigger Your Test
+> This will work for both Android and iOS applications.
 
-### Step 1: Setup Your Test Suite
+## Step 1: Setup the Environment Variables
 
-You can use your own project to configure and test it. For demo purposes, we are using the sample repository.
+You need to export your environment variables *LT_USERNAME* and *LT_ACCESS_KEY* that are available in your [LambdaTest Profile page](https://accounts.lambdatest.com/security). Run the below mentioned commands in your terminal to setup the environment variables.
 
-:::tip sample repo
-Download or Clone the code sample from the LambdaTest GitHub repository to run your tests.
-
-<a href="https://github.com/LambdaTest/lambdatest-accessibility-selenium" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
-:::
+<Tabs className="docs__val">
+<TabItem value="bash" label="Linux / MacOS" default>
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-bash">
+  {`export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}"
+export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}"`}
+  </CodeBlock>
+</div>
+</TabItem>
+<TabItem value="powershell" label="Windows" default>
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-powershell">
+  {`set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}"
+set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}"`}
+  </CodeBlock>
+</div>
+</TabItem>
+</Tabs>
 
-If you are using your own project, make sure you update the **Hub endpoint** in your tests file. By setting up the Hub endpoint, you establish the communication channel between your tests and the browser nodes, enabling effective test distribution and execution.
+## Step 2: Upload your Application
+Upload your **_iOS_** application (.ipa file) or **_android_** application (.apk or .aab file) to the LambdaTest servers using our **REST API**. You need to provide your **Username** and **AccessKey** in the format `Username:AccessKey` in the **cURL** command for authentication.
 
-Configure the desired capabilities based on your test requirements. For example:
+Make sure to add the path of the **appFile** in the cURL request. Below is an example cURL request to upload your app using our REST API:
 
 <Tabs className="docs__val">
 
-<TabItem value="python" label="Python" default>
-
+<TabItem value="bash" label="App File" default>
   <div className="lambdatest__codeblock">
-
-    ```python
-    desired_cap = {
-      "platform": "android",
-      "isRealMobile": True,
-      "app": "lt://APP",  # Replace with your LambdaTest App URL
-      "accessibility": True,
-      "buildName": "Accessibility-lambda",
-      "idleTimeout": 1800,
-      "build": "NewAppiumBuild",
-      "name": "MyTest",
-      "devicelog": True
-    }
-    ```
-
+    <CodeBlock className="language-bash">
+      {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app""`}
+    </CodeBlock>
   </div>
-
 </TabItem>
 
-<TabItem value="java" label="Java" default>
-
+<TabItem value="powershell" label="App URL" default>
   <div className="lambdatest__codeblock">
-    ```java
-    DesiredCapabilities caps = new DesiredCapabilities();
-    caps.setCapability("platform", "android");
-    caps.setCapability("isRealMobile", true);
-    caps.setCapability("app", "lt://APPID"); // Replace with your App ID
-    caps.setCapability("accessibility", true);
-    caps.setCapability("idleTimeout", 1800);
-    caps.setCapability("build", "AccessibilityScanBuild");
-    caps.setCapability("name", "MyTest");
-    caps.setCapability("devicelog", true);
-    ```
-</div>
-
+    <CodeBlock className="language-bash">
+      {`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=:https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk" -F "name=Proverbial_App"`}
+    </CodeBlock>
+  </div>
 </TabItem>
+
 </Tabs>
 
+:::tip
 
-> You can generate capabilities for your test requirements with the help of our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
+- If you do not have any **.apk** or **.ipa** file, you can run your sample tests on LambdaTest by using our sample apps, :link: [Android app](https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk) or :link: [iOS app](https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_ios.ipa).
 
-### Step 2: Establish User Authentication
+- Response of above cURL will be a **JSON** object containing the `APP_URL` of the format - `lt://APP123456789123456789` and will be used in the next step
 
-Now, you need to export your environment variables *LT_USERNAME* and *LT_ACCESS_KEY* that are available in the [LambdaTest Profile page](https://accounts.lambdatest.com/detail/profile).
+:::
 
-Run the below mentioned commands in your terminal to setup the CLI and the environment variables.
+## Step 3: Configure required Capabilities
+To enable accessibility testing, the following two configurations are mandatory:
 
-<Tabs className="docs__val">
+- Enable accessibility in capabilities:
+```python
+"accessibility": True
+```
 
-<TabItem value="bash" label="Linux / MacOS" default>
+- Invoke scan via script:
+```python
+driver.execute_script("lambda-accessibility-scan")
+```
 
-  <div className="lambdatest__codeblock">
-    <CodeBlock className="language-bash">
-  {`export LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}"
-export LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}"`}
-  </CodeBlock>
-</div>
+You may call `lambda-accessibility-scan` multiple times to scan different app screens or flows.
 
-</TabItem>
 
-<TabItem value="powershell" label="Windows" default>
+:::info
 
-  <div className="lambdatest__codeblock">
-    <CodeBlock className="language-powershell">
-  {`set LT_USERNAME="${ YOUR_LAMBDATEST_USERNAME()}"
-set LT_ACCESS_KEY="${ YOUR_LAMBDATEST_ACCESS_KEY()}"`}
-  </CodeBlock>
-</div>
+- You must add the generated **APP_URL** to the `app` capability in the config file.
+- You can generate capabilities for your test requirements with the help of our inbuilt [**Capabilities Generator tool**](https://www.lambdatest.com/capabilities-generator/).For more details, please refer to our guide on [**Desired Capabilities in Appium**](https://www.lambdatest.com/support/docs/desired-capabilities-in-appium/).
 
-</TabItem>
-</Tabs>
+:::
 
-### Step 3: Execute and Monitor your Test
+### Sample Script
+
+```python
+from curses import flash
+import time
+# import requests
+from appium import webdriver
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+import unittest
+import os
+from appium import webdriver
+from appium.options.android import UiAutomator2Options
+import sys
+from selenium.webdriver.common.by import By
+from appium.webdriver.client_config import AppiumClientConfig
+
+
+options = UiAutomator2Options()
+options.load_capabilities({
+    "platform": "android",
+    "platformVersion": "14",
+    "deviceName": "Galaxy S23 Ultra",
+    "isRealMobile": True,
+    "app" : "lt://YOUR_APP_ID",
+    "accessibility": True,
+    "buildName": "Accessibility-lambda",
+    "idleTimeout": 1800,
+    "build": "Accessibility Native App",
+    "name": "Android App Accessibility",
+    "devicelog": True,
+    "visual": True,
+})
+url = "https://YOUR_LT_USERNAME:[email protected]/wd/hub" 
+
+client_config = AppiumClientConfig(
+    remote_server_addr=url,
+    ignore_certificates=True,
+    direct_connection=True
+)
+
+driver = webdriver.Remote(client_config.remote_server_addr, options = options, client_config=client_config)
+driver.implicitly_wait(2)
+
+time.sleep(10)
+
+time.sleep(10)
+driver.execute_script("lambda-accessibility-scan")
+time.sleep(10)
+driver.find_element(By.CSS_SELECTOR, '#username').send_keys("Pbtest1") # Example CSS selector
+driver.execute_script("lambda-accessibility-scan")
+
+driver.quit()
+```
 
-Now execute your tests and visit the [Automation Dashboard](https://accounts.lambdatest.com/dashboard). Click on the Accessibility tab and check the report generated.
+## Step 4: Execute and Monitor your Tests
+Run the following command in the directory where your project has been saved to execute your build.
 
 ```bash
-mvn test
+python3 test.py
 ```
 
-<img loading="lazy" src={require('../assets/images/accessibility-testing/accessibility-automation.png').default} alt="automation-dashboard" className="doc_img"/>
+## Accessibility Dashboard and Reporting
+You can check the complete detailed report on the [Accessibility Dashboard](https://accessibility.lambdatest.com/automation)
+
+<img loading="lazy" src={require('../assets/images/accessibility-testing/app-automation/6.png').default} alt="automation-dashboard" className="doc_img"/>
+

docs/accessibility-android-rules.md

@@ -0,0 +1,64 @@
+---
+id: accessibility-android-rules
+title: Android Accessibility Rules - Quick Reference
+sidebar_label: Android
+description: Use LambdaTest Accessibility DevTools to detect and report accessibility issues with automation, following WCAG guidelines.
+keywords:
+    - LambdaTest
+    - Accessibility
+    - Testing
+    - Manual
+    - Accessibility Testing Settings
+url: https://www.lambdatest.com/support/docs/accessibility-android-rules/
+site_name: LambdaTest
+slug: accessibility-android-rules/
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<script type="application/ld+json"
+      dangerouslySetInnerHTML={{ __html: JSON.stringify({
+       "@context": "https://schema.org",
+        "@type": "BreadcrumbList",
+        "itemListElement": [{
+          "@type": "ListItem",
+          "position": 1,
+          "name": "Home",
+          "item": "https://www.lambdatest.com"
+        },{
+          "@type": "ListItem",
+          "position": 2,
+          "name": "Support",
+          "item": "https://www.lambdatest.com/support/docs/"
+        },{
+          "@type": "ListItem",
+          "position": 3,
+          "name": "Accessibility Android Rules",
+          "item": "https://www.lambdatest.com/support/docs/accessibility-android-rules/"
+        }]
+      })
+    }}
+></script>
+
+| Rule Name | WCAG | Level | Impact | Description |
+|-----------|------|-------|--------|-------------|
+| Missing Image Alt | 1.1.1 | A | Critical | Images lack alternative text descriptions that screen readers can announce to users. Add `android:contentDescription` to meaningful images or set to empty string for decorative images to ensure proper accessibility support. |
+| Missing View Accessibility | 4.1.2 | A | Serious | Interactive elements like buttons, clickable views, or custom controls lack proper accessibility labels that describe their purpose. Ensure all interactive Views have clear `android:contentDescription` or associated labels for screen readers. |
+| Unlabeled Checkbox Element | 4.1.2 | A | Serious | Checkbox controls are missing accessible names that describe their purpose or current state. Provide descriptive labels using `android:text`, `android:contentDescription`, or associated TextView labels so users understand what they're selecting. |
+| Insufficient Color Ratio | 1.4.3 | AA | Serious | Text elements don't meet minimum contrast ratio requirements making them difficult to read for users with visual impairments. Maintain 4.5:1 ratio for normal text and 3:1 for large text by adjusting colors or background. |
+| Missing Field Label | 3.3.2 | A | Serious | Input fields like EditText lack descriptive labels that identify their purpose to users. Provide clear labels using `android:hint`, associated TextView with `android:labelFor`, or TextInputLayout to describe expected input. |
+| Non-accessible Interaction | 4.1.2 | A | Serious | Custom interactive elements, buttons, or gesture-based controls cannot be accessed or activated through assistive technology. Ensure all interactive elements have proper focus handling, role definition, and descriptive labels. |
+| Missing Screen Title | 2.4.2 | A | Serious | Activities or screens lack descriptive titles that help users understand their current location in the app. Set meaningful titles using `setTitle()` or `supportActionBar?.title` for proper navigation context. |
+| Unlabeled Toggle Control | 4.1.2 | A | Serious | Switch, toggle, or similar controls are missing accessible names that explain what they control and their current state. Provide descriptive labels that clearly indicate what the toggle affects (e.g., "Wi-Fi enabled"). |
+| Mismatched Label Text | 2.5.3 | A | Serious | The visible text label on a control differs from the programmatically accessible name, causing confusion for screen reader users. Ensure the accessible name includes or matches the visible text exactly. |
+| Missing Input Value | 4.1.2 | A | Moderate | Text fields are missing programmatic values that assistive technology can read, making it difficult for users to understand current input state. Ensure EditText values are properly exposed and announced by screen readers. |
+| Inaccessible Text Focus | 4.1.2 | A | Moderate | Text elements that receive focus lack proper accessibility properties, confusing screen reader users about their purpose. Either provide clear interactive roles and descriptions or remove focus capability for non-interactive text. |
+| Misplaced Field Label | 3.3.2 | A | Moderate | Form labels are not positioned correctly relative to their controls or lack proper programmatic association. Ensure labels appear visually before controls and use `android:labelFor` for proper screen reader announcement order. |
+| Nested Control Issues | 4.1.2 | A | Moderate | Interactive elements are incorrectly nested inside other interactive elements, creating focus traps and navigation confusion. Separate interactive elements into distinct, non-nested components to ensure proper accessibility navigation. |
+| Unnamed Nested Element | 4.1.2 | A | Moderate | Elements within containers lack their own accessible names when they should be independently accessible. Provide distinct labels for nested interactive elements or mark decorative elements as non-focusable. |
+| Fixed Orientation Lock | 1.3.4 | AA | Moderate | App restricts viewing to only portrait or landscape orientation without accessibility justification. Support both orientations or provide alternative access methods for users who cannot rotate their devices due to physical constraints. |
+| Undersized Touch Target | 2.5.5 | AAA | Moderate | Interactive elements are smaller than the recommended minimum touch target size, making them difficult to activate for users with motor impairments. Ensure all touch targets are at least 48dp x 48dp. |
+| Insufficient Target Spacing | 2.5.5 | AAA | Moderate | Interactive elements are placed too close together without adequate spacing, increasing risk of accidental activation. Provide sufficient spacing between adjacent touch targets to prevent targeting errors for users with limited dexterity. |