使用 TDD 測試驅動開發來構建 Laravel REST API

Summer__發表於2019-03-06

LaravelRESTAPI

TDD 以及敏捷開發的先驅者之一的 James Grenning有句名言：

如果你沒有進行測試驅動開發，那麼你應該正在做開發後堵漏的事 - James Grenning

今天我們將進行一場基於 Laravel 的測試驅動開發之旅。我們將建立一個完整的 Laravel REST API，其中包含身份驗證和 CRUD 功能，而無需開啟 Postman 或瀏覽器。?

注意：本旅程假定你已經理解了 Laravel 和 PHPUnit 的基本概念。你是否已經明晰了這個問題？那就開始吧。

專案設定

首先建立一個新的 Laravel 專案 composer create-project --prefer-dist laravel/laravel tdd-journey。

然後，我們需要建立使用者認證腳手架，執行 php artisan make:auth ，設定好 .env 檔案中的資料庫配置後，執行資料庫遷移 php artisan migrate。

本測試專案並不會使用到剛生成的使用者認證相關的路由和檢視。我們將使用 jwt-auth。所以需要繼續安裝 jwt 到專案。

注意：如果您在執行 jwt:generate 指令時遇到錯誤, 您可以參考這裡解決這個問題，直到 jwt 被正確安裝到專案中。

最後，您需要在 tests/Unit 和 tests/Feature 目錄中刪除 ExampleTest.php 檔案，使我們的測試結果不被影響。

編碼

首先將 JWT 驅動配置為 auth 配置項的預設值：


<?php 
// config/auth.php file
'defaults' => [
    'guard' => 'api',
    'passwords' => 'users',
],
'guards' => [
    ...
    'api' => [
        'driver' => 'jwt',
        'provider' => 'users',
    ],
],
複製程式碼

然後將如下內容放到你的 routes/api.php 檔案裡：

<?php
Route::group(['middleware' => 'api', 'prefix' => 'auth'], function () {
    Route::post('authenticate', 'AuthController@authenticate')->name('api.authenticate');
    Route::post('register', 'AuthController@register')->name('api.register');
});
複製程式碼

現在我們已經將驅動設定完成了，如法炮製，去設定你的使用者模型：

<?php
...
class User extends Authenticatable implements JWTSubject
{
    ...
     //獲取將被儲存在 JWT 主體 claim 中的標識
    public function getJWTIdentifier()
    {
        return $this->getKey();
    }
    // 返回一個鍵值對陣列，包含要新增到 JWT 的任何自定義 claim
    public function getJWTCustomClaims()
    {
        return [];
    }
}
複製程式碼

我們所需要做的就是實現 JWTSubject 介面然後新增相應的方法即可。

接下來，我們需要增加許可權認證方法到控制器中.

執行 php artisan make:controller AuthController 並且新增以下方法：

<?php
...
class AuthController extends Controller
{
    
    public function authenticate(Request $request){
        // 驗證欄位
        $this->validate($request,['email' => 'required|email','password'=> 'required']);
        // 測試驗證
        $credentials = $request->only(['email','password']);
        if (! $token = auth()->attempt($credentials)) {
            return response()->json(['error' => 'Incorrect credentials'], 401);
        }
        return response()->json(compact('token'));
    }
    public function register(Request $request){
        // 表達驗證
        $this->validate($request,[
            'email' => 'required|email|max:255|unique:users',
            'name' => 'required|max:255',
            'password' => 'required|min:8|confirmed',
        ]);
        // 建立使用者並生成 Token
        $user =  User::create([
            'name' => $request->input('name'),
            'email' => $request->input('email'),
            'password' => Hash::make($request->input('password')),
        ]);
        $token = JWTAuth::fromUser($user);
        return response()->json(compact('token'));
    }
}
複製程式碼

這一步非常直接，我們要做的就是新增 authenticate 和 register 方法到我們的控制器中。在 authenticate 方法，我們驗證了輸入，嘗試去登入，如果成功就返回令牌。在 register 方法，我們驗證輸入，然後基於此建立一個使用者並且生成令牌。

4. 接下來，我們進入相對簡單的部分。測試我們剛寫入的內容。使用 php artisan make：test AuthTest 生成測試類。在新的 tests / Feature / AuthTest 中新增以下方法：

