eZ\Publish\SPI\Tests\FieldType\BaseIntegrationTest

Complexity

Total Complexity

47

Size/Duplication

Total Lines	654
Duplicated Lines	12.84 %

Coupling/Cohesion

Components	3
Dependencies	29

Importance

Changes

0

34 Methods

Rating	Name	Duplication	Size	Complexity
	getTypeName()	0	1	?
	getCustomHandler()	0	1	?
	getTypeConstraints()	0	1	?
	getFieldDefinitionData()	0	1	?
	getInitialValue()	0	1	?
	getUpdatedValue()	0	1	?
A	getInstallationDir()	10	10	2
A	getTransformationProcessor()	0	12	2
A	assertLoadedFieldDataCorrect()	0	7	1
A	assertUpdatedFieldDataCorrect()	0	7	1
A	postCreationHook()	0	4	1
A	assertDeletedFieldDataCorrect()	0	4	1
A	setUp()	0	13	2
A	testCreateContentType()	0	9	1
A	createContentType()	0	47	1
A	testContentTypeField()	0	7	1
A	testLoadContentTypeField()	0	7	1
A	testLoadContentTypeFieldType()	0	9	1
A	testLoadContentTypeFieldData()	0	7	1
A	testCreateContent()	0	13	1
A	createContent()	0	54	1
A	testCreatedFieldType()	0	9	1
A	testLoadField()	0	8	1
A	testLoadFieldType()	0	9	1
A	testLoadExternalData()	0	4	1
A	testUpdateField()	0	6	1
A	updateContent()	0	20	1
A	testUpdateFieldType()	0	9	1
A	testUpdateExternalData()	0	4	1
A	testDeleteField()	0	14	1
A	deleteContent()	0	9	1
A	getContainer()	40	40	1
A	getHandler()	0	22	1
C	setAllServicesPublic()	34	34	17

<?php

/**
 * File contains: eZ\Publish\SPI\Tests\FieldType\BaseIntegrationTest 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\SPI\Tests\FieldType;

use eZ\Publish\Core\Persistence;
use eZ\Publish\Core\Persistence\TransformationProcessor\DefinitionBased;
use eZ\Publish\Core\Persistence\Legacy\Tests\TestCase;
use eZ\Publish\Core\Persistence\Legacy;
use eZ\Publish\SPI\Persistence\Content;
use eZ\Publish\SPI\Persistence\Content\Field;
use eZ\Publish\SPI\Persistence\Content\Type;
use eZ\Publish\SPI\Persistence\Content\UpdateStruct;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

/**
 * Integration test for the legacy storage.
 *
 * @group integration
 */
abstract class BaseIntegrationTest extends TestCase
{
    /**
     * Property indicating whether the DB already has been set up.
     *
     * @var bool
     */
    protected static $setUp = false;

    /**
     * Id of test content type.
     *
     * @var string
     */
    protected static $contentTypeId;

    /**
     * Id of test content.
     *
     * @var string
     */
    protected static $contentId;

    /**
     * Current version of test content.
     *
     * @var string
     */
    protected static $contentVersion;

    /**
     * @var \Symfony\Component\DependencyInjection\ContainerBuilder
     */
    protected static $container;

    /**
     * @return string
     */
    protected static function getInstallationDir()
    {
        static $installDir = null;
        if ($installDir === null) {
            $config = require __DIR__ . '/../../../../../config.php';
            $installDir = $config['install_dir'];
        }

        return $installDir;
    }

    /**
     * @var \eZ\Publish\Core\Persistence\TransformationProcessor
     */
    protected $transformationProcessor;

    /**
     * @return \eZ\Publish\Core\Persistence\TransformationProcessor
     */
    public function getTransformationProcessor()
    {
        if (!isset($this->transformationProcessor)) {
            $this->transformationProcessor = new DefinitionBased(
                new Persistence\TransformationProcessor\DefinitionBased\Parser(self::getInstallationDir()),
                new Persistence\TransformationProcessor\PcreCompiler(new Persistence\Utf8Converter()),
                glob(__DIR__ . '/../../../Core/Persistence/Tests/TransformationProcessor/_fixtures/transformations/*.tr')
            );
        }

        return $this->transformationProcessor;
    }

    /**
     * Returns the identifier of the FieldType under test.
     *
     * @return string
     */
    abstract public function getTypeName();

