寫Laravel測試代碼(一)

MageekChiu 發(fā)布于2019-06-27 16:48 / 2778人閱讀

摘要：在中可以在設(shè)置數(shù)據(jù)庫重裝操作這樣就可以在每一個中定義本次污染的數(shù)據(jù)表，保證下一個在運行前重刷下被污染的數(shù)據(jù)表，如這樣會極大提高數(shù)據(jù)庫測試效率，不推薦使用給出的和，效率并不高。

本文主要探討寫數(shù)據(jù)庫測試。

寫laravel程序時，除了寫生產(chǎn)代碼，還需要寫測試代碼。其中，寫數(shù)據(jù)庫測試比較麻煩，因為需要針對每一個test case需要建立好數(shù)據(jù)集，該次test case污染的數(shù)據(jù)表還需要恢復(fù)現(xiàn)場，避免影響下一個test case運行，同時還得保證性能問題，否則隨著程序不斷膨脹，測試數(shù)量也越多，那每一次測試運行需要花費大量時間。

有兩個比較好的方法可以提高數(shù)據(jù)庫測試性能：

對大量的tests按照功能分組。如有1000個tests，可以按照業(yè)務(wù)功能分組，如group1:1-200, group2:201-800, group3: 801-1000。這樣可以并發(fā)運行每組測試包裹。

只恢復(fù)每個test case污染的表，而不需要把所有的數(shù)據(jù)表重新恢復(fù)，否則表數(shù)量越多測試代碼執(zhí)行越慢。

這里聊下方法2的具體做法。

假設(shè)程序有50張表，每次運行測試時首先需要為每組構(gòu)建好獨立的對應(yīng)數(shù)據(jù)庫，然后創(chuàng)建數(shù)據(jù)表，最后就是填充測試數(shù)據(jù)(fixtures)。fixtures可用yml格式定義，既直觀也方便維護(hù)，如：

#simple.yml
accounts:
  - id: 1
    person_id: 2
    type: investment
    is_included: true
  - id: 2
    person_id: 2
    type: investment
    is_included: true
transactions:
  - account_id: 1
    posted_date: "2017-01-01"
    amount: 10000
    transaction_category_id: 1   
  - account_id: 2
    posted_date: "2017-01-02"
    amount: 10001
    transaction_category_id: 2

然后需要寫個yamlSeeder class來把數(shù)據(jù)集填充到臨時數(shù)據(jù)庫里:

abstract class YamlSeeder extends IlluminateDatabaseSeeder
{
    private $files;

    public function __construct(array $files)
    {
        $this->files = $files
    }
    
    public function run(array $tables = []): void
    {
        // Close unique and foreign key constraint
        $db = $this->container["db"];
        $db->statement("SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0;");
        $db->statement("SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0;");
        
        foreach($this->files as $file) {
            ...
            
            // Convert yaml data to array
            $fixtures = SymfonyComponentYamlYaml::parse(file_get_contents($file));
            
            ...
            
            foreach($fixtures as $table => $data) {
                // Only seed specified tables, it is important!!!
                if ($tables && !in_array($table, $tables, true)) {
                    continue;
                }
                
                $db->table($table)->truncate();

                if (!$db->table($table)->insert($data)) {
                    throw new RuntimeException("xxx");
                }
            }
            
            ...
        }
        
        // Open unique and foreign key constraint
        $db->statement("SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS;");
        $db->statement("SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS;");
    }
}

class SimpleYamlSeeder extends YamlSeeder
{
    public function __construct()
    {
        parent::__construct([database.path("seeds/simple.yml")]);
    }
}

上面的代碼有一個關(guān)鍵處是參數(shù)$tables：如果參數(shù)是空數(shù)組，就把所有數(shù)據(jù)表數(shù)據(jù)插入隨機(jī)數(shù)據(jù)庫里；如果是指定的數(shù)據(jù)表，只重刷指定的數(shù)據(jù)表。這樣會很大提高數(shù)據(jù)庫測試的性能，因為可以在每一個test case里只需要指定本次測試所污染的數(shù)據(jù)表。在tests/TestCase.php中可以在setUp()設(shè)置數(shù)據(jù)庫重裝操作：

    abstract class TestCase extends IlluminateFoundationTestingTestCase
    {
        protected static $tablesToReseed = [];
        
        public function seed($class = "DatabaseSeeder", array $tables = []): void
        {
            $this->artisan("db:seed", ["--class" => $class, "--tables" => implode(",", $tables)]);
        }
        
        protected function reseed(): void
        {
            // TEST_SEEDERS is defined in phpunit.xml, e.g. 
            $seeders = env("TEST_SEEDERS") ? explode(",", env("TEST_SEEDERS")) : [];
            
            if ($seeders && is_array(static::$tablesToReseed)) {
                foreach ($seeders as $seeder) {
                    $this->seed($seeder, static::$tablesToReseed);
                }
            }
            
            Cache::flush();
            
            static::$tablesToReseed = false;
        }
        
        protected static function reseedInNextTest(array $tables = []): void
        {
            static::$tablesToReseed = $tables;
        }
    }

這樣就可以在每一個test case中定義本次污染的數(shù)據(jù)表，保證下一個test case在運行前重刷下被污染的數(shù)據(jù)表，如:

    final class AccountControllerTest extends TestCase
    {
        ...
        
        public function testUpdateAccount()
        {
            static::reseedInNextTest([Account::class, Transaction::class]);
            
            ...
        }
        
    }

這樣會極大提高數(shù)據(jù)庫測試效率，不推薦使用Laravel給出的IlluminateFoundationTestingDatabaseMigrations 和 IlluminateFoundationTestingDatabaseTransactions，效率并不高。

laravel的db:seed命令沒有--tables這個options，所以需要擴(kuò)展IlluminateDatabaseConsoleSeedsSeedCommand:

class SeedCommand extends IlluminateDatabaseConsoleSeedsSeedCommand
{
    public function fire()
    {
        if (!$this->confirmToProceed()) {
            return;
        }

        $this->resolver->setDefaultConnection($this->getDatabase());

        Model::unguarded(function () {
            $this->getSeeder()->run($this->getTables());
        });
    }
    
    protected function getTables()
    {
        $tables = $this->input->getOption("tables");

        return $tables ? explode(",", $tables) : [];
    }

    protected function getOptions()
    {
        $options   = parent::getOptions();
        $options[] = ["tables", null, InputOption::VALUE_OPTIONAL, "A comma-separated list of tables to seed, all if left empty"];

        return $options;
    }
}

當(dāng)然還得寫SeedServiceProvider()來覆蓋原有的IlluminateFoundationProvidersConsoleSupportServiceProvider::registerSeedCommand()中注冊的command.seed，然后在config/app.php中注冊：

class SeedServiceProvider extends ServiceProvider
{
    /**
     * Indicates if loading of the provider is deferred.
     *
     * @var bool
     */
    protected $defer = true;

    /**
     * @see IlluminateDatabaseSeedServiceProvider::registerSeedCommand()
     */
    public function register()
    {
        $this->app->singleton("command.seed", function ($app) {
            return new SeedCommand($app["db"]);
        });

        $this->commands("command.seed");
    }

    public function provides()
    {
        return ["command.seed"];
    }
}

OK,這樣所有的工作都做完了。。以后寫數(shù)據(jù)庫測試性能會提高很多，大量的test case可以在短時間內(nèi)運行完畢。

最后，寫測試代碼是必須的，好處非常多，隨著項目程序越來越大，就會深深感覺到寫測試是必須的，一勞永逸，值得花時間投資。也是作為一名軟件工程師的必備要求。

RightCapital招聘Laravel DevOps