Passed
Push — master ( 2e1e94...ef92a5 )
by Gerrit
02:12
created

shouldRenderTemplate()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 12
rs 9.8666
c 0
b 0
f 0
cc 1
nc 1
nop 0
1
<?php
2
/**
3
 * Copyright (C) 2017  Gerrit Addiks.
4
 * This package (including this file) was released under the terms of the GPL-3.0.
5
 * You should have received a copy of the GNU General Public License along with this program.
6
 * If not, see <http://www.gnu.org/licenses/> or send me a mail so i can send you a copy.
7
 * @license GPL-3.0
8
 * @author Gerrit Addiks <[email protected]>
9
 */
10
11
namespace Addiks\SymfonyGenerics\Tests\Unit\Controllers;
12
13
use PHPUnit\Framework\TestCase;
14
use Addiks\SymfonyGenerics\Controllers\DefaultControllerHelper;
15
use Doctrine\ORM\EntityManagerInterface;
16
use Twig_Environment;
17
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
18
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
19
use Symfony\Component\HttpFoundation\Session\Session;
20
use Psr\Log\LoggerInterface;
21
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
22
use stdClass;
23
use Symfony\Component\HttpFoundation\RedirectResponse;
24
use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
25
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
26
use Symfony\Component\HttpFoundation\RequestStack;
27
use Symfony\Component\HttpFoundation\Response;
28
use Doctrine\Common\Persistence\ObjectRepository;
29
30
final class DefaultControllerHelperTest extends TestCase
31
{
32
33
    /**
34
     * @var DefaultControllerHelper
35
     */
36
    private $controllerHelper;
37
38
    /**
39
     * @var EntityManagerInterface
40
     */
41
    private $entityManager;
42
43
    /**
44
     * @var Twig_Environment
45
     */
46
    private $twig;
47
48
    /**
49
     * @var AuthorizationCheckerInterface
50
     */
51
    private $authorization;
52
53
    /**
54
     * @var UrlGeneratorInterface
55
     */
56
    private $urlGenerator;
57
58
    /**
59
     * @var Session
60
     */
61
    private $session;
62
63
    /**
64
     * @var LoggerInterface
65
     */
66
    private $logger;
67
68
    /**
69
     * @var EventDispatcherInterface
70
     */
71
    private $eventDispatcher;
72
73
    /**
74
     * @var RequestStack
75
     */
76
    private $requestStack;
77
78
    public function setUp()
79
    {
80
        $this->entityManager = $this->createMock(EntityManagerInterface::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Doctr...anagerInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Doctrine\ORM\EntityManagerInterface> of property $entityManager.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
81
        $this->twig = $this->createMock(Twig_Environment::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Twig_Environment::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Twig_Environment> of property $twig.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
82
        $this->authorization = $this->createMock(AuthorizationCheckerInterface::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Symfo...heckerInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component...zationCheckerInterface> of property $authorization.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
83
        $this->urlGenerator = $this->createMock(UrlGeneratorInterface::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Symfo...eratorInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component...\UrlGeneratorInterface> of property $urlGenerator.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
84
        $this->session = $this->createMock(Session::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Symfo...Session\Session::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component...dation\Session\Session> of property $session.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
85
        $this->logger = $this->createMock(LoggerInterface::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Psr\L...LoggerInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Psr\Log\LoggerInterface> of property $logger.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
86
        $this->eventDispatcher = $this->createMock(EventDispatcherInterface::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Symfo...atcherInterface::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component...entDispatcherInterface> of property $eventDispatcher.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
87
        $this->requestStack = $this->createMock(RequestStack::class);
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->createMock(\Symfo...on\RequestStack::class) of type object<PHPUnit\Framework\MockObject\MockObject> is incompatible with the declared type object<Symfony\Component...oundation\RequestStack> of property $requestStack.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
88
89
        $this->controllerHelper = new DefaultControllerHelper(
90
            $this->entityManager,
0 ignored issues
show
Documentation introduced by
$this->entityManager is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Doctrine\ORM\EntityManagerInterface>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
91
            $this->twig,
0 ignored issues
show
Documentation introduced by
$this->twig is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Twig_Environment>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
92
            $this->authorization,
0 ignored issues
show
Documentation introduced by
$this->authorization is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Symfony\Component...zationCheckerInterface>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
93
            $this->urlGenerator,
0 ignored issues
show
Documentation introduced by
$this->urlGenerator is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Symfony\Component...\UrlGeneratorInterface>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
94
            $this->session,
0 ignored issues
show
Documentation introduced by
$this->session is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Symfony\Component...dation\Session\Session>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
95
            $this->logger,
0 ignored issues
show
Documentation introduced by
$this->logger is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Psr\Log\LoggerInterface>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
96
            $this->eventDispatcher,
0 ignored issues
show
Documentation introduced by
$this->eventDispatcher is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Symfony\Component...entDispatcherInterface>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
97
            $this->requestStack
0 ignored issues
show
Documentation introduced by
$this->requestStack is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<Symfony\Component...oundation\RequestStack>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
98
        );
99
    }
100
101
    /**
102
     * @test
103
     */
104
    public function shouldRenderTemplate()
105
    {
106
        $this->twig->expects($this->once())->method('render')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Twig_Environment>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
107
            $this->equalTo('some-template'),
108
            $this->equalTo(['foo', 'bar'])
109
        )->willReturn('some-response');
110
111
        /** @var Response $actualResult */
112
        $actualResult = $this->controllerHelper->renderTemplate('some-template', ['foo', 'bar']);
113
114
        $this->assertEquals(new Response('some-response'), $actualResult);
115
    }
116
117
    /**
118
     * @test
119
     */
120
    public function shouldFindEntity()
121
    {
122
        $this->entityManager->expects($this->once())->method('find')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Doctrine\ORM\EntityManagerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
123
            $this->equalTo('some-class'),
124
            $this->equalTo('foo')
125
        )->willReturn('some-entity');
126
127
        /** @var mixed $actualResult */
128
        $actualResult = $this->controllerHelper->findEntity('some-class', 'foo');
129
130
        $this->assertEquals('some-entity', $actualResult);
131
    }
132
133
    /**
134
     * @test
135
     */
136
    public function shouldFindEntities()
137
    {
138
        /** @var ObjectRepository $repository */
139
        $repository = $this->createMock(ObjectRepository::class);
140
        $repository->method('findBy')->with(
141
            $this->equalTo(['foo' => 'bar'])
142
        )->willReturn(['some-entity', 'some-other-entity']);
143
144
        $this->entityManager->expects($this->once())->method('getRepository')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Doctrine\ORM\EntityManagerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
145
            $this->equalTo('some-class')
146
        )->willReturn($repository);
147
148
        /** @var mixed $actualResult */
149
        $actualResult = $this->controllerHelper->findEntities('some-class', ['foo' => 'bar']);
150
151
        $this->assertEquals(['some-entity', 'some-other-entity'], $actualResult);
152
    }
153
154
    /**
155
     * @test
156
     */
157 View Code Duplication
    public function shouldPersistEntity()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
158
    {
159
        /** @var stdClass $entity */
160
        $entity = $this->createMock(stdClass::class);
161
162
        $this->entityManager->expects($this->once())->method('persist')->with($this->identicalTo($entity));
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Doctrine\ORM\EntityManagerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
163
164
        $this->controllerHelper->persistEntity($entity);
165
    }
166
167
    /**
168
     * @test
169
     */
170 View Code Duplication
    public function shouldRemoveEntity()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
171
    {
172
        /** @var stdClass $entity */
173
        $entity = $this->createMock(stdClass::class);
174
175
        $this->entityManager->expects($this->once())->method('remove')->with($this->identicalTo($entity));
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Doctrine\ORM\EntityManagerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
176
177
        $this->controllerHelper->removeEntity($entity);
178
    }
179
180
    /**
181
     * @test
182
     */
183
    public function shouldFlushORM()
184
    {
185
        $this->entityManager->expects($this->once())->method('flush');
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Doctrine\ORM\EntityManagerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
186
        $this->controllerHelper->flushORM();
187
    }
188
189
    /**
190
     * @test
191
     */
192 View Code Duplication
    public function shouldHandleException()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
193
    {
194
        /** @var Exception $exception */
195
        $exception = $this->createMock('Exception');
196
        $exception->method('__toString')->willReturn("some-string");
197
198
        $this->logger->expects($this->once())->method('log')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Psr\Log\LoggerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
199
            $this->equalTo('error'),
200
            $this->identicalTo('some-string')
201
        );
202
203
        $this->controllerHelper->handleException($exception);
204
    }
205
206
    /**
207
     * @test
208
     */
209 View Code Duplication
    public function shouldAddFlashMessage()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
210
    {
211
        /** @var FlashBagInterface $flashBag */
212
        $flashBag = $this->createMock(FlashBagInterface::class);
213
        $flashBag->expects($this->once())->method('add')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Symfony\Component...lash\FlashBagInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
214
            $this->equalTo('some-type'),
215
            $this->equalTo("Lorem ipsum dolor sit amet!")
216
        );
217
218
        $this->session->method('getFlashBag')->willReturn($flashBag);
0 ignored issues
show
Bug introduced by
The method method() does not seem to exist on object<Symfony\Component...dation\Session\Session>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
219
220
        $this->controllerHelper->addFlashMessage("Lorem ipsum dolor sit amet!", "some-type");
221
    }
222
223
    /**
224
     * @test
225
     */
226 View Code Duplication
    public function shouldUseDefaultCodeWhenRedirectingToRoute()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
227
    {
228
        $this->urlGenerator->expects($this->once())->method('generate')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Symfony\Component...\UrlGeneratorInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
229
            $this->equalTo('some_route'),
230
            $this->equalTo(['foo' => 'bar']),
231
            $this->equalTo(UrlGeneratorInterface::ABSOLUTE_URL)
232
        )->willReturn("*this-is-some-url*");
233
234
        $expectedResponse = new RedirectResponse("*this-is-some-url*", 301);
235
236
        /** @var RedirectResponse $actualResponse */
237
        $actualResponse = $this->controllerHelper->redirectToRoute("some_route", ['foo' => 'bar']);
238
239
        $this->assertEquals($expectedResponse, $actualResponse);
240
    }
241
242
    /**
243
     * @test
244
     */
245 View Code Duplication
    public function shouldRedirectToRoute()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
246
    {
247
        $this->urlGenerator->expects($this->once())->method('generate')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Symfony\Component...\UrlGeneratorInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
248
            $this->equalTo('some_route'),
249
            $this->equalTo(['foo' => 'bar']),
250
            $this->equalTo(UrlGeneratorInterface::ABSOLUTE_URL)
251
        )->willReturn("*this-is-some-url*");
252
253
        $expectedResponse = new RedirectResponse("*this-is-some-url*", 302);
254
255
        /** @var RedirectResponse $actualResponse */
256
        $actualResponse = $this->controllerHelper->redirectToRoute("some_route", ['foo' => 'bar'], 302);
257
258
        $this->assertEquals($expectedResponse, $actualResponse);
259
    }
260
261
    /**
262
     * @test
263
     */
264
    public function shouldDenyAccessUnlessGranted()
265
    {
266
        $this->expectException(AccessDeniedException::class);
267
268
        /** @var stdClass $subject */
269
        $subject = $this->createMock(stdClass::class);
270
271
        $this->authorization->expects($this->once())->method('isGranted')->with(
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Symfony\Component...zationCheckerInterface>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
272
            $this->equalTo("foo"),
273
            $this->equalTo($subject)
274
        )->willReturn(false);
275
276
        try {
277
            $this->controllerHelper->denyAccessUnlessGranted("foo", $subject);
278
279
        } catch (AccessDeniedException $exception) {
280
            $this->assertEquals(["foo"], $exception->getAttributes());
281
            $this->assertSame($subject, $exception->getSubject());
282
283
            throw $exception;
284
        }
285
    }
286
287
}
288