feat: add tests for isWsl

src/node/util.ts

@@ -377,10 +377,16 @@ export const getMediaMime = (filePath?: string): string => {
   return (filePath && mimeTypes[path.extname(filePath)]) || "text/plain"
 }
 
-export const isWsl = async (): Promise<boolean> => {
+/**
+ * A helper function that checks if the platform is Windows Subsystem for Linux
+ * (WSL)
+ *
+ * @returns {Boolean} boolean if it is WSL
+ */
+export const isWsl = async (platform: NodeJS.Platform, procVersionFilePath: string): Promise<boolean> => {
   return (
-    (process.platform === "linux" && os.release().toLowerCase().indexOf("microsoft") !== -1) ||
-    (await fs.readFile("/proc/version", "utf8")).toLowerCase().indexOf("microsoft") !== -1
+    (platform === "linux" && os.release().toLowerCase().indexOf("microsoft") !== -1) ||
+    (await fs.readFile(procVersionFilePath, "utf8")).toLowerCase().indexOf("microsoft") !== -1
   )
 }
 
@@ -398,7 +404,7 @@ export const open = async (address: URL | string): Promise<void> => {
   }
   const args = [] as string[]
   const options = {} as cp.SpawnOptions
-  const platform = (await isWsl()) ? "wsl" : process.platform
+  const platform = (await isWsl(process.platform, "/proc/version")) ? "wsl" : process.platform
   let command = platform === "darwin" ? "open" : "xdg-open"
   if (platform === "win32" || platform === "wsl") {
     command = platform === "wsl" ? "cmd.exe" : "cmd"

test/unit/node/util.test.ts

@@ -482,3 +482,74 @@ describe("humanPath", () => {
     expect(actual).toBe(expected)
   })
 })
+
+describe("isWsl", () => {
+  describe("on Linux (microsoft)", () => {
+    const testDir = path.join(tmpdir, "tests", "isWsl-linux-microsoft")
+    let pathToFile = ""
+
+    beforeEach(async () => {
+      pathToFile = path.join(testDir, "/proc-version")
+      await fs.mkdir(testDir, { recursive: true })
+      await fs.writeFile(pathToFile, "microsoft")
+    })
+    afterEach(async () => {
+      await fs.rm(testDir, { recursive: true, force: true })
+    })
+
+    it("should return true", async () => {
+      expect(await util.isWsl("linux", pathToFile)).toBe(true)
+    })
+  })
+  describe("on Linux (non-microsoft)", () => {
+    const testDir = path.join(tmpdir, "tests", "isWsl-linux-non-microsoft")
+    let pathToFile = ""
+
+    beforeEach(async () => {
+      pathToFile = path.join(testDir, "/proc-version")
+      await fs.mkdir(testDir, { recursive: true })
+      await fs.writeFile(pathToFile, "linux")
+    })
+    afterEach(async () => {
+      await fs.rm(testDir, { recursive: true, force: true })
+    })
+
+    it("should return false", async () => {
+      expect(await util.isWsl("linux", pathToFile)).toBe(false)
+    })
+  })
+  describe("on Win32 with microsoft in /proc/version", () => {
+    const testDir = path.join(tmpdir, "tests", "isWsl-win32-microsoft")
+    let pathToFile = ""
+
+    beforeEach(async () => {
+      pathToFile = path.join(testDir, "/proc-version")
+      await fs.mkdir(testDir, { recursive: true })
+      await fs.writeFile(pathToFile, "microsoft")
+    })
+    afterEach(async () => {
+      await fs.rm(testDir, { recursive: true, force: true })
+    })
+
+    it("should return true", async () => {
+      expect(await util.isWsl("win32", pathToFile)).toBe(true)
+    })
+  })
+  describe("on Darwin", () => {
+    const testDir = path.join(tmpdir, "tests", "isWsl-darwin")
+    let pathToFile = ""
+
+    beforeEach(async () => {
+      pathToFile = path.join(testDir, "/proc-version")
+      await fs.mkdir(testDir, { recursive: true })
+      await fs.writeFile(pathToFile, "darwin")
+    })
+    afterEach(async () => {
+      await fs.rm(testDir, { recursive: true, force: true })
+    })
+
+    it("should return false", async () => {
+      expect(await util.isWsl("darwin", pathToFile)).toBe(false)
+    })
+  })
+})