UserKernelTestBase.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\user\Kernel\Views;

use Drupal\Tests\views\Kernel\ViewsKernelTestBase;
use Drupal\views\Tests\ViewTestData;

/**
 * Provides a common test base for user views tests.
 */
abstract class UserKernelTestBase extends ViewsKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'user_test_views',
        'user',
        'system',
        'field',
    ];
    
    /**
     * Users to use during this test.
     *
     * @var array
     */
    protected $users = [];
    
    /**
     * The entity storage for roles.
     *
     * @var \Drupal\user\RoleStorage
     */
    protected $roleStorage;
    
    /**
     * The entity storage for users.
     *
     * @var \Drupal\user\UserStorage
     */
    protected $userStorage;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE) : void {
        parent::setUp();
        ViewTestData::createTestViews(static::class, [
            'user_test_views',
        ]);
        $this->installEntitySchema('user');
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $this->roleStorage = $entity_type_manager->getStorage('user_role');
        $this->userStorage = $entity_type_manager->getStorage('user');
    }
    
    /**
     * Set some test data for permission related tests.
     */
    protected function setupPermissionTestData() {
        // Setup a role without any permission.
        $this->roleStorage
            ->create([
            'id' => 'authenticated',
            'label' => 'Authenticated',
        ])
            ->save();
        $this->roleStorage
            ->create([
            'id' => 'no_permission',
            'label' => 'No permission',
        ])
            ->save();
        // Setup a role with just one permission.
        $this->roleStorage
            ->create([
            'id' => 'one_permission',
            'label' => '1 permission',
        ])
            ->save();
        user_role_grant_permissions('one_permission', [
            'administer permissions',
        ]);
        // Setup a role with multiple permissions.
        $this->roleStorage
            ->create([
            'id' => 'multiple_permissions',
            'label' => 'Multiple permissions',
        ])
            ->save();
        user_role_grant_permissions('multiple_permissions', [
            'administer permissions',
            'administer users',
            'access user profiles',
        ]);
        // Setup a user without an extra role.
        $this->users[] = $account = $this->userStorage
            ->create([
            'name' => $this->randomString(),
        ]);
        $account->save();
        // Setup a user with just the first role (so no permission beside the
        // ones from the authenticated role).
        $this->users[] = $account = $this->userStorage
            ->create([
            'name' => 'first_role',
        ]);
        $account->addRole('no_permission')
            ->save();
        // Setup a user with just the second role (so one additional permission).
        $this->users[] = $account = $this->userStorage
            ->create([
            'name' => 'second_role',
        ]);
        $account->addRole('one_permission')
            ->save();
        // Setup a user with both the second and the third role.
        $this->users[] = $account = $this->userStorage
            ->create([
            'name' => 'second_third_role',
        ]);
        $account->addRole('one_permission')
            ->addRole('multiple_permissions')
            ->save();
    }

}