AuthenticationManagerTest.php

Same filename in other branches
  1. 9 core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php
  2. 8.9.x core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php
  3. 11.x core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php

Namespace

Drupal\Tests\Core\Authentication

File

core/tests/Drupal/Tests/Core/Authentication/AuthenticationManagerTest.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Authentication;

use Drupal\Core\Authentication\AuthenticationCollector;
use Drupal\Core\Authentication\AuthenticationManager;
use Drupal\Core\Authentication\AuthenticationProviderFilterInterface;
use Drupal\Core\Authentication\AuthenticationProviderInterface;
use Drupal\Tests\UnitTestCase;
use Drupal\Core\Routing\RouteObjectInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;

/**
 * @coversDefaultClass \Drupal\Core\Authentication\AuthenticationManager
 * @group Authentication
 */
class AuthenticationManagerTest extends UnitTestCase {
    
    /**
     * @covers ::defaultFilter
     * @covers ::applyFilter
     *
     * @dataProvider providerTestDefaultFilter
     */
    public function testDefaultFilter($applies, $has_route, $auth_option, $provider_id, $global) : void {
        $auth_provider = $this->createMock('Drupal\\Core\\Authentication\\AuthenticationProviderInterface');
        $auth_collector = new AuthenticationCollector();
        $auth_collector->addProvider($auth_provider, $provider_id, 0, $global);
        $authentication_manager = new AuthenticationManager($auth_collector);
        $request = new Request();
        if ($has_route) {
            $route = new Route('/example');
            if ($auth_option) {
                $route->setOption('_auth', $auth_option);
            }
            $request->attributes
                ->set(RouteObjectInterface::ROUTE_OBJECT, $route);
        }
        $this->assertSame($applies, $authentication_manager->appliesToRoutedRequest($request, FALSE));
    }
    
    /**
     * @covers ::applyFilter
     */
    public function testApplyFilterWithFilterProvider() : void {
        $auth_provider = $this->createMock('Drupal\\Tests\\Core\\Authentication\\TestAuthenticationProviderInterface');
        $auth_provider->expects($this->once())
            ->method('appliesToRoutedRequest')
            ->willReturn(TRUE);
        $authentication_collector = new AuthenticationCollector();
        $authentication_collector->addProvider($auth_provider, 'filtered', 0);
        $authentication_manager = new AuthenticationManager($authentication_collector);
        $request = new Request();
        $this->assertTrue($authentication_manager->appliesToRoutedRequest($request, FALSE));
    }
    
    /**
     * Provides data to self::testDefaultFilter().
     */
    public static function providerTestDefaultFilter() {
        $data = [];
        // No route, cookie is global, should apply.
        $data[] = [
            TRUE,
            FALSE,
            [],
            'cookie',
            TRUE,
        ];
        // No route, cookie is not global, should not apply.
        $data[] = [
            FALSE,
            FALSE,
            [],
            'cookie',
            FALSE,
        ];
        // Route, no _auth, cookie is global, should apply.
        $data[] = [
            TRUE,
            TRUE,
            [],
            'cookie',
            TRUE,
        ];
        // Route, no _auth, cookie is not global, should not apply.
        $data[] = [
            FALSE,
            TRUE,
            [],
            'cookie',
            FALSE,
        ];
        // Route, with _auth and non-matching provider, should not apply.
        $data[] = [
            FALSE,
            TRUE,
            [
                'basic_auth',
            ],
            'cookie',
            TRUE,
        ];
        // Route, with _auth and matching provider should not apply.
        $data[] = [
            TRUE,
            TRUE,
            [
                'basic_auth',
            ],
            'basic_auth',
            TRUE,
        ];
        return $data;
    }

}

/**
 * Helper interface to mock two interfaces at once.
 */
interface TestAuthenticationProviderInterface extends AuthenticationProviderFilterInterface, AuthenticationProviderInterface {

}

Classes

Title Deprecated Summary
AuthenticationManagerTest @coversDefaultClass \Drupal\Core\Authentication\AuthenticationManager @group Authentication

Interfaces

Title Deprecated Summary
TestAuthenticationProviderInterface Helper interface to mock two interfaces at once.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.