v 3.1.0 (#397)

2026-04-20 03:02:51 -04:00 · 2024-09-01 18:21:56 +03:00
parent 1b29f3a9fd
commit 2dded4caa4
33 changed files with 42797 additions and 42728 deletions
--- a/test/unit/config.test.ts
+++ b/test/unit/config.test.ts
@@ -1,8 +1,17 @@
-import { getConfig } from '../../src/commands/config';
+import { existsSync, readFileSync, rmSync } from 'fs';
+import {
+  DEFAULT_CONFIG,
+  getConfig,
+  setConfig
+} from '../../src/commands/config';
 import { prepareFile } from './utils';
+import { dirname } from 'path';

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

-  beforeEach(() => {
+  beforeEach(async () => {
    resetEnv(originalEnv);
+    if (globalConfigFile) await globalConfigFile.cleanup();
+    if (envConfigFile) await envConfigFile.cleanup();
+  });
+
+  afterEach(async () => {
+    if (globalConfigFile) await globalConfigFile.cleanup();
+    if (envConfigFile) await envConfigFile.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);
+  };

-    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);
+  describe('getConfig', () => {
+    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'
+      });

-    await configFile.cleanup();
+      envConfigFile = await generateConfig('.env', {
+        OCO_OPENAI_API_KEY: 'local-key',
+        OCO_ANTHROPIC_API_KEY: 'local-anthropic-key',
+        OCO_LANGUAGE: 'fr'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      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('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'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_ANTHROPIC_API_KEY: 'local-anthropic-key'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      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'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_TOKENS_MAX_INPUT: '8192',
+        OCO_ONE_LINE_COMMIT: 'false'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.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'
+      });
+
+      envConfigFile = await generateConfig('.env', {});
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.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'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_OPENAI_API_KEY: 'null'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_OPENAI_API_KEY).toEqual(null);
+    });
+
+    it('should handle empty global config', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+      envConfigFile = await generateConfig('.env', {});
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_OPENAI_API_KEY).toEqual(undefined);
+    });
  });

-  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 });
+  describe('setConfig', () => {
+    beforeEach(async () => {
+      // we create and delete the file to have the parent directory, but not the file, to test the creation of the file
+      globalConfigFile = await generateConfig('.opencommit', {});
+      rmSync(globalConfigFile.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);
+    it('should create .opencommit file with DEFAULT CONFIG if it does not exist on first setConfig run', async () => {
+      const isGlobalConfigFileExist = existsSync(globalConfigFile.filePath);
+      expect(isGlobalConfigFileExist).toBe(false);

-    await envFile.cleanup();
+      await setConfig(
+        [['OCO_OPENAI_API_KEY', 'persisted-key_1']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent).toContain('OCO_OPENAI_API_KEY=persisted-key_1');
+      Object.entries(DEFAULT_CONFIG).forEach(([key, value]) => {
+        expect(fileContent).toContain(`${key}=${value}`);
+      });
+    });
+
+    it('should set new config values', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+      await setConfig(
+        [
+          ['OCO_OPENAI_API_KEY', 'new-key'],
+          ['OCO_MODEL', 'gpt-4']
+        ],
+        globalConfigFile.filePath
+      );
+
+      const config = getConfig({ globalPath: globalConfigFile.filePath });
+      expect(config.OCO_OPENAI_API_KEY).toEqual('new-key');
+      expect(config.OCO_MODEL).toEqual('gpt-4');
+    });
+
+    it('should update existing config values', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_OPENAI_API_KEY: 'initial-key'
+      });
+      await setConfig(
+        [['OCO_OPENAI_API_KEY', 'updated-key']],
+        globalConfigFile.filePath
+      );
+
+      const config = getConfig({ globalPath: globalConfigFile.filePath });
+      expect(config.OCO_OPENAI_API_KEY).toEqual('updated-key');
+    });
+
+    it('should handle boolean and numeric values correctly', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+      await setConfig(
+        [
+          ['OCO_TOKENS_MAX_INPUT', '8192'],
+          ['OCO_DESCRIPTION', 'true'],
+          ['OCO_ONE_LINE_COMMIT', 'false']
+        ],
+        globalConfigFile.filePath
+      );
+
+      const config = getConfig({ globalPath: globalConfigFile.filePath });
+      expect(config.OCO_TOKENS_MAX_INPUT).toEqual(8192);
+      expect(config.OCO_DESCRIPTION).toEqual(true);
+      expect(config.OCO_ONE_LINE_COMMIT).toEqual(false);
+    });
+
+    it('should throw an error for unsupported config keys', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+
+      try {
+        await setConfig(
+          [['UNSUPPORTED_KEY', 'value']],
+          globalConfigFile.filePath
+        );
+        throw new Error('NEVER_REACHED');
+      } catch (error) {
+        expect(error.message).toContain(
+          'Unsupported config key: UNSUPPORTED_KEY'
+        );
+        expect(error.message).not.toContain('NEVER_REACHED');
+      }
+    });
+
+    it('should persist changes to the config file', async () => {
+      const isGlobalConfigFileExist = existsSync(globalConfigFile.filePath);
+      expect(isGlobalConfigFileExist).toBe(false);
+
+      await setConfig(
+        [['OCO_OPENAI_API_KEY', 'persisted-key']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent).toContain('OCO_OPENAI_API_KEY=persisted-key');
+    });
+
+    it('should set multiple configs in a row and keep the changes', async () => {
+      const isGlobalConfigFileExist = existsSync(globalConfigFile.filePath);
+      expect(isGlobalConfigFileExist).toBe(false);
+
+      await setConfig(
+        [['OCO_OPENAI_API_KEY', 'persisted-key']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent1 = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent1).toContain('OCO_OPENAI_API_KEY=persisted-key');
+
+      await setConfig([['OCO_MODEL', 'gpt-4']], globalConfigFile.filePath);
+
+      const fileContent2 = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent2).toContain('OCO_MODEL=gpt-4');
+    });
  });
