教你掌握 Laravel 的測驗方法-Laravel-PHP中文網

以下由Laravel教學專欄為大家介紹掌握 Laravel 的測試方法，希望對需要的朋友有幫助！

教你掌握 Laravel 的測驗方法

掌握Laravel 的測試方法

不管你承認與否在研發一款產品時，軟體測試對專案而言意義重大，然而是測試通常被我們視而不見。這篇文章我們主要研究 Laravel 框架的測試方法。

或許你還不知道，Laravel 核心早已繼承了 PHPUnit 單元測試元件。 PHPUnit 是 PHP 社群裡使用最廣泛、最受歡迎的測試框架之一。 PHPUnit 同時支援「單元測試」和「功能測試」兩種特性。

我們會簡單介紹 PHPUnit 「單元測試」和「功能測試」的基本使用方法。繼而，講解如何在 Laravel 專案中建立「單元測試」和「功能測試」用例。不過這篇我們假定你已經對 PHPUnit 測試框架有了基本的了解，所以讓我們把焦點放到 Laravel 中使用 PHPUnit 進行測試這個主題。

單元測試和功能測試

如果您已經接觸過PHPUnit 框架，那麼您應該知道，它支援兩種類型特性-- “單元測試”和“功能測試」。

「單元測試」的目的是用來測試函數或方法的正確性。更重要的是，我們可以輕鬆實現程式碼邏輯的正確性。

如果您在開發過程中發現某個功能包含多個邏輯處理，那麼最好將每個處理邏輯拆分到不同的方法裡，這樣以確保單一方法和程式碼區塊可測試。

我們以一個理想的方法來窺探單元測試的奧秘。

<?php
public function getNameAttribute($value)
{
    return ucfirst($value);
}

登入後複製

如你所見，這個方法只處理一個業務邏輯，方法內部透過 ucfirst 函數將字元轉換成首字母大寫格式。

單元測試是為了保證每個獨立單元的程式碼正確性；功能測試則是為了保證一個功能的正確性。一言以蔽之，就是透過特定的測試案例來模擬使用者存取應用程式的行為驗證系統的正確性。

例如，我們可以為包含以下步驟的登入功能實作一個功能測試案例：

#發起一個存取登入頁面的GET 請求；
判斷我們是否處在登入頁面；
產生用於採用POST 請求方式登入的登入資料；
判斷是否建立登入會話資料成功。

這就是應該如何建立「功能測試」用例的秘密。接下來我們將建立具體的測試案例，來講解如何在 Laravel 中使用「單元測試」和「功能測試」。

建置測試環境

建立測試模型

在開始建立測試案例前，我們需要先建構起用於測試的項目依賴。

先執行下面的 artisan 指令建立一個 Post 模型及其對應的遷移檔案。

$ php artisan make:model Post --migration

登入後複製

上面的命令將為我們建立一個 Post 模型類別和資料庫遷移檔案。

Post 模型程式碼如下：

<?php
// app/Post.php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Post extends Model
{
    //
}

登入後複製

資料庫移轉檔案 YYYY_MM_DD_HHMMSS_create_posts_table.php 將會建立在 database/migrations 目錄中。

Post 資料表會儲存一篇文章的標題。修改後 Post 資料庫遷移檔案程式碼如下：

<?php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
class CreatePostsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create(&#39;posts&#39;, function (Blueprint $table) {
            $table->increments(&#39;id&#39;);
            $table->string(&#39;name&#39;);
            $table->timestamps();
        });
    }
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists(&#39;posts&#39;);
    }
}

登入後複製

如你所見，我們透過新增的 $table->string('name') 來儲存文章的標題。接下來，執行資料庫遷移指令就回在資料庫中建立對應的資料表了。

$ php artisan migrate

登入後複製

在建立完資料表之後，我們需要在Post 模型類別中加入以下程式碼

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Post extends Model
{
    /**
     * Get the post title.
     *
     * @param  string  $value
     * @return string
     */
    public function getNameAttribute($value)
    {
        return ucfirst($value);
    }
}

登入後複製

我們剛剛新增了accessor 方法，它的功能是修改文章的標題，這正是我們在單元測試用例中要測試的。以上就是 Post 模型所需要修改的內容。

建立測試控制器

接下來，我們需要建立一個檔案名稱為app/Http/Controllers/AccessorController.php 的控制器，它將被用於後續功能測試。

<?php
// app/Http/Controllers/AccessorController.php
namespace App\Http\Controllers;
use App\Post;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class AccessorController extends Controller
{
    public function index(Request $request)
    {
        // get the post-id from request params
        $post_id = $request->get("id", 0);
        // load the requested post
        $post = Post::find($post_id);
        // check the name property
        return $post->name;
    }
}

登入後複製

