eZ\Publish\Core\REST\Server\Tests\Output\ValueObjectVisitor\ContentFieldValidationExceptionTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	testVisit()	0	21	1
A	testResultContainsErrorDescription()	0	11	1
A	testResultContainsErrorDetails()	0	18	1
A	getExpectedStatusCode()	0	4	1
A	getExpectedMessage()	0	4	1
A	getExpectedDescription()	0	4	1
A	getException()	0	23	1
A	internalGetVisitor()	0	4	1

<?php

/**
 * File containing a test class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\REST\Server\Tests\Output\ValueObjectVisitor;

use eZ\Publish\Core\Base\Exceptions\ContentFieldValidationException as CoreContentFieldValidationException;
use eZ\Publish\Core\FieldType\ValidationError;
use eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor;
use eZ\Publish\Core\REST\Server\Exceptions;
use Symfony\Component\Translation\Translator;

class ContentFieldValidationExceptionTest extends ExceptionTest
{
    /**
     * Test the ContentFieldValidationException visitor.
     *
     * @return string
     */
    public function testVisit()
    {
        $visitor = $this->getVisitor();
        $generator = $this->getGenerator();

        $generator->startDocument(null);

        $exception = $this->getException();

        $visitor->visit(
            $this->getVisitorMock(),

It seems like $this->getVisitorMock() targeting eZ\Publish\Core\REST\Common\Tests\Output\ValueObjectVisitorBaseTest::getVisitorMock() can also be of type object<PHPUnit_Framework_MockObject_MockObject>; however, eZ\Publish\Core\REST\Common\Output\ValueObjectVisitor::visit() does only seem to accept object<eZ\Publish\Core\REST\Common\Output\Visitor>, maybe add an additional type check?

            $generator,
            $exception
        );

        $result = $generator->endDocument(null);

        $this->assertNotNull($result);

        return $result;
    }

    /**
     * Test if result contains ErrorMessage element and description.
     *
     * @param string $result
     *
     * @depends testVisit
     */
    public function testResultContainsErrorDescription($result)
    {
        $this->assertXMLTag(
            [
                'tag' => 'errorDescription',
                'content' => $this->getExpectedDescription(),
            ],
            $result,
            'Missing <errorDescription> element.'
        );
    }

    /**
     * Test if result contains ErrorMessage element and details.
     *
     * @param string $result
     *
     * @depends testVisit
     */
    public function testResultContainsErrorDetails($result)
    {
        $this->assertXMLTag(
            [
                'tag' => 'errorDetails',
            ],
            $result,
            'Missing <errorDetails> element.'
        );

        $this->assertXMLTag(
            [
                'tag' => 'field',
            ],
            $result,
            'Missing <field> element.'
        );
    }

    /**
     * Get expected status code.
     *
     * @return int
     */
    protected function getExpectedStatusCode()
    {
        return 400;
    }

    /**
     * Get expected message.
     *
     * @return string
     */
    protected function getExpectedMessage()
    {
        return 'Bad Request';
    }

    /**
     * Get expected description.
     *
     * @return string
     */
    protected function getExpectedDescription()
    {
        return 'Content fields did not validate';
    }

    /**
     * Gets the exception.
     *
     * @return \Exception
     */
    protected function getException()
    {
        return new Exceptions\ContentFieldValidationException(
            new CoreContentFieldValidationException([

array(1 => array('eng-GB' => new \eZ\Publish\Core\FieldType\ValidationError('Value for required field definition \'%identifier%\' with language \'%languageCode%\' is empty', null, array('%identifier%' => 'name', '%languageCode%' => 'eng-GB'), 'empty')), 2 => array('eng-GB' => new \eZ\Publish\Core\FieldType\ValidationError('The value must be a valid email address.', null, array(), 'email'))) is of type array<integer,array<string,object<eZ\Publish\Core\FieldType\ValidationError>,{"eng-GB":"object<eZ\\Publish\\Core\\FieldType\\ValidationError>"}>,{"1":"array<string,object<eZ\\Publish\\Core\\FieldType\\ValidationError>,{\"eng-GB\":\"object<eZ\\\\Publish\\\\Core\\\\FieldType\\\\ValidationError>\"}>","2":"array<string,object<eZ\\Publish\\Core\\FieldType\\ValidationError>,{\"eng-GB\":\"object<eZ\\\\Publish\\\\Core\\\\FieldType\\\\ValidationError>\"}>"}>, but the function expects a array<integer,object<eZ\Publish\Core\FieldType\ValidationError>>.

                1 => [
                    'eng-GB' => new ValidationError(
                        "Value for required field definition '%identifier%' with language '%languageCode%' is empty",
                        null,
                        ['%identifier%' => 'name', '%languageCode%' => 'eng-GB'],
                        'empty'
                    ),
                ],
                2 => [
                    'eng-GB' => new ValidationError(
                        'The value must be a valid email address.',
                        null,
                        [],
                        'email'
                    ),
                ],
            ])
        );
    }

    /**
     * Gets the exception visitor.
     *
     * @return \eZ\Publish\Core\REST\Server\Output\ValueObjectVisitor\ContentFieldValidationException
     */
    protected function internalGetVisitor()
    {
        return new ValueObjectVisitor\ContentFieldValidationException(false, new Translator('eng-GB'));
    }
}