nodium/src/driver/browserstack.js

Pure nodejs selenium webdriver functional helpers

import { Builder, Browser } from 'selenium-webdriver';
import { getFirefoxOptions } from './local';

export default function getBrowserstackDriver(
    username,
    accessKey,
    browser,
    project = 'nodium sample test',
    localIdentifier = 'local',
    build = 'local',
    capabilities = {}
) {
    // auto detect tunnel name and build depends on travis-ci or circle-ci env var
    if (process.env.TRAVIS_JOB_NUMBER) {
        localIdentifier =
            process.env.BROWSERSTACK_LOCAL_IDENTIFIER ||
            process.env.TRAVIS_JOB_NUMBER;
        build = 'Travis #' + process.env.TRAVIS_BUILD_NUMBER;
    }
    if (process.env.CIRCLE_BUILD_NUM) {
        localIdentifier = process.env.CIRCLE_BUILD_NUM;
        build = 'Circle #' + localIdentifier;
    }

    if (browser.version) {
        capabilities.browser_version = browser.version;
    }
    if (!capabilities['browserstack.selenium_version']) {
        capabilities['browserstack.selenium_version'] = '3.14.0';
    }

    const builder = new Builder()
        .usingServer('http://hub.browserstack.com/wd/hub')
        .withCapabilities({
            browserName:
                browser.name.charAt(0).toUpperCase() +
                browser.name.slice(1).toLowerCase(),
            os: browser.platform,
            os_version: browser.platformVersion,
            resolution: browser.resolution,
            build,
            project,
            'browserstack.user': username,
            'browserstack.key': accessKey,
            'browserstack.local': 'true',
            'browserstack.localIdentifier': localIdentifier,
            ...capabilities,
        });

    if (Browser.FIREFOX === browser.name.toLowerCase()) {
        builder.setFirefoxOptions(getFirefoxOptions());
    }

    return builder.build();
}