AccessTokenTest::testPersistNewAccessTokenWithScopesDbFailureThrowsException() - Code Metrics - abterphp/admin - Measure and Improve Code Quality continuously with Scrutinizer

testPersistNewAccessTokenWithScopesDbFailureThrowsException() A
last analyzed 2023-01-23 22:21 UTC

↳ Parent: AccessTokenTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	59
Code Lines	43
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	43
c	0
b	0
f	0
dl	0
loc	59
rs	9.232
cc	1
nc	1
nop	0
How to fix Long Method

<?php

declare(strict_types=1);

namespace AbterPhp\Admin\Oauth2\Repository;

use AbterPhp\Admin\Exception\Database;
use AbterPhp\Admin\Oauth2\Entity\AccessToken as Entity;
use AbterPhp\Framework\TestCase\Database\QueryTestCase;
use AbterPhp\Framework\TestDouble\Database\MockStatementFactory;
use League\OAuth2\Server\Entities\AccessTokenEntityInterface;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Entities\ScopeEntityInterface;
use Opulence\Orm\Ids\Generators\UuidV4Generator;
use PHPUnit\Framework\MockObject\MockObject;

class AccessTokenTest extends QueryTestCase
{
    /** @var AccessToken - System Under Test */
    protected $sut;

    /** @var UuidV4Generator|MockObject */
    protected $uuidGeneratorMock;

    public function setUp(): void
    {
        parent::setUp();

        $this->uuidGeneratorMock = $this->createMock(UuidV4Generator::class);

        $this->sut = new AccessToken($this->uuidGeneratorMock, $this->connectionPoolMock);
    }

    public function testGetNewToken()
    {
        /** @var ClientEntityInterface|MockObject $clientEntityStub */
        $clientEntityStub = $this->createMock(ClientEntityInterface::class);

        $scopes         = [];
        $userIdentifier = null;

        $actualResult = $this->sut->getNewToken($clientEntityStub, $scopes, $userIdentifier);

        $this->assertInstanceOf(Entity::class, $actualResult);
    }

    public function testPersistNewAccessToken()
    {
        $tokenId    = 'foo';
        $clientName = 'bar';
        $expiresAt  = new \DateTime();

        $accessTokenEntityMock = $this->createAccessTokenStub($tokenId, $clientName, $expiresAt, []);

        $sql0          = 'INSERT INTO tokens (id, api_client_id, expires_at) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind0 = [
            [$tokenId, \PDO::PARAM_STR],
            [$clientName, \PDO::PARAM_STR],
            [$expiresAt->format('Y-m-d H:i:s'), \PDO::PARAM_STR],
        ];
        $statement0    = MockStatementFactory::createWriteStatement($this, $valuesToBind0);

        $this->writeConnectionMock
            ->expects($this->exactly(1))
            ->method('prepare')
            ->withConsecutive([$sql0])
            ->willReturnOnConsecutiveCalls($statement0);

