DomainMapperTest::getContentDomainMapper() - Code Metrics - Inspection of "EZP-30639: Removed deprecated ViewController actio..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — ezp-30639-deprecated-view-acti... ( fa6552...a00a72 )

unknown

created 2020-02-27 12:02 UTC

DomainMapperTest::getContentDomainMapper() A

↳ Parent: DomainMapperTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0

<?php

/**
 * File contains: eZ\Publish\Core\Repository\Tests\Service\Mock\DomainMapperTest 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\Repository\Tests\Service\Mock;

use DateTime;
use eZ\Publish\API\Repository\Exceptions\InvalidArgumentException;
use eZ\Publish\API\Repository\Values\Content\Search\SearchHit;
use eZ\Publish\API\Repository\Values\Content\Search\SearchResult;
use eZ\Publish\API\Repository\Values\Content\VersionInfo as APIVersionInfo;
use eZ\Publish\Core\Repository\ProxyFactory\ProxyDomainMapperInterface;
use eZ\Publish\Core\Repository\Tests\Service\Mock\Base as BaseServiceMockTest;
use eZ\Publish\Core\Repository\Mapper\ContentDomainMapper;
use eZ\Publish\Core\Repository\Values\Content\Content;
use eZ\Publish\Core\Repository\Values\Content\VersionInfo;
use eZ\Publish\SPI\Persistence\Content\ContentInfo;
use eZ\Publish\SPI\Persistence\Content\ContentInfo as SPIContentInfo;
use eZ\Publish\SPI\Persistence\Content\Location;
use eZ\Publish\API\Repository\Values\Content\Location as APILocation;
use eZ\Publish\SPI\Persistence\Content\VersionInfo as SPIVersionInfo;

/**
 * Mock test case for internal ContentDomainMapper.
 */
class DomainMapperTest extends BaseServiceMockTest
{
    private const EXAMPLE_CONTENT_TYPE_ID = 1;
    private const EXAMPLE_SECTION_ID = 1;
    private const EXAMPLE_MAIN_LOCATION_ID = 1;
    private const EXAMPLE_MAIN_LANGUAGE_CODE = 'ger-DE';
    private const EXAMPLE_OWNER_ID = 1;
    private const EXAMPLE_INITIAL_LANGUAGE_CODE = 'eng-GB';
    private const EXAMPLE_CREATOR_ID = 23;

    /**
     * @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildVersionInfoDomainObject
     * @dataProvider providerForBuildVersionInfo
     */
    public function testBuildVersionInfo(SPIVersionInfo $spiVersionInfo)
    {
        $languageHandlerMock = $this->getLanguageHandlerMock();
        $languageHandlerMock->expects($this->never())->method('load');

        $versionInfo = $this->getContentDomainMapper()->buildVersionInfoDomainObject($spiVersionInfo);

        $this->assertInstanceOf(APIVersionInfo::class, $versionInfo);
    }

    /**
     * @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildLocationWithContent
     */
    public function testBuildLocationWithContentForRootLocation()
    {
        $spiRootLocation = new Location(['id' => 1, 'parentId' => 1]);
        $apiRootLocation = $this->getContentDomainMapper()->buildLocationWithContent($spiRootLocation, null);

        $legacyDateTime = new DateTime();
        $legacyDateTime->setTimestamp(1030968000);

        $expectedContentInfo = new \eZ\Publish\API\Repository\Values\Content\ContentInfo([
            'id' => 0,
            'name' => 'Top Level Nodes',
            'sectionId' => 1,
            'mainLocationId' => 1,
            'contentTypeId' => 1,
            'currentVersionNo' => 1,
            'published' => 1,
            'ownerId' => 14,
            'modificationDate' => $legacyDateTime,
            'publishedDate' => $legacyDateTime,
            'alwaysAvailable' => 1,
            'remoteId' => null,
            'mainLanguageCode' => 'eng-GB',
        ]);

        $expectedContent = new Content([
            'versionInfo' => new VersionInfo([
                'names' => [
                    $expectedContentInfo->mainLanguageCode => $expectedContentInfo->name,
                ],
                'contentInfo' => $expectedContentInfo,
                'versionNo' => $expectedContentInfo->currentVersionNo,
                'modificationDate' => $expectedContentInfo->modificationDate,
                'creationDate' => $expectedContentInfo->modificationDate,
                'creatorId' => $expectedContentInfo->ownerId,
            ]),
        ]);

        $this->assertInstanceOf(APILocation::class, $apiRootLocation);
        $this->assertEquals($spiRootLocation->id, $apiRootLocation->id);
        $this->assertEquals($expectedContentInfo->id, $apiRootLocation->getContentInfo()->id);
        $this->assertEquals($expectedContent, $apiRootLocation->getContent());
    }

