ServiceTest::getLanguage() - Code Metrics - Inspection of "CS" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — reduce_cache_tags ( d6cc39...c3ce2a )

by André

created 2019-12-02 15:15 UTC

ServiceTest::getLanguage() A

↳ Parent: ServiceTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php

/**
 * File containing the ServiceTest 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\SignalSlot\Tests;

use eZ\Publish\API\Repository\Values\Content\Language;
use eZ\Publish\Core\Repository\Values\User\User;
use eZ\Publish\Core\Repository\Values\User\UserGroup;
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
use eZ\Publish\Core\Repository\Values\Content\VersionInfo;
use eZ\Publish\Core\Repository\Values\Content\Content;
use eZ\Publish\Core\SignalSlot\SignalDispatcher;
use PHPUnit\Framework\TestCase;

abstract class ServiceTest extends TestCase
{
    /**
     * Returns a mock of the aggregated service.
     */
    abstract protected function getServiceMock();

    /**
     * Returns an instance of the SignalSlot service to test.
     *
     * @param mixed $innerService mock of the inner service used by the signal
     * slot one used to test whether the original method is called is correctly
     * called.
     * @param \eZ\Publish\Core\SignalSlot\SignalDispatcher $dispatcher mock of
     * the dispatcher used to test whether the emit method is correctly called
     *
     * @return object An instance of the SignalSlot service
     */
    abstract protected function getSignalSlotService($innerService, SignalDispatcher $dispatcher);

    /**
     * @dataProvider serviceProvider
     *
     * Tests that:
     * - the original service method is called with the exact same arguments
     * - the signal is emitted with the correct signal object containing the
     *   expected attributes/values
     * - the returned value from the original service method is returned
     *   by the method from the signal slot service
     */
    public function testService(
        $method,
        $parameters,
        $return,
        $emitNr,
        $signalClass = '',
        array $signalAttr = null
    ) {
        $innerService = $this->getServiceMock();
        $innerService->expects($this->once())
                     ->method($method)
                     ->will(
                         $this->returnValueMap(
                             [
                                 array_merge($parameters, [$return]),
                             ]
                         )
                     );

        $dispatcher = $this->createMock(SignalDispatcher::class);
        $that = $this;
        $d = $dispatcher->expects($this->exactly($emitNr))
                        ->method('emit');
        if ($emitNr && $signalClass && $signalAttr) {
            $d->with(
                $this->callback(
                    function ($signal) use ($that, $signalClass, $signalAttr) {
                        if (!$signal instanceof $signalClass) {
                            $that->fail(
                                "The signal is not an instance of $signalClass"
                            );

                            return false;
                        }
                        foreach ($signalAttr as $attr => $val) {
                            if ($signal->{$attr} !== $val) {
                                $that->fail(
                                    "The attribute '{$attr}' of the signal does not have the correct value '{$val}'"
                                );

                                return false;
                            }
                        }

                        return true;
                    }
                )
            );
        }
        $service = $this->getSignalSlotService($innerService, $dispatcher);
        $result = call_user_func_array([$service, $method], $parameters);

        $this->assertTrue($result === $return);
    }

    /**
     * Creates a content info from $contentId and $remoteId.
     *
     * @param mixed $contentId
     * @param mixed $remoteId
     *
     * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
     */
    protected function getContentInfo($contentId, $remoteId)
    {
        return new ContentInfo(
            ['id' => $contentId, 'remoteId' => $remoteId]
        );
    }

    /**
     * Creates a version info object from $contentInfo and $versionNo.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
     * @param int $versionNo
     * @param string|null $languageCode
     *
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
     */
    protected function getVersionInfo(ContentInfo $contentInfo, int $versionNo, ?string $languageCode = null): VersionInfo
    {
        return new VersionInfo(
            [
                'contentInfo' => $contentInfo,
                'versionNo' => $versionNo,
                'initialLanguageCode' => $languageCode,
            ]
        );
    }

    /**
     * Creates a content object from $versionInfo.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Content
     */
    protected function getContent(VersionInfo $versionInfo)
    {
        return new Content(
            [
                'versionInfo' => $versionInfo,
                'internalFields' => [],
            ]
        );
    }

    /**
     * Creates a User object from $userId, $userRemoteId and $userVersionNo.
     *
     * @param mixed $userId
     * @param mixed $userRemoteId
     * @param int $userVersionNo
     *
     * @return \eZ\Publish\Core\Repository\Values\User\User
     */
    protected function getUser($userId, $userRemoteId, $userVersionNo)
    {
        return new User(
            [
                'content' => $this->getContent(
                    $this->getVersionInfo(
                        $this->getContentInfo($userId, $userRemoteId),
                        $userVersionNo
                    )
                ),
            ]
        );
    }

    /**
     * Returns a new UserGroup.
     *
     * @param mixed $groupId
     * @param mixed $groupRemoteId
     * @param int $groupVersioNo
     *
     * @return \eZ\Publish\Core\Repository\Values\User\UserGroup
     */
    protected function getUserGroup($groupId, $groupRemoteId, $groupVersioNo)
    {
        return new UserGroup(
            [
                'content' => $this->getContent(
                    $this->getVersionInfo(
                        $this->getContentInfo($groupId, $groupRemoteId),
                        $groupVersioNo
                    )
                ),
            ]
        );
    }

    protected function getLanguage(string $languageCode): Language
    {
        return new Language(
            [
                'languageCode' => $languageCode,
            ]
        );
    }
}