<?php 
/**
 * @test 
 * Test registration
 */
public function testRegister(){
    //建立測試使用者資料
    $data = [
        'email' => 'test@gmail.com',
        'name' => 'Test',
        'password' => 'secret1234',
        'password_confirmation' => 'secret1234',
    ];
    //傳送 post 請求
    $response = $this->json('POST',route('api.register'),$data);
    //判斷是否傳送成功
    $response->assertStatus(200);
    //接收我們得到的 token
    $this->assertArrayHasKey('token',$response->json());
    //刪除資料
    User::where('email','test@gmail.com')->delete();
}
/**
 * @test
 * Test login
 */
public function testLogin()
{
    //建立使用者
    User::create([
        'name' => 'test',
        'email'=>'test@gmail.com',
        'password' => bcrypt('secret1234')
    ]);
    //模擬登陸
    $response = $this->json('POST',route('api.authenticate'),[
        'email' => 'test@gmail.com',
        'password' => 'secret1234',
    ]);
    //判斷是否登入成功並且收到了 token 
    $response->assertStatus(200);
    $this->assertArrayHasKey('token',$response->json());
    //刪除使用者
    User::where('email','test@gmail.com')->delete();
}
複製程式碼

上面程式碼中的幾行註釋概括了程式碼的大概作用。您應該注意的一件事是我們如何在每個測試中建立和刪除使用者。測試的全部要點是它們應該彼此獨立並且應該在你的理想情況下存在資料庫中的狀態。

如果你想全域性安裝它，可以執行 $ vendor / bin / phpunit 或 $ phpunit 命令。執行後它應該會給你返回是否安裝成功的資料。如果不是這種情況，您可以瀏覽日誌，修復並重新測試。這就是 TDD 的美麗之處。

5. 對於本教程，我們將使用『菜譜 Recipes』作為我們的 CRUD 資料模型。

首先建立我們的遷移資料表 php artisan make：migration create_recipes_table 並新增以下內容：


<?php 
...
public function up()
{
    Schema::create('recipes', function (Blueprint $table) {
        $table->increments('id');
        $table->string('title');
        $table->text('procedure')->nullable();
        $table->tinyInteger('publisher_id')->nullable();
        $table->timestamps();
    });
}
public function down()
{
    Schema::dropIfExists('recipes');
}
複製程式碼

然後執行資料遷移。現在使用命令 php artisan make：model Recipe 來生成模型並將其新增到我們的模型中。

<?php 
...
protected $fillable = ['title','procedure'];
/**
 * 釋出者
 * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
 */
public function publisher(){
    return $this->belongsTo(User::class);
}
複製程式碼

然後將此方法新增到 user 模型。

<?php
...
  /**
 * 獲取所有菜譜
 * @return \Illuminate\Database\Eloquent\Relations\HasMany
 */
public function recipes(){
    return $this->hasMany(Recipe::class);
}
複製程式碼

6. 現在我們需要最後一部分設定來完成我們的食譜管理。首先，我們將建立控制器 php artisan make：controller RecipeController 。接下來，編輯 routes / api.php 檔案並新增 create 路由端點。

<?php 
...
  Route::group(['middleware' => ['api','auth'],'prefix' => 'recipe'],function (){
    Route::post('create','RecipeController@create')->name('recipe.create');
});
複製程式碼

在控制器中，還要新增 create 方法

<?php 
...
  public function create(Request $request){
    //驗證資料
    $this->validate($request,['title' => 'required','procedure' => 'required|min:8']);
    //建立配方並附加到使用者
    $user = Auth::user();
    $recipe = Recipe::create($request->only(['title','procedure']));
    $user->recipes()->save($recipe);
    //返回 json 格式的食譜資料
    return $recipe->toJson();
}
複製程式碼

使用 php artisan make：test RecipeTest 生成特徵測試並編輯內容，如下所示：

<?php 
...
class RecipeTest extends TestCase
{
    use RefreshDatabase;
    ...
    //建立使用者並驗證使用者身份
    protected function authenticate(){
        $user = User::create([
            'name' => 'test',
            'email' => 'test@gmail.com',
            'password' => Hash::make('secret1234'),
        ]);
        $token = JWTAuth::fromUser($user);
        return $token;
    }
  
