Hướng dẫn phpunit mock function return value - giá trị trả về của hàm giả lập phpunit

Một trong những điều khó khăn nhất về thử nghiệm đơn vị là cô lập thành phần bạn muốn kiểm tra. Để làm điều này, bạn phải tạo một thế giới ảo cho thành phần của mình tồn tại bên trong - như ma trận với các xác nhận. Và làm thế nào để chúng ta tạo ra kỳ quan khoa học viễn tưởng này? Câu trả lời nằm ở các đối tượng giả phpunit (còn được gọi là cuống hoặc nhân đôi thử nghiệm). Trước khi tôi nhận được chi tiết, ở đây, một câu chuyện cảnh báo về thử nghiệm chống lại sự phụ thuộc thực sự:

Một nhà phát triển đã từng được giao nhiệm vụ tạo ra một hệ thống để quản lý các nhiệm vụ tiếp thị khác nhau cho chủ nhân của mình - một ngân hàng lớn. Hệ thống này được thiết kế để gửi các chiến dịch bưu chính, quảng cáo SMS, bản tin và những thứ tương tự. Một lập trình viên giỏi, anh ta đã bắt gặp lỗi thử nghiệm, và tất cả đều ở trên tàu để đưa ra bộ thử nghiệm đơn vị hệ thống. Vì vậy, ông đặt người quản lý sự kiện chính thông qua các bước đi của nó. Ông đã tạo ra một số hồ sơ dựa trên các nhóm khách hàng khác nhau mà bộ phận nhắm mục tiêu - học sinh, học sinh đói, công chức, chuyên nghiệp trẻ, v.v. Ông đã viết một bài kiểm tra đã chuyển chúng theo phương pháp chính của thành phần sự kiện

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

2 sau đó đã kiểm tra kết quả. Anh ấy đã chạy bài kiểm tra vào tối thứ Tư. Tất cả đã diễn ra tốt đẹp, dường như.

Đó là cho đến giữa ngày thứ Sáu, anh ấy đã biết về sự cấu hình sai của cỗ máy phát triển của mình. Thử nghiệm của anh đã tương tác với các hệ thống trực tiếp. Nó được gọi là một thành phần đã hợp nhất một thư tiếp thị với dữ liệu thử nghiệm, sau đó được in các chữ cái được cấp cho đơn đặt hàng để chúng được đẩy ra hệ thống bưu chính. Vào sáng thứ Sáu, hai ngàn khách hàng có giá trị nhất của ngân hàng đã mở một lá thư bắt đầu từ“Dear Rich Bastard”…

Mọi thứ không phải là kịch tính như vậy - nhưng câu chuyện không minh họa một điểm quan trọng. Càng xa càng tốt, một bài kiểm tra đơn vị nên tập trung vào một thành phần duy nhất. Mã khác nên được giữ ở mức tối thiểu. Trong bài đăng này, tôi sẽ chạy qua một số cách mà chúng ta có thể tạo ra các đối tượng giả phpunit có thể được cấu hình để đánh lừa một thành phần để tin rằng chúng là thực tế.

Một lớp học để kiểm tra và người ngoài cuộc

Hãy bắt đầu với một lớp có tên

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class Context
{
    function perform($input)
    {
        // work with databases and services
        // and complicated stuff you don't want to run
        // in a test
        return $input;
    }
}

Như bạn có thể thấy,

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

Boilerplate PHPUNIT

Dưới đây là lớp kiểm tra đơn vị mà tôi sẽ sử dụng cho ví dụ này:

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

Phpunit sẽ chạy phương pháp TestMock cho tôi. Tôi sẽ kiểm tra xem trên dòng lệnh:

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

Tạo các đối tượng giả phpunit trả về một giá trị duy nhất

Hãy nhớ rằng nó là lớp

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

$mockcontext = $this->createMock(Context::class);

Bây giờ tôi có một đối tượng

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

$mockcontext->method("perform")->willReturn(5);

Phương pháp

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

Thời gian để xem nó có hoạt động không:

$mycommand = new MyCommand();
        $testval = $mycommand->execute($mockcontext);
        self::assertEquals(10, $testval);

Bởi vì

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

Trả về các giá trị khác nhau cho nhiều cuộc gọi

Ví dụ trước là tốt nếu tôi muốn cùng một giá trị được trả về mỗi khi

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$mockcontext = $this->createMock(Context::class);
        $mockcontext->method("perform")->will(
            $this->onConsecutiveCalls(2, 4, 6)
        );

Một cấu trúc hơi khác nhau cho cấu hình. Phương thức

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

Đây là các bài kiểm tra của tôi:

$testval = $mycommand->execute($mockcontext);
        self::assertEquals(7, $testval);
        $testval = $mycommand->execute($mockcontext);
        self::assertEquals(9, $testval);
        $testval = $mycommand->execute($mockcontext);
        self::assertEquals(11, $testval);

Nếu

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

Tạo phương pháp đối tượng sơ khai, ném một ngoại lệ

Cũng như hoạt động thử nghiệm, chúng ta thường cần kiểm tra khả năng của các thành phần để xử lý các điều kiện lỗi. Tại đây, cách bạn có thể tạo một đối tượng sơ khai ném một ngoại lệ thay vì trả về một giá trị:

$mockcontext = $this->createMock(Context::class);
        $mockcontext->method("perform")->will(
            $this->throwException(new \Exception())
        );
        $testval = $mycommand->execute($mockcontext);
        self::assertEquals(-1, $testval);

Hãy nhớ rằng nếu

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

Ánh xạ đối số để trả về các giá trị trong các đối tượng giả phpunit

Nếu bạn cần làm cho các đối tượng giả PHPunit của bạn trả về một giá trị cụ thể dựa trên một đối số (hoặc một tập hợp các đối số) thì bạn có thể sử dụng

$mockcontext = $this->createMock(Context::class);

$mockcontext = $this->createMock(Context::class);

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

Vì vậy, trong ví dụ này, đưa ra một đối số của

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$mockcontext->method("perform")->willReturn(5);

Sử dụng các cuộc gọi lại để quản lý logic phức tạp hơn

Mặc dù PHPUNIT cung cấp rất nhiều phương thức thuận tiện để trả về các giá trị từ các đối tượng giả, đôi khi bạn sẽ cần phải đi theo con đường tùy chỉnh. Nếu bạn cần kiểm soát nhiều hơn, bạn có thể chuyển cuộc gọi lại cho

$mockcontext->method("perform")->willReturn(5);

class MyCommand
{
    function execute(Context $context, $input = 0)
    {
        // do stuff
        try {
            $importantvalue = $context->perform($input);
            // and more stuff with $importantvalue
            return ($importantvalue + 5);
        } catch (\Exception $e) {
            return -1;
        }

    }
}

Điều này cho phép tôi làm cho phương pháp giả của tôi

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

$mockcontext->method("perform")->willReturn(5);

$mockcontext->method("perform")->willReturn(5);

$ phpunit test/MyCommandTest.php 

PHPUnit 5.5.4 by Sebastian Bergmann and contributors.

.                                                                   1 / 1 (100%)

Time: 271 ms, Memory: 2.75MB

OK (1 test, 0 assertions)

$mockcontext->method("perform")->willReturn(5);

class MyCommandTest extends \PHPUnit_Framework_TestCase
{
    function testMock()
    {
        // code goes here
    }
}

$mockcontext->method("perform")->willReturn(5);

Tất nhiên, có nhiều hơn nữa để thử nghiệm với các đối tượng giả phpunit, nhưng vì tôi phải xem xét giá trị trở lại này mỗi tháng hoặc lâu hơn, tôi nghĩ rằng tôi đã để nó ở đây để sử dụng. Tôi sẽ trở lại chủ đề trong các bài viết sau.

Hình ảnh: _ mô hình của người Hồi giáo - William Warby - Giấy phép CC bằng 2.0_
“Models” – William Warby – license
CC BY 2.0_