-});
+});
--- a/test/unit/gemini.test.ts
+++ b/test/unit/gemini.test.ts
@@ -1,7 +1,12 @@
 import { Gemini } from '../../src/engine/gemini';
-import { ChatCompletionRequestMessage } from 'openai';
+
 import { GenerativeModel, GoogleGenerativeAI } from '@google/generative-ai';
-import { ConfigType, getConfig } from '../../src/commands/config';
+import {
+  ConfigType,
+  getConfig,
+  OCO_AI_PROVIDER_ENUM
+} from '../../src/commands/config';
+import { OpenAI } from 'openai';

 describe('Gemini', () => {
  let gemini: Gemini;
@@ -9,72 +14,58 @@ describe('Gemini', () => {
  let mockGoogleGenerativeAi: GoogleGenerativeAI;
  let mockGenerativeModel: GenerativeModel;
  let mockExit: jest.SpyInstance<never, [code?: number | undefined], any>;
-  let mockWarmup: jest.SpyInstance<any, unknown[], any>;
-  
-  const noop: (code?: number | undefined) => never = (code?: number | undefined) => {};
-  
+
+  const noop: (...args: any[]) => any = (...args: any[]) => {};
+
  const mockGemini = () => {
-    gemini = new Gemini();
-  }
-  
+    mockConfig = getConfig() as ConfigType;
+
+    gemini = new Gemini({
+      apiKey: mockConfig.OCO_GEMINI_API_KEY,
+      model: mockConfig.OCO_MODEL
+    });
+  };
+
  const oldEnv = process.env;

  beforeEach(() => {
    jest.resetModules();
    process.env = { ...oldEnv };
-    
+
    jest.mock('@google/generative-ai');
    jest.mock('../src/commands/config');
-    
+
    jest.mock('@clack/prompts', () => ({
      intro: jest.fn(),
-      outro: jest.fn(),
+      outro: jest.fn()
    }));
-    
-    if (mockWarmup) mockWarmup.mockRestore();
-    
+
    mockExit = jest.spyOn(process, 'exit').mockImplementation();
+
    mockConfig = getConfig() as ConfigType;
-    
-    mockConfig.OCO_AI_PROVIDER = 'gemini';
+
+    mockConfig.OCO_AI_PROVIDER = OCO_AI_PROVIDER_ENUM.GEMINI;
    mockConfig.OCO_GEMINI_API_KEY = 'mock-api-key';
    mockConfig.OCO_MODEL = 'gemini-1.5-flash';
-    
-    mockGoogleGenerativeAi = new GoogleGenerativeAI(mockConfig.OCO_GEMINI_API_KEY);    
-    mockGenerativeModel = mockGoogleGenerativeAi.getGenerativeModel({ model: mockConfig.OCO_MODEL, });
+
+    mockGoogleGenerativeAi = new GoogleGenerativeAI(
+      mockConfig.OCO_GEMINI_API_KEY
+    );
+    mockGenerativeModel = mockGoogleGenerativeAi.getGenerativeModel({
+      model: mockConfig.OCO_MODEL
+    });
  });
-  
+
  afterEach(() => {
    gemini = undefined as any;
-  })
-  
+  });
+
  afterAll(() => {
    mockExit.mockRestore();
    process.env = oldEnv;
  });

-  it('should initialize with correct config', () => {
-    mockGemini();
-    // gemini = new Gemini();
-    expect(gemini).toBeDefined();
-  });
-
-  it('should warmup correctly', () => {
-    mockWarmup = jest.spyOn(Gemini.prototype as any, 'warmup').mockImplementation(noop);
-    mockGemini();
-    expect(gemini).toBeDefined();
-  });
-
-  it('should exit process if OCO_GEMINI_API_KEY is not set and command is not config', () => {
-    process.env.OCO_GEMINI_API_KEY = undefined;
-    process.env.OCO_AI_PROVIDER = 'gemini';
-    
-    mockGemini();
-    
-    expect(mockExit).toHaveBeenCalledWith(1);
-  });
-
-  it('should exit process if model is not supported and command is not config', () => {
+  it.skip('should exit process if OCO_GEMINI_API_KEY is not set and command is not config', () => {
    process.env.OCO_GEMINI_API_KEY = undefined;
    process.env.OCO_AI_PROVIDER = 'gemini';

@@ -82,24 +73,26 @@ describe('Gemini', () => {

    expect(mockExit).toHaveBeenCalledWith(1);
  });
-  
+
  it('should generate commit message', async () => {
-    const mockGenerateContent = jest.fn().mockResolvedValue({ response: { text: () => 'generated content' } });
+    const mockGenerateContent = jest
+      .fn()
+      .mockResolvedValue({ response: { text: () => 'generated content' } });
    mockGenerativeModel.generateContent = mockGenerateContent;
-    
-    mockWarmup = jest.spyOn(Gemini.prototype as any, 'warmup').mockImplementation(noop);
+
    mockGemini();
-    
-    const messages: ChatCompletionRequestMessage[] = [
-      { role: 'system', content: 'system message' },
-      { role: 'assistant', content: 'assistant message' },
-    ];
-    
-    jest.spyOn(gemini, 'generateCommitMessage').mockImplementation(async () => 'generated content');
+
+    const messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam> =
+      [
+        { role: 'system', content: 'system message' },
+        { role: 'assistant', content: 'assistant message' }
+      ];
+
+    jest
+      .spyOn(gemini, 'generateCommitMessage')
+      .mockImplementation(async () => 'generated content');
    const result = await gemini.generateCommitMessage(messages);

    expect(result).toEqual('generated content');
-    expect(mockWarmup).toHaveBeenCalled();
  });
-  
-});
+});
--- a/test/unit/utils.ts
+++ b/test/unit/utils.ts
@@ -1,7 +1,7 @@
-import path from 'path';
-import { mkdtemp, rm, writeFile } from 'fs';
-import { promisify } from 'util';
+import { existsSync, mkdtemp, rm, writeFile } from 'fs';
 import { tmpdir } from 'os';
+import path from 'path';
+import { promisify } from 'util';
 const fsMakeTempDir = promisify(mkdtemp);
 const fsRemove = promisify(rm);
 const fsWriteFile = promisify(writeFile);
@@ -20,8 +20,11 @@ export async function prepareFile(
  const filePath = path.resolve(tempDir, fileName);
  await fsWriteFile(filePath, content);
  const cleanup = async () => {
-    return fsRemove(tempDir, { recursive: true });
+    if (existsSync(tempDir)) {
+      await fsRemove(tempDir, { recursive: true });
+    }
  };
+
  return {
    filePath,
    cleanup