Skip to content

fix(cli-test): remove the trailing newline from parsed cli outputs #2148

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
zimeg merged 4 commits into from
Feb 12, 2025
Merged

fix(cli-test): remove the trailing newline from parsed cli outputs #2148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a7f9a0
fix(cli-test): remove the trailing newline from parsed cli outputs
zimeg Feb 11, 2025
7fbb866
fix: avoid removing newlines from the captured shell output
zimeg Feb 11, 2025
8924b60
test: confirm outputs from the shell are returned unchanged
zimeg Feb 12, 2025
f247cc5
style: match the ordering of unit tests between describe blocks
zimeg Feb 12, 2025
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
16 changes: 16 additions & 0 deletions packages/cli-test/src/cli/shell.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,13 @@ describe('shell module', () => {
sinon.match({ shell: true, env: fakeEnv }),
);
});
it('should return the command outputs unchanged', () => {
const fakeCmd = 'echo';
const fakeArgs = ['"greetings"'];
const sh = shell.spawnProcess(fakeCmd, fakeArgs);
spawnProcess.stdout.emit('data', 'outputs\r\n');
assert.equal(sh.output, 'outputs\r\n');
});
it('should raise bubble error details up', () => {
runSpy.throws(new Error('this is bat country'));
assert.throw(() => {
Expand Down Expand Up @@ -124,6 +131,15 @@ describe('shell module', () => {
sinon.match({ shell: true, env: fakeEnv }),
);
});
it('should return the command outputs unchanged', () => {
const fakeCmd = 'echo';
const fakeArgs = ['"greetings"'];
const sh = shell.spawnProcess(fakeCmd, fakeArgs);
spawnProcess.stdout.emit('data', 'outputs\r\n');
spawnProcess.stderr.emit('data', 'warning\n');
spawnProcess.stdout.emit('data', 'endings\r\n');
assert.equal(sh.output, 'outputs\r\nwarning\nendings\r\n');
});
it('should raise bubble error details up', () => {
spawnSpy.throws(new Error('this is bat country'));
assert.throw(() => {
Expand Down
10 changes: 6 additions & 4 deletions packages/cli-test/src/cli/shell.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,17 @@ export const shell = {
// Listen to data event that returns all the output and collect it
// biome-ignore lint/suspicious/noExplicitAny: stdout can accept a variety of data
childProcess.stdout.on('data', (data: any) => {
sh.output += this.removeANSIcolors(data.toString());
logger.verbose(`Output: ${this.removeANSIcolors(data.toString())}`);
const output = this.removeANSIcolors(data.toString());
sh.output += output;
logger.verbose(`Output: ${output.replace(/\r?\n$/, '')}`);
Copy link
Member

@mwbrooks mwbrooks Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking it to the next level with \r? 🪟

Copy link
Member Author

@zimeg zimeg Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course - always keeping the cartridge return in mind! But only sometimes 😉

});

// Collect error output
// biome-ignore lint/suspicious/noExplicitAny: stderr can accept a variety of data
childProcess.stderr.on('data', (data: any) => {
sh.output += this.removeANSIcolors(data.toString());
logger.error(`Error: ${this.removeANSIcolors(data.toString())}`);
const output = this.removeANSIcolors(data.toString());
sh.output += output;
logger.error(`Error: ${output.replace(/\r?\n$/, '')}`);
});

// Set the finished flag to true on close event
Expand Down