tests/PHPUnit/Extensions/Database/Constraint/DataSetIsEqual.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     Mike Lively <m@digitalsandwich.com>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49 require_once 'PHPUnit/Framework/Constraint.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * Asserts whether or not two dbunit datasets are equal.
  55  *
  56  * @category   Testing
  57  * @package    PHPUnit
  58  * @author     Mike Lively <m@digitalsandwich.com>
  59  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  60  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  61  * @version    Release: 3.3.17
  62  * @link       http://www.phpunit.de/
  63  * @since      Class available since Release 3.2.0
  64  */
  65 class PHPUnit_Extensions_Database_Constraint_DataSetIsEqual extends PHPUnit_Framework_Constraint
  66 {
  67
  68     /**
  69      * @var PHPUnit_Extensions_Database_DataSet_IDataSet
  70      */
  71     protected $value;
  72
  73     /**
  74      * @var string
  75      */
  76     protected $failure_reason;
  77
  78     /**
  79      * Creates a new constraint.
  80      *
  81      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $value
  82      */
  83     public function __construct(PHPUnit_Extensions_Database_DataSet_IDataSet $value)
  84     {
  85         $this->value = $value;
  86     }
  87
  88     /**
  89      * Determines whether or not the given dataset matches the dataset used to
  90      * create this constraint.
  91      *
  92      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $other
  93      * @return bool
  94      */
  95     public function evaluate($other)
  96     {
  97         if ($other instanceof PHPUnit_Extensions_Database_DataSet_IDataSet) {
  98             try {
  99                 $this->value->assertEquals($other);
 100                 return TRUE;
 101             } catch (Exception $e) {
 102                 $this->failure_reason = $e->getMessage();
 103                 return FALSE;
 104             }
 105         } else {
 106             throw new InvalidArgumentException("PHPUnit_Extensions_Database_DataSet_IDataSet expected");
 107         }
 108     }
 109
 110     protected function customFailureDescription($other, $description, $not)
 111     {
 112         return sprintf(
 113           'Failed asserting that actual %s %s Reason: %s',
 114
 115            $other->__toString(),
 116            $this->toString(),
 117            $this->failure_reason
 118          );
 119     }
 120
 121     /**
 122      * Returns a string representation of the constraint.
 123      *
 124      * @return string
 125      */
 126     public function toString()
 127     {
 128         return sprintf('is equal to expected %s',
 129             $this->value->__toString());
 130     }
 131 }
 132 ?>