    /**
     * Returns the Handler with all necessary objects registered.
     *
     * Returns an instance of the Persistence Handler where the
     * FieldType\Storage has been registered.
     *
     * @return \eZ\Publish\SPI\Persistence\Handler
     */
    abstract public function getCustomHandler();

    /**
     * Returns the FieldTypeConstraints to be used to create a field definition
     * of the FieldType under test.
     *
     * @return \eZ\Publish\SPI\Persistence\Content\FieldTypeConstraints
     */
    abstract public function getTypeConstraints();

    /**
     * Returns the field definition data expected after loading the newly
     * created field definition with the FieldType under test.
     *
     * This is a PHPUnit data provider
     *
     * @return array
     */
    abstract public function getFieldDefinitionData();

    /**
     * Get initial field value.
     *
     * @return \eZ\Publish\SPI\Persistence\Content\FieldValue
     */
    abstract public function getInitialValue();

    /**
     * Asserts that the loaded field data is correct.
     *
     * Performs assertions on the loaded field, mainly checking that the
     * $field->value->externalData is loaded correctly. If the loading of
     * external data manipulates other aspects of $field, their correctness
     * also needs to be asserted. Make sure you implement this method agnostic
     * to the used SPI\Persistence implementation!
     */
    public function assertLoadedFieldDataCorrect(Field $field)
    {
        $this->assertEquals(
            $this->getInitialValue(),
            $field->value
        );
    }

    /**
     * Get update field value.
     *
     * Use to update the field
     *
     * @return \eZ\Publish\SPI\Persistence\Content\FieldValue
     */
    abstract public function getUpdatedValue();

    /**
     * Asserts that the updated field data is loaded correct.
     *
     * Performs assertions on the loaded field after it has been updated,
     * mainly checking that the $field->value->externalData is loaded
     * correctly. If the loading of external data manipulates other aspects of
     * $field, their correctness also needs to be asserted. Make sure you
     * implement this method agnostic to the used SPI\Persistence
     * implementation!
     */
    public function assertUpdatedFieldDataCorrect(Field $field)
    {
        $this->assertEquals(
            $this->getUpdatedValue(),
            $field->value
        );
    }

    /**
     * Method called after content creation.
     *
     * Useful, if additional stuff should be executed (like creating the actual
     * user).
     *
     * @param Legacy\Handler $handler
     * @param Content $content
     */
    public function postCreationHook(Legacy\Handler $handler, Content $content)
    {
        // Do nothing by default
    }

    /**
     * Can be overwritten to assert that additional data has been deleted.
     *
     * @param Content $content
     */
    public function assertDeletedFieldDataCorrect(Content $content)

The parameter $content is not used and could be removed.

    {
        // Do nothing by default
    }

    /**
     * Only set up once for these read only tests on a large fixture.
     *
     * Skipping the reset-up, since setting up for these tests takes quite some
     * time, which is not required to spent, since we are only reading from the
     * database anyways.
     */
    public function setUp()
    {
        if (!self::$setUp) {
            self::$container = $this->getContainer();
            $this->handler = self::$container->get('ezpublish.api.storage_engine.legacy.dbhandler');
            $this->db = $this->handler->getName();
            parent::setUp();
            $this->insertDatabaseFixture(__DIR__ . '/../../../Core/Repository/Tests/Service/Integration/Legacy/_fixtures/clean_ezdemo_47_dump.php');
            self::$setUp = $this->handler;

It seems like $this->handler of type object is incompatible with the declared type boolean of property $setUp.

        } else {
            $this->handler = self::$setUp;

It seems like self::$setUp of type boolean is incompatible with the declared type object<eZ\Publish\Core\Persistence\Database\DatabaseHandler> of property $handler.

        }
    }

    public function testCreateContentType()
    {
        $contentType = $this->createContentType();

        $this->assertNotNull($contentType->id);
        self::$contentTypeId = $contentType->id;

        return $contentType;
    }