    /**
     * @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildLocationWithContent
     */
    public function testBuildLocationWithContentThrowsInvalidArgumentException()
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Argument \'$content\' is invalid: Location 2 has missing Content');

        $nonRootLocation = new Location(['id' => 2, 'parentId' => 1]);

        $this->getContentDomainMapper()->buildLocationWithContent($nonRootLocation, null);
    }

    public function testBuildLocationWithContentIsAlignedWithBuildLocation()
    {
        $spiRootLocation = new Location(['id' => 1, 'parentId' => 1]);

        $this->assertEquals(
            $this->getContentDomainMapper()->buildLocationWithContent($spiRootLocation, null),
            $this->getContentDomainMapper()->buildLocation($spiRootLocation)
        );
    }

    public function providerForBuildVersionInfo()
    {
        $properties = [
            'contentInfo' => new SPIContentInfo([
                'contentTypeId' => self::EXAMPLE_CONTENT_TYPE_ID,
                'sectionId' => self::EXAMPLE_SECTION_ID,
                'mainLocationId' => self::EXAMPLE_MAIN_LOCATION_ID,
                'mainLanguageCode' => self::EXAMPLE_MAIN_LANGUAGE_CODE,
                'ownerId' => self::EXAMPLE_OWNER_ID,
            ]),
            'creatorId' => self::EXAMPLE_CREATOR_ID,
            'initialLanguageCode' => self::EXAMPLE_INITIAL_LANGUAGE_CODE,
        ];

        return [
            [
                new SPIVersionInfo(
                    $properties + [
                        'status' => 44,
                    ]),
            ],
            [
                new SPIVersionInfo(
                    $properties + [
                        'status' => SPIVersionInfo::STATUS_DRAFT,
                    ]
                ),
            ],
            [
                new SPIVersionInfo(
                    $properties + [
                        'status' => SPIVersionInfo::STATUS_PENDING,
                    ]
                ),
            ],
            [
                new SPIVersionInfo(
                    $properties + [
                        'status' => SPIVersionInfo::STATUS_ARCHIVED,
                        'languageCodes' => ['eng-GB', 'nor-NB', 'fre-FR'],
                    ]
                ),
            ],
            [
                new SPIVersionInfo(
                    $properties + [
                        'status' => SPIVersionInfo::STATUS_PUBLISHED,
                    ]
                ),
            ],
        ];
    }

    public function providerForBuildLocationDomainObjectsOnSearchResult()
    {
        $properties = [
            'contentTypeId' => self::EXAMPLE_CONTENT_TYPE_ID,
            'sectionId' => self::EXAMPLE_SECTION_ID,
            'mainLocationId' => self::EXAMPLE_MAIN_LOCATION_ID,
            'mainLanguageCode' => self::EXAMPLE_MAIN_LANGUAGE_CODE,
            'ownerId' => self::EXAMPLE_OWNER_ID,
        ];

        $locationHits = [
            new Location(['id' => 21, 'contentId' => 32, 'parentId' => 1]),
            new Location(['id' => 22, 'contentId' => 33, 'parentId' => 1]),
        ];

        return [
            [
                $locationHits,
                [32, 33],
                [],
                [
                    32 => new ContentInfo($properties + ['id' => 32]),
                    33 => new ContentInfo($properties + ['id' => 33]),
                ],
                0,
            ],
            [
                $locationHits,
                [32, 33],
                ['languages' => ['eng-GB']],
                [
                    32 => new ContentInfo($properties + ['id' => 32]),
                ],
                1,
            ],
            [
                $locationHits,
                [32, 33],
                ['languages' => ['eng-GB']],
                [],
                2,
            ],
        ];
    }

    /**
     * @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildLocationDomainObjectsOnSearchResult
     * @dataProvider providerForBuildLocationDomainObjectsOnSearchResult
     *
     * @param array $locationHits
     * @param array $contentIds
     * @param array $languageFilter
     * @param array $contentInfoList
     * @param int $missing
     */
    public function testBuildLocationDomainObjectsOnSearchResult(
        array $locationHits,
        array $contentIds,
        array $languageFilter,
        array $contentInfoList,
        int $missing
    ) {
        $contentHandlerMock = $this->getContentHandlerMock();
        $contentHandlerMock
            ->expects($this->once())
            ->method('loadContentInfoList')
            ->with($contentIds)
            ->willReturn($contentInfoList);

        $result = new SearchResult(['totalCount' => 10]);
        foreach ($locationHits as $locationHit) {
            $result->searchHits[] = new SearchHit(['valueObject' => $locationHit]);
        }

        $spiResult = clone $result;
        $missingLocations = $this->getContentDomainMapper()->buildLocationDomainObjectsOnSearchResult($result, $languageFilter);
        $this->assertIsArray($missingLocations);

        if (!$missing) {
            $this->assertEmpty($missingLocations);
        } else {
            $this->assertNotEmpty($missingLocations);
        }

        $this->assertCount($missing, $missingLocations);
        $this->assertEquals($spiResult->totalCount - $missing, $result->totalCount);
        $this->assertCount(count($spiResult->searchHits) - $missing, $result->searchHits);
    }

    /**
     * Returns ContentDomainMapper.
     *
     * @return \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper
     */
    protected function getContentDomainMapper(): ContentDomainMapper
    {
        return new ContentDomainMapper(
            $this->getContentHandlerMock(),
            $this->getPersistenceMockHandler('Content\\Location\\Handler'),
            $this->getTypeHandlerMock(),
            $this->getContentTypeDomainMapperMock(),
            $this->getLanguageHandlerMock(),
            $this->getFieldTypeRegistryMock(),
            $this->getThumbnailStrategy(),
            $this->getProxyFactoryMock()
        );
    }

    /**
     * @return \eZ\Publish\SPI\Persistence\Content\Handler|\PHPUnit\Framework\MockObject\MockObject
     */
    protected function getContentHandlerMock()
    {
        return $this->getPersistenceMockHandler('Content\\Handler');
    }

    /**
     * @return \eZ\Publish\SPI\Persistence\Content\Language\Handler|\PHPUnit\Framework\MockObject\MockObject
     */
    protected function getLanguageHandlerMock()
    {
        return $this->getPersistenceMockHandler('Content\\Language\\Handler');
    }

    /**
     * @return \eZ\Publish\SPI\Persistence\Content\Type\Handler|\PHPUnit\Framework\MockObject\MockObject
     */
    protected function getTypeHandlerMock()
    {
        return $this->getPersistenceMockHandler('Content\\Type\\Handler');
    }

    protected function getProxyFactoryMock(): ProxyDomainMapperInterface
    {
        return $this->createMock(ProxyDomainMapperInterface::class);
    }
}


