/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { describe, it, expect, beforeAll, afterAll } from 'vitest'; import { escapePath, unescapePath, isSubpath } from './paths.js'; describe('escapePath', () => { it.each([ ['spaces', 'my file.txt', 'my\\ file.txt'], ['tabs', 'file\twith\ttabs.txt', 'file\\\twith\\\ttabs.txt'], ['parentheses', 'file(1).txt', 'file\\(1\\).txt'], ['square brackets', 'file[backup].txt', 'file\\[backup\\].txt'], ['curly braces', 'file{temp}.txt', 'file\\{temp\\}.txt'], ['semicolons', 'file;name.txt', 'file\\;name.txt'], ['ampersands', 'file&name.txt', 'file\\&name.txt'], ['pipes', 'file|name.txt', 'file\\|name.txt'], ['asterisks', 'file*.txt', 'file\\*.txt'], ['question marks', 'file?.txt', 'file\\?.txt'], ['dollar signs', 'file$name.txt', 'file\\$name.txt'], ['backticks', 'file`name.txt', 'file\\`name.txt'], ['single quotes', "file'name.txt", "file\\'name.txt"], ['double quotes', 'file"name.txt', 'file\\"name.txt'], ['hash symbols', 'file#name.txt', 'file\\#name.txt'], ['exclamation marks', 'file!name.txt', 'file\\!name.txt'], ['tildes', 'file~name.txt', 'file\\~name.txt'], [ 'less than and greater than signs', 'file.txt', 'file\\.txt', ], ])('should escape %s', (_, input, expected) => { expect(escapePath(input)).toBe(expected); }); it('should handle multiple special characters', () => { expect(escapePath('my file (backup) [v1.2].txt')).toBe( 'my\\ file\\ \\(backup\\)\\ \\[v1.2\\].txt', ); }); it('should not double-escape already escaped characters', () => { expect(escapePath('my\\ file.txt')).toBe('my\\ file.txt'); expect(escapePath('file\\(name\\).txt')).toBe('file\\(name\\).txt'); }); it('should handle escaped backslashes correctly', () => { // Double backslash (escaped backslash) followed by space should escape the space expect(escapePath('path\\\\ file.txt')).toBe('path\\\\\\ file.txt'); // Triple backslash (escaped backslash + escaping backslash) followed by space should not double-escape expect(escapePath('path\\\\\\ file.txt')).toBe('path\\\\\\ file.txt'); // Quadruple backslash (two escaped backslashes) followed by space should escape the space expect(escapePath('path\\\\\\\\ file.txt')).toBe('path\\\\\\\\\\ file.txt'); }); it('should handle complex escaped backslash scenarios', () => { // Escaped backslash before special character that needs escaping expect(escapePath('file\\\\(test).txt')).toBe('file\\\\\\(test\\).txt'); // Multiple escaped backslashes expect(escapePath('path\\\\\\\\with space.txt')).toBe( 'path\\\\\\\\with\\ space.txt', ); }); it('should handle paths without special characters', () => { expect(escapePath('normalfile.txt')).toBe('normalfile.txt'); expect(escapePath('path/to/normalfile.txt')).toBe('path/to/normalfile.txt'); }); it('should handle complex real-world examples', () => { expect(escapePath('My Documents/Project (2024)/file [backup].txt')).toBe( 'My\\ Documents/Project\\ \\(2024\\)/file\\ \\[backup\\].txt', ); expect(escapePath('file with $special &chars!.txt')).toBe( 'file\\ with\\ \\$special\\ \\&chars\\!.txt', ); }); it('should handle empty strings', () => { expect(escapePath('')).toBe(''); }); it('should handle paths with only special characters', () => { expect(escapePath(' ()[]{};&|*?$`\'"#!~<>')).toBe( '\\ \\(\\)\\[\\]\\{\\}\\;\\&\\|\\*\\?\\$\\`\\\'\\"\\#\\!\\~\\<\\>', ); }); }); describe('unescapePath', () => { it.each([ ['spaces', 'my\\ file.txt', 'my file.txt'], ['tabs', 'file\\\twith\\\ttabs.txt', 'file\twith\ttabs.txt'], ['parentheses', 'file\\(1\\).txt', 'file(1).txt'], ['square brackets', 'file\\[backup\\].txt', 'file[backup].txt'], ['curly braces', 'file\\{temp\\}.txt', 'file{temp}.txt'], ])('should unescape %s', (_, input, expected) => { expect(unescapePath(input)).toBe(expected); }); it('should unescape multiple special characters', () => { expect(unescapePath('my\\ file\\ \\(backup\\)\\ \\[v1.2\\].txt')).toBe( 'my file (backup) [v1.2].txt', ); }); it('should handle paths without escaped characters', () => { expect(unescapePath('normalfile.txt')).toBe('normalfile.txt'); expect(unescapePath('path/to/normalfile.txt')).toBe( 'path/to/normalfile.txt', ); }); it('should handle all special characters', () => { expect( unescapePath( '\\ \\(\\)\\[\\]\\{\\}\\;\\&\\|\\*\\?\\$\\`\\\'\\"\\#\\!\\~\\<\\>', ), ).toBe(' ()[]{};&|*?$`\'"#!~<>'); }); it('should be the inverse of escapePath', () => { const testCases = [ 'my file.txt', 'file(1).txt', 'file[backup].txt', 'My Documents/Project (2024)/file [backup].txt', 'file with $special &chars!.txt', ' ()[]{};&|*?$`\'"#!~<>', 'file\twith\ttabs.txt', ]; testCases.forEach((testCase) => { expect(unescapePath(escapePath(testCase))).toBe(testCase); }); }); it('should handle empty strings', () => { expect(unescapePath('')).toBe(''); }); it('should not affect backslashes not followed by special characters', () => { expect(unescapePath('file\\name.txt')).toBe('file\\name.txt'); expect(unescapePath('path\\to\\file.txt')).toBe('path\\to\\file.txt'); }); it('should handle escaped backslashes in unescaping', () => { // Should correctly unescape when there are escaped backslashes expect(unescapePath('path\\\\\\ file.txt')).toBe('path\\\\ file.txt'); expect(unescapePath('path\\\\\\\\\\ file.txt')).toBe( 'path\\\\\\\\ file.txt', ); expect(unescapePath('file\\\\\\(test\\).txt')).toBe('file\\\\(test).txt'); }); }); describe('isSubpath', () => { it('should return true for a direct subpath', () => { expect(isSubpath('/a/b', '/a/b/c')).toBe(true); }); it('should return true for the same path', () => { expect(isSubpath('/a/b', '/a/b')).toBe(true); }); it('should return false for a parent path', () => { expect(isSubpath('/a/b/c', '/a/b')).toBe(false); }); it('should return false for a completely different path', () => { expect(isSubpath('/a/b', '/x/y')).toBe(false); }); it('should handle relative paths', () => { expect(isSubpath('a/b', 'a/b/c')).toBe(true); expect(isSubpath('a/b', 'a/c')).toBe(false); }); it('should handle paths with ..', () => { expect(isSubpath('/a/b', '/a/b/../b/c')).toBe(true); expect(isSubpath('/a/b', '/a/c/../b')).toBe(true); }); it('should handle root paths', () => { expect(isSubpath('/', '/a')).toBe(true); expect(isSubpath('/a', '/')).toBe(false); }); it('should handle trailing slashes', () => { expect(isSubpath('/a/b/', '/a/b/c')).toBe(true); expect(isSubpath('/a/b', '/a/b/c/')).toBe(true); expect(isSubpath('/a/b/', '/a/b/c/')).toBe(true); }); }); describe('isSubpath on Windows', () => { const originalPlatform = process.platform; beforeAll(() => { Object.defineProperty(process, 'platform', { value: 'win32', }); }); afterAll(() => { Object.defineProperty(process, 'platform', { value: originalPlatform, }); }); it('should return true for a direct subpath on Windows', () => { expect(isSubpath('C:\\Users\\Test', 'C:\\Users\\Test\\file.txt')).toBe( true, ); }); it('should return true for the same path on Windows', () => { expect(isSubpath('C:\\Users\\Test', 'C:\\Users\\Test')).toBe(true); }); it('should return false for a parent path on Windows', () => { expect(isSubpath('C:\\Users\\Test\\file.txt', 'C:\\Users\\Test')).toBe( false, ); }); it('should return false for a different drive on Windows', () => { expect(isSubpath('C:\\Users\\Test', 'D:\\Users\\Test')).toBe(false); }); it('should be case-insensitive for drive letters on Windows', () => { expect(isSubpath('c:\\Users\\Test', 'C:\\Users\\Test\\file.txt')).toBe( true, ); }); it('should be case-insensitive for path components on Windows', () => { expect(isSubpath('C:\\Users\\Test', 'c:\\users\\test\\file.txt')).toBe( true, ); }); it('should handle mixed slashes on Windows', () => { expect(isSubpath('C:/Users/Test', 'C:\\Users\\Test\\file.txt')).toBe(true); }); it('should handle trailing slashes on Windows', () => { expect(isSubpath('C:\\Users\\Test\\', 'C:\\Users\\Test\\file.txt')).toBe( true, ); }); it('should handle relative paths correctly on Windows', () => { expect(isSubpath('Users\\Test', 'Users\\Test\\file.txt')).toBe(true); expect(isSubpath('Users\\Test\\file.txt', 'Users\\Test')).toBe(false); }); });