simctl.py

import json
import os
import time

from core.log.log import Log
from core.utils.file_utils import File
from core.utils.run import run


# noinspection PyShadowingBuiltins
class Simctl(object):

    @staticmethod
    def run_simctl_command(command, wait=True, timeout=60):
        command = '{0} {1}'.format('xcrun simctl', command)
        return run(cmd=command, wait=wait, timeout=timeout)

    # noinspection PyBroadException
    @staticmethod
    def __get_simulators():
        result = Simctl.run_simctl_command(command='list --json devices')
        try:
            return json.loads(result.output)
        except ValueError:
            Log.error('Failed to parse json ' + os.linesep + result.output)
            return json.loads('{}')

    @staticmethod
    def start(simulator_info):
        if simulator_info.id is not None:
            Simctl.run_simctl_command(command='boot {0}'.format(simulator_info.id))
            Simctl.wait_until_boot(simulator_info)
            return simulator_info
        else:
            raise Exception('Can not boot iOS simulator if udid is not specified!')

    @staticmethod
    def is_running(simulator_info):
        sims = Simctl.__get_simulators()['devices']['iOS {0}'.format(simulator_info.sdk)]
        for sim in sims:
            if sim['name'] == simulator_info.name and sim['state'] == 'Booted':
                # simctl returns Booted too early, so we will wait some untill service is started
                simulator_info.id = str(sim['udid'])
                command = 'spawn {0} launchctl print system | grep com.apple.springboard.services'.format(
                    simulator_info.id)
                service_state = Simctl.run_simctl_command(command=command)
                if "M   A   com.apple.springboard.services" in service_state.output:
                    Log.info('Simulator "{0}" booted.'.format(simulator_info.name))
                    return simulator_info
        return False

    @staticmethod
    def wait_until_boot(simulator_info, timeout=180):
        """
        Wait until iOS Simulator is up and running.
        :param simulator_info: SimulatorInfo object.
        :param timeout: Timeout until device is ready (in seconds).
        :return: SimulatorInfo object with defined id, otherwise - False.
        """
        booted = False
        start_time = time.time()
        end_time = start_time + timeout
        while not booted:
            time.sleep(2)
            booted = Simctl.is_running(simulator_info)
            if booted or time.time() > end_time:
                return booted
        return booted

    @staticmethod
    def is_available(simulator_info):
        sims = Simctl.__get_simulators()['devices']['iOS {0}'.format(simulator_info.sdk)]
        for sim in sims:
            if sim['name'] == simulator_info.name:
                simulator_info.id = str(sim['udid'])
                return simulator_info
        return False

    @staticmethod
    def stop_application(simulator_info, app_id):
        return Simctl.run_simctl_command('terminate {0} {1}'.format(simulator_info.id, app_id))

    @staticmethod
    def stop_all(simulator_info):
        for app_id in Simctl.get_all_apps(simulator_info):
            Simctl.stop_application(simulator_info, app_id)

    @staticmethod
    def install(simulator_info, path):
        result = Simctl.run_simctl_command('install {0} {1}'.format(simulator_info.id, path))
        if result.exit_code != 0:
            # Since Xcode 10 sometimes xcrun simctl install fails first time (usually with iPhone X* devices).
            Log.info('Failed to install {0} on {1}.'.format(path, simulator_info.name))
            Log.info('Retry...')
            result = Simctl.run_simctl_command('install {0} {1}'.format(simulator_info.id, path))
            assert result.exit_code == 0, 'Failed to install {0} on {1}'.format(path, simulator_info.name)
            assert 'Failed to install the requested application' not in result.output, \
                'Failed to install {0} on {1}'.format(path, simulator_info.name)

    @staticmethod
    def uninstall(simulator_info, app_id):
        result = Simctl.run_simctl_command('uninstall {0} {1}'.format(simulator_info.id, app_id))
        assert result.exit_code == 0, 'Failed to uninstall {0} on {1}'.format(app_id, simulator_info.name)
        assert 'Failed to uninstall the requested application' not in result.output, \
            'Failed to uninstall {0} on {1}'.format(app_id, simulator_info.name)
        Log.info('Successfully uninstalled {0} from {1}'.format(app_id, simulator_info.id))

    @staticmethod
    def uninstall_all(simulator_info):
        Simctl.stop_all(simulator_info)
        for app_id in Simctl.get_all_apps(simulator_info):
            Simctl.uninstall(simulator_info, app_id)

    @staticmethod
    def get_screen(sim_id, file_path):
        File.delete(file_path)
        result = Simctl.run_simctl_command('io {0} screenshot {1}'.format(sim_id, file_path))
        assert result.exit_code == 0, 'Failed to get screenshot of {0}'.format(sim_id)
        assert File.exists(file_path), 'Failed to get screenshot of {0}'.format(sim_id)

    @staticmethod
    def erase(simulator_info):
        result = Simctl.run_simctl_command('erase {0}'.format(simulator_info.id))
        assert result.exit_code == 0, 'Failed to erase {0}'.format(simulator_info.name)
        Log.info('Erase {0}.'.format(simulator_info.name))

    @staticmethod
    def erase_all():
        result = Simctl.run_simctl_command('erase all')
        assert result.exit_code == 0, 'Failed to erase all iOS Simulators.'
        Log.info('Erase all iOS Simulators.')

    @staticmethod
    def get_all_apps(simulator_info):
        bundle_ids = []
        root = '~/Library/Developer/CoreSimulator/Devices/{0}'.format(simulator_info.id)
        shell = 'find {0}/data/Containers/Bundle/Application -maxdepth 3 | grep .app | grep Info.plist'.format(root)
        result = run(cmd=shell, timeout=30)
        for plist in result.output.splitlines():
            bundle_id = run(cmd='/usr/libexec/PlistBuddy -c "Print :CFBundleIdentifier" {0}'.format(plist)).output
            if '.' in bundle_id:
                bundle_ids.append(bundle_id)
        return bundle_ids