Completed
Push — master ( ae5e03...0447ee )
by Jeroen
10:35 queued 04:37
created

Tests/unit/Helper/Menu/SettingsMenuAdaptorTest.php (1 issue)

a method exists on all of the called types.

Bug Major

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Kunstmaan\AdminBundle\Tests\Helper\Menu;
4
5
use Kunstmaan\AdminBundle\Helper\Menu\MenuAdaptorInterface;
6
use Kunstmaan\AdminBundle\Helper\Menu\MenuBuilder;
7
use Kunstmaan\AdminBundle\Helper\Menu\MenuItem;
8
use Kunstmaan\AdminBundle\Helper\Menu\SettingsMenuAdaptor;
9
use Kunstmaan\AdminBundle\Helper\Menu\TopMenuItem;
10
use PHPUnit\Framework\TestCase;
11
use Symfony\Component\HttpFoundation\Request;
12
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
13
14
class SettingsMenuAdaptorTest extends TestCase
15
{
16
    /** @var AuthorizationCheckerInterface (mock) */
17
    private $authorizationCheckerInterface;
18
19
    /**
20
     * @var bool
21
     */
22
    private $isEnabledVersionChecker = true;
23
24
    public function setUp()
25
    {
26
        $this->authorizationCheckerInterface = $this->createMock(AuthorizationCheckerInterface::class);
27
    }
28
29
    /**
30
     * @dataProvider provider
31
     *
32
     * @param TopMenuItem|null $parent
33
     * @param string           $requestRoute
34
     * @param int              $expectedCount
35
     * @param string|null      $expectedLabel
36
     * @param bool             $granted
37
     */
38
    public function testAdaptChildren(?TopMenuItem $parent, string $requestRoute, int $expectedCount, ?string $expectedLabel, bool $granted)
39
    {
40
        $children = [];
41
        /** @var MenuBuilder $menuBuilderMock */
42
        $menuBuilderMock = $this->createMock(MenuBuilder::class);
43
        /** @var Request $request */
44
        $request = new Request([], [], ['_route' => $requestRoute]);
45
        $this->authorizationCheckerInterface
46
            ->expects($this->any())
47
            ->method('isGranted')
48
            ->willReturn($granted);
49
50
        $settingsMenuAdaptorMock = $this->setUpSettingsMenuAdaptorMock();
51
        $settingsMenuAdaptorMock->adaptChildren($menuBuilderMock, $children, $parent, $request);
0 ignored issues
show
The method adaptChildren does only exist in Kunstmaan\AdminBundle\He...enu\SettingsMenuAdaptor, but not in PHPUnit\Framework\MockObject\MockObject.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
52
53
        $this->assertCount($expectedCount, $children);
54
        $this->assertContainsOnlyInstancesOf(MenuItem::class, $children);
55
56
        if (null !== $expectedLabel) {
57
            $this->assertEquals($expectedLabel, $children[0]->getLabel());
58
        }
59
    }
60
61
    /**
62
     * @return \PHPUnit\Framework\MockObject\MockObject|SettingsMenuAdaptor
63
     */
64
    public function setUpSettingsMenuAdaptorMock()
65
    {
66
        $simpleMenuAdaptorMock = $this->getMockBuilder(SettingsMenuAdaptor::class)
67
            ->setConstructorArgs([$this->authorizationCheckerInterface, $this->isEnabledVersionChecker])
68
            ->setMethods(null)
69
            ->getMock()
70
        ;
71
72
        return $simpleMenuAdaptorMock;
73
    }
74
75
    public function testHasInterface()
76
    {
77
        $settingsMenuAdaptorMock = $this->setUpSettingsMenuAdaptorMock();
78
        $this->assertInstanceOf(MenuAdaptorInterface::class, $settingsMenuAdaptorMock);
79
    }
80
81
    public function provider()
82
    {
83
        /** @var TopMenuItem $parent */
84
        $parent = $this->createMock(TopMenuItem::class);
85
        $parent
86
            ->expects($this->any())
87
            ->method('getRoute')
88
            ->willReturn('KunstmaanAdminBundle_settings')
89
        ;
90
91
        /** @var TopMenuItem $parentWithOtherRoute */
92
        $parentWithOtherRoute = $this->createMock(TopMenuItem::class);
93
        $parentWithOtherRoute
94
            ->expects($this->any())
95
            ->method('getRoute')
96
            ->willReturn('KunstmaanAdminBundle_other')
97
        ;
98
99
        return [
100
            'with no parent and no route' => [null, 'KunstmaanAdminBundle_settings', 1, 'settings.title', true],
101
            'with parent and route is settings but not granted' => [$parent, 'kunstmaanadminbundle_admin_exception', 1, 'settings.exceptions.title', false],
102
            'with parent and route is settings and first active' => [$parent, 'KunstmaanAdminBundle_settings_bundle_version', 2, 'settings.version.bundle', true],
103
            'with parent and route is settings and second active' => [$parent, 'kunstmaanadminbundle_admin_exception', 2, 'settings.version.bundle', true],
104
            'with parent and route is not settings' => [$parentWithOtherRoute, '', 0, null, true],
105
        ];
106
    }
107
}
108