android-plugin-build-service.ts

import { AndroidPluginBuildService } from "../../lib/services/android-plugin-build-service";
import { assert } from "chai";
import {
	INCLUDE_GRADLE_NAME,
	AndroidBuildDefaults,
	PLUGIN_BUILD_DATA_FILENAME,
} from "../../lib/constants";
import { getShortPluginName } from "../../lib/common/helpers";
import * as FsLib from "../../lib/common/file-system";
import * as path from "path";
import * as stubs from "../stubs";
import temp = require("temp");
import {
	IFileSystem,
	ISpawnResult,
	IStringDictionary,
} from "../../lib/common/declarations";
import { IPluginBuildOptions } from "../../lib/definitions/android-plugin-migrator";
import { IInjector } from "../../lib/common/definitions/yok";
import { IFilesHashService } from "../../lib/definitions/files-hash-service";

temp.track();

describe("androidPluginBuildService", () => {
	const pluginName = "my-plugin";
	const shortPluginName = getShortPluginName(pluginName);
	let spawnFromEventCalled = false;
	let fs: IFileSystem;
	let androidBuildPluginService: AndroidPluginBuildService;
	let tempFolder: string;
	let pluginFolder: string;

	function setup(options?: {
		addManifest?: boolean;
		addResFolder?: boolean;
		addAssetsFolder?: boolean;
		addIncludeGradle?: boolean;
		addLegacyIncludeGradle?: boolean;
		addProjectDir?: boolean;
		addProjectRuntime?: boolean;
		latestRuntimeGradleVersion?: string;
		latestRuntimeGradleAndroidVersion?: string;
		projectRuntimeGradleVersion?: string;
		projectRuntimeGradleAndroidVersion?: string;
		addPreviousBuildInfo?: boolean;
		hasChangesInShasums?: boolean;
	}): IPluginBuildOptions {
		options = options || {};
		spawnFromEventCalled = false;
		tempFolder = temp.mkdirSync("androidPluginBuildService-temp");
		pluginFolder = temp.mkdirSync("androidPluginBuildService-plugin");
		createTestInjector(options);
		setupPluginFolders(options);

		return {
			platformsAndroidDirPath: pluginFolder,
			pluginName: pluginName,
			aarOutputDir: pluginFolder,
			tempPluginDirPath: tempFolder,
			projectDir: options.addProjectDir ? pluginFolder : null,
		};
	}

	function createTestInjector(options: {
		addProjectRuntime?: boolean;
		latestRuntimeGradleVersion?: string;
		latestRuntimeGradleAndroidVersion?: string;
		projectRuntimeGradleVersion?: string;
		projectRuntimeGradleAndroidVersion?: string;
		hasChangesInShasums?: boolean;
	}): void {
		const testInjector: IInjector = new stubs.InjectorStub();
		testInjector.register("fs", FsLib.FileSystem);
		testInjector.register("childProcess", {
			spawnFromEvent: async (command: string): Promise<ISpawnResult> => {
				const finalAarName = `${shortPluginName}-release.aar`;
				const aar = path.join(
					tempFolder,
					shortPluginName,
					"build",
					"outputs",
					"aar",
					finalAarName
				);
				fs.writeFile(aar, "");
				spawnFromEventCalled = command.indexOf("gradlew") !== -1;
				return null;
			},
		});
		testInjector.register("packageManager", setupNpm(options));
		testInjector.register("projectData", stubs.ProjectDataStub);
		testInjector.register("filesHashService", <IFilesHashService>{
			generateHashes: async (
				files: string[]
			): Promise<IStringDictionary> => ({}),
			getChanges: async (
				files: string[],
				oldHashes: IStringDictionary
			): Promise<IStringDictionary> => ({}),
			hasChangesInShasums: (
				oldHashes: IStringDictionary,
				newHashes: IStringDictionary
			): boolean => !!options.hasChangesInShasums,
		});

		testInjector.register("watchIgnoreListService", {
			addFileToIgnoreList: () => ({}),
		});

		fs = testInjector.resolve("fs");
		androidBuildPluginService = testInjector.resolve<AndroidPluginBuildService>(
			AndroidPluginBuildService
		);

		// initialize dummy projectData
		const projectData = testInjector.resolve("projectData");
		projectData.initializeProjectData("test-project");
	}

	function setupNpm(options: {
		latestRuntimeGradleVersion?: string;
		latestRuntimeGradleAndroidVersion?: string;
		projectRuntimeGradleVersion?: string;
		projectRuntimeGradleAndroidVersion?: string;
		addProjectRuntime?: boolean;
	}): any {
		return {
			getRegistryPackageData: async (packageName: string): Promise<any> => {
				const result: any = [];
				result["dist-tags"] = { latest: "4.1.2" };
				result.versions = [];
				result.versions["1.0.0"] = {
					name: packageName,
					gradle: {
						version: options.projectRuntimeGradleVersion,
						android: options.projectRuntimeGradleAndroidVersion,
					},
				};
				result.versions["4.1.2"] = {
					name: packageName,
					gradle: {
						version: options.latestRuntimeGradleVersion,
						android: options.latestRuntimeGradleAndroidVersion,
					},
				};

				return result;
			},
			view: async (packageName: string, config: any): Promise<any> => {
				let result: any = null;
				if (config && config.gradle) {
					const packageNameParts = packageName.split("@");
					const packageVersion = packageNameParts[packageNameParts.length - 1];
					switch (packageVersion) {
						case "1.0.0":
							result = {
								version: options.projectRuntimeGradleVersion,
								android: options.projectRuntimeGradleAndroidVersion,
							};
							break;
						case "4.1.2":
							result = {
								version: options.latestRuntimeGradleVersion,
								android: options.latestRuntimeGradleAndroidVersion,
							};
							break;
					}
				}

				if (config && config["dist-tags"]) {
					result = {
						latest: "4.1.2",
					};
				}

				return result;
			},
		};
	}

	function setupPluginFolders(options: {
		addManifest?: boolean;
		addResFolder?: boolean;
		addAssetsFolder?: boolean;
		addIncludeGradle?: boolean;
		addLegacyIncludeGradle?: boolean;
		addPreviousBuildInfo?: boolean;
	}) {
		const validAndroidManifestContent = `<?xml version="1.0" encoding="UTF-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
</manifest>`;
		const validStringsXmlContent = `<?xml version="1.0" encoding="utf-8"?>
<resources>
	<string
		name="string_name"
		>text_string</string>
</resources>`;
		const validIncludeGradleContent =
			`android {` +
			(options.addLegacyIncludeGradle
				? `
	productFlavors {
		"nativescript-pro-ui" {
			dimension "nativescript-pro-ui"
		}
	}`
				: ``) +
			`
}

def supportVersion = project.hasProperty("supportVersion") ? project.supportVersion : "23.3.0"

dependencies {
	compile "com.android.support:appcompat-v7:$supportVersion"
	compile "com.android.support:recyclerview-v7:$supportVersion"
	compile "com.android.support:design:$supportVersion"
}`;

		if (options.addManifest) {
			fs.writeFile(
				path.join(pluginFolder, "AndroidManifest.xml"),
				validAndroidManifestContent
			);
		}

		if (options.addResFolder) {
			const valuesFolder = path.join(pluginFolder, "res", "values");
			fs.createDirectory(valuesFolder);
			fs.writeFile(
				path.join(valuesFolder, "strings.xml"),
				validStringsXmlContent
			);
		}

		if (options.addAssetsFolder) {
			const imagesFolder = path.join(pluginFolder, "assets", "images");
			fs.createDirectory(imagesFolder);
			fs.writeFile(path.join(imagesFolder, "myicon.png"), "123");
		}

		if (options.addLegacyIncludeGradle || options.addIncludeGradle) {
			fs.writeFile(
				path.join(pluginFolder, INCLUDE_GRADLE_NAME),
				validIncludeGradleContent
			);
		}

		if (options.addPreviousBuildInfo) {
			const pluginBuildDir = path.join(tempFolder, "my_plugin");
			fs.ensureDirectoryExists(pluginBuildDir);
			fs.writeFile(path.join(pluginBuildDir, PLUGIN_BUILD_DATA_FILENAME), "{}");
			fs.writeFile(path.join(pluginFolder, "my_plugin.aar"), "{}");
		}
	}

	describe("buildAar", () => {
		it("builds aar when all supported files are in the plugin", async () => {
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				addResFolder: true,
				addAssetsFolder: true,
			});

			await androidBuildPluginService.buildAar(config);

			assert.isTrue(spawnFromEventCalled);
		});

		it("does not build aar when there are no supported files in the plugin", async () => {
			const config: IPluginBuildOptions = setup();

			await androidBuildPluginService.buildAar(config);

			assert.isFalse(spawnFromEventCalled);
		});

		it("builds aar when there are res and assets folders", async () => {
			const config: IPluginBuildOptions = setup({
				addResFolder: true,
				addAssetsFolder: true,
			});

			await androidBuildPluginService.buildAar(config);

			assert.isTrue(spawnFromEventCalled);
		});

		it("builds aar when there is an android manifest", async () => {
			const config: IPluginBuildOptions = setup({
				addManifest: true,
			});

			await androidBuildPluginService.buildAar(config);

			assert.isTrue(spawnFromEventCalled);
		});

		it("builds aar when plugin is already build and source files have changed since last buid", async () => {
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				addPreviousBuildInfo: true,
				hasChangesInShasums: true,
			});

			await androidBuildPluginService.buildAar(config);

			assert.isTrue(spawnFromEventCalled);
		});

		it("does not build aar when plugin is already build and source files have not changed", async () => {
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				addPreviousBuildInfo: true,
			});

			await androidBuildPluginService.buildAar(config);

			assert.isFalse(spawnFromEventCalled);
		});

		it("builds aar with the latest runtime gradle versions when no project dir is specified", async () => {
			const expectedGradleVersion = "4.4";
			const expectedAndroidVersion = "4.5.6";
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				latestRuntimeGradleVersion: expectedGradleVersion,
				latestRuntimeGradleAndroidVersion: expectedAndroidVersion,
			});

			await androidBuildPluginService.buildAar(config);
			const actualAndroidVersion = getGradleAndroidPluginVersion();
			const actualGradleVersion = getGradleVersion();

			assert.equal(actualAndroidVersion, expectedAndroidVersion);
			assert.equal(actualGradleVersion, expectedGradleVersion);
			assert.isTrue(spawnFromEventCalled);
		});

		it("builds aar with the latest runtime gradle versions when a project dir without runtime versions is specified", async () => {
			const expectedGradleVersion = "4.4";
			const expectedAndroidVersion = "4.5.6";
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				addProjectDir: true,
				latestRuntimeGradleVersion: expectedGradleVersion,
				latestRuntimeGradleAndroidVersion: expectedAndroidVersion,
				addProjectRuntime: true,
				projectRuntimeGradleVersion: null,
				projectRuntimeGradleAndroidVersion: null,
			});

			await androidBuildPluginService.buildAar(config);
			const actualAndroidVersion = getGradleAndroidPluginVersion();
			const actualGradleVersion = getGradleVersion();

			assert.equal(actualGradleVersion, expectedGradleVersion);
			assert.equal(actualAndroidVersion, expectedAndroidVersion);
			assert.isTrue(spawnFromEventCalled);
		});

		it("builds aar with the specified runtime gradle versions when the project runtime has gradle versions", async () => {
			const expectedGradleVersion = "4.4.4";
			const expectedAndroidVersion = "5.5.5";
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				addProjectDir: true,
				latestRuntimeGradleVersion: "4.4.4",
				latestRuntimeGradleAndroidVersion: "5.5.5",
				addProjectRuntime: true,
				projectRuntimeGradleVersion: expectedGradleVersion,
				projectRuntimeGradleAndroidVersion: expectedAndroidVersion,
			});

			await androidBuildPluginService.buildAar(config);
			const actualAndroidVersion = getGradleAndroidPluginVersion();
			const actualGradleVersion = getGradleVersion();

			assert.equal(actualGradleVersion, expectedGradleVersion);
			assert.equal(actualAndroidVersion, expectedAndroidVersion);
			assert.isTrue(spawnFromEventCalled);
		});

		it("builds aar with the hardcoded gradle versions when the project runtime and the latest runtime do not have versions specified", async () => {
			const config: IPluginBuildOptions = setup({
				addManifest: true,
				addProjectDir: true,
				latestRuntimeGradleVersion: null,
				latestRuntimeGradleAndroidVersion: null,
				addProjectRuntime: true,
				projectRuntimeGradleVersion: null,
				projectRuntimeGradleAndroidVersion: null,
			});

			await androidBuildPluginService.buildAar(config);
			const actualAndroidVersion = getGradleAndroidPluginVersion();
			const actualGradleVersion = getGradleVersion();

			assert.equal(actualGradleVersion, AndroidBuildDefaults.GradleVersion);
			assert.equal(
				actualAndroidVersion,
				AndroidBuildDefaults.GradleAndroidPluginVersion
			);
			assert.isTrue(spawnFromEventCalled);
		});
	});

	describe("migrateIncludeGradle", () => {
		it("if there is a legacy include.gradle file", async () => {
			const config: IPluginBuildOptions = setup({
				addLegacyIncludeGradle: true,
			});

			const isMigrated = await androidBuildPluginService.migrateIncludeGradle(
				config
			);
			const includeGradleContent = fs.readText(
				path.join(pluginFolder, INCLUDE_GRADLE_NAME).toString()
			);
			const areProductFlavorsRemoved =
				includeGradleContent.indexOf("productFlavors") === -1;

			assert.isTrue(isMigrated);
			assert.isTrue(areProductFlavorsRemoved);
		});

		it("if there is an already migrated include.gradle file", async () => {
			const config: IPluginBuildOptions = setup({
				addIncludeGradle: true,
			});

			const isMigrated = await androidBuildPluginService.migrateIncludeGradle(
				config
			);

			assert.isFalse(isMigrated);
		});
	});

	function getGradleAndroidPluginVersion() {
		const gradleWrappersContent = fs.readText(
			path.join(tempFolder, shortPluginName, "build.gradle")
		);
		const androidVersionRegex = /com\.android\.tools\.build\:gradle\:(.*)\'\r?\n/g;
		const androidVersion = androidVersionRegex.exec(gradleWrappersContent)[1];

		return androidVersion;
	}

	function getGradleVersion() {
		const buildGradleContent = fs.readText(
			path.join(
				tempFolder,
				shortPluginName,
				"gradle",
				"wrapper",
				"gradle-wrapper.properties"
			)
		);
		const gradleVersionRegex = /gradle\-(.*)\-bin\.zip\r?\n/g;
		const gradleVersion = gradleVersionRegex.exec(buildGradleContent)[1];

		return gradleVersion;
	}
});