Lập trình với Yii2: Kiểm tra tự động với Codeception

() translation by (you can also view the original English article)

Final product image — What You'll Be Creating

Nếu bạn đang hỏi "Yii là gì?", thì hãy xem hướng dẫn trước của tôi Introduction to the Yii framework - để biết được lợi ích của Yii và tổng quan có gì mới ở Yii 2.0, phát hành vào tháng 10 2014.

Trong loạt bài Programming with Yii2 - Lập trình cùng Yii2, tôi hướng dẫn các bạn sử dụng framework Yii2 của PHP. Trong hướng dẫn này, tôi sẽ khám phá chủ đề test tự động bằng Codeception, được tích hợp với framework Yii2.

Phải thừa nhận rằng, kinh nghiệm viết về tests của tôi thực sự hiếm hoi. Tôi thường tham gia các dự án một mình hoặc quy mô nhỏ với nguồn lực hạn chế. Trong suốt thời gian làm việc tại Microsoft, chúng tôi có những đội ngũ test riêng biệt đảm nhậm việc này. Nhưng thẳng thắn mà nói điều này có thể là điển hình với cả bạn quá, phải không? Các lập trình viên thích code, họ không viết test - ít nhất là các lập trình viên ngày xưa không làm thế.

Codeception là một thư viện đầy sáng tạo theo nghĩa đen nhằm mục đích làm cho các bài test viết vui vẻ và dễ dàng. Và tôi muốn nói rằng họ đã thành công ở mức độ vừa phải. Khi tôi thận trọng bắt đầu trải nghiệm vào hồ nước của Codeception, thật sự dễ dàng và thú vị. Tuy nhiên, khi tôi bắt đầu đi tiến xa hơn, tôi đã gặp phải vấn đề về cấu hình với Yii và các mô-đun cụ thể được sử dụng trong loạt bài này. Chắc chắn có những thách thức. Nhìn chung, dù tôi rất ấn tượng và nhìn thấy lợi ích của việc học hỏi nhiều hơn.

Đơn giản mà nói, Codeception và tích hợp của nó với Yii khiến tôi muốn viết test nhiều hơn. Tôi hoài nghi bạn sẽ có một trải nghiệm tương tự.

Một nhắc nhở nhỏ trước khi chúng ta bắt đầu, tôi luôn tham gia vào các chủ đề bình luận phía dưới. Tôi đặc biệt hứng thú nếu bạn có suy nghĩ hoặc muốn đề xuất các chủ đề cho hướng dẫn trong tương lai. Nếu bạn có câu hỏi hoặc chủ đề đề xuất, xin vui lòng đăng ở bên dưới. Bạn cũng có thể liên hệ trực tiếp với tôi trên Twitter @reifman.

Bắt đầu nào

Cài đặt Codeception

Tôi đã sử dụng tài liệu Yii's Testing Environment Setup - Hướng dẫn cài đặt môi trường test của Yii. Tôi bắt đầu với bản cài đặt toàn cục của codeception để tôi có thể sử dụng nó cho bất kỳ dự án nào.

$ composer global require "codeception/codeception=2.1.*"
Changed current directory to /Users/Jeff/.composer
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
  - Installing symfony/yaml (v3.1.1)
    Loading from cache
...
codeception/codeception suggests installing symfony/phpunit-bridge (For phpunit-bridge support)
Writing lock file
Generating autoload files

Bạn cũng cần có codeception/specify:

$ composer global require "codeception/specify=*"
Changed current directory to /Users/Jeff/.composer
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
composer require "codeception/verify=*"
  - Installing codeception/specify (0.4.3)
    Downloading: 100%         

Writing lock file
Generating autoload files

Và codeception/verify:

$ composer require "codeception/verify=*"
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
  - Installing codeception/verify (0.3.0)                  
    Downloading: 100%         

Writing lock file
Generating autoload files

Tiếp theo, nó giúp thiết lập alias cho codecept bằng cách sử dụng thư mục toàn cục composer:

1	$ composer global status
2	Changed current directory to /Users/Jeff/.composer
3	No local changes

Phần này thiết lập alias:

1	$ alias codecept="/Users/Jeff/.composer/vendor/bin/codecept"

