refactoring_v1 (#391)

2024-08-27 17:04:36 +03:00
parent 68c9ed359c
commit 8fe8e614ac
30 changed files with 41777 additions and 38400 deletions
@@ -3,6 +3,9 @@ import { prepareFile } from './utils';

 describe('getConfig', () => {
  const originalEnv = { ...process.env };
+  let globalConfigFile: { filePath: string; cleanup: () => Promise<void> };
+  let localEnvFile: { filePath: string; cleanup: () => Promise<void> };
+
  function resetEnv(env: NodeJS.ProcessEnv) {
    Object.keys(process.env).forEach((key) => {
      if (!(key in env)) {
@@ -13,93 +16,135 @@ describe('getConfig', () => {
    });
  }

-  beforeEach(() => {
+  beforeEach(async () => {
    resetEnv(originalEnv);
+    if (globalConfigFile) await globalConfigFile.cleanup();
+    if (localEnvFile) await localEnvFile.cleanup();
  });

  afterAll(() => {
    resetEnv(originalEnv);
  });

-  it('return config values from the global config file', async () => {
-    const configFile = await prepareFile(
-      '.opencommit',
-      `
-OCO_OPENAI_API_KEY="sk-key"
-OCO_ANTHROPIC_API_KEY="secret-key"
-OCO_TOKENS_MAX_INPUT="8192"
-OCO_TOKENS_MAX_OUTPUT="1000"
-OCO_OPENAI_BASE_PATH="/openai/api"
-OCO_DESCRIPTION="true"
-OCO_EMOJI="true"
-OCO_MODEL="gpt-4"
-OCO_LANGUAGE="de"
-OCO_MESSAGE_TEMPLATE_PLACEHOLDER="$m"
-OCO_PROMPT_MODULE="@commitlint"
-OCO_AI_PROVIDER="ollama"
-OCO_GITPUSH="false"
-OCO_ONE_LINE_COMMIT="true"
-`
-    );
-    const config = getConfig({ configPath: configFile.filePath, envPath: '' });
+  const generateConfig = async (
+    fileName: string,
+    content: Record<string, string>
+  ) => {
+    const fileContent = Object.entries(content)
+      .map(([key, value]) => `${key}="${value}"`)
+      .join('\n');
+    return await prepareFile(fileName, fileContent);
+  };
+
+  it('should prioritize local .env over global .opencommit config', async () => {
+    globalConfigFile = await generateConfig('.opencommit', {
+      OCO_OPENAI_API_KEY: 'global-key',
+      OCO_MODEL: 'gpt-3.5-turbo',
+      OCO_LANGUAGE: 'en'
+    });
+
+    localEnvFile = await generateConfig('.env', {
+      OCO_OPENAI_API_KEY: 'local-key',
+      OCO_ANTHROPIC_API_KEY: 'local-anthropic-key',
+      OCO_LANGUAGE: 'fr'
+    });
+
+    const config = getConfig({
+      configPath: globalConfigFile.filePath,
+      envPath: localEnvFile.filePath
+    });

    expect(config).not.toEqual(null);
-    expect(config!['OCO_OPENAI_API_KEY']).toEqual('sk-key');
-    expect(config!['OCO_ANTHROPIC_API_KEY']).toEqual('secret-key');
-    expect(config!['OCO_TOKENS_MAX_INPUT']).toEqual(8192);
-    expect(config!['OCO_TOKENS_MAX_OUTPUT']).toEqual(1000);
-    expect(config!['OCO_OPENAI_BASE_PATH']).toEqual('/openai/api');
-    expect(config!['OCO_DESCRIPTION']).toEqual(true);
-    expect(config!['OCO_EMOJI']).toEqual(true);
-    expect(config!['OCO_MODEL']).toEqual('gpt-4');
-    expect(config!['OCO_LANGUAGE']).toEqual('de');
-    expect(config!['OCO_MESSAGE_TEMPLATE_PLACEHOLDER']).toEqual('$m');
-    expect(config!['OCO_PROMPT_MODULE']).toEqual('@commitlint');
-    expect(() => ['ollama', 'gemini'].includes(config!['OCO_AI_PROVIDER'])).toBeTruthy();
-    expect(config!['OCO_GITPUSH']).toEqual(false);
-    expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
-
-    await configFile.cleanup();
+    expect(config.OCO_OPENAI_API_KEY).toEqual('local-key');
+    expect(config.OCO_MODEL).toEqual('gpt-3.5-turbo');
+    expect(config.OCO_LANGUAGE).toEqual('fr');
+    expect(config.OCO_ANTHROPIC_API_KEY).toEqual('local-anthropic-key');
  });

-  it('return config values from the local env file', async () => {
-    const envFile = await prepareFile(
-      '.env',
-      `
-OCO_OPENAI_API_KEY="sk-key"
-OCO_ANTHROPIC_API_KEY="secret-key"
-OCO_TOKENS_MAX_INPUT="8192"
-OCO_TOKENS_MAX_OUTPUT="1000"
-OCO_OPENAI_BASE_PATH="/openai/api"
-OCO_DESCRIPTION="true"
-OCO_EMOJI="true"
-OCO_MODEL="gpt-4"
-OCO_LANGUAGE="de"
-OCO_MESSAGE_TEMPLATE_PLACEHOLDER="$m"
-OCO_PROMPT_MODULE="@commitlint"
-OCO_AI_PROVIDER="ollama"
-OCO_GITPUSH="false"
-OCO_ONE_LINE_COMMIT="true"
-    `
-    );
-    const config = getConfig({ configPath: '', envPath: envFile.filePath });
+  it('should fallback to global config when local config is not set', async () => {
+    globalConfigFile = await generateConfig('.opencommit', {
+      OCO_OPENAI_API_KEY: 'global-key',
+      OCO_MODEL: 'gpt-4',
+      OCO_LANGUAGE: 'de',
+      OCO_DESCRIPTION: 'true'
+    });
+
+    localEnvFile = await generateConfig('.env', {
+      OCO_ANTHROPIC_API_KEY: 'local-anthropic-key'
+    });
+
+    const config = getConfig({
+      configPath: globalConfigFile.filePath,
+      envPath: localEnvFile.filePath
+    });

    expect(config).not.toEqual(null);
-    expect(config!['OCO_OPENAI_API_KEY']).toEqual('sk-key');
-    expect(config!['OCO_ANTHROPIC_API_KEY']).toEqual('secret-key');
-    expect(config!['OCO_TOKENS_MAX_INPUT']).toEqual(8192);
-    expect(config!['OCO_TOKENS_MAX_OUTPUT']).toEqual(1000);
-    expect(config!['OCO_OPENAI_BASE_PATH']).toEqual('/openai/api');
-    expect(config!['OCO_DESCRIPTION']).toEqual(true);
-    expect(config!['OCO_EMOJI']).toEqual(true);
-    expect(config!['OCO_MODEL']).toEqual('gpt-4');
-    expect(config!['OCO_LANGUAGE']).toEqual('de');
-    expect(config!['OCO_MESSAGE_TEMPLATE_PLACEHOLDER']).toEqual('$m');
-    expect(config!['OCO_PROMPT_MODULE']).toEqual('@commitlint');
-    expect(() => ['ollama', 'gemini'].includes(config!['OCO_AI_PROVIDER'])).toBeTruthy();
-    expect(config!['OCO_GITPUSH']).toEqual(false);
-    expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
-
-    await envFile.cleanup();
+    expect(config.OCO_OPENAI_API_KEY).toEqual('global-key');
+    expect(config.OCO_ANTHROPIC_API_KEY).toEqual('local-anthropic-key');
+    expect(config.OCO_MODEL).toEqual('gpt-4');
+    expect(config.OCO_LANGUAGE).toEqual('de');
+    expect(config.OCO_DESCRIPTION).toEqual(true);
  });
-});
+
+  it('should handle boolean and numeric values correctly', async () => {
+    globalConfigFile = await generateConfig('.opencommit', {
+      OCO_TOKENS_MAX_INPUT: '4096',
+      OCO_TOKENS_MAX_OUTPUT: '500',
+      OCO_GITPUSH: 'true'
+    });
+
+    localEnvFile = await generateConfig('.env', {
+      OCO_TOKENS_MAX_INPUT: '8192',
+      OCO_ONE_LINE_COMMIT: 'false'
+    });
+
+    const config = getConfig({
+      configPath: globalConfigFile.filePath,
+      envPath: localEnvFile.filePath
+    });
+
+    expect(config).not.toEqual(null);
+    expect(config.OCO_TOKENS_MAX_INPUT).toEqual(8192);
+    expect(config.OCO_TOKENS_MAX_OUTPUT).toEqual(500);
+    expect(config.OCO_GITPUSH).toEqual(true);
+    expect(config.OCO_ONE_LINE_COMMIT).toEqual(false);
+  });
+
+  it('should handle empty local config correctly', async () => {
+    globalConfigFile = await generateConfig('.opencommit', {
+      OCO_OPENAI_API_KEY: 'global-key',
+      OCO_MODEL: 'gpt-4',
+      OCO_LANGUAGE: 'es'
+    });
+
+    localEnvFile = await generateConfig('.env', {});
+
+    const config = getConfig({
+      configPath: globalConfigFile.filePath,
+      envPath: localEnvFile.filePath
+    });
+
+    expect(config).not.toEqual(null);
+    expect(config.OCO_OPENAI_API_KEY).toEqual('global-key');
+    expect(config.OCO_MODEL).toEqual('gpt-4');
+    expect(config.OCO_LANGUAGE).toEqual('es');
+  });
+
+  it('should override global config with null values in local .env', async () => {
+    globalConfigFile = await generateConfig('.opencommit', {
+      OCO_OPENAI_API_KEY: 'global-key',
+      OCO_MODEL: 'gpt-4',
+      OCO_LANGUAGE: 'es'
+    });
+
+    localEnvFile = await generateConfig('.env', { OCO_OPENAI_API_KEY: 'null' });
+
+    const config = getConfig({
+      configPath: globalConfigFile.filePath,
+      envPath: localEnvFile.filePath
+    });
+
+    expect(config).not.toEqual(null);
+    expect(config.OCO_OPENAI_API_KEY).toEqual(null);
+  });
+});