NativeScript/apps/automated/src/test-runner.ts

/* tslint:disable */
import * as TKUnit from './tk-unit';
import './ui-test';

import { isAndroid, Device, platformNames, Trace, Button, Frame, StackLayout, Page, TextView, Utils, Color } from '@nativescript/core';
Frame.defaultAnimatedNavigation = false;

export function isRunningOnEmulator(): boolean {
	// These checks are not good enough to be added to modules but they keep unit tests green.

	if (Device.os === platformNames.android) {
		return (
			android.os.Build.FINGERPRINT.indexOf('generic') > -1 ||
			android.os.Build.HARDWARE.toLowerCase() === 'goldfish' ||
			android.os.Build.HARDWARE.toLowerCase() === 'donatello' || // VS Emulator
			android.os.Build.PRODUCT.toLocaleLowerCase().indexOf('sdk') > -1 ||
			android.os.Build.PRODUCT.toLocaleLowerCase().indexOf('emulator') > -1
		); // VS Emulator
	} else if (__APPLE__) {
		return __dirname.search('Simulator') > -1;
	}
}

// Enable running a singleTest group, type the group name here
const singleTest = null;

let allTests = {};

import * as globalsTests from './globals/globals-tests';
allTests['GLOBALS'] = globalsTests;

import * as domNodeTest from './debugger/dom-node-tests';
allTests['DOM-NODE'] = domNodeTest;

import * as platformTests from './platform/platform-tests';
allTests['PLATFORM'] = platformTests;

import * as fsTests from './file-system/file-system-tests';
allTests['FILE-SYSTEM'] = fsTests;

import * as httpTests from './http/http-tests';
import * as xhrTests from './xhr/xhr-tests';
import * as fetchTests from './fetch/fetch-tests';
import * as timerTests from './timer/timer-tests';
import * as profilingTests from './profiling/profiling-tests';

allTests['HTTP'] = httpTests;
allTests['XHR'] = xhrTests;
allTests['FETCH'] = fetchTests;

// don't run these on CI as they are flaky
if (!__CI__) {
	allTests['TIMER'] = timerTests;
	allTests['PROFILING'] = profilingTests;
}

import * as a11yPropertiesTests from './accessibility/accessibility-properties-tests';
allTests['A11Y-PROPERTIES'] = a11yPropertiesTests;

import * as appSettingsTests from './application-settings/application-settings-tests';
allTests['APPLICATION-SETTINGS'] = appSettingsTests;

import * as applicationTests from './application/application-tests';
allTests['APPLICATION'] = applicationTests;

import * as imageSourceTests from './image-source/image-source-tests';
allTests['IMAGE-SOURCE'] = imageSourceTests;

import * as observableArrayTests from './data/observable-array-tests';
allTests['OBSERVABLE-ARRAY'] = observableArrayTests;

import * as virtualArrayTests from './data/virtual-array-tests';
allTests['VIRTUAL-ARRAY'] = virtualArrayTests;

import * as observableTests from './data/observable-tests';
allTests['OBSERVABLE'] = observableTests;

// import * as animationFrameTests from './animation-frame/animation-frame';
// allTests['ANIMATION-FRAME'] = animationFrameTests;

import * as colorTests from './color/color-tests';
allTests['COLOR'] = colorTests;

import * as bindableTests from './ui/core/bindable/bindable-tests';
allTests['BINDABLE'] = bindableTests;

// import * as bindingExpressionTests from './ui/core/bindable/binding-expressions-tests';
// allTests['BINDING-EXPRESSIONS'] = bindingExpressionTests;

import * as xmlParserTests from './xml-parser-tests/xml-parser-tests';
allTests['XML-PARSER'] = xmlParserTests;

import * as formattedStringTests from './text/formatted-string-tests';
allTests['FORMATTEDSTRING'] = formattedStringTests;

import * as fileSystemAccessTests from './file-system-access-tests/file-system-access-tests';
allTests['FILE-SYSTEM-ACCESS'] = fileSystemAccessTests;

import * as qualifierMatcherTests from './name-resolvers-tests/qualifier-matcher-tests';
allTests['QUALIFIER-MATCHER'] = qualifierMatcherTests;

import * as moduleNameResolverTests from './name-resolvers-tests/module-name-resolver-tests';
allTests['MODULE-NAME-RESOLVER'] = moduleNameResolverTests;

