gitforest 0.1.0 → 1.0.0

package/test/unit/config/loader.test.ts

@@ -1,692 +0,0 @@
-import { describe, test, expect, beforeEach, afterEach } from "bun:test";
-import { join } from "path";
-import { mkdtemp, rm, writeFile } from "fs/promises";
-import { tmpdir } from "os";
-import { stringify } from "yaml";
-import { loadConfig, findConfigPath, applyEnvOverrides, getSupportedEnvVars } from "../../../src/config/loader.ts";
-import type { GitforestConfig } from "../../../src/types/index.ts";
-import {
-  createTempDir,
-  cleanupTempDir,
-  createMockConfig,
-  createMockYamlConfig,
-} from "../fixtures/setup.ts";
-
-describe("findConfigPath", () => {
-  let tempDir: string;
-
-  beforeEach(() => {
-    tempDir = createTempDir("config-test");
-  });
-
-  afterEach(() => {
-    cleanupTempDir(tempDir);
-  });
-
-  test("finds gitforest.config.yaml in current directory first", () => {
-    createMockYamlConfig(tempDir, "directories:\n  - path: ~/test");
-    const result = findConfigPath(tempDir);
-    // Should find the config in specified directory (highest priority)
-    expect(result).toBe(join(tempDir, "gitforest.config.yaml"));
-  });
-
-  test("finds gitforest.config.json in current directory", () => {
-    createMockConfig(tempDir, { directories: [{ path: "~/test" }] });
-    const result = findConfigPath(tempDir);
-    expect(result).toBe(join(tempDir, "gitforest.config.json"));
-  });
-
-  test("prefers yaml over json in current directory", () => {
-    createMockYamlConfig(tempDir, "directories:\n  - path: ~/yaml");
-    createMockConfig(tempDir, { directories: [{ path: "~/json" }] });
-    const result = findConfigPath(tempDir);
-    // YAML should be found first per priority order
-    expect(result).toBe(join(tempDir, "gitforest.config.yaml"));
-  });
-});
-
-describe("loadConfig", () => {
-  let tempDir: string;
-
-  beforeEach(() => {
-    tempDir = createTempDir("config-load-test");
-  });
-
-  afterEach(() => {
-    cleanupTempDir(tempDir);
-  });
-
-  test("loads valid JSON config", async () => {
-    const configPath = createMockConfig(tempDir, {
-      directories: [{ path: "~/projects", maxDepth: 2 }],
-    });
-
-    const config = await loadConfig(configPath);
-
-    expect(config.directories).toHaveLength(1);
-    expect(config.directories[0]?.maxDepth).toBe(2);
-  });
-
-  test("loads valid YAML config", async () => {
-    const configPath = createMockYamlConfig(
-      tempDir,
-      `
-directories:
-  - path: ~/projects
-    maxDepth: 3
-    label: Projects
-  - path: ~/work
-    maxDepth: 2
-
-scan:
-  ignore:
-    - node_modules
-    - vendor
-  includeHidden: false
-
-github:
-  defaultVisibility: private
-`
-    );
-
-    const config = await loadConfig(configPath);
-
-    expect(config.directories).toHaveLength(2);
-    expect(config.directories[0]?.maxDepth).toBe(3);
-    expect(config.directories[0]?.label).toBe("Projects");
-    expect(config.scan.ignore).toContain("vendor");
-    expect(config.github.defaultVisibility).toBe("private");
-  });
-
-  test("expands tilde in paths", async () => {
-    const configPath = createMockConfig(tempDir, {
-      directories: [{ path: "~/projects" }],
-    });
-
-    const config = await loadConfig(configPath);
-
-    expect(config.directories[0]?.path).not.toContain("~");
-    expect(config.directories[0]?.path).toContain(process.env.HOME || "");
-  });
-
-  test("throws error for invalid config", async () => {
-    const configPath = createMockConfig(tempDir, {
-      directories: [], // Invalid: empty array
-    });
-
-    await expect(loadConfig(configPath)).rejects.toThrow();
-  });
-
-  test("throws error for missing required field", async () => {
-    const configPath = createMockConfig(tempDir, {
-      // Missing directories field
-      scan: { ignore: [] },
-    });
-
-    await expect(loadConfig(configPath)).rejects.toThrow();
-  });
-
-  test("throws error when config file does not exist", async () => {
-    const nonExistentPath = join(tempDir, "non-existent.yaml");
-    await expect(loadConfig(nonExistentPath)).rejects.toThrow();
-  });
-
-  test("applies default values for optional fields", async () => {
-    const configPath = createMockConfig(tempDir, {
-      directories: [{ path: "~/projects" }],
-    });
-
-    const config = await loadConfig(configPath);
-
-    expect(config.scan.concurrency).toBe(5);
-    expect(config.display.sortBy).toBe("status");
-    expect(config.cache.ttlSeconds).toBe(300);
-  });
-});
-
-describe("applyEnvOverrides", () => {
-  // Store original env values
-  const originalEnv: Record<string, string | undefined> = {};
-  const envVarsToClean = [
-    "GITTY_GITHUB_VISIBILITY",
-    "GITTY_CONCURRENCY",
-    "GITTY_INCLUDE_HIDDEN",
-    "GITTY_SORT_BY",
-    "GITTY_SORT_DIR",
-    "GITTY_SHOW_SUBMODULES",
-    "GITTY_CACHE_TTL",
-  ];
-
-  const createBaseConfig = (): GitforestConfig => ({
-    directories: [{ path: "/home/user/projects", maxDepth: 2 }],
-    scan: {
-      concurrency: 5,
-      ignore: ["node_modules"],
-      includeHidden: false,
-    },
-    display: {
-      showSubmodules: true,
-      showNonGitProjects: true,
-      sortBy: "status",
-      sortDirection: "desc",
-    },
-    github: {
-      defaultVisibility: "private",
-    },
-    cache: {
-      ttlSeconds: 300,
-      githubTtlSeconds: 600,
-      enableBackgroundRefresh: true,
-      backgroundRefreshIntervalSeconds: 300,
-    },
-    commands: [],
-  });
-
-  beforeEach(() => {
-    // Save original values
-    for (const key of envVarsToClean) {
-      originalEnv[key] = process.env[key];
-      delete process.env[key];
-    }
-  });
-
-  afterEach(() => {
-    // Restore original values
-    for (const key of envVarsToClean) {
-      if (originalEnv[key] !== undefined) {
-        process.env[key] = originalEnv[key];
-      } else {
-        delete process.env[key];
-      }
-    }
-  });
-
-  test("returns config unchanged when no env vars set", () => {
-    const config = createBaseConfig();
-    const result = applyEnvOverrides(config);
-
-    expect(result).toEqual(config);
-  });
-
-  test("overrides github.defaultVisibility from GITTY_GITHUB_VISIBILITY", () => {
-    process.env.GITTY_GITHUB_VISIBILITY = "public";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.github?.defaultVisibility).toBe("public");
-  });
-
-  test("overrides scan.concurrency from GITTY_CONCURRENCY", () => {
-    process.env.GITTY_CONCURRENCY = "10";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.scan?.concurrency).toBe(10);
-  });
-
-  test("overrides scan.includeHidden from GITTY_INCLUDE_HIDDEN", () => {
-    process.env.GITTY_INCLUDE_HIDDEN = "true";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.scan?.includeHidden).toBe(true);
-  });
-
-  test("overrides display.sortBy from GITTY_SORT_BY", () => {
-    process.env.GITTY_SORT_BY = "name";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.display?.sortBy).toBe("name");
-  });
-
-  test("overrides display.sortDirection from GITTY_SORT_DIR", () => {
-    process.env.GITTY_SORT_DIR = "asc";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.display?.sortDirection).toBe("asc");
-  });
-
-  test("overrides display.showSubmodules from GITTY_SHOW_SUBMODULES", () => {
-    process.env.GITTY_SHOW_SUBMODULES = "false";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.display?.showSubmodules).toBe(false);
-  });
-
-  test("overrides cache.ttlSeconds from GITTY_CACHE_TTL", () => {
-    process.env.GITTY_CACHE_TTL = "600";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.cache?.ttlSeconds).toBe(600);
-  });
-
-  test("applies multiple env overrides at once", () => {
-    process.env.GITTY_GITHUB_VISIBILITY = "public";
-    process.env.GITTY_CONCURRENCY = "20";
-    process.env.GITTY_SORT_BY = "lastActivity";
-    process.env.GITTY_CACHE_TTL = "1200";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.github?.defaultVisibility).toBe("public");
-    expect(result.scan?.concurrency).toBe(20);
-    expect(result.display?.sortBy).toBe("lastActivity");
-    expect(result.cache?.ttlSeconds).toBe(1200);
-  });
-
-  test("does not modify original config", () => {
-    process.env.GITTY_CONCURRENCY = "15";
-    const config = createBaseConfig();
-    const originalConcurrency = config.scan?.concurrency;
-
-    applyEnvOverrides(config);
-
-    expect(config.scan?.concurrency).toBe(originalConcurrency);
-  });
-
-  test("ignores empty string env values", () => {
-    process.env.GITTY_GITHUB_VISIBILITY = "";
-    const config = createBaseConfig();
-
-    const result = applyEnvOverrides(config);
-
-    // Empty env values should be ignored, keeping the original value
-    expect(result.github?.defaultVisibility).toBe("private");
-  });
-
-  test("creates missing parent objects", () => {
-    process.env.GITTY_CACHE_TTL = "900";
-    // Start with a minimal but complete config
-    const config: GitforestConfig = {
-      directories: [{ path: "/test", maxDepth: 1 }],
-      scan: { ignore: [], includeHidden: false, concurrency: 4 },
-      github: { defaultVisibility: "private" },
-      display: { showSubmodules: true, showNonGitProjects: true, sortBy: "status", sortDirection: "desc" },
-      cache: { 
-        ttlSeconds: 300,
-        githubTtlSeconds: 600,
-        enableBackgroundRefresh: true,
-        backgroundRefreshIntervalSeconds: 300,
-      },
-      commands: [],
-    };
-
-    const result = applyEnvOverrides(config);
-
-    expect(result.cache?.ttlSeconds).toBe(900);
-  });
-});
-
-describe("getSupportedEnvVars", () => {
-  test("returns list of supported env vars", () => {
-    const envVars = getSupportedEnvVars();
-
-    expect(envVars.length).toBeGreaterThan(0);
-    expect(envVars.some((v) => v.env === "GITTY_GITHUB_VISIBILITY")).toBe(true);
-    expect(envVars.some((v) => v.env === "GITTY_CONCURRENCY")).toBe(true);
-  });
-
-  test("each env var has required properties", () => {
-    const envVars = getSupportedEnvVars();
-
-    for (const envVar of envVars) {
-      expect(envVar.env).toBeDefined();
-      expect(envVar.path).toBeDefined();
-      expect(envVar.description).toBeDefined();
-      expect(envVar.env.length).toBeGreaterThan(0);
-      expect(envVar.path.length).toBeGreaterThan(0);
-    }
-  });
-
-  test("path format is dot-separated", () => {
-    const envVars = getSupportedEnvVars();
-    const visibility = envVars.find((v) => v.env === "GITTY_GITHUB_VISIBILITY");
-
-    expect(visibility?.path).toBe("github.defaultVisibility");
-  });
-});
-
-describe("loadConfig - comprehensive tests", () => {
-  let tempDir: string;
-
-  beforeEach(async () => {
-    tempDir = await mkdtemp(join(tmpdir(), "gitforest-config-test-"));
-  });
-
-  afterEach(async () => {
-    await rm(tempDir, { recursive: true, force: true });
-  });
-
-  describe("loadConfig from default location", () => {
-    test("loads config from default location when no path provided", async () => {
-      const configContent = {
-        directories: [{ path: "~/projects", maxDepth: 2 }]
-      };
-      await writeFile(join(tempDir, "gitforest.config.yaml"), stringify(configContent));
-      
-      const config = await loadConfig(undefined, tempDir);
-      expect(config.directories).toHaveLength(1);
-      expect(config.directories[0]?.path).toContain(process.env.HOME || "");
-    });
-
-    test("loads config from custom path", async () => {
-      const configPath = join(tempDir, "custom-config.yaml");
-      const configContent = {
-        directories: [{ path: "/test/path", maxDepth: 3 }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.directories[0]?.path).toBe("/test/path");
-      expect(config.directories[0]?.maxDepth).toBe(3);
-    });
-
-    test("throws error when specified config file does not exist", async () => {
-      // Test with a specific path that doesn't exist
-      const nonExistentPath = join(tempDir, "does-not-exist.yaml");
-      await expect(loadConfig(nonExistentPath)).rejects.toThrow();
-    });
-
-    test("handles YAML parse errors gracefully", async () => {
-      const configPath = join(tempDir, "invalid.yaml");
-      await writeFile(configPath, "invalid: yaml: content: [");
-      
-      await expect(loadConfig(configPath)).rejects.toThrow();
-    });
-
-    test("handles invalid config structure", async () => {
-      const configPath = join(tempDir, "invalid-structure.yaml");
-      const invalidConfig = {
-        directories: [{ path: 123 }], // path should be string
-      };
-      await writeFile(configPath, stringify(invalidConfig));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Invalid config file/);
-    });
-
-    test("expands ~ in directory paths", async () => {
-      const configPath = join(tempDir, "tilde-config.yaml");
-      const configContent = {
-        directories: [
-          { path: "~/projects" },
-          { path: "~/work/test" },
-          { path: "/absolute/path" }
-        ]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.directories[0]?.path).toBe(join(process.env.HOME || "", "projects"));
-      expect(config.directories[1]?.path).toBe(join(process.env.HOME || "", "work/test"));
-      expect(config.directories[2]?.path).toBe("/absolute/path");
-    });
-
-    test("expands environment variables in paths", async () => {
-      process.env.TEST_PROJECTS_DIR = "/test/projects";
-      const configPath = join(tempDir, "env-var-config.yaml");
-      const configContent = {
-        directories: [
-          { path: "${TEST_PROJECTS_DIR}/frontend" },
-          { path: "~/backend" }
-        ]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      // Note: The current implementation doesn't expand env vars, this is expected behavior
-      expect(config.directories[0]?.path).toBe("${TEST_PROJECTS_DIR}/frontend");
-      delete process.env.TEST_PROJECTS_DIR;
-    });
-  });
-
-  describe("Validation tests", () => {
-    test("validates required directories field exists", async () => {
-      const configPath = join(tempDir, "no-directories.yaml");
-      const configContent = {
-        scan: { ignore: ["node_modules"] }
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Invalid config file/);
-    });
-
-    test("validates directory path is non-empty", async () => {
-      const configPath = join(tempDir, "empty-path.yaml");
-      const configContent = {
-        directories: [{ path: "" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Invalid config file/);
-    });
-
-    test("validates maxDepth is within range (0-10)", async () => {
-      const configPath = join(tempDir, "invalid-depth.yaml");
-      const configContent = {
-        directories: [{ path: "~/test", maxDepth: 15 }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Invalid config file/);
-    });
-
-    test("validates scan.concurrency is within range (1-20)", async () => {
-      const configPath = join(tempDir, "invalid-concurrency.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }],
-        scan: { concurrency: 25 }
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Invalid config file/);
-    });
-
-    test("validates command keys are not reserved", async () => {
-      const configPath = join(tempDir, "reserved-key.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }],
-        commands: [
-          { name: "test", key: "j", command: "echo test" } // 'j' is reserved
-        ]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/reserved/);
-    });
-
-    test("validates no duplicate command keys", async () => {
-      const configPath = join(tempDir, "duplicate-keys.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }],
-        commands: [
-          { name: "test1", key: "t", command: "echo test1" },
-          { name: "test2", key: "t", command: "echo test2" }
-        ]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Duplicate command keys/);
-    });
-
-    test("validates command key is single character", async () => {
-      const configPath = join(tempDir, "multi-char-key.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }],
-        commands: [
-          { name: "test", key: "abc", command: "echo test" }
-        ]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Invalid config file/);
-    });
-  });
-
-  describe("Default values tests", () => {
-    test("uses default ignore patterns", async () => {
-      const configPath = join(tempDir, "default-ignore.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.scan.ignore).toContain("node_modules");
-      expect(config.scan.ignore).toContain(".git");
-      expect(config.scan.ignore).toContain("vendor");
-      expect(config.scan.ignore).toContain("__pycache__");
-      expect(config.scan.ignore).toContain("target");
-      expect(config.scan.ignore).toContain("dist");
-      expect(config.scan.ignore).toContain("build");
-    });
-
-    test("uses default cache TTL", async () => {
-      const configPath = join(tempDir, "default-ttl.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.cache.ttlSeconds).toBe(300);
-      expect(config.cache.githubTtlSeconds).toBe(600);
-    });
-
-    test("uses default concurrency", async () => {
-      const configPath = join(tempDir, "default-concurrency.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.scan.concurrency).toBe(5);
-    });
-
-    test("uses default visibility", async () => {
-      const configPath = join(tempDir, "default-visibility.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.github.defaultVisibility).toBe("private");
-    });
-
-    test("uses default display settings", async () => {
-      const configPath = join(tempDir, "default-display.yaml");
-      const configContent = {
-        directories: [{ path: "~/test" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.display.showSubmodules).toBe(true);
-      expect(config.display.showNonGitProjects).toBe(true);
-      expect(config.display.sortBy).toBe("status");
-      expect(config.display.sortDirection).toBe("desc");
-    });
-  });
-
-  describe("Edge cases", () => {
-    test("handles empty config file", async () => {
-      const configPath = join(tempDir, "empty.yaml");
-      await writeFile(configPath, "");
-      
-      await expect(loadConfig(configPath)).rejects.toThrow();
-    });
-
-    test("handles config with only directories", async () => {
-      const configPath = join(tempDir, "minimal-config.yaml");
-      const configContent = {
-        directories: [{ path: "~/projects" }]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.directories).toHaveLength(1);
-      expect(config.directories[0]?.path).toContain("projects");
-      // All other fields should have defaults
-      expect(config.scan).toBeDefined();
-      expect(config.display).toBeDefined();
-      expect(config.cache).toBeDefined();
-      expect(config.github).toBeDefined();
-    });
-
-    test("handles config with all optional fields", async () => {
-      const configPath = join(tempDir, "full-config.yaml");
-      const configContent = {
-        directories: [
-          { path: "~/projects", maxDepth: 3, label: "My Projects" },
-          { path: "~/work", maxDepth: 2, label: "Work Stuff" }
-        ],
-        scan: {
-          ignore: ["custom_ignore"],
-          includeHidden: true,
-          concurrency: 10
-        },
-        github: {
-          defaultVisibility: "public" as const
-        },
-        display: {
-          showSubmodules: false,
-          showNonGitProjects: false,
-          sortBy: "name" as const,
-          sortDirection: "asc" as const
-        },
-        cache: {
-          ttlSeconds: 600,
-          githubTtlSeconds: 1200,
-          enableBackgroundRefresh: false,
-          backgroundRefreshIntervalSeconds: 600
-        },
-        commands: [
-          { name: "Custom Command", key: "z", command: "echo 'Custom!'", confirm: true, background: false }
-        ]
-      };
-      await writeFile(configPath, stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.directories).toHaveLength(2);
-      expect(config.scan.concurrency).toBe(10);
-      expect(config.github.defaultVisibility).toBe("public");
-      expect(config.display.sortBy).toBe("name");
-      expect(config.display.sortDirection).toBe("asc");
-      expect(config.cache.ttlSeconds).toBe(600);
-      expect(config.commands).toHaveLength(1);
-      expect(config.commands[0]?.key).toBe("z");
-    });
-
-    test("handles JSON config files", async () => {
-      const configPath = join(tempDir, "config.json");
-      const configContent = {
-        directories: [{ path: "~/projects" }]
-      };
-      await writeFile(configPath, JSON.stringify(configContent));
-      
-      const config = await loadConfig(configPath);
-      expect(config.directories).toHaveLength(1);
-      expect(config.directories[0]?.path).toContain("projects");
-    });
-
-    test("throws error for unknown file format", async () => {
-      const configPath = join(tempDir, "config.txt");
-      await writeFile(configPath, "directories: []");
-      
-      await expect(loadConfig(configPath)).rejects.toThrow(/Unknown config file format/);
-    });
-  });
-});