Explication détaillée de la façon de tester les commandes Laravel
- 藏色散人avant
- 2020-04-13 13:57:585051parcourir
Introduction
J'ai récemment utilisé l'outil de ligne de commande consolo de Laravel Lorsque j'écrivais des commandes et que je voulais écrire des tests, j'ai découvert que la méthode de test des commandes n'était pas mentionnée dans le document officiel. documentation. Il m'a fallu un certain temps pour trouver des informations par-dessus le mur, et je les ai mises en œuvre avec succès et enregistrées pour le confort d'un plus grand nombre de personnes.
Recommandé : "Tutoriel Laravel"
Méthode de test
Tout le monde sait que Laravel utilise de nombreux composants matures de Symfony, celui de Laravel Le composant console utilise Symfony/console.
Heureusement, le composant Symfony/console fournit CommandTester pour les tests de commandes. L'utilisation est la suivante
...
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());
}Exemple
Nous avons maintenant une commande pour. créer manuellement un nouvel utilisateur, createUser, est utilisé pour créer un utilisateur manuellement.
Doit permettre de manière interactive aux utilisateurs de saisir leur nom, leur e-mail, leur mot de passe, leur confirmation de mot de passe, ces données.
Commande à tester
<?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'])
]);
}
}Résultat correct
Si vous saisissez les informations correctement, vous obtiendrez le résultat suivant
$ 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
Ce que vous voulez tester
Je souhaite tester deux éléments de contenu :
Test de vérification de la saisie des données
● Test de validité de l'e-mail
● Tester si le mot de passe saisi deux fois est le même
2 Créer correctement un test utilisateur
● Écrire un test unitaire
<?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'
]);
}
}. Exécuter le test
$ 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
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!
Articles Liés
Voir plus- Permettez-moi de partager avec vous quelques pratiques simples de codage Laravel
- Explication détaillée de la nouvelle opération de collecte lorsque la méthode dans laravel5.4.12
- Une manière très fine de diviser les fichiers de routage Laravel (traduction)
- Faire en sorte que l'API Laravel renvoie toujours des réponses au format JSON