    public function testCreate()
    {
        //獲取 token
        $token = $this->authenticate();
        $response = $this->withHeaders([
            'Authorization' => 'Bearer '. $token,
        ])->json('POST',route('recipe.create'),[
            'title' => 'Jollof Rice',
            'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
        ]);
        $response->assertStatus(200);
    }
}
複製程式碼

上面的程式碼你可能還是不太理解。我們所做的就是建立一個用於處理使用者註冊和 token 生成的方法，然後在 testCreate() 方法中使用該 token 。注意使用 RefreshDatabase trait ，這個 trait 是 Laravel 在每次測試後重置資料庫的便捷方式，非常適合我們漂亮的小專案。

好的，所以現在，我們只要判斷當前請求是否是響應狀態，然後繼續執行 $ vendor/bin/phpunit 。

如果一切執行順利，您應該收到錯誤。 ?

There was 1 failure:

Tests\Feature\RecipeTest::testCreate Expected status code 200 but received 500. Failed asserting that false is true.

/home/user/sites/tdd-journey/vendor/laravel/framework/src/Illuminate/Foundation/Testing/TestResponse.php:133 /home/user/sites/tdd-journey/tests/Feature/RecipeTest.php:49

FAILURES! Tests: 3, Assertions: 5, Failures: 1.

檢視日誌檔案，我們可以看到罪魁禍首是 Recipe 和 User 類中的 publisher 和 recipes 的關係。 Laravel 嘗試在表中找到一個欄位為 user_id 的列並將其用作於外來鍵，但在我們的遷移中，我們將publisher_id設定為外來鍵。現在，將行調整為：

//食譜檔案
public function publisher(){
    return $this->belongsTo(User::class,'publisher_id');
}
//使用者檔案
public function recipes(){
    return $this->hasMany(Recipe::class,'publisher_id');
}
複製程式碼

然後重新執行測試。如果一切順利，我們將獲得所有綠色測試！?

...                                                                 
3 / 3 (100%)
...
OK (3 tests, 5 assertions)
複製程式碼

現在我們仍然需要測試建立配方的方法。為此，我們可以判斷使用者的『菜譜 Recipes』計數。更新你的 testCreate 方法，如下所示：


<?php
...
//獲取 token
$token = $this->authenticate();
$response = $this->withHeaders([
    'Authorization' => 'Bearer '. $token,
])->json('POST',route('recipe.create'),[
    'title' => 'Jollof Rice',
    'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
]);
$response->assertStatus(200);
//得到計數做出判斷
$count = User::where('email','test@gmail.com')->first()->recipes()->count();
$this->assertEquals(1,$count);
複製程式碼

我們現在可以繼續編寫其餘的方法。首先，編寫我們的 routes/api.php

<?php
...
Route::group(['middleware' => ['api','auth'],'prefix' => 'recipe'],function (){
    Route::post('create','RecipeController@create')->name('recipe.create');
    Route::get('all','RecipeController@all')->name('recipe.all');
    Route::post('update/{recipe}','RecipeController@update')->name('recipe.update');
    Route::get('show/{recipe}','RecipeController@show')->name('recipe.show');
    Route::post('delete/{recipe}','RecipeController@delete')->name('recipe.delete');
});
複製程式碼

接下來，我們將方法新增到控制器。以下面這種方式更新 RecipeController 類。

<?php 
....
//建立配方
public function create(Request $request){
    //驗證
    $this->validate($request,['title' => 'required','procedure' => 'required|min:8']);
    //建立配方並附加到使用者
    $user = Auth::user();
    $recipe = Recipe::create($request->only(['title','procedure']));
    $user->recipes()->save($recipe);
    //返回配方的 json 格式資料
    return $recipe->toJson();
}
//獲取所有的配方
public function all(){
    return Auth::user()->recipes;
}
//更新配方
public function update(Request $request, Recipe $recipe){
    //檢查使用者是否是配方的所有者
    if($recipe->publisher_id != Auth::id()){
        abort(404);
        return;
    }
    //更新並返回
    $recipe->update($request->only('title','procedure'));
    return $recipe->toJson();
}
//顯示單個食譜的詳細資訊
public function show(Recipe $recipe){
    if($recipe->publisher_id != Auth::id()){
        abort(404);
        return;
    }
    return $recipe->toJson();
}
//刪除一個配方
public function delete(Recipe $recipe){
    if($recipe->publisher_id != Auth::id()){
        abort(404);
        return;
    }
    $recipe->delete();
}
複製程式碼

