silverstripe-framework/tests/php/ORM/ValidationExceptionTest.php

<?php

namespace SilverStripe\ORM\Tests;

use SilverStripe\ORM\ValidationResult;
use SilverStripe\ORM\ValidationException;
use SilverStripe\Dev\SapphireTest;

class ValidationExceptionTest extends SapphireTest
{
	/**
	 * Test that ValidationResult object can correctly populate a ValidationException
	 */
	public function testCreateFromValidationResult() {

		$result = new ValidationResult();
		$result->addError('Not a valid result');

		$exception = new ValidationException($result);

		$this->assertEquals(0, $exception->getCode());
		$this->assertEquals('Not a valid result', $exception->getMessage());
		$this->assertFalse($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->addError('Invalid type')
				->addError('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->assertFalse($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();
		$result->addError('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->assertFalse($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->addError('A spork is not a knife')
				->addError('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());
	}

	/**
	 * Test combining validation results together
	 */
	public function testCombineResults(){
		$result = new ValidationResult();
		$anotherresult = new ValidationResult();
		$yetanotherresult = new ValidationResult();
		$anotherresult->addError("Eat with your mouth closed", 'bad', "EATING101");
		$yetanotherresult->addError("You didn't wash your hands", 'bad', "BECLEAN", false);

		$this->assertTrue($result->valid());
		$this->assertFalse($anotherresult->valid());
		$this->assertFalse($yetanotherresult->valid());

		$result->combineAnd($anotherresult)
				->combineAnd($yetanotherresult);
		$this->assertFalse($result->valid());
		$this->assertEquals(array(
			"EATING101" => "Eat with your mouth closed",
			"BECLEAN" => "You didn't wash your hands"
		), $result->messageList());
	}

	/**
	 * Test that a ValidationException created with no contained ValidationResult
	 * will correctly populate itself with an inferred version
	 */
	public function testCreateForField() {
		$exception = ValidationException::create_for_field('Content', 'Content is required');

		$this->assertEquals('Content is required', $exception->getMessage());
		$this->assertEquals(false, $exception->getResult()->valid());

		$this->assertEquals(array(
			'Content' => array(
				'message' => 'Content is required',
				'messageType' => 'bad',
			),
		), $exception->getResult()->fieldErrors());
	}

	/**
	 * Test that a ValidationException created with no contained ValidationResult
	 * will correctly populate itself with an inferred version
	 */
	public function testValidationResultAddMethods() {
		$result = new ValidationResult();
		$result->addMessage('A spork is not a knife', 'bad');
		$result->addError('A knife is not a back scratcher');
		$result->addFieldMessage('Title', 'Title is good', 'good');
		$result->addFieldError('Content', 'Content is bad');


		$this->assertEquals(array(
			'Title' => array(
				'message' => 'Title is good',
				'messageType' => 'good'
			),
			'Content' => array(
				'message' => 'Content is bad',
				'messageType' => 'bad'
			)
		), $result->fieldErrors());

		$this->assertEquals('A spork is not a knife; A knife is not a back scratcher', $result->overallMessage());

		$exception = ValidationException::create_for_field('Content', 'Content is required');
	}

}