SDK-7772 WDIO Jasmine v9 platformisation

.changeset/pr-244.md

@@ -0,0 +1,7 @@
+---
+"@wdio/browserstack-service": minor
+---
+
+- WebdriverIO with Jasmine (v9) now runs on the BrowserStack CLI: Test Observability, Accessibility, Automate/App Automate session status and naming, and Percy.
+- HTTP command logs now appear in Test Observability for WebdriverIO Mocha and Cucumber, and Mocha sessions show a per-test annotation again.
+- Fixed `--browserstack.testManagementOptions.testPlanId <id>` passed on the command line not reaching Test Management.

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

@@ -23,6 +23,7 @@ import {
     isFalse,
     isTurboScale,
     shouldAddServiceVersion,
+    getTestPlanId,
 } from '../util.js'
 import PerformanceTester from '../instrumentation/performance/performance-tester.js'
 import { EVENTS as PerformanceEvents } from '../instrumentation/performance/constants.js'
@@ -32,7 +33,6 @@ import type { Options, Capabilities } from '@wdio/types'
 import type {
     BrowserstackConfig,
     BrowserstackOptions,
-    TestManagementOptions,
     TestObservabilityOptions,
 } from '../types.js'
 import { TestFrameworkConstants } from './frameworks/constants/testFrameworkConstants.js'
