/**
* Runs the command and returns the command output and the separated STDERR in the outgoing parameter.
*
* Uses the "system.commandOutputHelper.work.path" config, what is describes the directory where the temporary
* file pointer will be added. (default => /tmp)
*
* @param CommandExecutor $command The command executor object.
* @param string $stdErr The error messages [Outgoing]
*
* @return \YapepBase\Shell\CommandOutput The output of the command.
* @throws \Exception
*/
public function runCommandWithStdErr(CommandExecutor $command, &$stdErr)
{
$dir = Config::getInstance()->get('system.commandOutputHelper.work.path', '/tmp');
$pipePath = tempnam($dir, 'stderr-');
$fileHandler = Application::getInstance()->getDiContainer()->getFileHandler();
try {
posix_mkfifo($pipePath, 0755);
$command->setOutputRedirection(CommandExecutor::OUTPUT_REDIRECT_STDERR, $pipePath);
$result = $command->run();
$stdErr = $fileHandler->getAsString($pipePath);
$fileHandler->remove($pipePath);
} catch (\Exception $e) {
if ($fileHandler->checkIsPathExists($pipePath)) {
$fileHandler->remove($pipePath);
}
throw $e;
}
return $result;
}
/**
* Tests the full command creation method.
*/
public function testGetCommand()
{
$expectedCommand = '/test';
$expectedParams = array('-v' => null, '-t' => 'testValue', null => 'testArgument');
// Test generating the command with the default separator
$command = new CommandExecutor();
$command->setCommand($expectedCommand);
foreach ($expectedParams as $name => $value) {
$command->addParam($name, $value);
}
$expectedOutput = escapeshellarg($expectedCommand) . ' -v -t ' . escapeshellarg('testValue') . ' ' . escapeshellarg('testArgument');
$this->assertSame($expectedOutput, $command->getCommand());
// Test generating the command with an empty separator
$command = new CommandExecutor();
$command->setCommand($expectedCommand);
foreach ($expectedParams as $name => $value) {
$command->addParam($name, $value);
}
$command->setSwitchValueSeparator('');
$expectedOutput = escapeshellarg($expectedCommand) . ' -v -t' . escapeshellarg('testValue') . ' ' . escapeshellarg('testArgument');
$this->assertSame($expectedOutput, $command->getCommand());
// Test generating the command with '=' as the separator
$command = new CommandExecutor();
$command->setCommand($expectedCommand);
foreach ($expectedParams as $name => $value) {
$command->addParam($name, $value);
}
$command->setSwitchValueSeparator('=');
$expectedOutput = escapeshellarg($expectedCommand) . ' -v -t=' . escapeshellarg('testValue') . ' ' . escapeshellarg('testArgument');
$this->assertSame($expectedOutput, $command->getCommand());
// Test with multiple arguments
$command = new CommandExecutor();
$command->setCommand($expectedCommand);
$command->addParam(null, 'testArgument1');
$command->addParam(null, 'testArgument 2');
$expectedOutput = escapeshellarg($expectedCommand) . ' ' . escapeshellarg('testArgument1') . ' ' . escapeshellarg('testArgument 2');
$this->assertSame($expectedOutput, $command->getCommand());
// Test with multiple instances of the same switch
$command = new CommandExecutor();
$command->setCommand($expectedCommand);
$command->addParam('-v');
$command->addParam('-v');
$command->addParam('-v');
$expectedOutput = escapeshellarg($expectedCommand) . ' -v -v -v';
$this->assertSame($expectedOutput, $command->getCommand());
// Test with chained commands
$command1 = new CommandExecutor();
$command2 = new CommandExecutor();
$command3 = new CommandExecutor();
$command1->setCommand('test1')->setChainedCommand($command2, CommandExecutor::OPERATOR_PIPE);
$command2->setCommand('test2')->setChainedCommand($command3, CommandExecutor::OPERATOR_BINARY_AND);
$command3->setCommand('test3');
$expectedOutput = escapeshellarg('test1') . ' | ' . escapeshellarg('test2') . ' && ' . escapeshellarg('test3');
$this->assertSame($expectedOutput, $command1->getCommand(), 'The generated chained command is invalid');
// Test with output redirection and escaping
$command = new CommandExecutor();
$command->setCommand('test')->setOutputRedirection(CommandExecutor::OUTPUT_REDIRECT_STDERR_APPEND, 'error.log');
$expectedOutput = escapeshellarg('test') . ' 2>> ' . escapeshellarg('error.log');
$this->assertSame($expectedOutput, $command->getCommand(), 'The generated output redirected command is invalid');
// Test with output redirection and no escaping
$command = new CommandExecutor();
$command->setCommand('test')->setOutputRedirection(CommandExecutor::OUTPUT_REDIRECT_STDERR, CommandExecutor::REDIRECT_TARGET_STDOUT, false);
$expectedOutput = escapeshellarg('test') . ' 2> &1';
$this->assertSame($expectedOutput, $command->getCommand(), 'The generated output redirected command is invalid');
// Test with output redirection with chaining
$command = new CommandExecutor();
$command2 = new CommandExecutor();
$command2->setCommand('test2');
$command->setCommand('test')->setOutputRedirection(CommandExecutor::OUTPUT_REDIRECT_STDERR, CommandExecutor::REDIRECT_TARGET_STDOUT, false)->setChainedCommand($command2, CommandExecutor::OPERATOR_PIPE);
$expectedOutput = escapeshellarg('test') . ' 2> &1 | ' . escapeshellarg('test2');
$this->assertSame($expectedOutput, $command->getCommand(), 'The generated output redirected and chained command is invalid');
}
