browserstack.py

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

import pytest

from pytest_selenium.drivers.cloud import Provider
from pytest_selenium.exceptions import MissingCloudSettingError


class BrowserStack(Provider):

    API = "https://api.browserstack.com/automate/sessions/{session}.json"

    @property
    def auth(self):
        return self.username, self.key

    @property
    def executor(self):
        return "https://hub.browserstack.com/wd/hub"

    @property
    def username(self):
        user = self.get_credential(
            "username", ["BROWSERSTACK_USERNAME", "BROWSERSTACK_USR"]
        )
        if user in [
            "BROWSERSTACK_USERNAME",
            "YOUR_USERNAME",
            "BROWSERSTACK_USR",
        ]:
            return self.get_credential(
                "", ["BROWSERSTACK_USERNAME", "BROWSERSTACK_USR"]
            )
        else:
            return user

    @property
    def key(self):
        access_key = self.get_credential(
            "key", ["BROWSERSTACK_ACCESS_KEY", "BROWSERSTACK_PSW"]
        )
        if access_key in [
            "BROWSERSTACK_ACCESS_KEY",
            "YOUR_ACCESS_KEY",
            "BROWSERSTACK_PSW",
        ]:
            return self.get_credential(
                "", ["BROWSERSTACK_ACCESS_KEY", "BROWSERSTACK_PSW"]
            )
        else:
            return access_key

    @property
    def job_access(self):
        """Get job url field, private(required authentication) or public."""
        try:
            field = self.get_setting(
                key="job_access",
                envs=["BROWSERSTACK_JOB_ACCESS"],
                section="report",
                allowed_values=["browser_url", "public_url"],
            )
        except MissingCloudSettingError:
            field = "browser_url"

        return field


@pytest.mark.optionalhook
def pytest_selenium_runtest_makereport(item, report, summary, extra):
    if report.when in ["setup", "teardown"]:
        return
    provider = BrowserStack()
    if not provider.uses_driver(item.config.getoption("driver")):
        return

    passed = report.passed or (report.failed and hasattr(report, "wasxfail"))
    # set test failure reason if available
    fail_reason = ""
    if not passed:
        try:
            fail_reason = report.longrepr.reprcrash
        except Exception as e:
            summary.append(
                "WARNING: Failed to determine {0} job URL: {1}".format(provider.name, e)
            )
    session_id = item._driver.session_id
    api_url = provider.API.format(session=session_id)

    # lazy import requests for projects that don't need requests
    import requests

    try:
        job_info = requests.get(api_url, auth=provider.auth, timeout=10).json()
        job_url = job_info["automation_session"][provider.job_access]
        # Add the job URL to the summary
        summary.append("{0} Job: {1}".format(provider.name, job_url))
        pytest_html = item.config.pluginmanager.getplugin("html")
        # Add the job URL to the HTML report
        extra.append(pytest_html.extras.url(job_url, "{0} Job".format(provider.name)))
    except Exception as e:
        summary.append(
            "WARNING: Failed to determine {0} job URL: {1}".format(provider.name, e)
        )

    try:
        # Update the session status
        job_status = job_info["automation_session"]["status"]
        if job_status not in ("failed", "passed"):
            # Only update the status if it's not already marked (by user via script)
            if passed:
                item._driver.execute_script(
                    'browserstack_executor: { \
                        "action": "setSessionStatus", \
                        "arguments": { "status":"passed" } \
                    }'
                )
            else:
                import json

                if fail_reason:
                    item._driver.execute_script(
                        'browserstack_executor: {\
                            "action": "annotate", \
                            "arguments": {\
                                "level": "error", \
                                "data": '
                        + json.dumps(str(fail_reason))
                        + "\
                            }\
                        }"
                    )
                    item._driver.execute_script(
                        'browserstack_executor: {\
                            "action": "setSessionStatus", \
                            "arguments": {\
                                "status": "failed", \
                                "reason": '
                        + json.dumps(str(fail_reason))
                        + "\
                            }\
                        }"
                    )
                else:
                    item._driver.execute_script(
                        'browserstack_executor: { \
                            "action": "setSessionStatus", \
                            "arguments": { "status":"failed" } \
                        }'
                    )
    except Exception as e:
        summary.append("WARNING: Failed to update session status: {0}".format(e))


def driver_kwargs(request, test, capabilities, **kwargs):
    provider = BrowserStack()
    assert provider.job_access
    if (
        "bstack:options" in capabilities
        and type(capabilities["bstack:options"]) is dict
    ):
        capabilities["bstack:options"].setdefault("sessionName", test)
        capabilities["bstack:options"].setdefault("userName", provider.username)
        capabilities["bstack:options"].setdefault("accessKey", provider.key)
    else:
        capabilities.setdefault("name", test)
        capabilities.setdefault("browserstack.user", provider.username)
        capabilities.setdefault("browserstack.key", provider.key)
    kwargs = {
        "command_executor": provider.executor,
        "desired_capabilities": capabilities,
        "keep_alive": True,
    }
    return kwargs