class UserLocalTasksTest in Drupal 10

Tests user local tasks.

@group user

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Menu\LocalTaskIntegrationTestBase
    • class \Drupal\Tests\user\Unit\Menu\UserLocalTasksTest

File

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

Namespace

Drupal\Tests\user\Unit\Menu

class UserLocalTasksTest extends LocalTaskIntegrationTestBase {
  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')
      ->will($this
      ->returnValue([]));
    $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) {
    $this
      ->assertLocalTasks($route, $expected);
  }

  /**
   * Provides a list of routes to test.
   */
  public 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) {
    $tasks = [
      0 => [
        'user.register',
        'user.pass',
        'user.login',
      ],
    ];
    $this
      ->assertLocalTasks($route, $tasks);
  }

  /**
   * Provides a list of routes to test.
   */
  public function getUserLoginRoutes() {
    return [
      [
        'user.login',
      ],
      [
        'user.register',
      ],
      [
        'user.pass',
      ],
    ];
  }

  /**
   * Checks user listing local tasks.
   *
   * @dataProvider getUserPageRoutes
   */
  public function testUserPageLocalTasks($route, $subtask = []) {
    $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 function getUserPageRoutes() {
    return [
      [
        'entity.user.canonical',
      ],
      [
        'entity.user.edit_form',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
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
UserLocalTasksTest::getUserAdminRoutes	public	function	Provides a list of routes to test.
UserLocalTasksTest::getUserLoginRoutes	public	function	Provides a list of routes to test.
UserLocalTasksTest::getUserPageRoutes	public	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.