NativeScript/apps/tests/ui/helper.ts

import view = require("ui/core/view");
import frame = require("ui/frame");
import page = require("ui/page");
import stackLayoutModule = require("ui/layouts/stack-layout");
import button = require("ui/button");
import TKUnit = require("../TKUnit");
import utils = require("utils/utils");
import types = require("utils/types");
import styling = require("ui/styling");
import platform = require("platform");

var DELTA = 0.1;

export var ASYNC = 0.2;
export var MEMORY_ASYNC = 2;

export function do_PageTest(test: (views: Array<view.View>) => void, content: view.View, secondView: view.View, thirdView: view.View) {
    var newPage: page.Page;
    var pageFactory = function (): page.Page {
        newPage = new page.Page();
        newPage.content = content;
        return newPage;
    };

    navigate(pageFactory);

    try {
        test([newPage, content, secondView, thirdView, newPage.actionBar]);
    }
    finally {
        goBack();
    }
}

export function do_PageTest_WithButton(test: (views: Array<view.View>) => void) {
    var newPage: page.Page;
    var btn: button.Button;
    var pageFactory = function (): page.Page {
        newPage = new page.Page();
        btn = new button.Button();
        newPage.content = btn;
        return newPage;
    };

    navigate(pageFactory);

    try {
        test([newPage, btn, newPage.actionBar]);
    }
    finally {
        goBack();
    }
}

export function do_PageTest_WithStackLayout_AndButton(test: (views: Array<view.View>) => void) {
    var newPage: page.Page;
    var stackLayout;
    var btn;
    var pageFactory = function (): page.Page {
        newPage = new page.Page();
        stackLayout = new stackLayoutModule.StackLayout();
        btn = new button.Button();

        stackLayout.addChild(btn);
        newPage.content = stackLayout;
        return newPage;
    };

    navigate(pageFactory);

    try {
        test([newPage, stackLayout, btn, newPage.actionBar]);
    }
    finally {
        goBack();
    }
}

export function do_PageTest_WithStackLayout_AndButton_NavigatedBack(test: (views: Array<view.View>) => void,
    assert: (views: Array<view.View>) => void) {

    var newPage: page.Page;
    var stackLayout;
    var btn;
    var pageFactory = function (): page.Page {
        newPage = new page.Page();
        stackLayout = new stackLayoutModule.StackLayout();
        btn = new button.Button();
        stackLayout.addChild(btn);
        newPage.content = stackLayout;
        return newPage;
    };

    navigate(pageFactory);

    try {
        test([newPage, stackLayout, btn, newPage.actionBar]);
    }
    finally {
        goBack();
    }

    try {
        assert([newPage, stackLayout, btn, newPage.actionBar]);
    }
    finally {
        // wait to ensure asynchronous navigation
        TKUnit.wait(ASYNC);
    }
}

export function assertViewColor(testView: view.View, hexColor: string, valueSource?: number) {
    TKUnit.assert(testView.style.color, "Color property not applied correctly. Style value is not defined.");
    TKUnit.assertEqual(testView.style.color.hex, hexColor, "color property");

    if (types.isDefined(valueSource)) {
        TKUnit.assertEqual(testView.style._getValueSource(styling.properties.colorProperty), valueSource, "valueSource");
    }
}

export function assertViewBackgroundColor(testView: view.View, hexColor: string) {
    TKUnit.assert(testView.style.backgroundColor, "Background color property not applied correctly. Style value is not defined.");
    TKUnit.assertEqual(testView.style.backgroundColor.hex, hexColor, "backgroundColor property");
}

//export function buildUIAndRunTest(controlToTest, testFunction, pageCss?, testDelay?) {
export function buildUIAndRunTest(controlToTest, testFunction, pageCss?) {
    var newPage: page.Page;
    var pageFactory = function (): page.Page {
        newPage = new page.Page();
        newPage.content = controlToTest;
        if (pageCss) {
            newPage.css = pageCss;
        }
        return newPage;
    };

    navigate(pageFactory);
    TKUnit.assert(newPage.isLoaded, "The page should be loaded here.");
    try {
        testFunction([controlToTest, newPage]);
    }
    finally {
        goBack();
    }
}

