|
|
@@ -1,39 +1,288 @@
|
|
|
-import { describe, expect, test } from "bun:test"
|
|
|
-import os from "node:os"
|
|
|
-import path from "node:path"
|
|
|
-import { mkdtemp, mkdir, rm } from "node:fs/promises"
|
|
|
+import { describe, test, expect } from "bun:test"
|
|
|
+import path from "path"
|
|
|
+import fs from "fs/promises"
|
|
|
import { Filesystem } from "../../src/util/filesystem"
|
|
|
+import { tmpdir } from "../fixture/fixture"
|
|
|
|
|
|
-describe("util.filesystem", () => {
|
|
|
- test("exists() is true for files and directories", async () => {
|
|
|
- const tmp = await mkdtemp(path.join(os.tmpdir(), "opencode-filesystem-"))
|
|
|
- const dir = path.join(tmp, "dir")
|
|
|
- const file = path.join(tmp, "file.txt")
|
|
|
- const missing = path.join(tmp, "missing")
|
|
|
+describe("filesystem", () => {
|
|
|
+ describe("exists()", () => {
|
|
|
+ test("returns true for existing file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.txt")
|
|
|
+ await fs.writeFile(filepath, "content", "utf-8")
|
|
|
|
|
|
- await mkdir(dir, { recursive: true })
|
|
|
- await Bun.write(file, "hello")
|
|
|
+ expect(await Filesystem.exists(filepath)).toBe(true)
|
|
|
+ })
|
|
|
|
|
|
- const cases = await Promise.all([Filesystem.exists(dir), Filesystem.exists(file), Filesystem.exists(missing)])
|
|
|
+ test("returns false for non-existent file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "does-not-exist.txt")
|
|
|
|
|
|
- expect(cases).toEqual([true, true, false])
|
|
|
+ expect(await Filesystem.exists(filepath)).toBe(false)
|
|
|
+ })
|
|
|
|
|
|
- await rm(tmp, { recursive: true, force: true })
|
|
|
+ test("returns true for existing directory", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const dirpath = path.join(tmp.path, "subdir")
|
|
|
+ await fs.mkdir(dirpath)
|
|
|
+
|
|
|
+ expect(await Filesystem.exists(dirpath)).toBe(true)
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("isDir()", () => {
|
|
|
+ test("returns true for directory", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const dirpath = path.join(tmp.path, "testdir")
|
|
|
+ await fs.mkdir(dirpath)
|
|
|
+
|
|
|
+ expect(await Filesystem.isDir(dirpath)).toBe(true)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("returns false for file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.txt")
|
|
|
+ await fs.writeFile(filepath, "content", "utf-8")
|
|
|
+
|
|
|
+ expect(await Filesystem.isDir(filepath)).toBe(false)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("returns false for non-existent path", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "does-not-exist")
|
|
|
+
|
|
|
+ expect(await Filesystem.isDir(filepath)).toBe(false)
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("size()", () => {
|
|
|
+ test("returns file size", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.txt")
|
|
|
+ const content = "Hello, World!"
|
|
|
+ await fs.writeFile(filepath, content, "utf-8")
|
|
|
+
|
|
|
+ expect(await Filesystem.size(filepath)).toBe(content.length)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("returns 0 for non-existent file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "does-not-exist.txt")
|
|
|
+
|
|
|
+ expect(await Filesystem.size(filepath)).toBe(0)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("returns directory size", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const dirpath = path.join(tmp.path, "testdir")
|
|
|
+ await fs.mkdir(dirpath)
|
|
|
+
|
|
|
+ // Directories have size on some systems
|
|
|
+ const size = await Filesystem.size(dirpath)
|
|
|
+ expect(typeof size).toBe("number")
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("readText()", () => {
|
|
|
+ test("reads file content", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.txt")
|
|
|
+ const content = "Hello, World!"
|
|
|
+ await fs.writeFile(filepath, content, "utf-8")
|
|
|
+
|
|
|
+ expect(await Filesystem.readText(filepath)).toBe(content)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("throws for non-existent file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "does-not-exist.txt")
|
|
|
+
|
|
|
+ await expect(Filesystem.readText(filepath)).rejects.toThrow()
|
|
|
+ })
|
|
|
+
|
|
|
+ test("reads UTF-8 content correctly", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "unicode.txt")
|
|
|
+ const content = "Hello 世界 🌍"
|
|
|
+ await fs.writeFile(filepath, content, "utf-8")
|
|
|
+
|
|
|
+ expect(await Filesystem.readText(filepath)).toBe(content)
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("readJson()", () => {
|
|
|
+ test("reads and parses JSON", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.json")
|
|
|
+ const data = { key: "value", nested: { array: [1, 2, 3] } }
|
|
|
+ await fs.writeFile(filepath, JSON.stringify(data), "utf-8")
|
|
|
+
|
|
|
+ const result: typeof data = await Filesystem.readJson(filepath)
|
|
|
+ expect(result).toEqual(data)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("throws for invalid JSON", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "invalid.json")
|
|
|
+ await fs.writeFile(filepath, "{ invalid json", "utf-8")
|
|
|
+
|
|
|
+ await expect(Filesystem.readJson(filepath)).rejects.toThrow()
|
|
|
+ })
|
|
|
+
|
|
|
+ test("throws for non-existent file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "does-not-exist.json")
|
|
|
+
|
|
|
+ await expect(Filesystem.readJson(filepath)).rejects.toThrow()
|
|
|
+ })
|
|
|
+
|
|
|
+ test("returns typed data", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "typed.json")
|
|
|
+ interface Config {
|
|
|
+ name: string
|
|
|
+ version: number
|
|
|
+ }
|
|
|
+ const data: Config = { name: "test", version: 1 }
|
|
|
+ await fs.writeFile(filepath, JSON.stringify(data), "utf-8")
|
|
|
+
|
|
|
+ const result = await Filesystem.readJson<Config>(filepath)
|
|
|
+ expect(result.name).toBe("test")
|
|
|
+ expect(result.version).toBe(1)
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("readBytes()", () => {
|
|
|
+ test("reads file as buffer", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.txt")
|
|
|
+ const content = "Hello, World!"
|
|
|
+ await fs.writeFile(filepath, content, "utf-8")
|
|
|
+
|
|
|
+ const buffer = await Filesystem.readBytes(filepath)
|
|
|
+ expect(buffer).toBeInstanceOf(Buffer)
|
|
|
+ expect(buffer.toString("utf-8")).toBe(content)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("throws for non-existent file", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "does-not-exist.bin")
|
|
|
+
|
|
|
+ await expect(Filesystem.readBytes(filepath)).rejects.toThrow()
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("write()", () => {
|
|
|
+ test("writes text content", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.txt")
|
|
|
+ const content = "Hello, World!"
|
|
|
+
|
|
|
+ await Filesystem.write(filepath, content)
|
|
|
+
|
|
|
+ expect(await fs.readFile(filepath, "utf-8")).toBe(content)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("writes buffer content", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "test.bin")
|
|
|
+ const content = Buffer.from([0x00, 0x01, 0x02, 0x03])
|
|
|
+
|
|
|
+ await Filesystem.write(filepath, content)
|
|
|
+
|
|
|
+ const read = await fs.readFile(filepath)
|
|
|
+ expect(read).toEqual(content)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("writes with permissions", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "protected.txt")
|
|
|
+ const content = "secret"
|
|
|
+
|
|
|
+ await Filesystem.write(filepath, content, 0o600)
|
|
|
+
|
|
|
+ const stats = await fs.stat(filepath)
|
|
|
+ // Check permissions on Unix
|
|
|
+ if (process.platform !== "win32") {
|
|
|
+ expect(stats.mode & 0o777).toBe(0o600)
|
|
|
+ }
|
|
|
+ })
|
|
|
+
|
|
|
+ test("creates parent directories", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "nested", "deep", "file.txt")
|
|
|
+ const content = "nested content"
|
|
|
+
|
|
|
+ await Filesystem.write(filepath, content)
|
|
|
+
|
|
|
+ expect(await fs.readFile(filepath, "utf-8")).toBe(content)
|
|
|
+ })
|
|
|
})
|
|
|
|
|
|
- test("isDir() is true only for directories", async () => {
|
|
|
- const tmp = await mkdtemp(path.join(os.tmpdir(), "opencode-filesystem-"))
|
|
|
- const dir = path.join(tmp, "dir")
|
|
|
- const file = path.join(tmp, "file.txt")
|
|
|
- const missing = path.join(tmp, "missing")
|
|
|
+ describe("writeJson()", () => {
|
|
|
+ test("writes JSON data", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "data.json")
|
|
|
+ const data = { key: "value", number: 42 }
|
|
|
+
|
|
|
+ await Filesystem.writeJson(filepath, data)
|
|
|
+
|
|
|
+ const content = await fs.readFile(filepath, "utf-8")
|
|
|
+ expect(JSON.parse(content)).toEqual(data)
|
|
|
+ })
|
|
|
+
|
|
|
+ test("writes formatted JSON", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "pretty.json")
|
|
|
+ const data = { key: "value" }
|
|
|
+
|
|
|
+ await Filesystem.writeJson(filepath, data)
|
|
|
+
|
|
|
+ const content = await fs.readFile(filepath, "utf-8")
|
|
|
+ expect(content).toContain("\n")
|
|
|
+ expect(content).toContain(" ")
|
|
|
+ })
|
|
|
+
|
|
|
+ test("writes with permissions", async () => {
|
|
|
+ await using tmp = await tmpdir()
|
|
|
+ const filepath = path.join(tmp.path, "config.json")
|
|
|
+ const data = { secret: "data" }
|
|
|
+
|
|
|
+ await Filesystem.writeJson(filepath, data, 0o600)
|
|
|
+
|
|
|
+ const stats = await fs.stat(filepath)
|
|
|
+ if (process.platform !== "win32") {
|
|
|
+ expect(stats.mode & 0o777).toBe(0o600)
|
|
|
+ }
|
|
|
+ })
|
|
|
+ })
|
|
|
+
|
|
|
+ describe("mimeType()", () => {
|
|
|
+ test("returns correct MIME type for JSON", () => {
|
|
|
+ expect(Filesystem.mimeType("test.json")).toContain("application/json")
|
|
|
+ })
|
|
|
+
|
|
|
+ test("returns correct MIME type for JavaScript", () => {
|
|
|
+ expect(Filesystem.mimeType("test.js")).toContain("javascript")
|
|
|
+ })
|
|
|
|
|
|
- await mkdir(dir, { recursive: true })
|
|
|
- await Bun.write(file, "hello")
|
|
|
+ test("returns MIME type for TypeScript (or video/mp2t due to extension conflict)", () => {
|
|
|
+ const mime = Filesystem.mimeType("test.ts")
|
|
|
+ // .ts is ambiguous: TypeScript vs MPEG-2 TS video
|
|
|
+ expect(mime === "video/mp2t" || mime === "application/typescript" || mime === "text/typescript").toBe(true)
|
|
|
+ })
|
|
|
|
|
|
- const cases = await Promise.all([Filesystem.isDir(dir), Filesystem.isDir(file), Filesystem.isDir(missing)])
|
|
|
+ test("returns correct MIME type for images", () => {
|
|
|
+ expect(Filesystem.mimeType("test.png")).toContain("image/png")
|
|
|
+ expect(Filesystem.mimeType("test.jpg")).toContain("image/jpeg")
|
|
|
+ })
|
|
|
|
|
|
- expect(cases).toEqual([true, false, false])
|
|
|
+ test("returns default for unknown extension", () => {
|
|
|
+ expect(Filesystem.mimeType("test.unknown")).toBe("application/octet-stream")
|
|
|
+ })
|
|
|
|
|
|
- await rm(tmp, { recursive: true, force: true })
|
|
|
+ test("handles files without extension", () => {
|
|
|
+ expect(Filesystem.mimeType("Makefile")).toBe("application/octet-stream")
|
|
|
+ })
|
|
|
})
|
|
|
})
|