JWTAuthenticatorTest::testGetsCredentialsTokenDoesNotExist() - Code Metrics - Inspection of "[WIP] Add custom authenticator for new Symfony aut..." - thecatontheflat/atlassian-connect-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#52)

by Matthieu

created 2021-07-01 12:42 UTC

xist() A

↳ Parent: JWTAuthenticatorTest::testAuthenticateHasNoClientKey()

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php declare(strict_types = 1);

namespace AtlassianConnectBundle\Tests\Security;

use AtlassianConnectBundle\Entity\Tenant;
use AtlassianConnectBundle\Security\JWTAuthenticator;
use AtlassianConnectBundle\Security\JWTSecurityHelperInterface;
use AtlassianConnectBundle\Security\JWTUserProvider;
use AtlassianConnectBundle\Security\JWTUserProviderInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;

/**
 * Class JWTAuthenticatorTest
 */
final class JWTAuthenticatorTest extends TestCase
{
    /**
     * @var JWTUserProviderInterface|MockObject
     */
    private $userProvider;

    /**
     * @var JWTSecurityHelperInterface|MockObject
     */
    private $securityHelper;

    /**
     * @var JWTAuthenticator
     */
    private $jwtAuthenticator;

    /**
     * Setup function
     */
    protected function setUp(): void
    {
        if (Kernel::VERSION_ID < 50200) {
            $this->markTestSkipped('This test only works with the new authenticator mechanism');
        }

        $this->userProvider = $this->createMock(JWTUserProvider::class);
        $this->securityHelper = $this->createMock(JWTSecurityHelperInterface::class);
        $this->jwtAuthenticator = new JWTAuthenticator(
            $this->userProvider,
            $this->securityHelper
        );
    }

    /**
     * Tests if the request is supported
     */
    public function testSupportsRequest(): void
    {
        $this->securityHelper
            ->expects($this->once())
            ->method('supportsRequest')
            ->with($request = new Request())
            ->willReturn(true);

        $this->assertTrue($this->jwtAuthenticator->supports($request));
    }

    /**
     * Test the authenticate method
     */
    public function testAuthenticate(): void
    {
        $token = [
            'sub' => 'username',
            'iss' => 'key',
        ];

        $this->securityHelper
            ->expects($this->once())
            ->method('getJWTToken')
            ->with($request = new Request())
            ->willReturn('token');

        $this->userProvider
            ->expects($this->once())
            ->method('getDecodedToken')
            ->with('token')
            ->willReturn((object) $token);

        $this->userProvider
            ->expects($this->once())
            ->method('loadUserByIdentifier')
            ->with('key')
            ->willReturn(new Tenant());

        $result = $this->jwtAuthenticator->authenticate($request);
        $this->assertEquals(
            new SelfValidatingPassport(new UserBadge('username')),
            $result
        );
    }

    /**
     * Test if an exception is thrown when no jwt token is present
     */
    public function testAuthenticateHasNoJWTToken(): void
    {
        $this->expectException(CustomUserMessageAuthenticationException::class);
        $this->expectExceptionMessage('JWT Token not provided');

        $this->securityHelper
            ->expects($this->once())
            ->method('getJWTToken')
            ->with($request = new Request())
            ->willReturn(null);

        $this->jwtAuthenticator->authenticate($request);
    }

    /**
     * Test if an exception is thrown when no client key is present
     */
    public function testAuthenticateHasNoClientKey(): void
    {
        $this->expectException(CustomUserMessageAuthenticationException::class);
        $this->expectExceptionMessage('API Key token does not exist');

        $token = [
            'sub' => 'username',
            'iss' => null,
        ];

        $this->securityHelper
            ->expects($this->once())
            ->method('getJWTToken')
            ->with($request = new Request())
            ->willReturn('token');

        $this->userProvider
            ->expects($this->once())
            ->method('getDecodedToken')
            ->with('token')
            ->willReturn((object) $token);

        $this->jwtAuthenticator->authenticate($request);
    }

    /**
     * test onAuthenticationFailure Method
     */
    public function testItSendsAResponseOnAuthenticationFailure(): void
    {
        $response = $this->jwtAuthenticator->onAuthenticationFailure(new Request(), new AuthenticationException('Error'));

        $this->assertEquals('Authentication Failed: Error', $response->getContent());
        $this->assertEquals(403, $response->getStatusCode());
    }

    /**
     * test onAuthenticationSuccess method
     */
    public function testItDoesNotSendAResponseOnAuthenticationSuccess(): void
    {
        $this->assertNull($this->jwtAuthenticator->onAuthenticationSuccess(new Request(), $this->createMock(TokenInterface::class), 'main'));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }
}


