背景

在很多Github開源專案頁面的readme中，經常看到類似的圖示

這個 bulid passing，其實是 Travis 的構建狀態圖示。Travis 是一個結合 Github 使用的持續整合（CI：continuous integration）工具。持續整合是一種軟體開發實踐，即團隊開發成員經常整合他們的工作，每次整合都通過自動化的構建（包括編譯，釋出，自動化測試）來驗證，從而儘早地發現整合錯誤。使用 Travis 後，每當對 Github 進行 push 操作時，都會在 Travis 提供的環境上執行自動化的構建。

1. 編寫測試程式碼

比如我們想測試一下使用者註冊功能，首先在Laravel專案路徑下執行下面命令生成測試用例檔案：

php artisan make:test RegisterTest

這樣在 tests/Feature路徑下就會生成一個 RegisterTest.php 檔案。如果是單元測試，可以在命令後面加 --unit，則會在 tests/Unit 路徑下生成單元測試檔案。

接下來編輯測試檔案：

class RegisterTest extends TestCase {
  use DatabaseTransactions;

  /**
   * A basic test example.
   *
   * @return void
   */
  public function testRegister
 
()
  {
    $response = $this->json('POST', '/api/register', [
      'name'     => 'TestUser123',
      'email'    => '[email protected]',
      'password' => '123456'
    ]);


    $response->assertStatus(200)
    ->assertJsonStructure(['token']);
  }

  public function testRegisterInvalidEmail
 
()
  {
    $response = $this->json('POST', '/api/register', [
      'name'     => 'TestUser1234',
      'email'    => 'TestUser123TestUser.com',
      'password' => '123456'
    ]);


    $response->assertStatus(500)
      ->assertJson(['message' => 'The given data failed to pass validation.']);
  }

  public function testRegisterRepeatEmail()
  {
    User::create([
      'name' => 'TestUser12345',
      'email' => '[email protected]',
      'password' => bcrypt('123456'),
    ]);

    $response = $this->json('POST', '/api/register', [
      'name'     => 'TestUser12345',
      'email'    => '[email protected]',
      'password' => '123456'
    ]);


    $response->assertStatus(500)
      ->assertJson(['message' => 'The given data failed to pass validation.']);
  }
}

開頭加上use DatabaseTransactions;，測試用例使用資料庫事務，這樣在用例執行完後，對資料庫的修改都會被恢復。

後面三個函式對應3個測試用例，分別測試了註冊成功，e-mail地址不合法，和e-mail地址跟已存在的使用者重複的情況。程式碼都很好理解，因為 api 功能返回的是 json 格式的資料，這裡用了 Laravel 框架的 json 斷言 assertJsonStructure 和 assertJson，前者代表 Response body 的 json 資料包含後面的格式，但不關注欄位的值，後者則要求 json 資料中包含了對應的欄位和值。

用例寫好後，在專案路徑下執行命令 phpunit，測試通過：

vagrant@homestead:~/Code/jokes$ phpunit
PHPUnit 5.7.19 by Sebastian Bergmann and contributors.

.....                                                               5 / 5 (100%)

Time: 5.23 seconds, Memory: 14.00MB

OK (5 tests, 8 assertions)

2. 配置Travis

Travis是一個持續整合工具，對於Github 上的開源專案可以免費使用。首先開啟網站 https://travis-ci.org/ ，使用 Github 賬號授權登入，之後 Travis 會同步 Github 上的開源專案，選擇你要進行持續整合的專案即可，過程比較簡單，照著Travis官方文件操作就行，關鍵的地方就是要編輯好Travis的配置檔案，下面就介紹一下基於PHP Laravel 框架的專案配置時需要注意的地方。

1 準備環境配置檔案

Laravel專案很多配置都放在 .env 檔案裡，這個檔案一般在不同的執行環境上會單獨去配置，也不會新增到 Git 中。因此我們首先準備一個在 Travis 環境上用的檔案，先直接將框架自帶的初始檔案 .env.example 拷貝一份：

cp .env.example .env.travis

然後在修改，主要改了兩個地方，一是資料庫配置：

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=jokes
DB_USERNAME=root
DB_PASSWORD=

Travis環境預設支援 MySql，賬號有 root 和 travis，密碼為空，在 .env.travis 檔案中做相應修改，賬戶選擇了許可權較高的 root 。

第二個是增加 Dingo/Api 的相關配置，為了測試用例和我們實際線上環境一直，這裡主要加了字首等資訊：

# DINGO/API
API_STANDARDS_TREE=vnd
API_SUBTYPE=jokes
API_PREFIX=api
API_VERSION=v1
API_NAME=jokes
API_CONDITIONAL_REQUEST=false
API_STRICT=false
API_DEBUG=true
API_DEFAULT_FORMAT=json

2 編輯 Travis 配置檔案

在專案根路徑下新增 .travis.yml 檔案，新增如下內容：

language: php
php:
  - 7.1
service:
  - mysql
before_script:
  - composer install
  - composer dump-autoload
  - cp .env.travis .env
  - php artisan jwt:generate
  - php artisan key:generate
  - php artisan vendor:publish
  - mysql -e 'CREATE DATABASE IF NOT EXISTS jokes ;'
  - php artisan migrate
script: phpunit

• 指定使用的語言為 PHP，並指定了要執行的版本。
• 指明需要啟動 MySql 服務。
• before_script，表明在執行測試之前需要做的工作，這裡我們做了Laravel 專案執行前基本的準備工作:
  
  • 通過 composer 安裝依賴
  • 將之前準備的 Travis 環境專用的 .env 檔案拷貝
  • 生成金鑰
  • 釋出 vendor 檔案
  • 建立 jokes 資料庫
  • 執行資料庫遷移，建立資料表

• 執行測試 phpunit

  3. 自動執行Travis

  配置好上面的內容後，當想 Github 發起 push 後，就會自動進行持續整合，安裝上面的配置一步步執行，告知測試結果。
  

4. 新增構建狀態圖示

在 Travis 專案介面點選狀態圖示，在彈出的視窗中現在對應的分支，以及格式，比如 Markdown，將程式碼複製到專案的 readme.md 檔案中：

readme.md：

[![Build Status](https://travis-ci.org/zhongchenyu/jokes-laravel.svg?branch=master)](https://travis-ci.org/zhongchenyu/jokes-laravel)

An api server project using PHP Framework Laravel.