GenericEntityListingControllerTest::shouldThrowExceptionWhenEntityClassIsMissing() - Code Metrics - Inspection of "added entity-listing-controller;" - addiks/symfony_generics - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a8c688...026476 )

by Gerrit

created 2018-11-06 20:42 UTC

shouldThrowExceptionWhenEntityClassIsMissing() A

↳ Parent: GenericEntityListingControllerTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Copyright (C) 2017  Gerrit Addiks.
 * This package (including this file) was released under the terms of the GPL-3.0.
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <http://www.gnu.org/licenses/> or send me a mail so i can send you a copy.
 * @license GPL-3.0
 * @author Gerrit Addiks <[email protected]>
 */

namespace Addiks\SymfonyGenerics\Tests\Unit\Controllers;

use PHPUnit\Framework\TestCase;
use Addiks\SymfonyGenerics\Controllers\GenericEntityListingController;
use Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface;
use InvalidArgumentException;
use Addiks\SymfonyGenerics\Tests\Unit\Controllers\SampleEntity;
use Addiks\SymfonyGenerics\Services\ArgumentCompilerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\File\Exception\AccessDeniedException;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use ErrorException;

final class GenericEntityListingControllerTest extends TestCase
{

    /**
     * @var GenericEntityListingController
     */
    private $controller;

    /**
     * @var ControllerHelperInterface
     */
    private $controllerHelper;

    /**
     * @var ArgumentCompilerInterface
     */
    private $argumentCompiler;

    public function setUp()
    {
        $this->controllerHelper = $this->createMock(ControllerHelperInterface::class);

        $this->argumentCompiler = $this->createMock(ArgumentCompilerInterface::class);

    }

