v 3.0.17 (#366)

test/e2e/noChanges.test.ts

@@ -5,7 +5,6 @@ import { prepareEnvironment } from './utils';
 
 it('cli flow when there are no changes', async () => {
   const { gitDir, cleanup } = await prepareEnvironment();
-
   const { findByText } = await render(`OCO_AI_PROVIDER='test' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
   expect(await findByText('No changes detected')).toBeInTheConsole();
 

test/e2e/oneFile.test.ts

@@ -10,7 +10,6 @@ it('cli flow to generate commit message for 1 new file (staged)', async () => {
   await render('git' ,['add index.ts'], { cwd: gitDir });
 
   const { queryByText, findByText, userEvent } = await render(`OCO_AI_PROVIDER='test' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
-
   expect(await queryByText('No files are staged')).not.toBeInTheConsole();
   expect(await queryByText('Do you want to stage all files and generate commit message?')).not.toBeInTheConsole();
 

test/e2e/prompt-module/commitlint.test.ts

@@ -0,0 +1,224 @@
+import { resolve } from 'path';
+import { render } from 'cli-testing-library';
+import 'cli-testing-library/extend-expect';
+import { prepareEnvironment, wait } from '../utils';
+import path from 'path';
+
+function getAbsolutePath(relativePath: string) {
+  const scriptDir = path.dirname(__filename);
+  return path.resolve(scriptDir, relativePath);
+}
+async function setupCommitlint(dir: string, ver: 9 | 18 | 19) {
+  let packagePath, packageJsonPath, configPath;
+  switch (ver) {
+    case 9:
+      packagePath = getAbsolutePath('./data/commitlint_9/node_modules');
+      packageJsonPath = getAbsolutePath('./data/commitlint_9/package.json');
+      configPath = getAbsolutePath('./data/commitlint_9/commitlint.config.js');
+      break;
+    case 18:
+      packagePath = getAbsolutePath('./data/commitlint_18/node_modules');
+      packageJsonPath = getAbsolutePath('./data/commitlint_18/package.json');
+      configPath = getAbsolutePath('./data/commitlint_18/commitlint.config.js');
+      break;
+    case 19:
+      packagePath = getAbsolutePath('./data/commitlint_19/node_modules');
+      packageJsonPath = getAbsolutePath('./data/commitlint_19/package.json');
+      configPath = getAbsolutePath('./data/commitlint_19/commitlint.config.js');
+      break;
+  }
+  await render('cp', ['-r', packagePath, '.'], { cwd: dir });
+  await render('cp', [packageJsonPath, '.'], { cwd: dir });
+  await render('cp', [configPath, '.'], { cwd: dir });
+  await wait(3000); // Avoid flakiness by waiting
+}
+
+describe('cli flow to run "oco commitlint force"', () => {
+  it('on commitlint@9 using CJS', async () => {
+    const { gitDir, cleanup } = await prepareEnvironment();
+
+    await setupCommitlint(gitDir, 9);
+    const npmList = await render('npm', ['list', '@commitlint/load'], {
+      cwd: gitDir
+    });
+    expect(await npmList.findByText('@commitlint/load@9')).toBeInTheConsole();
+
+    const { findByText } = await render(
+      `
+      OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
+      OCO_PROMPT_MODULE='@commitlint'  \
+      OCO_AI_PROVIDER='test'  \
+      node ${resolve('./out/cli.cjs')} commitlint force \
+    `,
+      [],
+      { cwd: gitDir }
+    );
+
+    expect(
+      await findByText('opencommit — configure @commitlint')
+    ).toBeInTheConsole();
+    expect(
+      await findByText('Read @commitlint configuration')
+    ).toBeInTheConsole();
+
+    expect(
+      await findByText('Generating consistency with given @commitlint rules')
+    ).toBeInTheConsole();
+    expect(
+      await findByText('Done - please review contents of')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+  it('on commitlint@18 using CJS', async () => {
+    const { gitDir, cleanup } = await prepareEnvironment();
+
+    await setupCommitlint(gitDir, 18);
+    const npmList = await render('npm', ['list', '@commitlint/load'], {
+      cwd: gitDir
+    });
+    expect(await npmList.findByText('@commitlint/load@18')).toBeInTheConsole();
+
+    const { findByText } = await render(
+      `
+      OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
+      OCO_PROMPT_MODULE='@commitlint'  \
+      OCO_AI_PROVIDER='test'  \
+      node ${resolve('./out/cli.cjs')} commitlint force \
+    `,
+      [],
+      { cwd: gitDir }
+    );
+
+    expect(
+      await findByText('opencommit — configure @commitlint')
+    ).toBeInTheConsole();
+    expect(
+      await findByText('Read @commitlint configuration')
+    ).toBeInTheConsole();
+
+    expect(
+      await findByText('Generating consistency with given @commitlint rules')
+    ).toBeInTheConsole();
+    expect(
+      await findByText('Done - please review contents of')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+  it('on commitlint@19 using ESM', async () => {
+    const { gitDir, cleanup } = await prepareEnvironment();
+
+    await setupCommitlint(gitDir, 19);
+    const npmList = await render('npm', ['list', '@commitlint/load'], {
+      cwd: gitDir
+    });
+    expect(await npmList.findByText('@commitlint/load@19')).toBeInTheConsole();
+
+    const { findByText } = await render(
+      `
+      OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
+      OCO_PROMPT_MODULE='@commitlint'  \
+      OCO_AI_PROVIDER='test'  \
+      node ${resolve('./out/cli.cjs')} commitlint force \
+    `,
+      [],
+      { cwd: gitDir }
+    );
+
+    expect(
+      await findByText('opencommit — configure @commitlint')
+    ).toBeInTheConsole();
+    expect(
+      await findByText('Read @commitlint configuration')
+    ).toBeInTheConsole();
+
+    expect(
+      await findByText('Generating consistency with given @commitlint rules')
+    ).toBeInTheConsole();
+    expect(
+      await findByText('Done - please review contents of')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+});
+
+describe('cli flow to generate commit message using @commitlint prompt-module', () => {
+  it('on commitlint@19 using ESM', async () => {
+    const { gitDir, cleanup } = await prepareEnvironment();
+
+    // Setup commitlint@19
+    await setupCommitlint(gitDir, 19);
+    const npmList = await render('npm', ['list', '@commitlint/load'], {
+      cwd: gitDir
+    });
+    expect(await npmList.findByText('@commitlint/load@19')).toBeInTheConsole();
+
+    // Run `oco commitlint force`
+    const commitlintForce = await render(
+      `
+      OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
+      OCO_PROMPT_MODULE='@commitlint'  \
+      OCO_AI_PROVIDER='test'  \
+      node ${resolve('./out/cli.cjs')} commitlint force \
+    `,
+      [],
+      { cwd: gitDir }
+    );
+    expect(
+      await commitlintForce.findByText('Done - please review contents of')
+    ).toBeInTheConsole();
+
+    // Run `oco commitlint get`
+    const commitlintGet = await render(
+      `
+      OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
+      OCO_PROMPT_MODULE='@commitlint'  \
+      OCO_AI_PROVIDER='test'  \
+      node ${resolve('./out/cli.cjs')} commitlint get \
+    `,
+      [],
+      { cwd: gitDir }
+    );
+    expect(
+      await commitlintGet.findByText('[object Object]')
+    ).toBeInTheConsole();
+
+    // Run 'oco' using .opencommit-commitlint
+    await render('echo', [`'console.log("Hello World");' > index.ts`], {
+      cwd: gitDir
+    });
+    await render('git', ['add index.ts'], { cwd: gitDir });
+
+    const oco = await render(
+      `
+      OCO_TEST_MOCK_TYPE='commit-message' \
+      OCO_PROMPT_MODULE='@commitlint'  \
+      OCO_AI_PROVIDER='test' \
+      node ${resolve('./out/cli.cjs')} \
+    `,
+      [],
+      { cwd: gitDir }
+    );
+
+    expect(
+      await oco.findByText('Generating the commit message')
+    ).toBeInTheConsole();
+    expect(
+      await oco.findByText('Confirm the commit message?')
+    ).toBeInTheConsole();
+    oco.userEvent.keyboard('[Enter]');
+
+    expect(
+      await oco.findByText('Choose a remote to push to')
+    ).toBeInTheConsole();
+    oco.userEvent.keyboard('[Enter]');
+
+    expect(
+      await oco.findByText('Successfully pushed all commits to origin')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+});

test/e2e/prompt-module/data/commitlint_18/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};

test/e2e/prompt-module/data/commitlint_18/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "commitlint-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0"
+  }
+}

test/e2e/prompt-module/data/commitlint_19/commitlint.config.js

@@ -0,0 +1,3 @@
+export default {
+  extends: ['@commitlint/config-conventional']
+};

test/e2e/prompt-module/data/commitlint_19/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "commitlint-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@commitlint/cli": "^19.0.0",
+    "@commitlint/config-conventional": "^19.0.0"
+  }
+}

test/e2e/prompt-module/data/commitlint_9/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};

test/e2e/prompt-module/data/commitlint_9/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "commitlint-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@commitlint/cli": "^9.0.0",
+    "@commitlint/config-conventional": "^9.0.0"
+  }
+}

test/e2e/setup.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+current_dir=$(pwd)
+setup_dir="$(cd "$(dirname "$0")" && pwd)"
+
+# Set up for prompt-module/commitlint
+cd $setup_dir && cd prompt-module/data/commitlint_9 && npm ci
+cd $setup_dir && cd prompt-module/data/commitlint_18 && npm ci
+cd $setup_dir && cd prompt-module/data/commitlint_19 && npm ci
+
+cd $current_dir

test/e2e/utils.ts

@@ -29,3 +29,5 @@ export const prepareEnvironment = async (): Promise<{
     cleanup,
   }
 }
+
+export const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));

test/jest-setup.ts

@@ -1,5 +1,8 @@
 import 'cli-testing-library/extend-expect'
 import { configure } from 'cli-testing-library'
+import { jest } from '@jest/globals';
+
+global.jest = jest;
 
 /**
  * Adjusted the wait time for waitFor/findByText to 2000ms, because the default 1000ms makes the test results flaky

test/unit/config.test.ts

@@ -55,7 +55,7 @@ OCO_ONE_LINE_COMMIT="true"
     expect(config!['OCO_LANGUAGE']).toEqual('de');
     expect(config!['OCO_MESSAGE_TEMPLATE_PLACEHOLDER']).toEqual('$m');
     expect(config!['OCO_PROMPT_MODULE']).toEqual('@commitlint');
-    expect(config!['OCO_AI_PROVIDER']).toEqual('ollama');
+    expect(() => ['ollama', 'gemini'].includes(config!['OCO_AI_PROVIDER'])).toBeTruthy();
     expect(config!['OCO_GITPUSH']).toEqual(false);
     expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
 
@@ -96,7 +96,7 @@ OCO_ONE_LINE_COMMIT="true"
     expect(config!['OCO_LANGUAGE']).toEqual('de');
     expect(config!['OCO_MESSAGE_TEMPLATE_PLACEHOLDER']).toEqual('$m');
     expect(config!['OCO_PROMPT_MODULE']).toEqual('@commitlint');
-    expect(config!['OCO_AI_PROVIDER']).toEqual('ollama');
+    expect(() => ['ollama', 'gemini'].includes(config!['OCO_AI_PROVIDER'])).toBeTruthy();
     expect(config!['OCO_GITPUSH']).toEqual(false);
     expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
 

test/unit/gemini.test.ts

@@ -0,0 +1,105 @@
+import { Gemini } from '../../src/engine/gemini';
+import { ChatCompletionRequestMessage } from 'openai';
+import { GenerativeModel, GoogleGenerativeAI } from '@google/generative-ai';
+import { ConfigType, getConfig } from '../../src/commands/config';
+
+describe('Gemini', () => {
+  let gemini: Gemini;
+  let mockConfig: ConfigType;
+  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 mockGemini = () => {
+    gemini = new Gemini();
+  }
+  
+  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(),
+    }));
+    
+    if (mockWarmup) mockWarmup.mockRestore();
+    
+    mockExit = jest.spyOn(process, 'exit').mockImplementation();
+    mockConfig = getConfig() as ConfigType;
+    
+    mockConfig.OCO_AI_PROVIDER = '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, });
+  });
+  
+  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', () => {
+    process.env.OCO_GEMINI_API_KEY = undefined;
+    process.env.OCO_AI_PROVIDER = 'gemini';
+
+    mockGemini();
+
+    expect(mockExit).toHaveBeenCalledWith(1);
+  });
+  
+  it('should generate commit message', async () => {
+    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 result = await gemini.generateCommitMessage(messages);
+
+    expect(result).toEqual('generated content');
+    expect(mockWarmup).toHaveBeenCalled();
+  });
+  
+});