Laravel測試驅動開發 -- 正向單元測試

時間 2019-11-15

標籤 laravel 測試驅動開發正向單元简体版

原文原文鏈接

上一篇翻譯的文章裏經過簡單的十一步講述瞭如何在Laravel中進行測試驅動開發，這是做者關於測試的第二篇文章，文章中簡述瞭如何在Laravel中進行增刪改查的單元測試，本文中的單元測試都是正向測試，以後還會有一篇來說述如何作反向測試。php

正向測試： Positive test 提供合法數據，測試預期被測程序能獲得正常執行。
反向測試：Negative test 提供非法的輸入數據，測試預期被測程序拋出指定的Exception。laravel

如下是譯文：git

最近我開啓了一個開源電子商務應用項目LARACOM，使用的是Laravel框架並集成了Rob Gloudeman 的shoping cart 和與其相關的packages。github

在開啓這個項目時我必須爲項目作長遠規劃和考慮，因此在我腦海中歷來就沒出現過"我不會用到TDD(test driven development)方法"這個想法，TDD是開發的必選項。爲了進行TDD，我須要將項目中的測試用例劃分到兩個不一樣的組中，一組是單元測試另一組是功能測試。數據庫

單元測試是用來測試項目中的Model、Repository等等這些類的，而功能測試是看測試代碼是否可以正確訪問到Controller並斷言Controller的行爲：是否redirect 到了目標URL、返回了指定的視圖或者是跳轉並攜帶着形成跳轉的錯誤信息。設計模式

介紹的足夠多了，若是你以前沒有嘗試過TDD，我以前有寫進行TDD的基本方法。那篇文章裏有介紹TDD的基本概念和開始TDD的基本方法，因此這裏再也不贅述。app

今天咱們要作的是爲個人項目寫Carousel業務的基本CRUD方法。框架

譯者注：文章裏做者開推薦了他寫的實現repository設計模式的package單元測試

Edit: Hey! I created a base repository package you can use for your next project :)

Part I: Positive Unit Testing

從create測試開始

讓咱們從對create操做的測試開始。測試

建立/tests/Unit/Carousels/CarouselUnitTest.php 文件

注：經過命令 php artisan make:test Carousels/CarouselUnitTest --unit 建立

<?php
namespace Tests\Unit\Carousels;
use Tests\TestCase;
class CarouselUnitTest extends TestCase
{
   /** @test */
   public function it_can_create_a_carousel()
   {
       $data = [
           'title' => $this->faker->word,
           'link' => $this->faker->url,
           'src' => $this->faker->url,
       ];
     
       $carouselRepo = new CarouselRepository(new Carousel);
       $carousel = $carouselRepo->createCarousel($data);
     
       $this->assertInstanceOf(Carousel::class, $carousel);
       $this->assertEquals($data['title'], $carousel->title);
       $this->assertEquals($data['link'], $carousel->link);
       $this->assertEquals($data['image_src'], $carousel->src);
   }
}

在這個文件中咱們要作的是：

測試respository類是否可以用這些參數在數據庫中新建carousel記錄。
測試在新建carousel後，返回的carousel對象各屬性的值是否與建立時提供的參數值一致。

如今在你的終端中，執行vendor/bin/phpunit(當前工做目錄必須是你項目的根目錄)。

是否有錯誤？是的，由於咱們尚未建立CarouselRepository.php這個文件，因此會有以下錯誤

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
E                                                                   1 / 1 (100%)
Time: 700 ms, Memory: 26.00MB
There was 1 error:
1) Tests\Unit\Carousels\CarouselUnitTest::it_can_create_a_carousel
Error: Class 'Tests\Unit\Carousels\CarouselRepository' not found

讓咱們建立app/Shop/Carousels/Repositories/CarouselRepository.php文件