import * as weakEventsTests from './ui/core/weak-event-listener/weak-event-listener-tests';
allTests['WEAK-EVENTS'] = weakEventsTests;

import * as traceErrorTests from './trace/trace-error-tests';
allTests['TRACE-ERROR'] = traceErrorTests;

import * as connectivityTests from './connectivity/connectivity-tests';
allTests['CONNECTIVITY'] = connectivityTests;

import * as proxyViewContainerTests from './ui/proxy-view-container/proxy-view-container-tests';
allTests['PROXY-VIEW-CONTAINER'] = proxyViewContainerTests;

import * as scrollViewTests from './ui/scroll-view/scroll-view-tests';
allTests['SCROLL-VIEW'] = scrollViewTests;

import * as actionBarTests from './ui/action-bar/action-bar-tests';
allTests['ACTION-BAR'] = actionBarTests;

// import * as xmlDeclarationTests from './xml-declaration/xml-declaration-tests';
// allTests['XML-DECLARATION'] = xmlDeclarationTests;

import * as dockLayoutTests from './ui/layouts/dock-layout-tests';
allTests['DOCKLAYOUT'] = dockLayoutTests;

import * as wrapLayoutTests from './ui/layouts/wrap-layout-tests';
allTests['WRAPLAYOUT'] = wrapLayoutTests;

import * as absoluteLayoutTests from './ui/layouts/absolute-layout-tests';
allTests['ABSOLUTELAYOUT'] = absoluteLayoutTests;

import * as gridLayoutTests from './ui/layouts/grid-layout-tests';
allTests['GRIDLAYOUT'] = gridLayoutTests;

import * as stackLayoutTests from './ui/layouts/stack-layout-tests';
allTests['STACKLAYOUT'] = stackLayoutTests;

import * as flexBoxLayoutTests from './ui/layouts/flexbox-layout-tests';
allTests['FLEXBOXLAYOUT'] = flexBoxLayoutTests;

import * as safeAreaLayoutTests from './ui/layouts/safe-area-tests';
import * as safeAreaListViewtTests from './ui/list-view/list-view-safe-area-tests';
import * as scrollViewSafeAreaTests from './ui/scroll-view/scroll-view-safe-area-tests';
import * as repeaterSafeAreaTests from './ui/repeater/repeater-safe-area-tests';
import * as webViewSafeAreaTests from './ui/web-view/web-view-safe-area-tests';

if (__APPLE__ && Utils.SDK_VERSION > 10) {
	allTests['SAFEAREALAYOUT'] = safeAreaLayoutTests;
	allTests['SAFEAREA-LISTVIEW'] = safeAreaListViewtTests;
	allTests['SAFEAREA-SCROLL-VIEW'] = scrollViewSafeAreaTests;
	allTests['SAFEAREA-REPEATER'] = repeaterSafeAreaTests;
	allTests['SAFEAREA-WEBVIEW'] = webViewSafeAreaTests;
}

import * as rootViewsCssClassesTests from './ui/styling/root-views-css-classes-tests';
allTests['ROOT-VIEWS-CSS-CLASSES'] = rootViewsCssClassesTests;

import * as stylePropertiesTests from './ui/styling/style-properties-tests';
allTests['STYLE-PROPERTIES'] = stylePropertiesTests;

import * as frameTests from './ui/frame/frame-tests';
allTests['FRAME'] = frameTests;

import * as viewTests from './ui/view/view-tests';
allTests['VIEW'] = viewTests;

import * as viewLayoutChangedEventTests from './ui/view/view-tests-layout-event';
allTests['VIEW-LAYOUT-EVENT'] = viewLayoutChangedEventTests;

import * as styleTests from './ui/styling/style-tests';
allTests['STYLE'] = styleTests;

import * as visualStateTests from './ui/styling/visual-state-tests';
allTests['VISUAL-STATE'] = visualStateTests;

import * as cssKeywordsTests from './ui/styling/css-keywords-tests';
allTests['CSS-KEYWORDS'] = cssKeywordsTests;

import * as valueSourceTests from './ui/styling/value-source-tests';
allTests['VALUE-SOURCE'] = valueSourceTests;

import * as builderTests from './ui/builder/builder-tests';
allTests['BUILDER'] = builderTests;

import * as builderFileQualifierTests from './ui/builder/builder-file-qualifiers-tests';
allTests['BUILDER-QUALIFIERS'] = builderFileQualifierTests;

