test: add a few tests for the interactive app creation

Author: DimitarTachev

test/project-commands.ts

@@ -1,20 +1,31 @@
 import { Yok } from "../lib/common/yok";
 import * as stubs from "./stubs";
 import { CreateProjectCommand } from "../lib/commands/create-project";
-import { StringParameterBuilder } from "../lib/common/command-params";
+import { StringCommandParameter } from "../lib/common/command-params";
+import helpers = require("../lib/common/helpers");
 import * as constants from "../lib/constants";
 import { assert } from "chai";
+import { PrompterStub } from "./stubs";
+
+const NgFlavor = "Angular";
+const VueFlavor = "Vue.js";
+const TsFlavor = "Plain TypeScript";
+const JsFlavor = "Plain JavaScript";
 
 let selectedTemplateName: string;
 let isProjectCreated: boolean;
+let createProjectCalledWithForce: boolean;
+let validateProjectCallsCount: number;
 const dummyArgs = ["dummyArgsString"];
 
 class ProjectServiceMock implements IProjectService {
-	async validateProjectName(opts: { projectName: string, force: boolean, pathToProject: string }) : Promise<string> {
+	async validateProjectName(opts: { projectName: string, force: boolean, pathToProject: string }): Promise<string> {
+		validateProjectCallsCount++;
 		return null;
 	}
 
 	async createProject(projectOptions: IProjectSettings): Promise<ICreateProjectData> {
+		createProjectCalledWithForce = projectOptions.force;
 		selectedTemplateName = projectOptions.template;
 		isProjectCreated = true;
 		return null;
@@ -45,7 +56,8 @@ function createTestInjector() {
 		template: undefined
 	});
 	testInjector.register("createCommand", CreateProjectCommand);
-	testInjector.register("stringParameterBuilder", StringParameterBuilder);
+	testInjector.register("stringParameter", StringCommandParameter);
+	testInjector.register("prompter", PrompterStub);
 
 	return testInjector;
 }
@@ -55,9 +67,34 @@ describe("Project commands tests", () => {
 	let options: IOptions;
 	let createProjectCommand: ICommand;
 
+	function setupAnswers(opts: {
+		projectNameAnswer?: string,
+		flavorAnswer?: string,
+		templateAnswer?: string,
+	}) {
+		const prompterStub = <stubs.PrompterStub>testInjector.resolve("$prompter");
+		const choices: IDictionary<string> = {};
+		if (opts.projectNameAnswer) {
+			choices["First, what will be the name of your app?"] = opts.projectNameAnswer;
+		}
+		if (opts.flavorAnswer) {
+			choices[opts.projectNameAnswer ? "Next" : "First" + ", which flavor would you like to use?"] = opts.flavorAnswer;
+		}
+		if (opts.templateAnswer) {
+			choices[opts.projectNameAnswer ? "Finally" : "Next" + ", which template would you like to start from?"] = opts.templateAnswer;
+		}
+
+		prompterStub.expect({
+			choices
+		});
+	}
+
 	beforeEach(() => {
 		testInjector = createTestInjector();
+		helpers.isInteractive = () => true;
 		isProjectCreated = false;
+		validateProjectCallsCount = 0;
+		createProjectCalledWithForce = false;
 		selectedTemplateName = undefined;
 		options = testInjector.resolve("$options");
 		createProjectCommand = testInjector.resolve("$createCommand");
@@ -70,6 +107,8 @@ describe("Project commands tests", () => {
 			await createProjectCommand.execute(dummyArgs);
 
 			assert.isTrue(isProjectCreated);
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
 		it("should not fail when using only --tsc.", async () => {
@@ -78,6 +117,8 @@ describe("Project commands tests", () => {
 			await createProjectCommand.execute(dummyArgs);
 
 			assert.isTrue(isProjectCreated);
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
 		it("should not fail when using only --template.", async () => {
@@ -86,6 +127,8 @@ describe("Project commands tests", () => {
 			await createProjectCommand.execute(dummyArgs);
 
 			assert.isTrue(isProjectCreated);
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
 		it("should set the template name correctly when used --ng.", async () => {
@@ -94,6 +137,8 @@ describe("Project commands tests", () => {
 			await createProjectCommand.execute(dummyArgs);
 
 			assert.deepEqual(selectedTemplateName, constants.ANGULAR_NAME);
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
 		it("should set the template name correctly when used --tsc.", async () => {
@@ -102,36 +147,60 @@ describe("Project commands tests", () => {
 			await createProjectCommand.execute(dummyArgs);
 
 			assert.deepEqual(selectedTemplateName, constants.TYPESCRIPT_NAME);
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
+		});
+
+		it("should fail when --ng and --template are used simultaneously.", async () => {
+			options.ng = true;
+			options.template = "ng";
+
+			await assert.isRejected(createProjectCommand.execute(dummyArgs));
+		});
+
+		it("should fail when --tsc and --template are used simultaneously.", async () => {
+			options.tsc = true;
+			options.template = "tsc";
+
+			await assert.isRejected(createProjectCommand.execute(dummyArgs));
 		});
 
-		it("should not set the template name when --ng is not used.", async () => {
-			options.ng = false;
+		it("should ask for a template when ng flavor is selected.", async () => {
+			setupAnswers({ flavorAnswer: NgFlavor, templateAnswer: "Hello World" });
 
 			await createProjectCommand.execute(dummyArgs);
 
-			assert.isUndefined(selectedTemplateName);
+			assert.deepEqual(selectedTemplateName, "tns-template-hello-world-ng");
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
-		it("should not set the template name when --tsc is not used.", async () => {
-			options.tsc = false;
+		it("should ask for a template when ts flavor is selected.", async () => {
+			setupAnswers({ flavorAnswer: TsFlavor, templateAnswer:  "Hello World" });
 
 			await createProjectCommand.execute(dummyArgs);
 
-			assert.isUndefined(selectedTemplateName);
+			assert.deepEqual(selectedTemplateName, "tns-template-hello-world-ts");
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
-		it("should fail when --ng and --template are used simultaneously.", async () => {
-			options.ng = true;
-			options.template = "ng";
+		it("should ask for a template when js flavor is selected.", async () => {
+			setupAnswers({ flavorAnswer: JsFlavor, templateAnswer:  "Hello World" });
 
-			await assert.isRejected(createProjectCommand.execute(dummyArgs));
+			await createProjectCommand.execute(dummyArgs);
+
+			assert.deepEqual(selectedTemplateName, "tns-template-hello-world");
+			assert.equal(validateProjectCallsCount, 1);
+			assert.isTrue(createProjectCalledWithForce);
 		});
 
-		it("should fail when --tsc and --template are used simultaneously.", async () => {
-			options.tsc = true;
-			options.template = "tsc";
+		it("should select the default vue template when the vue flavor is selected.", async () => {
+			setupAnswers({ flavorAnswer: VueFlavor });
 
-			await assert.isRejected(createProjectCommand.execute(dummyArgs));
+			await createProjectCommand.execute(dummyArgs);
+
+			assert.deepEqual(selectedTemplateName, "https://github.com/NativeScript/template-blank-vue/tarball/0.9.0");
 		});
 	});
 });

test/stubs.ts

@@ -514,11 +514,13 @@ export class LockFile {
 export class PrompterStub implements IPrompter {
 	private strings: IDictionary<string> = {};
 	private passwords: IDictionary<string> = {};
+	private choices: IDictionary<string> = {};
 
-	expect(options?: { strings: IDictionary<string>, passwords: IDictionary<string> }) {
+	expect(options?: { strings?: IDictionary<string>, passwords?: IDictionary<string>, choices?: IDictionary<string> }) {
 		if (options) {
 			this.strings = options.strings || this.strings;
 			this.passwords = options.passwords || this.passwords;
+			this.choices = options.choices || this.choices;
 		}
 	}
 
@@ -540,8 +542,11 @@ export class PrompterStub implements IPrompter {
 	async promptForChoice(promptMessage: string, choices: any[]): Promise<string> {
 		throw unreachable();
 	}
-	async promptForDetailedChoice(promptMessage: string, choices: any[]): Promise<string> {
-		throw unreachable();
+	async promptForDetailedChoice(question: string, choices: any[]): Promise<string> {
+		chai.assert.ok(question in this.choices, `PrompterStub didn't expect to be asked: ${question}`);
+		const result = this.choices[question];
+		delete this.choices[question];
+		return result;
 	}
 	async confirm(prompt: string, defaultAction?: () => boolean): Promise<boolean> {
 		throw unreachable();