const base = require('@playwright/test'); const cp = require('child_process'); const clientPlaywrightVersion = cp .execSync('npx playwright --version') .toString() .trim() .split(' ')[1]; // BrowserStack Specific Capabilities. const caps = { browser: 'chrome', os: 'osx', os_version: 'catalina', name: 'My first playwright test', build: process.env.BROWSERSTACK_BUILD_NAME || `local-build-${new Date().getTime()}`, 'browserstack.username': process.env.BROWSERSTACK_USERNAME || 'YOUR_USERNAME', 'browserstack.accessKey': process.env.BROWSERSTACK_ACCESS_KEY || 'YOUR_ACCESS_KEY', 'browserstack.local': process.env.BROWSERSTACK_LOCAL || false, 'client.playwrightVersion': clientPlaywrightVersion, 'browserstack.debug': true, 'browserstack.networkLogs': true, 'browserstack.networkLogsOptions': { "captureContent": "true" } }; // Patching the capabilities dynamically according to the project name. const patchCaps = (name, title) => { let combination = name.split(/@browserstack/)[0]; let [browerCaps, osCaps] = combination.split(/:/); let [browser, browser_version] = browerCaps.split(/@/); let osCapsSplit = osCaps.split(/ /); let os = osCapsSplit.shift(); let os_version = osCapsSplit.join(' '); caps.browser = browser; if (browser.includes('playwright-')) { caps['browserstack.playwrightVersion'] = browser_version; } else { caps.browser_version = browser_version; } caps.os = os; caps.os_version = os_version; caps.name = title; }; const isHash = (entity) => Boolean(entity && typeof(entity) === "object" && !Array.isArray(entity)); const nestedKeyValue = (hash, keys) => keys.reduce((hash, key) => (isHash(hash) ? hash[key] : undefined), hash); const isUndefined = val => (val === undefined || val === null || val === ''); const evaluateSessionStatus = (status) => { if (!isUndefined(status)) { status = status.toLowerCase(); } if (status === "passed") { return "passed"; } else if (status === "failed" || status === "timedout") { return "failed"; } else { return ""; } } exports.test = base.test.extend({ page: async ({ page, playwright }, use, testInfo) => { // Use BrowserStack Launched Browser according to capabilities for cross-browser testing. if (testInfo.project.name.match(/browserstack/)) { patchCaps(testInfo.project.name, `${testInfo.file} - ${testInfo.title}`); const vBrowser = await playwright.chromium.connect({ wsEndpoint: `wss://cdp.browserstack.com/playwright?caps=` + `${encodeURIComponent(JSON.stringify(caps))}`, }); const vContext = await vBrowser.newContext(testInfo.project.use); const vPage = await vContext.newPage(); await use(vPage); const testResult = { action: 'setSessionStatus', arguments: { status: evaluateSessionStatus(testInfo.status), reason: nestedKeyValue(testInfo, ['error', 'message']) }, }; await vPage.evaluate(() => {}, `browserstack_executor: ${JSON.stringify(testResult)}`); await vPage.close(); await vBrowser.close(); } else { use(page); } }, });