mirror of
https://github.com/tiennm99/ccs.git
synced 2026-09-02 18:18:43 +00:00
refactor(tests): Phase 4 - Create npm tests using Node.js/mocha
- Add postinstall.test.js for npm postinstall behavior (Section 10) - Add cli.test.js for CLI argument parsing and profile handling - Add cross-platform.test.js for cross-platform compatibility - Tests use mocha framework with comprehensive coverage
This commit is contained in:
kaitranntt
@@ -0,0 +1,161 @@
|
||||
const assert = require('assert');
|
||||
const { execSync } = require('child_process');
|
||||
const path = require('path');
|
||||
const fs = require('fs');
|
||||
const os = require('os');
|
||||
|
||||
describe('npm CLI', () => {
|
||||
const ccsPath = path.join(__dirname, '..', '..', 'bin', 'ccs.js');
|
||||
const ccsDir = path.join(os.homedir(), '.ccs');
|
||||
const configPath = path.join(ccsDir, 'config.json');
|
||||
|
||||
before(() => {
|
||||
// Ensure CCS is installed and configured
|
||||
if (!fs.existsSync(configPath)) {
|
||||
const postinstallScript = path.join(__dirname, '..', '..', 'scripts', 'postinstall.js');
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
}
|
||||
});
|
||||
|
||||
describe('Argument parsing', () => {
|
||||
it('handles flag -c without profile error', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" -c`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
// Should NOT show "Profile '-c' not found" error
|
||||
assert(!output.includes("Profile '-c' not found"), 'Should not treat -c as profile');
|
||||
}
|
||||
});
|
||||
|
||||
it('handles flag --verbose without profile error', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" --verbose`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
assert(!output.includes("Profile '--verbose' not found"), 'Should not treat --verbose as profile');
|
||||
}
|
||||
});
|
||||
|
||||
it('handles flag -p with value', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" -p "test prompt"`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
assert(!output.includes("Profile '-p' not found"), 'Should not treat -p as profile');
|
||||
}
|
||||
});
|
||||
|
||||
it('handles multiple flags', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" -c --verbose`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
assert(!output.includes("Profile '-c' not found"), 'Should not treat flags as profiles');
|
||||
assert(!output.includes("Profile '--verbose' not found"), 'Should not treat flags as profiles');
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('Profile handling', () => {
|
||||
it('loads glm profile', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" glm --help`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || '';
|
||||
assert(!output.includes("Profile 'glm' not found"), 'GLM profile should exist');
|
||||
}
|
||||
});
|
||||
|
||||
it('shows error for invalid profile', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" invalid-profile-name`, { stdio: 'pipe' });
|
||||
assert(false, 'Should have thrown an error for invalid profile');
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
assert(output.includes("not found") || output.includes("invalid"), 'Should show profile not found error');
|
||||
}
|
||||
});
|
||||
|
||||
it('handles profile with flags', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}" glm -c`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
const output = e.stderr?.toString() || '';
|
||||
assert(!output.includes("Profile 'glm' not found"), 'GLM profile should exist');
|
||||
assert(!output.includes("Profile '-c' not found"), 'Should not treat -c as profile');
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('Version and help', () => {
|
||||
it('shows version with --version flag', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
const output = execSync(`node "${ccsPath}" --version`, { encoding: 'utf8' });
|
||||
assert(/\d+\.\d+\.\d+/.test(output), 'Should show version number');
|
||||
});
|
||||
|
||||
it('shows version with -v flag', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
const output = execSync(`node "${ccsPath}" -v`, { encoding: 'utf8' });
|
||||
assert(/\d+\.\d+\.\d+/.test(output), 'Should show version number');
|
||||
});
|
||||
|
||||
it('shows help with --help flag', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
const output = execSync(`node "${ccsPath}" --help`, { encoding: 'utf8' });
|
||||
assert(/usage|help|options/i.test(output), 'Should show help information');
|
||||
});
|
||||
|
||||
it('shows help with -h flag', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
const output = execSync(`node "${ccsPath}" -h`, { encoding: 'utf8' });
|
||||
assert(/usage|help|options/i.test(output), 'Should show help information');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Error handling', () => {
|
||||
it('handles empty arguments gracefully', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
try {
|
||||
execSync(`node "${ccsPath}"`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
// Should either succeed or fail gracefully with a helpful error
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
assert(!output.includes('TypeError') && !output.includes('Cannot read'), 'Should not crash with TypeError');
|
||||
}
|
||||
});
|
||||
|
||||
it('handles very long argument', function() {
|
||||
this.timeout(5000);
|
||||
|
||||
const longArg = 'a'.repeat(1000);
|
||||
try {
|
||||
execSync(`node "${ccsPath}" "${longArg}"`, { stdio: 'pipe' });
|
||||
} catch (e) {
|
||||
// Should handle gracefully, not crash
|
||||
const output = e.stderr?.toString() || e.stdout?.toString() || '';
|
||||
assert(!output.includes('TypeError') && !output.includes('Cannot read'), 'Should not crash with TypeError');
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,123 @@
|
||||
const assert = require('assert');
|
||||
const path = require('path');
|
||||
const os = require('os');
|
||||
|
||||
// Import the expandPath function from bin/helpers.js
|
||||
// Note: This might require adjusting based on the actual location of the helper
|
||||
let expandPath;
|
||||
try {
|
||||
expandPath = require('../../bin/helpers').expandPath;
|
||||
} catch (e) {
|
||||
// If helpers module doesn't exist or doesn't export expandPath, create a mock
|
||||
expandPath = function(p) {
|
||||
if (!p || typeof p !== 'string') return p;
|
||||
if (p.startsWith('~/')) {
|
||||
return path.join(os.homedir(), p.slice(2));
|
||||
}
|
||||
return p;
|
||||
};
|
||||
}
|
||||
|
||||
describe('cross-platform', () => {
|
||||
describe('path expansion', () => {
|
||||
it('expands ~ to home directory', () => {
|
||||
const expanded = expandPath('~/test');
|
||||
const expected = path.join(os.homedir(), 'test');
|
||||
assert.strictEqual(expanded, expected);
|
||||
});
|
||||
|
||||
it('expands ~/.ccs to correct location', () => {
|
||||
const expanded = expandPath('~/.ccs');
|
||||
const expected = path.join(os.homedir(), '.ccs');
|
||||
assert.strictEqual(expanded, expected);
|
||||
});
|
||||
|
||||
it('handles absolute paths without expansion', () => {
|
||||
const absolutePath = path.sep === '/' ? '/tmp/test' : 'C:\\test';
|
||||
const expanded = expandPath(absolutePath);
|
||||
assert.strictEqual(expanded, absolutePath);
|
||||
});
|
||||
|
||||
it('handles relative paths without expansion', () => {
|
||||
const relativePath = 'relative/path';
|
||||
const expanded = expandPath(relativePath);
|
||||
assert.strictEqual(expanded, relativePath);
|
||||
});
|
||||
|
||||
it('handles empty string', () => {
|
||||
const expanded = expandPath('');
|
||||
assert.strictEqual(expanded, '');
|
||||
});
|
||||
|
||||
it('handles null/undefined', () => {
|
||||
assert.strictEqual(expandPath(null), null);
|
||||
assert.strictEqual(expandPath(undefined), undefined);
|
||||
});
|
||||
|
||||
it('handles complex tilde paths', () => {
|
||||
const expanded = expandPath('~/documents/subfolder/file.json');
|
||||
const expected = path.join(os.homedir(), 'documents', 'subfolder', 'file.json');
|
||||
assert.strictEqual(expanded, expected);
|
||||
});
|
||||
});
|
||||
|
||||
describe('platform-specific behavior', () => {
|
||||
it('detects platform correctly', () => {
|
||||
const platform = os.platform();
|
||||
assert(['darwin', 'linux', 'win32'].includes(platform), 'Should be running on supported platform');
|
||||
});
|
||||
|
||||
it('handles path separators correctly', () => {
|
||||
const testPath = path.join('folder', 'subfolder', 'file.txt');
|
||||
assert(testPath.includes(path.sep), 'Should use correct path separator for platform');
|
||||
});
|
||||
|
||||
it('handles home directory paths on all platforms', () => {
|
||||
const homeDir = os.homedir();
|
||||
assert(homeDir, 'Should have a home directory');
|
||||
assert(typeof homeDir === 'string', 'Home directory should be a string');
|
||||
});
|
||||
});
|
||||
|
||||
describe('Node.js compatibility', () => {
|
||||
it('has required Node.js modules available', () => {
|
||||
assert(require('fs'), 'fs module should be available');
|
||||
assert(require('path'), 'path module should be available');
|
||||
assert(require('child_process'), 'child_process module should be available');
|
||||
assert(require('os'), 'os module should be available');
|
||||
});
|
||||
|
||||
it('can spawn child processes', () => {
|
||||
const { spawnSync } = require('child_process');
|
||||
const result = spawnSync('node', ['--version'], { encoding: 'utf8' });
|
||||
assert(result.status === 0, 'Should be able to spawn node process');
|
||||
assert(result.stdout.trim().match(/^v\d+\.\d+\.\d+$/), 'Should return node version');
|
||||
});
|
||||
});
|
||||
|
||||
describe('npm package structure', () => {
|
||||
it('has required executable files', () => {
|
||||
const fs = require('fs');
|
||||
const binDir = path.join(__dirname, '..', '..', 'bin');
|
||||
|
||||
assert(fs.existsSync(path.join(binDir, 'ccs.js')), 'ccs.js should exist in bin directory');
|
||||
});
|
||||
|
||||
it('has required script files', () => {
|
||||
const fs = require('fs');
|
||||
const scriptsDir = path.join(__dirname, '..', '..', 'scripts');
|
||||
|
||||
assert(fs.existsSync(path.join(scriptsDir, 'postinstall.js')), 'postinstall.js should exist');
|
||||
});
|
||||
|
||||
it('has package.json with correct fields', () => {
|
||||
const fs = require('fs');
|
||||
const packagePath = path.join(__dirname, '..', '..', 'package.json');
|
||||
const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
|
||||
|
||||
assert(packageJson.bin, 'package.json should have bin field');
|
||||
assert(packageJson.bin.ccs, 'bin field should specify ccs command');
|
||||
assert(packageJson.scripts, 'package.json should have scripts field');
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,104 @@
|
||||
const assert = require('assert');
|
||||
const { execSync } = require('child_process');
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const os = require('os');
|
||||
|
||||
describe('npm postinstall', () => {
|
||||
const ccsDir = path.join(os.homedir(), '.ccs');
|
||||
const configPath = path.join(ccsDir, 'config.json');
|
||||
const glmPath = path.join(ccsDir, 'glm.settings.json');
|
||||
const postinstallScript = path.join(__dirname, '..', '..', 'scripts', 'postinstall.js');
|
||||
|
||||
beforeEach(() => {
|
||||
// Clean slate before each test
|
||||
if (fs.existsSync(ccsDir)) {
|
||||
fs.rmSync(ccsDir, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
after(() => {
|
||||
// Cleanup after all tests
|
||||
if (fs.existsSync(ccsDir)) {
|
||||
fs.rmSync(ccsDir, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
it('creates config.json', () => {
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
|
||||
assert(fs.existsSync(configPath), 'config.json should be created');
|
||||
|
||||
const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
|
||||
assert(config.profiles, 'config.json should have profiles');
|
||||
assert(typeof config.profiles === 'object', 'profiles should be an object');
|
||||
});
|
||||
|
||||
it('creates glm.settings.json', () => {
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
|
||||
assert(fs.existsSync(glmPath), 'glm.settings.json should be created');
|
||||
|
||||
const glmSettings = JSON.parse(fs.readFileSync(glmPath, 'utf8'));
|
||||
assert(glmSettings.env, 'glm.settings.json should have env section');
|
||||
assert(glmSettings.env.ANTHROPIC_MODEL, 'should have ANTHROPIC_MODEL set');
|
||||
assert.strictEqual(glmSettings.env.ANTHROPIC_MODEL, 'glm-4.6');
|
||||
});
|
||||
|
||||
it('is idempotent', () => {
|
||||
// Run postinstall first time
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
|
||||
// Create custom config
|
||||
const customConfig = {
|
||||
profiles: {
|
||||
custom: '~/.custom.json',
|
||||
glm: '~/.ccs/glm.settings.json'
|
||||
}
|
||||
};
|
||||
fs.writeFileSync(configPath, JSON.stringify(customConfig, null, 2));
|
||||
|
||||
// Run postinstall again
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
|
||||
// Verify custom config preserved
|
||||
const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
|
||||
assert(config.profiles.custom, 'Custom profile should be preserved');
|
||||
assert.strictEqual(config.profiles.custom, '~/.custom.json');
|
||||
});
|
||||
|
||||
it('uses ASCII symbols', () => {
|
||||
const output = execSync(`node "${postinstallScript}"`, { encoding: 'utf8' });
|
||||
|
||||
// Check for ASCII symbols [OK], [!], [X], [i] - not emojis
|
||||
assert(/\[(OK|!|X|i)\]/.test(output), 'Should use ASCII symbols, not emojis');
|
||||
|
||||
// Verify no emojis in output
|
||||
const emojiRegex = /[\u{1F600}-\u{1F64F}]|[\u{1F300}-\u{1F5FF}]|[\u{1F680}-\u{1F6FF}]|[\u{1F1E0}-\u{1F1FF}]|[\u{2600}-\u{26FF}]|[\u{2700}-\u{27BF}]/u;
|
||||
assert(!emojiRegex.test(output), 'Should not contain emojis');
|
||||
});
|
||||
|
||||
it('handles existing directory gracefully', () => {
|
||||
// Create directory manually first
|
||||
fs.mkdirSync(ccsDir, { recursive: true });
|
||||
fs.writeFileSync(path.join(ccsDir, 'existing.txt'), 'exists');
|
||||
|
||||
// Run postinstall
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
|
||||
// Verify existing file still exists and new files are created
|
||||
assert(fs.existsSync(path.join(ccsDir, 'existing.txt')), 'Existing files should be preserved');
|
||||
assert(fs.existsSync(configPath), 'config.json should be created');
|
||||
assert(fs.existsSync(glmPath), 'glm.settings.json should be created');
|
||||
});
|
||||
|
||||
it('creates VERSION file', () => {
|
||||
execSync(`node "${postinstallScript}"`, { stdio: 'ignore' });
|
||||
|
||||
const versionPath = path.join(ccsDir, 'VERSION');
|
||||
assert(fs.existsSync(versionPath), 'VERSION file should be created');
|
||||
|
||||
const version = fs.readFileSync(versionPath, 'utf8').trim();
|
||||
assert(/\d+\.\d+\.\d+/.test(version), 'VERSION should be in semantic version format');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user