tests/PHPUnit/PHPUnit/Framework/ComparisonFailure/Array.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 array 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_Array extends PHPUnit_Framework_ComparisonFailure
  59 {
  60     /**
  61      * Returns a string describing the difference between the expected and the
  62      * actual array.
  63      *
  64      * @return string
  65      */
  66     public function toString()
  67     {
  68         if (!$this->identical) {
  69             ksort($this->expected);
  70             ksort($this->actual);
  71         }
  72
  73         $diff = PHPUnit_Util_Diff::diff(
  74           print_r($this->expected, TRUE),
  75           print_r($this->actual, TRUE)
  76         );
  77
  78         if ($diff !== FALSE) {
  79             return trim($diff);
  80         }
  81
  82         // Fallback: Either diff is not available or the print_r() output for
  83         // the expected and the actual array are equal (but the arrays are not).
  84
  85         $expectedOnly = array();
  86         $actualOnly   = array();
  87         $diff         = '';
  88
  89         foreach ($this->expected as $expectedKey => $expectedValue) {
  90             if (!array_key_exists($expectedKey, $this->actual)) {
  91                 $expectedOnly[] = $expectedKey;
  92                 continue;
  93             }
  94
  95             if ($expectedValue === $this->actual[$expectedKey]) {
  96                 continue;
  97             }
  98
  99             $diffObject = PHPUnit_Framework_ComparisonFailure::diffIdentical(
 100               $expectedValue,
 101               $this->actual[$expectedKey],
 102               sprintf(
 103                 '%sarray key %s: ',
 104
 105                 $this->message,
 106                 PHPUnit_Util_Type::toString($expectedKey)
 107               )
 108             );
 109
 110             $diff .= $diffObject->toString() . "\n";
 111         }
 112
 113         foreach ($this->actual as $actualKey => $actualValue) {
 114             if (!array_key_exists($actualKey, $this->expected)) {
 115                 $actualOnly[] = $actualKey;
 116                 continue;
 117             }
 118         }
 119
 120         foreach ($expectedOnly as $expectedKey) {
 121             $diff .= sprintf(
 122               "array key %s: only in expected %s\n",
 123
 124               PHPUnit_Util_Type::toString($expectedKey),
 125               PHPUnit_Util_Type::toString($this->expected[$expectedKey])
 126             );
 127         }
 128
 129         foreach ($actualOnly as $actualKey) {
 130             $diff .= sprintf(
 131               "array key %s: only in actual %s\n",
 132
 133               PHPUnit_Util_Type::toString($actualKey),
 134               PHPUnit_Util_Type::toString($this->actual[$actualKey])
 135             );
 136         }
 137
 138         return $diff;
 139     }
 140 }