chore: a bit more unit testing (#684)

## PR Checklist

- [x] Addresses an existing open issue: fixes #471
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Gets through the rest of the relatively straightforward unit tests.

At this point I think we can consider #471 to be resolved. Unit test
coverage is >89%.

Author: JoshuaKGoldberg

src/initialize/index.ts

@@ -1,5 +1,5 @@
 import { outro } from "../shared/cli/outro.js";
-import { getGitDefaultSettings } from "../shared/getDefaultSettings.js";
+import { getGitDefaultSettings } from "../shared/getGitDefaultSettings.js";
 import { readInputs } from "../shared/inputs.js";
 import { runOrRestore } from "../shared/runOrRestore.js";
 import { initializeWithValues } from "./initializeWithValues.js";

src/migrate/index.ts

@@ -1,6 +1,6 @@
 import { augmentValuesWithNpmInfo } from "../shared/augmentValuesWithNpmInfo.js";
 import { outro } from "../shared/cli/outro.js";
-import { getGitDefaultSettings } from "../shared/getDefaultSettings.js";
+import { getGitDefaultSettings } from "../shared/getGitDefaultSettings.js";
 import { readInputs } from "../shared/inputs.js";
 import { runOrRestore } from "../shared/runOrRestore.js";
 import { migrateWithValues } from "./migrateWithValues.js";

src/shared/getDefaultSettings.test.ts renamed to src/shared/getGitDefaultSettings.test.ts

@@ -1,8 +1,6 @@
 import { describe, expect, it, vi } from "vitest";
 
-import { getGitDefaultSettings } from "./getDefaultSettings.js";
-
-vi.mock("./cli/lines.js");
+import { getGitDefaultSettings } from "./getGitDefaultSettings.js";
 
 const mockGitRemoteOriginUrl = vi.fn();
 
@@ -12,17 +10,19 @@ vi.mock("git-remote-origin-url", () => ({
 	},
 }));
 
