eZ\Publish\Core\Helper\Tests\PreviewLocationProviderTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	9	1
A	testGetPreviewLocationDraft()	0	28	1
A	testGetPreviewLocation()	0	30	1
A	testGetPreviewLocationNoLocation()	0	21	1
A	getContentMock()	0	20	1

<?php

/**
 * This file is part of the eZ Publish Kernel package.
 *
 * @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\Helper\Tests;

use eZ\Publish\API\Repository\ContentService;
use eZ\Publish\API\Repository\LocationService;
use eZ\Publish\API\Repository\Values\Content\ContentInfo as APIContentInfo;
use eZ\Publish\API\Repository\Values\Content\Location as APILocation;
use eZ\Publish\Core\Helper\PreviewLocationProvider;
use eZ\Publish\Core\Repository\Values\Content\Content;
use eZ\Publish\Core\Repository\Values\Content\Location;
use eZ\Publish\Core\Repository\Values\Content\VersionInfo;
use eZ\Publish\SPI\Persistence\Content\Location\Handler as SPILocationHandler;
use PHPUnit\Framework\TestCase;

class PreviewLocationProviderTest extends TestCase
{
    /** @var \eZ\Publish\API\Repository\LocationService|\PHPUnit\Framework\MockObject\MockObject */
    private $contentService;

    /** @var \eZ\Publish\API\Repository\LocationService|\PHPUnit\Framework\MockObject\MockObject */
    private $locationService;

    /** @var \eZ\Publish\SPI\Persistence\Content\Location\Handler|\PHPUnit\Framework\MockObject\MockObject */
    private $locationHandler;

    /** @var \eZ\Publish\Core\Helper\PreviewLocationProvider */
    private $provider;

    protected function setUp()
    {
        parent::setUp();

        $this->contentService = $this->createMock(ContentService::class);
        $this->locationService = $this->createMock(LocationService::class);
        $this->locationHandler = $this->createMock(SPILocationHandler::class);
        $this->provider = new PreviewLocationProvider($this->locationService, $this->contentService, $this->locationHandler);
    }

    public function testGetPreviewLocationDraft()
    {
        $contentId = 123;
        $parentLocationId = 456;
        $content = $this->getContentMock($contentId);

        $this->contentService
            ->expects($this->once())
            ->method('loadContent')
            ->with($contentId)
            ->willReturn($content);

        $this->locationService
            ->expects($this->never())
            ->method('loadLocation');

        $this->locationHandler
            ->expects($this->once())
            ->method('loadParentLocationsForDraftContent')
            ->with($contentId)
            ->will($this->returnValue([new Location(['id' => $parentLocationId])]));

        $location = $this->provider->loadMainLocation($contentId);

The method eZ\Publish\Core\Helper\PreviewLocationProvider::loadMainLocation() has been deprecated with message: Since 7.5.4, rather use {@see loadMainLocationByContent}.

        $this->assertInstanceOf(APILocation::class, $location);
        $this->assertSame($content, $location->content);
        $this->assertNull($location->id);
        $this->assertEquals($parentLocationId, $location->parentLocationId);
    }

    public function testGetPreviewLocation()
    {
        $contentId = 123;
        $locationId = 456;
        $content = $this->getContentMock($contentId, $locationId);

        $location = $this
            ->getMockBuilder(Location::class)
            ->setConstructorArgs([['id' => $locationId, 'content' => $content]])
            ->getMockForAbstractClass();

        $this->contentService
            ->expects($this->once())
            ->method('loadContent')
            ->with($contentId)
            ->willReturn($content);

        $this->locationService
            ->expects($this->once())
            ->method('loadLocation')
            ->with($locationId)
            ->will($this->returnValue($location));

        $this->locationHandler->expects($this->never())->method('loadParentLocationsForDraftContent');

        $returnedLocation = $this->provider->loadMainLocation($contentId);

The method eZ\Publish\Core\Helper\PreviewLocationProvider::loadMainLocation() has been deprecated with message: Since 7.5.4, rather use {@see loadMainLocationByContent}.

        $this->assertSame($location, $returnedLocation);
        $this->assertSame($content, $location->content);
        //$this->assertSame($contentInfo, $returnedLocation->contentInfo);
    }

    public function testGetPreviewLocationNoLocation()
    {
        $contentId = 123;
        $content = $this->getContentMock($contentId);

        $this->contentService
            ->expects($this->once())
            ->method('loadContent')
            ->with($contentId)
            ->willReturn($content);

        $this->locationHandler
            ->expects($this->once())
            ->method('loadParentLocationsForDraftContent')
            ->with($contentId)
            ->will($this->returnValue([]));

        $this->locationHandler->expects($this->never())->method('loadLocationsByContent');

        $this->assertNull($this->provider->loadMainLocation($contentId));

The method eZ\Publish\Core\Helper\PreviewLocationProvider::loadMainLocation() has been deprecated with message: Since 7.5.4, rather use {@see loadMainLocationByContent}.

    }

    private function getContentMock(int $contentId, ?int $mainLocationId = null, bool $published = false): Content
    {
        $contentInfo = new APIContentInfo([
            'id' => $contentId,
            'mainLocationId' => $mainLocationId,
            'published' => $published,
        ]);

        $versionInfo = $this->createMock(VersionInfo::class);
        $versionInfo->expects($this->once())
            ->method('getContentInfo')
            ->willReturn($contentInfo);

        $content = $this->createMock(Content::class);
        $content->expects($this->once())
            ->method('getVersionInfo')
            ->willReturn($versionInfo);

        return $content;
    }
}