Yii cũng cần cài đặt Faker để tạo dữ liệu giả để test ứng dụng của bạn:

$ composer require --dev yiisoft/yii2-faker:*
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Nothing to install or update                               
Generating autoload files

Thiết lập Codeception với ứng dụng của bạn

Codecept bootstrap khởi tạo codeception cho ứng dụng Yii của bạn. Lệnh này tạo ra một loạt các file cấu hình để xây dựng và chạy test đối với ứng dụng của bạn. Chúng tôi đang sử dụng ứng dụng Hello từ loạt bài này. Xem liên kết GitHub trên trang này để lấy code.

$ codecept bootstrap
 Initializing Codeception in /Users/Jeff/Sites/hello 

File codeception.yml created       <- global configuration
tests/unit created                 <- unit tests
tests/unit.suite.yml written       <- unit tests suite configuration
tests/functional created           <- functional tests
tests/functional.suite.yml written <- functional tests suite configuration
tests/acceptance created           <- acceptance tests
tests/acceptance.suite.yml written <- acceptance tests suite configuration
tests/_output was added to .gitignore
 --- 
tests/_bootstrap.php written <- global bootstrap file
Building initial Tester classes
Building Actor classes for suites: acceptance, functional, unit
 -> AcceptanceTesterActions.php generated successfully. 0 methods added
\AcceptanceTester includes modules: PhpBrowser, \Helper\Acceptance
AcceptanceTester.php created.
 -> FunctionalTesterActions.php generated successfully. 0 methods added
\FunctionalTester includes modules: \Helper\Functional
FunctionalTester.php created.
 -> UnitTesterActions.php generated successfully. 0 methods added
\UnitTester includes modules: Asserts, \Helper\Unit
UnitTester.php created.

Bootstrap is done. Check out /Users/Jeff/Sites/hello/tests directory

