PHPUnit 自動化測試大作戰【CH23】
更新於 2024/12/17閱讀時間約 12 分鐘
今天我們來聊聊覆蓋率報告吧！
何為覆蓋率報告 & 為何需要覆蓋率報告
所謂的覆蓋率報告，指的是能指出我們的專案程式庫，有被測試程式碼實際測試到的部分的佔比有多少。當我們了解有多少程式碼有被覆蓋到，以及有多少程式碼沒被覆蓋到時，理論上我們可以對程式碼是否可正常運作更有信心！
事前準備
- 先將以 Laradock 啟動的各 Docker 容器關閉：
# Laradock 目錄下
docker-compose down
- 將 Laradock 目錄下的 php-fpm 資料夾下的 Dockerfile，尋找
# Check PHP version:字樣，在其上方加入以下幾行：
# 上略
# Add following commmands
RUN pecl install xdebugRUN docker-php-ext-enable xdebug# End of adding commands
###########################################################################
# Check PHP version:
###########################################################################
- 啟動 PHP-FPM 容器：
docker-compose up -d php-fpm
- 進入 PHP-FPM 容器：
docker exec -it laradock-php-fpm-1 bash
測試覆蓋率報告產製
測試覆蓋率報告主要有2種產製方式，一種是純文字輸出於終端機上，一種是輸出 HTML 檔，以下我們就分別測試看看：
純文字輸出
- 在 PHP-FPM 容器內，輸入以下指令：
XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-text
- 輸出範例：
PHPUnit 9.5.24 #StandWithUkraine
........... 11 / 11 (100%)
Time: 00:00.321, Memory: 14.00 MB
OK (11 tests, 48 assertions)
Code Coverage Report:
2022-10-07 06:28:48
Summary:
Classes: 0.00% (0/11)
Methods: 0.00% (0/12)
Lines: 6.45% (2/31)
App\Console\Kernel
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 2)
App\Exceptions\Handler
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)
App\Http\Controllers\Controller
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Kernel
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Middleware\Authenticate
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 2)
App\Http\Middleware\EncryptCookies
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Middleware\ForbidLoginDuringLunch
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 4)
App\Http\Middleware\PreventRequestsDuringMaintenance
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Middleware\RedirectIfAuthenticated
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 5)
App\Http\Middleware\TrimStrings
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Middleware\TrustHosts
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)
App\Http\Middleware\TrustProxies
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Middleware\ValidateSignature
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Http\Middleware\VerifyCsrfToken
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Models\User
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Providers\AppServiceProvider
Methods: ( 0/ 0) Lines: ( 0/ 0)
App\Providers\AuthServiceProvider
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)
App\Providers\BroadcastServiceProvider
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 2)
App\Providers\EventServiceProvider
Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)
App\Providers\RouteServiceProvider
Methods: 0.00% ( 0/ 2) Lines: 0.00% ( 0/ 9)
App\Services\TestService
Methods: 0.00% ( 0/ 1) Lines: 66.67% ( 2/ 3) 11 / 11 (100%)Time: 00:00.321, Memory: 14.00 MBOK (11 tests, 48 assertions)Code Coverage Report: 2022-10-07 06:28:48 Summary: Classes: 0.00% (0/11) Methods: 0.00% (0/12) Lines: 6.45% (2/31)App\Console\Kernel Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 2)App\Exceptions\Handler Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)App\Http\Controllers\Controller Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Kernel Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Middleware\Authenticate Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 2)App\Http\Middleware\EncryptCookies Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Middleware\ForbidLoginDuringLunch Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 4)App\Http\Middleware\PreventRequestsDuringMaintenance Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Middleware\RedirectIfAuthenticated Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 5)App\Http\Middleware\TrimStrings Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Middleware\TrustHosts Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)App\Http\Middleware\TrustProxies Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Middleware\ValidateSignature Methods: ( 0/ 0) Lines: ( 0/ 0)App\Http\Middleware\VerifyCsrfToken Methods: ( 0/ 0) Lines: ( 0/ 0)App\Models\User Methods: ( 0/ 0) Lines: ( 0/ 0)App\Providers\AppServiceProvider Methods: ( 0/ 0) Lines: ( 0/ 0)App\Providers\AuthServiceProvider Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)App\Providers\BroadcastServiceProvider Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 2)App\Providers\EventServiceProvider Methods: 0.00% ( 0/ 1) Lines: 0.00% ( 0/ 1)App\Providers\RouteServiceProvider Methods: 0.00% ( 0/ 2) Lines: 0.00% ( 0/ 9)App\Services\TestService Methods: 0.00% ( 0/ 1) Lines: 66.67% ( 2/ 3)
- 說明：首先可以看到
Summary的地方，這邊會顯示3種覆蓋率：Classes、Methods、Lines，前2者都是要將單一 Class/Method 內每一行可執行程式碼都有被測試程式碼覆蓋到，才會計算在內，而 Lines 就單純多了，就是有幾行可執行程式碼有被測試程式碼覆蓋到。
輸出HTML檔
- 在 PHP-FPM 容器內，輸入以下指令：
XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html report/
- 輸出範例：
- 說明：HTML檔會好看得多，從輸出範例1上可以一目了然，各資料夾的各類覆蓋率是多少。除此之外，從輸出範例2可知還可以單看某一個檔案的覆蓋率。
以上就是今天的介紹，大家是不是更了解測試覆蓋率了呢？
之後的篇幅，讓我們來演練一些情境題吧！
如果您喜歡這篇文章，歡迎加入追蹤以接收新文章通知 😄
參考資料
留言0
查看全部
你可能也想看
Google News 追蹤
*合作聲明與警語：
本文係由國泰世華銀行邀稿。
證券服務係由國泰世華銀行辦理共同行銷證券經紀開戶業務，定期定額(股)服務由國泰綜合證券提供。
剛出社會的時候，很常在各種 Podcast 或 YouTube 甚至是在朋友間聊天，都會聽到各種市場動態、理財話題，像是：聯準會降息或是近期哪些科
在前一篇文章中，我們探討了多重資料庫連線情境下，Model 及 Database Assertion 的應對方式，不過實際上筆者認為比較有難度的，其實是 Migration 應對方式。
今天就讓我們來探討這部分吧！
Migration 應對方式
對於多重資料庫連線這種情境，筆者實務上做過的對應
今天讓我們探討「缺乏 Migration Files 與 Factory Files」的 Legacy 情境吧！
很多時候我們會遇到沒有 Migration Files 或 Factory Files 的 Legacy Codebase，原因大概有以下幾種：
該程式庫原本不是以 Laravel
在實務情境上，常會有在單一專案程式庫中，存取多個不同資料庫的使用情境，在這種情況下，我們通常會設置多個資料庫連線（Database Connection）設定。
在平常開發使用設很方便，但要做測試時就會發現一些問題：
在測試程式碼或 Seeder 中調用 factory() 時，都是在預設連線資
今天就讓我們依照前一天的情境題，來撰寫測試案例函數吧！
這次同樣地，先讓我們規畫擬訂測試案例：
測試案例
使用者註冊：
使用者可送出註冊資料，系統將建立使用者資料，並送出含有專屬驗證連結之驗證信，當此驗證連結被開啟後，將讓使用者轉為已驗證狀態
請求錯誤的驗證連結：
錯誤的驗證連結被開啟後
前兩天，我們探討了「網站文章」的情境題；今明兩天，就讓我們探討另一個情境題「會員註冊」吧！
這邊我們同樣假設網站是採前後端分離的設計，因此我們就專注在測試 API 的部分，不過會多一個「註冊驗證信」的部分要實作與做測試驗證。
使用案例
使用者可填寫註冊資料後送出資料。
使用者可收到註冊驗證信
練習 PHPUnit 測試的撰寫，依序創建Controller、Service，並針對計算邏輯進行單元測試的練習。
在 Laravel 中的測試中，PHPUnit 和 Mockery 都可以用來創建測試替身（test double），但它們有不同的方式和功能，以下簡單介紹兩種寫法方式。
前言
基本準備差不多了，也能跑自己的測試，再來就是關於測試腳本的核心：元素定位跟動作，本篇會著重介紹 XPATH 定位的部分
前言
上篇我們成功執行第一個測試案例，從 Python 腳本透過 Appium 控制模擬器點選設定中的電池，下個問題就是怎麼找元件，這時候就要請出 Appium Inspector 了
前言
經過五個小單元的準備，終於可以開始跑第一個測試了，Appium 本身是個工具，可以搭配各種語言，這邊選擇 Python 作為測試腳本語言，以便之後跟 Robot Framework 串接。
*合作聲明與警語：
本文係由國泰世華銀行邀稿。
證券服務係由國泰世華銀行辦理共同行銷證券經紀開戶業務，定期定額(股)服務由國泰綜合證券提供。
剛出社會的時候，很常在各種 Podcast 或 YouTube 甚至是在朋友間聊天，都會聽到各種市場動態、理財話題，像是：聯準會降息或是近期哪些科
在前一篇文章中，我們探討了多重資料庫連線情境下，Model 及 Database Assertion 的應對方式，不過實際上筆者認為比較有難度的，其實是 Migration 應對方式。
今天就讓我們來探討這部分吧！
Migration 應對方式
對於多重資料庫連線這種情境，筆者實務上做過的對應
今天讓我們探討「缺乏 Migration Files 與 Factory Files」的 Legacy 情境吧！
很多時候我們會遇到沒有 Migration Files 或 Factory Files 的 Legacy Codebase，原因大概有以下幾種：
該程式庫原本不是以 Laravel
在實務情境上，常會有在單一專案程式庫中，存取多個不同資料庫的使用情境，在這種情況下，我們通常會設置多個資料庫連線（Database Connection）設定。
在平常開發使用設很方便，但要做測試時就會發現一些問題：
在測試程式碼或 Seeder 中調用 factory() 時，都是在預設連線資
今天就讓我們依照前一天的情境題，來撰寫測試案例函數吧！
這次同樣地，先讓我們規畫擬訂測試案例：
測試案例
使用者註冊：
使用者可送出註冊資料，系統將建立使用者資料，並送出含有專屬驗證連結之驗證信，當此驗證連結被開啟後，將讓使用者轉為已驗證狀態
請求錯誤的驗證連結：
錯誤的驗證連結被開啟後
前兩天，我們探討了「網站文章」的情境題；今明兩天，就讓我們探討另一個情境題「會員註冊」吧！
這邊我們同樣假設網站是採前後端分離的設計，因此我們就專注在測試 API 的部分，不過會多一個「註冊驗證信」的部分要實作與做測試驗證。
使用案例
使用者可填寫註冊資料後送出資料。
使用者可收到註冊驗證信
練習 PHPUnit 測試的撰寫，依序創建Controller、Service，並針對計算邏輯進行單元測試的練習。
在 Laravel 中的測試中，PHPUnit 和 Mockery 都可以用來創建測試替身（test double），但它們有不同的方式和功能，以下簡單介紹兩種寫法方式。
前言
基本準備差不多了，也能跑自己的測試，再來就是關於測試腳本的核心：元素定位跟動作，本篇會著重介紹 XPATH 定位的部分
前言
上篇我們成功執行第一個測試案例，從 Python 腳本透過 Appium 控制模擬器點選設定中的電池，下個問題就是怎麼找元件，這時候就要請出 Appium Inspector 了
前言
經過五個小單元的準備，終於可以開始跑第一個測試了，Appium 本身是個工具，可以搭配各種語言，這邊選擇 Python 作為測試腳本語言，以便之後跟 Robot Framework 串接。