OAuth2Framework\Component\Scope\Tests\ScopeParameterCheckerTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	6	2
A	anAuthorizationRequestWithNoScopeParameterIsChecked()	0	11	1
A	anAuthorizationRequestWithScopeParameterIsChecked()	0	12	1
A	anAuthorizationRequestWithAnUnsupportedScopeParameterIsChecked()	0	20	2
A	getScopeParameterChecker()	0	19	2

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace OAuth2Framework\Component\Scope\Tests;

use OAuth2Framework\Component\AuthorizationEndpoint\Authorization;
use OAuth2Framework\Component\AuthorizationEndpoint\Exception\OAuth2AuthorizationException;
use OAuth2Framework\Component\Core\Client\Client;
use OAuth2Framework\Component\Scope\Policy\ScopePolicyManager;
use OAuth2Framework\Component\Scope\ScopeParameterChecker;
use OAuth2Framework\Component\Scope\ScopeRepository;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;

/**
 * @group ScopeParameterChecker
 */
class ScopeParameterCheckerTest extends TestCase
{
    /**
     * @inheritdoc}
     */
    protected function setUp()
    {
        if (!class_exists(Authorization::class)) {
            $this->markTestSkipped('Authorization Endpoint not available');
        }
    }

    /**
     * @test
     */
    public function anAuthorizationRequestWithNoScopeParameterIsChecked()
    {
        $client = $this->prophesize(Client::class);
        $authorization = $this->prophesize(Authorization::class);
        $authorization->getClient()->willReturn($client->reveal());
        $authorization->hasQueryParam('scope')->willReturn(false)->shouldBeCalled();
        $authorization->withResponseParameter('scope', Argument::any())->shouldNotBeCalled();
        $this->getScopeParameterChecker()->check(
            $authorization->reveal()
        );
    }

    /**
     * @test
     */
    public function anAuthorizationRequestWithScopeParameterIsChecked()
    {
        $client = $this->prophesize(Client::class);
        $authorization = $this->prophesize(Authorization::class);
        $authorization->getClient()->willReturn($client->reveal());
        $authorization->hasQueryParam('scope')->willReturn(true)->shouldBeCalled();
        $authorization->getQueryParam('scope')->willReturn('scope1')->shouldBeCalled();
        $authorization->withResponseParameter('scope', Argument::any())->willReturn($authorization)->shouldBeCalled();
        $this->getScopeParameterChecker()->check(
            $authorization->reveal()
        );
    }

    /**
     * @test
     */
    public function anAuthorizationRequestWithAnUnsupportedScopeParameterIsChecked()
    {
        $client = $this->prophesize(Client::class);
        $authorization = $this->prophesize(Authorization::class);
        $authorization->getClient()->willReturn($client->reveal());
        $authorization->hasQueryParam('scope')->willReturn(true)->shouldBeCalled();
        $authorization->getQueryParam('scope')->willReturn('invalid_scope')->shouldBeCalled();
        $authorization->withResponseParameter('scope', Argument::any())->shouldNotBeCalled();

        try {
            $this->getScopeParameterChecker()->check(
                $authorization->reveal()
            );
            $this->fail('Expected exception nt thrown.');
        } catch (OAuth2AuthorizationException $e) {
            self::assertEquals('invalid_scope', $e->getMessage());
            self::assertEquals('An unsupported scope was requested. Available scopes for the client are scope1, scope2.', $e->getErrorDescription());
            self::assertEquals(400, $e->getCode());
        }
    }

    /**
     * @var ScopeParameterChecker|null
     */
    private $scopeParameterChecker = null;

    private function getScopeParameterChecker(): ScopeParameterChecker
    {
        if (null === $this->scopeParameterChecker) {
            $scopeRepository = $this->prophesize(ScopeRepository::class);
            $scopeRepository->all()->willReturn([
                'scope1',
                'scope2',
            ]);
            $scopePolicyManager = $this->prophesize(ScopePolicyManager::class);
            $scopePolicyManager->apply(Argument::any(), Argument::type(Client::class))->willReturnArgument(0);

            $this->scopeParameterChecker = new ScopeParameterChecker(
                $scopeRepository->reveal(),
                $scopePolicyManager->reveal()
            );
        }

        return $this->scopeParameterChecker;
    }
}