run_common.py

import os

from core.enums.os_type import OSType
from core.log.log import Log
from core.settings import Settings
from core.utils.ci.jenkins import Jenkins
from core.utils.device.adb import Adb
from core.utils.device.device_manager import DeviceManager
from core.utils.file_utils import File, Folder
from core.utils.git import Git
from core.utils.gradle import Gradle
from core.utils.npm import Npm
from data.templates import Template
from products.nativescript.preview_helpers import Preview
from products.nativescript.tns import Tns


def __cleanup():
    """
    Wipe TEST_OUT_HOME.
    """
    Folder.clean(os.path.join(Settings.TEST_RUN_HOME, 'node_modules'))
    Folder.clean(Settings.TEST_OUT_HOME)
    Folder.create(Settings.TEST_OUT_LOGS)
    Folder.create(Settings.TEST_OUT_IMAGES)

    DeviceManager.Emulator.stop()
    if Settings.HOST_OS == OSType.OSX:
        DeviceManager.Simulator.stop()

    Adb.restart()
    Tns.kill()
    Gradle.kill()
    Gradle.cache_clean()


def __get_templates():
    """
    Clone hello-world templates and pack them as local npm packages.
    Hints: Creating project from local npm package is much faster than from GitHub repo.
    """
    branch = 'master'
    if Jenkins.is_pr():
        branch = Jenkins.get_pr_info().source_branch
    local_folder = os.path.join(Settings.TEST_SUT_HOME, 'templates')
    Git.clone(repo_url=Template.REPO, branch=branch, local_folder=local_folder)

    apps = [Template.HELLO_WORLD_JS, Template.HELLO_WORLD_TS, Template.HELLO_WORLD_NG, Template.MASTER_DETAIL_NG]
    for app in apps:
        template_name = app.name
        template_folder = os.path.join(local_folder, 'packages', template_name)
        out_file = os.path.join(Settings.TEST_SUT_HOME, template_name + '.tgz')
        Npm.pack(folder=template_folder, output_file=out_file)
        if File.exists(out_file):
            app.path = out_file
        else:
            raise IOError("Failed to clone and pack template: " + template_name)

    # Tar local templates in assets folder
    template_name = 'template-min'
    template_folder = os.path.join(Settings.ASSETS_HOME, template_name)
    out_file = os.path.join(Settings.TEST_SUT_HOME, template_name + '.tgz')
    Npm.pack(folder=template_folder, output_file=out_file)


def __get_runtimes():
    """
    Get {N} Runtimes in TEST_SUT_HOME.
    """

    # Copy or download tns-android
    android_package = os.path.join(Settings.TEST_SUT_HOME, 'tns-android.tgz')
    if '.tgz' in Settings.Packages.ANDROID:
        File.copy(src=Settings.Packages.ANDROID, target=android_package)
        Settings.Packages.ANDROID = android_package
    else:
        Npm.download(package=Settings.Packages.ANDROID, output_file=android_package)

    # Copy or download tns-ios
    if Settings.HOST_OS == OSType.OSX:
        ios_package = os.path.join(Settings.TEST_SUT_HOME, 'tns-ios.tgz')
        if '.tgz' in Settings.Packages.IOS:
            File.copy(src=Settings.Packages.IOS, target=ios_package)
            Settings.Packages.IOS = ios_package
        else:
            Npm.download(package=Settings.Packages.IOS, output_file=ios_package)


def __install_ns_cli():
    """
    Install NativeScript CLI locally.
    """

    # Copy NativeScript CLI (if used from local package)
    if '.tgz' in Settings.Packages.NS_CLI:
        cli_package = os.path.join(Settings.TEST_SUT_HOME, 'nativescript.tgz')
        File.copy(src=Settings.Packages.NS_CLI, target=cli_package)
        Settings.Packages.NS_CLI = cli_package

    # Install NativeScript CLI
    output = Npm.install(package=Settings.Packages.NS_CLI, folder=Settings.TEST_RUN_HOME)

    # Verify executable exists after install
    path = os.path.join(Settings.TEST_RUN_HOME, 'node_modules', '.bin', 'tns')
    assert File.exists(path), 'NativeScript executable not found at ' + path
    Settings.Executables.TNS = path

    # Verify installation output
    # noinspection SpellCheckingInspection
    assert 'postinstall.js' in output, 'Post install scripts not executed.'
    assert 'dev-post-install' not in output, 'Dev post install executed on installation.'


def __install_ng_cli():
    """
    Install Angular CLI locally.
    """
    Npm.install(package=Settings.Packages.NG_CLI, folder=Settings.TEST_RUN_HOME)

    # Verify executable exists after install
    path = os.path.join(Settings.TEST_RUN_HOME, 'node_modules', '.bin', 'ng')
    assert File.exists(path), 'Angular CLI executable not found at ' + path
    Settings.Executables.NG = path


def __install_schematics():
    """
    Install NativeScript Schematics locally.
    """
    Npm.install(package=Settings.Packages.NS_SCHEMATICS, folder=Settings.TEST_RUN_HOME)


def prepare(clone_templates=True, install_ng_cli=False, get_preivew_packages=False):
    Log.info('================== Prepare Test Run ==================')
    __cleanup()
    __install_ns_cli()
    __get_runtimes()
    if install_ng_cli:
        __install_ng_cli()
        __install_schematics()
    if clone_templates:
        __get_templates()
    if get_preivew_packages:
        Preview.get_app_packages()

    Log.settings()