test: ✅ add the first E2E test and configuration to CI (#316)

* add tests

test/Dockerfile

@@ -0,0 +1,21 @@
+FROM ubuntu:latest
+
+RUN apt-get update && apt-get install -y curl git
+
+# Install Node.js v20
+RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
+RUN apt-get install -y nodejs
+
+# Setup git
+RUN git config --global user.email "test@example.com"
+RUN git config --global user.name "Test User"
+
+COPY . /app
+WORKDIR /app
+
+RUN ls -la
+
+RUN npm install
+RUN npm run build
+
+CMD ["npm", "run", "test:e2e"]

test/e2e/noChanges.test.ts

@@ -0,0 +1,13 @@
+import { resolve } from 'path'
+import { render } from 'cli-testing-library'
+import 'cli-testing-library/extend-expect';
+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();
+
+  await cleanup();
+});

test/e2e/oneFile.test.ts

@@ -0,0 +1,56 @@
+import { resolve } from 'path'
+import { render } from 'cli-testing-library'
+import 'cli-testing-library/extend-expect';
+import { prepareEnvironment } from './utils';
+
+it('cli flow to generate commit message for 1 new file (staged)', async () => {
+  const { gitDir, cleanup } = await prepareEnvironment();
+
+  await render('echo' ,[`'console.log("Hello World");' > index.ts`], { cwd: gitDir });
+  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();
+
+  expect(await findByText('Generating the commit message')).toBeInTheConsole();
+  expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Do you want to run `git push`?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Successfully pushed all commits to origin')).toBeInTheConsole();
+
+  await cleanup();
+});
+
+it('cli flow to generate commit message for 1 changed file (not staged)', async () => {
+  const { gitDir, cleanup } = await prepareEnvironment();
+
+  await render('echo' ,[`'console.log("Hello World");' > index.ts`], { cwd: gitDir });
+  await render('git' ,['add index.ts'], { cwd: gitDir });
+  await render('git' ,[`commit -m 'add new file'`], { cwd: gitDir });
+
+  await render('echo' ,[`'console.log("Good night World");' >> index.ts`], { cwd: gitDir });
+
+  const { findByText, userEvent } = await render(`OCO_AI_PROVIDER='test' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
+
+  expect(await findByText('No files are staged')).toBeInTheConsole();
+  expect(await findByText('Do you want to stage all files and generate commit message?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Generating the commit message')).toBeInTheConsole();
+  expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Successfully committed')).toBeInTheConsole();
+
+  expect(await findByText('Do you want to run `git push`?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Successfully pushed all commits to origin')).toBeInTheConsole();
+
+  await cleanup();
+});

test/e2e/utils.ts

@@ -0,0 +1,31 @@
+import path from 'path'
+import { mkdtemp, rm } from 'fs'
+import { promisify } from 'util';
+import { tmpdir } from 'os';
+import { exec } from 'child_process';
+const fsMakeTempDir = promisify(mkdtemp);
+const fsExec = promisify(exec);
+const fsRemove = promisify(rm);
+
+/**
+ * Prepare the environment for the test
+ * Create a temporary git repository in the temp directory
+ */
+export const prepareEnvironment = async (): Promise<{
+  gitDir: string;
+  cleanup: () => Promise<void>;
+}> => {
+  const tempDir = await fsMakeTempDir(path.join(tmpdir(), 'opencommit-test-'));
+  // Create a remote git repository int the temp directory. This is necessary to execute the `git push` command
+  await fsExec('git init --bare remote.git', { cwd: tempDir }); 
+  await fsExec('git clone remote.git test', { cwd: tempDir });
+  const gitDir = path.resolve(tempDir, 'test');
+
+  const cleanup = async () => {
+    return fsRemove(tempDir, { recursive: true });
+  }
+  return {
+    gitDir,
+    cleanup,
+  }
+}

test/jest-setup.ts

@@ -0,0 +1,7 @@
+import 'cli-testing-library/extend-expect'
+import { configure } from 'cli-testing-library'
+
+/**
+ * Adjusted the wait time for waitFor/findByText to 2000ms, because the default 1000ms makes the test results flaky
+ */
+configure({ asyncUtilTimeout: 2000 })