Merge pull request #176 from RobertReaves/feature-lkId

Added support for adding a LK id

Author: elijahmanor

specs/workflows/dev.spec.js

@@ -1,20 +1,32 @@
-const resetWorkflow = require("../../src/workflows/dev");
-const run = require("../../src/workflows/steps");
-
 describe("dev workflow", () => {
-	it("should have all of the required steps", () => {
-		expect(resetWorkflow).toEqual([
-			run.fetchUpstream,
-			run.gitCreateBranchOrigin,
-			run.checkoutBaseBranch,
-			run.rebaseUpstreamBaseBranch,
-			run.checkoutWorkingBranch,
-			run.gitCreateBranchUpstream,
-			run.githubUpstream,
-			run.githubOrigin,
-			run.updatePullRequestTitle,
-			run.updatePullRequestBody,
-			run.createGithubPullRequestAganistBranch
-		]);
+	let resetWorkflow;
+	describe("has LK scope", () => {
+		beforeEach(() => {
+			jest.resetModules();
+			jest.doMock("../../src/utils", () => ({
+				hasLkScope: jest.fn(() => true)
+			}));
+
+			resetWorkflow = require("../../src/workflows/dev");
+		});
+
+		it("should have all of the required steps", () => {
+			expect(resetWorkflow.length).toEqual(12);
+		});
+	});
+
+	describe("doesn't have LK scope", () => {
+		beforeEach(() => {
+			jest.resetModules();
+			jest.doMock("../../src/utils", () => ({
+				hasLkScope: jest.fn(() => false)
+			}));
+
+			resetWorkflow = require("../../src/workflows/dev");
+		});
+
+		it("should have all of the required steps", () => {
+			expect(resetWorkflow.length).toEqual(11);
+		});
 	});
 });

specs/workflows/steps/index.spec.js

@@ -3204,6 +3204,23 @@ describe("shared workflow steps", () => {
 			});
 		});
 
+		describe("has LK id", () => {
+			it("should call update title with LK id", () => {
+				state.lkId = "123456789";
+				return run
+					.createGithubPullRequestAganistBranch(state)
+					.then(() => {
+						expect(createPullRequest).toHaveBeenCalledWith({
+							base: "feature-branch",
+							body: "This is my pull request body",
+							head: "someone-awesome-origin:feature-branch",
+							title:
+								"This is my pull request title (LK:123456789)"
+						});
+					});
+			});
+		});
+
 		it("should create a new GitHub client instance given a valid auth token", () => {
 			return run.createGithubPullRequestAganistBranch(state).then(() => {
 				expect(GitHub).toHaveBeenCalledTimes(1);
@@ -4595,6 +4612,65 @@ feature-last-branch`)
 		});
 	});
 
+	describe("addLKId", () => {
+		describe("when user has LK id", () => {
+			beforeEach(() => {
+				util.prompt = jest.fn(() =>
+					Promise.resolve({ hasId: true, id: "123456789" })
+				);
+			});
+
+			it("should prompt the user if they have a LK id", () => {
+				return run.addLKId(state).then(() => {
+					expect(util.prompt).toHaveBeenCalledWith([
+						{
+							type: "confirm",
+							name: "hasId",
+							message: "Do you have a LK ID?",
+							default: false
+						}
+					]);
+				});
+			});
+
+			it("should prompt the user for their LK id", () => {
+				return run.addLKId(state).then(() => {
+					expect(util.prompt).toHaveBeenCalledWith([
+						{
+							type: "input",
+							name: "id",
+							message: "What is your LK ID?"
+						}
+					]);
+				});
+			});
+
+			it("should persist the given LK id to the workflow state", () => {
+				return run.addLKId(state).then(() => {
+					expect(state).toHaveProperty("lkId");
+					expect(state.lkId).toEqual("123456789");
+				});
+			});
+		});
+
+		describe("when user doesn't have LK id", () => {
+			it("should prompt the user for their LK id", () => {
+				util.prompt = jest.fn(() => Promise.resolve({ hasId: false }));
+				return run.addLKId(state).then(() => {
+					expect(util.prompt).toHaveBeenCalledTimes(1);
+					expect(util.prompt).toHaveBeenCalledWith([
+						{
+							type: "confirm",
+							name: "hasId",
+							message: "Do you have a LK ID?",
+							default: false
+						}
+					]);
+				});
+			});
+		});
+	});
+
 	describe("updatePullRequestBody", () => {
 		beforeEach(() => {
 			util.prompt = jest.fn(() => Promise.resolve({ body: true }));

src/workflows/dev.js

@@ -1,4 +1,5 @@
 const run = require("./steps/index");
+const { hasLkScope } = require("../utils");
 
 module.exports = [
 	run.fetchUpstream,
@@ -10,6 +11,7 @@ module.exports = [
 	run.githubUpstream,
 	run.githubOrigin,
 	run.updatePullRequestTitle,
+	hasLkScope() ? run.addLKId : null,
 	run.updatePullRequestBody,
 	run.createGithubPullRequestAganistBranch
-];
+].filter(x => x);

src/workflows/steps/index.js

@@ -1138,6 +1138,7 @@ ${chalk.green(log)}`);
 				},
 				origin: { owner: repositoryOriginOwner }
 			},
+			lkId,
 			token,
 			branch,
 			devBranch,
@@ -1152,7 +1153,7 @@ ${chalk.green(log)}`);
 		);
 
 		const options = {
-			title,
+			title: `${title}${lkId ? ` (LK:${lkId})` : ""}`,
 			body,
 			head: `${repositoryOriginOwner}:${branch}`,
 			base: devBranch ? `${devBranch}` : `${branch}`
@@ -1600,6 +1601,35 @@ ${chalk.green(log)}`);
 			});
 		});
 	},
+	addLKId(state) {
+		state.step = "addLKId";
+		return util
+			.prompt([
+				{
+					type: "confirm",
+					name: "hasId",
+					message: "Do you have a LK ID?",
+					default: false
+				}
+			])
+			.then(answers => {
+				if (answers.hasId) {
+					return util
+						.prompt([
+							{
+								type: "input",
+								name: "id",
+								message: "What is your LK ID?"
+							}
+						])
+						.then(response => {
+							state.lkId = response.id.trim();
+							return Promise.resolve();
+						});
+				}
+				return Promise.resolve();
+			});
+	},
 	updatePullRequestBody(state) {
 		state.step = "updatePullRequestBody";
 		const { filePaths: { pullRequestTemplatePath } } = state;