Write tests for installers and remove --passWithNoTests option from lint staged config

Author: volodymyrZotov

lint-staged.config.js

@@ -3,7 +3,7 @@ const lintStagedConfig = {
 	"*.{js,json,md,ts,yaml,yml}": "npm run format:write",
 	"*.{js,ts}": ["npm run lint:fix"],
 	// run testing on all supported file types within the src/ directory
-	"src/**/*.{js,ts}": ["npm run test -- --findRelatedTests --passWithNoTests"],
+	"src/**/*.{js,ts}": ["npm run test -- --findRelatedTests"],
 };
 
 export default lintStagedConfig;

src/cli-installer/cli-installer.ts

@@ -3,11 +3,6 @@ import os from "os";
 import * as core from "@actions/core";
 import * as tc from "@actions/tool-cache";
 
-import { type Installer } from "./index";
-import { LinuxInstaller } from "./linux";
-import { MacOsInstaller } from "./macos";
-import { WindowsInstaller } from "./windows";
-
 export type SupportedPlatform = Extract<
 	NodeJS.Platform,
 	"linux" | "darwin" | "win32"
@@ -21,6 +16,7 @@ const archMap: Record<string, string> = {
 	arm64: "arm64",
 };
 
+// Builds the download URL for the 1Password CLI based on the platform and version.
 export const cliUrlBuilder: Record<
 	SupportedPlatform,
 	(version: string, arch?: string) => string
