如何在Laravel 5.4中使用ask（）测试工匠命令

Posted 2021-04-11

尝试使用ask（）函数为laravel php artisan命令编写测试。我之前从未使用过嘲弄，但是当我尝试运行测试时，它会冻结，所以我猜，我做错了什么。

MyCommand.php：

public function handle()
    {
        $input['answer1'] = $this->ask('Ask question 1');
        $input['answer2'] = $this->ask('Ask question 2');
        $input['answer3'] = $this->ask('Ask question 3');


        //--- processing validation        
        $validator = Validator::make($input, [
            'answer1' => 'required',
            'answer2' => 'required',
            'answer3' => 'required',

        ]);

        if ($validator->fails()) {
            // processing error
            }
        } else {
            // saving to DB
        }
    }

我的单元测试：

    $command = m::mock('AppConsoleCommandsQuestions');


            $command->shouldReceive('ask')              
                  ->andReturn('Answer 1')
                  ->shouldReceive('ask')
                  ->andReturn('Answer 2')
                  ->shouldReceive('ask')
                  ->andReturn('Answer 3')


            $this->artisan('myCommand:toRun');

$this->assertDatabaseHas('myTable', [
            'question1' => 'answer1'
        ]);

//

答案

Laravel 5.4 - 5.6

这里的实际问题是运行控制台命令正在等待用户输入，但是我们通过PHPUnit运行它，所以我们无法输入任何内容。

在单元测试中遇到限制可能最初令人沮丧，但是你发现的限制最终可能成为伪装的祝福。

目前，您的实现紧密耦合到一个视图（一个控制台命令，所以一个管理员的视图，但仍然是一个视图）。这里可以做的是将任何逻辑放在一个单独的类中，MyCommand可以利用，以及哪些PHPUnit可以自己测试。我们知道运行自定义命令的基础工作正如Laravel单元测试中所证明的那样，因此我们可以在单独的可测试类中卸载逻辑。

您的新课程可能如下所示：

class CommandLogic
{

    public function getQuestion1Text()
    {
        return 'Ask question 1';
    }

    public function getQuestion2Text()
    {
        return 'Ask question 2';
    }

    public function getQuestion3Text()
    {
        return 'Ask question 3';
    }

    public function submit(array $input)
    {
        $validator = IlluminateSupportFacadesValidator::make($input, [
            'answer1' => 'required',
            'answer2' => 'required',
            'answer3' => 'required',
        ]);

        if ($validator->fails()) {
            // processing error
        } else {
            // saving to DB
        }
    }

}

...你的实际单元测试，如下所示：

$commandLogic = new CommandLogic();
$sampleInput = [
    'answer1' => 'test1',
    'answer2' => 'test2',
    'answer3' => 'test3',
];

$commandLogic->submit($sampleInput);
$this->assertDatabaseHas('myTable', [
    'question1' => 'test1'
]);

...和你的控制台命令，像这样：

public function handle()
{
    $commandLogic = new CommandLogic();
    $input['answer1'] = $this->ask($commandLogic->getQuestion1Text());
    $input['answer2'] = $this->ask($commandLogic->getQuestion2Text());
    $input['answer3'] = $this->ask($commandLogic->getQuestion3Text());

    $commandLogic->submit($input);
}

这会强制执行single responsibility principle并将代码库中的移动部分分开。我知道这可能感觉像是一个警察，但在Laravel 5.4中测试这些东西很难。如果您愿意升级到5.7或更高版本，请阅读以下内容......

---

Laravel 5.7+

Laravel 5.7引入了能够运行控制台测试，满足了这个问题所要求的确切要求 - https://laravel.com/docs/5.7/console-tests。这更像是一个完整的集成测试而不是单元测试。