adb.py

import logging
import os
import re
import time

from subprocess32 import TimeoutExpired

from core.enums.os_type import OSType
from core.log.log import Log
from core.settings import Settings
from core.utils.file_utils import File
from core.utils.process import Process
from core.utils.run import run
from core.utils.version import Version

ANDROID_HOME = os.environ.get('ANDROID_HOME')
ADB_PATH = os.path.join(ANDROID_HOME, 'platform-tools', 'adb')


class Adb(object):
    @staticmethod
    def run_adb_command(command, device_id=None, wait=True, timeout=60, fail_safe=False, log_level=logging.DEBUG):
        if device_id is None:
            command = '{0} {1}'.format(ADB_PATH, command)
        else:
            command = '{0} -s {1} {2}'.format(ADB_PATH, device_id, command)
        return run(cmd=command, wait=wait, timeout=timeout, fail_safe=fail_safe, log_level=log_level)

    @staticmethod
    def get_ids(include_emulators=False):
        """
        Get IDs of available android devices.
        """
        devices = []
        output = Adb.run_adb_command('devices -l').output
        # Example output:
        # emulator-5554          device product:sdk_x86 model:Android_SDK_built_for_x86 device:generic_x86
        # HT46BWM02644           device usb:336592896X product:m8_google model:HTC_One_M8 device:htc_m8
        for line in output.splitlines():
            if 'model' in line and ' device ' in line:
                device_id = line.split(' ')[0]
                if 'emulator' in line and not include_emulators:
                    Log.debug('{0} not included in android device list.'.format(device_id))
                else:
                    devices.append(device_id)
        return devices

    @staticmethod
    def get_logcat(device_id):
        """
        Dump the log and then exit (don't block).
        :param device_id: Device id.
        """
        # sometimes command timeout. Very often on api29. Add a retry that don't wait the process to finish.
        try:
            result = Adb.run_adb_command(command='logcat -d', device_id=device_id, wait=True).output
        except TimeoutExpired:
            Log.info('get_logcat timeout! Retrying...')
            command_result = Adb.run_adb_command(command='logcat -d', device_id=device_id, wait=False)
            time.sleep(15)
            result = File.read(command_result.log_file)
            try:
                os.kill(command_result.pid, 0)
            except OSError:
                Log.info('Process already killed...')
        return result

    @staticmethod
    def clear_logcat(device_id):
        """
        Clear (flush) the entire log.
        :param device_id: Device id.
        """
        Adb.run_adb_command(command='logcat -c', device_id=device_id, wait=True)
        Log.info("The logcat on {0} is cleared.".format(device_id))

    @staticmethod
    def __find_aapt():
        """
        Find aapt tool under $ANDROID_HOME/build-tools
        :return: Path to appt.
        """
        aapt_executable = 'aapt'
        if Settings.HOST_OS is OSType.WINDOWS:
            aapt_executable += '.exe'
        base_path = os.path.join(ANDROID_HOME, 'build-tools')
        return File.find(base_path=base_path, file_name=aapt_executable, exact_match=True)

    @staticmethod
    def restart():
        Log.info("Restart adb.")
        Adb.run_adb_command('kill-server')
        Process.kill(proc_name='adb')
        Adb.run_adb_command('start-server')

    @staticmethod
    def get_package_permission(apk_file):
        """
        Get permission from apk file.
        :param apk_file: Path to apk file.
        :return: Permissions as string.
        """
        command = Adb.__find_aapt() + ' d permissions ' + apk_file
        return run(cmd=command, log_level=logging.WARNING).output

    @staticmethod
    def is_running(device_id):
        """
        Check if device is is currently running.
        :param device_id: Device id.
        :return: True if running, False if not running.
        """
        if Settings.HOST_OS is OSType.WINDOWS:
            command = "shell dumpsys window windows | findstr mSurface"
        else:
            command = "shell dumpsys window windows | grep -E 'mSurface'"
        result = Adb.run_adb_command(command=command, device_id=device_id, timeout=10, fail_safe=True)
        return bool('mSurface=Surface' in result.output)

    @staticmethod
    def wait_until_boot(device_id, timeout=250, check_interval=3):
        """
        Wait android device/emulator is up and running.
        :param device_id: Device identifier.
        :param timeout: Timeout until device is ready (in seconds).
        :param check_interval: Sleep specified time before check again.
        :return: True if device is ready before timeout, otherwise - False.
        """
        booted = False
        start_time = time.time()
        end_time = start_time + timeout
        while not booted:
            time.sleep(check_interval)
            booted = Adb.is_running(device_id=device_id)
            if (booted is True) or (time.time() > end_time):
                break
        return booted

    @staticmethod
    def reboot(device_id):
        Adb.run_adb_command(command='reboot', device_id=device_id)
        Adb.wait_until_boot(device_id=device_id)

    @staticmethod
    def prevent_screen_lock(device_id):
        """
        Disable screen lock after time of inactivity.
        :param device_id: Device identifier.
        """
        Adb.run_adb_command(command='shell settings put system screen_off_timeout -1', device_id=device_id)

    @staticmethod
    def pull(device_id, source, target):
        return Adb.run_adb_command(command='pull {0} {1}'.format(source, target), device_id=device_id)

    @staticmethod
    def get_page_source(device_id):
        temp_file = os.path.join(Settings.TEST_OUT_TEMP, 'window_dump.xml')
        File.delete(temp_file)
        Adb.run_adb_command(command='shell rm /sdcard/window_dump.xml', device_id=device_id)
        result = Adb.run_adb_command(command='shell uiautomator dump', device_id=device_id)
        if 'UI hierchary dumped to' in result.output:
            time.sleep(1)
            Adb.pull(device_id=device_id, source='/sdcard/window_dump.xml', target=temp_file)
            if File.exists(temp_file):
                result = File.read(temp_file)
                File.delete(temp_file)
                return result
            else:
                return ''
        else:
            # Sometimes adb shell uiatomator dump fails, for example with:
            # adb: error: remote object '/sdcard/window_dump.xml' does not exist
            # In such cases return empty string.
            return ''

    # noinspection PyPep8Naming
    @staticmethod
    def is_text_visible(device_id, text, case_sensitive=False):
        element = Adb.get_element_by_text(device_id, text, case_sensitive)
        return element is not None

    @staticmethod
    def get_element_coordinates(element):
        bounds = element.attrib['bounds']
        bound_groups = re.findall(r"(\d+,\d+)", bounds)
        x = 0
        y = 0
        counter = 0
        for bound_group in bound_groups:
            arr_x_y = bound_group.split(",")
            x = x + int(arr_x_y[0])
            y = y + int(arr_x_y[1])
            counter = counter + 1
        return x / counter, y / counter

    @staticmethod
    def click_element_by_text(device_id, text, case_sensitive=False):
        element = Adb.get_element_by_text(device_id, text, case_sensitive)
        if element is not None:
            coordinates = Adb.get_element_coordinates(element)
            Adb.run_adb_command(command="shell input tap {0} {1}".format(str(coordinates[0]), str(coordinates[1])),
                                device_id=device_id)
        else:
            assert False, 'Element with text ' + text + ' not found!'

    # noinspection PyPep8Naming
    @staticmethod
    def get_element_by_text(device_id, text, case_sensitive=False):
        import xml.etree.ElementTree as ET
        page_source = Adb.get_page_source(device_id)
        if page_source != '':
            xml = ET.ElementTree(ET.fromstring(page_source))
            elements = xml.findall(".//node[@text]")
            if elements:
                for element in elements:
                    if case_sensitive:
                        if text in element.attrib['text']:
                            return element
                    else:
                        if text.lower() in element.attrib['text'].lower():
                            return element
        return None

    @staticmethod
    def get_screen(device_id, file_path):
        File.delete(path=file_path)
        if Settings.HOST_OS == OSType.WINDOWS and 'emulator' in device_id:
            Adb.run_adb_command(command='exec-out screencap -p > ' + file_path,
                                device_id=device_id,
                                log_level=logging.DEBUG)
        else:
            Adb.run_adb_command(command='shell rm /sdcard/image.png', device_id=device_id)
            Adb.run_adb_command(command='shell screencap -p /sdcard/image.png', device_id=device_id)
            result = Adb.run_adb_command(command='pull /sdcard/image.png {0}'.format(file_path), device_id=device_id)
            assert '1 file pulled' in result.output, 'Failed to pull image from {0}.\n{1}'.format(device_id,
                                                                                                  result.output)
            Adb.run_adb_command(command='shell rm /sdcard/image.png', device_id=device_id)
        if File.exists(file_path):
            return
        else:
            raise Exception('Failed to get screen of {0}.'.format(device_id))

    @staticmethod
    def get_device_version(device_id):
        result = Adb.run_adb_command(command='shell getprop ro.build.version.release', device_id=device_id)
        if result.exit_code == 0:
            return result.output
        else:
            raise Exception('Failed to get version of {0}.'.format(device_id))

    @staticmethod
    def open_home(device_id):
        cmd = 'shell am start -a android.intent.action.MAIN -c android.intent.category.HOME'
        Adb.run_adb_command(command=cmd, device_id=device_id)
        Log.info('Open home screen of {0}.'.format(str(device_id)))

    @staticmethod
    def install(apk_path, device_id, time_out=60):
        """
        Install application.
        :param apk_path: File path to .apk.
        :param device_id: Device id.
        :param time_out: command timeout interval.
        """
        command = '-s {0} install -r {1}'.format(device_id, apk_path)
        result = Adb.run_adb_command(command=command, timeout=time_out, wait=True)
        # Retry to install the app. Recently too many attempts failed from first time.
        if not result.complete:
            Log.info('Failed to install {0} on {1}.'.format(apk_path, device_id))
            Log.info('Retry...')
            result = Adb.run_adb_command(command=command, timeout=time_out, wait=True)

        assert 'Success' in result.output, 'Failed to install {0}. Output: {1}'.format(apk_path, result.output)
        Log.info('{0} installed successfully on {1}.'.format(apk_path, device_id))

    @staticmethod
    def uninstall(app_id, device_id, assert_success=True):
        """
        Uninstall application.
        :param app_id: Package identifier - org.nativescript.testapp.
        :param device_id: Device id.
        :param assert_success: Assert if uninstall is successful.
        """
        command = 'uninstall ' + app_id
        output = Adb.run_adb_command(command=command, device_id=device_id, wait=True).output
        if assert_success:
            assert 'Success' in output, 'Failed to uninstall {0}. Output: {1}'.format(app_id, output)
            Log.info('{0} uninstalled successfully from {1}.'.format(app_id, device_id))

    @staticmethod
    def __list_path(device_id, package_id, path):
        """
        List file of application.
        :param device_id: Device identifier.
        :param package_id: Package identifier.
        :param path: Path relative to root folder of the package.
        :return: List of files and folders
        """
        command = 'shell run-as {id} ls -la /data/data/{id}/files/{path}'.format(id=package_id, path=path)
        output = Adb.run_adb_command(command=command, device_id=device_id, log_level=logging.DEBUG, wait=True).output
        return output

    @staticmethod
    def file_exists(device_id, package_id, file_name, timeout=20):
        """file_exists
        Wait until path exists (relative based on folder where package is deployed) on emulator/android device.
        :param device_id: Device identifier.
        :param package_id: Package identifier.
        :param file_name: File you want to check if exists.
        :param timeout: Timeout in seconds.
        :return: True if path exists, false if path does not exists
        """
        t_end = time.time() + timeout
        found = False
        while time.time() < t_end:
            files = Adb.__list_path(device_id=device_id, package_id=package_id, path=file_name)
            if 'No such file or directory' not in files:
                found = True
                break
        return found

    @staticmethod
    def start_application(device_id, app_id):
        """
        Start application.
        :param device_id: Device id.
        :param app_id: App id.
        """
        command = 'shell monkey -p ' + app_id + ' -c android.intent.category.LAUNCHER 1'
        output = Adb.run_adb_command(command=command, device_id=device_id, wait=True).output
        assert 'Events injected: 1' in output, 'Failed to start {0}.'.format(app_id)
        Log.info('{0} started successfully.'.format(app_id))

    @staticmethod
    def stop_application(device_id, app_id):
        """
        Stop application
        :param device_id: Device identifier
        :param app_id: Bundle identifier (example: org.nativescript.TestApp)
        """
        result = Adb.run_adb_command(command='shell am force-stop {0}'.format(app_id), device_id=device_id, wait=True)
        assert app_id not in result.output, 'Failed to stop ' + app_id

    @staticmethod
    def is_application_installed(device_id, app_id):
        """
        Stop application
        :param device_id: Device identifier
        :param app_id: Bundle identifier (example: org.nativescript.TestApp)
        """
        packages = Adb.run_adb_command(command=' shell pm list packages -f', device_id=device_id, wait=True).output
        is_application_installed = False
        if app_id in packages:
            is_application_installed = True
        return is_application_installed

    @staticmethod
    def get_version(device_id):
        """
        Get device version
        :param device_id: Device identifier as float.
        """
        result = Adb.run_adb_command(command='shell getprop ro.build.version.release', wait=True, device_id=device_id)
        return Version.get(result.output)

    @staticmethod
    def get_active_services(device_id, service_name=""):
        """
        Get actice services
        :param device_id: Device identifier as float.
        :param service_name: Service name you want to find as string.
        """
        try:
            result = Adb.run_adb_command(command='shell dumpsys activity services {0}'.format(service_name), wait=True,
                                         device_id=device_id).output
        except TimeoutExpired:
            Log.info('get_logcat timeout! Retrying...')
            command_result = Adb.run_adb_command(command='shell dumpsys activity services {0}'.format(service_name),
                                                 wait=False, device_id=device_id)
            time.sleep(15)
            result = File.read(command_result.log_file)
            try:
                os.kill(command_result.pid, 0)
            except OSError:
                Log.info('Process already killed...')
        return result

    @staticmethod
    def get_process_pid(device_id, process_name):
        """
        Get actice services
        :param device_id: Device identifier as float.
        :param process_name: process name as string.
        """
        result = Adb.run_adb_command(command='shell ps | grep {0} | awk \'{{print $2}}\''.format(process_name),
                                     wait=True,
                                     device_id=device_id)
        pid = result.output.replace(process_name, "").strip()
        return pid

    @staticmethod
    def kill_process(device_id, process_name):
        """
        Get actice services
        :param device_id: Device identifier as float.
        :param process_name: process name as string.
        """
        pid = Adb.get_process_pid(device_id, process_name)
        result = Adb.run_adb_command(
            command='shell kill {0}'.format(pid),
            wait=True, device_id=device_id)
        assert result.output == "", "Process {0} not killed! Logs:{1}".format(process_name, result.output)
        time.sleep(5)

    @staticmethod
    def kill_application(device_id, app_id, process_id):
        """
        Stop application
        :param device_id: Device identifier
        :param app_id: Bundle identifier (example: org.nativescript.TestApp)
        :param process_id: The id of the process
        """
        Adb.run_adb_command(command='shell run-as {0} kill {1}'.format(app_id, process_id),
                            device_id=device_id, wait=True)
        # wait application to be killed
        time.sleep(2)

    @staticmethod
    def run_adb_as_root(device_id):
        """
        Run adb on device/emulator as root
        :param device_id: Device identifier as float.
        """
        Adb.run_adb_command(command='kill-server', wait=True, device_id=device_id)
        Adb.run_adb_command(command='root', wait=True, device_id=device_id)
        time.sleep(5)