tests/PHPUnit/Framework/MockObject/Matcher/Parameters.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 require_once 'PHPUnit/Framework/MockObject/Matcher/StatelessInvocation.php';
  51 require_once 'PHPUnit/Framework/MockObject/Invocation.php';
  52
  53 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  54
  55 /**
  56  * Invocation matcher which looks for specific parameters in the invocations.
  57  *
  58  * Checks the parameters of all incoming invocations, the parameter list is
  59  * checked against the defined constraints in $parameters. If the constraint
  60  * is met it will return true in matches().
  61  *
  62  * @category   Testing
  63  * @package    PHPUnit
  64  * @author     Jan Borsodi <jb@ez.no>
  65  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  66  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  67  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  68  * @version    Release: 3.3.17
  69  * @link       http://www.phpunit.de/
  70  * @since      Class available since Release 3.0.0
  71  */
  72 class PHPUnit_Framework_MockObject_Matcher_Parameters extends PHPUnit_Framework_MockObject_Matcher_StatelessInvocation
  73 {
  74     protected $parameters = array();
  75
  76     protected $invocation;
  77
  78     public function __construct($parameters)
  79     {
  80         foreach($parameters as $parameter) {
  81             if (!($parameter instanceof PHPUnit_Framework_Constraint)) {
  82                 $parameter = new PHPUnit_Framework_Constraint_IsEqual($parameter);
  83             }
  84
  85             $this->parameters[] = $parameter;
  86         }
  87     }
  88
  89     public function toString()
  90     {
  91         $text = 'with parameter';
  92
  93         foreach($this->parameters as $index => $parameter) {
  94             if ($index > 0) {
  95                 $text .= ' and';
  96             }
  97
  98             $text .= ' ' . $index . ' ' . $parameter->toString();
  99         }
 100
 101         return $text;
 102     }
 103
 104     public function matches(PHPUnit_Framework_MockObject_Invocation $invocation)
 105     {
 106         $this->invocation = $invocation;
 107         $this->verify();
 108
 109         return count($invocation->parameters) < count($this->parameters);
 110     }
 111
 112     public function verify()
 113     {
 114         if ($this->invocation === NULL) {
 115             throw new PHPUnit_Framework_ExpectationFailedException(
 116               'Mocked method does not exist.'
 117             );
 118         }
 119
 120         if (count($this->invocation->parameters) < count($this->parameters)) {
 121             throw new PHPUnit_Framework_ExpectationFailedException(
 122               sprintf(
 123                 'Parameter count for invocation %s is too low.',
 124
 125                 $this->invocation->toString()
 126               )
 127             );
 128         }
 129
 130         foreach ($this->parameters as $i => $parameter) {
 131             if (!$parameter->evaluate($this->invocation->parameters[$i])) {
 132                 $parameter->fail(
 133                   $this->invocation->parameters[$i],
 134                   sprintf(
 135                     'Parameter %s for invocation %s does not match expected value.',
 136
 137                     $i,
 138                     $this->invocation->toString()
 139                   )
 140                 );
 141             }
 142         }
 143     }
 144 }
 145 ?>