<?php
namespace App\Shop\Carousels\Repositories;
use App\Shop\Carousels\Carousel;
use App\Shop\Carousels\Exceptions\CreateCarouselErrorException;
use Illuminate\Database\QueryException;
class CarouselRepository
{
    /**
     * CarouselRepository constructor.
     * @param Carousel $carousel
     */
    public function __construct(Carousel $carousel)
    {
        $this->model = $carousel;
    }
    /**
     * @param array $data
     * @return Carousel
     * @throws CreateCarouselErrorException
     */
    public function createCarousel(array $data) : Carousel
    {
        try {
            return $this->model->create($data);
        } catch (QueryException $e) {
            throw new CreateCarouselErrorException($e);
        }
    }
}

在這個repository中，咱們用依賴注入將CarouselModel注入到了其中，由於尚未這個CarouselModel因此在注入這個Model時會拋出一個錯誤。

咱們先來建立: app/Shop/Carousels/Carousel.php

<?php
namespace App\Shop\Carousels;
use Illuminate\Database\Eloquent\Model;
class Carousel extends Model
{
    protected $fillable = [
        'title',
        'link',
        'src'
    ];
}

在repository建立完成後，咱們將其引入到咱們的測試文件中去，像這樣:

<?php
namespace Tests\Unit\Carousels;
use App\Shop\Carousels\Carousel;
use App\Shop\Carousels\Repositories\CarouselRepository;
use Tests\TestCase;
class CarouselUnitTest extends TestCase
{
    /** @test */
    public function it_can_create_a_carousel()
    {
        $data = [
            'title' => $this->faker->word,
            'link' => $this->faker->url,
            'src' => $this->faker->url,
        ];
      
        $carouselRepo = new CarouselRepository(new Carousel);
        $carousel = $carouselRepo->createCarousel($data);
      
        $this->assertInstanceOf(Carousel::class, $carousel);
        $this->assertEquals($data['title'], $carousel->title);
        $this->assertEquals($data['link'], $carousel->link);
        $this->assertEquals($data['image_src'], $carousel->src);
    }
}

接下來在此運行vendor/bin/phpunit

Error Again? Yes? 你猜對了。

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
E                                                                   1 / 1 (100%)
Time: 898 ms, Memory: 26.00MB
There was 1 error:
1) Tests\Unit\Carousels\CarouselUnitTest::it_can_create_a_carousel
App\Shop\Carousels\Exceptions\CreateCarouselErrorException: PDOException: SQLSTATE[HY000]: General error: 1 no such table: carousels in /Users/jsd/Code/shop/vendor/doctrine/dbal/lib/Doctrine/DBAL/Driver/PDOConnection.php:77

測試文件中嘗試往carousels表中寫入數據，可是這個表如今還不存在。咱們接下來經過Migration文件來建立這個表。

在命令行終端中運行:

php artisan make:migration create_carousels_table --create=carousels

編輯遷移文件以下:

<?php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
class CreateCarouselTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('carousels', function (Blueprint $table) {
            $table->increments('id');
            $table->string('title');
            $table->string('link')->nullable();
            $table->string('src');
            $table->timestamps();
        });
    }
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('carousels');
    }
}

link字段是可空的，title和image字段是必須項。

執行遷移文件建立完carousels表後，再次執行vendor/bin/phpunit顯示以下:

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
.                                                                   1 / 1 (100%)
Time: 696 ms, Memory: 26.00MB
OK (1 test, 6 assertions)

如今你已經讓這個測試經過了，因此只要你在運行vendor/bin/phpunit時這個測試能正確經過，那麼你就能認爲會應用能成功建立carousel記錄。

read測試

如今讓咱們來測試在建立carousel後，是否能從正確的讀取到它。

<?php
namespace Tests\Unit\Carousels;
use Tests\TestCase;
class CarouselUnitTest extends TestCase
{
    /** @test */
    public function it_can_show_the_carousel()
    {
        $carousel = factory(Carousel::class)->create();
        $carouselRepo = new CarouselRepository(new Carousel);
        $found = $carouselRepo->findCarousel($carousel->id);
        
        $this->assertInstanceOf(Carousel::class, $found);
        $this->assertEquals($found->title, $carousel->title);
        $this->assertEquals($found->link, $carousel->link);
        $this->assertEquals($found->src, $carousel->src);
    }
    /** @test */
    public function it_can_create_a_carousel()
    {
        $data = [
            'title' => $this->faker->word,
            'link' => $this->faker->url,
            'src' => $this->faker->url,
        ];
      
        $carouselRepo = new CarouselRepository(new Carousel);
        $carousel = $carouselRepo->createCarousel($data);
      
        $this->assertInstanceOf(Carousel::class, $carousel);
        $this->assertEquals($data['title'], $carousel->title);
        $this->assertEquals($data['link'], $carousel->link);
        $this->assertEquals($data['src'], $carousel->src);
    }
}

