Files
repomix-mirror/tests/cli/cliReport.test.ts
Kazuki Yamada e5f7a1f311 fix(shared): Address PR review feedback
- shared/errorHandle: recognize duck-typed OperationCancelledError from
  worker boundaries in isRepomixError (it extends RepomixError but the
  name was missing from the structured-clone fallback comparison).
  Add a regression test for the worker-boundary case.

Test improvements per coderabbit / claude review:
- cliReport: assert skill-directory + relative path on the same log line.
- processConcurrency: restore process.versions.bun by removing the property
  when it didn't originally exist, instead of leaving it defined-as-undefined.
- logger: drop the no-op `process.env.REPOMIX_LOG_LEVEL = undefined` (it
  coerces to the string "undefined" and is overwritten by the next delete).
- unifiedWorker: replace the tautological cache test with one that proves
  cache uniqueness via onWorkerTermination cleanup count; add a test for
  task-based inference overriding workerData (bundled-env reuse).
- calculateMetricsWorker: new direct test for the default export's items
  vs. single-mode dispatch — unifiedWorker mocks this module so the branch
  was otherwise untested.
- packRemoteRepositoryTool: hard-code the expected output path instead of
  expect.any(String) to catch arg-swap regressions.
- memoryUtils: tighten getMemoryStats assertions with sanity bounds
  (heapUsed <= heapTotal, rss > 0, heapUsagePercent <= 100) so a
  unit-conversion regression (bytes vs MB) would fail the test.
2026-04-26 22:20:42 +09:00

404 lines
14 KiB
TypeScript

