PHPUnit утверждать, что было сгенерировано исключение? - PullRequest
276 голосов
/ 16 апреля 2011

Кто-нибудь знает, существует ли assert или что-то подобное, что может проверить, было ли выброшено исключение в тестируемом коде?

Ответы [ 12 ]

469 голосов
/ 16 апреля 2011
<?php
require_once 'PHPUnit/Framework.php';

class ExceptionTest extends PHPUnit_Framework_TestCase
{
    public function testException()
    {
        $this->expectException(InvalidArgumentException::class);
        // or for PHPUnit < 5.2
        // $this->setExpectedException(InvalidArgumentException::class);

        //...and then add your test code that generates the exception 
        exampleMethod($anInvalidArgument);
    }
}

Ожидаем исключения () Документация PHPUnit

Статья автора PHPUnit содержит подробное объяснение передовых методов тестирования исключений.

114 голосов
/ 16 апреля 2011

Вы также можете использовать аннотацию docblock :

class ExceptionTest extends PHPUnit_Framework_TestCase
{
    /**
     * @expectedException InvalidArgumentException
     */
    public function testException()
    {
        ...
    }
}

Для PHP 5.5+ (особенно для кода с пространством имен), теперь я предпочитаю использовать ::class

33 голосов
/ 13 февраля 2016

Если вы работаете на PHP 5.5+, вы можете использовать ::class разрешение , чтобы получить имя класса с expectException / setExpectedException. Это дает несколько преимуществ:

  • Имя будет полностью определено с его пространством имен (если есть).
  • Он разрешается до string, поэтому он будет работать с любой версией PHPUnit.
  • Вы получаете завершение кода в вашей IDE.
  • PHP-компилятор выдаст сообщение об ошибке, если вы неправильно наберете имя класса.

Пример: * * один тысяча двадцать-одна

namespace \My\Cool\Package;

class AuthTest extends \PHPUnit_Framework_TestCase
{
    public function testLoginFailsForWrongPassword()
    {
        $this->expectException(WrongPasswordException::class);
        Auth::login('Bob', 'wrong');
    }
}

PHP компилирует

WrongPasswordException::class

в

"\My\Cool\Package\WrongPasswordException"

без PHPUnit быть мудрее.

Примечание : В PHPUnit 5.2 введена expectException в качестве замены setExpectedException.

27 голосов
/ 27 февраля 2014

Код ниже будет проверять сообщение об исключении и код исключения.

Важное замечание: Сбой произойдет, если не возникнет ожидаемое исключение.

try{
    $test->methodWhichWillThrowException();//if this method not throw exception it must be fail too.
    $this->fail("Expected exception 1162011 not thrown");
}catch(MySpecificException $e){ //Not catching a generic Exception or the fail function is also catched
    $this->assertEquals(1162011, $e->getCode());
    $this->assertEquals("Exception Message", $e->getMessage());
}
23 голосов
/ 30 апреля 2014

Вы можете использовать расширение assertException , чтобы утверждать более одного исключения во время одного выполнения теста.

Вставьте метод в ваш TestCase и используйте:

public function testSomething()
{
    $test = function() {
        // some code that has to throw an exception
    };
    $this->assertException( $test, 'InvalidArgumentException', 100, 'expected message' );
}

Я также сделал черту для любителей хорошего кода ..

13 голосов
/ 29 марта 2017

Альтернативным способом может быть следующее:

$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Expected Exception Message');

Пожалуйста, убедитесь, что ваш тестовый класс расширяется \PHPUnit_Framework_TestCase.

9 голосов
/ 26 января 2016
public function testException() {
    try {
        $this->methodThatThrowsException();
        $this->fail("Expected Exception has not been raised.");
    } catch (Exception $ex) {
        $this->assertEquals($ex->getMessage(), "Exception message");
    }

}
7 голосов
/ 06 апреля 2018

Комплексное решение

Текущий PHPUnit " лучшие практики " для тестирования исключений кажутся .. тусклыми ( документы ).