程式碼和註釋已經很好地解釋了這個邏輯。

最後我們的 test/Feature/RecipeTest:

<?php
...
  use RefreshDatabase;
protected $user;
// 建立使用者並驗證他
protected function authenticate(){
    $user = User::create([
        'name' => 'test',
        'email' => 'test@gmail.com',
        'password' => Hash::make('secret1234'),
    ]);
    $this->user = $user;
    $token = JWTAuth::fromUser($user);
    return $token;
}
// 測試建立路由
public function testCreate()
{
    // 獲取令牌
    $token = $this->authenticate();
    $response = $this->withHeaders([
        'Authorization' => 'Bearer '. $token,
    ])->json('POST',route('recipe.create'),[
        'title' => 'Jollof Rice',
        'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
    ]);
    $response->assertStatus(200);
    // 獲取計數並斷言
    $count = $this->user->recipes()->count();
    $this->assertEquals(1,$count);
}
// 測試顯示所有路由
public function testAll(){
    // 驗證並將配方附加到使用者
    $token = $this->authenticate();
    $recipe = Recipe::create([
        'title' => 'Jollof Rice',
        'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
    ]);
    $this->user->recipes()->save($recipe);
    // 呼叫路由並斷言響應
    $response = $this->withHeaders([
        'Authorization' => 'Bearer '. $token,
    ])->json('GET',route('recipe.all'));
    $response->assertStatus(200);
    // 斷言計數為1，第一項的標題相關
    $this->assertEquals(1,count($response->json()));
    $this->assertEquals('Jollof Rice',$response->json()[0]['title']);
}
// 測試更新路由
public function testUpdate(){
    $token = $this->authenticate();
    $recipe = Recipe::create([
        'title' => 'Jollof Rice',
        'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
    ]);
    $this->user->recipes()->save($recipe);
    // 呼叫路由並斷言響應
    $response = $this->withHeaders([
        'Authorization' => 'Bearer '. $token,
    ])->json('POST',route('recipe.update',['recipe' => $recipe->id]),[
        'title' => 'Rice',
    ]);
    $response->assertStatus(200);
    // 斷言標題是新標題
    $this->assertEquals('Rice',$this->user->recipes()->first()->title);
}
// 測試單一的展示路由
public function testShow(){
    $token = $this->authenticate();
    $recipe = Recipe::create([
        'title' => 'Jollof Rice',
        'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
    ]);
    $this->user->recipes()->save($recipe);
    $response = $this->withHeaders([
        'Authorization' => 'Bearer '. $token,
    ])->json('GET',route('recipe.show',['recipe' => $recipe->id]));
    $response->assertStatus(200);
    // 斷言標題是正確的
    $this->assertEquals('Jollof Rice',$response->json()['title']);
}
// 測試刪除路由
public function testDelete(){
    $token = $this->authenticate();
    $recipe = Recipe::create([
        'title' => 'Jollof Rice',
        'procedure' => 'Parboil rice, get pepper and mix, and some spice and serve!'
    ]);
    $this->user->recipes()->save($recipe);
    $response = $this->withHeaders([
        'Authorization' => 'Bearer '. $token,
    ])->json('POST',route('recipe.delete',['recipe' => $recipe->id]));
    $response->assertStatus(200);
    // 斷言沒有食譜
    $this->assertEquals(0,$this->user->recipes()->count());
}
複製程式碼

除了附加測試之外，我們還新增了一個類範圍的 $user 屬性。這樣，我們不止可以利用 $user 來使用 authenticate 方法不僅生成令牌，而且還為後續其他對 $user 的操作做好了準備。

現在執行 $ vendor/bin/phpunit 如果操作正確，你應該進行所有綠色測試。

結論

希望這能讓你深度瞭解在 TDD 在 Laravel 專案中的執行方式。他絕對是一個比這更寬泛的概念，一個不受特地方法約束的概念。

