Skip to content

test: add escapePOSIXShell util #55125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 12 commits into from
Sep 29, 2024
Merged

test: add escapePOSIXShell util #55125

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b931733
test: add `escapePOSIXShell` util
aduh95 Jun 10, 2023
7c9f006
fixup! test: add `escapePOSIXShell` util
aduh95 Sep 25, 2024
354271c
fixup! test: add `escapePOSIXShell` util
aduh95 Sep 26, 2024
aaf5b0a
fixup! test: add `escapePOSIXShell` util
aduh95 Sep 27, 2024
779d566
fixup! test: add `escapePOSIXShell` util
aduh95 Sep 27, 2024
38868c2
fixup! test: add `escapePOSIXShell` util
aduh95 Sep 27, 2024
ad045ab
fixup! test: add `escapePOSIXShell` util
aduh95 Sep 28, 2024
4e0ede9
Apply suggestions from code review
aduh95 Sep 29, 2024
d07a1ac
Update test/parallel/test-permission-allow-child-process-cli.js
aduh95 Sep 29, 2024
b3663ac
docs
aduh95 Sep 29, 2024
7215a86
fixup! docs
aduh95 Sep 29, 2024
e0a22b5
fixup! docs
aduh95 Sep 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! test: add escapePOSIXShell util
  • Loading branch information
@aduh95
aduh95 committed Sep 25, 2024
commit 7c9f0060f7515677de6743cac9c6636256473d70
40 changes: 20 additions & 20 deletions test/common/escapePOSIXShell.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
'use strict';

/**
* Escape quoted values in a string template literal. On Windows, this function
* does not escape anything (which is fine for paths, as `"` is not a valid char
* in a path on Windows), so you should use it only to escape paths – or other
* values on tests which are skipped on Windows.
* @returns {[string, object | undefined]} An array that can be passed as
* arguments to `exec` or `execSync`.
*/
* Escape quoted values in a string template literal. On Windows, this function
* does not escape anything (which is fine for paths, as `"` is not a valid char
* in a path on Windows), so you should use it only to escape paths – or other
* values on tests which are skipped on Windows.
* @returns {[string, object | undefined]} An array that can be passed as
* arguments to `exec` or `execSync`.
*/
module.exports = function escapePOSIXShell(cmdParts, ...args) {
if (common.isWindows) {
// On Windows, paths cannot contain `"`, so we can return the string unchanged.
return [String.raw({ raw: cmdParts }, ...args)];
}
// On POSIX shells, we can pass values via the env, as there's a standard way for referencing a variable.
const env = { ...process.env };
let cmd = cmdParts[0];
for (let i = 0; i < args.length; i++) {
const envVarName = `ESCAPED_${i}`;
env[envVarName] = args[i];
cmd += '${' + envVarName + '}' + cmdParts[i + 1];
}
if (process.platform === 'win32') {
// On Windows, paths cannot contain `"`, so we can return the string unchanged.
return [String.raw({ raw: cmdParts }, ...args)];
}
// On POSIX shells, we can pass values via the env, as there's a standard way for referencing a variable.
const env = { ...process.env };
let cmd = cmdParts[0];
for (let i = 0; i < args.length; i++) {
const envVarName = `ESCAPED_${i}`;
env[envVarName] = args[i];
cmd += '${' + envVarName + '}' + cmdParts[i + 1];
}

return [cmd, { env }];
return [cmd, { env }];
};