import * as buttonTests from './ui/button/button-tests';
allTests['BUTTON'] = buttonTests;

import * as labelTests from './ui/label/label-tests';
allTests['LABEL'] = labelTests;

import * as tabViewTests from './ui/tab-view/tab-view-tests';
allTests['TAB-VIEW'] = tabViewTests;

import * as tabViewTestsNew from './ui/tab-view/tab-view-tests-new';
allTests['TAB-VIEW-NEW'] = tabViewTestsNew;

import * as tabViewNavigationTests from './ui/tab-view/tab-view-navigation-tests';
allTests['TAB-VIEW-NAVIGATION'] = tabViewNavigationTests;

import * as imageTests from './ui/image/image-tests';
allTests['IMAGE'] = imageTests;

import * as imageCacheTests from './ui/image-cache/image-cache-tests';
allTests['IMAGE-CACHE'] = imageCacheTests;

import * as sliderTests from './ui/slider/slider-tests';
allTests['SLIDER'] = sliderTests;

import * as switchTests from './ui/switch/switch-tests';
allTests['SWITCH'] = switchTests;

import * as progressTests from './ui/progress/progress-tests';
allTests['PROGRESS'] = progressTests;

import * as placeholderTests from './ui/placeholder/placeholder-tests';
allTests['PLACEHOLDER'] = placeholderTests;

import * as pageTests from './ui/page/page-tests';
allTests['PAGE'] = pageTests;

import * as listViewTests from './ui/list-view/list-view-tests';
allTests['LISTVIEW'] = listViewTests;

import * as activityIndicatorTests from './ui/activity-indicator/activity-indicator-tests';
allTests['ACTIVITY-INDICATOR'] = activityIndicatorTests;

import * as textBaseTests from './ui/text-base/text-base-tests';
allTests['TEXT-BASE'] = textBaseTests;

import * as textFieldTests from './ui/text-field/text-field-tests';
allTests['TEXT-FIELD'] = textFieldTests;

import * as textViewTests from './ui/text-view/text-view-tests';
allTests['TEXT-VIEW'] = textViewTests;

import * as listPickerTests from './ui/list-picker/list-picker-tests';
allTests['LIST-PICKER'] = listPickerTests;

import * as datePickerTests from './ui/date-picker/date-picker-tests';
allTests['DATE-PICKER'] = datePickerTests;

import * as timePickerTests from './ui/time-picker/time-picker-tests';
allTests['TIME-PICKER'] = timePickerTests;

// TODO: followup on 3 assertions here -
// import * as webViewTests from './ui/web-view/web-view-tests';
// allTests['WEB-VIEW'] = webViewTests;

import * as htmlViewTests from './ui/html-view/html-view-tests';
allTests['HTML-VIEW'] = htmlViewTests;

import * as repeaterTests from './ui/repeater/repeater-tests';
allTests['REPEATER'] = repeaterTests;

import * as segmentedBarTests from './ui/segmented-bar/segmented-bar-tests';
allTests['SEGMENTED-BAR'] = segmentedBarTests;

// import * as animationTests from './ui/animation/animation-tests';
// allTests['ANIMATION'] = animationTests;

import * as lifecycle from './ui/lifecycle/lifecycle-tests';
allTests['LIFECYCLE'] = lifecycle;

import * as cssAnimationTests from './ui/animation/css-animation-tests';
allTests['CSS-ANIMATION'] = cssAnimationTests;

import * as transitionTests from './navigation/transition-tests';
allTests['TRANSITIONS'] = transitionTests;

import * as searchBarTests from './ui/search-bar/search-bar-tests';
allTests['SEARCH-BAR'] = searchBarTests;

import * as navigationTests from './navigation/navigation-tests';
allTests['NAVIGATION'] = navigationTests;

// import * as livesyncTests from './livesync/livesync-tests';
// allTests['LIVESYNC'] = livesyncTests;

import * as tabViewRootTests from './ui/tab-view/tab-view-root-tests';
allTests['TAB-VIEW-ROOT'] = tabViewRootTests;

import * as resetRootViewTests from './ui/root-view/reset-root-view-tests';
allTests['RESET-ROOT-VIEW'] = resetRootViewTests;

import * as rootViewTests from './ui/root-view/root-view-tests';
allTests['ROOT-VIEW'] = rootViewTests;

