UserLocalTasksTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\user\Unit\Menu;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Tests\Core\Menu\LocalTaskIntegrationTestBase;

/**
 * Tests user local tasks.
 *
 * @group user
 */
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',
      ],
    ];
  }

}