class ThemeNegotiatorTest in Drupal 9

@coversDefaultClass \Drupal\Core\Theme\ThemeNegotiator @group Theme

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Theme\ThemeNegotiatorTest

File

core/tests/Drupal/Tests/Core/Theme/ThemeNegotiatorTest.php, line 16

Namespace

Drupal\Tests\Core\Theme

class ThemeNegotiatorTest extends UnitTestCase {

  /**
   * The mocked theme access checker.
   *
   * @var \Drupal\Core\Theme\ThemeAccessCheck|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $themeAccessCheck;

  /**
   * The container builder.
   *
   * @var \Drupal\Core\DependencyInjection\ContainerBuilder
   */
  protected $container;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The actual tested theme negotiator.
   *
   * @var \Drupal\Core\Theme\ThemeNegotiator
   */
  protected $themeNegotiator;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $this->themeAccessCheck = $this
      ->getMockBuilder('\\Drupal\\Core\\Theme\\ThemeAccessCheck')
      ->disableOriginalConstructor()
      ->getMock();
    $this->container = new ContainerBuilder();
  }

  /**
   * Tests determining the theme.
   *
   * @see \Drupal\Core\Theme\ThemeNegotiator::determineActiveTheme()
   */
  public function testDetermineActiveTheme() {
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->once())
      ->method('determineActiveTheme')
      ->will($this
      ->returnValue('example_test'));
    $negotiator
      ->expects($this
      ->once())
      ->method('applies')
      ->will($this
      ->returnValue(TRUE));
    $this->container
      ->set('test_negotiator', $negotiator);
    $negotiators = [
      'test_negotiator',
    ];
    $this->themeAccessCheck
      ->expects($this
      ->any())
      ->method('checkAccess')
      ->will($this
      ->returnValue(TRUE));
    $route_match = new RouteMatch('test_route', new Route('/test-route'), [], []);
    $theme = $this
      ->createThemeNegotiator($negotiators)
      ->determineActiveTheme($route_match);
    $this
      ->assertEquals('example_test', $theme);
  }

  /**
   * Tests determining with two negotiators checking the priority.
   *
   * @see \Drupal\Core\Theme\ThemeNegotiator::determineActiveTheme()
   */
  public function testDetermineActiveThemeWithPriority() {
    $negotiators = [];
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->once())
      ->method('determineActiveTheme')
      ->will($this
      ->returnValue('example_test'));
    $negotiator
      ->expects($this
      ->once())
      ->method('applies')
      ->will($this
      ->returnValue(TRUE));
    $negotiators['test_negotiator_1'] = $negotiator;
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->never())
      ->method('determineActiveTheme');
    $negotiator
      ->expects($this
      ->never())
      ->method('applies');
    $negotiators['test_negotiator_2'] = $negotiator;
    foreach ($negotiators as $id => $negotiator) {
      $this->container
        ->set($id, $negotiator);
    }
    $this->themeAccessCheck
      ->expects($this
      ->any())
      ->method('checkAccess')
      ->will($this
      ->returnValue(TRUE));
    $route_match = new RouteMatch('test_route', new Route('/test-route'), [], []);
    $theme = $this
      ->createThemeNegotiator(array_keys($negotiators))
      ->determineActiveTheme($route_match);
    $this
      ->assertEquals('example_test', $theme);
  }

  /**
   * Tests determining with two negotiators of which just one returns access.
   *
   * @see \Drupal\Core\Theme\ThemeNegotiator::determineActiveTheme()
   */
  public function testDetermineActiveThemeWithAccessCheck() {
    $negotiators = [];
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->once())
      ->method('determineActiveTheme')
      ->will($this
      ->returnValue('example_test'));
    $negotiator
      ->expects($this
      ->once())
      ->method('applies')
      ->will($this
      ->returnValue(TRUE));
    $negotiators['test_negotiator_1'] = $negotiator;
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->once())
      ->method('determineActiveTheme')
      ->will($this
      ->returnValue('example_test2'));
    $negotiator
      ->expects($this
      ->once())
      ->method('applies')
      ->will($this
      ->returnValue(TRUE));
    $negotiators['test_negotiator_2'] = $negotiator;
    foreach ($negotiators as $id => $negotiator) {
      $this->container
        ->set($id, $negotiator);
    }
    $this->themeAccessCheck
      ->expects($this
      ->exactly(2))
      ->method('checkAccess')
      ->willReturnMap([
      [
        'example_test',
        FALSE,
      ],
      [
        'example_test2',
        TRUE,
      ],
    ]);
    $route_match = new RouteMatch('test_route', new Route('/test-route'), [], []);
    $theme = $this
      ->createThemeNegotiator(array_keys($negotiators))
      ->determineActiveTheme($route_match);
    $this
      ->assertEquals('example_test2', $theme);
  }

  /**
   * Tests determining with two negotiators of which one does not apply.
   *
   * @see \Drupal\Core\Theme\ThemeNegotiatorInterface
   */
  public function testDetermineActiveThemeWithNotApplyingNegotiator() {
    $negotiators = [];
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->never())
      ->method('determineActiveTheme');
    $negotiator
      ->expects($this
      ->once())
      ->method('applies')
      ->will($this
      ->returnValue(FALSE));
    $negotiators['test_negotiator_1'] = $negotiator;
    $negotiator = $this
      ->createMock('Drupal\\Core\\Theme\\ThemeNegotiatorInterface');
    $negotiator
      ->expects($this
      ->once())
      ->method('determineActiveTheme')
      ->will($this
      ->returnValue('example_test2'));
    $negotiator
      ->expects($this
      ->once())
      ->method('applies')
      ->will($this
      ->returnValue(TRUE));
    $negotiators['test_negotiator_2'] = $negotiator;
    foreach ($negotiators as $id => $negotiator) {
      $this->container
        ->set($id, $negotiator);
    }
    $this->themeAccessCheck
      ->expects($this
      ->any())
      ->method('checkAccess')
      ->will($this
      ->returnValue(TRUE));
    $route_match = new RouteMatch('test_route', new Route('/test-route'), [], []);
    $theme = $this
      ->createThemeNegotiator(array_keys($negotiators))
      ->determineActiveTheme($route_match);
    $this
      ->assertEquals('example_test2', $theme);
  }

  /**
   * Creates a new theme negotiator instance.
   *
   * @param array $negotiators
   *   An array of negotiator IDs.
   *
   * @return \Drupal\Core\Theme\ThemeNegotiator
   */
  protected function createThemeNegotiator(array $negotiators) {
    $resolver = new ClassResolver();
    $resolver
      ->setContainer($this->container);
    $theme_negotiator = new ThemeNegotiator($this->themeAccessCheck, $resolver, $negotiators);
    return $theme_negotiator;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
ThemeNegotiatorTest::$container	protected	property	The container builder.
ThemeNegotiatorTest::$requestStack	protected	property	The request stack.
ThemeNegotiatorTest::$themeAccessCheck	protected	property	The mocked theme access checker.
ThemeNegotiatorTest::$themeNegotiator	protected	property	The actual tested theme negotiator.
ThemeNegotiatorTest::createThemeNegotiator	protected	function	Creates a new theme negotiator instance.
ThemeNegotiatorTest::setUp	protected	function	Overrides UnitTestCase::setUp
ThemeNegotiatorTest::testDetermineActiveTheme	public	function	Tests determining the theme.
ThemeNegotiatorTest::testDetermineActiveThemeWithAccessCheck	public	function	Tests determining with two negotiators of which just one returns access.
ThemeNegotiatorTest::testDetermineActiveThemeWithNotApplyingNegotiator	public	function	Tests determining with two negotiators of which one does not apply.
ThemeNegotiatorTest::testDetermineActiveThemeWithPriority	public	function	Tests determining with two negotiators checking the priority.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass	public static	function