引言
最近使用到laravel的consolo命令列工具，在寫指令，想寫一些測試的時候，發現官方文件中並沒有提到command的測試方法。花了點時間，翻牆找了資料，實踐成功並記錄一下，方便更多人。
推薦：《laravel教學》
測試方法
大家都知道Laravel中使用了許多Symfony的成熟元件，Laravel的console組件使用的就是Symfony/console。
幸運的是，Symfony/console 元件中提供了用於command測試的CommandTester, 使用方法如下
...
use FooCommand;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;
...
public function testSample(){
//创建一个console测试应用平台，用来搭载测试的命令
$application = new Application();
//创建待测试的command
$testedCommand = $this->app->make(FooCommand::class);
//设置命令执行需要的laravel依赖
$testedCommand->setLaravel(app());
//添加待测试的command到测试应用上
//同时command 也绑定 application
$application->add($testedCommand);
//实例化命令测试类
$commandTester = new CommandTester($testedCommand);
//命令输入流，对应每次交互需要提供的输入内容
$commandTester->setInputs([
//...
]);
//执行命令
$commandTester->execute(['command' => $testedCommand->getName()]);
//对命令执行结果进行断言测试，主要是依靠正则判断
//$commandTester->getDisplay() 方法可以获取命令执行后的输出结果
$this->assertRegExp("/some reg/", $commandTester->getDisplay());
}範例
我們現在有一個手動建立新使用者的指令createUser,作用就是手動建立一個使用者。
需要互動式讓使用者輸入name,email,password,comfirm password,這些資料。
要待測試的command
<?php
namespace App\Console\Commands;
use App\User;
use Illuminate\Auth\Events\Registered;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Validator;
class CreateUser extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'createUser';
/**
* The console command description.
*
* @var string
*/
protected $description = 'create new user for system manually';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
*/
public function handle()
{
$this->line($this->description);
// 获取输入的数据
$data = [
'name' => $this->ask('What\'s your name?'),
'email' => $this->ask('What\'s your email?'),
'password' => $this->secret('What\'s your password?'),
'password_confirmation' => $this->secret('Pleas confirm your password.')
];
// 验证输入内容
$validator = $this->makeValidator($data);
if ($validator->fails()) {
foreach ($validator->errors()->toArray() as $error) {
foreach ($error as $message) {
$this->error($message);
}
}
return;
}
// 向用户确认输入信息
if (!$this->confirm('Confirm your info: ' . PHP_EOL . 'name:' . $data['name'] . PHP_EOL . 'email:' . $data['email'] . PHP_EOL . 'is this correct?')) {
return;
}
// 注册
$user = $this->create($data);
event(new Registered($user));
$this->line('User ' . $user->name . ' successfully registered');
}
/**
* Get a validator for an incoming registration request.
*
* @param array $data
* @return \Illuminate\Contracts\Validation\Validator
*/
protected function makeValidator($data)
{
return Validator::make($data, [
'name' => 'required|string|max:255|unique:users',
'email' => 'required|string|email|max:255|unique:users',
'password' => 'required|string|min:6|confirmed'
]);
}
/**
* Create a new user instance after a valid registration.
*
* @param array $data
* @return \App\User
*/
protected function create($data)
{
return User::create([
'name' => $data['name'],
'email' => $data['email'],
'password' => bcrypt($data['password'])
]);
}
}正確的結果
如果正確輸入訊息的話，會得到如下輸出
$ path-to-your-app/app# php artisan createUser create new user for system manually What's your name?: > vestin What's your email?: > correct@abc.com What's your password?: > Pleas confirm your password.: > Confirm your info: name:vestin email:correct@abc.com is this correct? (yes/no) [no]: > yes User vestin successfully registered
想要測試的內容
我想要測試兩塊內容：
1.資料輸入驗證測試
● email有效性測試
● password兩次輸入是否相同的測試
2.正確建立使用者測試
● 編寫單元測試
<?php
namespace Tests\Unit\command;
use App\Console\Commands\CreateUser;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;
use Tests\TestCase;
use Illuminate\Foundation\Testing\RefreshDatabase;
class CreateUserTest extends TestCase
{
use RefreshDatabase;
/**
* 测试数据验证
*
* @return void
*/
public function testValidation()
{
$application = new Application();
$testedCommand = $this->app->make(CreateUser::class);
$testedCommand->setLaravel(app());
$application->add($testedCommand);
$commandTester = new CommandTester($testedCommand);
$commandTester->setInputs(['Vestin', 'badEmail@abc', '123456', '654321']);
$commandTester->execute(['command' => $testedCommand->getName()]);
// assert
$this->assertRegExp("/The email must be a valid email address/", $commandTester->getDisplay());
$commandTester->setInputs(['vestin', 'correct@abc.com', '123456', '654321']);
$commandTester->execute(['command' => $testedCommand->getName()]);
// assert
$this->assertRegExp("/The password confirmation does not match/", $commandTester->getDisplay());
}
/**
* 测试成功注册用户
*
* @return void
*/
public function testSuccess()
{
$application = new Application();
$testedCommand = $this->app->make(CreateUser::class);
$testedCommand->setLaravel(app());
$application->add($testedCommand);
$commandTester = new CommandTester($testedCommand);
$commandTester->setInputs(['Vestin', 'correct@abc.com', '123456', '123456', 'y']);
$commandTester->execute(['command' => $testedCommand->getName()]);
// assert
$this->assertRegExp("/User Vestin successfully registered/", $commandTester->getDisplay());
$this->assertDatabaseHas('users', [
'email' => 'correct@abc.com',
'name' => 'Vestin'
]);
}
}執行測試
$ path-to-your-app/app# ./vendor/bin/phpunit PHPUnit 6.4.3 by Sebastian Bergmann and contributors. .. 3 / 3 (100%) Time: 659 ms, Memory: 14.00MB
以上是測試laravel commands的方法詳解的詳細內容。更多資訊請關注PHP中文網其他相關文章！