1			<?php declare(strict_types = 1);
2
3			namespace AtlassianConnectBundle\Tests\Security;
4
5			use AtlassianConnectBundle\Entity\Tenant;
6			use AtlassianConnectBundle\Security\JWTAuthenticator;
7			use AtlassianConnectBundle\Security\JWTSecurityHelperInterface;
8			use AtlassianConnectBundle\Security\JWTUserProvider;
9			use AtlassianConnectBundle\Security\JWTUserProviderInterface;
10			use PHPUnit\Framework\MockObject\MockObject;
11			use PHPUnit\Framework\TestCase;
12			use Symfony\Component\HttpFoundation\Request;
13			use Symfony\Component\HttpKernel\Kernel;
14			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
15			use Symfony\Component\Security\Core\Exception\AuthenticationException;
16			use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;
17			use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
18			use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
19
20			/**
21			* Class JWTAuthenticatorTest
22			*/
23			final class JWTAuthenticatorTest extends TestCase
24			{
25			/**
26			* @var JWTUserProviderInterface\|MockObject
27			*/
28			private $userProvider;
29
30			/**
31			* @var JWTSecurityHelperInterface\|MockObject
32			*/
33			private $securityHelper;
34
35			/**
36			* @var JWTAuthenticator
37			*/
38			private $jwtAuthenticator;
39
40			/**
41			* Setup function
42			*/
43			protected function setUp(): void
44			{
45			if (Kernel::VERSION_ID < 50200) {
46			$this->markTestSkipped('This test only works with the new authenticator mechanism');
47			}
48
49			$this->userProvider = $this->createMock(JWTUserProvider::class);
50			$this->securityHelper = $this->createMock(JWTSecurityHelperInterface::class);
51			$this->jwtAuthenticator = new JWTAuthenticator(
52			$this->userProvider,
53			$this->securityHelper
54			);
55			}
56
57			/**
58			* Tests if the request is supported
59			*/
60			public function testSupportsRequest(): void
61			{
62			$this->securityHelper
63			->expects($this->once())
64			->method('supportsRequest')
65			->with($request = new Request())
66			->willReturn(true);
67
68			$this->assertTrue($this->jwtAuthenticator->supports($request));
69			}
70
71			/**
72			* Test the authenticate method
73			*/
74			public function testAuthenticate(): void
75			{
76			$token = [
77			'sub' => 'username',
78			'iss' => 'key',
79			];
80
81			$this->securityHelper
82			->expects($this->once())
83			->method('getJWTToken')
84			->with($request = new Request())
85			->willReturn('token');
86
87			$this->userProvider
88			->expects($this->once())
89			->method('getDecodedToken')
90			->with('token')
91			->willReturn((object) $token);
92
93			$this->userProvider
94			->expects($this->once())
95			->method('loadUserByIdentifier')
96			->with('key')
97			->willReturn(new Tenant());
98
99			$result = $this->jwtAuthenticator->authenticate($request);
100			$this->assertEquals(
101			new SelfValidatingPassport(new UserBadge('username')),
102			$result
103			);
104			}
105
106			/**
107			* Test if an exception is thrown when no jwt token is present
108			*/
109			public function testAuthenticateHasNoJWTToken(): void
110			{
111			$this->expectException(CustomUserMessageAuthenticationException::class);
112			$this->expectExceptionMessage('JWT Token not provided');
113
114			$this->securityHelper
115			->expects($this->once())
116			->method('getJWTToken')
117			->with($request = new Request())
118			->willReturn(null);
119
120			$this->jwtAuthenticator->authenticate($request);
121			}
122
123			/**
124			* Test if an exception is thrown when no client key is present
125			*/
126			public function testAuthenticateHasNoClientKey(): void
127			{
128			$this->expectException(CustomUserMessageAuthenticationException::class);
129			$this->expectExceptionMessage('API Key token does not exist');
130
131			$token = [
132			'sub' => 'username',
133			'iss' => null,
134			];
135
136			$this->securityHelper
137			->expects($this->once())
138			->method('getJWTToken')
139			->with($request = new Request())
140			->willReturn('token');
141
142			$this->userProvider
143			->expects($this->once())
144			->method('getDecodedToken')
145			->with('token')
146			->willReturn((object) $token);
147
148			$this->jwtAuthenticator->authenticate($request);
149			}
150
151			/**
152			* test onAuthenticationFailure Method
153			*/
154			public function testItSendsAResponseOnAuthenticationFailure(): void
155			{
156			$response = $this->jwtAuthenticator->onAuthenticationFailure(new Request(), new AuthenticationException('Error'));
157
158			$this->assertEquals('Authentication Failed: Error', $response->getContent());
159			$this->assertEquals(403, $response->getStatusCode());
160			}
161
162			/**
163			* test onAuthenticationSuccess method
164			*/
165			public function testItDoesNotSendAResponseOnAuthenticationSuccess(): void
166			{
167			$this->assertNull($this->jwtAuthenticator->onAuthenticationSuccess(new Request(), $this->createMock(TokenInterface::class), 'main'));
			0 ignored issues – show Bug introduced 2019-05-06 11:57 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->jwtAuthenticator-...erface::class), 'main')` targeting `AtlassianConnectBundle\S...AuthenticationSuccess()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
168			}
169			}
170

thecatontheflat / atlassian-connect-bundle

Pull Request — master (#52)

xist() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like