運行測試，在每次咱們新建測試後，咱們老是預期測試會運行失敗，爲何呢？由於咱們尚未實現邏輯。若是咱們在建立完測試後運行既能獲得success的結果，那麼證實咱們在應用TDD時步驟上出現了錯誤(TDD 先寫測試後編碼實現)。

每個咱們新建的測試都要放在測試文件中的頭部，由於咱們想讓新建的測試優先運行

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
E                                                                   1 / 1 (100%)
Time: 688 ms, Memory: 26.00MB
There was 1 error:
1) Tests\Unit\Carousels\CarouselUnitTest::it_can_show_the_carousel
InvalidArgumentException: Unable to locate factory with name [default] [App\Shop\Carousels\Carousel].

在這個錯誤中顯示，測試程序嘗試調用了還不存在的模型工廠。

建立文件: database/factories/CarouselModelFactory.php

<?php
/*
|--------------------------------------------------------------------------
| Model Factories
|--------------------------------------------------------------------------
|
| Here you may define all of your model factories. Model factories give
| you a convenient way to create models for testing and seeding your
| database. Just tell the factory how a default model should look.
|
*/
use App\Shop\Carousels\Carousel;
/** @var \Illuminate\Database\Eloquent\Factory $factory */
$factory->define(Carousel::class, function (Faker\Generator $faker) {
    return [
        'title' => $faker->word,
        'link' => $faker->url,
        'src' => $faker->url,
    ];
});

在此運行phpunit

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
E                                                                   1 / 1 (100%)
Time: 708 ms, Memory: 26.00MB
There was 1 error:
1) Tests\Unit\Carousels\CarouselUnitTest::it_can_show_the_carousel
Error: Call to undefined method App\Shop\Carousels\Repositories\CarouselRepository::findCarousel()

如今找不到模型工廠的錯誤消失了，意味着如今能夠持久化到數據庫裏了，有些人想讓建立對象和持久化的過程可以分開，那麼能夠將測試代碼中的:

$carousel = factory(Carousel::class)->create();

替換成:

$carousel = factory(Carousel::class)->make();

可是如今測試程序中仍然有錯誤，由於在repository中找不到findCarousel()方法。

<?php
namespace App\Shop\Carousels\Repositories;
use App\Shop\Carousels\Carousel;
use App\Shop\Carousels\Exceptions\CarouselNotFoundException;
use App\Shop\Carousels\Exceptions\CreateCarouselErrorException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\QueryException;
class CarouselRepository
{
   protected $model;
  
    /**
     * CarouselRepository constructor.
     * @param Carousel $carousel
     */
    public function __construct(Carousel $carousel)
    {
        $this->model = $carousel;
    }
    /**
     * @param array $data
     * @return Carousel
     * @throws CreateCarouselErrorException
     */
    public function createCarousel(array $data) : Carousel
    {
        try {
            return $this->model->create($data);
        } catch (QueryException $e) {
            throw new CreateCarouselErrorException($e);
        }
    }
    /**
     * @param int $id
     * @return Carousel
     * @throws CarouselNotFoundException
     */
    public function findCarousel(int $id) : Carousel
    {
        try {
            return $this->model->findOrFail($id);
        } catch (ModelNotFoundException $e) {
            throw new CarouselNotFoundException($e);
        }
    }
}

如今運行phpunit看看輸出是什麼。

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
.                                                                   1 / 1 (100%)
Time: 932 ms, Memory: 26.00MB
OK (1 test, 6 assertions)

update測試

如今讓咱們測試一下是否可以對carousel進行更新