import path from 'node:path';
import { beforeEach, describe, expect, test, vi } from 'vitest';
import { reportCompletion, reportSecurityCheck, reportSummary, reportTopFiles } from '../../src/cli/cliReport.js';
import type { SuspiciousFileResult } from '../../src/core/security/securityCheck.js';
import type { PackResult } from '../../src/index.js';
import { logger } from '../../src/shared/logger.js';
import { createMockConfig } from '../testing/testUtils.js';
vi.mock('../../src/shared/logger');
vi.mock('picocolors', () => ({
default: {
dim: (str: string) => `DIM:${str}`,
green: (str: string) => `GREEN:${str}`,
yellow: (str: string) => `YELLOW:${str}`,
red: (str: string) => `RED:${str}`,
cyan: (str: string) => `CYAN:${str}`,
underline: (str: string) => `UNDERLINE:${str}`,
},
}));
describe('cliReport', () => {
beforeEach(() => {
vi.resetAllMocks();
});
describe('reportSummary', () => {
test('should print summary with suspicious files and security check enabled', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
const suspiciousFiles: SuspiciousFileResult[] = [
{ filePath: 'suspicious.txt', messages: ['Contains sensitive data'], type: 'file' },
];
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: suspiciousFiles,
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 0,
skippedFiles: [],
};
reportSummary('/test/project', packResult, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('1 suspicious file(s) detected and excluded'));
});
test('should print summary with git diffs included', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
output: { git: { includeDiffs: true } },
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 50,
gitLogTokenCount: 0,
skippedFiles: [],
};
reportSummary('/test/project', packResult, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('Git diffs included'));
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('50 tokens'));
});
test('should print summary with no git diffs', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
output: { git: { includeDiffs: true } },
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 0,
skippedFiles: [],
};
reportSummary('/test/project', packResult, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('No git diffs included'));
});
test('should print summary with git logs included', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
output: { git: { includeLogs: true } },
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 30,
skippedFiles: [],
};
reportSummary('/test/project', packResult, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('Git logs included'));
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('30 tokens'));
});
test('should print summary with no git logs', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
output: { git: { includeLogs: true } },
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 0,
skippedFiles: [],
};
reportSummary('/test/project', packResult, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('No git logs included'));
});
test('should print skill directory output when skillGenerate is configured', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
skillGenerate: true,
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 0,
skippedFiles: [],
};
// Use path.join so the expected substring uses the OS-native separator
// — getDisplayPath calls path.relative, which yields backslashes on Windows.
const cwd = path.join('/test', 'project');
const skillDir = path.join(cwd, '.claude', 'skills', 'test-skill');
const expectedRelative = path.join('.claude', 'skills', 'test-skill');
reportSummary(cwd, packResult, config, { skillDir });
// Both substrings must appear on the SAME log line, not just somewhere across
// separate logger.log calls — otherwise an unrelated line could satisfy each.
const calls = (logger.log as ReturnType<typeof vi.fn>).mock.calls.map((c) => String(c[0]));
const outputLine = calls.find((line) => line.includes('skill directory'));
expect(outputLine).toBeDefined();
expect(outputLine).toContain(expectedRelative);
});
test('should print first…last paths and part count for split outputs', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 0,
skippedFiles: [],
outputFiles: ['repomix-output.1.xml', 'repomix-output.2.xml', 'repomix-output.3.xml'],
};
reportSummary('/test/project', packResult, config);
// first … last (3 parts)
const calls = (logger.log as ReturnType<typeof vi.fn>).mock.calls.map((c) => String(c[0]));
const outputLine = calls.find((line) => line.includes('repomix-output.1.xml'));
expect(outputLine).toBeDefined();
expect(outputLine).toContain('repomix-output.3.xml');
expect(outputLine).toContain('3 parts');
});
test('should print summary with security check disabled', () => {
const config = createMockConfig({
security: { enableSecurityCheck: false },
});
const packResult: PackResult = {
totalFiles: 10,
totalCharacters: 1000,
totalTokens: 200,
fileCharCounts: { 'file1.txt': 100 },
fileTokenCounts: { 'file1.txt': 50 },
suspiciousFilesResults: [],
suspiciousGitDiffResults: [],
suspiciousGitLogResults: [],
processedFiles: [],
safeFilePaths: [],
gitDiffTokenCount: 0,
gitLogTokenCount: 0,
skippedFiles: [],
};
reportSummary('/test/project', packResult, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('Security check disabled'));
});
});
describe('reportSecurityCheck', () => {
test('should skip printing when security check is disabled', () => {
const config = createMockConfig({
security: { enableSecurityCheck: false },
});
reportSecurityCheck('/root', [], [], [], config);
expect(logger.log).not.toHaveBeenCalled();
});
test('should print message when no suspicious files found', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
reportSecurityCheck('/root', [], [], [], config);
expect(logger.log).toHaveBeenCalledWith('🔎 Security Check:');
expect(logger.log).toHaveBeenCalledWith('DIM:──────────────────');
expect(logger.log).toHaveBeenCalledWith('GREEN:✔ No suspicious files detected.');
});
test('should print details of suspicious files when found', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
const configRelativePath = path.join('config', 'secrets.txt');
const suspiciousFiles: SuspiciousFileResult[] = [
{
filePath: path.join('/root', configRelativePath),
messages: ['Contains API key', 'Contains password'],
type: 'file',
},
];
reportSecurityCheck('/root', suspiciousFiles, [], [], config);
expect(logger.log).toHaveBeenCalledWith('YELLOW:1 suspicious file(s) detected and excluded from the output:');
expect(logger.log).toHaveBeenCalledWith(`1. ${configRelativePath}`);
expect(logger.log).toHaveBeenCalledWith('DIM: - 2 security issues detected');
expect(logger.log).toHaveBeenCalledWith(
expect.stringContaining('Please review these files for potential sensitive information.'),
);
});
test('should print details of single security issue correctly', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
const suspiciousFiles: SuspiciousFileResult[] = [
{
filePath: path.join('/root', 'secret.txt'),
messages: ['Contains API key'],
type: 'file',
},
];
reportSecurityCheck('/root', suspiciousFiles, [], [], config);
expect(logger.log).toHaveBeenCalledWith('DIM: - 1 security issue detected');
});
test('should print details of suspicious git diffs when found', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
const suspiciousGitDiffResults: SuspiciousFileResult[] = [
{
filePath: 'work_tree',
messages: ['Contains API key'],
type: 'gitDiff',
},
];
reportSecurityCheck('/root', [], suspiciousGitDiffResults, [], config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('1 security issue(s) found in Git diffs:'));
expect(logger.log).toHaveBeenCalledWith(
expect.stringContaining('Note: Git diffs with security issues are still included'),
);
});
test('should print details of suspicious git logs when found', () => {
const config = createMockConfig({
security: { enableSecurityCheck: true },
});
const suspiciousGitLogResults: SuspiciousFileResult[] = [
{
filePath: 'commit_log',
messages: ['Contains password', 'Contains secret'],
type: 'gitLog',
},
];
reportSecurityCheck('/root', [], [], suspiciousGitLogResults, config);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('1 security issue(s) found in Git logs:'));
expect(logger.log).toHaveBeenCalledWith('DIM: - 2 security issues detected');
expect(logger.log).toHaveBeenCalledWith(
expect.stringContaining('Note: Git logs with security issues are still included'),
);
});
});
describe('reportTopFiles', () => {
test('should print top files sorted by character count', () => {
const fileCharCounts = {
'src/index.ts': 1000,
'src/utils.ts': 500,
'README.md': 2000,
};
const fileTokenCounts = {
'src/index.ts': 200,
'src/utils.ts': 100,
'README.md': 400,
};
reportTopFiles(fileCharCounts, fileTokenCounts, 2, 60);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('Top 2 Files'));
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('README.md'));
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('src/index.ts'));
expect(logger.log).not.toHaveBeenCalledWith(expect.stringContaining('src/utils.ts'));
});
test('should handle empty file list', () => {
reportTopFiles({}, {}, 5, 0);
expect(logger.log).toHaveBeenCalledWith(expect.stringContaining('Top 5 Files'));
});
});
describe('reportCompletion', () => {
test('should print completion message', () => {
reportCompletion();
expect(logger.log).toHaveBeenCalledWith('GREEN:🎉 All Done!');
expect(logger.log).toHaveBeenCalledWith('Your repository has been successfully packed.');
});
});
});