HandlerFilterRolesTest.php in Drupal 8

Namespace

Drupal\Tests\user\Kernel\Views

File

core/modules/user/tests/src/Kernel/Views/HandlerFilterRolesTest.php

<?php

namespace Drupal\Tests\user\Kernel\Views;

use Drupal\user\Entity\Role;
use Drupal\views\Entity\View;
use Drupal\views\Views;
use PHPUnit\Framework\Error\Warning;

/**
 * Tests the roles filter handler.
 *
 * @group user
 *
 * @see \Drupal\user\Plugin\views\filter\Roles
 */
class HandlerFilterRolesTest extends UserKernelTestBase {

  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = [
    'test_user_name',
  ];

  /**
   * Tests that role filter dependencies are calculated correctly.
   */
  public function testDependencies() {
    $role = Role::create([
      'id' => 'test_user_role',
    ]);
    $role
      ->save();
    $view = View::load('test_user_name');
    $expected = [
      'module' => [
        'user',
      ],
    ];
    $this
      ->assertEqual($expected, $view
      ->getDependencies());
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['filters']['roles_target_id'] = [
      'id' => 'roles_target_id',
      'table' => 'user__roles',
      'field' => 'roles_target_id',
      'value' => [
        'test_user_role' => 'test_user_role',
      ],
      'plugin_id' => 'user_roles',
    ];
    $view
      ->save();
    $expected['config'][] = 'user.role.test_user_role';
    $this
      ->assertEqual($expected, $view
      ->getDependencies());
    $view = View::load('test_user_name');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['filters']['roles_target_id'] = [
      'id' => 'roles_target_id',
      'table' => 'user__roles',
      'field' => 'roles_target_id',
      'value' => [
        'test_user_role' => 'test_user_role',
      ],
      'operator' => 'empty',
      'plugin_id' => 'user_roles',
    ];
    $view
      ->save();
    unset($expected['config']);
    $this
      ->assertEqual($expected, $view
      ->getDependencies());
    $view = View::load('test_user_name');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['filters']['roles_target_id'] = [
      'id' => 'roles_target_id',
      'table' => 'user__roles',
      'field' => 'roles_target_id',
      'value' => [
        'test_user_role' => 'test_user_role',
      ],
      'operator' => 'not empty',
      'plugin_id' => 'user_roles',
    ];
    $view
      ->save();
    $this
      ->assertEqual($expected, $view
      ->getDependencies());
    $view = Views::getView('test_user_name');
    $view
      ->initDisplay();
    $view
      ->initHandlers();
    $this
      ->assertEqual(array_keys($view->filter['roles_target_id']
      ->getValueOptions()), [
      'test_user_role',
    ]);
    $view = View::load('test_user_name');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['filters']['roles_target_id'] = [
      'id' => 'roles_target_id',
      'table' => 'user__roles',
      'field' => 'roles_target_id',
      'value' => [],
      'plugin_id' => 'user_roles',
    ];
    $view
      ->save();
    $this
      ->assertEqual($expected, $view
      ->getDependencies());
  }

  /**
   * Tests that a warning is triggered if the filter references a missing role.
   */
  public function testMissingRole() {
    $role = Role::create([
      'id' => 'test_user_role',
    ]);
    $role
      ->save();

    /** @var \Drupal\views\Entity\View $view */
    $view = View::load('test_user_name');
    $display =& $view
      ->getDisplay('default');
    $display['display_options']['filters']['roles_target_id'] = [
      'id' => 'roles_target_id',
      'table' => 'user__roles',
      'field' => 'roles_target_id',
      'value' => [
        'test_user_role' => 'test_user_role',
      ],
      'plugin_id' => 'user_roles',
    ];

    // Ensure no warning is triggered before the role is deleted.
    $view
      ->calculateDependencies();
    $role
      ->delete();
    $this
      ->expectException(Warning::class);
    $this
      ->expectExceptionMessage('The test_user_role role does not exist. You should review and fix the configuration of the test_user_name view.');
    $view
      ->calculateDependencies();
  }

}

Classes

Name	Description
HandlerFilterRolesTest	Tests the roles filter handler.