1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
|
import {inspect} from 'node:util';
import test from 'ava';
import {isStream} from 'is-stream';
import {execa, execaSync, execaCommand, execaCommandSync, $} from '../index.js';
import {setFixtureDir} from './helpers/fixtures-dir.js';
setFixtureDir();
const command = async (t, expected, ...args) => {
const {command: failCommand} = await t.throwsAsync(execa('fail.js', args));
t.is(failCommand, `fail.js${expected}`);
const {command} = await execa('noop.js', args);
t.is(command, `noop.js${expected}`);
};
command.title = (message, expected) => `command is: ${JSON.stringify(expected)}`;
test(command, ' foo bar', 'foo', 'bar');
test(command, ' baz quz', 'baz', 'quz');
test(command, '');
const testEscapedCommand = async (t, expected, args) => {
const {escapedCommand: failEscapedCommand} = await t.throwsAsync(execa('fail.js', args));
t.is(failEscapedCommand, `fail.js ${expected}`);
const {escapedCommand: failEscapedCommandSync} = t.throws(() => {
execaSync('fail.js', args);
});
t.is(failEscapedCommandSync, `fail.js ${expected}`);
const {escapedCommand} = await execa('noop.js', args);
t.is(escapedCommand, `noop.js ${expected}`);
const {escapedCommand: escapedCommandSync} = execaSync('noop.js', args);
t.is(escapedCommandSync, `noop.js ${expected}`);
};
testEscapedCommand.title = (message, expected) => `escapedCommand is: ${JSON.stringify(expected)}`;
test(testEscapedCommand, 'foo bar', ['foo', 'bar']);
test(testEscapedCommand, '"foo bar"', ['foo bar']);
test(testEscapedCommand, '"\\"foo\\""', ['"foo"']);
test(testEscapedCommand, '"*"', ['*']);
test('allow commands with spaces and no array arguments', async t => {
const {stdout} = await execa('command with space.js');
t.is(stdout, '');
});
test('allow commands with spaces and array arguments', async t => {
const {stdout} = await execa('command with space.js', ['foo', 'bar']);
t.is(stdout, 'foo\nbar');
});
test('execaCommand()', async t => {
const {stdout} = await execaCommand('echo.js foo bar');
t.is(stdout, 'foo\nbar');
});
test('execaCommand() ignores consecutive spaces', async t => {
const {stdout} = await execaCommand('echo.js foo bar');
t.is(stdout, 'foo\nbar');
});
test('execaCommand() allows escaping spaces in commands', async t => {
const {stdout} = await execaCommand('command\\ with\\ space.js foo bar');
t.is(stdout, 'foo\nbar');
});
test('execaCommand() allows escaping spaces in arguments', async t => {
const {stdout} = await execaCommand('echo.js foo\\ bar');
t.is(stdout, 'foo bar');
});
test('execaCommand() escapes other whitespaces', async t => {
const {stdout} = await execaCommand('echo.js foo\tbar');
t.is(stdout, 'foo\tbar');
});
test('execaCommand() trims', async t => {
const {stdout} = await execaCommand(' echo.js foo bar ');
t.is(stdout, 'foo\nbar');
});
test('execaCommandSync()', t => {
const {stdout} = execaCommandSync('echo.js foo bar');
t.is(stdout, 'foo\nbar');
});
test('$', async t => {
const {stdout} = await $`echo.js foo bar`;
t.is(stdout, 'foo\nbar');
});
test('$ accepts options', async t => {
const {stdout} = await $({stripFinalNewline: true})`noop.js foo`;
t.is(stdout, 'foo');
});
test('$ allows string interpolation', async t => {
const {stdout} = await $`echo.js foo ${'bar'}`;
t.is(stdout, 'foo\nbar');
});
test('$ allows number interpolation', async t => {
const {stdout} = await $`echo.js 1 ${2}`;
t.is(stdout, '1\n2');
});
test('$ allows array interpolation', async t => {
const {stdout} = await $`echo.js ${['foo', 'bar']}`;
t.is(stdout, 'foo\nbar');
});
test('$ allows empty array interpolation', async t => {
const {stdout} = await $`echo.js foo ${[]} bar`;
t.is(stdout, 'foo\nbar');
});
test('$ allows execa return value interpolation', async t => {
const foo = await $`echo.js foo`;
const {stdout} = await $`echo.js ${foo} bar`;
t.is(stdout, 'foo\nbar');
});
test('$ allows execa return value array interpolation', async t => {
const foo = await $`echo.js foo`;
const {stdout} = await $`echo.js ${[foo, 'bar']}`;
t.is(stdout, 'foo\nbar');
});
test('$ allows execa return value buffer interpolation', async t => {
const foo = await $({encoding: null})`echo.js foo`;
const {stdout} = await $`echo.js ${foo} bar`;
t.is(stdout, 'foo\nbar');
});
test('$ allows execa return value buffer array interpolation', async t => {
const foo = await $({encoding: null})`echo.js foo`;
const {stdout} = await $`echo.js ${[foo, 'bar']}`;
t.is(stdout, 'foo\nbar');
});
test('$ ignores consecutive spaces', async t => {
const {stdout} = await $`echo.js foo bar`;
t.is(stdout, 'foo\nbar');
});
test('$ allows escaping spaces with interpolation', async t => {
const {stdout} = await $`echo.js ${'foo bar'}`;
t.is(stdout, 'foo bar');
});
test('$ disallows escaping spaces with backslashes', async t => {
const {stdout} = await $`echo.js foo\\ bar`;
t.is(stdout, 'foo\\\nbar');
});
test('$ allows space escaped values in array interpolation', async t => {
const {stdout} = await $`echo.js ${['foo', 'bar baz']}`;
t.is(stdout, 'foo\nbar baz');
});
test('$ passes newline escape sequence as one argument', async t => {
const {stdout} = await $`echo.js \n`;
t.is(stdout, '\n');
});
test('$ passes newline escape sequence in interpolation as one argument', async t => {
const {stdout} = await $`echo.js ${'\n'}`;
t.is(stdout, '\n');
});
test('$ handles invalid escape sequence', async t => {
const {stdout} = await $`echo.js \u`;
t.is(stdout, '\\u');
});
test('$ can concatenate at the end of tokens', async t => {
const {stdout} = await $`echo.js foo${'bar'}`;
t.is(stdout, 'foobar');
});
test('$ does not concatenate at the end of tokens with a space', async t => {
const {stdout} = await $`echo.js foo ${'bar'}`;
t.is(stdout, 'foo\nbar');
});
test('$ can concatenate at the end of tokens followed by an array', async t => {
const {stdout} = await $`echo.js foo${['bar', 'foo']}`;
t.is(stdout, 'foobar\nfoo');
});
test('$ can concatenate at the start of tokens', async t => {
const {stdout} = await $`echo.js ${'foo'}bar`;
t.is(stdout, 'foobar');
});
test('$ does not concatenate at the start of tokens with a space', async t => {
const {stdout} = await $`echo.js ${'foo'} bar`;
t.is(stdout, 'foo\nbar');
});
test('$ can concatenate at the start of tokens followed by an array', async t => {
const {stdout} = await $`echo.js ${['foo', 'bar']}foo`;
t.is(stdout, 'foo\nbarfoo');
});
test('$ can concatenate at the start and end of tokens followed by an array', async t => {
const {stdout} = await $`echo.js foo${['bar', 'foo']}bar`;
t.is(stdout, 'foobar\nfoobar');
});
test('$ can concatenate multiple tokens', async t => {
const {stdout} = await $`echo.js ${'foo'}bar${'foo'}`;
t.is(stdout, 'foobarfoo');
});
test('$ allows escaping spaces in commands with interpolation', async t => {
const {stdout} = await $`${'command with space.js'} foo bar`;
t.is(stdout, 'foo\nbar');
});
test('$ escapes other whitespaces', async t => {
const {stdout} = await $`echo.js foo\tbar`;
t.is(stdout, 'foo\tbar');
});
test('$ trims', async t => {
const {stdout} = await $` echo.js foo bar `;
t.is(stdout, 'foo\nbar');
});
test('$.sync', t => {
const {stdout} = $.sync`echo.js foo bar`;
t.is(stdout, 'foo\nbar');
});
test('$.sync accepts options', t => {
const {stdout} = $({stripFinalNewline: true}).sync`noop.js foo`;
t.is(stdout, 'foo');
});
test('$.sync must be used after options binding, not before', t => {
t.throws(() => $.sync({})`noop.js`, {message: /Please use/});
});
test('$.sync allows execa return value interpolation', t => {
const foo = $.sync`echo.js foo`;
const {stdout} = $.sync`echo.js ${foo} bar`;
t.is(stdout, 'foo\nbar');
});
test('$.sync allows execa return value array interpolation', t => {
const foo = $.sync`echo.js foo`;
const {stdout} = $.sync`echo.js ${[foo, 'bar']}`;
t.is(stdout, 'foo\nbar');
});
test('$.sync allows execa return value buffer interpolation', t => {
const foo = $({encoding: null}).sync`echo.js foo`;
const {stdout} = $.sync`echo.js ${foo} bar`;
t.is(stdout, 'foo\nbar');
});
test('$.sync allows execa return value buffer array interpolation', t => {
const foo = $({encoding: null}).sync`echo.js foo`;
const {stdout} = $.sync`echo.js ${[foo, 'bar']}`;
t.is(stdout, 'foo\nbar');
});
const invalidExpression = test.macro({
async exec(t, input, expected) {
await t.throwsAsync(
async () => $`echo.js ${input}`,
{instanceOf: TypeError, message: expected},
);
t.throws(
() => $.sync`echo.js ${input}`,
{instanceOf: TypeError, message: expected},
);
},
title(prettyInput, input, expected) {
return `$ APIs throw on invalid '${prettyInput ?? inspect(input)}' expression with '${expected}'`;
},
});
test(invalidExpression, undefined, 'Unexpected "undefined" in template expression');
test(invalidExpression, [undefined], 'Unexpected "undefined" in template expression');
test(invalidExpression, null, 'Unexpected "object" in template expression');
test(invalidExpression, [null], 'Unexpected "object" in template expression');
test(invalidExpression, true, 'Unexpected "boolean" in template expression');
test(invalidExpression, [true], 'Unexpected "boolean" in template expression');
test(invalidExpression, {}, 'Unexpected "object" in template expression');
test(invalidExpression, [{}], 'Unexpected "object" in template expression');
test(invalidExpression, {foo: 'bar'}, 'Unexpected "object" in template expression');
test(invalidExpression, [{foo: 'bar'}], 'Unexpected "object" in template expression');
test(invalidExpression, {stdout: undefined}, 'Unexpected "undefined" stdout in template expression');
test(invalidExpression, [{stdout: undefined}], 'Unexpected "undefined" stdout in template expression');
test(invalidExpression, {stdout: 1}, 'Unexpected "number" stdout in template expression');
test(invalidExpression, [{stdout: 1}], 'Unexpected "number" stdout in template expression');
test(invalidExpression, Promise.resolve(), 'Unexpected "object" in template expression');
test(invalidExpression, [Promise.resolve()], 'Unexpected "object" in template expression');
test(invalidExpression, Promise.resolve({stdout: 'foo'}), 'Unexpected "object" in template expression');
test(invalidExpression, [Promise.resolve({stdout: 'foo'})], 'Unexpected "object" in template expression');
test('$`noop.js`', invalidExpression, $`noop.js`, 'Unexpected "object" in template expression');
test('[ $`noop.js` ]', invalidExpression, [$`noop.js`], 'Unexpected "object" in template expression');
test('$({stdio: \'inherit\'}).sync`noop.js`', invalidExpression, $({stdio: 'inherit'}).sync`noop.js`, 'Unexpected "undefined" stdout in template expression');
test('[ $({stdio: \'inherit\'}).sync`noop.js` ]', invalidExpression, [$({stdio: 'inherit'}).sync`noop.js`], 'Unexpected "undefined" stdout in template expression');
test('$ stdin defaults to "inherit"', async t => {
const {stdout} = await $({input: 'foo'})`stdin-script.js`;
t.is(stdout, 'foo');
});
test('$.sync stdin defaults to "inherit"', t => {
const {stdout} = $({input: 'foo'}).sync`stdin-script.js`;
t.is(stdout, 'foo');
});
test('$ stdin has no default value when stdio is set', t => {
t.true(isStream($({stdio: 'pipe'})`noop.js`.stdin));
});
|