在 index 方法中，我們透過請求中的 id 參數，從 Post 模型中查詢一篇文章。

最後，在 routes/web.php 路由設定檔裡定義相關路由。

<?php
Route::get(&#39;accessor/index&#39;, &#39;AccessorController@index&#39;);

登入後複製

設定完路由後就可以透過 http://your-laravel-site.com/accessor/index 存取該路由是否能夠正常存取了。

單元測試

上一節我們建構了用於測試的環境。本節我們會在 Laravel 中編寫單元測試案例對 Post 模型進行測試。

幸運的是，Laravel 同樣為我們提供了創建測試用例模版檔案的命令工具。

透過在命令列執行下面的命令來建立 AccessorTest 單元測試案例類別。注意我們需要透過 --unit 參數選項來表示這個指令建立一個單元測試案例。單元測試用例檔案被建立在 tests/Unit 目錄內。

$ php artisan make:test --unit

登入後複製

执行上面创建测试用例命令会创建文件名为 tests/Unit/AccessorTest.php 文件。

<?php
// tests/Unit/AccessorTest.php
namespace Tests\Unit;
use Tests\TestCase;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class AccessorTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testExample()
    {
        $this->assertTrue(true);
    }
}

登入後複製

将 testExample 方法替换成更有实际意义的方法：

<?php
// tests/Unit/AccessorTest.php
namespace Tests\Unit;
use Tests\TestCase;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class AccessorTest extends TestCase
{
    /**
     * Test accessor method
     *
     * @return void
     */  
    public function testAccessorTest()
    {
        $db_post = DB::select(&#39;select * from posts where id = 1&#39;);
        $db_post_title = ucfirst($db_post[0]->title);
        $model_post = Post::find(1);
        $model_post_title = $model_post->title;
        $this->assertEquals($db_post_title, $model_post_title);
    }
}

登入後複製

我们可以看到更新后的代码和 Laravel 代码编码风格完全一致。在类的开始我们引入了相关依赖类文件。在 testAccessorTest 方法里，我们希望验证定义在 Post 模型里面的 getNameAttribute 方法的正确性。

为了实现这样的测试功能，我们通过 DB 类使用原生 SQL 查询到一篇文章，并将文章的标题赋值给 $db_post_title 变量。

之后，我们通过 Post 模型获取经过 getNameAttribute 方法处理过后的同一篇文章的标题赋值给 $model_post_title。

最后，通过 assertEquals 方法比较两个变量是否相等。

以上就是如何在 Laravel 中使用单元测试的使用方法。

功能测试

这一节我们将学习如何创建功能测试用例来对先前创建的控制器进行「功能测试」。

通过下面给出的命令，我们将创建一个名为 AccessorTest 的功能测试用例。注意这边我们没有使用 --unit 命令行选项，所以命令会在 tests/Feature 目录下创建一个「功能测试」用例。

$ php artisan make:test AccessorTest

登入後複製

命令会创建文件名为 tests/Feature/AccessorTest.php 的测试类。

<?php
// tests/Feature/AccessorTest.php
namespace Tests\Feature;
use Tests\TestCase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class AccessorTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testExample()
    {
        $this->assertTrue(true);
    }
}

登入後複製

同样我们替换掉 testExample 方法。

<?php
// tests/Feature/AccessorTest.php
namespace Tests\Feature;
use Tests\TestCase;
use Illuminate\Foundation\Testing\WithoutMiddleware;
use Illuminate\Foundation\Testing\DatabaseMigrations;
use Illuminate\Foundation\Testing\DatabaseTransactions;
class AccessorTest extends TestCase
{
    /**
     * A basic test example.
     *
     * @return void
     */
    public function testBasicTest()
    {
        $db_post = DB::select(&#39;select * from posts where id = 1&#39;);
        $db_post_title = ucfirst($db_post[0]->name);
        $response = $this->get(&#39;/accessor/index?id=1&#39;);
        $response->assertStatus(200);
        $response->assertSeeText($db_post_title);
    }
}

登入後複製

熟悉功能测试的朋友应该对上面的代码不会太陌生。

首先，我们还是通过 DB 类使用原生 SQL 查询到一篇文章，并将文章的标题赋值给 $db_post_title 变量。接着我们模拟一个访问 /accessor/index?id=1 URI 的 GET 请求，并通过 $response 变量接收响应。

然后，我们去匹配请求响应的状态码是否为 200。在我们的测试用例中的这个 GET 请求响应状态码应该是 200。此外，测试后还将获取到一个首字母大写的标题，判断标题是否与 $db_post_title 相对的方法是 assertSeeText。

编写完成所有的测试用例后。接下来需要去执行这些测试用例。在 Laravel 项目中运行 PHPUnit 测试用例，仅需在项目更目录执行下面的命令。