    /**
     * Performs the creation of the content type with a field of the field type
     * under test.
     *
     * @return \eZ\Publish\SPI\Persistence\Content\Type
     */
    protected function createContentType()
    {
        $createStruct = new Content\Type\CreateStruct(
            array(
                'name' => array('eng-GB' => 'Test'),
                'identifier' => 'test-' . $this->getTypeName(),
                'status' => 0,
                'creatorId' => 14,
                'created' => time(),
                'modifierId' => 14,
                'modified' => time(),
                'initialLanguageId' => 2,
                'remoteId' => 'abcdef',
            )
        );

        $createStruct->fieldDefinitions = array(
            new Content\Type\FieldDefinition(
                array(
                    'name' => array('eng-GB' => 'Name'),
                    'identifier' => 'name',
                    'fieldGroup' => 'main',
                    'position' => 1,
                    'fieldType' => 'ezstring',
                    'isTranslatable' => false,
                    'isRequired' => true,
                )
            ),
            new Content\Type\FieldDefinition(
                array(
                    'name' => array('eng-GB' => 'Data'),
                    'identifier' => 'data',
                    'fieldGroup' => 'main',
                    'position' => 2,
                    'fieldType' => $this->getTypeName(),
                    'isTranslatable' => false,
                    'isRequired' => true,
                    'fieldTypeConstraints' => $this->getTypeConstraints(),
                )
            ),
        );

        $handler = $this->getCustomHandler();
        $contentTypeHandler = $handler->contentTypeHandler();

        return $contentTypeHandler->create($createStruct);
    }

    /**
     * @depends testCreateContentType
     */
    public function testContentTypeField($contentType)
    {
        $this->assertSame(
            $this->getTypeName(),
            $contentType->fieldDefinitions[1]->fieldType
        );
    }

    /**
     * @depends testCreateContentType
     */
    public function testLoadContentTypeField()
    {
        $handler = $this->getCustomHandler();
        $contentTypeHandler = $handler->contentTypeHandler();

        return $contentTypeHandler->load(self::$contentTypeId);
    }

    /**
     * @depends testLoadContentTypeField
     */
    public function testLoadContentTypeFieldType($contentType)
    {
        $this->assertSame(
            $this->getTypeName(),
            $contentType->fieldDefinitions[1]->fieldType
        );

        return $contentType->fieldDefinitions[1];
    }

    /**
     * @depends testLoadContentTypeFieldType
     * @dataProvider getFieldDefinitionData
     */
    public function testLoadContentTypeFieldData($name, $value, $field)
    {
        $this->assertEquals(
            $value,
            $field->$name
        );
    }

    /**
     * @depends testLoadContentTypeField
     */
    public function testCreateContent($contentType)
    {
        $handler = $this->getCustomHandler();

        $content = $this->createContent($contentType, $this->getInitialValue());

        self::$contentId = $content->versionInfo->contentInfo->id;
        self::$contentVersion = $content->versionInfo->contentInfo->currentVersionNo;

The property $contentVersion was declared of type string, but $content->versionInfo->contentInfo->currentVersionNo is of type integer. Maybe add a type cast?

        $this->postCreationHook($handler, $content);

$handler of type object<eZ\Publish\SPI\Persistence\Handler> is not a sub-type of object<eZ\Publish\Core\Persistence\Legacy\Handler>. It seems like you assume a concrete implementation of the interface eZ\Publish\SPI\Persistence\Handler to be always present.

        return $content;
    }

    /**
     * Creates content of the given $contentType with $fieldValue in
     * $languageCode.
     *
     * @param Type $contentType
     * @param mixed $fieldValue
     * @param string $languageCode
     *
     * @return Content
     */
    protected function createContent(Type $contentType, $fieldValue, $languageCode = 'eng-GB')
    {
        $createStruct = new Content\CreateStruct(
            array(
                'name' => array($languageCode => 'Test object'),
                'typeId' => $contentType->id,
                'sectionId' => 1,
                'ownerId' => 14,
                'locations' => array(
                    new Content\Location\CreateStruct(
                        array(
                            'parentId' => 2,
                            'remoteId' => 'sindelfingen',
                        )
                    ),
                ),
                // Language with id=2 is eng-US
                // This is probably a mistake, as the fields are given with eng-GB, but it has a nice
                // side effect of testing creation with empty value.
                // TODO: change to eng-GB (8) and/or find a more obvious way to test creation with empty value
                'initialLanguageId' => 2,
                'remoteId' => microtime(),
                'modified' => time(),
                'fields' => array(
                    new Content\Field(
                        array(
                            'type' => 'ezstring',
                            'languageCode' => $languageCode,
                            'fieldDefinitionId' => $contentType->fieldDefinitions[0]->id,
                            'value' => new Content\FieldValue(
                                array(
                                    'data' => 'This is just a test object',
                                    'sortKey' => 'this is just a test object',
                                )
                            ),
                        )
                    ),
                    new Content\Field(
                        array(
                            'type' => $this->getTypeName(),
                            'languageCode' => $languageCode,
                            'fieldDefinitionId' => $contentType->fieldDefinitions[1]->id,
                            'value' => $fieldValue,
                        )
                    ),
                ),
            )
        );

        $handler = $this->getCustomHandler();
        $contentHandler = $handler->contentHandler();

        return $contentHandler->create($createStruct);
    }

