tests/PHPUnit/PHPUnit/Framework/ComparisonFailure/Object.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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  * @package    PHPUnit
  38  * @subpackage Framework_ComparisonFailure
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 3.0.0
  44  */
  45
  46 /**
  47  * Thrown when an assertion for object equality failed.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework_ComparisonFailure
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.5.13
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.0.0
  57  */
  58 class PHPUnit_Framework_ComparisonFailure_Object extends PHPUnit_Framework_ComparisonFailure
  59 {
  60     /**
  61      * Returns a string describing the difference between the expected and the
  62      * actual object.
  63      *
  64      * @return string
  65      */
  66     public function toString()
  67     {
  68         $diff = PHPUnit_Util_Diff::diff(
  69           print_r($this->expected, TRUE),
  70           print_r($this->actual, TRUE)
  71         );
  72
  73         if ($diff !== FALSE) {
  74             return trim($diff);
  75         }
  76
  77         // Fallback: Either diff is not available or the print_r() output for
  78         // the expected and the actual object are equal (but the objects are
  79         // not).
  80
  81         $expectedClass = get_class($this->expected);
  82         $actualClass   = get_class($this->actual);
  83
  84         if ($expectedClass !== $actualClass) {
  85             return sprintf(
  86               "%s%sexpected class <%s>\n" .
  87               '%sgot class      <%s>',
  88
  89               $this->message,
  90               ($this->message != '') ? ' ' : '',
  91               $expectedClass,
  92               ($this->message != '') ? str_repeat(' ', strlen($this->message) + 1) : '',
  93               $actualClass
  94             );
  95         } else {
  96             $expectedReflection = new ReflectionClass($expectedClass);
  97             $actualReflection   = new ReflectionClass($actualClass);
  98
  99             $diff = "in object of class <{$expectedClass}>:\n";
 100             $i    = 0;
 101
 102             foreach($expectedReflection->getProperties() as $expectedAttribute) {
 103                 if ($expectedAttribute->isPrivate() ||
 104                     $expectedAttribute->isProtected()) {
 105                     continue;
 106                 }
 107
 108                 $actualAttribute = $actualReflection->getProperty(
 109                                      $expectedAttribute->getName()
 110                                    );
 111                 $expectedValue   = $expectedAttribute->getValue(
 112                                      $this->expected
 113                                    );
 114                 $actualValue     = $actualAttribute->getValue($this->actual);
 115
 116                 if ($expectedValue !== $actualValue) {
 117                     if ($i > 0) {
 118                         $diff .= "\n";
 119                     }
 120
 121                     ++$i;
 122
 123                     $expectedType = gettype($expectedValue);
 124                     $actualType   = gettype($actualValue);
 125
 126                     if ($expectedType !== $actualType) {
 127                         $diffObject = new PHPUnit_Framework_ComparisonFailure_Type(
 128                           $expectedValue,
 129                           $actualValue,
 130                           $this->message . 'attribute <' .
 131                           $expectedAttribute->getName() . '>: '
 132                         );
 133
 134                         $diff .= $diffObject->toString();
 135                     }
 136
 137                     elseif (is_object($expectedValue)) {
 138                         if (get_class($expectedValue) !== get_class($actualValue)) {
 139                             $diffObject = new PHPUnit_Framework_ComparisonFailure_Type(
 140                               $expectedValue,
 141                               $actualValue,
 142                               $this->message . 'attribute <' .
 143                               $expectedAttribute->getName() . '>: '
 144                             );
 145
 146                             $diff .= $diffObject->toString();
 147                         } else {
 148                             $diff .= 'attribute <' .
 149                                      $expectedAttribute->getName() .
 150                                      '> contains object <' .
 151                                      get_class($expectedValue) .
 152                                      '> with different attributes';
 153                         }
 154                     } else {
 155                         $diffObject = PHPUnit_Framework_ComparisonFailure::diffIdentical(
 156                           $expectedValue,
 157                           $actualValue,
 158                           $this->message . 'attribute <' .
 159                           $expectedAttribute->getName() . '>: '
 160                         );
 161
 162                         $diff .= $diffObject->toString();
 163                     }
 164                 }
 165             }
 166
 167             return $diff;
 168         }
 169     }
 170 }