tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

BUG Enforced requirement that ValidationException::getResult() is expected to consistently produce a valid ValidationResult object.

Browse Source
This commit is contained in:
Damian Mooyman 2013-03-15 13:56:43 +13:00
parent 75df03dddc
commit cd27bf71fb
2 changed files with 116 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
model/ValidationException.php
View File

@ -10,22 +10,50 @@
class ValidationException extends Exception { class ValidationException extends Exception {
/** /**
* @var {@link ValidationResult} or string * The contained ValidationResult related to this error
*
* @var ValidationResult
*/ */
protected $result; protected $result;
/**
* Construct a new ValidationException with an optional ValidationResult object
*
* @param ValidationResult|string $result The ValidationResult containing the
* failed result. Can be substituted with an error message instead if no
* ValidationResult exists.
* @param string|integer $message The error message. If $result was given the
* message string rather than a ValidationResult object then this will have
* the error code number.
* @param integer $code The error code number, if not given in the second parameter
*/
public function __construct($result = null, $message = null, $code = 0) { public function __construct($result = null, $message = null, $code = 0) {
if($result instanceof ValidationResult) {
$this->result = $result; // Check arguments
$message = $result->message(); if(!($result instanceof ValidationResult)) {
} else {
// Shift parameters if no ValidationResult is given
$code = $message; $code = $message;
$message = $result; $message = $result;
// Infer ValidationResult from parameters
$result = new ValidationResult(false, $message);
} elseif(empty($message)) {
// Infer message if not given
$message = $result->message();
} }
// Construct
$this->result = $result;
parent::__construct($message, $code); parent::__construct($message, $code);
} }
/**
* Retrieves the ValidationResult related to this error
*
* @return ValidationResult
*/
public function getResult() { public function getResult() {
return $this->result; return $this->result;
} }

83
tests/model/ValidationExceptionTest.php Normal file
View File

@ -0,0 +1,83 @@
<?php
/**
* @package framework
* @subpackage Testing
*/
class ValidationExceptionTest extends SapphireTest
{
/**
* Test that ValidationResult object can correctly populate a ValidationException
*/
public function testCreateFromValidationResult() {
$result = new ValidationResult(false, 'Not a valid result');
$exception = new ValidationException($result);
$this->assertEquals(0, $exception->getCode());
$this->assertEquals('Not a valid result', $exception->getMessage());
$this->assertEquals(false, $exception->getResult()->valid());
$this->assertEquals('Not a valid result', $exception->getResult()->message());
}
/**
* Test that ValidationResult object with multiple errors can correctly
* populate a ValidationException
*/
public function testCreateFromComplexValidationResult() {
$result = new ValidationResult();
$result->error('Invalid type');
$result->error('Out of kiwis');
$exception = new ValidationException($result);
$this->assertEquals(0, $exception->getCode());
$this->assertEquals('Invalid type; Out of kiwis', $exception->getMessage());
$this->assertEquals(false, $exception->getResult()->valid());
$this->assertEquals('Invalid type; Out of kiwis', $exception->getResult()->message());
}
/**
* Test that a ValidationException created with no contained ValidationResult
* will correctly populate itself with an inferred version
*/
public function testCreateFromMessage() {
$exception = new ValidationException('Error inferred from message', E_USER_ERROR);
$this->assertEquals(E_USER_ERROR, $exception->getCode());
$this->assertEquals('Error inferred from message', $exception->getMessage());
$this->assertEquals(false, $exception->getResult()->valid());
$this->assertEquals('Error inferred from message', $exception->getResult()->message());
}
/**
* Test that ValidationException can be created with both a ValidationResult
* and a custom message
*/
public function testCreateWithValidationResultAndMessage() {
$result = new ValidationResult(false, 'Incorrect placement of cutlery');
$exception = new ValidationException($result, 'An error has occurred', E_USER_WARNING);
$this->assertEquals(E_USER_WARNING, $exception->getCode());
$this->assertEquals('An error has occurred', $exception->getMessage());
$this->assertEquals(false, $exception->getResult()->valid());
$this->assertEquals('Incorrect placement of cutlery', $exception->getResult()->message());
}
/**
* Test that ValidationException can be created with both a ValidationResult
* and a custom message
*/
public function testCreateWithComplexValidationResultAndMessage() {
$result = new ValidationResult();
$result->error('A spork is not a knife');
$result->error('A knife is not a back scratcher');
$exception = new ValidationException($result, 'An error has occurred', E_USER_WARNING);
$this->assertEquals(E_USER_WARNING, $exception->getCode());
$this->assertEquals('An error has occurred', $exception->getMessage());
$this->assertEquals(false, $exception->getResult()->valid());
$this->assertEquals('A spork is not a knife; A knife is not a back scratcher', $exception->getResult()->message());
}
}