    /**
     * @depends testCreateContent
     */
    public function testCreatedFieldType($content)
    {
        $this->assertSame(
            $this->getTypeName(),
            $content->fields[1]->type
        );

        return $content->fields[1];
    }

    /**
     * @depends testCreateContent
     */
    public function testLoadField()
    {
        $handler = $this->getCustomHandler();

        $contentHandler = $handler->contentHandler();

        return $contentHandler->load(self::$contentId, self::$contentVersion);
    }

    /**
     * @depends testLoadField
     */
    public function testLoadFieldType($content)
    {
        $this->assertSame(
            $this->getTypeName(),
            $content->fields[1]->type
        );

        return $content->fields[1];
    }

    /**
     * @depends testLoadFieldType
     */
    public function testLoadExternalData($field)
    {
        $this->assertLoadedFieldDataCorrect($field);
    }

    /**
     * @depends testLoadFieldType
     */
    public function testUpdateField($field)
    {
        $field->value = $this->getUpdatedValue();

        return $this->updateContent(self::$contentId, self::$contentVersion, $field);
    }

    /**
     * Performs an update on $contentId in $contentVersion setting $field.
     *
     * @param mixed $contentId
     * @param mixed $contentVersion
     * @param Field $field
     *
     * @return Content
     */
    protected function updateContent($contentId, $contentVersion, Field $field)
    {
        $handler = $this->getCustomHandler();

        $field->value = $this->getUpdatedValue();
        $updateStruct = new UpdateStruct(
            array(
                'creatorId' => 14,
                'modificationDate' => time(),
                'initialLanguageId' => 2,
                'fields' => array(
                    $field,
                ),
            )
        );

        $contentHandler = $handler->contentHandler();

        return $contentHandler->updateContent($contentId, $contentVersion, $updateStruct);
    }

    /**
     * @depends testUpdateField
     */
    public function testUpdateFieldType($content)
    {
        $this->assertSame(
            $this->getTypeName(),
            $content->fields[1]->type
        );

        return $content->fields[1];
    }

    /**
     * @depends testUpdateFieldType
     */
    public function testUpdateExternalData($field)
    {
        $this->assertUpdatedFieldDataCorrect($field);
    }

    /**
     * @depends testUpdateField
     * @expectedException \eZ\Publish\API\Repository\Exceptions\NotFoundException
     */
    public function testDeleteField($content)
    {
        $handler = $this->getCustomHandler();
        $contentHandler = $handler->contentHandler();

        $this->deleteContent($content);

        $this->assertDeletedFieldDataCorrect($content);

        $contentHandler->load(
            $content->versionInfo->contentInfo->id,
            $content->versionInfo->versionNo
        );
    }

    /**
     * Deletes the given $content.
     *
     * @param Content $content
     */
    protected function deleteContent(Content $content)
    {
        $handler = $this->getCustomHandler();
        $contentHandler = $handler->contentHandler();

        $contentHandler->removeRawContent(
            $content->versionInfo->contentInfo->id
        );
    }

