|
| 1 | +/** |
| 2 | + * PR-δ: trivial branch coverage for packages/tar-xz/src/node/file.ts |
| 3 | + * |
| 4 | + * Targets three partial-branch lines identified in post-PR-β coverage report: |
| 5 | + * - file.ts:287 `if (entry.mtime > 0)` — false branch (mtime === 0) |
| 6 | + * - file.ts:519 `if (entry.type === TarEntryType.FILE)` — truthy branch explicit dispatch |
| 7 | + * - file.ts:523 `(entry.mode ?? 0o644)` — mode=0 path (file created with mode 0 & SAFE_MODE_MASK) |
| 8 | + */ |
| 9 | + |
| 10 | +import { promises as fs } from 'node:fs'; |
| 11 | +import * as os from 'node:os'; |
| 12 | +import * as path from 'node:path'; |
| 13 | +import { xzSync } from 'node-liblzma'; |
| 14 | +import { afterEach, beforeEach, describe, expect, it } from 'vitest'; |
| 15 | +import { extractFile } from '../src/node/file.js'; |
| 16 | +import { calculatePadding, createEndOfArchive, createHeader } from '../src/tar/format.js'; |
| 17 | +import { TarEntryType } from '../src/types.js'; |
| 18 | + |
| 19 | +// --------------------------------------------------------------------------- |
| 20 | +// Local TAR builder (mirrors the helper in coverage-final.spec.ts) |
| 21 | +// --------------------------------------------------------------------------- |
| 22 | + |
| 23 | +function buildSingleEntryTar(options: { |
| 24 | + name: string; |
| 25 | + content: Buffer; |
| 26 | + type?: string; |
| 27 | + mtime?: number; |
| 28 | + mode?: number; |
| 29 | +}): Buffer { |
| 30 | + const type = options.type ?? TarEntryType.FILE; |
| 31 | + const isLink = |
| 32 | + type === TarEntryType.SYMLINK || |
| 33 | + type === TarEntryType.HARDLINK || |
| 34 | + type === TarEntryType.DIRECTORY; |
| 35 | + const size = isLink ? 0 : options.content.length; |
| 36 | + |
| 37 | + const header = createHeader({ |
| 38 | + name: options.name, |
| 39 | + size, |
| 40 | + type: type as '0', |
| 41 | + mtime: options.mtime, |
| 42 | + mode: options.mode, |
| 43 | + }); |
| 44 | + |
| 45 | + const blocks: Buffer[] = [Buffer.from(header)]; |
| 46 | + if (size > 0) { |
| 47 | + blocks.push(options.content); |
| 48 | + const pad = calculatePadding(size); |
| 49 | + if (pad > 0) blocks.push(Buffer.alloc(pad)); |
| 50 | + } |
| 51 | + blocks.push(Buffer.from(createEndOfArchive())); |
| 52 | + return Buffer.concat(blocks); |
| 53 | +} |
| 54 | + |
| 55 | +// --------------------------------------------------------------------------- |
| 56 | +// Test 1 — file.ts:287 mtime === 0 → false branch of `if (entry.mtime > 0)` |
| 57 | +// --------------------------------------------------------------------------- |
| 58 | + |
| 59 | +describe('extractFile() — mtime=0 skips utimes call (false branch of mtime > 0)', () => { |
| 60 | + let tempDir: string; |
| 61 | + |
| 62 | + beforeEach(async () => { |
| 63 | + tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'tar-xz-delta-')); |
| 64 | + }); |
| 65 | + |
| 66 | + afterEach(async () => { |
| 67 | + await fs.rm(tempDir, { recursive: true, force: true }).catch(() => {}); |
| 68 | + }); |
| 69 | + |
| 70 | + it('extracts a file entry with mtime=0 without error (utimes is not called)', async () => { |
| 71 | + const content = Buffer.from('content with zero mtime'); |
| 72 | + const rawTar = buildSingleEntryTar({ name: 'zero-mtime.txt', content, mtime: 0 }); |
| 73 | + |
| 74 | + const archivePath = path.join(tempDir, 'mtime0.tar.xz'); |
| 75 | + await fs.writeFile(archivePath, xzSync(rawTar)); |
| 76 | + |
| 77 | + const dest = path.join(tempDir, 'out'); |
| 78 | + await extractFile(archivePath, { cwd: dest }); |
| 79 | + |
| 80 | + const extracted = path.join(dest, 'zero-mtime.txt'); |
| 81 | + const readBack = await fs.readFile(extracted); |
| 82 | + expect(readBack).toEqual(content); |
| 83 | + }); |
| 84 | +}); |
| 85 | + |
| 86 | +// --------------------------------------------------------------------------- |
| 87 | +// Test 2 — file.ts:519 explicit TarEntryType.FILE dispatch |
| 88 | +// --------------------------------------------------------------------------- |
| 89 | + |
| 90 | +describe('extractFile() — explicit TarEntryType.FILE entry type', () => { |
| 91 | + let tempDir: string; |
| 92 | + |
| 93 | + beforeEach(async () => { |
| 94 | + tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'tar-xz-delta-')); |
| 95 | + }); |
| 96 | + |
| 97 | + afterEach(async () => { |
| 98 | + await fs.rm(tempDir, { recursive: true, force: true }).catch(() => {}); |
| 99 | + }); |
| 100 | + |
| 101 | + it('extracts a FILE-type entry when type is explicitly TarEntryType.FILE', async () => { |
| 102 | + const content = Buffer.from('explicit FILE type content'); |
| 103 | + const rawTar = buildSingleEntryTar({ |
| 104 | + name: 'explicit-file-type.txt', |
| 105 | + content, |
| 106 | + type: TarEntryType.FILE, |
| 107 | + }); |
| 108 | + |
| 109 | + const archivePath = path.join(tempDir, 'explicit-type.tar.xz'); |
| 110 | + await fs.writeFile(archivePath, xzSync(rawTar)); |
| 111 | + |
| 112 | + const dest = path.join(tempDir, 'out'); |
| 113 | + await extractFile(archivePath, { cwd: dest }); |
| 114 | + |
| 115 | + const extracted = path.join(dest, 'explicit-file-type.txt'); |
| 116 | + const readBack = await fs.readFile(extracted); |
| 117 | + expect(readBack).toEqual(content); |
| 118 | + }); |
| 119 | +}); |
| 120 | + |
| 121 | +// --------------------------------------------------------------------------- |
| 122 | +// Test 3 — file.ts:523 mode=0 in header → (0 ?? 0o644) & SAFE_MODE_MASK = 0 |
| 123 | +// POSIX-only: mode bits are not fully respected on Windows. |
| 124 | +// --------------------------------------------------------------------------- |
| 125 | + |
| 126 | +describe('extractFile() — mode=0 in TAR header (mode code path, POSIX only)', () => { |
| 127 | + let tempDir: string; |
| 128 | + |
| 129 | + beforeEach(async () => { |
| 130 | + tempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'tar-xz-delta-')); |
| 131 | + }); |
| 132 | + |
| 133 | + afterEach(async () => { |
| 134 | + await fs.rm(tempDir, { recursive: true, force: true }).catch(() => {}); |
| 135 | + }); |
| 136 | + |
| 137 | + it.skipIf(process.platform === 'win32')( |
| 138 | + 'extracts file with mode=0 in header; resulting permission bits are 0 (POSIX only)', |
| 139 | + async () => { |
| 140 | + // Skip also if running as root (root bypasses permission checks) |
| 141 | + if (process.getuid?.() === 0) return; |
| 142 | + |
| 143 | + const content = Buffer.from('zero mode content'); |
| 144 | + // Pass mode: 0 explicitly — createHeader writes octal 0000000 to the mode field. |
| 145 | + // parseOctal returns 0 for an all-zero field, so entry.mode = 0 at extraction time. |
| 146 | + // (0 ?? 0o644) = 0, so fileMode = 0 & SAFE_MODE_MASK = 0. |
| 147 | + const rawTar = buildSingleEntryTar({ name: 'zero-mode.txt', content, mode: 0 }); |
| 148 | + |
| 149 | + const archivePath = path.join(tempDir, 'mode0.tar.xz'); |
| 150 | + await fs.writeFile(archivePath, xzSync(rawTar)); |
| 151 | + |
| 152 | + const dest = path.join(tempDir, 'out'); |
| 153 | + await extractFile(archivePath, { cwd: dest }); |
| 154 | + |
| 155 | + const extracted = path.join(dest, 'zero-mode.txt'); |
| 156 | + |
| 157 | + // File must exist |
| 158 | + const stat = await fs.stat(extracted); |
| 159 | + expect(stat.isFile()).toBe(true); |
| 160 | + |
| 161 | + // Mode bits must be 0 (no permissions) — SAFE_MODE_MASK = 0o0777 |
| 162 | + // stat.mode includes file type bits; mask to permission bits only. |
| 163 | + const permBits = stat.mode & 0o777; |
| 164 | + expect(permBits).toBe(0); |
| 165 | + } |
| 166 | + ); |
| 167 | +}); |
0 commit comments