AjaxBasePageNegotiatorTest.php

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

Namespace

Drupal\Tests\Core\Theme

File

core/tests/Drupal/Tests/Core/Theme/AjaxBasePageNegotiatorTest.php

View source
<?php

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

use Drupal\Core\Access\CsrfTokenGenerator;
use Drupal\Core\Routing\RouteMatch;
use Drupal\Core\Theme\AjaxBasePageNegotiator;
use Drupal\Tests\UnitTestCase;
use Prophecy\Argument;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @coversDefaultClass \Drupal\Core\Theme\AjaxBasePageNegotiator
 * @group Theme
 */
class AjaxBasePageNegotiatorTest extends UnitTestCase {
    
    /**
     * @var \Drupal\Core\Theme\AjaxBasePageNegotiator
     *
     * The AJAX base page negotiator.
     */
    protected $negotiator;
    
    /**
     * @var \Drupal\Core\Access\CsrfTokenGenerator|\Prophecy\Prophecy\ProphecyInterface
     *
     * The CSRF token generator.
     */
    protected $tokenGenerator;
    
    /**
     * @var \Symfony\Component\HttpFoundation\RequestStack
     *
     * The request stack.
     */
    protected $requestStack;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->tokenGenerator = $this->prophesize(CsrfTokenGenerator::class);
        $config_factory = $this->getConfigFactoryStub([
            'system.theme' => [
                'default' => 'stark',
            ],
        ]);
        $this->requestStack = new RequestStack();
        $this->negotiator = new AjaxBasePageNegotiator($this->tokenGenerator
            ->reveal(), $config_factory, $this->requestStack);
    }
    
    /**
     * @covers ::applies
     * @dataProvider providerTestApplies
     */
    public function testApplies($request_data, $expected) : void {
        $request = new Request();
        foreach ($request_data as $key => $data) {
            $request->query
                ->set($key, $data);
        }
        $route_match = RouteMatch::createFromRequest($request);
        $this->requestStack
            ->push($request);
        $result = $this->negotiator
            ->applies($route_match);
        $this->assertSame($expected, $result);
    }
    public static function providerTestApplies() {
        $data = [];
        $data['empty'] = [
            [],
            FALSE,
        ];
        $data['no_theme'] = [
            [
                'ajax_page_state' => [
                    'theme' => '',
                    'theme_token' => '',
                ],
            ],
            FALSE,
        ];
        $data['valid_theme_empty_theme_token'] = [
            [
                'ajax_page_state' => [
                    'theme' => 'claro',
                    'theme_token' => '',
                ],
            ],
            TRUE,
        ];
        $data['valid_theme_valid_theme_token'] = [
            [
                'ajax_page_state' => [
                    'theme' => 'claro',
                    'theme_token' => 'valid_theme_token',
                ],
            ],
            TRUE,
        ];
        return $data;
    }
    
    /**
     * @covers ::determineActiveTheme
     */
    public function testDetermineActiveThemeValidToken() : void {
        $theme = 'claro';
        $theme_token = 'valid_theme_token';
        $request = new Request();
        $request->query
            ->set('ajax_page_state', [
            'theme' => $theme,
            'theme_token' => $theme_token,
        ]);
        $this->requestStack
            ->push($request);
        $route_match = RouteMatch::createFromRequest($request);
        $this->tokenGenerator
            ->validate($theme_token, $theme)
            ->willReturn(TRUE);
        $result = $this->negotiator
            ->determineActiveTheme($route_match);
        $this->assertSame($theme, $result);
    }
    
    /**
     * @covers ::determineActiveTheme
     */
    public function testDetermineActiveThemeInvalidToken() : void {
        $theme = 'claro';
        $theme_token = 'invalid_theme_token';
        $request = new Request();
        $request->query
            ->set('ajax_page_state', [
            'theme' => $theme,
            'theme_token' => $theme_token,
        ]);
        $request->request = new InputBag($request->request
            ->all());
        $this->requestStack
            ->push($request);
        $route_match = RouteMatch::createFromRequest($request);
        $this->tokenGenerator
            ->validate($theme_token, $theme)
            ->willReturn(FALSE);
        $result = $this->negotiator
            ->determineActiveTheme($route_match);
        $this->assertNull($result);
    }
    
    /**
     * @covers ::determineActiveTheme
     */
    public function testDetermineActiveThemeDefaultTheme() : void {
        $theme = 'stark';
        // When the theme is the system default, an empty string is provided as the
        // theme token. See system_js_settings_alter().
        $theme_token = '';
        $request = new Request([]);
        $request->query
            ->set('ajax_page_state', [
            'theme' => $theme,
            'theme_token' => $theme_token,
        ]);
        $request->request = new InputBag($request->request
            ->all());
        $this->requestStack
            ->push($request);
        $route_match = RouteMatch::createFromRequest($request);
        $this->tokenGenerator
            ->validate(Argument::cetera())
            ->shouldNotBeCalled();
        $result = $this->negotiator
            ->determineActiveTheme($route_match);
        $this->assertSame($theme, $result);
    }

}

Classes

Title Deprecated Summary
AjaxBasePageNegotiatorTest @coversDefaultClass \Drupal\Core\Theme\AjaxBasePageNegotiator @group Theme

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