test-execution-service.ts

import * as constants from "../constants";
import * as path from 'path';
import * as os from 'os';

interface IKarmaConfigOptions {
	debugBrk: boolean;
	debugTransport: boolean;
}

export class TestExecutionService implements ITestExecutionService {
	private static CONFIG_FILE_NAME = `node_modules/${constants.TEST_RUNNER_NAME}/config.js`;
	private static SOCKETIO_JS_FILE_NAME = `node_modules/${constants.TEST_RUNNER_NAME}/socket.io.js`;

	constructor(private $platformService: IPlatformService,
		private $liveSyncService: ILiveSyncService,
		private $httpClient: Server.IHttpClient,
		private $config: IConfiguration,
		private $logger: ILogger,
		private $fs: IFileSystem,
		private $options: IOptions,
		private $pluginsService: IPluginsService,
		private $devicesService: Mobile.IDevicesService,
		private $childProcess: IChildProcess) {
	}

	public platform: string;

	public async startKarmaServer(platform: string, projectData: IProjectData, projectFilesConfig: IProjectFilesConfig): Promise<void> {
		platform = platform.toLowerCase();
		this.platform = platform;

		// We need the dependencies installed here, so we can start the Karma server.
		await this.$pluginsService.ensureAllDependenciesAreInstalled(projectData);

		const projectDir = projectData.projectDir;
		await this.$devicesService.initialize({
			platform: platform,
			deviceId: this.$options.device,
			emulator: this.$options.emulator
		});

		const karmaConfig = this.getKarmaConfiguration(platform, projectData),
			// In case you want to debug the unit test runner, add "--inspect-brk=<port>" as a first element in the array of args.
			karmaRunner = this.$childProcess.spawn(process.execPath, [path.join(__dirname, "karma-execution.js")], { stdio: ["inherit", "inherit", "inherit", "ipc"] }),
			launchKarmaTests = async (karmaData: any) => {
				this.$logger.trace("## Unit-testing: Parent process received message", karmaData);
				let port: string;
				if (karmaData.url) {
					port = karmaData.url.port;
					const socketIoJsUrl = `http://${karmaData.url.host}/socket.io/socket.io.js`;
					const socketIoJs = (await this.$httpClient.httpRequest(socketIoJsUrl)).body;
					this.$fs.writeFile(path.join(projectDir, TestExecutionService.SOCKETIO_JS_FILE_NAME), socketIoJs);
				}

				if (karmaData.launcherConfig) {
					const configOptions: IKarmaConfigOptions = JSON.parse(karmaData.launcherConfig);
					const configJs = this.generateConfig(port, configOptions);
					this.$fs.writeFile(path.join(projectDir, TestExecutionService.CONFIG_FILE_NAME), configJs);
				}

				// Prepare the project AFTER the TestExecutionService.CONFIG_FILE_NAME file is created in node_modules
				// so it will be sent to device.

				let devices = [];
				if (this.$options.debugBrk) {
					const selectedDeviceForDebug = await this.$devicesService.pickSingleDevice({
						onlyEmulators: this.$options.emulator,
						onlyDevices: this.$options.forDevice,
						deviceId: this.$options.device
					});
					devices = [selectedDeviceForDebug];
					// const debugData = this.getDebugData(platform, projectData, deployOptions, { device: selectedDeviceForDebug.deviceInfo.identifier });
					// await this.$debugService.debug(debugData, this.$options);
				} else {
					devices = this.$devicesService.getDeviceInstances();
				}

				// Now let's take data for each device:
				const platformLowerCase = this.platform && this.platform.toLowerCase();
				const deviceDescriptors: ILiveSyncDeviceInfo[] = devices.filter(d => !platformLowerCase || d.deviceInfo.platform.toLowerCase() === platformLowerCase)
					.map(d => {
						const info: ILiveSyncDeviceInfo = {
							identifier: d.deviceInfo.identifier,
							buildAction: async (): Promise<string> => {
								const buildConfig: IBuildConfig = {
									buildForDevice: !d.isEmulator,
									iCloudContainerEnvironment: this.$options.iCloudContainerEnvironment,
									projectDir: this.$options.path,
									clean: this.$options.clean,
									teamId: this.$options.teamId,
									device: this.$options.device,
									provision: this.$options.provision,
									release: this.$options.release,
									keyStoreAlias: this.$options.keyStoreAlias,
									keyStorePath: this.$options.keyStorePath,
									keyStoreAliasPassword: this.$options.keyStoreAliasPassword,
									keyStorePassword: this.$options.keyStorePassword
								};

								await this.$platformService.buildPlatform(d.deviceInfo.platform, buildConfig, projectData);
								const pathToBuildResult = await this.$platformService.lastOutputPath(d.deviceInfo.platform, buildConfig, projectData);
								return pathToBuildResult;
							},
							debugOptions: this.$options,
							debugggingEnabled: this.$options.debugBrk
						};

						return info;
					});

				const env = this.$options.env || {};
				env.unitTesting = !!this.$options.bundle;

				const liveSyncInfo: ILiveSyncInfo = {
					projectDir: projectData.projectDir,
					skipWatcher: !this.$options.watch || this.$options.justlaunch,
					watchAllFiles: this.$options.syncAllFiles,
					bundle: !!this.$options.bundle,
					release: this.$options.release,
					env,
					timeout: this.$options.timeout,
					useHotModuleReload: this.$options.hmr
				};

				await this.$liveSyncService.liveSync(deviceDescriptors, liveSyncInfo);
			};

		karmaRunner.on("message",  (karmaData: any) => {
			this.$logger.trace(`The received message from karma is: `, karmaData);
			if (!karmaData.launcherConfig && !karmaData.url) {
				return;
			}

			launchKarmaTests(karmaData)
				.catch((result) => {
					this.$logger.error(result);
					process.exit(ErrorCodes.KARMA_FAIL);
				});
		});

		return new Promise<void>((resolve, reject) => {
			karmaRunner.on("exit", (exitCode: number) => {
				if (exitCode !== 0) {
					//End our process with a non-zero exit code
					const testError = <any>new Error("Test run failed.");
					testError.suppressCommandHelp = true;
					reject(testError);
				} else {
					resolve();
				}
			});

			karmaRunner.send({ karmaConfig: karmaConfig });
		});
	}