Vì vài lý do, tôi cũng đã sao chép các thư mục test trùng lặp trong hello / tests; chỉ cần xóa hello / tests / functional, hello / tests / accept, và hello / tests / unit xóa mọi thứ. Tất cả các bài test đều có trong thư mục hello/tests/codeception/*.

Các loại hình test khác nhau

Codeception tập trung vào ba loại hình test:

Unit testing xác thực các đơn vị cụ thể đang hoạt động, chẳng hạn như test toàn diện tất cả các phương thức trong model của bạn.
Functional testing xác thực các kịch bản ứng dụng phổ biến giống như được thực hiện từ phía người dùng, nhưng bằng cách sử dụng trình mô phỏng trình duyệt web.
Acceptance testing giống y như functional testing nhưng chạy test thông qua trình duyệt web thực sự.

Và Codeception hỗ trợ ba loại hình test khác nhau cho code test của bạn:

Cept: đây là file test cho kịch bản đơn giản nhất
Cest: một định dạng hướng đối tượng để chạy nhiều test trong một file duy nhất
Test: các bài test được viết trên PHPUnit, một framework dùng cho mục đích test của PHP.

Hãy bắt đầu với ví dụ về các acceptance tests có sử dụng cept format (định dạng):

Acceptance Testing

Trước tiên, chúng tôi sẽ sử dụng ví dụ test Welcome của Codeception.

1	$ codecept generate:cept acceptance Welcome
2	Test was created in /Users/Jeff/Sites/hello/tests/acceptance/WelcomeCept.php

Ví dụ này tạo ra các bài tests/acceptance/WelcomeCept.php, mà chúng tôi sẽ chỉnh sửa bên dưới.

Vì các acceptance test cần có trình duyệt, chúng tôi phải chỉnh sửa file /tests/acceptance.suite.yml trong dự án của chúng tôi để cung cấp URL trang chúng tôi đang phát triển, http://localhost:8888/hello:

# Codeception Test Suite Configuration
#
# Suite for acceptance tests.
# Perform tests in browser using the WebDriver or PhpBrowser.
# If you need both WebDriver and PHPBrowser tests - create a separate suite.

class_name: AcceptanceTester
modules:
    enabled:
        - PhpBrowser:
            url: http://localhost:8888/hello/
        - \Helper\Acceptance

Bây giờ, chúng ta đã sẵn sàng để sửa đổi bài test đầu tiên trong các bài tests/acceptance/WelcomeCept.php. Tôi đang viết bài test dùng tải trang font-page để đảm bảo rằng mọi thứ hoạt động theo ý muốn.

Các bài test của Codeception có khái niệm về actor, trong trường hợp này là $I = new AcceptanceTester().

Đây là mô tả về actor trong tài liệu Codeception:

Chúng ta có UnitTester để xử lý các hàm và kiểm tra code. Chúng ta cũng có FunctionalTester, một trình test hội đủ điều kiện để test toàn bộ ứng dụng, với các hiểu biết bên trong của nó. Và AcceptanceTester để dùng làm việc với ứng dụng của chúng tôi thông qua một giao diện do chúng tôi cung cấp.

Bạn có thể nhận xét các bài test của mình bằng code, chẳng hạn như $I->wantTo('perform a certain test') hoặc 'ensure that the frontpage works'.

Trong test của tôi, tôi muốn nội dung $I->see là 'Congratulations' và 'Yii-powered':

<?php
$I = new AcceptanceTester($scenario);
$I->wantTo('ensure that frontpage works');
$I->amOnPage('/');
$I->see('Congratulations!');
$I->see('Yii-powered');

Đây là trang chủ hiện tại của Hello:

Programming with Yii - The Hello Home Page

Tiếp theo, hãy chạy test, đơn giản là codecept run:

1	$ codecept run
2	Codeception PHP Testing Framework v2.1.11
3	Powered by PHPUnit 5.3.5 by Sebastian Bergmann and contributors.
4	Acceptance Tests (1) ---------------------------------------------------------------------------------------
5	Ensure that frontpage works (WelcomeCept) Ok
6	------------------------------------------------------------------------------------------------------------
7	Functional Tests (0) ------------------------
8	---------------------------------------------
9	Unit Tests (0) ------------------------------
10	---------------------------------------------
11	Time: 554 ms, Memory: 10.25MB
12	OK (1 test, 2 assertions)

Như bạn có thể thấy, test của chúng tôi đã vượt qua thành công và code để xác minh chức năng này tương đối dễ đọc và đơn giản.

Ghi chú về các bài test mặc định của Yii

Để tiếp tục, tôi bắt đầu sử dụng các bài test mặc định của Yii. Tại thời điểm này, tôi đã gặp phải một số vấn đề về cấu hình - hầu hết là do tôi sử dụng mô-đun yii2-user tự dựng trong loạt bài này. Những vấn đề khác phát sinh từ các lỗi nhỏ với Yii, đội ngũ Yii đã nhanh chóng phản hồi và sửa lỗi khi nhận báo cáo trên GitHub; trong một số trường hợp, các vấn đề đã được khắc phục trong các phiên bản sau của yii2-basic tree.

Ngoài ra, vì tôi đã cập nhật yii2-basic tree cho loạt bài này nên tôi phải thực hiện một số thay đổi nhỏ cho những bài test mặc định.

Dưới đây là ví dụ kết quả để chạy acceptance test mặc định khi tôi đã thực hiện một số điều chỉnh nhỏ:

1	$ codecept run
2	Codeception PHP Testing Framework v2.1.11
3	Powered by PHPUnit 5.3.5 by Sebastian Bergmann and contributors.
4
5	Acceptance Tests (4) -------------------------------------------------------------------------------------------------
6	Ensure that about works (AboutCept) Ok
7	Ensure that contact works (ContactCept) Ok
8	Ensure that home page works (HomeCept) Ok
9	Ensure that login works (LoginCept) Ok
10	----------------------------------------------------------------------------------------------------------------------

Functional Testing

Để test chức năng hoạt động, tôi cần chạy một đối tượng máy chủ tích hợp sẵn của Yii. Tôi đã không biết về thành phần này cho đến khi Alex Markov của Yii đề cập đến nó trong cuộc trao đổi GitHub của chúng tôi.

1	$ ./yii serve

Tôi đã thực hiện các thay đổi nhỏ cho các bài functional test trong /tests/codeception/functional, chủ yếu để tìm các chuỗi văn bản cụ thể đã được cập nhật, ví dụ như "mật khẩu hoặc đăng nhập lỗi" thay cho mặc định của Yii. Cùng xem lại LoginCept.php:

<?php
use tests\codeception\_pages\LoginPage;
$I = new FunctionalTester($scenario);

$I->wantTo('ensure that login works');

$loginPage = LoginPage::openBy($I);
$I->see('Login');
$I->amGoingTo('try to login with empty credentials');
$loginPage->login('', '');
$I->expectTo('see validations errors');
$I->see('Login cannot be blank.');
$I->see('Password cannot be blank.');

$I->amGoingTo('try to login with wrong credentials');
$loginPage->login('admin', 'wrong');
$I->expectTo('see validations errors');
$I->see('Invalid login or password');

$I->amGoingTo('try to login with correct credentials');
$loginPage->login('admin', 'admin11');
$I->expectTo('see user info');
$I->see('Logout');

Về cơ bản, code truy xuất vào model LoginForm và test các phương thức khác nhau của model này bằng cách sử dụng Yii serve.

Đây là code test /tests/codeception_pages/LoginPage.php mà nó đang tận dụng (tôi cũng phải sửa đổi nó cho những thay đổi mà chúng tôi đã thực hiện cho loạt bài này):

class LoginPage extends BasePage
{
    public $route = 'user/login';

    /**
     * @param string $username
     * @param string $password
     */
    public function login($username, $password)
    {
        $this->actor->fillField('input[name="login-form[login]"]', $username);
        $this->actor->fillField('input[name="login-form[password]"]', $password);
        $this->actor->click('button[type=submit]');
    }
}

