CliTestTrait
trait CliTestTrait (View source)
CliTestTrait provides an execute()
method that is useful
for launching executable programs in functional tests.
Traits
OutputUtilsTrait provides some useful utility methods for test classes
that define getOutputRaw()
and getErrorOutputRaw()
methods.
Properties
protected int | $timeout | Timeout for command. |
|
protected int | $idleTimeout | Idle timeouts for commands. |
|
protected Process|null | $process |
Methods
Accessor for the last output, non-trimmed.
Accessor for the last stderr output, non-trimmed.
Get command output and simplify things like full paths and extra whitespace.
Returns a simplified version of the error output to facilitate testing.
Remove things like full paths and extra whitespace from the given string.
Accessor for the last output, rtrimmed and split on newlines.
Accessor for the last stderr output, rtrimmed and split on newlines.
Accessor for the last output, decoded from json.
Run a command and return the process without waiting for it to finish.
Actually runs the command.
No description
No description
No description
Borrowed from \Symfony\Component\Process\Exception\ProcessTimedOutException
Checks that the output matches the expected output.
Checks that the error output matches the expected output.
Details
string
getOutputRaw()
Accessor for the last output, non-trimmed.
string
getErrorOutputRaw()
Accessor for the last stderr output, non-trimmed.
protected string
getSimplifiedOutput()
Get command output and simplify things like full paths and extra whitespace.
protected string
getSimplifiedErrorOutput()
Returns a simplified version of the error output to facilitate testing.
protected string
simplifyOutput(string $output)
Remove things like full paths and extra whitespace from the given string.
array
pathsToSimplify()
No description
string
getOutput()
Accessor for the last output, trimmed.
string
getErrorOutput()
Accessor for the last stderr output, trimmed.
array
getOutputAsList()
Accessor for the last output, rtrimmed and split on newlines.
array
getErrorOutputAsList()
Accessor for the last stderr output, rtrimmed and split on newlines.
mixed
getOutputFromJSON(string|int $key = null)
Accessor for the last output, decoded from json.
Process
startExecute(string|array $command, string|null $cd = null, array|null $env = null, string|null $input = null)
Run a command and return the process without waiting for it to finish.
void
execute(array|string $command, int $expected_return = 0, string|null $cd = null, array|null $env = null, string|null $input = null)
Actually runs the command.
static string
escapeshellarg(string $arg)
No description
static bool
isWindows()
No description
static string
_escapeshellargWindows(string $arg)
No description
string
buildProcessMessage()
Borrowed from \Symfony\Component\Process\Exception\ProcessTimedOutException
protected void
assertOutputEquals(string $expected, string $filter = '')
Checks that the output matches the expected output.
This matches against a simplified version of the actual output that has absolute paths and duplicate whitespace removed, to avoid false negatives on minor differences.
protected void
assertErrorOutputEquals(string $expected, string $filter = '')
Checks that the error output matches the expected output.
This matches against a simplified version of the actual output that has absolute paths and duplicate whitespace removed, to avoid false negatives on minor differences.