+vi.mock("../shared/cli/lines.js");
+
 describe("getDefaultSettings", () => {
 	it("returns the retrieved owner and repository when gitRemoteOriginUrl succeeds", async () => {
-		mockGitRemoteOriginUrl.mockResolvedValue("https://github.com/abc/def");
+		mockGitRemoteOriginUrl.mockResolvedValueOnce("https://github.com/abc/def");
 
 		const settings = await getGitDefaultSettings();
 
 		expect(settings).toEqual({ owner: "abc", repository: "def" });
 	});
 
 	it("returns arbitrary owner and repository defaults when gitRemoteOriginUrl rejects", async () => {
-		mockGitRemoteOriginUrl.mockRejectedValue(new Error("Oh no!"));
+		mockGitRemoteOriginUrl.mockRejectedValueOnce(new Error("Oh no!"));
 
 		const settings = await getGitDefaultSettings();
 

src/shared/getDefaultSettings.ts renamed to src/shared/getGitDefaultSettings.ts

@@ -0,0 +1,33 @@
+import { Octokit } from "octokit";
+import { describe, expect, it, vi } from "vitest";
+
+import { getOctokit } from "./getOctokit.js";
+
+const mock$ = vi.fn();
+
+vi.mock("execa", () => ({
+	get $() {
+		return mock$;
+	},
+}));
+
+vi.mock("octokit");
+
+describe("getOctokit", () => {
+	it("throws an error when gh auth status fails", async () => {
+		mock$.mockRejectedValueOnce(new Error("Oh no!"));
+
+		await expect(getOctokit).rejects.toMatchInlineSnapshot(
+			"[Error: GitHub authentication failed.]",
+		);
+	});
+
+	it("returns a new Octokit when gh auth status succeeds", async () => {
+		const auth = "abc123";
+		mock$.mockResolvedValueOnce({}).mockResolvedValueOnce({ stdout: auth });
+
+		const actual = await getOctokit();
+
+		expect(actual).toEqual(new Octokit({ auth }));
+	});
+});

src/shared/getOctokit.test.ts

@@ -1,24 +1,16 @@
-import chalk from "chalk";
 import { $ } from "execa";
 import { Octokit } from "octokit";
 
-import { runOrSkip } from "./cli/runOrSkip.js";
+export async function getOctokit(): Promise<Octokit | undefined> {
+	try {
+		await $`gh auth status`;
+	} catch (error) {
+		throw new Error("GitHub authentication failed.", {
+			cause: (error as Error).message,
+		});
+	}
 
-export async function getOctokit(
-	skipApi: boolean,
-): Promise<Octokit | undefined> {
-	return runOrSkip("Checking GitHub authentication", skipApi, async () => {
-		try {
-			await $`gh auth status`;
-		} catch (error) {
-			console.error();
-			console.error(chalk.red((error as Error).message));
-			console.error();
-			throw new Error("GitHub authentication failed.");
-		}
+	const auth = (await $`gh auth token`).stdout.trim();
 
-		const auth = (await $`gh auth token`).stdout.trim();
-
-		return new Octokit({ auth });
-	});
+	return new Octokit({ auth });
 }

src/shared/getOctokit.ts

@@ -3,6 +3,7 @@ import { Octokit } from "octokit";
 import { titleCase } from "title-case";
 
 import { allArgOptions } from "./args.js";
+import { runOrSkip } from "./cli/runOrSkip.js";
 import { ensureRepositoryExists } from "./ensureRepositoryExists.js";
 import { getOctokit } from "./getOctokit.js";
 import { getPrefillOrPromptedValue } from "./getPrefillOrPromptedValue.js";
@@ -71,7 +72,11 @@ export async function readInputs({
 				"What owner or user will the repository be under?",
 			))));
 
-	const octokit = await getOctokit(!!values["skip-github-api"]);
+	const octokit = await runOrSkip(
+		"Checking GitHub authentication",
+		!!values["skip-github-api"],
+		getOctokit,
+	);
 
 	const repository =
 		(values.repository as string | undefined) ??

src/shared/inputs.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it, vi } from "vitest";
+
+import { detectExistingContributors } from "./detectExistingContributors.js";
+
+const mockGetAllContributorsForRepository = vi.fn();
+
+vi.mock("all-contributors-for-repository", () => ({
+	get getAllContributorsForRepository() {
+		return mockGetAllContributorsForRepository;
+	},
+}));
+
+const mock$ = vi.fn();
+
+vi.mock("execa", () => ({
+	get $() {
+		return mock$;
+	},
+}));
+
+describe("detectExistingContributors", () => {
+	it("runs npx all-contributors add for each contributor and contribution type", async () => {
+		mockGetAllContributorsForRepository.mockResolvedValue({
+			username: ["bug", "docs"],
+		});
+
+		await detectExistingContributors();
+
+		expect(mock$.mock.calls).toMatchInlineSnapshot(`
+			[
+			  [
+			    [
+			      "npx all-contributors add ",
+			      " ",
+			      "",
+			    ],
+			    "username",
+			    "0,1",
+			  ],
+			]
+		`);
+	});
+});

src/steps/detectExistingContributors.test.ts

@@ -11,6 +11,15 @@ const createMockOctokit = (request: SpyInstance) =>
 const stubValues = { owner: "", repository: "" };
 
 describe("migrateBranchProtectionSettings", () => {
+	it("does not throw when the request receives a non-error response", async () => {
+		const mockRequest = vi.fn().mockResolvedValue({ status: 200 });
+
+		await initializeBranchProtectionSettings(
+			createMockOctokit(mockRequest),
+			stubValues,
+		);
+	});
+
 	it("returns false when the request receives a 403 response", async () => {
 		const mockRequest = vi.fn().mockRejectedValue({ status: 403 });
 

src/steps/initializeBranchProtectionSettings.test.ts

@@ -11,7 +11,6 @@ export async function initializeRepositorySettings(
 	octokit: Octokit,
 	{ description, owner, repository }: MigrateRepositoryValues,
 ) {
-	console.log("Will update repo settings");
 	await octokit.rest.repos.update({
 		allow_auto_merge: true,
 		allow_rebase_merge: false,