SDK 7414 wdio cucumber platformisation

.changeset/pr-191.md

@@ -0,0 +1,7 @@
+---
+"@wdio/browserstack-service": minor
+---
+
+- WebdriverIO + CucumberJS now runs on the BrowserStack CLI flow, the same path Mocha already uses. Reporting, accessibility, Percy and session naming behave as before — no config change is needed.
+- Fixed: sessions were left unmarked pass/fail when setSessionName: false was set. Naming and status are independent options again.
+- Fixed: the accessibility extension was not applied on non-BrowserStack infrastructure, leaving scans empty on otherwise green runs.

packages/browserstack-service/src/cli/cliUtils.ts

@@ -47,7 +47,7 @@ const CLI_DOWNLOAD_TMP_SUFFIX = '.zip'
 export class CLIUtils {
     static automationFrameworkDetail = {}
     static testFrameworkDetail = {}
-    static CLISupportedFrameworks = ['mocha']
+    static CLISupportedFrameworks = ['mocha', 'cucumber']
 
     static isDevelopmentEnv() {
         return process.env.BROWSERSTACK_CLI_ENV === 'development'

packages/browserstack-service/src/cli/index.ts

@@ -16,6 +16,7 @@ import { BROWSERSTACK_ACCESSIBILITY, BROWSERSTACK_OBSERVABILITY, BROWSERSTACK_TE
 import type { Options } from '@wdio/types'
 import TestOpsConfig from '../testOps/testOpsConfig.js'
 import WdioMochaTestFramework from './frameworks/wdioMochaTestFramework.js'
+import WdioCucumberTestFramework from './frameworks/wdioCucumberTestFramework.js'
 import WdioAutomationFramework from './frameworks/wdioAutomationFramework.js'
 import WebdriverIOModule from './modules/webdriverIOModule.js'
 import AccessibilityModule from './modules/accessibilityModule.js'
@@ -47,7 +48,7 @@ export class BrowserstackCLI {
     modulesLoaded = false
     binSessionId: string | null = null
     modules: Record<string, BaseModule> = {}
-    testFramework: WdioMochaTestFramework|null = null
+    testFramework: WdioMochaTestFramework|WdioCucumberTestFramework|null = null
     cliParams: Record<string, string> | null = null
     automationFramework: WdioAutomationFramework|null = null
     SDK_CLI_BIN_PATH: string | null = null
@@ -548,7 +549,15 @@ export class BrowserstackCLI {
         const testFrameworkDetail = CLIUtils.getTestFrameworkDetail()
         if (testFrameworkDetail.name.toLowerCase() === 'webdriverio-mocha') {
             this.testFramework = new WdioMochaTestFramework([testFrameworkDetail.name], testFrameworkDetail.version, this.binSessionId as string)
+            return
+        }
+        if (testFrameworkDetail.name.toLowerCase() === 'webdriverio-cucumber') {
+            this.testFramework = new WdioCucumberTestFramework([testFrameworkDetail.name], testFrameworkDetail.version, this.binSessionId as string)
+            return
         }
+        // An unmatched name leaves testFramework null, and every CLI event then no-ops with no
+        // error of any kind. Name it so the silence is diagnosable.
+        this.logger.error(`setupTestFramework: no CLI test framework registered for name=${testFrameworkDetail.name}; test events will not be tracked`)
     }
 
     /**

packages/browserstack-service/src/cli/modules/accessibilityModule.ts

@@ -89,10 +89,14 @@ export default class AccessibilityModule extends BaseModule {
             if (!this.accessibility) {
                 return
             }
-            // Open the scan gate for the hook window so DOM-changing commands issued inside
-            // before/beforeEach/afterEach/after hooks trigger scans (web per-command path). The
-            // following onBeforeTest re-computes the per-test gate, so this only affects the hook.
-            if (this.autoScanning && sessionId !== undefined && sessionId !== null) {
+            // Open the scan gate for the hook window, so commands issued inside hooks are scanned.
+            // Mocha-only, as legacy gates the identical write (`this._framework === 'mocha'`): it
+            // relies on the following onBeforeTest re-computing the gate, which holds only where
+            // beforeEach precedes beforeTest. Cucumber inverts that ordering, so there the write
+            // would land last and force the gate permanently open.
+            const frameworkName = String(TestFramework.getState(testInstance, TestFrameworkConstants.KEY_TEST_FRAMEWORK_NAME) || '')
+            const isMocha = frameworkName.toLowerCase().includes('mocha')
+            if (this.autoScanning && isMocha && sessionId) {
                 this.accessibilityMap.set(sessionId, true)
             }
         } catch (error) {
@@ -343,7 +347,13 @@ export default class AccessibilityModule extends BaseModule {
 
             const sessionId = AutomationFramework.getState(autoInstance, AutomationFrameworkConstants.KEY_FRAMEWORK_SESSION_ID)
             const accessibilityOptions = this.config.accessibilityOptions
-            const shouldScanTest = this.autoScanning && shouldScanTestForAccessibility(suiteTitle, test.title || '', accessibilityOptions as Record<string, string> | undefined) && this.accessibility
+            // Cucumber filters scans by gherkin tag, which needs the world object and the 6-arg
+            // form of shouldScanTestForAccessibility; the 3-arg form matches include/exclude tags
+            // against the test title instead and so silently scans every scenario. `args.world` is
+            // only ever populated on the cucumber path, so mocha and jasmine keep the exact 3-arg
+            // behaviour — both extra args arrive undefined/false and the tag branch is not taken.
+            const world = args.world as { [key: string]: unknown } | undefined
+            const shouldScanTest = this.autoScanning && shouldScanTestForAccessibility(suiteTitle, test.title || '', accessibilityOptions as Record<string, string> | undefined, world, Boolean(world)) && this.accessibility
 
             this.accessibilityMap.set(sessionId, shouldScanTest)