|
| 1 | +/** |
| 2 | + * @fileoverview Tests for socket package bootstrap and delegation. |
| 3 | + */ |
| 4 | + |
| 5 | +import { spawnSync } from 'node:child_process' |
| 6 | +import { existsSync } from 'node:fs' |
| 7 | +import { promises as fs } from 'node:fs' |
| 8 | +import { homedir, platform, tmpdir } from 'node:os' |
| 9 | +import path from 'node:path' |
| 10 | +import { fileURLToPath } from 'node:url' |
| 11 | +import { brotliCompressSync } from 'node:zlib' |
| 12 | + |
| 13 | +import { describe, expect, it, beforeEach, afterEach } from 'vitest' |
| 14 | + |
| 15 | +const __dirname = path.dirname(fileURLToPath(import.meta.url)) |
| 16 | +const packageDir = path.join(__dirname, '..') |
| 17 | +const bootstrapPath = path.join(packageDir, 'bin', 'bootstrap.js') |
| 18 | +const socketBinPath = path.join(packageDir, 'bin', 'socket.js') |
| 19 | + |
| 20 | +describe('socket package', () => { |
| 21 | + describe('package.json validation', () => { |
| 22 | + it('should have valid package.json metadata', async () => { |
| 23 | + const pkgJson = JSON.parse( |
| 24 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 25 | + ) |
| 26 | + |
| 27 | + expect(pkgJson.name).toBe('socket') |
| 28 | + expect(pkgJson.version).toMatch(/^\d+\.\d+\.\d+$/) |
| 29 | + expect(pkgJson.license).toBe('MIT') |
| 30 | + expect(pkgJson.description).toContain('Socket CLI') |
| 31 | + }) |
| 32 | + |
| 33 | + it('should have correct bin entry', async () => { |
| 34 | + const pkgJson = JSON.parse( |
| 35 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 36 | + ) |
| 37 | + |
| 38 | + expect(pkgJson.bin).toEqual({ |
| 39 | + socket: './bin/socket.js', |
| 40 | + }) |
| 41 | + }) |
| 42 | + |
| 43 | + it('should have all platform optional dependencies', async () => { |
| 44 | + const pkgJson = JSON.parse( |
| 45 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 46 | + ) |
| 47 | + |
| 48 | + const expectedPlatforms = [ |
| 49 | + '@socketbin/cli-alpine-arm64', |
| 50 | + '@socketbin/cli-alpine-x64', |
| 51 | + '@socketbin/cli-darwin-arm64', |
| 52 | + '@socketbin/cli-darwin-x64', |
| 53 | + '@socketbin/cli-linux-arm64', |
| 54 | + '@socketbin/cli-linux-x64', |
| 55 | + '@socketbin/cli-win32-arm64', |
| 56 | + '@socketbin/cli-win32-x64', |
| 57 | + ] |
| 58 | + |
| 59 | + expect(pkgJson.optionalDependencies).toBeDefined() |
| 60 | + for (const platformPkg of expectedPlatforms) { |
| 61 | + expect(pkgJson.optionalDependencies[platformPkg]).toMatch(/^\^?\d+\.\d+\.\d+/) |
| 62 | + } |
| 63 | + }) |
| 64 | + |
| 65 | + it('should include required files', async () => { |
| 66 | + const pkgJson = JSON.parse( |
| 67 | + await fs.readFile(path.join(packageDir, 'package.json'), 'utf-8'), |
| 68 | + ) |
| 69 | + |
| 70 | + expect(pkgJson.files).toContain('bin/') |
| 71 | + }) |
| 72 | + }) |
| 73 | + |
| 74 | + describe('bin scripts exist', () => { |
| 75 | + it('should have socket.js bin script', () => { |
| 76 | + expect(existsSync(socketBinPath)).toBe(true) |
| 77 | + }) |
| 78 | + |
| 79 | + it('should have bootstrap.js', () => { |
| 80 | + expect(existsSync(bootstrapPath)).toBe(true) |
| 81 | + }) |
| 82 | + |
| 83 | + it('socket.js should be executable', async () => { |
| 84 | + if (platform() !== 'win32') { |
| 85 | + const stats = await fs.stat(socketBinPath) |
| 86 | + // Check if user execute bit is set. |
| 87 | + expect((stats.mode & 0o100) !== 0).toBe(true) |
| 88 | + } |
| 89 | + }) |
| 90 | + |
| 91 | + it('socket.js should have node shebang', async () => { |
| 92 | + const content = await fs.readFile(socketBinPath, 'utf-8') |
| 93 | + expect(content.startsWith('#!/usr/bin/env node')).toBe(true) |
| 94 | + }) |
| 95 | + |
| 96 | + it('socket.js should require bootstrap.js', async () => { |
| 97 | + const content = await fs.readFile(socketBinPath, 'utf-8') |
| 98 | + expect(content).toContain("require('./bootstrap.js')") |
| 99 | + }) |
| 100 | + }) |
| 101 | + |
| 102 | + describe('bootstrap logic', () => { |
| 103 | + let testDir |
| 104 | + let originalHome |
| 105 | + |
| 106 | + beforeEach(async () => { |
| 107 | + // Create temp directory for test. |
| 108 | + testDir = await fs.mkdtemp(path.join(tmpdir(), 'socket-test-')) |
| 109 | + originalHome = process.env.HOME |
| 110 | + // Mock home directory to avoid polluting real home. |
| 111 | + process.env.HOME = testDir |
| 112 | + }) |
| 113 | + |
| 114 | + afterEach(async () => { |
| 115 | + // Restore original home. |
| 116 | + process.env.HOME = originalHome |
| 117 | + // Clean up test directory. |
| 118 | + try { |
| 119 | + await fs.rm(testDir, { recursive: true, force: true }) |
| 120 | + } catch { |
| 121 | + // Ignore cleanup errors. |
| 122 | + } |
| 123 | + }) |
| 124 | + |
| 125 | + it.skip('should download and cache CLI on first run', async () => { |
| 126 | + // This test actually downloads from npm - requires npm to be available. |
| 127 | + // Enable with: TEST_NPM_DOWNLOAD=1 pnpm test |
| 128 | + if (!process.env.TEST_NPM_DOWNLOAD) { |
| 129 | + return |
| 130 | + } |
| 131 | + |
| 132 | + const result = spawnSync(process.execPath, [bootstrapPath, '--version'], { |
| 133 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 134 | + timeout: 60000, // 60s for npm download. |
| 135 | + }) |
| 136 | + |
| 137 | + // Should succeed. |
| 138 | + expect(result.status).toBe(0) |
| 139 | + |
| 140 | + // Should output version. |
| 141 | + const stdout = result.stdout.toString() |
| 142 | + expect(stdout).toMatch(/\d+\.\d+\.\d+/) |
| 143 | + |
| 144 | + // Should have cached CLI. |
| 145 | + const cliPath = path.join(testDir, '.socket', '_dlx', 'cli', 'dist', 'cli.js') |
| 146 | + expect(existsSync(cliPath)).toBe(true) |
| 147 | + }, 120000) // 2 min timeout |
| 148 | + |
| 149 | + it('should use cached CLI on subsequent runs', async () => { |
| 150 | + // Pre-create cache directory with mock CLI. |
| 151 | + const cliDir = path.join(testDir, '.socket', '_dlx', 'cli', 'dist') |
| 152 | + await fs.mkdir(cliDir, { recursive: true }) |
| 153 | + |
| 154 | + // Create mock CLI that just prints version. |
| 155 | + const mockCli = ` |
| 156 | + console.log('1.0.0-mock') |
| 157 | + process.exit(0) |
| 158 | + ` |
| 159 | + await fs.writeFile(path.join(cliDir, 'cli.js'), mockCli) |
| 160 | + |
| 161 | + const result = spawnSync(process.execPath, [bootstrapPath, '--version'], { |
| 162 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 163 | + timeout: 5000, |
| 164 | + }) |
| 165 | + |
| 166 | + expect(result.status).toBe(0) |
| 167 | + expect(result.stdout.toString()).toContain('1.0.0-mock') |
| 168 | + }) |
| 169 | + |
| 170 | + it('should use compressed CLI when available', async () => { |
| 171 | + // Pre-create cache directory with compressed CLI. |
| 172 | + const cliDir = path.join(testDir, '.socket', '_dlx', 'cli', 'dist') |
| 173 | + await fs.mkdir(cliDir, { recursive: true }) |
| 174 | + |
| 175 | + // Create mock CLI. |
| 176 | + const mockCli = ` |
| 177 | + console.log('1.0.0-compressed') |
| 178 | + process.exit(0) |
| 179 | + ` |
| 180 | + const compressed = brotliCompressSync(Buffer.from(mockCli)) |
| 181 | + await fs.writeFile(path.join(cliDir, 'cli.js.bz'), compressed) |
| 182 | + |
| 183 | + const result = spawnSync(process.execPath, [bootstrapPath, '--version'], { |
| 184 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 185 | + timeout: 5000, |
| 186 | + }) |
| 187 | + |
| 188 | + expect(result.status).toBe(0) |
| 189 | + expect(result.stdout.toString()).toContain('1.0.0-compressed') |
| 190 | + }) |
| 191 | + |
| 192 | + it('should pass arguments to delegated CLI', async () => { |
| 193 | + // Pre-create cache with mock CLI that echoes args. |
| 194 | + const cliDir = path.join(testDir, '.socket', '_dlx', 'cli', 'dist') |
| 195 | + await fs.mkdir(cliDir, { recursive: true }) |
| 196 | + |
| 197 | + const mockCli = ` |
| 198 | + console.log(JSON.stringify(process.argv.slice(2))) |
| 199 | + process.exit(0) |
| 200 | + ` |
| 201 | + await fs.writeFile(path.join(cliDir, 'cli.js'), mockCli) |
| 202 | + |
| 203 | + const result = spawnSync( |
| 204 | + process.execPath, |
| 205 | + [bootstrapPath, 'report', '--json', 'lodash'], |
| 206 | + { |
| 207 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 208 | + timeout: 5000, |
| 209 | + }, |
| 210 | + ) |
| 211 | + |
| 212 | + expect(result.status).toBe(0) |
| 213 | + const args = JSON.parse(result.stdout.toString()) |
| 214 | + expect(args).toEqual(['report', '--json', 'lodash']) |
| 215 | + }) |
| 216 | + |
| 217 | + it('should set PKG_EXECPATH environment variable', async () => { |
| 218 | + // Pre-create cache with mock CLI that prints env. |
| 219 | + const cliDir = path.join(testDir, '.socket', '_dlx', 'cli', 'dist') |
| 220 | + await fs.mkdir(cliDir, { recursive: true }) |
| 221 | + |
| 222 | + const mockCli = ` |
| 223 | + console.log(process.env.PKG_EXECPATH) |
| 224 | + process.exit(0) |
| 225 | + ` |
| 226 | + await fs.writeFile(path.join(cliDir, 'cli.js'), mockCli) |
| 227 | + |
| 228 | + const result = spawnSync(process.execPath, [bootstrapPath, '--version'], { |
| 229 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 230 | + timeout: 5000, |
| 231 | + }) |
| 232 | + |
| 233 | + expect(result.status).toBe(0) |
| 234 | + expect(result.stdout.toString()).toContain('PKG_INVOKE_NODEJS') |
| 235 | + }) |
| 236 | + |
| 237 | + it('should exit with CLI exit code', async () => { |
| 238 | + // Pre-create cache with mock CLI that exits with code 42. |
| 239 | + const cliDir = path.join(testDir, '.socket', '_dlx', 'cli', 'dist') |
| 240 | + await fs.mkdir(cliDir, { recursive: true }) |
| 241 | + |
| 242 | + const mockCli = ` |
| 243 | + process.exit(42) |
| 244 | + ` |
| 245 | + await fs.writeFile(path.join(cliDir, 'cli.js'), mockCli) |
| 246 | + |
| 247 | + const result = spawnSync(process.execPath, [bootstrapPath], { |
| 248 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 249 | + timeout: 5000, |
| 250 | + }) |
| 251 | + |
| 252 | + expect(result.status).toBe(42) |
| 253 | + }) |
| 254 | + }) |
| 255 | + |
| 256 | + describe('error handling', () => { |
| 257 | + it('should handle missing npm gracefully', async () => { |
| 258 | + const testDir = await fs.mkdtemp(path.join(tmpdir(), 'socket-test-')) |
| 259 | + const originalHome = process.env.HOME |
| 260 | + const originalPath = process.env.PATH |
| 261 | + |
| 262 | + try { |
| 263 | + process.env.HOME = testDir |
| 264 | + // Set PATH to empty to simulate missing npm. |
| 265 | + process.env.PATH = '' |
| 266 | + |
| 267 | + const result = spawnSync(process.execPath, [bootstrapPath, '--version'], { |
| 268 | + stdio: ['ignore', 'pipe', 'pipe'], |
| 269 | + timeout: 5000, |
| 270 | + }) |
| 271 | + |
| 272 | + // Should fail gracefully. |
| 273 | + expect(result.status).not.toBe(0) |
| 274 | + expect(result.stderr.toString()).toContain('Failed to download') |
| 275 | + } finally { |
| 276 | + process.env.HOME = originalHome |
| 277 | + process.env.PATH = originalPath |
| 278 | + await fs.rm(testDir, { recursive: true, force: true }).catch(() => {}) |
| 279 | + } |
| 280 | + }) |
| 281 | + }) |
| 282 | + |
| 283 | + describe('README documentation', () => { |
| 284 | + it('should have README.md', () => { |
| 285 | + const readmePath = path.join(packageDir, 'README.md') |
| 286 | + expect(existsSync(readmePath)).toBe(true) |
| 287 | + }) |
| 288 | + |
| 289 | + it('README should document installation', async () => { |
| 290 | + const readmePath = path.join(packageDir, 'README.md') |
| 291 | + const readme = await fs.readFile(readmePath, 'utf-8') |
| 292 | + expect(readme).toContain('npm install') |
| 293 | + expect(readme).toContain('socket') |
| 294 | + }) |
| 295 | + |
| 296 | + it('README should document how it works', async () => { |
| 297 | + const readmePath = path.join(packageDir, 'README.md') |
| 298 | + const readme = await fs.readFile(readmePath, 'utf-8') |
| 299 | + expect(readme).toContain('@socketsecurity/cli') |
| 300 | + expect(readme).toContain('~/.socket') |
| 301 | + }) |
| 302 | + |
| 303 | + it('README should document platform binaries', async () => { |
| 304 | + const readmePath = path.join(packageDir, 'README.md') |
| 305 | + const readme = await fs.readFile(readmePath, 'utf-8') |
| 306 | + expect(readme).toContain('@socketbin') |
| 307 | + expect(readme).toContain('darwin') |
| 308 | + expect(readme).toContain('linux') |
| 309 | + expect(readme).toContain('win32') |
| 310 | + }) |
| 311 | + }) |
| 312 | +}) |
0 commit comments