class RouterTest

Same name in this branch

Tests menu router and hook_menu() functionality.

Hierarchy

Expanded class hierarchy of RouterTest

File

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

Namespace

Drupal\system\Tests\Menu
View source
class RouterTest extends WebTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'block',
    'menu_test',
    'test_page_test',
  );
  public static function getInfo() {
    return array(
      'name' => 'Menu router',
      'description' => 'Tests menu router and hook_menu() functionality.',
      'group' => 'Menu',
    );
  }
  function setUp() {

    // Enable dummy module that implements hook_menu.
    parent::setUp();

    // Make the tests below more robust by explicitly setting the default theme
    // and administrative theme that they expect.
    theme_enable(array(
      'bartik',
    ));
    variable_set('theme_default', 'bartik');
    variable_set('admin_theme', 'seven');
    theme_disable(array(
      'stark',
    ));

    // Enable navigation menu block.
    db_merge('block')
      ->key(array(
      'module' => 'system',
      'delta' => 'menu-tools',
      'theme' => 'bartik',
    ))
      ->fields(array(
      'status' => 1,
      'weight' => 0,
      'region' => 'sidebar_first',
      'pages' => '',
      'cache' => -1,
    ))
      ->execute();
  }

  /**
   * Test title callback set to FALSE.
   */
  function testTitleCallbackFalse() {
    $this
      ->drupalGet('test-page');
    $this
      ->assertText('A title with @placeholder', 'Raw text found on the page');
    $this
      ->assertNoText(t('A title with @placeholder', array(
      '@placeholder' => 'some other text',
    )), 'Text with placeholder substitutions not found.');
  }

  /**
   * Tests page title of MENU_CALLBACKs.
   */
  function testTitleMenuCallback() {

    // Verify that the menu router item title is not visible.
    $this
      ->drupalGet('');
    $this
      ->assertNoText(t('Menu Callback Title'));

    // Verify that the menu router item title is output as page title.
    $this
      ->drupalGet('menu_callback_title');
    $this
      ->assertText(t('Menu Callback Title'));
  }

  /**
   * Tests menu item descriptions.
   */
  function testDescriptionMenuItems() {

    // Verify that the menu router item title is output as page title.
    $this
      ->drupalGet('menu_callback_description');
    $this
      ->assertText(t('Menu item description text'));
    $this
      ->assertRaw(check_plain('<strong>Menu item description arguments</strong>'));
  }

  /**
   * Test the theme callback when it is set to use an administrative theme.
   */
  function testThemeCallbackAdministrative() {
    theme_enable(array(
      'seven',
    ));
    $this
      ->drupalGet('menu-test/theme-callback/use-admin-theme');
    $this
      ->assertText('Custom theme: seven. Actual theme: seven.', 'The administrative theme can be correctly set in a theme callback.');
    $this
      ->assertRaw('seven/style.css', "The administrative theme's CSS appears on the page.");
  }

  /**
   * Test that the theme callback is properly inherited.
   */
  function testThemeCallbackInheritance() {
    theme_enable(array(
      'seven',
    ));
    $this
      ->drupalGet('menu-test/theme-callback/use-admin-theme/inheritance');
    $this
      ->assertText('Custom theme: seven. Actual theme: seven. Theme callback inheritance is being tested.', 'Theme callback inheritance correctly uses the administrative theme.');
    $this
      ->assertRaw('seven/style.css', "The administrative theme's CSS appears on the page.");
  }

  /**
   * Test that 'page callback', 'file' and 'file path' keys are properly
   * inherited from parent menu paths.
   */
  function testFileInheritance() {
    $this
      ->drupalGet('admin/config/development/file-inheritance');
    $this
      ->assertText('File inheritance test description', 'File inheritance works.');
  }

  /**
   * Test path containing "exotic" characters.
   */
  function testExoticPath() {
    $path = "menu-test/ -._~!\$'\"()*@[]?&+%#,;=:" . "%23%25%26%2B%2F%3F" . "éøïвβ中國書۞";

    // Characters from various non-ASCII alphabets.
    $this
      ->drupalGet($path);
    $this
      ->assertRaw('This is menu_test_callback().');
  }

  /**
   * Test the theme callback when the site is in maintenance mode.
   */
  function testThemeCallbackMaintenanceMode() {
    config('system.maintenance')
      ->set('enabled', 1)
      ->save();
    theme_enable(array(
      'seven',
    ));

    // For a regular user, the fact that the site is in maintenance mode means
    // we expect the theme callback system to be bypassed entirely.
    $this
      ->drupalGet('menu-test/theme-callback/use-admin-theme');
    $this
      ->assertRaw('bartik/css/style.css', "The maintenance theme's CSS appears on the page.");

    // An administrator, however, should continue to see the requested theme.
    $admin_user = $this
      ->drupalCreateUser(array(
      'access site in maintenance mode',
    ));
    $this
      ->drupalLogin($admin_user);
    $this
      ->drupalGet('menu-test/theme-callback/use-admin-theme');
    $this
      ->assertText('Custom theme: seven. Actual theme: seven.', 'The theme callback system is correctly triggered for an administrator when the site is in maintenance mode.');
    $this
      ->assertRaw('seven/style.css', "The administrative theme's CSS appears on the page.");
    config('system.maintenance')
      ->set('enabled', 0)
      ->save();
  }

  /**
   * Make sure the maintenance mode can be bypassed using hook_menu_site_status_alter().
   *
   * @see hook_menu_site_status_alter().
   */
  function testMaintenanceModeLoginPaths() {
    config('system.maintenance')
      ->set('enabled', 1)
      ->save();
    $offline_message = t('@site is currently under maintenance. We should be back shortly. Thank you for your patience.', array(
      '@site' => config('system.site')
        ->get('name'),
    ));
    $this
      ->drupalGet('test-page');
    $this
      ->assertText($offline_message);
    $this
      ->drupalGet('menu_login_callback');
    $this
      ->assertText('This is menu_login_callback().', 'Maintenance mode can be bypassed through hook_menu_site_status_alter().');
    config('system.maintenance')
      ->set('enabled', 0)
      ->save();
  }

  /**
   * Test that an authenticated user hitting 'user/login' gets redirected to
   * 'user' and 'user/register' gets redirected to the user edit page.
   */
  function testAuthUserUserLogin() {
    $web_user = $this
      ->drupalCreateUser(array());
    $this
      ->drupalLogin($web_user);
    $this
      ->drupalGet('user/login');

    // Check that we got to 'user'.
    $this
      ->assertTrue($this->url == url('user/' . $this->loggedInUser->uid, array(
      'absolute' => TRUE,
    )), "Logged-in user redirected to user on accessing user/login");

    // user/register should redirect to user/UID/edit.
    $this
      ->drupalGet('user/register');
    $this
      ->assertTrue($this->url == url('user/' . $this->loggedInUser->uid . '/edit', array(
      'absolute' => TRUE,
    )), "Logged-in user redirected to user/UID/edit on accessing user/register");
  }

  /**
   * Test the theme callback when it is set to use an optional theme.
   */
  function testThemeCallbackOptionalTheme() {

    // Request a theme that is not enabled.
    $this
      ->drupalGet('menu-test/theme-callback/use-stark-theme');
    $this
      ->assertText('Custom theme: NONE. Actual theme: bartik.', 'The theme callback system falls back on the default theme when a theme that is not enabled is requested.');
    $this
      ->assertRaw('bartik/css/style.css', "The default theme's CSS appears on the page.");

    // Now enable the theme and request it again.
    theme_enable(array(
      'stark',
    ));
    $this
      ->drupalGet('menu-test/theme-callback/use-stark-theme');
    $this
      ->assertText('Custom theme: stark. Actual theme: stark.', 'The theme callback system uses an optional theme once it has been enabled.');
    $this
      ->assertRaw('stark/css/layout.css', "The optional theme's CSS appears on the page.");
  }

  /**
   * Test the theme callback when it is set to use a theme that does not exist.
   */
  function testThemeCallbackFakeTheme() {
    $this
      ->drupalGet('menu-test/theme-callback/use-fake-theme');
    $this
      ->assertText('Custom theme: NONE. Actual theme: bartik.', 'The theme callback system falls back on the default theme when a theme that does not exist is requested.');
    $this
      ->assertRaw('bartik/css/style.css', "The default theme's CSS appears on the page.");
  }

  /**
   * Test the theme callback when no theme is requested.
   */
  function testThemeCallbackNoThemeRequested() {
    $this
      ->drupalGet('menu-test/theme-callback/no-theme-requested');
    $this
      ->assertText('Custom theme: NONE. Actual theme: bartik.', 'The theme callback system falls back on the default theme when no theme is requested.');
    $this
      ->assertRaw('bartik/css/style.css', "The default theme's CSS appears on the page.");
  }

  /**
   * Test that hook_custom_theme() can control the theme of a page.
   */
  function testHookCustomTheme() {

    // Trigger hook_custom_theme() to dynamically request the Stark theme for
    // the requested page.
    state()
      ->set('menu_test.hook_custom_theme_name', 'stark');
    theme_enable(array(
      'stark',
      'seven',
    ));

    // Visit a page that does not implement a theme callback. The above request
    // should be honored.
    $this
      ->drupalGet('menu-test/no-theme-callback');
    $this
      ->assertText('Custom theme: stark. Actual theme: stark.', 'The result of hook_custom_theme() is used as the theme for the current page.');
    $this
      ->assertRaw('stark/css/layout.css', "The Stark theme's CSS appears on the page.");
  }

  /**
   * Test that the theme callback wins out over hook_custom_theme().
   */
  function testThemeCallbackHookCustomTheme() {

    // Trigger hook_custom_theme() to dynamically request the Stark theme for
    // the requested page.
    state()
      ->set('menu_test.hook_custom_theme_name', 'stark');
    theme_enable(array(
      'stark',
      'seven',
    ));

    // The menu "theme callback" should take precedence over a value set in
    // hook_custom_theme().
    $this
      ->drupalGet('menu-test/theme-callback/use-admin-theme');
    $this
      ->assertText('Custom theme: seven. Actual theme: seven.', 'The result of hook_custom_theme() does not override what was set in a theme callback.');
    $this
      ->assertRaw('seven/style.css', "The Seven theme's CSS appears on the page.");
  }

  /**
   * Tests for menu_link_maintain().
   */
  function testMenuLinkMaintain() {
    $admin_user = $this
      ->drupalCreateUser(array(
      'access content',
      'administer site configuration',
    ));
    $this
      ->drupalLogin($admin_user);

    // Create three menu items.
    menu_link_maintain('menu_test', 'insert', 'menu_test_maintain/1', 'Menu link #1');
    menu_link_maintain('menu_test', 'insert', 'menu_test_maintain/1', 'Menu link #1-main');
    menu_link_maintain('menu_test', 'insert', 'menu_test_maintain/2', 'Menu link #2');

    // Move second link to the main-menu, to test caching later on.
    db_update('menu_links')
      ->fields(array(
      'menu_name' => 'main',
    ))
      ->condition('link_title', 'Menu link #1-main')
      ->condition('customized', 0)
      ->condition('module', 'menu_test')
      ->execute();
    menu_cache_clear_all();

    // Load front page.
    $this
      ->drupalGet('');
    $this
      ->assertLink('Menu link #1');
    $this
      ->assertLink('Menu link #1-main');
    $this
      ->assertLink('Menu link #2');

    // Rename all links for the given path.
    menu_link_maintain('menu_test', 'update', 'menu_test_maintain/1', 'Menu link updated');

    // Load a different page to be sure that we have up to date information.
    $this
      ->drupalGet('menu_test_maintain/1');
    $this
      ->assertLink('Menu link updated');
    $this
      ->assertNoLink('Menu link #1');
    $this
      ->assertNoLink('Menu link #1-main');
    $this
      ->assertLink('Menu link #2');

    // Delete all links for the given path.
    menu_link_maintain('menu_test', 'delete', 'menu_test_maintain/1', '');

    // Load a different page to be sure that we have up to date information.
    $this
      ->drupalGet('menu_test_maintain/2');
    $this
      ->assertNoLink('Menu link updated');
    $this
      ->assertNoLink('Menu link #1');
    $this
      ->assertNoLink('Menu link #1-main');
    $this
      ->assertLink('Menu link #2');
  }

  /**
   * Tests for menu_name parameter for hook_menu().
   */
  function testMenuName() {
    $admin_user = $this
      ->drupalCreateUser(array(
      'administer site configuration',
    ));
    $this
      ->drupalLogin($admin_user);
    $sql = "SELECT menu_name FROM {menu_links} WHERE router_path = 'menu_name_test'";
    $name = db_query($sql)
      ->fetchField();
    $this
      ->assertEqual($name, 'original', 'Menu name is "original".');

    // Change the menu_name parameter in menu_test.module, then force a menu
    // rebuild.
    menu_test_menu_name('changed');
    menu_router_rebuild();
    $sql = "SELECT menu_name FROM {menu_links} WHERE router_path = 'menu_name_test'";
    $name = db_query($sql)
      ->fetchField();
    $this
      ->assertEqual($name, 'changed', 'Menu name was successfully changed after rebuild.');
  }

  /**
   * Tests for menu hierarchy.
   */
  function testMenuHierarchy() {
    $parent_link = db_query('SELECT * FROM {menu_links} WHERE link_path = :link_path', array(
      ':link_path' => 'menu-test/hierarchy/parent',
    ))
      ->fetchAssoc();
    $child_link = db_query('SELECT * FROM {menu_links} WHERE link_path = :link_path', array(
      ':link_path' => 'menu-test/hierarchy/parent/child',
    ))
      ->fetchAssoc();
    $unattached_child_link = db_query('SELECT * FROM {menu_links} WHERE link_path = :link_path', array(
      ':link_path' => 'menu-test/hierarchy/parent/child2/child',
    ))
      ->fetchAssoc();
    $this
      ->assertEqual($child_link['plid'], $parent_link['mlid'], 'The parent of a directly attached child is correct.');
    $this
      ->assertEqual($unattached_child_link['plid'], $parent_link['mlid'], 'The parent of a non-directly attached child is correct.');
  }

  /**
   * Tests menu link depth and parents of local tasks and menu callbacks.
   */
  function testMenuHidden() {

    // Verify links for one dynamic argument.
    $links = db_select('menu_links', 'ml')
      ->fields('ml')
      ->condition('ml.router_path', 'menu-test/hidden/menu%', 'LIKE')
      ->orderBy('ml.router_path')
      ->execute()
      ->fetchAllAssoc('router_path', PDO::FETCH_ASSOC);
    $parent = $links['menu-test/hidden/menu'];
    $depth = $parent['depth'] + 1;
    $plid = $parent['mlid'];
    $link = $links['menu-test/hidden/menu/list'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/menu/add'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/menu/settings'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/menu/manage/%'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $parent = $links['menu-test/hidden/menu/manage/%'];
    $depth = $parent['depth'] + 1;
    $plid = $parent['mlid'];
    $link = $links['menu-test/hidden/menu/manage/%/list'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/menu/manage/%/add'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/menu/manage/%/edit'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/menu/manage/%/delete'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));

    // Verify links for two dynamic arguments.
    $links = db_select('menu_links', 'ml')
      ->fields('ml')
      ->condition('ml.router_path', 'menu-test/hidden/block%', 'LIKE')
      ->orderBy('ml.router_path')
      ->execute()
      ->fetchAllAssoc('router_path', PDO::FETCH_ASSOC);
    $parent = $links['menu-test/hidden/block'];
    $depth = $parent['depth'] + 1;
    $plid = $parent['mlid'];
    $link = $links['menu-test/hidden/block/list'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/block/add'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/block/manage/%/%'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $parent = $links['menu-test/hidden/block/manage/%/%'];
    $depth = $parent['depth'] + 1;
    $plid = $parent['mlid'];
    $link = $links['menu-test/hidden/block/manage/%/%/configure'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
    $link = $links['menu-test/hidden/block/manage/%/%/delete'];
    $this
      ->assertEqual($link['depth'], $depth, format_string('%path depth @link_depth is equal to @depth.', array(
      '%path' => $link['router_path'],
      '@link_depth' => $link['depth'],
      '@depth' => $depth,
    )));
    $this
      ->assertEqual($link['plid'], $plid, format_string('%path plid @link_plid is equal to @plid.', array(
      '%path' => $link['router_path'],
      '@link_plid' => $link['plid'],
      '@plid' => $plid,
    )));
  }

  /**
   * Test menu_get_item() with empty ancestors.
   */
  function testMenuGetItemNoAncestors() {
    state()
      ->set('menu.masks', array());
    $this
      ->drupalGet('');
  }

  /**
   * Test menu_set_item().
   */
  function testMenuSetItem() {
    $item = menu_get_item('test-page');
    $this
      ->assertEqual($item['path'], 'test-page', "Path from menu_get_item('test-page') is equal to 'test-page'", 'menu');

    // Modify the path for the item then save it.
    $item['path'] = 'test-page-test';
    $item['href'] = 'test-page-test';
    menu_set_item('test-page', $item);
    $compare_item = menu_get_item('test-page');
    $this
      ->assertEqual($compare_item, $item, 'Modified menu item is equal to newly retrieved menu item.', 'menu');
  }

  /**
   * Test menu maintenance hooks.
   */
  function testMenuItemHooks() {

    // Create an item.
    menu_link_maintain('menu_test', 'insert', 'menu_test_maintain/4', 'Menu link #4');
    $this
      ->assertEqual(menu_test_static_variable(), 'insert', 'hook_menu_link_insert() fired correctly');

    // Update the item.
    menu_link_maintain('menu_test', 'update', 'menu_test_maintain/4', 'Menu link updated');
    $this
      ->assertEqual(menu_test_static_variable(), 'update', 'hook_menu_link_update() fired correctly');

    // Delete the item.
    menu_link_maintain('menu_test', 'delete', 'menu_test_maintain/4', '');
    $this
      ->assertEqual(menu_test_static_variable(), 'delete', 'hook_menu_link_delete() fired correctly');
  }

  /**
   * Test menu link 'options' storage and rendering.
   */
  function testMenuLinkOptions() {

    // Create a menu link with options.
    $menu_link = array(
      'link_title' => 'Menu link options test',
      'link_path' => 'test-page',
      'module' => 'menu_test',
      'options' => array(
        'attributes' => array(
          'title' => 'Test title attribute',
        ),
        'query' => array(
          'testparam' => 'testvalue',
        ),
      ),
    );
    menu_link_save($menu_link);

    // Load front page.
    $this
      ->drupalGet('test-page');
    $this
      ->assertRaw('title="Test title attribute"', 'Title attribute of a menu link renders.');
    $this
      ->assertRaw('testparam=testvalue', 'Query parameter added to menu link.');
  }

  /**
   * Tests the possible ways to set the title for menu items.
   * Also tests that menu item titles work with string overrides.
   */
  function testMenuItemTitlesCases() {

    // Build array with string overrides.
    $test_data = array(
      1 => array(
        'Example title - Case 1' => 'Alternative example title - Case 1',
      ),
      2 => array(
        'Example @sub1 - Case @op2' => 'Alternative example @sub1 - Case @op2',
      ),
      3 => array(
        'Example title' => 'Alternative example title',
      ),
      4 => array(
        'Example title' => 'Alternative example title',
      ),
    );
    foreach ($test_data as $case_no => $override) {
      $this
        ->menuItemTitlesCasesHelper($case_no);
      variable_set('locale_custom_strings_en', array(
        '' => $override,
      ));
      $this
        ->menuItemTitlesCasesHelper($case_no, TRUE);
      variable_set('locale_custom_strings_en', array());
    }
  }

  /**
   * Get a URL and assert the title given a case number. If override is true,
   * the title is asserted to begin with "Alternative".
   */
  private function menuItemTitlesCasesHelper($case_no, $override = FALSE) {
    $this
      ->drupalGet('menu-title-test/case' . $case_no);
    $this
      ->assertResponse(200);
    $asserted_title = $override ? 'Alternative example title - Case ' . $case_no : 'Example title - Case ' . $case_no;
    $this
      ->assertTitle($asserted_title . ' | Drupal', format_string('Menu title is: %title.', array(
      '%title' => $asserted_title,
    )), 'Menu');
  }

  /**
   * Load the router for a given path.
   */
  protected function menuLoadRouter($router_path) {
    return db_query('SELECT * FROM {menu_router} WHERE path = :path', array(
      ':path' => $router_path,
    ))
      ->fetchAssoc();
  }

  /**
   * Tests inheritance of 'load arguments'.
   */
  function testMenuLoadArgumentsInheritance() {
    $expected = array(
      'menu-test/arguments/%/%' => array(
        2 => array(
          'menu_test_argument_load' => array(
            3,
          ),
        ),
        3 => NULL,
      ),
      // Arguments are inherited to normal children.
      'menu-test/arguments/%/%/default' => array(
        2 => array(
          'menu_test_argument_load' => array(
            3,
          ),
        ),
        3 => NULL,
      ),
      // Arguments are inherited to tab children.
      'menu-test/arguments/%/%/task' => array(
        2 => array(
          'menu_test_argument_load' => array(
            3,
          ),
        ),
        3 => NULL,
      ),
      // Arguments are only inherited to the same loader functions.
      'menu-test/arguments/%/%/common-loader' => array(
        2 => array(
          'menu_test_argument_load' => array(
            3,
          ),
        ),
        3 => 'menu_test_other_argument_load',
      ),
      // Arguments are not inherited to children not using the same loader
      // function.
      'menu-test/arguments/%/%/different-loaders-1' => array(
        2 => NULL,
        3 => 'menu_test_argument_load',
      ),
      'menu-test/arguments/%/%/different-loaders-2' => array(
        2 => 'menu_test_other_argument_load',
        3 => NULL,
      ),
      'menu-test/arguments/%/%/different-loaders-3' => array(
        2 => NULL,
        3 => NULL,
      ),
      // Explicit loader arguments should not be overriden by parent.
      'menu-test/arguments/%/%/explicit-arguments' => array(
        2 => array(
          'menu_test_argument_load' => array(),
        ),
        3 => NULL,
      ),
    );
    foreach ($expected as $router_path => $load_functions) {
      $router_item = $this
        ->menuLoadRouter($router_path);
      $this
        ->assertIdentical(unserialize($router_item['load_functions']), $load_functions, format_string('Expected load functions for router %router_path', array(
        '%router_path' => $router_path,
      )));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
RouterTest::$modules public static property Modules to enable.
RouterTest::getInfo public static function
RouterTest::menuItemTitlesCasesHelper private function Get a URL and assert the title given a case number. If override is true, the title is asserted to begin with "Alternative".
RouterTest::menuLoadRouter protected function Load the router for a given path.
RouterTest::setUp function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
RouterTest::testAuthUserUserLogin function Test that an authenticated user hitting 'user/login' gets redirected to 'user' and 'user/register' gets redirected to the user edit page.
RouterTest::testDescriptionMenuItems function Tests menu item descriptions.
RouterTest::testExoticPath function Test path containing "exotic" characters.
RouterTest::testFileInheritance function Test that 'page callback', 'file' and 'file path' keys are properly inherited from parent menu paths.
RouterTest::testHookCustomTheme function Test that hook_custom_theme() can control the theme of a page.
RouterTest::testMaintenanceModeLoginPaths function Make sure the maintenance mode can be bypassed using hook_menu_site_status_alter().
RouterTest::testMenuGetItemNoAncestors function Test menu_get_item() with empty ancestors.
RouterTest::testMenuHidden function Tests menu link depth and parents of local tasks and menu callbacks.
RouterTest::testMenuHierarchy function Tests for menu hierarchy.
RouterTest::testMenuItemHooks function Test menu maintenance hooks.
RouterTest::testMenuItemTitlesCases function Tests the possible ways to set the title for menu items. Also tests that menu item titles work with string overrides.
RouterTest::testMenuLinkMaintain function Tests for menu_link_maintain().
RouterTest::testMenuLinkOptions function Test menu link 'options' storage and rendering.
RouterTest::testMenuLoadArgumentsInheritance function Tests inheritance of 'load arguments'.
RouterTest::testMenuName function Tests for menu_name parameter for hook_menu().
RouterTest::testMenuSetItem function Test menu_set_item().
RouterTest::testThemeCallbackAdministrative function Test the theme callback when it is set to use an administrative theme.
RouterTest::testThemeCallbackFakeTheme function Test the theme callback when it is set to use a theme that does not exist.
RouterTest::testThemeCallbackHookCustomTheme function Test that the theme callback wins out over hook_custom_theme().
RouterTest::testThemeCallbackInheritance function Test that the theme callback is properly inherited.
RouterTest::testThemeCallbackMaintenanceMode function Test the theme callback when the site is in maintenance mode.
RouterTest::testThemeCallbackNoThemeRequested function Test the theme callback when no theme is requested.
RouterTest::testThemeCallbackOptionalTheme function Test the theme callback when it is set to use an optional theme.
RouterTest::testTitleCallbackFalse function Test title callback set to FALSE.
RouterTest::testTitleMenuCallback function Tests page title of MENU_CALLBACKs.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$databasePrefix protected property The database prefix of this test run.
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::$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. 3
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::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().
TestBase::run public function Run all tests in this class.
TestBase::verbose protected function Logs verbose message in a text file.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$content protected property The content of the page currently loaded in the internal browser.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$drupalSettings protected property The value of the Drupal.settings JavaScript variable for the page currently loaded in the internal browser.
WebTestBase::$elements protected property The parsed version of the page. 1
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$httpauth_credentials protected property HTTP authentication credentials (<username>:<password>).
WebTestBase::$httpauth_method protected property HTTP authentication method
WebTestBase::$kernel protected property The kernel used in this test.
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing purposes.
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing purposes.
WebTestBase::$plainTextContent protected property The content of the page currently loaded in the internal browser (plain text version).
WebTestBase::$profile protected property The profile to install as a basis for testing. 35
WebTestBase::$redirect_count protected property The number of redirects followed during the handling of a request.
WebTestBase::$session_id protected property The current session ID, if available.
WebTestBase::$session_name protected property The current session name, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::assertField protected function Asserts that a field exists with the given name or id.
WebTestBase::assertFieldById protected function Asserts that a field exists in the current page with the given id and value.
WebTestBase::assertFieldByName protected function Asserts that a field exists in the current page with the given name and value.
WebTestBase::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
WebTestBase::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
WebTestBase::assertLink protected function Pass if a link with the specified label is found, and optional with the specified index.
WebTestBase::assertLinkByHref protected function Pass if a link containing a given href (part) is found.
WebTestBase::assertMail protected function Asserts that the most recently sent e-mail message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent e-mail message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent e-mail message has the string in it.
WebTestBase::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
WebTestBase::assertNoField protected function Asserts that a field does not exist with the given name or id.
WebTestBase::assertNoFieldById protected function Asserts that a field does not exist with the given id and value.
WebTestBase::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
WebTestBase::assertNoFieldByXPath protected function Asserts that a field does not exist in the current page by the given XPath.
WebTestBase::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
WebTestBase::assertNoLink protected function Pass if a link with the specified label is not found.
WebTestBase::assertNoLinkByHref protected function Pass if a link containing a given href (part) is not found.
WebTestBase::assertNoOption protected function Asserts that a select option in the current page does not exist.
WebTestBase::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
WebTestBase::assertNoPattern protected function Will trigger a pass if the perl regex pattern is not present in raw content.
WebTestBase::assertNoRaw protected function Pass if the raw text is NOT found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertNoText protected function Pass if the text is NOT found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
WebTestBase::assertNoTitle protected function Pass if the page title is not the given string.
WebTestBase::assertNoUniqueText protected function Pass if the text is found MORE THAN ONCE on the text version of the page.
WebTestBase::assertOption protected function Asserts that a select option in the current page exists.
WebTestBase::assertOptionSelected protected function Asserts that a select option in the current page is checked.
WebTestBase::assertPattern protected function Will trigger a pass if the Perl regex pattern is found in the raw content.
WebTestBase::assertRaw protected function Pass if the raw text IS found on the loaded page, fail otherwise. Raw text refers to the raw HTML that the page generated.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertText protected function Pass if the text IS found on the text version of the page. The text version is the equivalent of what a user would see when viewing through a web browser. In other words the HTML has been filtered out of the contents.
WebTestBase::assertTextHelper protected function Helper for assertText and assertNoText.
WebTestBase::assertThemeOutput protected function Asserts themed output.
WebTestBase::assertTitle protected function Pass if the page title is the given string.
WebTestBase::assertUniqueText protected function Pass if the text is found ONLY ONCE on the text version of the page.
WebTestBase::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
WebTestBase::assertUrl protected function Pass if the internal browser's URL matches the given path.
WebTestBase::buildXPathQuery protected function Builds an XPath query.
WebTestBase::checkForMetaRefresh protected function Check for meta refresh tag and if found call drupalGet() recursively. This function looks for the http-equiv attribute to be set to "Refresh" and is case-sensitive.
WebTestBase::checkPermissions protected function Check to make sure that the array of permissions are valid.
WebTestBase::clickLink protected function Follows a link by name.
WebTestBase::constructFieldXpath protected function Helper function: construct an XPath for the given set of attributes and value.
WebTestBase::createTypedData protected function Creates a typed data object and executes some basic assertions.
WebTestBase::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request.
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
WebTestBase::drupalCreateRole protected function Internal helper function; Create a role with specified permissions.
WebTestBase::drupalCreateUser protected function Create a user with a given set of permissions.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path.
WebTestBase::drupalGetAJAX protected function Retrieve a Drupal path or an absolute path and JSON decode the result.
WebTestBase::drupalGetContent protected function Gets the current raw HTML of requested page.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header. If multiple requests were required to retrieve the page, only the headers from the last request will be checked by default. However, if TRUE is passed as the second argument, all requests will be processed…
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. Normally we are only interested in the headers returned by the last request. However, if a page is redirected or HTTP authentication is in use, multiple requests will be required to retrieve the…
WebTestBase::drupalGetMails protected function Gets an array containing all e-mails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetSettings protected function Gets the value of the Drupal.settings JavaScript variable for the currently loaded page.
WebTestBase::drupalGetTestFiles protected function Get a list files that can be used in tests.
WebTestBase::drupalGetToken protected function Generate a token for the currently logged in user.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function
WebTestBase::drupalPost protected function Execute a POST request on a Drupal page. It will be done as usual POST request with SimpleBrowser.
WebTestBase::drupalPostAJAX protected function Execute an Ajax submission.
WebTestBase::drupalSetContent protected function Sets the raw HTML content. This can be useful when a page has been fetched outside of the internal browser and assertions need to be made on the returned page.
WebTestBase::drupalSetSettings protected function Sets the value of the Drupal.settings JavaScript variable for the currently loaded page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAllOptions protected function Get all option elements, including nested options, in a select.
WebTestBase::getSelectedItem protected function Get the selected value from a select field.
WebTestBase::getUrl protected function Get the current URL from the cURL handler.
WebTestBase::handleForm protected function Handle form input related to drupalPost(). Ensure that the specified fields exist and attempt to create POST data in the correct manner for the particular field type.
WebTestBase::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
WebTestBase::refreshVariables protected function Refresh the in-memory set of variables. Useful after a page request is made that changes a variable in a different thread. 1
WebTestBase::resetAll protected function Reset all data structures after having enabled new modules.
WebTestBase::tearDown protected function Delete created files and temporary files directory, delete the tables created by setUp(), and reset the database prefix. Overrides TestBase::tearDown 6
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::xpath protected function Perform an xpath search on the contents of the internal browser. The search is relative to the root element (HTML tag normally) of the page.
WebTestBase::__construct function Constructor for Drupal\simpletest\WebTestBase. Overrides TestBase::__construct