@@ -47,7 +47,7 @@ const CLI_DOWNLOAD_TMP_SUFFIX = '.zip'
 export class CLIUtils {
     static automationFrameworkDetail = {}
     static testFrameworkDetail = {}
-    static CLISupportedFrameworks = ['mocha', 'cucumber']
+    static CLISupportedFrameworks = ['mocha', 'cucumber', 'jasmine']
 
     static isDevelopmentEnv() {
         return process.env.BROWSERSTACK_CLI_ENV === 'development'
@@ -116,11 +116,7 @@ export class CLIUtils {
             )
         const observabilityOptions: TestObservabilityOptions =
             options.testObservabilityOptions || {}
-        const testManagementOptions: TestManagementOptions =
-            options.testManagementOptions || {}
-        const testPlanId = typeof testManagementOptions.testPlanId === 'string'
-            ? testManagementOptions.testPlanId.trim()
-            : ''
+        const testPlanId = (getTestPlanId(options as BrowserstackConfig & Options.Testrunner) || '').trim()
         const binconfig: Record<string, unknown> = {
             userName: observabilityOptions.user || config.user,
             accessKey: observabilityOptions.key || config.key,

packages/browserstack-service/src/cli/frameworks/wdioCucumberTestFramework.ts

@@ -116,6 +116,8 @@ export default class WdioCucumberTestFramework extends TestFramework {
 
     /** The hook currently open on this worker — started and not yet finished. */
     private openHook: { key: string, hookId: string } | null = null
+    // WebDriver command logs attach only once a scenario has started, as legacy's current-test gate did.
+    private scenarioStarted = false
 
     constructor(testFrameworks: string[], testFrameworkVersions: Record<string, string>, binSessionId: string) {
         super(testFrameworks, testFrameworkVersions, binSessionId)
@@ -222,6 +224,13 @@ export default class WdioCucumberTestFramework extends TestFramework {
         logger.debug(`WdioCucumberTestFramework.trackEvent: testFrameworkState=${testFrameworkState} hookState=${hookState}`)
         await super.trackEvent(testFrameworkState, hookState, args)
 
+        if (testFrameworkState === TestFrameworkState.TEST && hookState === HookState.PRE) {
+            this.scenarioStarted = true
+        } else if (testFrameworkState === TestFrameworkState.LOG && args.commandLog === true && !this.scenarioStarted) {
+            logger.debug('trackEvent: command log before the first scenario dropped')
+            return
+        }
+
         const instance = this.resolveInstance(testFrameworkState, hookState)
         if (!instance) {
             // Console output emitted before the first scenario (or before BeforeAll) has nothing

packages/browserstack-service/src/cli/frameworks/wdioMochaTestFramework.ts

@@ -35,6 +35,12 @@ export default class WdioMochaTestFramework extends TestFramework {
     static KEY_HOOK_LAST_STARTED = 'test_hook_last_started'
     static KEY_HOOK_LAST_FINISHED = 'test_hook_last_finished'
 
+    // WebDriver command logs follow the hook or test that started last, even after it finished, as legacy's
+    // current test did: a hook names its hook run, a test (null) the test.
+    private commandLogHook: Record<string, unknown> | null = null
+    // The last test that ran: a skip report moves the tracked instance to the skipped test, never this.
+    private commandLogTest: TestFrameworkInstance | null = null
+
     /**
    * Constructor for the TestFramework
    * @param {Array} testFrameworks - List of Test frameworks
@@ -55,7 +61,7 @@ export default class WdioMochaTestFramework extends TestFramework {
         logger.info(`trackEvent: testFrameworkState=${testFrameworkState} hookState=${hookState}`)
         await super.trackEvent(testFrameworkState, hookState, args)
 
-        const instance = this.resolveInstance(testFrameworkState, hookState, args)
+        const instance = this.commandLogTestInstance(testFrameworkState, hookState, args) ?? this.resolveInstance(testFrameworkState, hookState, args)
         if (instance === null) {
             logger.error(`trackEvent: instance not found for testFrameworkState=${testFrameworkState} hookState=${hookState}`)
             return
@@ -92,7 +98,7 @@ export default class WdioMochaTestFramework extends TestFramework {
             } else if (testFrameworkState === TestFrameworkState.LOG) {
                 const logEntry = args.logEntry as Record<string, unknown>
                 logEntry.uuid = TestFramework.getState(instance, TestFrameworkConstants.KEY_HOOK_ID)
-                this.loadLogEntries(instance, testFrameworkState, hookState, logEntry)
+                this.loadLogEntries(instance, testFrameworkState, hookState, logEntry, args.commandLog === true)
             } else if (testFrameworkState === TestFrameworkState.LOG_REPORT && hookState === HookState.POST) {
                 logger.info('trackEvent: load test results')
                 this.loadTestResult(instance, args)
@@ -105,6 +111,12 @@ export default class WdioMochaTestFramework extends TestFramework {
             // test_hooks_started forever (never popped).
             if (CLIUtils.matchHookRegex(testFrameworkState.toString().split('.')[1])) {
                 await this.trackHookEvents(instance, testFrameworkState, hookState, args)
+                if (hookState === HookState.PRE) {
+                    this.commandLogHook = WdioMochaTestFramework.openHook(instance) ?? null
+                }
+            } else if (testFrameworkState === TestFrameworkState.TEST && hookState === HookState.PRE && args.skipReport !== true) {
+                this.commandLogHook = null
+                this.commandLogTest = instance
             }
             logger.debug(`trackEvent: tracked instance data=${JSON.stringify(Object.fromEntries(instance.getAllData()))}`)
         } catch (error) {
@@ -266,7 +278,7 @@ export default class WdioMochaTestFramework extends TestFramework {
      * @param hookState HookState
      * @param args Additional arguments (level, message, etc.)
      */
-    loadLogEntries(instance: TestFrameworkInstance, testFrameworkState: State, hookState: State, logEntry: Record<string, unknown>) {
+    loadLogEntries(instance: TestFrameworkInstance, testFrameworkState: State, hookState: State, logEntry: Record<string, unknown>, commandLog = false) {
         const logRecord: Record<string, unknown> = {}
         const { level, message, timestamp, kind } = logEntry
 
@@ -280,6 +292,14 @@ export default class WdioMochaTestFramework extends TestFramework {
         logRecord.level = level
         logRecord.timestamp = timestamp
 
+        // The instance is already in LOG here, so a WebDriver command log names its hook itself: the binary
+        // keys an entry to a hook run only by a hook state.
+        const commandLogHook = commandLog ? this.commandLogHook : null
+        if (commandLogHook) {
+            logRecord[TestFrameworkConstants.KEY_HOOK_ID] = commandLogHook[TestFrameworkConstants.KEY_HOOK_ID]
+            logRecord.testFrameworkState = commandLogHook.key
+        }
+
         // Attach to the suitable hook
         const lastActiveHook = WdioMochaTestFramework.lastActiveHook(instance, WdioMochaTestFramework.KEY_HOOK_LAST_STARTED)
         if (lastActiveHook) {
@@ -297,6 +317,22 @@ export default class WdioMochaTestFramework extends TestFramework {
         })
     }
 
+    /** A command log outside any hook goes to the last test that ran, in LOG state, as console logs do. */
+    private commandLogTestInstance(testFrameworkState: State, hookState: State, args: Record<string, unknown>) {
+        if (testFrameworkState !== TestFrameworkState.LOG || args.commandLog !== true || this.commandLogHook || !this.commandLogTest) {
+            return null
+        }
+        this.updateInstanceState(this.commandLogTest, testFrameworkState, hookState)
+        return this.commandLogTest
+    }
+
+    /** The hook started last and not yet finished: a hook's POST pops it from the started list. */
+    static openHook(instance: TestFrameworkInstance): Record<string, unknown> | undefined {
+        const key = TestFramework.getState(instance, WdioMochaTestFramework.KEY_HOOK_LAST_STARTED) as string | undefined
+        const started = TestFramework.getState(instance, TestFrameworkConstants.KEY_HOOKS_STARTED) as Map<string, Record<string, unknown>[]> | undefined
+        return key && started instanceof Map ? started.get(key)?.at(-1) : undefined
+    }
+
     /**
      * Get the last active hook for the given instance and hook key.
      * @param instance TestFrameworkInstance

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

@@ -55,6 +55,27 @@ const SUMMARY_ANSI = {
     warn: { base: '\x1b[33m', emphasis: '\x1b[1;33m' }
 }
 
+const TEST_PLAN_ID_ARG = '--browserstack.testManagementOptions.testPlanId'
+
+// The binary parses CLI args as `--key=value` only, so the space form reaches it as `true` and
+// overrides the id getBinConfig already resolved; the id travels in the bin config instead.
+export function stripTestPlanIdArg(args: string[]): string[] {
+    const result: string[] = []
+    for (let i = 0; i < args.length; i++) {
+        if (args[i] === TEST_PLAN_ID_ARG) {
+            if (i + 1 < args.length && !args[i + 1].startsWith('-')) {
+                i++
+            }
+            continue
+        }
+        if (args[i].startsWith(`${TEST_PLAN_ID_ARG}=`)) {
+            continue
+        }
+        result.push(args[i])
+    }
+    return result
+}
+
 /**
  * GrpcClient - Singleton class for managing gRPC client connections
  *
@@ -180,7 +201,7 @@ export class GrpcClient {
                 sdkVersion: packageVersion,
                 pathProject: process.cwd(),
                 pathConfig: path.resolve(process.cwd(), 'browserstack.yml'),
-                cliArgs: process.argv.slice(2),
+                cliArgs: stripTestPlanIdArg(process.argv.slice(2)),
                 frameworks: [automationFrameworkDetail.name, testFrameworkDetail.name],
                 frameworkVersions,
                 language: CLIUtils.getSdkLanguage(),

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

@@ -17,6 +17,7 @@ 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 WdioJasmineTestFramework from './frameworks/wdioJasmineTestFramework.js'
 import WdioAutomationFramework from './frameworks/wdioAutomationFramework.js'
 import WebdriverIOModule from './modules/webdriverIOModule.js'
 import AccessibilityModule from './modules/accessibilityModule.js'
@@ -49,7 +50,7 @@ export class BrowserstackCLI {
     modulesLoaded = false
     binSessionId: string | null = null
     modules: Record<string, BaseModule> = {}
-    testFramework: WdioMochaTestFramework|WdioCucumberTestFramework|null = null
+    testFramework: WdioMochaTestFramework|WdioCucumberTestFramework|WdioJasmineTestFramework|null = null
     cliParams: Record<string, string> | null = null
     automationFramework: WdioAutomationFramework|null = null
     SDK_CLI_BIN_PATH: string | null = null
@@ -179,7 +180,12 @@ export class BrowserstackCLI {
                 this.modules[ObservabilityModule.MODULE_NAME] = new ObservabilityModule(startBinResponse.observability)
             }
 
-            this.modules[TestHubModule.MODULE_NAME] = new TestHubModule(startBinResponse.testhub)
+            const testHubModule = new TestHubModule(startBinResponse.testhub)
+            this.modules[TestHubModule.MODULE_NAME] = testHubModule
+            testHubModule.setTestFramework(this.testFramework)
+            if (this.testFramework instanceof WdioJasmineTestFramework) {
+                this.testFramework.setTestHubModule(testHubModule)
+            }
 
             // Custom-tag (multi Test-Case-ID) tagging rides the per-test event_json
             // to TestHub, so it is gated on the testhub pipeline being active.
@@ -568,6 +574,10 @@ export class BrowserstackCLI {
             this.testFramework = new WdioCucumberTestFramework([testFrameworkDetail.name], testFrameworkDetail.version, this.binSessionId as string)
             return
         }
+        if (testFrameworkDetail.name.toLowerCase() === 'webdriverio-jasmine') {
+            this.testFramework = new WdioJasmineTestFramework([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

@@ -278,7 +278,7 @@ export default class AccessibilityModule extends BaseModule {
             // on suite and test titles, and in this window neither exists yet. onBeforeTest
             // re-computes the per-test gate, tags included, so this only affects the window.
             const preTestSessionId = this.currentSessionId()
-            if (this.autoScanning && preTestSessionId !== undefined && preTestSessionId !== null) {
+            if (this.autoScanning && this.supportsPreTestWindow() && preTestSessionId !== undefined && preTestSessionId !== null) {
                 this.accessibilityMap.set(preTestSessionId, true)
                 this.logger.debug('Accessibility scan gate opened ahead of the first test')
             }
@@ -338,9 +338,11 @@ export default class AccessibilityModule extends BaseModule {
         try {
             this.logger.debug('Accessibility before test hook. Starting accessibility scan for this test case.')
             const suiteTitle = (typeof args.suiteTitle === 'string' ? args.suiteTitle : '') || ''
-            const test = (args.test && typeof args.test === 'object' ? args.test as { title?: string } : {}) || {}
+            const test = (args.test && typeof args.test === 'object' ? args.test as { title?: string, description?: string } : {}) || {}
+            // jasmine specs carry their name in `description` (`title` is unset), as on the classic handler
+            const testTitle = test.title ?? test.description
 
-            this.currentTestName = test.title || null
+            this.currentTestName = testTitle || null
             this.testContextSeen = true
             const autoInstance: AutomationFrameworkInstance = AutomationFramework.getTrackedInstance()
             const testInstance: TestFrameworkInstance = TestFramework.getTrackedInstance()
@@ -353,7 +355,7 @@ export default class AccessibilityModule extends BaseModule {
             // 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
+            const shouldScanTest = this.autoScanning && shouldScanTestForAccessibility(suiteTitle, testTitle || '', accessibilityOptions as Record<string, string> | undefined, world, Boolean(world)) && this.accessibility
 
             this.accessibilityMap.set(sessionId, shouldScanTest)
 
@@ -537,6 +539,12 @@ export default class AccessibilityModule extends BaseModule {
         return false
     }
 
+    // Legacy jasmine opened no scan window before its first spec (classic PRE_TEST_SCAN_FRAMEWORKS)
+    private supportsPreTestWindow(): boolean {
+        const frameworks = BrowserstackCLI.getInstance().getTestFramework()?.getTestFrameworks() ?? []
+        return !frameworks.some((name) => String(name).toLowerCase().includes('jasmine'))
+    }
+
     // See the classic handler: one definition, used at every scan site.
     private get hasNoParent(): boolean {
         return !this.currentHookRunUuid && !this.testContextSeen