Updated scan method and workflow

Author: SwethaKondam1

.github/workflows/ios-appium-tests.yml

@@ -31,8 +31,9 @@ env:
   APPIUM_SKIP_CHROMEDRIVER_INSTALL: 1
   APPIUM_TEST_SERVER_PORT: 4723
   APPIUM_TEST_SERVER_HOST: 127.0.0.1
-  AGORA_NPM_EMAIL: ${{ secrets.DQ_AGORA_USER }}
-  AGORA_NPM_AUTH: ${{ secrets.APPIUM_AUTH }}
+  ADT_APIKEY: ${{ secrets.AXE_APIKEY }}
+  AGORA_NPM_EMAIL: ${{ secrets.AGORA_NPM_EMAIL }}
+  AGORA_NPM_AUTH: ${{ secrets.DQ_AGORA_IDENTITY_TOKEN }}
   AGORA_REGISTRY_URL: //agora.dequecloud.com/artifactory/api/npm/axe-devtools-mobile-appium-qa/
 
 jobs:

appium-tests/README.md

@@ -114,6 +114,50 @@ npm run test:appium3
 npm test
 ```
 
+## Axe Accessibility Scanning
+
+The tests include automated axe accessibility scanning that sends results to the QA dashboard.
+
+### Setup for Axe Scans
+
+1. **Set API Key** (required for scans to run):
+```bash
+export ADT_APIKEY="your-api-key-here"
+# OR for dev environment
+export ADT_DEV_APIKEY="your-dev-api-key"
+```
+
+2. **Run tests** - axe scans will run automatically during tests:
+```bash
+npm test
+```
+
+### Axe Scan Features
+
+- **Automatic scanning** on every screen navigation
+- **Results sent to QA Dashboard** at `https://mobile-qa.dequelabs.com`
+- **Tagged scans** for easy filtering:
+  - Screen names (home, catalog, cart, profile)
+  - Test types (navigation, accessibility, etc.)
+  - Platform (ios, appium_webdriverio)
+
+### Viewing Scan Results
+
+1. Go to https://mobile-qa.dequelabs.com
+2. Log in with your credentials
+3. View scans filtered by:
+   - Scan name (e.g., "Home Screen Accessibility Scan")
+   - Tags (e.g., "home", "catalog", "accessibility")
+   - Date/time
+
+### Scan Coverage
+
+The tests scan accessibility for:
+- **App Launch**: Initial app state
+- **Tab Navigation**: All tab screens (Home, Catalog, Cart, Profile)
+- **Home Screen**: Main view, search bar, scrolled content, navigation bar
+- **Comprehensive Suite**: Full WCAG compliance checks on all screens
+
 ## Configuration Options
 
 You can customize test execution using environment variables:

appium-tests/test/helpers/utils.js

@@ -101,6 +101,63 @@ class Utils {
     async wait(ms = 1000) {
         await driver.pause(ms);
     }
+
+    /**
+     * Run axe accessibility scan and send results to QA dashboard
+     * @param {string} scanName - Name for the scan
+     * @param {string[]} tags - Tags for the scan
+     * @returns {Object} Scan result
+     */
+    async runAxeScan(scanName, tags = ['appium_webdriverio']) {
+        const apiKey = process.env.ADT_APIKEY || process.env.ADT_DEV_APIKEY || '';
+
+        if (!apiKey) {
+            console.warn('⚠ ADT_APIKEY not set, skipping axe scan');
+            return null;
+        }
+
+        const axeSettings = {
+            apiKey: apiKey,
+            axeServiceUrl: 'https://mobile-qa.dequelabs.com',
+            scanName: scanName,
+            tags: tags
+        };
+
+        try {
+            console.log(`🔍 Running axe scan: ${scanName}`);
+            const scanResult = await driver.executeScript('mobile: axeScan', [axeSettings]);
+
+            if (scanResult && scanResult.axeError) {
+                console.error(`❌ Axe scan failed: ${scanResult.axeError}`);
+                throw new Error(`Axe scan failed: ${scanResult.axeError}`);
+            }
+
+            console.log(`✓ Axe scan completed: ${scanName}`);
+            if (scanResult && scanResult.violations) {
+                console.log(`  - Violations found: ${scanResult.violations.length}`);
+            }
+
+            return scanResult;
+        } catch (error) {
+            console.error(`❌ Error running axe scan: ${error.message}`);
+            throw error;
+        }
+    }
+
+    /**
+     * Run axe scan for a specific screen after navigation
+     * @param {string} screenName - Name of the screen
+     * @param {string[]} tags - Additional tags
+     */
+    async scanScreen(screenName, tags = []) {
+        // Wait for screen to stabilize
+        await this.wait(1500);
+
+        const scanTags = ['appium_webdriverio', 'ios', screenName.toLowerCase(), ...tags];
+        const scanName = `${screenName} Screen Accessibility Scan`;
+
+        return await this.runAxeScan(scanName, scanTags);
+    }
 }
 
 module.exports = new Utils();