Поскольку я хотел больше , чем текущая реализация expectException, я использовал эту черту в своих тестовых примерах. Это всего лишь ~ 50 строк кода .

  • Поддерживает несколько исключений для теста
  • Поддерживает утверждения, вызываемые после возникновения исключения
  • Надежные и понятные примеры использования
  • Стандартный assert синтаксис
  • Поддерживает утверждения не только для сообщения, кода и класса
  • Поддерживает обратное утверждение, assertNotThrows
  • Поддержка PHP 7 Throwable Ошибки

Библиотека

Я опубликовал черту AssertThrows для Github и packagist , чтобы ее можно было установить с помощью composer.

Простой пример

Просто чтобы проиллюстрировать дух синтаксиса:

<?php

// Using simple callback
$this->assertThrows(MyException::class, [$obj, 'doSomethingBad']);

// Using anonymous function
$this->assertThrows(MyException::class, function() use ($obj) {
    $obj->doSomethingBad();
});

Довольно аккуратно?


Пример полного использования

Более подробный пример использования см. Ниже:

<?php

declare(strict_types=1);

use Jchook\AssertThrows\AssertThrows;
use PHPUnit\Framework\TestCase;

// These are just for illustration
use MyNamespace\MyException;
use MyNamespace\MyObject;

final class MyTest extends TestCase
{
    use AssertThrows; // <--- adds the assertThrows method

    public function testMyObject()
    {
        $obj = new MyObject();

        // Test a basic exception is thrown
        $this->assertThrows(MyException::class, function() use ($obj) {
            $obj->doSomethingBad();
        });

        // Test custom aspects of a custom extension class
        $this->assertThrows(MyException::class, 
            function() use ($obj) {
                $obj->doSomethingBad();
            },
            function($exception) {
                $this->assertEquals('Expected value', $exception->getCustomThing());
                $this->assertEquals(123, $exception->getCode());
            }
        );

        // Test that a specific exception is NOT thrown
        $this->assertNotThrows(MyException::class, function() use ($obj) {
            $obj->doSomethingGood();
        });
    }
}

?>
6 голосов
/ 27 октября 2017

Метод PHPUnit expectException очень неудобен, поскольку он позволяет тестировать только одно исключение на метод тестирования.

Я сделал эту вспомогательную функцию, чтобы утверждать, что какая-то функция выдает исключение:

/**
 * Asserts that the given callback throws the given exception.
 *
 * @param string $expectClass The name of the expected exception class
 * @param callable $callback A callback which should throw the exception
 */
protected function assertException(string $expectClass, callable $callback)
{
    try {
        $callback();
    } catch (\Throwable $exception) {
        $this->assertInstanceOf($expectClass, $exception, 'An invalid exception was thrown');
        return;
    }

    $this->fail('No exception was thrown');
}

Добавьте его в свой тестовый класс и назовите так:

public function testSomething() {
    $this->assertException(\PDOException::class, function() {
        new \PDO('bad:param');
    });
    $this->assertException(\PDOException::class, function() {
        new \PDO('foo:bar');
    });
}
4 голосов
/ 04 мая 2017

Вот все исключения, которые вы можете сделать.Обратите внимание, что все они необязательны .

class ExceptionTest extends PHPUnit_Framework_TestCase
{
    public function testException()
    {
        // make your exception assertions
        $this->expectException(InvalidArgumentException::class);
        // if you use namespaces:
        // $this->expectException('\Namespace\MyExceptio‌​n');
        $this->expectExceptionMessage('message');
        $this->expectExceptionMessageRegExp('/essage$/');
        $this->expectExceptionCode(123);
        // code that throws an exception
        throw new InvalidArgumentException('message', 123);
   }

   public function testAnotherException()
   {
        // repeat as needed
        $this->expectException(Exception::class);
        throw new Exception('Oh no!');
    }
}

Документация может быть найдена здесь .

...