mirror of
https://github.com/moodle/moodle.git
synced 2025-08-08 10:26:40 +02:00
504c97925c
We often do isEqual tests but where a field, may have a single exception. Ordinarily we can handle this easily by breaking the test down, but when dealing with mocked objects we can only pass an instance of a PHPUnit_Framework_Constraint, or a single value (which is cast to an instance of PHPUnit_Framework_Constraint_IsEqual). To deal with instances of time-based exception, we need to be able to compare simple objects and classes where one or two values may be different.
86 lines
3.2 KiB
PHP
86 lines
3.2 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Constraint that checks a simple object with an isEqual constrain, allowing for exceptions to be made for some fields.
|
|
*
|
|
* @package core
|
|
* @category phpunit
|
|
* @copyright 2015 Andrew Nicols <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
|
|
/**
|
|
* Constraint that checks a simple object with an isEqual constrain, allowing for exceptions to be made for some fields.
|
|
*
|
|
* @package core
|
|
* @category phpunit
|
|
* @copyright 2015 Andrew Nicols <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class phpunit_constraint_object_is_equal_with_exceptions extends PHPUnit_Framework_Constraint_IsEqual {
|
|
|
|
/**
|
|
* @var array $keys The list of exceptions.
|
|
*/
|
|
protected $keys = array();
|
|
|
|
/**
|
|
* Add an exception for the named key to use a different comparison
|
|
* method. Any assertion provided by PHPUnit_Framework_Assert is
|
|
* acceptable.
|
|
*
|
|
* @param string $key The key to except.
|
|
* @param string $comparator The assertion to use.
|
|
*/
|
|
public function add_exception($key, $comparator) {
|
|
$this->keys[$key] = $comparator;
|
|
}
|
|
|
|
/**
|
|
* Evaluates the constraint for parameter $other
|
|
*
|
|
* If $shouldreturnesult is set to false (the default), an exception is thrown
|
|
* in case of a failure. null is returned otherwise.
|
|
*
|
|
* If $shouldreturnesult is true, the result of the evaluation is returned as
|
|
* a boolean value instead: true in case of success, false in case of a
|
|
* failure.
|
|
*
|
|
* @param mixed $other Value or object to evaluate.
|
|
* @param string $description Additional information about the test
|
|
* @param bool $shouldreturnesult Whether to return a result or throw an exception
|
|
* @return mixed
|
|
* @throws PHPUnit_Framework_ExpectationFailedException
|
|
*/
|
|
public function evaluate($other, $description = '', $shouldreturnesult = false) {
|
|
foreach ($this->keys as $key => $comparison) {
|
|
if (isset($other->$key) || isset($this->value->$key)) {
|
|
// One of the keys is present, therefore run the comparison.
|
|
PHPUnit_Framework_Assert::$comparison($this->value->$key, $other->$key);
|
|
|
|
// Unset the keys, otherwise the standard evaluation will take place.
|
|
unset($other->$key);
|
|
unset($this->value->$key);
|
|
}
|
|
}
|
|
|
|
// Run the parent evaluation (isEqual).
|
|
return parent::evaluate($other, $description, $shouldreturnesult);
|
|
}
|
|
|
|
}
|