config.py

import datetime
from datetime import date
from typing import Literal, Optional

import pydantic
from appium.options.android import UiAutomator2Options

from spelly_mobile_test import utils

EnvContext = Literal['local', 'browserstack']


class Settings(pydantic.BaseSettings):
    # --- env by default ---
    context: EnvContext = 'browserstack'

    # --- Appium Capabilities ---
    platformName: str = None
    platformVersion: str = None
    deviceName: str = None
    app: Optional[str] = None
    appName: Optional[str] = None
    newCommandTimeout: Optional[int] = 60

    # --- > BrowserStack Capabilities ---
    projectName: Optional[str] = None
    buildName: Optional[str] = None
    browserstackSessionName: Optional[str] = None
    # --- > > BrowserStack credentials---
    browserstackUser: Optional[str] = None
    browserstackKey: Optional[str] = None
    udid: Optional[str] = None

    # --- Remote Driver ---
    remote_url: str = 'http://127.0.0.1:4723/wd/hub'  # default appium server url

    # --- Selene ---
    timeout: float = 8.0 # timeout: float = 6.0

    @property
    def run_on_browserstack(self):
        return 'hub.browserstack.com/wd/hub' in self.remote_url

    @property
    def driver_options(self):
        options = UiAutomator2Options()
        if self.deviceName:
            options.device_name = self.deviceName
        if self.platformName:
            options.platform_name = self.platformName
        options.app = (
            utils.file.abs_path_from_project(self.app)
            if self.app.startswith('./') or self.app.startswith('../')
            else self.app
        )
        options.new_command_timeout = self.newCommandTimeout
        if self.udid:
            options.udid = self.udid
        if self.run_on_browserstack:
            options.load_capabilities(
                {
                    'platformVersion': self.platformVersion,
                    # --- Browserstack Capabilities ---
                    'bstack:options': {
                        'projectName': self.projectName,
                        'buildName': f'{self.buildName}_{date.today()}',
                        'sessionName': f'{self.browserstackSessionName}_{datetime.datetime.now().time()}',
                        'userName': self.browserstackUser,
                        'accessKey': self.browserstackKey,
                    },
                }
            )

        return options

    @classmethod
    def in_context(cls, env: Optional[EnvContext] = None) -> 'Settings':
        """
        factory method to init Settings with values from corresponding .env file
        """
        asked_or_current = env or cls().context
        return cls(
            _env_file=utils.file.abs_path_from_project(f'config.{asked_or_current}.env')
        )


settings = Settings.in_context()