class UserLocalTasksTest

Same name in other branches
  1. 9 core/modules/user/tests/src/Unit/Menu/UserLocalTasksTest.php \Drupal\Tests\user\Unit\Menu\UserLocalTasksTest
  2. 8.9.x core/modules/user/tests/src/Unit/Menu/UserLocalTasksTest.php \Drupal\Tests\user\Unit\Menu\UserLocalTasksTest
  3. 10 core/modules/user/tests/src/Unit/Menu/UserLocalTasksTest.php \Drupal\Tests\user\Unit\Menu\UserLocalTasksTest

Tests user local tasks.

@group user

Hierarchy

Expanded class hierarchy of UserLocalTasksTest

File

core/modules/user/tests/src/Unit/Menu/UserLocalTasksTest.php, line 15

Namespace

Drupal\Tests\user\Unit\Menu
View source 
class UserLocalTasksTest extends LocalTaskIntegrationTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        $this->directoryList = [
            'user' => 'core/modules/user',
        ];
        parent::setUp();
        // Add services required for user local tasks.
        $entity_type_manager = $this->createMock(EntityTypeManagerInterface::class);
        $entity_type_manager->expects($this->any())
            ->method('getDefinitions')
            ->willReturn([]);
        $this->container
            ->set('entity_type.manager', $entity_type_manager);
        $this->container
            ->set('string_translation', $this->getStringTranslationStub());
    }
    
    /**
     * Tests local task existence.
     *
     * @dataProvider getUserAdminRoutes
     */
    public function testUserAdminLocalTasks($route, $expected) : void {
        $this->assertLocalTasks($route, $expected);
    }
    
    /**
     * Provides a list of routes to test.
     */
    public static function getUserAdminRoutes() {
        return [
            [
                'entity.user.collection',
                [
                    [
                        'entity.user.collection',
                        'user.admin_permissions',
                        'entity.user_role.collection',
                        'user.role.settings',
                    ],
                ],
            ],
            [
                'user.admin_permissions',
                [
                    [
                        'entity.user.collection',
                        'user.admin_permissions',
                        'entity.user_role.collection',
                        'user.role.settings',
                    ],
                ],
            ],
            [
                'entity.user_role.collection',
                [
                    [
                        'entity.user.collection',
                        'user.admin_permissions',
                        'entity.user_role.collection',
                        'user.role.settings',
                    ],
                ],
            ],
            [
                'entity.user.admin_form',
                [
                    [
                        'user.account_settings_tab',
                    ],
                ],
            ],
        ];
    }
    
    /**
     * Checks user listing local tasks.
     *
     * @dataProvider getUserLoginRoutes
     */
    public function testUserLoginLocalTasks($route) : void {
        $tasks = [
            0 => [
                'user.register',
                'user.pass',
                'user.login',
            ],
        ];
        $this->assertLocalTasks($route, $tasks);
    }
    
    /**
     * Provides a list of routes to test.
     */
    public static function getUserLoginRoutes() {
        return [
            [
                'user.login',
            ],
            [
                'user.register',
            ],
            [
                'user.pass',
            ],
        ];
    }
    
    /**
     * Checks user listing local tasks.
     *
     * @dataProvider getUserPageRoutes
     */
    public function testUserPageLocalTasks($route, $subtask = []) : void {
        $tasks = [
            0 => [
                'entity.user.canonical',
                'entity.user.edit_form',
            ],
        ];
        if ($subtask) {
            $tasks[] = $subtask;
        }
        $this->assertLocalTasks($route, $tasks);
    }
    
    /**
     * Provides a list of routes to test.
     */
    public static function getUserPageRoutes() {
        return [
            [
                'entity.user.canonical',
            ],
            [
                'entity.user.edit_form',
            ],
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
LocalTaskIntegrationTestBase::$container protected property The container.
LocalTaskIntegrationTestBase::$directoryList protected property A list of module directories used for YAML searching.
LocalTaskIntegrationTestBase::$moduleHandler protected property The module handler.
LocalTaskIntegrationTestBase::assertLocalTasks protected function Tests integration for local tasks.
LocalTaskIntegrationTestBase::getLocalTaskManager protected function Sets up the local task manager for the test.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
UnitTestCase::$root protected property The app root.
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::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function
UserLocalTasksTest::getUserAdminRoutes public static function Provides a list of routes to test.
UserLocalTasksTest::getUserLoginRoutes public static function Provides a list of routes to test.
UserLocalTasksTest::getUserPageRoutes public static function Provides a list of routes to test.
UserLocalTasksTest::setUp protected function Overrides LocalTaskIntegrationTestBase::setUp
UserLocalTasksTest::testUserAdminLocalTasks public function Tests local task existence.
UserLocalTasksTest::testUserLoginLocalTasks public function Checks user listing local tasks.
UserLocalTasksTest::testUserPageLocalTasks public function Checks user listing local tasks.

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