Bạn có thể thấy rằng chúng tôi đang code actor thành fillFields và các nút click cho các trường biểu mẫu đã cập nhật.

Trong lúc khắc phục sự cố gặp phải khi tích hợp Codeception với Yii, tôi thấy thật hữu ích khi chạy các test này ở chế độ verbose:

1	$ codecept run -vvv

Đây là kết quả verbose từ các bài functional test chức năng đăng nhập — trong Terminal của MacOS, PASSED và FAILED có màu đỏ hoặc hồng và bị đảo ngược để hiển thị:

Functional Tests (4) -------------------------------------------------------------------------------------------------
Modules: Filesystem, Yii2
...
----------------------------------------------------------------------------------------------------------------------
Ensure that login works (LoginCept)
Scenario:
* I am on page "/index-test.php/user/login"

  [Page] /index-test.php/user/login
  [Response] 200
  [Request Cookies] []
  [Response Headers] {"content-type":["text/html; charset=UTF-8"]}
* I see "Login"
* I am going to try to login with empty credentials
* I fill field "input[name="login-form[login]"]",""
* I fill field "input[name="login-form[password]"]",""
* I click "button[type=submit]"
  [Uri] http://localhost/index-test.php/user/login
  [Method] POST
  [Parameters] {"_csrf":"VEpvcmk3bVgFH1Y9AVsmYWQQDEouTSggYXMFGStdKBEnCyQfBxo8Bw==","login-form[login]":"","login-form[password]":""}
  [Page] http://localhost/index-test.php/user/login
  [Response] 200
  [Request Cookies] {"_csrf":"dd395a9e5e3c08cfb1615dae5fc7b5ba0a2025c003e430ba0139b300f4a917ada:2:{i:0;s:5:"_csrf";i:1;s:32:"QU9OhlK90Zc8GzEx59jkBjEIsAKmn-Q_";}"}
  [Response Headers] {"content-type":["text/html; charset=UTF-8"]}
* I expect to see validations errors
* I see "Login cannot be blank."
* I see "Password cannot be blank."
* I am going to try to login with wrong credentials
* I fill field "input[name="login-form[login]"]","admin"
* I fill field "input[name="login-form[password]"]","wrong"
* I click "button[type=submit]"
  [Uri] http://localhost/index-test.php/user/login
  [Method] POST
  [Parameters] {"_csrf":"QjFBRl9hMjMTZHgJNw15CnJrIn4YG3dLdwgrLR0Ld3oxcAorMUxjbA==","login-form[login]":"admin","login-form[password]":"wrong"}
  [Page] http://localhost/index-test.php/user/login
  [Response] 200
  [Request Cookies] {"_csrf":"dd395a9e5e3c08cfb1615dae5fc7b5ba0a2025c003e430ba0139b300f4a917ada:2:{i:0;s:5:"_csrf";i:1;s:32:"QU9OhlK90Zc8GzEx59jkBjEIsAKmn-Q_";}"}
  [Response Headers] {"content-type":["text/html; charset=UTF-8"]}