        $this->sut->persistNewAccessToken($accessTokenEntityMock);
    }

    public function testPersistNewAccessTokenDbFailureThrowsException()
    {
        $expectedCode    = 17;
        $expectedMessage = 'Foo is great before: FROM api_clients AS ac';

        $this->expectException(Database::class);
        $this->expectExceptionCode($expectedCode);
        $this->expectExceptionMessage($expectedMessage);

        $tokenId    = 'foo';
        $clientName = 'bar';
        $expiresAt  = new \DateTime();

        $accessTokenEntityMock = $this->createAccessTokenStub($tokenId, $clientName, $expiresAt, []);

        $sql0          = 'INSERT INTO tokens (id, api_client_id, expires_at) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind0 = [
            [$tokenId, \PDO::PARAM_STR],
            [$clientName, \PDO::PARAM_STR],
            [$expiresAt->format('Y-m-d H:i:s'), \PDO::PARAM_STR],
        ];
        $errorInfo0    = ['FOO', $expectedCode, $expectedMessage];
        $statement0    = MockStatementFactory::createErrorStatement($this, $valuesToBind0, $errorInfo0);

        $this->writeConnectionMock
            ->expects($this->exactly(1))
            ->method('prepare')
            ->withConsecutive([$sql0])
            ->willReturnOnConsecutiveCalls($statement0);

        $this->sut->persistNewAccessToken($accessTokenEntityMock);
    }

    public function testPersistNewAccessTokenWithScopes()
    {
        $tokenId    = 'foo';
        $clientName = 'bar';
        $expiresAt  = new \DateTime();

        $scopeId0 = '0c4554ca-c379-46ab-9389-bfc84790bb46';
        $scopeId1 = 'aa7076d8-02c1-4d79-becc-e754450a392f';

        $scopeIdentifier0 = 'scope-0';
        $scopeIdentifier1 = 'scope-1';

        $this->uuidGeneratorMock
            ->expects($this->exactly(2))
            ->method('generate')
            ->willReturnOnConsecutiveCalls($scopeId0, $scopeId1);

        $scope = $this->createMock(ScopeEntityInterface::class);
        $scope
            ->expects($this->any())
            ->method('getIdentifier')
            ->willReturn($scopeIdentifier0, $scopeIdentifier1);

        $accessTokenEntityMock = $this->createAccessTokenStub(
            $tokenId,
            $clientName,
            $expiresAt,
            [$scope, $scope]
        );

        $sql0          = 'INSERT INTO tokens (id, api_client_id, expires_at) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind0 = [
            [$tokenId, \PDO::PARAM_STR],
            [$clientName, \PDO::PARAM_STR],
            [$expiresAt->format('Y-m-d H:i:s'), \PDO::PARAM_STR],
        ];
        $statement0    = MockStatementFactory::createWriteStatement($this, $valuesToBind0);

        $sql1          = 'INSERT INTO tokens_admin_resources (id, token_id, admin_resource_id) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind1 = [
            [$scopeId0, \PDO::PARAM_STR],
            [$tokenId, \PDO::PARAM_STR],
            [$scopeIdentifier0, \PDO::PARAM_STR],
        ];
        $statement1    = MockStatementFactory::createWriteStatement($this, $valuesToBind1);

        $sql2          = 'INSERT INTO tokens_admin_resources (id, token_id, admin_resource_id) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind2 = [
            [$scopeId1, \PDO::PARAM_STR],
            [$tokenId, \PDO::PARAM_STR],
            [$scopeIdentifier1, \PDO::PARAM_STR],
        ];
        $statement2    = MockStatementFactory::createWriteStatement($this, $valuesToBind2);

        $this->writeConnectionMock
            ->expects($this->exactly(3))
            ->method('prepare')
            ->withConsecutive([$sql0], [$sql1], [$sql2])
            ->willReturnOnConsecutiveCalls($statement0, $statement1, $statement2);

        $this->sut->persistNewAccessToken($accessTokenEntityMock);
    }

    public function testPersistNewAccessTokenWithScopesDbFailureThrowsException()
    {
        $expectedCode    = 17;
        $expectedMessage = 'Foo is great before: FROM api_clients AS ac';

        $this->expectException(Database::class);
        $this->expectExceptionCode($expectedCode);
        $this->expectExceptionMessage($expectedMessage);

        $tokenId    = 'foo';
        $clientName = 'bar';
        $expiresAt  = new \DateTime();

        $scopeId0 = '0c4554ca-c379-46ab-9389-bfc84790bb46';

        $scopeIdentifier0 = 'scope-0';

        $this->uuidGeneratorMock
            ->expects($this->exactly(1))
            ->method('generate')
            ->willReturnOnConsecutiveCalls($scopeId0);

        $scope = $this->createMock(ScopeEntityInterface::class);
        $scope
            ->expects($this->any())
            ->method('getIdentifier')
            ->willReturn($scopeIdentifier0);

        $accessTokenEntityMock = $this->createAccessTokenStub(
            $tokenId,
            $clientName,
            $expiresAt,
            [$scope]
        );

        $sql0          = 'INSERT INTO tokens (id, api_client_id, expires_at) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind0 = [
            [$tokenId, \PDO::PARAM_STR],
            [$clientName, \PDO::PARAM_STR],
            [$expiresAt->format('Y-m-d H:i:s'), \PDO::PARAM_STR],
        ];
        $statement0    = MockStatementFactory::createWriteStatement($this, $valuesToBind0);

        $sql1          = 'INSERT INTO tokens_admin_resources (id, token_id, admin_resource_id) VALUES (?, ?, ?)'; // phpcs:ignore
        $valuesToBind1 = [
            [$scopeId0, \PDO::PARAM_STR],
            [$tokenId, \PDO::PARAM_STR],
            [$scopeIdentifier0, \PDO::PARAM_STR],
        ];
        $errorInfo1    = ['FOO', $expectedCode, $expectedMessage];
        $statement1    = MockStatementFactory::createErrorStatement($this, $valuesToBind1, $errorInfo1);

        $this->writeConnectionMock
            ->expects($this->exactly(2))
            ->method('prepare')
            ->withConsecutive([$sql0], [$sql1])
            ->willReturnOnConsecutiveCalls($statement0, $statement1);

        $this->sut->persistNewAccessToken($accessTokenEntityMock);
    }

    /**
     * @param string $scopeId
     * @param string $identifier
     * @param int    $at
     *
     * @return ScopeEntityInterface
     */
    protected function createScopeStub(string $scopeId, string $identifier, int $at): ScopeEntityInterface
    {
        $this->uuidGeneratorMock->expects($this->at($at))->method('generate')->willReturn($scopeId);
        $this->uuidGeneratorMock->expects(/** @scrutinizer ignore-deprecated */ $this->at($at))->method('generate')->willReturn($scopeId);

        $scope = $this->createMock(ScopeEntityInterface::class);
        $scope->expects($this->any())->method('getIdentifier')->willReturn($identifier);

        return $scope;

    }

    /**
     * @param string                 $tokenId
     * @param string                 $clientName
     * @param \DateTime              $expiresAt
     * @param ScopeEntityInterface[] $scopes
     *
     * @return AccessTokenEntityInterface|MockObject
     */
    protected function createAccessTokenStub(
        string $tokenId,
        string $clientName,
        \DateTime $expiresAt,
        array $scopes
    ): AccessTokenEntityInterface {
        $clientStub = $this->createMock(ClientEntityInterface::class);
        $clientStub->expects($this->any())->method('getName')->willReturn($clientName);

        /** @var AccessTokenEntityInterface|MockObject $accessTokenEntityMock */
        $accessTokenEntityMock = $this->createMock(AccessTokenEntityInterface::class);

        $accessTokenEntityMock->expects($this->any())->method('getIdentifier')->willReturn($tokenId);
        $accessTokenEntityMock->expects($this->any())->method('getClient')->willReturn($clientStub);
        $accessTokenEntityMock->expects($this->any())->method('getExpiryDateTime')->willReturn($expiresAt);
        $accessTokenEntityMock->expects($this->any())->method('getScopes')->willReturn($scopes);

        return $accessTokenEntityMock;

    }

    public function testRevokeAccessToken()
    {
        $tokenId = 'foo';

        $this->sut->revokeAccessToken($tokenId);

        // This test is expected to break if there's anything happening in AccessToken::revokeAccessToken
        $this->assertTrue(true);
    }

    public function testIsAccessTokenRevoked()
    {
        $tokenId = 'foo';

        $actualResult = $this->sut->isAccessTokenRevoked($tokenId);

        $this->assertFalse($actualResult);
    }
}

abterphp / admin

testPersistNewAccessTokenWithScopesDbFailureThrowsException() A last analyzed 2023-01-23 22:21 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

testPersistNewAccessTokenWithScopesDbFailureThrowsException() A
last analyzed 2023-01-23 22:21 UTC