<?php
namespace Tests\Unit\Carousels;
use Tests\TestCase;
class CarouselUnitTest extends TestCase
{
    /** @test */
    public function it_can_update_the_carousel()
    {
        $carousel = factory(Carousel::class)->create();
        
        $data = [
            'title' => $this->faker->word,
            'link' => $this->faker->url,
            'src' => $this->faker->url,
        ];
        
        $carouselRepo = new CarouselRepository($carousel);
        $update = $carouselRepo->updateCarousel($data);
        
        $this->assertTrue($update);
        $this->assertEquals($data['title'], $carousel->title);
        $this->assertEquals($data['link'], $carousel->link);
        $this->assertEquals($data['src'], $carousel->src);
    }
    /** @test */
    public function it_can_show_the_carousel()
    {
        $carousel = factory(Carousel::class)->create();
        $carouselRepo = new CarouselRepository(new Carousel);
        $found = $carouselRepo->findCarousel($carousel->id);
        
        $this->assertInstanceOf(Carousel::class, $found);
        $this->assertEquals($found->title, $carousel->title);
        $this->assertEquals($found->link, $carousel->link);
        $this->assertEquals($found->src, $carousel->src);
    }
    /** @test */
    public function it_can_create_a_carousel()
    {
        $data = [
            'title' => $this->faker->word,
            'link' => $this->faker->url,
            'src' => $this->faker->url,
        ];
      
        $carouselRepo = new CarouselRepository(new Carousel);
        $carousel = $carouselRepo->createCarousel($data);
      
        $this->assertInstanceOf(Carousel::class, $carousel);
        $this->assertEquals($data['title'], $carousel->title);
        $this->assertEquals($data['link'], $carousel->link);
        $this->assertEquals($data['src'], $carousel->src);
    }
}

這裏咱們在吃使用模型工廠建立了carousel記錄，而後經過$data參數給updateCarousel來更新carousel並斷言更新後的carousel對象的屬性值與$data中的字段值同樣。

如今這個測試會運行失敗，由於你知道的在repository類中尚未定義updateCarousel方法，如今讓咱們來建立這個方法。

<?php
namespace App\Shop\Carousels\Repositories;
use App\Shop\Carousels\Carousel;
use App\Shop\Carousels\Exceptions\CarouselNotFoundException;
use App\Shop\Carousels\Exceptions\CreateCarouselErrorException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\QueryException;
class CarouselRepository
{
   protected $model;
  
    /**
     * CarouselRepository constructor.
     * @param Carousel $carousel
     */
    public function __construct(Carousel $carousel)
    {
        $this->model = $carousel;
    }
    /**
     * @param array $data
     * @return Carousel
     * @throws CreateCarouselErrorException
     */
    public function createCarousel(array $data) : Carousel
    {
        try {
            return $this->model->create($data);
        } catch (QueryException $e) {
            throw new CreateCarouselErrorException($e);
        }
    }
    /**
     * @param int $id
     * @return Carousel
     * @throws CarouselNotFoundException
     */
    public function findCarousel(int $id) : Carousel
    {
        try {
            return $this->model->findOrFail($id);
        } catch (ModelNotFoundException $e) {
            throw new CarouselNotFoundException($e);
        }
    }
    
     /**
     * @param array $data
     * @return bool
     * @throws UpdateCarouselErrorException
     */
    public function updateCarousel(array $data) : bool
    {
        try {
            return $this->model->update($data);
        } catch (QueryException $e) {
            throw new UpdateCarouselErrorException($e);
        }
    }
}

updateCarousel()方法建立完後再次運行phpunit

PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
.                                                                   1 / 1 (100%)
Time: 932 ms, Memory: 26.00MB
OK (1 test, 6 assertions)

方法建立完後測試立馬就能運行成功了。

delete測試

最後讓咱們看一下刪除carousel測試