雖然這種開發方法看起來比常見的除錯後期程式要耗時，但他很適合在程式碼中儘早捕獲錯誤。雖然有些情況下非 TDD 方式會更有用，但習慣於 TDD 模式開發是一種可靠的技能和習慣。

本演練的全部程式碼可參見 Github here 倉庫。請隨意使用。

乾杯！

文章轉自：https://learnku.com/laravel/t/22690
更多文章：https://learnku.com/laravel/c/translations

使用Spring Boot REST API進行測試驅動開發
2018-09-12
Spring BootRESTAPI
TDD（測試驅動開發）死了嗎？
2019-06-26
測試驅動開發(TDD)例項演示
2020-05-14
測試驅動開發(TDD)實戰心得 - DeniMoka
2020-11-17
測試驅動開發（TDD）總結——原理篇
2019-02-21
變異測試是測試驅動開發（TDD）的演變
2019-10-17
測試驅動開發（TDD）—— 資料庫查詢篇
2019-09-03
資料庫
Swift 進階開發指南：如何使用 Quick、Nimble 執行測試驅動開發（TDD）
2019-03-04
SwiftUI
Laravel 測試驅動開發 -- 正向單元測試
2018-07-25
Laravel
測試驅動開發TDD | IDCF FDCC認證學員作品
2020-07-06
Laravel 專案：使用 TDD 構建論壇 Chapter 15
2018-05-05
LaravelAPT
Laravel 專案：使用 TDD 構建論壇 Chapter 8
2018-04-30
LaravelAPT
Laravel 專案：使用 TDD 構建論壇 Chapter 4
2018-04-28
LaravelAPT
Laravel 專案：使用 TDD 構建論壇 Chapter 1
2018-04-18
LaravelAPT
Laravel 專案：使用 TDD 構建論壇 Chapter 0
2018-04-17
LaravelAPT
使用JBang構建Spring Boot Rest API教程
2024-04-07
Spring BootRESTAPI
Go 語言：透過TDD測試驅動開發學習 Mocking （模擬）的思想
2023-03-27
GoMock
TDD測試驅動開發：Hello, YOU -- 透過簡單的 hello_test.go 程式學會編寫測試,學習使用常量來最佳化並根據需要重構
2023-03-16
Go
談“測試驅動的開發”
2020-04-06
[實戰] 使用 MongoDB Go 驅動與 Iris 構建 RESTful API
2019-10-30
MongoDBRESTAPI
在 .NET Core 中構建 REST API
2021-03-15
RESTAPI
簡單的11步在Laravel中實現測試驅動開發
2019-02-27
Laravel
簡單的 11 步在 Laravel 中實現測試驅動開發
2018-07-17
Laravel
什麼是測試驅動開發
2024-11-03
laravel7使用JWT+Dingo構建API
2020-08-04
LaravelJWTGoAPI
使用go語言開發自動化API測試工具
2024-03-08
GoAPI
Django REST framework API 指南（26）：測試
2018-03-24
DjangoRESTFrameworkAPI
使用Ollama部署本地LLM：構建AI REST API的簡易指南
2024-09-29
AIRESTAPI
探索Django REST框架構建強大的API
2024-03-29
DjangoREST框架架構API
Quarkus入門：構建PetClinic REST API - Rafał Borowiec
2020-03-01
RESTAPI
Slack使用開源元件構建自動驅動Kafka叢集
2022-03-13
元件Kafka
Rest Assured+TestNg實現資料驅動的介面測試
2018-06-14
REST
Laravel 使用 passport 開發 API 介面
2020-05-25
LaravelPassportAPI
[譯] 使用 Node 和 OAuth 2.0 構建一個簡單的 REST API
2018-10-01
OAuthRESTAPI
用Java構建反應式REST API - Kalpa Senanayake
2019-02-06
JavaRESTAPINaN
驅動開發目標測試機器設定
2024-11-01
在 Laravel 中使用子查詢來構建動態模型關係
2019-07-26
Laravel模型
用 TDD 的方式為 Laravel 開發擴充套件
2020-05-04
Laravel套件

使用 TDD 測試驅動開發來構建 Laravel REST API

專案設定

編碼

結論

相關文章