[7.x] Adding console command assertion expectsChoice()

[nuernbergerA]

This PR adds a new console test method for asking choices.

Current State

You can ask a multiple-choice question in a Laravel command with the choice method:

$name = $this->choice('What is your name?', ['Taylor', 'Dayle'], $defaultIndex);

Currently, you can only assert the message of this question and define a reply like:

$this->artisan('question')
  ->expectsQuestion('What is your name?', 'Taylor')
  ->assertExitCode(0);
}

What you cannot test here are the given choices: ['Taylor', 'Dayle']
Depending on how your command looks like, these choices may change through input.

Solution

In order to solve this problem, this PR adds a new method to expect choices. The code above can now be tested like:

$this->artisan('question')
  ->expectsChoice('What is your name?', 'Taylor', ['Taylor', 'Dayle'])
  ->assertExitCode(0);
}

Next to the message and the reply, you can now define the expected available choices as well.

Per default we compare both arrays ignoring the order using assertEqualsCanonicalizing, if needed can switch to assertEquals via a fourth parameter.

$this->artisan('question')
  ->expectsChoice('What is your name?', 'Taylor', ['Taylor', 'Dayle'], true)
  ->assertExitCode(0);
}

[christophrumpel]

+1 👌

[nuernbergerA]

@taylorotwell any idea how we can cover the whole console assertion stuff with tests?