* I expect to see validations errors
* I see "Invalid login or password"
* I am going to try to login with correct credentials
* I fill field "input[name="login-form[login]"]","admin"
* I fill field "input[name="login-form[password]"]","admin11"
* I click "button[type=submit]"
  [Uri] http://localhost/index-test.php/user/login
  [Method] POST
  [Parameters] {"_csrf":"bG8uMXdPYk49Ohd.HyMpd1w1TQkwNSc2WVZEWjUlJwcfLmVcGWIzEQ==","login-form[login]":"admin","login-form[password]":"admin11"}
  [Headers] {"location":["http://localhost/index-test.php"],"content-type":["text/html; charset=UTF-8"]}
  [Page] http://localhost/index-test.php/user/login
  [Response] 302
  [Request Cookies] {"_csrf":"dd395a9e5e3c08cfb1615dae5fc7b5ba0a2025c003e430ba0139b300f4a917ada:2:{i:0;s:5:"_csrf";i:1;s:32:"QU9OhlK90Zc8GzEx59jkBjEIsAKmn-Q_";}"}
  [Response Headers] {"location":["http://localhost/index-test.php"],"content-type":["text/html; charset=UTF-8"]}
  [Redirecting to] http://localhost/index-test.php
  [Page] http://localhost/index-test.php
  [Response] 200
  [Request Cookies] {"_csrf":"dd395a9e5e3c08cfb1615dae5fc7b5ba0a2025c003e430ba0139b300f4a917ada:2:{i:0;s:5:"_csrf";i:1;s:32:"QU9OhlK90Zc8GzEx59jkBjEIsAKmn-Q_";}"}
  [Response Headers] {"content-type":["text/html; charset=UTF-8"]}
* I expect to see user info
* I see "Logout"
 PASSED 

Nói chung, cần phải học để bắt đầu với Codeception và code đúng cho test của bạn. Nhưng kết quả thật ấn tượng và hữu dụng.

Unit Testing

Về cơ bản, unit test là test có lập trình của các model của chúng tôi. Lý tưởng nhất, chúng tôi sẽ viết test cho mọi phương thức và biến thể sử dụng của model của chúng tôi.

Thật không may, tôi đã không thể khiến unit test làm việc trong tree của chúng tôi vì một trong hai lỗi nhỏ của Yii chưa được công bố hoặc các vấn đề cấu hình giữa Codeception và yii2-user mà chúng tôi tích hợp trong How to Program With Yii2: Integrating User Registration.

1	Unit Tests (3) ----------------------------------------------------------------------------------------------------
2	Modules:
3	-------------------------------------------------------------------------------------------------------------------
4	Trying to test login no user (tests\codeception\unit\models\LoginFormTest::testLoginNoUser)...
5	<pre>PHP Fatal Error 'yii\base\ErrorException' with message 'Call to undefined function
6	tests\codeception\unit\models\expect()'

Tôi sẽ giải quyết vấn đề unit test một lần nữa trong loạt bài Startup của chúng tôi, ở đó không sử dụng yii2-user mà thay vào đó sử dụng tích hợp người dùng tích hợp sẵn của cây Nâng cao Yii.

Hãy xem xét một vài ví dụ từ Yii2-app-basic tree.

Kiểm tra Email biểu mẫu liên hệ

Các bài test hello/tests/codeception/unit/models/ContactFormTest.php gửi email thông qua việc lập trình của các model.

<?php

namespace tests\codeception\unit\models;

use Yii;
use yii\codeception\TestCase;
use Codeception\Specify;

class ContactFormTest extends TestCase
{
    use Specify;

    protected function setUp()
    {
        parent::setUp();
        Yii::$app->mailer->fileTransportCallback = function ($mailer, $message) {
            return 'testing_message.eml';
        };
    }

    protected function tearDown()
    {
        unlink($this->getMessageFile());
        parent::tearDown();
    }

