Merge pull request #4418 from NativeScript/tachev/fix-testing-deps

feat: keep the unit testing dependencies up-to-date and stable

Author: Dimitar Tachev

.gitignore

@@ -79,3 +79,4 @@ lib/common/xunit.xml
 lib/common/test-reports.xml
 !lib/common/test-scripts/**
 !lib/common/scripts/**
+config/test-deps-versions-generated.json

Gruntfile.js

@@ -1,6 +1,8 @@
 const childProcess = require("child_process");
 const EOL = require("os").EOL;
+const path = require("path");
 const now = new Date().toISOString();
+const latestVersion = require('latest-version');
 
 const ENVIRONMENTS = {
 	live: "live",
@@ -205,9 +207,14 @@ module.exports = function (grunt) {
 	});
 
 	grunt.registerTask("test", ["ts:devall", "shell:npm_test"]);
+
+	registerTestingDependenciesTasks(grunt);
+
 	grunt.registerTask("prepare", [
 		"clean",
 		"ts:release_build",
+		"generate_unit_testing_dependencies",
+		"verify_unit_testing_dependencies",
 		"shell:npm_test",
 
 		"set_live_ga_id",
@@ -230,6 +237,30 @@ module.exports = function (grunt) {
 	grunt.registerTask("lint", ["tslint:build"]);
 	grunt.registerTask("all", ["clean", "test", "lint"]);
 	grunt.registerTask("rebuild", ["clean", "ts:devlib"]);
-	grunt.registerTask("default", "ts:devlib");
+	grunt.registerTask("default", ["ts:devlib", "generate_unit_testing_dependencies"]);
 	grunt.registerTask("docs-jekyll", ['template']);
 };
+
+function registerTestingDependenciesTasks(grunt) {
+	const configsBasePath = path.join(__dirname, "config");
+	const generatedVersionFilePath = path.join(configsBasePath, "test-deps-versions-generated.json");
+
+	grunt.registerTask("generate_unit_testing_dependencies", async function () {
+		var done = this.async();
+		const dependenciesVersions = {};
+		const testDependencies = grunt.file.readJSON(path.join(configsBasePath, "test-dependencies.json"));
+		for (var dependency of testDependencies) {
+			const dependencyVersion = dependency.version || await latestVersion(dependency.name);
+			dependenciesVersions[dependency.name] = dependencyVersion;
+		}
+		grunt.file.write(generatedVersionFilePath, JSON.stringify(dependenciesVersions));
+		done();
+	});
+
+	grunt.registerTask("verify_unit_testing_dependencies", function () {
+		if (!grunt.file.exists(generatedVersionFilePath)) {
+			throw new Error("Unit testing dependencies are not configured.");
+		}
+	});
+}
+

config/test-dependencies.json

@@ -0,0 +1,28 @@
+[
+    {
+        "name": "karma"
+    },
+    {
+        "name": "karma-nativescript-launcher"
+    },
+    {
+        "name": "mocha",
+        "framework": "mocha"
+    },
+    {
+        "name": "karma-mocha",
+        "framework": "mocha"
+    },
+    {
+        "name": "karma-chai",
+        "framework": "mocha"
+    },
+    {
+        "name": "karma-jasmine",
+        "framework": "jasmine"
+    },
+    {
+        "name": "karma-qunit",
+        "framework": "qunit"
+    }
+]

lib/bootstrap.ts

@@ -187,5 +187,6 @@ $injector.require("hmrStatusService", "./services/hmr-status-service");
 
 $injector.require("pacoteService", "./services/pacote-service");
 $injector.require("qrCodeTerminalService", "./services/qr-code-terminal-service");
+$injector.require("testInitializationService", "./services/test-initialization-service");
 
 $injector.require("networkConnectivityValidator", "./helpers/network-connectivity-validator");

lib/commands/test-init.ts

@@ -5,10 +5,6 @@ import { fromWindowsRelativePathToUnix } from '../common/helpers';
 class TestInitCommand implements ICommand {
 	public allowedParameters: ICommandParameter[] = [];
 
-	private frameworkDependencies: IDictionary<string[]> = {
-		mocha: ['karma-chai', 'mocha'],
-	};
-
 	private karmaConfigAdditionalFrameworks: IDictionary<string[]> = {
 		mocha: ['chai']
 	};
@@ -21,7 +17,8 @@ class TestInitCommand implements ICommand {
 		private $fs: IFileSystem,
 		private $resources: IResourceLoader,
 		private $pluginsService: IPluginsService,
-		private $logger: ILogger) {
+		private $logger: ILogger,
+		private $testInitializationService: ITestInitializationService) {
 		this.$projectData.initializeProjectData();
 	}
 
@@ -34,28 +31,25 @@ class TestInitCommand implements ICommand {
 			this.$errors.fail(`Unknown or unsupported unit testing framework: ${frameworkToInstall}`);
 		}
 
-		const dependencies = this.frameworkDependencies[frameworkToInstall] || [];
-		const modulesToInstall: IDependencyInformation[] = [
-			{
-				name: 'karma',
-				// Hardcode the version unitl https://github.com/karma-runner/karma/issues/3052 is fixed
-				version: "2.0.2"
-			},
-			{
-				name: `karma-${frameworkToInstall}`
-			},
-			{
-				name: 'karma-nativescript-launcher'
-			}
-		];
+		let modulesToInstall: IDependencyInformation[] = [];
+		try {
+			const dependencies = this.$testInitializationService.getDependencies(frameworkToInstall);
+			const dependenciesVersions = this.$testInitializationService.getDependenciesVersions();
+			modulesToInstall = dependencies.map(dependency => {
+				const dependencyVersion = dependenciesVersions[dependency];
+				if (!dependencyVersion) {
+					this.$errors.failWithoutHelp(`'${dependency}' is not a registered dependency.`);
+				}
 
-		modulesToInstall.push(...dependencies.map(f => ({ name: f })));
+				return { name: dependency, version: dependencyVersion };
+			});
+		} catch (err) {
+			this.$errors.failWithoutHelp(`Unable to install the unit testing dependencies. Error: '${err.message}'`);
+		}
 
 		for (const mod of modulesToInstall) {
 			let moduleToInstall = mod.name;
-			if (mod.version) {
-				moduleToInstall += `@${mod.version}`;
-			}
+			moduleToInstall += `@${mod.version}`;
 			await this.$packageManager.install(moduleToInstall, projectDir, {
 				'save-dev': true,
 				'save-exact': true,

lib/definitions/project.d.ts

@@ -475,6 +475,11 @@ interface ITestExecutionService {
 	canStartKarmaServer(projectData: IProjectData): Promise<boolean>;
 }
 
+interface ITestInitializationService {
+	getDependencies(framework: string): string[];
+	getDependenciesVersions(): IDictionary<string>;
+}
+
 /**
  * Describes a service used to facilitate communication with CocoaPods
  */

lib/services/test-initialization-service.ts

@@ -0,0 +1,29 @@
+import * as path from "path";
+import { cache } from "../common/decorators";
+
+export class TestInitializationService implements ITestInitializationService {
+	private configsPath = path.join(__dirname, "..", "..", "config");
+
+	constructor(private $fs: IFileSystem) { }
+
+	@cache()
+	public getDependencies(selectedFramework: string): string[] {
+		const dependenciesPath = path.join(this.configsPath, "test-dependencies.json");
+		const allDependencies: { name: string, framework: string }[] = this.$fs.readJson(dependenciesPath);
+		const targetFrameworkDependencies: string[] = allDependencies
+			.filter(dependency => !dependency.framework || dependency.framework === selectedFramework)
+			.map(dependency => dependency.name);
+
+		return targetFrameworkDependencies;
+	}
+
+	@cache()
+	public getDependenciesVersions(): IDictionary<string> {
+		const dependenciesVersionsPath = path.join(this.configsPath, "test-deps-versions-generated.json");
+		const dependenciesVersions = this.$fs.readJson(dependenciesVersionsPath);
+
+		return dependenciesVersions;
+	}
+}
+
+$injector.register("testInitializationService", TestInitializationService);