appium-tests/test/specs/accessibility.spec.js

@@ -21,6 +21,9 @@ describe('Accessibility Tests', () => {
 
             console.log(`✓ ${tab.label} tab is accessible`);
         }
+
+        // Run axe scan on tab bar accessibility
+        await utils.scanScreen('Tab Bar Accessibility', ['accessibility', 'tab-labels']);
     });
 
     it('should verify all tabs are clickable', async () => {
@@ -41,6 +44,9 @@ describe('Accessibility Tests', () => {
         }
 
         console.log('✓ All tabs are clickable');
+
+        // Run axe scan on tab clickability
+        await utils.scanScreen('Tabs Clickable', ['accessibility', 'interactive']);
     });
 
     it('should verify screen navigation is accessible', async () => {
@@ -61,6 +67,9 @@ describe('Accessibility Tests', () => {
             await utils.takeScreenshot(`accessibility-${test.name.toLowerCase()}`);
 
             console.log(`✓ ${test.name} screen accessible and screenshot captured`);
+
+            // Run axe scan on each navigated screen
+            await utils.scanScreen(`${test.name} Navigation`, ['accessibility', test.name.toLowerCase(), 'navigation']);
         }
     });
 
@@ -77,5 +86,45 @@ describe('Accessibility Tests', () => {
         expect(size.height).to.be.at.least(44);
 
         console.log(`✓ Tab touch targets meet minimum size requirements (${size.width}x${size.height})`);
+
+        // Run axe scan on touch targets
+        await utils.scanScreen('Touch Targets', ['accessibility', 'touch-targets', 'sizing']);
+    });
+
+    it('should run comprehensive accessibility scan on all screens', async () => {
+        const screens = [
+            { tab: selectors.homeTab, name: 'Home' },
+            { tab: selectors.catalogTab, name: 'Catalog' },
+            { tab: selectors.cartTab, name: 'Cart' },
+            { tab: selectors.profileTab, name: 'Profile' }
+        ];
+
+        console.log('🔍 Running comprehensive accessibility scan on all screens...');
+
+        for (const screen of screens) {
+            // Navigate to screen
+            const tab = await $(screen.tab);
+            await utils.tapWithRetry(tab);
+            await utils.wait(1500);
+
+            console.log(`Scanning ${screen.name} screen...`);
+
+            // Run comprehensive axe scan
+            const scanResult = await utils.runAxeScan(
+                `${screen.name} Comprehensive Scan`,
+                ['comprehensive', 'full-suite', screen.name.toLowerCase(), 'wcag']
+            );
+
+            if (scanResult) {
+                console.log(`✓ ${screen.name} scan completed`);
+                if (scanResult.violations && scanResult.violations.length > 0) {
+                    console.log(`  ⚠ Found ${scanResult.violations.length} violation(s) on ${screen.name} screen`);
+                } else {
+                    console.log(`  ✓ No violations found on ${screen.name} screen`);
+                }
+            }
+        }
+
+        console.log('✓ Comprehensive accessibility scan completed for all screens');
     });
-});
+});

appium-tests/test/specs/app-launch.spec.js

@@ -12,6 +12,9 @@ describe('App Launch Tests', () => {
         expect(appState).to.equal(4); // 4 = running in foreground
 
         console.log('✓ App launched successfully');
+
+        // Run axe scan on app launch
+        await utils.scanScreen('App Launch', ['app-start', 'initial-load']);
     });
 
     it('should display the tab bar with all tabs', async () => {
@@ -29,11 +32,17 @@ describe('App Launch Tests', () => {
         await utils.verifyElementDisplayed(catalogTab, 'Catalog Tab');
         await utils.verifyElementDisplayed(cartTab, 'Cart Tab');
         await utils.verifyElementDisplayed(profileTab, 'Profile Tab');
+
+        // Run axe scan on tab bar
+        await utils.scanScreen('Tab Bar', ['navigation', 'tab-bar']);
     });
 
     it('should display Home screen by default', async () => {
         // Verify Home header is displayed
         const homeHeader = await $(`-ios predicate string:${selectors.homeHeader}`);
         await utils.verifyElementDisplayed(homeHeader, 'Home Header');
+
+        // Run axe scan on default home screen
+        await utils.scanScreen('Home Default', ['home', 'default-screen']);
     });
-});
+});