import * as utilsTests from './utils/utils-tests';
allTests['UTILS'] = utilsTests;

if (singleTest != null) {
	const tempTest = allTests[singleTest];
	allTests = {};
	if (tempTest) {
		allTests[singleTest] = tempTest;
	} else {
		console.log('Test does not exist', singleTest);
	}
}

const testsSuitesWithLongDelay = {
	HTTP: 15 * 1000,
};

const testsWithLongDelay = {
	testLocation: 10000,
	testLocationOnce: 10000,
	testLocationOnceMaximumAge: 10000,
	// web-view-tests
	testLoadExistingUrl: 10000 * 5,
	testLoadLocalFile: 10000 * 5,
	testLoadInvalidUrl: 10000,
	testLoadUpperCaseSrc: 10000 * 5,
	test_SettingImageSrc: 30 * 1000,
	test_ChainingAnimations: 30 * 1000,
	test_AnimatingProperties: 30 * 1000,
	test_AnimateBackgroundColor_FromString: 10 * 1000,
};

let startTime;
let running = false;
let testsQueue = new Array<TestInfo>();

function printRunTestStats() {
	let failedTestCount = 0;
	const failedTestInfo = [];
	const slowTests = new Array<string>();

	let allTests = testsQueue.filter((t) => t.isTest);

	allTests.forEach((testCase, i, arr) => {
		let testName = testCase.testName;
		if (!testCase.isPassed) {
			failedTestCount++;
			failedTestInfo.push(testName + ' FAILED: ' + testCase.errorMessage);
		}

		let duration = (testCase.duration / 1000).toFixed(2);
		if (testCase.duration > 500) {
			slowTests.push(`${testName}: ${duration}s`);
		}
	});

	const totalTime = (TKUnit.time() - startTime).toFixed(2);

	let finalMessage = `\n` + `=== ALL TESTS COMPLETE ===\n` + `${allTests.length - failedTestCount} OK, ${failedTestCount} failed\n` + `DURATION: ${totalTime} ms\n` + `=== END OF TESTS ===\n`;

	TKUnit.write(finalMessage, Trace.messageType.info);

	failedTestInfo.forEach((message, i, arr) => {
		TKUnit.write(message, Trace.messageType.error);
		finalMessage += '\n' + message;
	});

	// console.log("test-result.xml:\n" + generateTestFile(allTests));

	// DO NOT CHANGE THE FIRST ROW! Used as an indicator for test run pass detection.
	TKUnit.write(`Tests EOF!`, Trace.messageType.info);

	showReportPage(finalMessage);
}

function generateTestFile(allTests: TestInfo[]) {
	let failedTestCount = 0;

	const testCases = new Array<string>();
	allTests.forEach((testCase, i, arr) => {
		let testName = testCase.testName;
		let duration = (testCase.duration / 1000).toFixed(2);

		testCases.push(`<testcase classname="${Device.os}" name="${testName}" time="${duration}">`);
		if (!testCase.isPassed) {
			failedTestCount++;
			testCases.push(`<failure type="exceptions.AssertionError"><![CDATA[${testCase.errorMessage}]]></failure>`);
		}
		testCases.push(`</testcase>`);
	});

	const totalTime = (TKUnit.time() - startTime).toFixed(2);

	const result = ['<testsuites>', `<testsuite name="NativeScript Tests" timestamp="${new Date()}" hostname="hostname" time="${totalTime}" errors="0" tests="${allTests.length}" skipped="0" failures="${failedTestCount}">`, ...testCases, '</testsuite>', '</testsuites>'].join('');

	return result;
}

function showReportPage(finalMessage: string) {
	const stack = new StackLayout();
	const btn = new Button();
	btn.text = 'Rerun tests';
	btn.on('tap', () => runAll(testsSelector));
	stack.addChild(btn);

	const messageContainer = new TextView();
	messageContainer.editable = messageContainer.autocorrect = false;
	messageContainer.text = finalMessage;
	stack.addChild(messageContainer);

	if (__VISIONOS__) {
		// just helps make the results screen more clear on Vision Pro
		btn.style.fontSize = 22;
		stack.style.padding = 20;
		stack.style.marginTop = 20;
		messageContainer.style.fontSize = 22;
		messageContainer.style.color = new Color('#fff');
	}

	Frame.topmost().navigate({
		create: () => {
			const page = new Page();
			page.content = stack;
			messageContainer.focus();
			if (!__VISIONOS__) {
				page.style.fontSize = 11;
			}
			if (isAndroid) {
				page.on('navigatedTo', () => {
					messageContainer.focus();
					setTimeout(() => messageContainer.dismissSoftInput());
				});
			}

			return page;
		},
		clearHistory: true,
	});
}