export function navigateToModuleAndRunTest(moduleName, context, testFunction) {
    navigateToModule(moduleName, context);
    try {
        testFunction(frame.topmost().currentPage);
    }
    finally {
        goBack();
    }
}

export function buildUIWithWeakRefAndInteract<T extends view.View>(createFunc: () => T, interactWithViewFunc?: (view: T) => void, done?) {
    var newPage: page.Page;
    var testFinished = false;
    var pageFactory = function (): page.Page {
        newPage = new page.Page();
        var sp = new stackLayoutModule.StackLayout();
        newPage.content = sp;
        var loaded = false;

        newPage.on("loaded", () => {
            loaded = true;
            var weakRef = new WeakRef(createFunc());
            try {
                sp.addChild(weakRef.get());

                if (interactWithViewFunc) {
                    interactWithViewFunc(weakRef.get());
                }

                sp.removeChild(weakRef.get());
                if (newPage.ios) {
                    /* tslint:disable:no-unused-expression */
                    // Could cause GC on the next call.
                    // NOTE: Don't replace this with forceGC();
                    new ArrayBuffer(4 * 1024 * 1024);
                }
                utils.GC();

                TKUnit.waitUntilReady(() => { return weakRef.get() ? !(weakRef.get().isLoaded) : true; }, MEMORY_ASYNC);
                TKUnit.assert(!weakRef.get(), weakRef.get() + " leaked!");
                testFinished = true;
            }
            catch (e) {
                done(e);
            }
        });

        return newPage;
    };

    try {
        navigate(pageFactory);
        TKUnit.waitUntilReady(() => { return testFinished; }, MEMORY_ASYNC);
    }
    finally {
        goBack();
        done(null);
    }
}

export function navigate(pageFactory: () => page.Page, navigationContext?: any) {
    var currentPage = frame.topmost().currentPage;
    frame.topmost().navigate({ create: pageFactory, animated: false, context: navigationContext });
    TKUnit.waitUntilReady(() => { return frame.topmost().currentPage !== currentPage && frame.topmost().currentPage.isLoaded && !currentPage.isLoaded; });
}

export function navigateToModule(moduleName: string, context?: any) {
    var currentPage = frame.topmost().currentPage;
    frame.topmost().navigate({ moduleName: moduleName, context: context, animated: false });
    TKUnit.waitUntilReady(() => { return frame.topmost().currentPage !== currentPage && frame.topmost().currentPage.isLoaded && !currentPage.isLoaded; });
}

export function navigateWithEntry(navigationEntry: frame.NavigationEntry) {
    var currentPage = frame.topmost().currentPage;
    frame.topmost().navigate(navigationEntry);
    TKUnit.waitUntilReady(() => { return frame.topmost().currentPage !== currentPage && frame.topmost().currentPage.isLoaded && !currentPage.isLoaded; });
}

export function goBack(): void {
    var currentPage = frame.topmost().currentPage;
    frame.topmost().goBack();
    TKUnit.waitUntilReady(() => { return frame.topmost().currentPage !== currentPage && frame.topmost().currentPage.isLoaded && !currentPage.isLoaded; });
}

export function assertAreClose(actual: number, expected: number, message: string): void {
    var density = utils.layout.getDisplayDensity();
    var delta = Math.floor(density) !== density ? 1.1 : DELTA;

    TKUnit.assertAreClose(actual, expected, delta, message);
}

export function forceGC() {
    if (platform.device.os === platform.platformNames.ios) {
        /* tslint:disable:no-unused-expression */
        // Could cause GC on the next call.
        new ArrayBuffer(4 * 1024 * 1024);
        TKUnit.wait(ASYNC);
    }
    utils.GC();
}