class TreeOutputTest

Menu tree output related tests.

Hierarchy

Expanded class hierarchy of TreeOutputTest

File

drupal/core/modules/system/lib/Drupal/system/Tests/Menu/TreeOutputTest.php, line 15
Definition of Drupal\system\Tests\Menu\TreeOutputTest.

Namespace

Drupal\system\Tests\Menu
View source
class TreeOutputTest extends DrupalUnitTestBase {
  public static $modules = array(
    'system',
    'menu_link',
  );

  /**
   * Dummy link structure acceptable for menu_tree_output().
   */
  protected $tree_data = array();
  public static function getInfo() {
    return array(
      'name' => 'Menu tree output',
      'description' => 'Tests menu tree output functions.',
      'group' => 'Menu',
    );
  }
  function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', 'menu_router');
  }

  /**
   * Validate the generation of a proper menu tree output.
   */
  function testMenuTreeData() {
    $storage_controller = $this->container
      ->get('plugin.manager.entity')
      ->getStorageController('menu_link');

    // @todo Prettify this tree buildup code, it's very hard to read.
    $this->tree_data = array(
      '1' => array(
        'link' => $storage_controller
          ->create(array(
          'menu_name' => 'main-menu',
          'mlid' => 1,
          'hidden' => 0,
          'has_children' => 1,
          'title' => 'Item 1',
          'in_active_trail' => 1,
          'access' => 1,
          'href' => 'a',
          'localized_options' => array(
            'attributes' => array(
              'title' => '',
            ),
          ),
        )),
        'below' => array(
          '2' => array(
            'link' => $storage_controller
              ->create(array(
              'menu_name' => 'main-menu',
              'mlid' => 2,
              'hidden' => 0,
              'has_children' => 1,
              'title' => 'Item 2',
              'in_active_trail' => 1,
              'access' => 1,
              'href' => 'a/b',
              'localized_options' => array(
                'attributes' => array(
                  'title' => '',
                ),
              ),
            )),
            'below' => array(
              '3' => array(
                'link' => $storage_controller
                  ->create(array(
                  'menu_name' => 'main-menu',
                  'mlid' => 3,
                  'hidden' => 0,
                  'has_children' => 0,
                  'title' => 'Item 3',
                  'in_active_trail' => 0,
                  'access' => 1,
                  'href' => 'a/b/c',
                  'localized_options' => array(
                    'attributes' => array(
                      'title' => '',
                    ),
                  ),
                )),
                'below' => array(),
              ),
              '4' => array(
                'link' => $storage_controller
                  ->create(array(
                  'menu_name' => 'main-menu',
                  'mlid' => 4,
                  'hidden' => 0,
                  'has_children' => 0,
                  'title' => 'Item 4',
                  'in_active_trail' => 0,
                  'access' => 1,
                  'href' => 'a/b/d',
                  'localized_options' => array(
                    'attributes' => array(
                      'title' => '',
                    ),
                  ),
                )),
                'below' => array(),
              ),
            ),
          ),
        ),
      ),
      '5' => array(
        'link' => $storage_controller
          ->create(array(
          'menu_name' => 'main-menu',
          'mlid' => 5,
          'hidden' => 1,
          'has_children' => 0,
          'title' => 'Item 5',
          'in_active_trail' => 0,
          'access' => 1,
          'href' => 'e',
          'localized_options' => array(
            'attributes' => array(
              'title' => '',
            ),
          ),
        )),
        'below' => array(),
      ),
      '6' => array(
        'link' => $storage_controller
          ->create(array(
          'menu_name' => 'main-menu',
          'mlid' => 6,
          'hidden' => 0,
          'has_children' => 0,
          'title' => 'Item 6',
          'in_active_trail' => 0,
          'access' => 0,
          'href' => 'f',
          'localized_options' => array(
            'attributes' => array(
              'title' => '',
            ),
          ),
        )),
        'below' => array(),
      ),
      '7' => array(
        'link' => $storage_controller
          ->create(array(
          'menu_name' => 'main-menu',
          'mlid' => 7,
          'hidden' => 0,
          'has_children' => 0,
          'title' => 'Item 7',
          'in_active_trail' => 0,
          'access' => 1,
          'href' => 'g',
          'localized_options' => array(
            'attributes' => array(
              'title' => '',
            ),
          ),
        )),
        'below' => array(),
      ),
    );
    $output = menu_tree_output($this->tree_data);

    // Validate that the - in main-menu is changed into an underscore
    $this
      ->assertEqual($output['1']['#theme'], 'menu_link__main_menu', 'Hyphen is changed to a dash on menu_link');
    $this
      ->assertEqual($output['#theme_wrappers'][0], 'menu_tree__main_menu', 'Hyphen is changed to a dash on menu_tree wrapper');

    // Looking for child items in the data
    $this
      ->assertEqual($output['1']['#below']['2']['#href'], 'a/b', 'Checking the href on a child item');
    $this
      ->assertTrue(in_array('active-trail', $output['1']['#below']['2']['#attributes']['class']), 'Checking the active trail class');

    // Validate that the hidden and no access items are missing
    $this
      ->assertFalse(isset($output['5']), 'Hidden item should be missing');
    $this
      ->assertFalse(isset($output['6']), 'False access should be missing');

    // Item 7 is after a couple hidden items. Just to make sure that 5 and 6 are skipped and 7 still included
    $this
      ->assertTrue(isset($output['7']), 'Item after hidden items is present');
  }

}

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::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
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::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.
TreeOutputTest::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules
TreeOutputTest::$tree_data protected property Dummy link structure acceptable for menu_tree_output().
TreeOutputTest::getInfo public static function
TreeOutputTest::setUp function Sets up Drupal unit test environment. Overrides DrupalUnitTestBase::setUp
TreeOutputTest::testMenuTreeData function Validate the generation of a proper menu tree output.
UnitTestBase::$configDirectories protected property