1			<?php
2
3			/**
4			* File containing the ServiceTest 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\SignalSlot\Tests;
10
11			use eZ\Publish\API\Repository\Values\Content\Language;
12			use eZ\Publish\Core\Repository\Values\User\User;
13			use eZ\Publish\Core\Repository\Values\User\UserGroup;
14			use eZ\Publish\API\Repository\Values\Content\ContentInfo;
15			use eZ\Publish\Core\Repository\Values\Content\VersionInfo;
16			use eZ\Publish\Core\Repository\Values\Content\Content;
17			use eZ\Publish\Core\SignalSlot\SignalDispatcher;
18			use PHPUnit\Framework\TestCase;
19
20			abstract class ServiceTest extends TestCase
21			{
22			/**
23			* Returns a mock of the aggregated service.
24			*/
25			abstract protected function getServiceMock();
26
27			/**
28			* Returns an instance of the SignalSlot service to test.
29			*
30			* @param mixed $innerService mock of the inner service used by the signal
31			* slot one used to test whether the original method is called is correctly
32			* called.
33			* @param \eZ\Publish\Core\SignalSlot\SignalDispatcher $dispatcher mock of
34			* the dispatcher used to test whether the emit method is correctly called
35			*
36			* @return object An instance of the SignalSlot service
37			*/
38			abstract protected function getSignalSlotService($innerService, SignalDispatcher $dispatcher);
39
40			/**
41			* @dataProvider serviceProvider
42			*
43			* Tests that:
44			* - the original service method is called with the exact same arguments
45			* - the signal is emitted with the correct signal object containing the
46			* expected attributes/values
47			* - the returned value from the original service method is returned
48			* by the method from the signal slot service
49			*/
50			public function testService(
51			$method,
52			$parameters,
53			$return,
54			$emitNr,
55			$signalClass = '',
56			array $signalAttr = null
57			) {
58			$innerService = $this->getServiceMock();
59			$innerService->expects($this->once())
60			->method($method)
61			->will(
62			$this->returnValueMap(
63			[
64			array_merge($parameters, [$return]),
65			]
66			)
67			);
68
69			$dispatcher = $this->createMock(SignalDispatcher::class);
70			$that = $this;
71			$d = $dispatcher->expects($this->exactly($emitNr))
72			->method('emit');
73			if ($emitNr && $signalClass && $signalAttr) {
74			$d->with(
75			$this->callback(
76			function ($signal) use ($that, $signalClass, $signalAttr) {
77			if (!$signal instanceof $signalClass) {
78			$that->fail(
79			"The signal is not an instance of $signalClass"
80			);
81
82			return false;
83			}
84			foreach ($signalAttr as $attr => $val) {
85			if ($signal->{$attr} !== $val) {
86			$that->fail(
87			"The attribute '{$attr}' of the signal does not have the correct value '{$val}'"
88			);
89
90			return false;
91			}
92			}
93
94			return true;
95			}
96			)
97			);
98			}
99			$service = $this->getSignalSlotService($innerService, $dispatcher);
100			$result = call_user_func_array([$service, $method], $parameters);
101
102			$this->assertTrue($result === $return);
103			}
104
105			/**
106			* Creates a content info from $contentId and $remoteId.
107			*
108			* @param mixed $contentId
109			* @param mixed $remoteId
110			*
111			* @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
112			*/
113			protected function getContentInfo($contentId, $remoteId)
114			{
115			return new ContentInfo(
116			['id' => $contentId, 'remoteId' => $remoteId]
117			);
118			}
119
120			/**
121			* Creates a version info object from $contentInfo and $versionNo.
122			*
123			* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
124			* @param int $versionNo
125			* @param string\|null $languageCode
126			*
127			* @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
128			*/
129			protected function getVersionInfo(ContentInfo $contentInfo, int $versionNo, ?string $languageCode = null): VersionInfo
130			{
131			return new VersionInfo(
132			[
133			'contentInfo' => $contentInfo,
134			'versionNo' => $versionNo,
135			'initialLanguageCode' => $languageCode,
136			]
137			);
138			}
139
140			/**
141			* Creates a content object from $versionInfo.
142			*
143			* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
144			*
145			* @return \eZ\Publish\API\Repository\Values\Content\Content
146			*/
147			protected function getContent(VersionInfo $versionInfo)
148			{
149			return new Content(
150			[
151			'versionInfo' => $versionInfo,
152			'internalFields' => [],
153			]
154			);
155			}
156
157			/**
158			* Creates a User object from $userId, $userRemoteId and $userVersionNo.
159			*
160			* @param mixed $userId
161			* @param mixed $userRemoteId
162			* @param int $userVersionNo
163			*
164			* @return \eZ\Publish\Core\Repository\Values\User\User
165			*/
166			protected function getUser($userId, $userRemoteId, $userVersionNo)
167			{
168			return new User(
169			[
170			'content' => $this->getContent(
171			$this->getVersionInfo(
172			$this->getContentInfo($userId, $userRemoteId),
173			$userVersionNo
174			)
175			),
176			]
177			);
178			}
179
180			/**
181			* Returns a new UserGroup.
182			*
183			* @param mixed $groupId
184			* @param mixed $groupRemoteId
185			* @param int $groupVersioNo
186			*
187			* @return \eZ\Publish\Core\Repository\Values\User\UserGroup
188			*/
189			protected function getUserGroup($groupId, $groupRemoteId, $groupVersioNo)
190			{
191			return new UserGroup(
192			[
193			'content' => $this->getContent(
194			$this->getVersionInfo(
195			$this->getContentInfo($groupId, $groupRemoteId),
196			$groupVersioNo
197			)
198			),
199			]
200			);
201			}
202
203			protected function getLanguage(string $languageCode): Language
204			{
205			return new Language(
206			[
207			'languageCode' => $languageCode,
208			]
209			);
210			}
211			}
212

ezsystems / ezpublish-kernel

Push — reduce_cache_tags ( d6cc39...c3ce2a )

ServiceTest::getLanguage() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like