测试模拟器

    Laravel 针对事件、任务和 Facades 的模拟，提供了开箱即用的辅助函数。这些函数基于 Mocker 封装而成，使用非常方便，无需手动调用复杂的 Mockery 函数。当然你也可以使用 Mockery 或者使用 PHPUnit 创建自己的模拟器。

    任务模拟

    你可以使用 Facade 的 fake 方法来模拟事件监听，测试的时候并不会真正触发事件监听器。然后你就可以测试断言事件运行了，甚至可以检查他们接收的数据。使用 fake 的时候，断言一般出现在测试代码的后面：

    1. <?php
    3. namespace Tests\Feature;
    5. use Tests\TestCase;
    6. use App\Events\OrderShipped;
    7. use App\Events\OrderFailedToShip;
    8. use Illuminate\Support\Facades\Event;
    9. use Illuminate\Foundation\Testing\RefreshDatabase;
    10. use Illuminate\Foundation\Testing\WithoutMiddleware;
    12. class ExampleTest extends TestCase
    13. {
    14.     /**
    15.      * 测试订单发货
    16.      */
    17.     public function testOrderShipping()
    18.     {
    19.         Event::fake();
    21.         // 处理订单发货...
    23.         Event::assertDispatched(OrderShipped::class, function ($e) use ($order) {
    24.                 return $e->order->id === $order->id;
    25.         });
    27.         // 断言事件执行两次...
    28.         Event::assertDispatched(OrderShipped::class, 2);
    30.         // 断言事件并没有被执行...
    31.         Event::assertNotDispatched(OrderFailedToShip::class);
    32.     }
    33. }

    邮件模拟

    1. <?php
    3. namespace Tests\Feature;
    5. use Tests\TestCase;
    6. use App\Mail\OrderShipped;
    7. use Illuminate\Support\Facades\Mail;
    8. use Illuminate\Foundation\Testing\RefreshDatabase;
    9. use Illuminate\Foundation\Testing\WithoutMiddleware;
    11. class ExampleTest extends TestCase
    12. {
    13.     public function testOrderShipping()
    14.     {
    15.         Mail::fake();
    17.         // 执行订单发送...
    19.         Mail::assertSent(OrderShipped::class, function ($mail) use ($order) {
    20.             return $mail->order->id === $order->id;
    21.         });
    22.         // 断言一条发送给用户的消息...
    23.         Mail::assertSent(OrderShipped::class, function ($mail) use ($user) {
    24.             return $mail->hasTo($user->email) &&
    25.                    $mail->hasCc('...') &&
    26.                    $mail->hasBcc('...');
    27.         });
    29.         // 断言邮件被发送两次...
    30.         Mail::assertSent(OrderShipped::class, 2);
    32.         // 断言没有发送邮件...
    33.         Mail::assertNotSent(AnotherMailable::class);
    34.     }
    35. }

    如果你用后台任务执行邮件发送队列，你应该是用 assertQueued 代替 assertSent ：

    你可以使用 Notification Facade 的 fake 方法来模拟通知的发送，测试时并不会真的发出通知。然后你可以断言 发送给了用户，甚至可以检查他们收到的内容。使用 fakes 时，断言一般放在测试代码后面：

    1. <?php
    3. namespace Tests\Feature;
    5. use Tests\TestCase;
    6. use App\Notifications\OrderShipped;
    7. use Illuminate\Support\Facades\Notification;
    8. use Illuminate\Foundation\Testing\RefreshDatabase;
    9. use Illuminate\Foundation\Testing\WithoutMiddleware;
    11. class ExampleTest extends TestCase
    12. {
    13.     public function testOrderShipping()
    14.     {
    15.         Notification::fake();
    17.         // 处理订单发货...
    19.         Notification::assertSentTo(
    20.             $user,
    21.             OrderShipped::class,
    22.             function ($notification, $channels) use ($order) {
    23.                 return $notification->order->id === $order->id;
    24.             }
    25.         );
    27.         // 断言通知已经发送给了指定用户...
    28.         Notification::assertSentTo(
    29.             [$user], OrderShipped::class
    30.         );
    32.         // 断言通知没有发送...
    33.         Notification::assertNotSentTo(
    34.             [$user], AnotherNotification::class
    35.         );
    36.     }
    37. }

    队列模拟

    你可以使用 Queue Facade 的 fake 方法来模拟任务队列，测试的时候并不会真的把任务放入队列。然后你可以断言任务被放入了队列，甚至可以检查他们收到的内容。使用 fakes 时，断言一般放在测试代码的后面：

    1. <?php
    3. namespace Tests\Feature;
    5. use Tests\TestCase;
    6. use App\Jobs\ShipOrder;
    7. use Illuminate\Support\Facades\Queue;
    8. use Illuminate\Foundation\Testing\RefreshDatabase;
    9. use Illuminate\Foundation\Testing\WithoutMiddleware;
    11. class ExampleTest extends TestCase
    12.     public function testOrderShipping()
    13.     {
    14.         Queue::fake();
    16.         // 处理订单发货...
    18.         Queue::assertPushed(ShipOrder::class, function ($job) use ($order) {
    19.             return $job->order->id === $order->id;
    22.         // 断言任务进入了指定队列...
    23.         Queue::assertPushedOn('queue-name', ShipOrder::class);
    25.         // 断言任务进入2次...
    26.         Queue::assertPushed(ShipOrder::class, 2);
    28.         // 断言任务没有进入队列...
    29.         Queue::assertNotPushed(AnotherJob::class);
    30.     }
    31. }

    你可以使用 Storage Facade 的 fake 方法，轻松的生成一个模拟磁盘，结合 UploadedFile 类的文件生成工具，极大的简化了文件上传测试。例如：

    Facades

    与传统的静态方法调用，不同 facades 也可以被模拟。相对静态函数调用来说这是一个巨大的优势，即时你在使用依赖注入，测试时依然非常方便。在测试中，你可能想在控制器中模拟对 Laravel Facade 的调用。比如下面控制器中的行为：

    1. <?php
    3. namespace App\Http\Controllers;
    5. use Illuminate\Support\Facades\Cache;
    7. class UserController extends Controller
    8. {
    9.     /**
    10.      * 显示应用里所有用户
    11.      *
    12.      * @return Response
    13.      */
    14.     public function index()
    15.     {
    16.         $value = Cache::get('key');
    18.         //
    19.     }
    20. }

    我们可以通过 shouldReceive 方法来模拟 Cache Facade，此函数会返回一个 实例。由于 Facade 的调用实际是由 Laravel 的 服务容器 管理的，所以 Facade 能比传统的静态类表现出更好的测试便利性。下面，让我们模拟一下 Cache Facade 的 get 方法：

    1. <?php
    3. namespace Tests\Feature;
    5. use Tests\TestCase;
    6. use Illuminate\Support\Facades\Cache;
    7. use Illuminate\Foundation\Testing\RefreshDatabase;
    8. use Illuminate\Foundation\Testing\WithoutMiddleware;
    10. class UserControllerTest extends TestCase
    11. {
    12.     public function testGetIndex()
    13.     {
    14.         Cache::shouldReceive('get')
    15.                     ->once()
    16.                     ->with('key')
    17.                     ->andReturn('value');
    19.         $response = $this->get('/users');
    21.         // ...
    22.     }

    本文章首发在 网站上。