	public async canStartKarmaServer(projectData: IProjectData): Promise<boolean> {
		let canStartKarmaServer = true;
		const requiredDependencies = ["karma", "nativescript-unit-test-runner"];
		_.each(requiredDependencies, (dep) => {
			if (!projectData.dependencies[dep] && !projectData.devDependencies[dep]) {
				canStartKarmaServer = false;
				return;
			}
		});

		return canStartKarmaServer;
	}

	allowedParameters: ICommandParameter[] = [];

	private generateConfig(port: string, options: any): string {
		const nics = os.networkInterfaces();
		const ips = Object.keys(nics)
			.map(nicName => nics[nicName].filter((binding: any) => binding.family === 'IPv4')[0])
			.filter(binding => binding)
			.map(binding => binding.address);

		const config = {
			port,
			ips,
			options,
		};

		return 'module.exports = ' + JSON.stringify(config);
	}

	private getKarmaConfiguration(platform: string, projectData: IProjectData): any {
		const karmaConfig: any = {
			browsers: [platform],
			configFile: path.join(projectData.projectDir, 'karma.conf.js'),
			_NS: {
				log: this.$logger.getLevel(),
				path: this.$options.path,
				tns: process.argv[1],
				node: process.execPath,
				options: {
					debugTransport: this.$options.debugTransport,
					debugBrk: this.$options.debugBrk,
					watch: !!this.$options.watch,
					bundle: !!this.$options.bundle,
					appDirectoryRelativePath: projectData.getAppDirectoryRelativePath()
				}
			},
		};

		if (this.$config.DEBUG || this.$logger.getLevel() === 'TRACE') {
			karmaConfig.logLevel = 'DEBUG';
		}

		if (!this.$options.watch) {
			// Setting singleRun to true will automatically start the tests when new browser (device in our case) is registered in karma.
			karmaConfig.singleRun = true;
		}

		if (this.$options.debugBrk) {
			karmaConfig.browserNoActivityTimeout = 1000000000;
		}

		karmaConfig.projectDir = projectData.projectDir;
		karmaConfig.bundle = this.$options.bundle;
		karmaConfig.platform = platform.toLowerCase();
		this.$logger.debug(JSON.stringify(karmaConfig, null, 4));

		return karmaConfig;
	}
}
$injector.register('testExecutionService', TestExecutionService);