    protected function getContainer()
    {
        $config = include __DIR__ . '/../../../../../config.php';
        $installDir = $config['install_dir'];

        $containerBuilder = new ContainerBuilder();
        $settingsPath = $installDir . '/eZ/Publish/Core/settings/';
        $loader = new YamlFileLoader($containerBuilder, new FileLocator($settingsPath));

        $loader->load('fieldtypes.yml');
        $loader->load('io.yml');
        $loader->load('repository.yml');
        $loader->load('repository/inner.yml');
        $loader->load('repository/signalslot.yml');
        $loader->load('repository/siteaccessaware.yml');
        $loader->load('fieldtype_external_storages.yml');
        $loader->load('storage_engines/common.yml');
        $loader->load('storage_engines/shortcuts.yml');
        $loader->load('storage_engines/legacy.yml');
        $loader->load('search_engines/legacy.yml');
        $loader->load('storage_engines/cache.yml');
        $loader->load('settings.yml');
        $loader->load('fieldtype_services.yml');
        $loader->load('utils.yml');
        $loader->load('tests/common.yml');
        $loader->load('policies.yml');

        $containerBuilder->setParameter('ezpublish.kernel.root_dir', $installDir);

        $containerBuilder->setParameter(
            'legacy_dsn',
            $this->getDsn()
        );

        $this->setAllServicesPublic($containerBuilder);

        $containerBuilder->compile();

        return $containerBuilder;
    }

    /**
     * Returns the Handler.
     *
     * @param string $identifier
     * @param \eZ\Publish\SPI\FieldType\FieldType $fieldType
     * @param \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\Converter $fieldValueConverter
     * @param \eZ\Publish\SPI\FieldType\FieldStorage $externalStorage
     *
     * @return \eZ\Publish\SPI\Persistence\Handler
     */
    protected function getHandler($identifier, $fieldType, $fieldValueConverter, $externalStorage)
    {
        /** @var \eZ\Publish\Core\Persistence\FieldTypeRegistry $fieldTypeRegistry */
        $fieldTypeRegistry = self::$container->get('ezpublish.persistence.field_type_registry');
        /** @var \eZ\Publish\Core\Persistence\Legacy\Content\FieldValue\ConverterRegistry $converterRegistry */
        $converterRegistry = self::$container->get('ezpublish.persistence.legacy.field_value_converter.registry');
        /** @var \eZ\Publish\Core\Persistence\Legacy\Content\StorageRegistry $storageRegistry */
        $storageRegistry = self::$container->get('ezpublish.persistence.external_storage_registry');

        $textLineFieldType = new \eZ\Publish\Core\FieldType\TextLine\Type();
        $textLineFieldType->setTransformationProcessor($this->getTransformationProcessor());
        $textLineFieldValueConverter = new Legacy\Content\FieldValue\Converter\TextLineConverter();

        $fieldTypeRegistry->register('ezstring', $textLineFieldType);
        $converterRegistry->register('ezstring', $textLineFieldValueConverter);

        $fieldTypeRegistry->register($identifier, $fieldType);
        $converterRegistry->register($identifier, $fieldValueConverter);
        $storageRegistry->register($identifier, $externalStorage);

        return self::$container->get('ezpublish.spi.persistence.legacy');
    }

    /**
     * Overrides all services to be public.
     *
     * It is a workaround to the change in Symfony 4 which makes all services private by default.
     * Our integration tests are not prepared for this as they get services directly from the Container.
     *
     * Inspired by {@link \Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TestServiceContainerWeakRefPass}
     *
     * @param \Symfony\Component\DependencyInjection\ContainerBuilder $containerBuilder
     */
    private function setAllServicesPublic(ContainerBuilder $containerBuilder): void
    {
        $definitions = $containerBuilder->getDefinitions();

        foreach ($definitions as $id => $definition) {
            if (
                $id && '.' !== $id[0]
                && (!$definition->isPublic() || $definition->isPrivate())
                && !$definition->getErrors()
                && !$definition->isAbstract()
            ) {
                $definition->setPrivate(false);
                $definition->setPublic(true);
            }
        }

        $aliases = $containerBuilder->getAliases();
        foreach ($aliases as $id => $alias) {
            if ($id && '.' !== $id[0] && (!$alias->isPublic() || $alias->isPrivate())) {
                while (isset($aliases[$target = (string) $alias])) {
                    $alias = $aliases[$target];
                }
                if (
                    isset($definitions[$target])
                    && !$definitions[$target]->getErrors()
                    && !$definitions[$target]->isAbstract()
                ) {

                    $definition->setPrivate(false);

The variable $definition seems to be defined by a foreach iteration on line 651. Are you sure the iterator is never empty, otherwise this variable is not defined?

                    $definition->setPublic(true);
                }
            }
        }
    }
}