tests/PHPUnit/Framework/ComparisonFailure/Object.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Jan Borsodi <jb@ez.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.0.0
  46  */
  47
  48 require_once 'PHPUnit/Framework.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * Thrown when an assertion for object equality failed.
  55  *
  56  * @category   Testing
  57  * @package    PHPUnit
  58  * @author     Jan Borsodi <jb@ez.no>
  59  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.0.0
  65  */
  66 class PHPUnit_Framework_ComparisonFailure_Object extends PHPUnit_Framework_ComparisonFailure
  67 {
  68     /**
  69      * Returns a string describing the difference between the expected and the
  70      * actual object.
  71      *
  72      * @return string
  73      */
  74     public function toString()
  75     {
  76         if ($this->hasDiff()) {
  77             $diff = $this->diff(
  78               print_r($this->expected, TRUE), print_r($this->actual, TRUE)
  79             );
  80
  81             if (!empty($diff)) {
  82                 return $diff;
  83             }
  84         }
  85
  86         // Fallback: Either diff is not available or the print_r() output for
  87         // the expected and the actual object are equal (but the objects are not).
  88
  89         $expectedClass = get_class($this->expected);
  90         $actualClass   = get_class($this->actual);
  91
  92         if ($expectedClass !== $actualClass) {
  93             return sprintf(
  94               "%s%sexpected class <%s>\n" .
  95               '%sgot class      <%s>',
  96
  97               $this->message,
  98               ($this->message != '') ? ' ' : '',
  99               $expectedClass,
 100               ($this->message != '') ? str_repeat(' ', strlen($this->message) + 1) : '',
 101               $actualClass
 102             );
 103         } else {
 104             $expectedReflection = new ReflectionClass($expectedClass);
 105             $actualReflection   = new ReflectionClass($actualClass);
 106
 107             $diff = "in object of class <{$expectedClass}>:\n";
 108             $i    = 0;
 109
 110             foreach($expectedReflection->getProperties() as $expectedAttribute) {
 111                 if ($expectedAttribute->isPrivate() || $expectedAttribute->isProtected()) continue;
 112
 113                 $actualAttribute = $actualReflection->getProperty($expectedAttribute->getName());
 114                 $expectedValue  = $expectedAttribute->getValue($this->expected);
 115                 $actualValue    = $actualAttribute->getValue($this->actual);
 116
 117                 if ($expectedValue !== $actualValue) {
 118                     if ($i > 0) {
 119                         $diff .= "\n";
 120                     }
 121
 122                     ++$i;
 123
 124                     $expectedType = gettype($expectedValue);
 125                     $actualType   = gettype($actualValue);
 126
 127                     if ($expectedType !== $actualType) {
 128                         $diffObject = new PHPUnit_Framework_ComparisonFailure_Type($expectedValue, $actualValue, $this->message . 'attribute <' . $expectedAttribute->getName() . '>: ');
 129                         $diff .= $diffObject->toString();
 130                     }
 131
 132                     elseif (is_object($expectedValue)) {
 133                         if (get_class($expectedValue) !== get_class($actualValue)) {
 134                             $diffObject = new PHPUnit_Framework_ComparisonFailure_Type($expectedValue, $actualValue, $this->message . 'attribute <' . $expectedAttribute->getName() . '>: ');
 135                             $diff .= $diffObject->toString();
 136                         } else {
 137                             $diff .= 'attribute <' . $expectedAttribute->getName() . '> contains object <' . get_class($expectedValue) . '> with different attributes';
 138                         }
 139                     } else {
 140                         $diffObject = PHPUnit_Framework_ComparisonFailure::diffIdentical($expectedValue, $actualValue, $this->message . 'attribute <' . $expectedAttribute->getName() . '>: ');
 141                         $diff .= $diffObject->toString();
 142                     }
 143                 }
 144             }
 145
 146             return $diff;
 147         }
 148     }
 149 }
 150 ?>