Added some unit tests for the test utils + fix smol review comments

Author: EhabY

test/unit/core/cliUtils.test.ts

@@ -29,7 +29,7 @@ describe("CliUtils", () => {
 		expect((await cliUtils.stat(binPath))?.size).toBe(4);
 	});
 
-	it.skipIf(isWindows)("version", async () => {
+	it.skipIf(isWindows())("version", async () => {
 		const binPath = path.join(tmp, "version");
 		await expect(cliUtils.version(binPath)).rejects.toThrow("ENOENT");
 

test/unit/globalFlags.test.ts

@@ -3,7 +3,7 @@ import { type WorkspaceConfiguration } from "vscode";
 
 import { getGlobalFlags } from "@/globalFlags";
 
-import { quoteCommand } from "../utils/platform";
+import { isWindows } from "../utils/platform";
 
 describe("Global flags suite", () => {
 	it("should return global-config and header args when no global flags configured", () => {
@@ -80,3 +80,9 @@ describe("Global flags suite", () => {
 		]);
 	});
 });
+
+function quoteCommand(value: string): string {
+	// Used to escape environment variables in commands. See `getHeaderArgs` in src/headers.ts
+	const quote = isWindows() ? '"' : "'";
+	return `${quote}${value}${quote}`;
+}

test/utils/platform.test.ts

@@ -0,0 +1,86 @@
+import { describe, expect, it } from "vitest";
+
+import {
+	expectPathsEqual,
+	exitCommand,
+	printCommand,
+	printEnvCommand,
+	isWindows,
+} from "./platform";
+
+describe("platform utils", () => {
+	describe("printCommand", () => {
+		it("should generate a simple node command", () => {
+			const result = printCommand("hello world");
+			expect(result).toBe("node -e \"process.stdout.write('hello world')\"");
+		});
+
+		it("should escape special characters", () => {
+			const result = printCommand('path\\to\\file\'s "name"\nline2\rcarriage');
+			expect(result).toBe(
+				'node -e "process.stdout.write(\'path\\\\to\\\\file\\\'s \\"name\\"\\nline2\\rcarriage\')"',
+			);
+		});
+	});
+
+	describe("exitCommand", () => {
+		it("should generate node commands with various exit codes", () => {
+			expect(exitCommand(0)).toBe('node -e "process.exit(0)"');
+			expect(exitCommand(1)).toBe('node -e "process.exit(1)"');
+			expect(exitCommand(42)).toBe('node -e "process.exit(42)"');
+			expect(exitCommand(-1)).toBe('node -e "process.exit(-1)"');
+		});
+	});
+
+	describe("printEnvCommand", () => {
+		it("should generate node commands that print env variables", () => {
+			expect(printEnvCommand("url", "CODER_URL")).toBe(
+				"node -e \"process.stdout.write('url=' + process.env.CODER_URL)\"",
+			);
+			expect(printEnvCommand("token", "CODER_TOKEN")).toBe(
+				"node -e \"process.stdout.write('token=' + process.env.CODER_TOKEN)\"",
+			);
+			// Will fail to execute but that's fine
+			expect(printEnvCommand("", "")).toBe(
+				"node -e \"process.stdout.write('=' + process.env.)\"",
+			);
+		});
+	});
+
+	describe("expectPathsEqual", () => {
+		it("should consider identical paths equal", () => {
+			expectPathsEqual("same/path", "same/path");
+		});
+
+		it("should throw when paths are different", () => {
+			expect(() =>
+				expectPathsEqual("path/to/file1", "path/to/file2"),
+			).toThrow();
+		});
+
+		it("should handle empty paths", () => {
+			expectPathsEqual("", "");
+		});
+
+		it.runIf(isWindows())(
+			"should consider paths with different separators equal on Windows",
+			() => {
+				expectPathsEqual("path/to/file", "path\\to\\file");
+				expectPathsEqual("C:/path/to/file", "C:\\path\\to\\file");
+				expectPathsEqual(
+					"C:/path with spaces/file",
+					"C:\\path with spaces\\file",
+				);
+			},
+		);
+
+		it.skipIf(isWindows())(
+			"should consider backslash as literal on non-Windows",
+			() => {
+				expect(() =>
+					expectPathsEqual("path/to/file", "path\\to\\file"),
+				).toThrow();
+			},
+		);
+	});
+});

test/utils/platform.ts

@@ -2,7 +2,9 @@ import os from "node:os";
 import path from "node:path";
 import { expect } from "vitest";
 
-export const isWindows = os.platform() === "win32";
+export function isWindows(): boolean {
+	return os.platform() === "win32";
+}
 
 /**
  * Returns a platform-independent command that outputs the given text.
@@ -39,15 +41,6 @@ export function expectPathsEqual(actual: string, expected: string) {
 	expect(normalizePath(actual)).toBe(normalizePath(expected));
 }
 
-export function quoteCommand(value: string): string {
-	const quote = getPlatformQuote();
-	return `${quote}${value}${quote}`;
-}
-
 function normalizePath(p: string): string {
-	return p.replaceAll(path.sep, "/");
-}
-
-function getPlatformQuote(): string {
-	return isWindows ? '"' : "'";
+	return p.replaceAll(path.sep, path.posix.sep);
 }

vitest.config.ts

@@ -5,13 +5,8 @@ export default defineConfig({
 	test: {
 		globals: true,
 		environment: "node",
-		include: ["test/unit/**/*.test.ts", "test/integration/**/*.test.ts"],
-		exclude: [
-			"test/integration/**",
-			"**/node_modules/**",
-			"**/out/**",
-			"**/*.d.ts",
-		],
+		include: ["test/unit/**/*.test.ts", "test/utils/**/*.test.ts"],
+		exclude: ["**/node_modules/**", "**/out/**", "**/*.d.ts"],
 		pool: "threads",
 		fileParallelism: true,
 		coverage: {