PHPUnit assert that an exception was thrown

Question

Does anyone know whether there is an assert or something like that which can test whether an exception was thrown in the code being tested

User · Answer

Here s all the exception assertions you can do   Note that all of them are optional   class ExceptionTest extends PHPUnit Framework TestCase       public function testException                    make your exception assertions          this- gt expectException InvalidArgumentException  class              if you use namespaces              this- gt expectException   Namespace MyExceptio  n             this- gt expectExceptionMessage  message             this- gt expectExceptionMessageRegExp   essage               this- gt expectExceptionCode 123              code that throws an exception         throw new InvalidArgumentException  message   123            public function testAnotherException                   repeat as needed          this- gt expectException Exception  class           throw new Exception  Oh no               Documentation can be found here

User · Answer

If you re running on PHP 5 5   you can use   class resolution to obtain the name of the class with expectException setExpectedException  This provides several benefits    The name will be fully-qualified with its namespace  if any   It resolves to a string so it will work with any version of PHPUnit  You get code-completion in your IDE  The PHP compiler will emit an error if you mistype the class name    Example   namespace  My Cool Package   class AuthTest extends  PHPUnit Framework TestCase       public function testLoginFailsForWrongPassword                  this- gt expectException WrongPasswordException  class           Auth  login  Bob    wrong              PHP compiles  WrongPasswordException  class   into    My Cool Package WrongPasswordException    without PHPUnit being the wiser      Note  PHPUnit 5 2 introduced expectException as a replacement for setExpectedException

User · Answer

Comprehensive Solution  PHPUnit s current  best practices  for exception testing seem   lackluster  docs    Since I wanted more than the current expectException implementation  I made a trait to use on my test cases  It s only  50 lines of code    Supports multiple exceptions per test Supports assertions called after the exception is thrown Robust and clear usage examples Standard assert syntax Supports assertions for more than just message  code  and class Supports inverse assertion  assertNotThrows Supports PHP 7 Throwable errors   Library  I published the AssertThrows trait to Github and packagist so it can be installed with composer   Simple Example  Just to illustrate the spirit behind the syntax    lt  php     Using simple callback  this- gt assertThrows MyException  class    obj   doSomethingBad         Using anonymous function  this- gt assertThrows MyException  class  function   use   obj         obj- gt doSomethingBad          Pretty neat     Full Usage Example  Please see below for a more comprehensive usage example    lt  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      lt --- adds the assertThrows method      public function testMyObject                  obj   new MyObject                Test a basic exception is thrown          this- gt assertThrows MyException  class  function   use   obj                 obj- gt doSomethingBad                            Test custom aspects of a custom extension class          this- gt assertThrows MyException  class               function   use   obj                     obj- gt doSomethingBad                               function  exception                     this- gt assertEquals  Expected value    exception- gt getCustomThing                      this- gt assertEquals 123   exception- gt getCode                                          Test that a specific exception is NOT thrown          this- gt assertNotThrows MyException  class  function   use   obj                 obj- gt doSomethingGood                           gt

User · Answer

function yourfunction  a  z      if  a lt  z   throw new  lt YOUR EXCEPTION gt         here is the test   class FunctionTest extends  PHPUnit Framework TestCase      public function testException            this- gt setExpectedException  lt YOUR EXCEPTION gt   class         yourfunction 1 2    add vars that cause the exception

User · Answer

You can also use a docblock annotation until PHPUnit 9 is released   class ExceptionTest extends PHPUnit Framework TestCase                   expectedException InvalidArgumentException             public function testException                               For PHP 5 5   especially with namespaced code   I now prefer using   class

User · Answer

Code below will test exception message and exception code    Important  It will fail if expected exception not thrown too   try       test- gt methodWhichWillThrowException     if this method not throw exception it must be fail too       this- gt fail  Expected exception 1162011 not thrown     catch MySpecificException  e     Not catching a generic Exception or the fail function is also catched      this- gt assertEquals 1162011   e- gt getCode          this- gt assertEquals  Exception Message    e- gt getMessage

User · Answer

An alternative way can be the following    this- gt expectException  InvalidArgumentException  class    this- gt expectExceptionMessage  Expected Exception Message      Please ensure that your test class extents  PHPUnit Framework TestCase

User · Answer

For PHPUnit 5 7 27 and PHP 5 6 and to test multiple exceptions in one test  it was important to force the exception testing  Using exception handling alone to assert the instance of Exception will skip testing the situation if no exception occurs   public function testSomeFunction           e null       targetClassObj  new TargetClass        try            targetClassObj- gt doSomething          catch    Exception  e                this- gt assertInstanceOf  Exception  class  e        this- gt assertEquals  Some message   e- gt getMessage           e null      try            targetClassObj- gt doSomethingElse          catch   Exception  e                this- gt assertInstanceOf  Exception  class  e        this- gt assertEquals  Another message   e- gt getMessage

User · Answer

You can use assertException extension to assert more than one exception during one test execution   Insert method into your TestCase and use   public function testSomething          test   function                some code that has to throw an exception             this- gt assertException   test   InvalidArgumentException   100   expected message         I also made a trait for lovers of nice code

User · Answer

The PHPUnit expectException method is very inconvenient because it allows to test only one exception per a test method   I ve made this helper function to assert that some function throws an exception          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- gt assertInstanceOf  expectClass   exception   An invalid exception was thrown            return              this- gt fail  No exception was thrown        Add it to your test class and call this way   public function testSomething          this- gt assertException  PDOException  class  function             new  PDO  bad param                 this- gt assertException  PDOException  class  function             new  PDO  foo bar

User · Answer

lt  php require once  PHPUnit Framework php    class ExceptionTest extends PHPUnit Framework TestCase       public function testException                  this- gt expectException InvalidArgumentException  class              or for PHPUnit  lt  5 2             this- gt setExpectedException InvalidArgumentException  class                 and then add your test code that generates the exception          exampleMethod  anInvalidArgument             expectException   PHPUnit documentation  PHPUnit author article provides detailed explanation on testing exceptions best practices

User · Answer

expectedException Exception     expectedExceptionMessage Amount has to be bigger then 0      public function testDepositNegative          this- gt account- gt deposit -7       Be very carefull about     42   42    notice the double    42    Writing only    42   42   asterix  will fail your code  Also make sure your using last version of phpUnit  In some earlier versions of phpunit  expectedException Exception is not supported  I had 4 0 and it didn t work for me  I had to update to 5 5 https   coderwall com p mklvdw install-phpunit-with-composer to update with composer

User · Answer

public function testException         try            this- gt methodThatThrowsException             this- gt fail  Expected Exception has not been raised           catch  Exception  ex             this- gt assertEquals  ex- gt getMessage     Exception message

User · Answer

PhpUnit is an amazing library  but this specific point is a bit frustrating  This is why we can use the turbotesting-php opensource library which has a very convenient assertion method to help us testing exceptions  It is found here   https   github com edertone TurboTesting blob master TurboTesting-Php src main php utils AssertUtils php  And to use it  we would simply do the following   AssertUtils  throwsException function            Some code that must throw an exception here       expected error message       If the code we type inside the anonymous function does not throw an exception  an exception will be thrown   If the code we type inside the anonymous function throws an exception  but its message does not match the expected regexp  an exception will also be thrown

[php] PHPUnit assert that an exception was thrown?

Examples related to php

Examples related to exception

Examples related to phpunit

Examples related to assert