<?php
namespace Tests\Unit\Carousels;
use Tests\TestCase;
class CarouselUnitTest extends TestCase
{
    /** @test */
    public function it_can_delete_the_carousel()
    {
        $carousel = factory(Carousel::class)->create();
      
        $carouselRepo = new CarouselRepository($carousel);
        $delete = $carouselRepo->deleteCarousel();
        
        $this->assertTrue($delete);
    }
  
    /** @test */
    public function it_can_update_the_carousel()
    {
        $carousel = factory(Carousel::class)->create();
        
        $data = [
            'title' => $this->faker->word,
            'link' => $this->faker->url,
            'src' => $this->faker->url,
        ];
        
        $carouselRepo = new CarouselRepository($carousel);
        $update = $carouselRepo->updateCarousel($data);
        
        $this->assertTrue($update);
        $this->assertEquals($data['title'], $carousel->title);
        $this->assertEquals($data['link'], $carousel->link);
        $this->assertEquals($data['src'], $carousel->src);
    }
    /** @test */
    public function it_can_show_the_carousel()
    {
        $carousel = factory(Carousel::class)->create();
        $carouselRepo = new CarouselRepository(new Carousel);
        $found = $carouselRepo->findCarousel($carousel->id);
        
        $this->assertInstanceOf(Carousel::class, $found);
        $this->assertEquals($found->title, $carousel->title);
        $this->assertEquals($found->link, $carousel->link);
        $this->assertEquals($found->src, $carousel->src);
    }
    /** @test */
    public function it_can_create_a_carousel()
    {
        $data = [
            'title' => $this->faker->word,
            'link' => $this->faker->url,
            'src' => $this->faker->url,
        ];
      
        $carouselRepo = new CarouselRepository(new Carousel);
        $carousel = $carouselRepo->createCarousel($data);
      
        $this->assertInstanceOf(Carousel::class, $carousel);
        $this->assertEquals($data['title'], $carousel->title);
        $this->assertEquals($data['link'], $carousel->link);
        $this->assertEquals($data['src'], $carousel->src);
    }
}

而後在repository中建立deleteCarousel()方法：

<?php
namespace App\Shop\Carousels\Repositories;
use App\Shop\Carousels\Carousel;
use App\Shop\Carousels\Exceptions\CarouselNotFoundException;
use App\Shop\Carousels\Exceptions\CreateCarouselErrorException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\QueryException;
class CarouselRepository
{
   protected $model;
  
    /**
     * CarouselRepository constructor.
     * @param Carousel $carousel
     */
    public function __construct(Carousel $carousel)
    {
        $this->model = $carousel;
    }
    /**
     * @param array $data
     * @return Carousel
     * @throws CreateCarouselErrorException
     */
    public function createCarousel(array $data) : Carousel
    {
        try {
            return $this->model->create($data);
        } catch (QueryException $e) {
            throw new CreateCarouselErrorException($e);
        }
    }
    /**
     * @param int $id
     * @return Carousel
     * @throws CarouselNotFoundException
     */
    public function findCarousel(int $id) : Carousel
    {
        try {
            return $this->model->findOrFail($id);
        } catch (ModelNotFoundException $e) {
            throw new CarouselNotFoundException($e);
        }
    }
    
     /**
     * @param array $data
     * @return bool
     * @throws UpdateCarouselErrorException
     */
    public function updateCarousel(array $data) : bool
    {
        try {
            return $this->model->update($data);
        } catch (QueryException $e) {
            throw new UpdateCarouselErrorException($e);
        }
    }
    
    /**
    * @return bool
    */
    public function deleteCarousel() : bool
    {
        return $this->model->delete();
    }
}

當這個方法被執行後，它應返回布爾值。若是刪除成功返回True，不然返回null。而後再次運行phpunit

➜ git: phpunit --filter=CarouselUnitTest::it_can_delete_the_carousel
PHPUnit 6.5.7 by Sebastian Bergmann and contributors.
.                                                                   1 / 1 (100%)
Time: 916 ms, Memory: 26.00MB
OK (1 test, 1 assertion)

WOW. 如今你已經大功告成了CONGRATULATIONS!

若是想看更多的測試Example能夠個人項目的單元測試目錄。

下一部分將講述在Laravel中進行Negative Unit Testing。