appium-tests/test/specs/home-screen.spec.js

@@ -16,6 +16,9 @@ describe('Home Screen Tests', () => {
         await utils.verifyElementDisplayed(homeHeader, 'Home Header');
 
         console.log('✓ Home screen elements displayed');
+
+        // Run axe scan on Home screen
+        await utils.scanScreen('Home Screen', ['home', 'main-view']);
     });
 
     it('should display search bar on Home screen', async () => {
@@ -27,6 +30,9 @@ describe('Home Screen Tests', () => {
             const isDisplayed = await searchBar.isDisplayed();
             if (isDisplayed) {
                 console.log('✓ Search bar is displayed');
+
+                // Run axe scan on search bar
+                await utils.scanScreen('Home Screen Search', ['home', 'search-bar']);
             }
         } catch (error) {
             console.log('⚠ Search bar may not be visible or accessible');
@@ -38,6 +44,9 @@ describe('Home Screen Tests', () => {
         await utils.swipeUp();
         await utils.wait(1000);
 
+        // Run axe scan after scrolling down
+        await utils.scanScreen('Home Screen Scrolled', ['home', 'scrolled-view']);
+
         // Scroll back up
         await utils.swipeDown();
         await utils.wait(1000);
@@ -53,5 +62,8 @@ describe('Home Screen Tests', () => {
         expect(isDisplayed).to.be.true;
 
         console.log('✓ Navigation bar is displayed');
+
+        // Run axe scan on navigation bar
+        await utils.scanScreen('Home Screen Navigation', ['home', 'navigation-bar']);
     });
-});
+});

appium-tests/test/specs/tab-navigation.spec.js

@@ -21,6 +21,9 @@ describe('Tab Navigation Tests', () => {
         await utils.verifyElementDisplayed(catalogHeader, 'Catalog Header');
 
         console.log('✓ Successfully navigated to Catalog tab');
+
+        // Run axe scan on Catalog screen
+        await utils.scanScreen('Catalog Screen', ['catalog', 'tab-navigation']);
     });
 
     it('should navigate to Cart tab', async () => {
@@ -34,6 +37,9 @@ describe('Tab Navigation Tests', () => {
         await utils.verifyElementDisplayed(cartHeader, 'Cart Header');
 
         console.log('✓ Successfully navigated to Cart tab');
+
+        // Run axe scan on Cart screen
+        await utils.scanScreen('Cart Screen', ['cart', 'tab-navigation']);
     });
 
     it('should navigate to Profile tab', async () => {
@@ -47,6 +53,9 @@ describe('Tab Navigation Tests', () => {
         await utils.verifyElementDisplayed(profileHeader, 'Profile Header');
 
         console.log('✓ Successfully navigated to Profile tab');
+
+        // Run axe scan on Profile screen
+        await utils.scanScreen('Profile Screen', ['profile', 'tab-navigation']);
     });
 
     it('should navigate between all tabs', async () => {
@@ -68,6 +77,9 @@ describe('Tab Navigation Tests', () => {
             await utils.verifyElementDisplayed(header, `${tab.name} Header`);
 
             console.log(`✓ Successfully navigated to ${tab.name} tab`);
+
+            // Run axe scan on each screen during navigation
+            await utils.scanScreen(`${tab.name} Screen`, [tab.name.toLowerCase(), 'full-navigation']);
         }
     });
 
@@ -77,6 +89,9 @@ describe('Tab Navigation Tests', () => {
         await utils.tapWithRetry(catalogTab);
         await utils.wait(1000);
 
+        // Run axe scan on Catalog before switching
+        await utils.scanScreen('Catalog Before Switch', ['catalog', 'state-test']);
+
         // Navigate away and back
         const homeTab = await $(selectors.homeTab);
         await utils.tapWithRetry(homeTab);
@@ -90,5 +105,8 @@ describe('Tab Navigation Tests', () => {
         await utils.verifyElementDisplayed(catalogHeader, 'Catalog Header');
 
         console.log('✓ Tab state maintained successfully');
+
+        // Run axe scan on Catalog after switching back
+        await utils.scanScreen('Catalog After Switch', ['catalog', 'state-maintained']);
     });
-});
+});