class TreeAccessTest

Tests the access check for menu tree using both hook_menu() and route items.

Hierarchy

Expanded class hierarchy of TreeAccessTest

File

drupal/core/modules/system/lib/Drupal/system/Tests/Menu/TreeAccessTest.php, line 20
Contains \Drupal\system\Tests\Menu\TreeAccessTest.

Namespace

Drupal\system\Tests\Menu
View source
class TreeAccessTest extends DrupalUnitTestBase {

  /**
   * A list of menu links used for this test.
   *
   * @var array
   */
  protected $links;

  /**
   * The route collection used for this test.
   *
   * @var\ \Symfony\Component\Routing\RouteCollection
   */
  protected $routeCollection;
  public static function getInfo() {
    return array(
      'name' => 'Menu tree access',
      'description' => 'Tests the access check for menu tree using both hook_menu() and route items.',
      'group' => 'Menu',
    );
  }

  /**
   * Overrides \Drupal\simpletest\DrupalUnitTestBase::containerBuild().
   */
  public function containerBuild(ContainerBuilder $container) {
    parent::containerBuild($container);
    $route_collection = $this
      ->getTestRouteCollection();
    $container
      ->register('router.route_provider', 'Drupal\\system\\Tests\\Routing\\MockRouteProvider')
      ->addArgument($route_collection);
  }

  /**
   * Generates the test route collection.
   *
   * @return \Symfony\Component\Routing\RouteCollection
   *   Returns the test route collection.
   */
  protected function getTestRouteCollection() {
    if (!isset($this->routeCollection)) {
      $route_collection = new RouteCollection();
      $route_collection
        ->add('menu_test_1', new Route('/menu_test/test_1', array(
        '_controller' => '\\Drupal\\menu_test\\TestController::test',
      ), array(
        '_access' => 'TRUE',
      )));
      $route_collection
        ->add('menu_test_2', new Route('/menu_test/test_2', array(
        '_controller' => '\\Drupal\\menu_test\\TestController::test',
      ), array(
        '_access' => 'FALSE',
      )));
      $this->routeCollection = $route_collection;
    }
    return $this->routeCollection;
  }

  /**
   * Tests access check for menu links with a route item.
   */
  public function testRouteItemMenuLinksAccess() {

    // Add the access checkers to the route items.
    $this->container
      ->get('access_manager')
      ->setChecks($this
      ->getTestRouteCollection());

    // Setup the links with the route items.
    $this->links = array(
      new MenuLink(array(
        'mlid' => 1,
        'route_name' => 'menu_test_1',
        'depth' => 1,
        'link_path' => 'menu_test/test_1',
      ), 'menu_link'),
      new MenuLink(array(
        'mlid' => 2,
        'route_name' => 'menu_test_2',
        'depth' => 1,
        'link_path' => 'menu_test/test_2',
      ), 'menu_link'),
    );

    // Build the menu tree and check access for all of the items.
    $tree = menu_tree_data($this->links);
    menu_tree_check_access($tree);
    $this
      ->assertEqual(count($tree), 1, 'Ensure that just one menu link got access.');
    $item = reset($tree);
    $this
      ->assertEqual($this->links[0], $item['link'], 'Ensure that the right link got access');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$modules public static property Modules to enable. 51
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::setUp protected function Sets up Drupal unit test environment. Overrides UnitTestBase::setUp 44
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
TreeAccessTest::$links protected property A list of menu links used for this test.
TreeAccessTest::$routeCollection protected property The route collection used for this test.
TreeAccessTest::containerBuild public function Overrides \Drupal\simpletest\DrupalUnitTestBase::containerBuild(). Overrides DrupalUnitTestBase::containerBuild
TreeAccessTest::getInfo public static function
TreeAccessTest::getTestRouteCollection protected function Generates the test route collection.
TreeAccessTest::testRouteItemMenuLinksAccess public function Tests access check for menu links with a route item.
UnitTestBase::$configDirectories protected property