    public function testContact()
    {
        $model = $this->createMock('app\models\ContactForm', ['validate']);
        $model->expects($this->once())->method('validate')->will($this->returnValue(true));

        $model->attributes = [
            'name' => 'Tester',
            'email' => 'tester@example.com',
            'subject' => 'very important letter subject',
            'body' => 'body of current message',
        ];

        $model->contact('admin@example.com');
        
        $this->specify('email should be send', function () {
            expect('email file should exist', file_exists($this->getMessageFile()))->true();
        });

        $this->specify('message should contain correct data', function () use ($model) {
            $emailMessage = file_get_contents($this->getMessageFile());

            expect('email should contain user name', $emailMessage)->contains($model->name);
            expect('email should contain sender email', $emailMessage)->contains($model->email);
            expect('email should contain subject', $emailMessage)->contains($model->subject);
            expect('email should contain body', $emailMessage)->contains($model->body);
        });
    }

    private function getMessageFile()
    {
        return Yii::getAlias(Yii::$app->mailer->fileTransportPath) . '/testing_message.eml';
    }

}

Tôi đã không vượt qua bài test này vì có một lỗi nhỏ trong Yii chưa được cập nhật (hoặc ít nhất tôi không thể tìm thấy code cập nhật). Sự sụt giảm của Yii codebase đã đặt tên cho email gửi đi với date stamp và code ở trên tìm kiếm một tên file cố định. Do đó, test này luôn thất bại. Tuy nhiên, thật hữu ích khi nhìn thấy cách bài test bằng lập trình có thể sử dụng các model để tạo ra một file và sau đó tìm file đó và xác thực nội dung của file để xác nhận rằng code đó đang hoạt động.

Kiểm tra Đăng nhập

Hãy xem file hello/tests/codeception/unit/models/LoginFormTest.php. Thêm một lần nữa, việc sử dụng yii2-user của tôi gây khó khăn khi tích hợp tại thời điểm viết hướng dẫn này; tuy nhiên, chúng ta có thể xem xét cách tiếp cận khái niệm đối với các hàm unit testing của model user.

Đây là hàm testLoginCorrect(), có vẻ để xem liệu đăng nhập có thành công với mật khẩu chính xác hay không:

public function testLoginCorrect()
    {
        $model = new LoginForm([
            'username' => 'admin',
            'password' => 'admin11',
        ]);

        $this->specify('user should be able to login with correct credentials', function () use ($model) {
            expect('model should login user', $model->login())->true();
            expect('error message should not be set', $model->errors)->hasntKey('password');
            expect('user should be logged in', Yii::$app->user->isGuest)->false();
        });
    }

Hàm này sử dụng model LoginForm để đăng nhập bằng lập trình cho người dùng, và sau đó nó lập trình trông để xem liệu người dùng hiện tại của Yii bây giờ không còn là khách nữa không.

1	expect('user should be logged in', Yii::$app->user->isGuest)->false();

Tiếp theo là gì?

Tôi hy vọng rằng bạn thích học về Codeception và cách nó tích hợp với Yii, dù tôi đã gặp phải một số rào cản. Phần cài đặt mặc định của yii2-basic giờ đã tốt hơn.

Nếu bạn muốn đọc thêm về chủ đề khi nào và cái gì cần test và lý do tại sao, tôi đề nghị bạn nên đọc bài Yii's Testing Overview. Chắc chắn sẽ có nhiều về Codeception để học và viết nhiều test hoàn thiện hơn.

Theo dõi các hướng dẫn sắp tới trong loạt bài Programming with Yii2 khi chúng tôi tiếp tục đào sâu vào các khía cạnh khác nhau của framework. Nếu bạn muốn biết khi nào hướng dẫn tiếp theo của Yii2 đến, hãy theo dõi tôi @reifman trên Twitter hoặc xem qua trang hướng dẫn của tôi.

Bạn cũng có thể muốn xem loạt bài Building Your Startup with PHP của tôi, ở đó sử dụng các template nâng cao của Yii2 khi chúng tôi xây dựng một ứng dụng thực tế. Trong thực tế, bạn có thể thử ứng dụng startup, Meeting Planner ngay hôm nay.

Liên kết liên quan

Codeception
Yii2 Developer Exchange, my Yii2 resource site
Yii2 Testing Environment Setup