PendingCommand
class PendingCommand
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected int|null | $expectedExitCode | The expected exit code. |
|
| protected int|null | $unexpectedExitCode | The unexpected exit code. |
|
| protected bool | $hasExecuted | Determine if the command has executed. |
Methods
Apply the callback if the given "value" is (or resolves to) truthy.
Apply the callback if the given "value" is (or resolves to) falsy.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Call the given Closure with this instance then return the instance.
Create a new pending console command run.
Specify an expected question that will be asked when the command runs.
Specify an expected confirmation question that will be asked when the command runs.
Specify an expected choice question with expected answers that will be asked/shown when the command runs.
Specify an expected search question with an expected search string, followed by an expected choice question with expected answers.
Specify output that should be printed when the command runs.
Specify output that should never be printed when the command runs.
Specify that the given string should be contained in the command output.
Specify that the given string shouldn't be contained in the command output.
Specify a table that should be printed when the command runs.
Specify that the given Prompts info message should be contained in the command output.
Specify that the given Prompts warning message should be contained in the command output.
Specify that the given Prompts error message should be contained in the command output.
Specify that the given Prompts alert message should be contained in the command output.
Specify that the given Prompts intro message should be contained in the command output.
Specify that the given Prompts outro message should be contained in the command output.
Specify a Prompts table that should be printed when the command runs.
Render the given prompt and add the output to the expectations.
Assert that the command has the given exit code.
Assert that the command does not have the given exit code.
Assert that the command has the success exit code.
Assert that the command has the success exit code.
Assert that the command does not have the success exit code.
Execute the command.
Execute the command.
Debug the command.
Determine if expected questions / choices / outputs are fulfilled.
Mock the application's console output.
Flush the expectations from the test case.
Flush all static state.
Handle the object's destruction.
Details
in
Conditionable at line 23
mixed
when(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) truthy.
in
Conditionable at line 56
mixed
unless(mixed $value = null, callable|null $callback = null, callable|null $default = null)
Apply the callback if the given "value" is (or resolves to) falsy.
in
Macroable at line 30
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 44
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 61
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 72
static void
flushMacros()
Flush the existing macros.
Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 83
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 108
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
in
Tappable at line 17
mixed
tap(callable|null $callback = null)
Call the given Closure with this instance then return the instance.
at line 60
__construct(TestCase $test, Container $app, string $command, array $parameters)
Create a new pending console command run.
at line 73
PendingCommand
expectsQuestion(string $question, mixed $answer)
Specify an expected question that will be asked when the command runs.
at line 85
PendingCommand
expectsConfirmation(string $question, string $answer = 'no')
Specify an expected confirmation question that will be asked when the command runs.
at line 95
PendingCommand
expectsChoice(string $question, array|string $answer, array $answers, bool $strict = false)
Specify an expected choice question with expected answers that will be asked/shown when the command runs.
at line 110
PendingCommand
expectsSearch(string $question, array|string $answer, string $search, array $answers)
Specify an expected search question with an expected search string, followed by an expected choice question with expected answers.
at line 122
PendingCommand
expectsOutput(string|null $output = null)
Specify output that should be printed when the command runs.
at line 140
PendingCommand
doesntExpectOutput(string|null $output = null)
Specify output that should never be printed when the command runs.
at line 158
PendingCommand
expectsOutputToContain(string $string)
Specify that the given string should be contained in the command output.
at line 170
PendingCommand
doesntExpectOutputToContain(string $string)
Specify that the given string shouldn't be contained in the command output.
at line 182
PendingCommand
expectsTable(array $headers, array|Arrayable $rows, string $tableStyle = 'default', array $columnStyles = [])
Specify a table that should be printed when the command runs.
at line 211
PendingCommand
expectsPromptsInfo(string $message)
Specify that the given Prompts info message should be contained in the command output.
at line 225
PendingCommand
expectsPromptsWarning(string $message)
Specify that the given Prompts warning message should be contained in the command output.
at line 239
PendingCommand
expectsPromptsError(string $message)
Specify that the given Prompts error message should be contained in the command output.
at line 253
PendingCommand
expectsPromptsAlert(string $message)
Specify that the given Prompts alert message should be contained in the command output.
at line 267
PendingCommand
expectsPromptsIntro(string $message)
Specify that the given Prompts intro message should be contained in the command output.
at line 281
PendingCommand
expectsPromptsOutro(string $message)
Specify that the given Prompts outro message should be contained in the command output.
at line 299
PendingCommand
expectsPromptsTable(array|Collection $headers, array|Collection|null $rows)
Specify a Prompts table that should be printed when the command runs.
at line 311
protected void
expectOutputToContainPrompt(Prompt $prompt)
Render the given prompt and add the output to the expectations.
at line 326
PendingCommand
assertExitCode(int $exitCode)
Assert that the command has the given exit code.
at line 338
PendingCommand
assertNotExitCode(int $exitCode)
Assert that the command does not have the given exit code.
at line 350
PendingCommand
assertSuccessful()
Assert that the command has the success exit code.
at line 360
PendingCommand
assertOk()
Assert that the command has the success exit code.
at line 370
PendingCommand
assertFailed()
Assert that the command does not have the success exit code.
at line 378
int
execute()
Execute the command.
at line 388
int
run()
Execute the command.
at line 436
never
dd()
Debug the command.
at line 455
protected void
verifyExpectations()
Determine if expected questions / choices / outputs are fulfilled.
at line 493
protected
mockConsoleOutput()
Mock the application's console output.
at line 608
protected void
flushExpectations()
Flush the expectations from the test case.
at line 622
static void
flushState()
Flush all static state.
at line 630
__destruct()
Handle the object's destruction.