    /**
     * @test
     */
    public function shouldPreventControllerBeingCalledAgain()

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
            'entity-class' => SampleEntity::class
        ]);

        $controller->__construct($this->controllerHelper, $this->argumentCompiler, [
            'entity-class' => SampleEntity::class
        ]);
    }

    /**
     * @test
     */
    public function shouldThrowExceptionWhenEntityClassIsMissing()
    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        ]);
    }

    /**
     * @test
     */
    public function shouldThrowExceptionWhenEntityClassIsInvalid()

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            'entity-class' => "DoesNotExist"
        ]);
    }

    /**
     * @test
     */
    public function shouldThrowExceptionOnInvalidNormalizer()

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            'entity-class' => SampleEntity::class,
            'normalizer' => false
        ]);
    }

    /**
     * @test
     */
    public function shouldThrowExceptionOnInvalidEncoder()

    {
        $this->expectException(InvalidArgumentException::class);

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            'entity-class' => SampleEntity::class,
            'encoder' => false
        ]);
    }

    /**
     * @test
     */
    public function shouldListEntities()
    {
        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var string $expectedResponseContent */
        $expectedResponseContent = '[{"lorem":false,"ipsum":"foo"},{"lorem":false,"ipsum":"foo"}]';

        /** @var SampleEntity $entityA */
        $entityA = $this->createMock(SampleEntity::class);

        /** @var SampleEntity $entityB */
        $entityB = $this->createMock(SampleEntity::class);

        $this->controllerHelper->expects($this->once())->method('findEntities')->with(

            $this->equalTo(SampleEntity::class),
            $this->equalTo(['blah' => 'blubb'])
        )->willReturn([$entityA, $entityB]);

        $this->argumentCompiler->expects($this->once())->method('buildRouteArguments')->with(

            $this->equalTo(['foo' => 'bar']),
            $this->identicalTo($request)
        )->willReturn(['blah' => 'blubb']);

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
            'entity-class' => SampleEntity::class,
            'data-template' => [
                'lorem' => 'fooCalled',
                'ipsum' => 'constructArgument'
            ],
            'criteria' => [
                'foo' => 'bar'
            ]
        ]);

        /** @var Response $actualResponse */
        $actualResponse = $controller->listEntities($request);

        $this->assertEquals($expectedResponseContent, $actualResponse->getContent());
    }

    /**
     * @test
     */
    public function shouldThrowExceptionIfNormalizerReturnsNonArray()
    {
        $this->expectException(ErrorException::class);

        /** @var Request $request */
        $request = $this->createMock(Request::class);

        /** @var SampleEntity $entity */
        $entity = $this->createMock(SampleEntity::class);

        $this->controllerHelper->expects($this->once())->method('findEntities')->with(

            $this->equalTo(SampleEntity::class),
            $this->equalTo([])
        )->willReturn([$entity]);

        /** @var NormalizerInterface $normalizer */
        $normalizer = $this->createMock(NormalizerInterface::class);
        $normalizer->expects($this->once())->method('normalize')->with(

            $this->identicalTo($entity)
        )->willReturn("*non-array*");

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
            'entity-class' => SampleEntity::class,
            'normalizer' => $normalizer,
        ]);

        $controller->listEntities($request);
    }

    /**
     * @test
     */
    public function shouldCheckIfAccessIsGranted()

    {
        /** @var Request $request */
        $request = $this->createMock(Request::class);

        $this->expectException(AccessDeniedException::class);

        $this->controllerHelper->expects($this->once())->method('denyAccessUnlessGranted')->with(

            $this->equalTo('some-attribute'),
            $this->identicalTo($request)
        )->will($this->returnCallback(
            function () {
                throw new AccessDeniedException('Lorem ipsum!');
            }
        ));

        $controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
            'entity-class' => SampleEntity::class,
            'authorization-attribute' => 'some-attribute',
        ]);

        $controller->listEntities($request);
    }

}


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\GenericEntityListingController;
15		use Addiks\SymfonyGenerics\Controllers\ControllerHelperInterface;
16		use InvalidArgumentException;
17		use Addiks\SymfonyGenerics\Tests\Unit\Controllers\SampleEntity;
18		use Addiks\SymfonyGenerics\Services\ArgumentCompilerInterface;
19		use Symfony\Component\HttpFoundation\Request;
20		use Symfony\Component\HttpFoundation\Response;
21		use Symfony\Component\HttpFoundation\File\Exception\AccessDeniedException;
22		use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
23		use ErrorException;
24
25		final class GenericEntityListingControllerTest extends TestCase
26		{
27
28		/**
29		* @var GenericEntityListingController
30		*/
31		private $controller;
32
33		/**
34		* @var ControllerHelperInterface
35		*/
36		private $controllerHelper;
37
38		/**
39		* @var ArgumentCompilerInterface
40		*/
41		private $argumentCompiler;
42
43		public function setUp()
44		{
45		$this->controllerHelper = $this->createMock(ControllerHelperInterface::class);
		0 ignored issues – show Documentation Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report It seems like `$this->createMock(\Addik...HelperInterface::class)` of type `object<PHPUnit\Framework\MockObject\MockObject>` is incompatible with the declared type `object<Addiks\SymfonyGen...trollerHelperInterface>` of property `$controllerHelper`. 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...
46		$this->argumentCompiler = $this->createMock(ArgumentCompilerInterface::class);
		0 ignored issues – show Documentation Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report It seems like `$this->createMock(\Addik...mpilerInterface::class)` of type `object<PHPUnit\Framework\MockObject\MockObject>` is incompatible with the declared type `object<Addiks\SymfonyGen...umentCompilerInterface>` of property `$argumentCompiler`. 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...
47		}
48
49		/**
50		* @test
51		*/
52	View Code Duplication	public function shouldPreventControllerBeingCalledAgain()
		0 ignored issues – show Duplication introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report 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...
53		{
54		$this->expectException(InvalidArgumentException::class);
55
56		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
57		'entity-class' => SampleEntity::class
58		]);
59
60		$controller->__construct($this->controllerHelper, $this->argumentCompiler, [
61		'entity-class' => SampleEntity::class
62		]);
63		}
64
65		/**
66		* @test
67		*/
68		public function shouldThrowExceptionWhenEntityClassIsMissing()
69		{
70		$this->expectException(InvalidArgumentException::class);
71
72		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
		0 ignored issues – show Unused Code introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report `$controller` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
73		]);
74		}
75
76		/**
77		* @test
78		*/
79	View Code Duplication	public function shouldThrowExceptionWhenEntityClassIsInvalid()
		0 ignored issues – show Duplication introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report 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...
80		{
81		$this->expectException(InvalidArgumentException::class);
82
83		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
		0 ignored issues – show Unused Code introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report `$controller` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
84		'entity-class' => "DoesNotExist"
85		]);
86		}
87
88		/**
89		* @test
90		*/
91	View Code Duplication	public function shouldThrowExceptionOnInvalidNormalizer()
		0 ignored issues – show Duplication introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report 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...
92		{
93		$this->expectException(InvalidArgumentException::class);
94
95		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
		0 ignored issues – show Unused Code introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report `$controller` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
96		'entity-class' => SampleEntity::class,
97		'normalizer' => false
98		]);
99		}
100
101		/**
102		* @test
103		*/
104	View Code Duplication	public function shouldThrowExceptionOnInvalidEncoder()
		0 ignored issues – show Duplication introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report 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...
