use toMatchSnapshot in test (#6344)
This commit is contained in:
parent
31b4c76a6b
commit
b55f19fdfc
|
@ -0,0 +1,33 @@
|
||||||
|
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||||
|
|
||||||
|
exports[`ShellTool > getDescription > should return the non-windows description when not on windows 1`] = `
|
||||||
|
"This tool executes a given shell command as \`bash -c <command>\`. Command can start background processes using \`&\`. Command is executed as a subprocess that leads its own process group. Command process group can be terminated as \`kill -- -PGID\` or signaled as \`kill -s SIGNAL -- -PGID\`.
|
||||||
|
|
||||||
|
The following information is returned:
|
||||||
|
|
||||||
|
Command: Executed command.
|
||||||
|
Directory: Directory (relative to project root) where command was executed, or \`(root)\`.
|
||||||
|
Stdout: Output on stdout stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
||||||
|
Stderr: Output on stderr stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
||||||
|
Error: Error or \`(none)\` if no error was reported for the subprocess.
|
||||||
|
Exit Code: Exit code or \`(none)\` if terminated by signal.
|
||||||
|
Signal: Signal number or \`(none)\` if no signal was received.
|
||||||
|
Background PIDs: List of background processes started or \`(none)\`.
|
||||||
|
Process Group PGID: Process group started or \`(none)\`"
|
||||||
|
`;
|
||||||
|
|
||||||
|
exports[`ShellTool > getDescription > should return the windows description when on windows 1`] = `
|
||||||
|
"This tool executes a given shell command as \`cmd.exe /c <command>\`. Command can start background processes using \`start /b\`.
|
||||||
|
|
||||||
|
The following information is returned:
|
||||||
|
|
||||||
|
Command: Executed command.
|
||||||
|
Directory: Directory (relative to project root) where command was executed, or \`(root)\`.
|
||||||
|
Stdout: Output on stdout stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
||||||
|
Stderr: Output on stderr stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
||||||
|
Error: Error or \`(none)\` if no error was reported for the subprocess.
|
||||||
|
Exit Code: Exit code or \`(none)\` if terminated by signal.
|
||||||
|
Signal: Signal number or \`(none)\` if no signal was received.
|
||||||
|
Background PIDs: List of background processes started or \`(none)\`.
|
||||||
|
Process Group PGID: Process group started or \`(none)\`"
|
||||||
|
`;
|
|
@ -396,39 +396,13 @@ describe('ShellTool', () => {
|
||||||
it('should return the windows description when on windows', () => {
|
it('should return the windows description when on windows', () => {
|
||||||
vi.mocked(os.platform).mockReturnValue('win32');
|
vi.mocked(os.platform).mockReturnValue('win32');
|
||||||
const shellTool = new ShellTool(mockConfig);
|
const shellTool = new ShellTool(mockConfig);
|
||||||
expect(shellTool.description)
|
expect(shellTool.description).toMatchSnapshot();
|
||||||
.toEqual(`This tool executes a given shell command as \`cmd.exe /c <command>\`. Command can start background processes using \`start /b\`.
|
|
||||||
|
|
||||||
The following information is returned:
|
|
||||||
|
|
||||||
Command: Executed command.
|
|
||||||
Directory: Directory (relative to project root) where command was executed, or \`(root)\`.
|
|
||||||
Stdout: Output on stdout stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
|
||||||
Stderr: Output on stderr stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
|
||||||
Error: Error or \`(none)\` if no error was reported for the subprocess.
|
|
||||||
Exit Code: Exit code or \`(none)\` if terminated by signal.
|
|
||||||
Signal: Signal number or \`(none)\` if no signal was received.
|
|
||||||
Background PIDs: List of background processes started or \`(none)\`.
|
|
||||||
Process Group PGID: Process group started or \`(none)\``);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should return the non-windows description when not on windows', () => {
|
it('should return the non-windows description when not on windows', () => {
|
||||||
vi.mocked(os.platform).mockReturnValue('linux');
|
vi.mocked(os.platform).mockReturnValue('linux');
|
||||||
const shellTool = new ShellTool(mockConfig);
|
const shellTool = new ShellTool(mockConfig);
|
||||||
expect(shellTool.description)
|
expect(shellTool.description).toMatchSnapshot();
|
||||||
.toEqual(`This tool executes a given shell command as \`bash -c <command>\`. Command can start background processes using \`&\`. Command is executed as a subprocess that leads its own process group. Command process group can be terminated as \`kill -- -PGID\` or signaled as \`kill -s SIGNAL -- -PGID\`.
|
|
||||||
|
|
||||||
The following information is returned:
|
|
||||||
|
|
||||||
Command: Executed command.
|
|
||||||
Directory: Directory (relative to project root) where command was executed, or \`(root)\`.
|
|
||||||
Stdout: Output on stdout stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
|
||||||
Stderr: Output on stderr stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
|
||||||
Error: Error or \`(none)\` if no error was reported for the subprocess.
|
|
||||||
Exit Code: Exit code or \`(none)\` if terminated by signal.
|
|
||||||
Signal: Signal number or \`(none)\` if no signal was received.
|
|
||||||
Background PIDs: List of background processes started or \`(none)\`.
|
|
||||||
Process Group PGID: Process group started or \`(none)\``);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
Loading…
Reference in New Issue