feat(core): support run changed tests (#1243)

Author: 9aoy

e2e/filter/changed.test.ts

@@ -0,0 +1,230 @@
+import { mkdtemp, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, it, onTestFinished } from '@rstest/core';
+import { prepareFixtures, runRstestCli } from '../scripts';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const changedFixturePath = join(__dirname, 'fixtures-changed');
+
+const collectRunTestFileLogs = (stdout: string) =>
+  stdout
+    .split('\n')
+    .filter((log) => log.includes('.test.ts') && !log.startsWith('::error'))
+    .sort();
+
+const prepareChangedFixture = async (name: string) => {
+  const fixturesTargetPath = await mkdtemp(join(tmpdir(), `rstest-${name}-`));
+
+  onTestFinished(() =>
+    rm(fixturesTargetPath, {
+      recursive: true,
+      force: true,
+      maxRetries: 10,
+      retryDelay: 500,
+    }),
+  );
+
+  const { fs } = await prepareFixtures({
+    fixturesPath: changedFixturePath,
+    fixturesTargetPath,
+  });
+
+  return { fixturesTargetPath, fs };
+};
+
+const runGit = async (cwd: string, args: string[]) => {
+  const { execFile } = await import('node:child_process');
+  const { promisify } = await import('node:util');
+  const execFileAsync = promisify(execFile);
+
+  await execFileAsync('git', args, { cwd });
+};
+
+const initGitFixture = async (cwd: string) => {
+  await runGit(cwd, ['-c', 'init.defaultBranch=main', 'init']);
+  await runGit(cwd, ['add', '.']);
+  await runGit(cwd, [
+    '-c',
+    'user.name=rstest',
+    '-c',
+    'user.email=rstest@example.com',
+    'commit',
+    '-m',
+    'init',
+  ]);
+};
+
+describe('changed test filtering', () => {
+  it('should reject changed with positional filters', async () => {
+    const { cli, expectExecFailed } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--changed=HEAD', 'src/index.ts'],
+      options: {
+        nodeOptions: {
+          cwd: changedFixturePath,
+        },
+      },
+    });
+
+    await expectExecFailed();
+
+    expect(cli.stderr).toContain(
+      'The `--changed` option cannot be used with positional filters.',
+    );
+  });
+
+  it('should reject changed with related options', async () => {
+    const { cli, expectExecFailed } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--changed', '--related'],
+      options: {
+        nodeOptions: {
+          cwd: changedFixturePath,
+        },
+      },
+    });
+
+    await expectExecFailed();
+
+    expect(cli.stderr).toContain(
+      'Options `--related`, `--findRelatedTests`, and `--changed` cannot be used together.',
+    );
+  });
+
+  it('should print a clear error when changed cannot read Git state', async () => {
+    const { fixturesTargetPath } =
+      await prepareChangedFixture('changed-no-git');
+
+    const { cli, expectExecFailed } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--changed'],
+      options: {
+        nodeOptions: {
+          cwd: fixturesTargetPath,
+          env: {
+            GIT_CEILING_DIRECTORIES: dirname(fixturesTargetPath),
+          },
+        },
+      },
+    });
+
+    await expectExecFailed();
+
+    expect(cli.stderr).toContain(
+      'Failed to resolve changed files for `--changed` from ',
+    );
+    expect(cli.stderr).toContain(
+      '. Make sure the current root is inside a Git repository.',
+    );
+    expect(cli.stderr).toContain('Git error:');
+  });
+
+  it('should run tests related to changed files', async () => {
+    const { fixturesTargetPath, fs } =
+      await prepareChangedFixture('changed-files');
+
+    await initGitFixture(fixturesTargetPath);
+
+    fs.update(join(fixturesTargetPath, 'src/index.ts'), (content) =>
+      content.replace("greet('index')", "greet('index changed')"),
+    );
+
+    const { cli, expectExecFailed } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--changed'],
+      options: {
+        nodeOptions: {
+          cwd: fixturesTargetPath,
+        },
+      },
+    });
+
+    await expectExecFailed();
+
+    const logs = collectRunTestFileLogs(cli.stdout);
+
+    expect(logs).toMatchInlineSnapshot(`
+      [
+        " ✗ index.test.ts (1)",
+      ]
+    `);
+  });
+
+  it('should run tests related to files changed since a commit', async () => {
+    const { fixturesTargetPath, fs } =
+      await prepareChangedFixture('changed-commit');
+
+    await initGitFixture(fixturesTargetPath);
+
+    const { execFile } = await import('node:child_process');
+    const { promisify } = await import('node:util');
+    const execFileAsync = promisify(execFile);
+    const { stdout } = await execFileAsync('git', ['rev-parse', 'HEAD'], {
+      cwd: fixturesTargetPath,
+      encoding: 'utf8',
+    });
+    const baseCommit = stdout.trim();
+
+    fs.update(join(fixturesTargetPath, 'src/other.ts'), (content) =>
+      content.replace("greet('other')", "greet('other changed')"),
+    );
+    await runGit(fixturesTargetPath, ['add', '.']);
+    await runGit(fixturesTargetPath, [
+      '-c',
+      'user.name=rstest',
+      '-c',
+      'user.email=rstest@example.com',
+      'commit',
+      '-m',
+      'change other',
+    ]);
+    fs.update(join(fixturesTargetPath, 'src/index.ts'), (content) =>
+      content.replace("greet('index')", "greet('index changed')"),
+    );
+
+    const { cli, expectExecFailed } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--changed', baseCommit],
+      options: {
+        nodeOptions: {
+          cwd: fixturesTargetPath,
+        },
+      },
+    });
+
+    await expectExecFailed();
+
+    const logs = collectRunTestFileLogs(cli.stdout);
+
+    expect(logs).toMatchInlineSnapshot(`
+      [
+        " ✗ index.test.ts (1)",
+        " ✗ other.test.ts (1)",
+      ]
+    `);
+  });
+
+  it('should pass when changed finds no files', async () => {
+    const { fixturesTargetPath } = await prepareChangedFixture('changed-empty');
+
+    await initGitFixture(fixturesTargetPath);
+
+    const { cli, expectExecSuccess } = await runRstestCli({
+      command: 'rstest',
+      args: ['run', '--changed'],
+      options: {
+        nodeOptions: {
+          cwd: fixturesTargetPath,
+        },
+      },
+    });
+
+    await expectExecSuccess();
+
+    expect(cli.stdout).toContain('No test files found, exiting with code 0.');
+  });
+});

e2e/filter/fixtures-changed/index.test.ts

@@ -0,0 +1,8 @@
+import { describe, expect, it } from '@rstest/core';
+import { sayHi } from './src/index';
+
+describe('index', () => {
+  it('should greet index', () => {
+    expect(sayHi()).toBe('Hello, index!');
+  });
+});

e2e/filter/fixtures-changed/other.test.ts

@@ -0,0 +1,8 @@
+import { describe, expect, it } from '@rstest/core';
+import { sayBye } from './src/other';
+
+describe('other', () => {
+  it('should greet other', () => {
+    expect(sayBye()).toBe('Hello, other!');
+  });
+});

e2e/filter/fixtures-changed/src/index.ts

@@ -0,0 +1,3 @@
+import { greet } from './shared';
+
+export const sayHi = () => greet('index');

e2e/filter/fixtures-changed/src/other.ts

@@ -0,0 +1,3 @@
+import { greet } from './shared';
+
+export const sayBye = () => greet('other');

e2e/filter/fixtures-changed/src/shared.ts

@@ -0,0 +1 @@
+export const greet = (name: string) => `Hello, ${name}!`;