function startLog(): void {
	let testsName: string = this.name;
	TKUnit.write('START ' + testsName + ' TESTS.', Trace.messageType.info);
	this.start = TKUnit.time();
}

function log(): void {
	let testsName: string = this.name;
	let duration = TKUnit.time() - this.start;
	TKUnit.write(testsName + ' COMPLETED for ' + duration.toFixed(2) + ' BACKSTACK DEPTH: ' + Frame.topmost().backStack.length, Trace.messageType.info);
}

function getAllProperties(obj: any) {
	let properties = new Set<string>();
	let currentObj = obj;
	do {
		Object.getOwnPropertyNames(currentObj).map((item) => properties.add(item));
	} while ((currentObj = Object.getPrototypeOf(currentObj)) && currentObj !== Object.prototype);
	return [...properties.keys()];
}

let testsSelector: string;
export function runAll(testSelector?: string) {
	testsSelector = testSelector;
	if (running) {
		// TODO: We may schedule pending run requests
		return;
	}

	let singleModuleName, singleTestName;
	if (testSelector) {
		const pair = testSelector.split('.');
		singleModuleName = pair[0];
		if (singleModuleName) {
			if (singleModuleName.length === 0) {
				singleModuleName = undefined;
			} else {
				singleModuleName = singleModuleName.toLowerCase();
			}
		}

		singleTestName = pair[1];
		if (singleTestName) {
			if (singleTestName.length === 0) {
				singleTestName = undefined;
			} else {
				singleTestName = singleTestName.toLowerCase();
			}
		}
	}

	console.log('TESTS: ' + singleModuleName ? singleModuleName : '' + ' ' + singleTestName ? singleTestName : '');

	testsQueue.push(
		new TestInfo(() => {
			running = true;
			startTime = TKUnit.time();
		}),
	);
	for (const name in allTests) {
		if (singleModuleName && singleModuleName !== name.toLowerCase()) {
			continue;
		}

		const testModule = allTests[name];

		const test = testModule.createTestCase ? testModule.createTestCase() : testModule;
		test.name = name;

		testsQueue.push(new TestInfo(startLog, test));

		if (test.setUpModule) {
			testsQueue.push(new TestInfo(test.setUpModule, test));
		}

		for (const testName of getAllProperties(test)) {
			if (singleTestName && singleTestName !== testName.toLowerCase()) {
				continue;
			}

			const testFunction = test[testName];
			if (typeof testFunction === 'function' && testName.substring(0, 4) == 'test') {
				if (test.setUp) {
					testsQueue.push(new TestInfo(test.setUp, test));
				}
				const testTimeout = testsWithLongDelay[testName] || testsSuitesWithLongDelay[name];
				testsQueue.push(new TestInfo(testFunction, test, true, name + '.' + testName, false, null, testTimeout));
				if (test.tearDown) {
					testsQueue.push(new TestInfo(test.tearDown, test));
				}
			}
		}
		if (test.tearDownModule) {
			testsQueue.push(new TestInfo(test.tearDownModule, test));
		}
		testsQueue.push(new TestInfo(log, test));
	}

	testsQueue.push(new TestInfo(printRunTestStats));
	testsQueue.push(
		new TestInfo(function () {
			testsQueue = [];
			running = false;
		}),
	);

	TKUnit.runTests(testsQueue, 0);
}

class TestInfo implements TKUnit.TestInfoEntry {
	testFunc: () => void;
	instance: any;
	isTest: boolean;
	testName: string;
	isPassed: boolean;
	errorMessage: string;
	testTimeout: number;
	duration: number;

	constructor(testFunc, testInstance?: any, isTest?, testName?, isPassed?, errorMessage?, testTimeout?, duration?) {
		this.testFunc = testFunc;
		this.instance = testInstance || null;
		this.isTest = isTest || false;
		this.testName = testName || '';
		this.isPassed = isPassed || false;
		this.errorMessage = errorMessage || '';
		this.testTimeout = testTimeout;
		this.duration = duration;
	}
}