@@ -34,28 +30,14 @@ export const cliUrlBuilder: Record<
 };
 
 export class CliInstaller {
-	protected readonly version: string;
-	protected readonly arch: string;
+	public readonly version: string;
+	public readonly arch: string;
 
 	public constructor(version: string) {
 		this.version = version;
 		this.arch = this.getArch();
 	}
 
-	public static create(version: string): Installer {
-		const platform = os.platform();
-		switch (platform) {
-			case "linux":
-				return new LinuxInstaller(version);
-			case "darwin":
-				return new MacOsInstaller(version);
-			case "win32":
-				return new WindowsInstaller(version);
-			default:
-				throw new Error(`Unsupported platform: ${platform}`);
-		}
-	}
-
 	public async install(url: string): Promise<void> {
 		console.info(`Downloading 1Password CLI from: ${url}`);
 		const downloadPath = await tc.downloadTool(url);

src/cli-installer/index.ts

@@ -1,5 +1 @@
-export { CliInstaller } from "./cli-installer";
-
-export interface Installer {
-	installCli(): Promise<void>;
-}
+export { type Installer, newCliInstaller } from "./installer";

src/cli-installer/installer.test.ts

@@ -0,0 +1,44 @@
+import os from "os";
+
+import { newCliInstaller } from "./installer";
+import { LinuxInstaller } from "./linux";
+import { MacOsInstaller } from "./macos";
+import { WindowsInstaller } from "./windows";
+
+jest.mock("os");
+jest.mock("./linux");
+jest.mock("./macos");
+jest.mock("./windows");
+
+describe("newCliInstaller", () => {
+	const version = "1.0.0";
+
+	afterEach(() => {
+		jest.resetAllMocks();
+	});
+
+	it("should return LinuxInstaller for linux platform", () => {
+		(os.platform as jest.Mock).mockReturnValue("linux");
+		const installer = newCliInstaller(version);
+		expect(installer).toBeInstanceOf(LinuxInstaller);
+	});
+
+	it("should return MacOsInstaller for darwin platform", () => {
+		(os.platform as jest.Mock).mockReturnValue("darwin");
+		const installer = newCliInstaller(version);
+		expect(installer).toBeInstanceOf(MacOsInstaller);
+	});
+
+	it("should return WindowsInstaller for win32 platform", () => {
+		(os.platform as jest.Mock).mockReturnValue("win32");
+		const installer = newCliInstaller(version);
+		expect(installer).toBeInstanceOf(WindowsInstaller);
+	});
+
+	it("should throw error for unsupported platform", () => {
+		(os.platform as jest.Mock).mockReturnValue("sunos");
+		expect(() => newCliInstaller(version)).toThrow(
+			"Unsupported platform: sunos",
+		);
+	});
+});

src/cli-installer/installer.ts

@@ -0,0 +1,23 @@
+import os from "os";
+
+import { LinuxInstaller } from "./linux";
+import { MacOsInstaller } from "./macos";
+import { WindowsInstaller } from "./windows";
+
+export interface Installer {
+	installCli(): Promise<void>;
+}
+
+export const newCliInstaller = (version: string): Installer => {
+	const platform = os.platform();
+	switch (platform) {
+		case "linux":
+			return new LinuxInstaller(version);
+		case "darwin":
+			return new MacOsInstaller(version);
+		case "win32":
+			return new WindowsInstaller(version);
+		default:
+			throw new Error(`Unsupported platform: ${platform}`);
+	}
+};

src/cli-installer/linux.test.ts

@@ -0,0 +1,31 @@
+import os from "os";
+
+import {
+	CliInstaller,
+	cliUrlBuilder,
+	type SupportedPlatform,
+} from "./cli-installer";
+import { LinuxInstaller } from "./linux";
+
+describe("LinuxInstaller", () => {
+	const version = "1.2.3";
+
+	it("should construct with given version and architecture", () => {
+		const installer = new LinuxInstaller(version);
+		expect(installer.version).toEqual(version);
+		expect(installer.arch).toEqual(os.arch());
+	});
+
+	it("should call install with correct URL", async () => {
+		const installer = new LinuxInstaller(version);
+		const installMock = jest
+			.spyOn(CliInstaller.prototype, "install")
+			.mockResolvedValue();
+
+		await installer.installCli();
+
+		const builder = cliUrlBuilder["linux" as SupportedPlatform];
+		const url = builder(version, installer.arch);
+		expect(installMock).toHaveBeenCalledWith(url);
+	});
+});

src/cli-installer/linux.ts

@@ -3,7 +3,7 @@ import {
 	cliUrlBuilder,
 	type SupportedPlatform,
 } from "./cli-installer";
-import type { Installer } from "./index";
+import type { Installer } from "./installer";
 
 export class LinuxInstaller extends CliInstaller implements Installer {
 	private readonly platform: SupportedPlatform = "linux"; // Node.js platform identifier for Linux

src/cli-installer/macos.test.ts

@@ -0,0 +1,25 @@
+import os from "os";
+
+import { cliUrlBuilder, type SupportedPlatform } from "./cli-installer";
+import { MacOsInstaller } from "./macos";
+
+describe("MacOsInstaller", () => {
+	const version = "1.2.3";
+
+	it("should construct with given version and architecture", () => {
+		const installer = new MacOsInstaller(version);
+		expect(installer.version).toEqual(version);
+		expect(installer.arch).toEqual(os.arch());
+	});
+
+	it("should call install with correct URL", async () => {
+		const installer = new MacOsInstaller(version);
+		const installMock = jest.spyOn(installer, "install").mockResolvedValue();
+
+		await installer.installCli();
+
+		const builder = cliUrlBuilder["darwin" as SupportedPlatform];
+		const url = builder(version, installer.arch);
+		expect(installMock).toHaveBeenCalledWith(url);
+	});
+});

src/cli-installer/macos.ts

@@ -11,7 +11,7 @@ import {
 	cliUrlBuilder,
 	type SupportedPlatform,
 } from "./cli-installer";
-import { type Installer } from "./index";
+import { type Installer } from "./installer";
 
 const execAsync = promisify(exec);
 

src/cli-installer/windows.test.ts

@@ -0,0 +1,31 @@
+import os from "os";
+
+import {
+	CliInstaller,
+	cliUrlBuilder,
+	type SupportedPlatform,
+} from "./cli-installer";
+import { WindowsInstaller } from "./windows";
+
+describe("WindowsInstaller", () => {
+	const version = "1.2.3";
+
+	it("should construct with given version and architecture", () => {
+		const installer = new WindowsInstaller(version);
+		expect(installer.version).toEqual(version);
+		expect(installer.arch).toEqual(os.arch());
+	});
+
+	it("should call install with correct URL", async () => {
+		const installer = new WindowsInstaller(version);
+		const installMock = jest
+			.spyOn(CliInstaller.prototype, "install")
+			.mockResolvedValue();
+
+		await installer.installCli();
+
+		const builder = cliUrlBuilder["win32" as SupportedPlatform];
+		const url = builder(version, installer.arch);
+		expect(installMock).toHaveBeenCalledWith(url);
+	});
+});