105		{
106		$this->expectException(InvalidArgumentException::class);
107
108		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
		0 ignored issues – show Unused Code introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report `$controller` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
109		'entity-class' => SampleEntity::class,
110		'encoder' => false
111		]);
112		}
113
114		/**
115		* @test
116		*/
117		public function shouldListEntities()
118		{
119		/** @var Request $request */
120		$request = $this->createMock(Request::class);
121
122		/** @var string $expectedResponseContent */
123		$expectedResponseContent = '[{"lorem":false,"ipsum":"foo"},{"lorem":false,"ipsum":"foo"}]';
124
125		/** @var SampleEntity $entityA */
126		$entityA = $this->createMock(SampleEntity::class);
127
128		/** @var SampleEntity $entityB */
129		$entityB = $this->createMock(SampleEntity::class);
130
131		$this->controllerHelper->expects($this->once())->method('findEntities')->with(
		0 ignored issues – show Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Addiks\SymfonyGen...trollerHelperInterface>`. 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...
132		$this->equalTo(SampleEntity::class),
133		$this->equalTo(['blah' => 'blubb'])
134		)->willReturn([$entityA, $entityB]);
135
136		$this->argumentCompiler->expects($this->once())->method('buildRouteArguments')->with(
		0 ignored issues – show Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Addiks\SymfonyGen...umentCompilerInterface>`. 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...
137		$this->equalTo(['foo' => 'bar']),
138		$this->identicalTo($request)
139		)->willReturn(['blah' => 'blubb']);
140
141		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
142		'entity-class' => SampleEntity::class,
143		'data-template' => [
144		'lorem' => 'fooCalled',
145		'ipsum' => 'constructArgument'
146		],
147		'criteria' => [
148		'foo' => 'bar'
149		]
150		]);
151
152		/** @var Response $actualResponse */
153		$actualResponse = $controller->listEntities($request);
154
155		$this->assertEquals($expectedResponseContent, $actualResponse->getContent());
156		}
157
158		/**
159		* @test
160		*/
161		public function shouldThrowExceptionIfNormalizerReturnsNonArray()
162		{
163		$this->expectException(ErrorException::class);
164
165		/** @var Request $request */
166		$request = $this->createMock(Request::class);
167
168		/** @var SampleEntity $entity */
169		$entity = $this->createMock(SampleEntity::class);
170
171		$this->controllerHelper->expects($this->once())->method('findEntities')->with(
		0 ignored issues – show Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Addiks\SymfonyGen...trollerHelperInterface>`. 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...
172		$this->equalTo(SampleEntity::class),
173		$this->equalTo([])
174		)->willReturn([$entity]);
175
176		/** @var NormalizerInterface $normalizer */
177		$normalizer = $this->createMock(NormalizerInterface::class);
178		$normalizer->expects($this->once())->method('normalize')->with(
		0 ignored issues – show Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Symfony\Component...er\NormalizerInterface>`. 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...
179		$this->identicalTo($entity)
180		)->willReturn("non-array");
181
182		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
183		'entity-class' => SampleEntity::class,
184		'normalizer' => $normalizer,
185		]);
186
187		$controller->listEntities($request);
188		}
189
190		/**
191		* @test
192		*/
193	View Code Duplication	public function shouldCheckIfAccessIsGranted()
		0 ignored issues – show Duplication introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report 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...
194		{
195		/** @var Request $request */
196		$request = $this->createMock(Request::class);
197
198		$this->expectException(AccessDeniedException::class);
199
200		$this->controllerHelper->expects($this->once())->method('denyAccessUnlessGranted')->with(
		0 ignored issues – show Bug introduced 2018-11-06 21:31 UTC by Report Bug Copy Issue Report The method `expects()` does not seem to exist on `object<Addiks\SymfonyGen...trollerHelperInterface>`. 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...
201		$this->equalTo('some-attribute'),
202		$this->identicalTo($request)
203		)->will($this->returnCallback(
204		function () {
205		throw new AccessDeniedException('Lorem ipsum!');
206		}
207		));
208
209		$controller = new GenericEntityListingController($this->controllerHelper, $this->argumentCompiler, [
210		'entity-class' => SampleEntity::class,
211		'authorization-attribute' => 'some-attribute',
212		]);
213
214		$controller->listEntities($request);
215		}
216
217		}
218

addiks / symfony_generics

Push — master ( a8c688...026476 )

shouldThrowExceptionWhenEntityClassIsMissing() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like