1			<?php
2
3			/**
4			* File contains: eZ\Publish\Core\Repository\Tests\Service\Mock\DomainMapperTest class.
5			*
6			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7			* @license For full copyright and license information view LICENSE file distributed with this source code.
8			*/
9			namespace eZ\Publish\Core\Repository\Tests\Service\Mock;
10
11			use DateTime;
12			use eZ\Publish\API\Repository\Exceptions\InvalidArgumentException;
13			use eZ\Publish\API\Repository\Values\Content\Search\SearchHit;
14			use eZ\Publish\API\Repository\Values\Content\Search\SearchResult;
15			use eZ\Publish\API\Repository\Values\Content\VersionInfo as APIVersionInfo;
16			use eZ\Publish\Core\Repository\ProxyFactory\ProxyDomainMapperInterface;
17			use eZ\Publish\Core\Repository\Tests\Service\Mock\Base as BaseServiceMockTest;
18			use eZ\Publish\Core\Repository\Mapper\ContentDomainMapper;
19			use eZ\Publish\Core\Repository\Values\Content\Content;
20			use eZ\Publish\Core\Repository\Values\Content\VersionInfo;
21			use eZ\Publish\SPI\Persistence\Content\ContentInfo;
22			use eZ\Publish\SPI\Persistence\Content\ContentInfo as SPIContentInfo;
23			use eZ\Publish\SPI\Persistence\Content\Location;
24			use eZ\Publish\API\Repository\Values\Content\Location as APILocation;
25			use eZ\Publish\SPI\Persistence\Content\VersionInfo as SPIVersionInfo;
26
27			/**
28			* Mock test case for internal ContentDomainMapper.
29			*/
30			class DomainMapperTest extends BaseServiceMockTest
31			{
32			private const EXAMPLE_CONTENT_TYPE_ID = 1;
33			private const EXAMPLE_SECTION_ID = 1;
34			private const EXAMPLE_MAIN_LOCATION_ID = 1;
35			private const EXAMPLE_MAIN_LANGUAGE_CODE = 'ger-DE';
36			private const EXAMPLE_OWNER_ID = 1;
37			private const EXAMPLE_INITIAL_LANGUAGE_CODE = 'eng-GB';
38			private const EXAMPLE_CREATOR_ID = 23;
39
40			/**
41			* @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildVersionInfoDomainObject
42			* @dataProvider providerForBuildVersionInfo
43			*/
44			public function testBuildVersionInfo(SPIVersionInfo $spiVersionInfo)
45			{
46			$languageHandlerMock = $this->getLanguageHandlerMock();
47			$languageHandlerMock->expects($this->never())->method('load');
48
49			$versionInfo = $this->getContentDomainMapper()->buildVersionInfoDomainObject($spiVersionInfo);
50
51			$this->assertInstanceOf(APIVersionInfo::class, $versionInfo);
52			}
53
54			/**
55			* @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildLocationWithContent
56			*/
57			public function testBuildLocationWithContentForRootLocation()
58			{
59			$spiRootLocation = new Location(['id' => 1, 'parentId' => 1]);
60			$apiRootLocation = $this->getContentDomainMapper()->buildLocationWithContent($spiRootLocation, null);
61
62			$legacyDateTime = new DateTime();
63			$legacyDateTime->setTimestamp(1030968000);
64
65			$expectedContentInfo = new \eZ\Publish\API\Repository\Values\Content\ContentInfo([
66			'id' => 0,
67			'name' => 'Top Level Nodes',
68			'sectionId' => 1,
69			'mainLocationId' => 1,
70			'contentTypeId' => 1,
71			'currentVersionNo' => 1,
72			'published' => 1,
73			'ownerId' => 14,
74			'modificationDate' => $legacyDateTime,
75			'publishedDate' => $legacyDateTime,
76			'alwaysAvailable' => 1,
77			'remoteId' => null,
78			'mainLanguageCode' => 'eng-GB',
79			]);
80
81			$expectedContent = new Content([
82			'versionInfo' => new VersionInfo([
83			'names' => [
84			$expectedContentInfo->mainLanguageCode => $expectedContentInfo->name,
85			],
86			'contentInfo' => $expectedContentInfo,
87			'versionNo' => $expectedContentInfo->currentVersionNo,
88			'modificationDate' => $expectedContentInfo->modificationDate,
89			'creationDate' => $expectedContentInfo->modificationDate,
90			'creatorId' => $expectedContentInfo->ownerId,
91			]),
92			]);
93
94			$this->assertInstanceOf(APILocation::class, $apiRootLocation);
95			$this->assertEquals($spiRootLocation->id, $apiRootLocation->id);
96			$this->assertEquals($expectedContentInfo->id, $apiRootLocation->getContentInfo()->id);
97			$this->assertEquals($expectedContent, $apiRootLocation->getContent());
98			}
99
100			/**
101			* @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildLocationWithContent
102			*/
103			public function testBuildLocationWithContentThrowsInvalidArgumentException()
104			{
105			$this->expectException(InvalidArgumentException::class);
106			$this->expectExceptionMessage('Argument \'$content\' is invalid: Location 2 has missing Content');
107
108			$nonRootLocation = new Location(['id' => 2, 'parentId' => 1]);
109
110			$this->getContentDomainMapper()->buildLocationWithContent($nonRootLocation, null);
111			}
112
113			public function testBuildLocationWithContentIsAlignedWithBuildLocation()
114			{
115			$spiRootLocation = new Location(['id' => 1, 'parentId' => 1]);
116
117			$this->assertEquals(
118			$this->getContentDomainMapper()->buildLocationWithContent($spiRootLocation, null),
119			$this->getContentDomainMapper()->buildLocation($spiRootLocation)
120			);
121			}
122
123			public function providerForBuildVersionInfo()
124			{
125			$properties = [
126			'contentInfo' => new SPIContentInfo([
127			'contentTypeId' => self::EXAMPLE_CONTENT_TYPE_ID,
128			'sectionId' => self::EXAMPLE_SECTION_ID,
129			'mainLocationId' => self::EXAMPLE_MAIN_LOCATION_ID,
130			'mainLanguageCode' => self::EXAMPLE_MAIN_LANGUAGE_CODE,
131			'ownerId' => self::EXAMPLE_OWNER_ID,
132			]),
133			'creatorId' => self::EXAMPLE_CREATOR_ID,
134			'initialLanguageCode' => self::EXAMPLE_INITIAL_LANGUAGE_CODE,
135			];
136
137			return [
138			[
139			new SPIVersionInfo(
140			$properties + [
141			'status' => 44,
142			]),
143			],
144			[
145			new SPIVersionInfo(
146			$properties + [
147			'status' => SPIVersionInfo::STATUS_DRAFT,
148			]
149			),
150			],
151			[
152			new SPIVersionInfo(
153			$properties + [
154			'status' => SPIVersionInfo::STATUS_PENDING,
155			]
156			),
157			],
158			[
159			new SPIVersionInfo(
160			$properties + [
161			'status' => SPIVersionInfo::STATUS_ARCHIVED,
162			'languageCodes' => ['eng-GB', 'nor-NB', 'fre-FR'],
163			]
164			),
165			],
166			[
167			new SPIVersionInfo(
168			$properties + [
169			'status' => SPIVersionInfo::STATUS_PUBLISHED,
170			]
171			),
172			],
173			];
174			}
175
176			public function providerForBuildLocationDomainObjectsOnSearchResult()
177			{
178			$properties = [
179			'contentTypeId' => self::EXAMPLE_CONTENT_TYPE_ID,
180			'sectionId' => self::EXAMPLE_SECTION_ID,
181			'mainLocationId' => self::EXAMPLE_MAIN_LOCATION_ID,
182			'mainLanguageCode' => self::EXAMPLE_MAIN_LANGUAGE_CODE,
183			'ownerId' => self::EXAMPLE_OWNER_ID,
184			];
185
186			$locationHits = [
187			new Location(['id' => 21, 'contentId' => 32, 'parentId' => 1]),
188			new Location(['id' => 22, 'contentId' => 33, 'parentId' => 1]),
189			];
190
191			return [
192			[
193			$locationHits,
194			[32, 33],
195			[],
196			[
197			32 => new ContentInfo($properties + ['id' => 32]),
198			33 => new ContentInfo($properties + ['id' => 33]),
199			],
200			0,
201			],
202			[
203			$locationHits,
204			[32, 33],
205			['languages' => ['eng-GB']],
206			[
207			32 => new ContentInfo($properties + ['id' => 32]),
208			],
209			1,
210			],
211			[
212			$locationHits,
213			[32, 33],
214			['languages' => ['eng-GB']],
215			[],
216			2,
217			],
218			];
219			}
220
221			/**
222			* @covers \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper::buildLocationDomainObjectsOnSearchResult
223			* @dataProvider providerForBuildLocationDomainObjectsOnSearchResult
224			*
225			* @param array $locationHits
226			* @param array $contentIds
227			* @param array $languageFilter
228			* @param array $contentInfoList
229			* @param int $missing
230			*/
231			public function testBuildLocationDomainObjectsOnSearchResult(
232			array $locationHits,
233			array $contentIds,
234			array $languageFilter,
235			array $contentInfoList,
236			int $missing
237			) {
238			$contentHandlerMock = $this->getContentHandlerMock();
239			$contentHandlerMock
240			->expects($this->once())
241			->method('loadContentInfoList')
242			->with($contentIds)
243			->willReturn($contentInfoList);
244
245			$result = new SearchResult(['totalCount' => 10]);
246			foreach ($locationHits as $locationHit) {
247			$result->searchHits[] = new SearchHit(['valueObject' => $locationHit]);
248			}
249
250			$spiResult = clone $result;
251			$missingLocations = $this->getContentDomainMapper()->buildLocationDomainObjectsOnSearchResult($result, $languageFilter);
252			$this->assertIsArray($missingLocations);
253
254			if (!$missing) {
255			$this->assertEmpty($missingLocations);
256			} else {
257			$this->assertNotEmpty($missingLocations);
258			}
259
260			$this->assertCount($missing, $missingLocations);
261			$this->assertEquals($spiResult->totalCount - $missing, $result->totalCount);
262			$this->assertCount(count($spiResult->searchHits) - $missing, $result->searchHits);
263			}
264
265			/**
266			* Returns ContentDomainMapper.
267			*
268			* @return \eZ\Publish\Core\Repository\Mapper\ContentDomainMapper
269			*/
270			protected function getContentDomainMapper(): ContentDomainMapper
271			{
272			return new ContentDomainMapper(
273			$this->getContentHandlerMock(),
274			$this->getPersistenceMockHandler('Content\\Location\\Handler'),
275			$this->getTypeHandlerMock(),
276			$this->getContentTypeDomainMapperMock(),
277			$this->getLanguageHandlerMock(),
278			$this->getFieldTypeRegistryMock(),
279			$this->getThumbnailStrategy(),
280			$this->getProxyFactoryMock()
281			);
282			}
283
284			/**
285			* @return \eZ\Publish\SPI\Persistence\Content\Handler\|\PHPUnit\Framework\MockObject\MockObject
286			*/
287			protected function getContentHandlerMock()
288			{
289			return $this->getPersistenceMockHandler('Content\\Handler');
290			}
291
292			/**
293			* @return \eZ\Publish\SPI\Persistence\Content\Language\Handler\|\PHPUnit\Framework\MockObject\MockObject
294			*/
295			protected function getLanguageHandlerMock()
296			{
297			return $this->getPersistenceMockHandler('Content\\Language\\Handler');
298			}
299
300			/**
301			* @return \eZ\Publish\SPI\Persistence\Content\Type\Handler\|\PHPUnit\Framework\MockObject\MockObject
302			*/
303			protected function getTypeHandlerMock()
304			{
305			return $this->getPersistenceMockHandler('Content\\Type\\Handler');
306			}
307
308			protected function getProxyFactoryMock(): ProxyDomainMapperInterface
309			{
310			return $this->createMock(ProxyDomainMapperInterface::class);
311			}
312			}
313

ezsystems / ezpublish-kernel

Push — ezp-30639-deprecated-view-acti... ( fa6552...a00a72 )

DomainMapperTest::getContentDomainMapper() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like