You are here

Home » API reference » Page Manager 8.4 » PageManagerAdminTest.php

class PageManagerAdminTest in Page Manager 8.4

Same name in this branch
  1. 8.4 page_manager_ui/tests/src/Functional/PageManagerAdminTest.php \Drupal\Tests\page_manager_ui\Functional\PageManagerAdminTest
  2. 8.4 page_manager_ui/tests/src/FunctionalJavascript/PageManagerAdminTest.php \Drupal\Tests\page_manager_ui\FunctionalJavascript\PageManagerAdminTest

Tests the admin UI for page entities.

@group page_manager_ui

Hierarchy

Expanded class hierarchy of PageManagerAdminTest

File

page_manager_ui/tests/src/Functional/PageManagerAdminTest.php, line 16

Namespace

Drupal\Tests\page_manager_ui\Functional
View source 
class PageManagerAdminTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'block',
    'page_manager_ui',
    'page_manager_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalPlaceBlock('local_tasks_block');
    $this
      ->drupalPlaceBlock('local_actions_block');
    $this
      ->drupalPlaceBlock('system_branding_block');
    $this
      ->drupalPlaceBlock('page_title_block');
    \Drupal::service('theme_installer')
      ->install([
      'bartik',
    ]);
    $this
      ->config('system.theme')
      ->set('admin', 'classy')
      ->save();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer pages',
      'access administration pages',
      'view the administration theme',
    ]));

    // Remove the default node_view page to start with a clean UI.
    Page::load('node_view')
      ->delete();
  }

  /**
   * Tests the Page Manager admin UI.
   */
  public function testAdmin() {
    $this
      ->doTestAddPage();
    $this
      ->doTestAccessConditions();
    $this
      ->doTestSelectionCriteria();
    $this
      ->doTestDisablePage();
    $this
      ->doTestAddVariant();
    $this
      ->doTestAddBlock();
    $this
      ->doTestSecondPage();
    $this
      ->doTestEditBlock();
    $this
      ->doTestEditVariant();
    $this
      ->doTestReorderVariants();
    $this
      ->doTestAddPageWithDuplicatePath();
    $this
      ->doTestAdminPath();
    $this
      ->doTestRemoveVariant();
    $this
      ->doTestRemoveBlock();
    $this
      ->doTestAddBlockWithAjax();
    $this
      ->doTestEditBlock();
    $this
      ->doTestExistingPathWithoutParameters();
    $this
      ->doTestUpdateSubmit();
    $this
      ->doTestDeletePage();
  }

  /**
   * Tests adding a page.
   */
  protected function doTestAddPage() {
    $this
      ->drupalGet('admin/structure');
    $this
      ->clickLink('Pages');
    $this
      ->assertText('Add a new page.');

    // Add a new page without a label.
    $this
      ->clickLink('Add page');
    $edit = [
      'id' => 'foo',
      'path' => 'admin/foo',
      'variant_plugin_id' => 'http_status_code',
      'use_admin_theme' => TRUE,
      'description' => 'This is our first test page.',
      // Go through all available steps (we skip them all in doTestSecondPage())
      'wizard_options[access]' => TRUE,
      'wizard_options[selection]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');
    $this
      ->assertText('Administrative title field is required.');

    // Add a new page with a label.
    $edit += [
      'label' => 'Foo',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Test the 'Page access' step.
    $this
      ->assertTitle('Page access | Drupal');
    $access_path = 'admin/structure/page_manager/add/foo/access';
    $this
      ->assertUrl($access_path . '?js=nojs');
    $this
      ->doTestAccessConditions($access_path, FALSE);
    $this
      ->drupalPostForm(NULL, [], 'Next');

    // Test the 'Selection criteria' step.
    $this
      ->assertTitle('Selection criteria | Drupal');
    $selection_path = 'admin/structure/page_manager/add/foo/selection';
    $this
      ->assertUrl($selection_path . '?js=nojs');
    $this
      ->doTestSelectionCriteria($selection_path, FALSE);
    $this
      ->drupalPostForm(NULL, [], 'Next');

    // Configure the variant.
    $edit = [
      'page_variant_label' => 'Status Code',
      'variant_settings[status_code]' => 200,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Finish');
    $this
      ->assertRaw(new FormattableMarkup('The page %label has been added.', [
      '%label' => 'Foo',
    ]));

    // We've gone from the add wizard to the edit wizard.
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/general');
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);
    $this
      ->assertTitle('Foo | Drupal');

    // Change the status code to 403.
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-http_status_code-0__general');
    $edit = [
      'variant_settings[status_code]' => 403,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Update');

    // Set the weight of the 'Status Code' variant to 10.
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/reorder_variants');
    $edit = [
      'variants[foo-http_status_code-0][weight]' => 10,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Update');
    $this
      ->drupalPostForm(NULL, [], 'Update and save');
  }

  /**
   * Tests access conditions step on both add and edit wizard.
   *
   * @param string $path
   *   The path this step is supposed to be at.
   * @param bool|true $redirect
   *   Whether or not to redirect to the path.
   */
  protected function doTestAccessConditions($path = 'admin/structure/page_manager/manage/foo/access', $redirect = TRUE) {
    if ($this
      ->getUrl() !== $path && $redirect) {
      $this
        ->drupalGet($path);
    }
    $this
      ->assertRaw('No required conditions have been configured.');

    // Configure a new condition.
    $edit = [
      'conditions' => 'user_role',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Add Condition');
    $this
      ->assertTitle('Add access condition | Drupal');
    $edit = [
      'roles[authenticated]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('The user is a member of Authenticated user');

    // Make sure we're still on the same wizard.
    $this
      ->assertUrl($path);

    // Edit the condition.
    $this
      ->clickLink('Edit');
    $this
      ->assertTitle('Edit access condition | Drupal');
    $edit = [
      'roles[anonymous]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('The user is a member of Anonymous user, Authenticated user');
    $this
      ->assertUrl($path);

    // Delete the condition.
    $this
      ->clickLink('Delete');
    $this
      ->assertTitle('Are you sure you want to delete the user_role condition? | Drupal');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertRaw('No required conditions have been configured.');
    $this
      ->assertUrl($path);
  }

  /**
   * Tests selection criteria step on both add and edit wizard.
   *
   * @param string $path
   *   The path this step is supposed to be at.
   * @param bool|true $redirect
   *   Whether or not to redirect to the path.
   */
  protected function doTestSelectionCriteria($path = 'admin/structure/page_manager/manage/foo/page_variant__foo-http_status_code-0__selection', $redirect = TRUE) {
    if ($this
      ->getUrl() !== $path && $redirect) {
      $this
        ->drupalGet($path);
    }
    $this
      ->assertRaw('No required conditions have been configured.');

    // Configure a new condition.
    $edit = [
      'conditions' => 'user_role',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Add Condition');
    $this
      ->assertTitle('Add new selection condition | Drupal');
    $edit = [
      'roles[authenticated]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('The user is a member of Authenticated user');

    // Make sure we're still on the add wizard (not the edit wizard).
    $this
      ->assertUrl($path);

    // Edit the condition.
    $this
      ->clickLink('Edit');
    $this
      ->assertTitle('Edit selection condition | Drupal');
    $edit = [
      'roles[anonymous]' => TRUE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save');
    $this
      ->assertRaw('The user is a member of Anonymous user, Authenticated user');
    $this
      ->assertUrl($path);

    // Delete the condition.
    $this
      ->clickLink('Delete');
    $this
      ->assertTitle('Are you sure you want to delete the user_role condition? | Drupal');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertRaw('No required conditions have been configured.');
    $this
      ->assertUrl($path);
  }

  /**
   * Tests disabling a page.
   */
  protected function doTestDisablePage() {
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(403);
    $this
      ->drupalGet('admin/structure/page_manager');
    $this
      ->clickLink('Disable');
    $this
      ->drupalGet('admin/foo');

    // The page should not be found if the page is enabled.
    $this
      ->assertResponse(404);
    $this
      ->drupalGet('admin/structure/page_manager');
    $this
      ->clickLink('Enable');
    $this
      ->drupalGet('admin/foo');

    // Re-enabling the page should make this path available.
    $this
      ->assertResponse(403);
  }

  /**
   * Tests adding a variant.
   */
  protected function doTestAddVariant() {
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/general');

    // Add a new variant.
    $this
      ->clickLink('Add variant');
    $edit = [
      'variant_plugin_id' => 'block_display',
      'label' => 'First',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Set the page title.
    $edit = [
      'variant_settings[page_title]' => 'Example title',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Finish variant wizard without adding blocks.
    $this
      ->drupalPostForm(NULL, [], 'Finish');

    // Save page to apply variant changes.
    $this
      ->drupalPostForm(NULL, [], 'Update and save');

    // Test that the variant is still used but empty.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);

    // Tests that the content region has no content at all.
    $elements = $this
      ->getSession()
      ->getPage()
      ->findAll('css', 'div.region.region-content *');

    // From Drupal 8.7, fallback area for messages is added by default.
    // @see https://www.drupal.org/node/3002643
    if (version_compare(\Drupal::VERSION, '8.7', '<')) {
      $this
        ->assertEmpty($elements);
    }
    else {
      $this
        ->assertCount(1, $elements);
      $this
        ->assertTrue($elements[0]
        ->hasAttribute('data-drupal-messages-fallback'));
    }
  }

  /**
   * Tests adding a block to a variant.
   */
  protected function doTestAddBlock() {
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__content');

    // Add a block to the variant.
    $this
      ->clickLink('Add new block');

    // Assert that the broken/missing block is not visible.
    $this
      ->assertNoText('Broken/Missing');
    $this
      ->clickLink('User account menu');
    $edit = [
      'region' => 'top',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Add block');
    $this
      ->drupalPostForm(NULL, [], 'Update and save');

    // Test that the block is displayed.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);
    $elements = $this
      ->xpath('//div[@class="block-region-top"]/nav/ul[@class="menu"]/li/a');
    $this
      ->assertTitle('Example title | Drupal');
    $expected = [
      'My account',
      'Log out',
    ];
    $links = [];
    foreach ($elements as $element) {
      $links[] = $element
        ->getText();
    }
    $this
      ->assertEqual($expected, $links);

    // Check the block label.
    $this
      ->assertRaw('User account menu');
  }

  /**
   * Creates a second page with another block display.
   */
  protected function doTestSecondPage() {
    $this
      ->drupalGet('admin/structure/page_manager');

    // Add a new page.
    $this
      ->clickLink('Add page');
    $edit = [
      'id' => 'second',
      'label' => 'Second',
      'path' => 'second',
      'variant_plugin_id' => 'block_display',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Configure the variant.
    $edit = [
      'page_variant_label' => 'Second variant',
      'variant_settings[page_title]' => 'Second title',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // We're now on the content step, but we don't need to add any blocks.
    $this
      ->drupalPostForm(NULL, [], 'Finish');
    $this
      ->assertRaw(new FormattableMarkup('The page %label has been added.', [
      '%label' => 'Second',
    ]));

    // Visit both pages, make sure that they do not interfere with each other.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertTitle('Example title | Drupal');
    $this
      ->drupalGet('second');
    $this
      ->assertTitle('Second title | Drupal');
  }

  /**
   * Tests editing a block.
   */
  protected function doTestEditBlock() {
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__general');
    $edit = [
      'variant_settings[page_title]' => 'Updated block label',
      'page_variant_label' => 'Updated block label',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Update and save');

    // Test that the block is displayed.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);

    // Check the block label.
    $this
      ->assertRaw($edit['variant_settings[page_title]']);
  }

  /**
   * Tests editing a variant.
   */
  protected function doTestEditVariant() {
    if (!($block = $this
      ->findBlockByLabel('foo-block_display-0', 'User account menu'))) {
      $this
        ->fail('Block not found');
      return;
    }
    $block_config = $block
      ->getConfiguration();
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__content');
    $this
      ->assertOptionSelected('edit-blocks-' . $block_config['uuid'] . '-region', 'top');
    $this
      ->assertOptionSelected('edit-blocks-' . $block_config['uuid'] . '-weight', 0);
    $form_name = 'blocks[' . $block_config['uuid'] . ']';
    $edit = [
      $form_name . '[region]' => 'bottom',
      $form_name . '[weight]' => -10,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Update');
    $this
      ->assertOptionSelected('edit-blocks-' . $block_config['uuid'] . '-region', 'bottom');
    $this
      ->assertOptionSelected('edit-blocks-' . $block_config['uuid'] . '-weight', -10);
    $this
      ->drupalPostForm(NULL, [], 'Update and save');
  }

  /**
   * Tests reordering variants.
   */
  protected function doTestReorderVariants() {
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);
    $elements = $this
      ->xpath('//div[@class="block-region-bottom"]/nav/ul[@class="menu"]/li/a');
    $expected = [
      'My account',
      'Log out',
    ];
    $links = [];
    foreach ($elements as $element) {
      $links[] = $element
        ->getText();
    }
    $this
      ->assertEqual($expected, $links);
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/general');
    $this
      ->clickLink('Reorder variants');
    $edit = [
      'variants[foo-http_status_code-0][weight]' => -10,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Update');
    $this
      ->drupalPostForm(NULL, [], 'Update and save');
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(403);
  }

  /**
   * Tests adding a page with a duplicate path.
   */
  protected function doTestAddPageWithDuplicatePath() {

    // Try to add a second page with the same path.
    $edit = [
      'label' => 'Bar',
      'id' => 'bar',
      'path' => 'admin/foo',
    ];
    $this
      ->drupalPostForm('admin/structure/page_manager/add', $edit, 'Next');
    $this
      ->assertText('The page path must be unique.');
    $this
      ->drupalGet('admin/structure/page_manager');
    $this
      ->assertNoText('Bar');
  }

  /**
   * Tests changing the admin theme of a page.
   */
  protected function doTestAdminPath() {
    $this
      ->config('system.theme')
      ->set('default', 'bartik')
      ->save();
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertTheme('classy');
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/general');
    $edit = [
      'use_admin_theme' => FALSE,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Update and save');
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertTheme('bartik');

    // Reset theme.
    $this
      ->config('system.theme')
      ->set('default', 'classy')
      ->save();
  }

  /**
   * Tests removing a variant.
   */
  protected function doTestRemoveVariant() {
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-http_status_code-0__general');
    $this
      ->clickLink('Delete this variant');
    $this
      ->assertRaw('Are you sure you want to delete this variant?');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertRaw(new FormattableMarkup('The variant %label has been removed.', [
      '%label' => 'Status Code',
    ]));
    $this
      ->drupalPostForm(NULL, [], 'Update and save');
  }

  /**
   * Tests removing a block.
   */
  protected function doTestRemoveBlock() {

    // Assert that the block is displayed.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);
    $elements = $this
      ->xpath('//div[@class="block-region-bottom"]/nav/ul[@class="menu"]/li/a');
    $expected = [
      'My account',
      'Log out',
    ];
    $links = [];
    foreach ($elements as $element) {
      $links[] = $element
        ->getText();
    }
    $this
      ->assertEqual($expected, $links);
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__content');
    $this
      ->clickLink('Delete');
    $this
      ->assertRaw(new FormattableMarkup('Are you sure you want to delete the block %label?', [
      '%label' => 'User account menu',
    ]));
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertRaw(new FormattableMarkup('The block %label has been removed.', [
      '%label' => 'User account menu',
    ]));
    $this
      ->drupalPostForm(NULL, [], 'Update and save');

    // Assert that the block is now gone.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);
    $elements = $this
      ->xpath('//div[@class="block-region-bottom"]/nav/ul[@class="menu"]/li/a');
    $this
      ->assertTrue(empty($elements));
  }

  /**
   * Tests adding a block with #ajax to a variant.
   */
  protected function doTestAddBlockWithAjax() {
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__content');

    // Add a block to the variant.
    $this
      ->clickLink('Add new block');
    $this
      ->clickLink('Page Manager Test Block');
    $edit = [
      'region' => 'top',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Add block');
    $this
      ->drupalPostForm(NULL, [], 'Update and save');

    // Test that the block is displayed.
    $this
      ->drupalGet('admin/foo');
    $this
      ->assertResponse(200);
    $this
      ->assertText(t('Example output'));

    // Check the block label.
    $this
      ->assertRaw('Page Manager Test Block');
  }

  /**
   * Tests adding a page with an existing path with no route parameters.
   */
  protected function doTestExistingPathWithoutParameters() {

    // Test an existing path.
    $this
      ->drupalGet('admin');
    $this
      ->assertResponse(200);
    $this
      ->drupalGet('admin/structure/page_manager');

    // Add a new page with existing path 'admin'.
    $this
      ->clickLink('Add page');
    $edit = [
      'label' => 'existing',
      'id' => 'existing',
      'path' => 'admin',
      'variant_plugin_id' => 'http_status_code',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Configure the variant.
    $edit = [
      'page_variant_label' => 'Status Code',
      'variant_settings[status_code]' => 404,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Finish');

    // Ensure the existing path leads to the new page.
    $this
      ->drupalGet('admin');
    $this
      ->assertResponse(404);
  }

  /**
   * Tests the Update button on Variant forms.
   */
  protected function doTestUpdateSubmit() {

    // Add a block variant.
    $this
      ->drupalGet('admin/structure/page_manager/manage/foo/general');

    // Add a new variant.
    $this
      ->clickLink('Add variant');
    $edit = [
      'variant_plugin_id' => 'block_display',
      'label' => 'First',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Set the page title.
    $edit = [
      'variant_settings[page_title]' => 'Example title',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');

    // Finish variant wizard without adding blocks.
    $this
      ->drupalPostForm(NULL, [], 'Finish');

    // Update the description and click on Update.
    $edit = [
      'page_variant_label' => 'First updated',
      'variant_settings[page_title]' => 'Example title updated',
    ];
    $this
      ->drupalPostForm('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__general', $edit, 'Update');
    $this
      ->assertFieldByName('page_variant_label', 'First updated');
    $this
      ->assertFieldByName('variant_settings[page_title]', 'Example title updated');

    // Click on Update at Contexts. Nothing should happen.
    $this
      ->drupalPostForm('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__contexts', [], 'Update');
    $this
      ->assertUrl('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__contexts');

    // Click on Update at Selection criteria. Nothing should happen.
    $this
      ->drupalPostForm('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__selection', [], 'Update');
    $this
      ->assertUrl('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__selection');

    // Click on Update at Content. Nothing should happen.
    $this
      ->drupalPostForm('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__content', [], 'Update');
    $this
      ->assertUrl('admin/structure/page_manager/manage/foo/page_variant__foo-block_display-0__content');
  }

  /**
   * Tests deleting a page.
   */
  protected function doTestDeletePage() {
    $this
      ->drupalGet('admin/structure/page_manager');
    $this
      ->clickLink('Delete');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertRaw(new FormattableMarkup('The page %name has been removed.', [
      '%name' => 'existing',
    ]));
    $this
      ->drupalGet('admin');

    // The overridden page is back to its default.
    $this
      ->assertResponse(200);
    $this
      ->drupalGet('admin/structure/page_manager');
    $this
      ->clickLink('Delete');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->assertRaw(new FormattableMarkup('The page %name has been removed.', [
      '%name' => 'Foo',
    ]));
    $this
      ->drupalGet('admin/foo');

    // The custom page is no longer found.
    $this
      ->assertResponse(404);
  }

  /**
   * Tests that default arguments are not removed from existing routes.
   */
  public function testExistingRoutes() {

    // Test that the page without placeholder is accessible.
    $this
      ->drupalGet('admin/structure/page_manager/add');
    $edit = [
      'label' => 'Placeholder test 2',
      'id' => 'placeholder2',
      'path' => '/page-manager-test',
      'variant_plugin_id' => 'http_status_code',
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Next');
    $edit = [
      'variant_settings[status_code]' => 418,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Finish');
    $this
      ->drupalGet('page-manager-test');
    $this
      ->assertResponse(418);

    // Test that the page test is accessible.
    $page_string = 'test-page';
    $this
      ->drupalGet('page-manager-test/' . $page_string);
    $this
      ->assertResponse(200);

    // Without a single variant, it will fall through to the original.
    $this
      ->drupalGet('admin/structure/page_manager/manage/placeholder2/page_variant__placeholder2-http_status_code-0__general');
    $this
      ->clickLink('Delete this variant');
    $this
      ->drupalPostForm(NULL, [], 'Delete');
    $this
      ->drupalPostForm(NULL, [], 'Update and save');
    $this
      ->drupalGet('page-manager-test');
    $this
      ->assertResponse(200);
  }

  /**
   * Asserts that a theme was used for the page.
   *
   * @param string $theme_name
   *   The theme name.
   */
  protected function assertTheme($theme_name) {
    $url = Url::fromUri('base:core/themes/' . $theme_name . '/logo.svg')
      ->toString();
    $elements = $this
      ->xpath('//img[contains(@src, :url)]', [
      ':url' => $url,
    ]);
    $this
      ->assertEqual(count($elements), 1, new FormattableMarkup('Page is rendered in @theme', [
      '@theme' => $theme_name,
    ]));
  }

  /**
   * Finds a block based on its variant and block label.
   *
   * @param string $page_variant_id
   *   The ID of the page variant entity.
   * @param string $block_label
   *   The label of the block.
   *
   * @return \Drupal\Core\Block\BlockPluginInterface|null
   *   Either a block plugin, or NULL.
   */
  protected function findBlockByLabel($page_variant_id, $block_label) {

    /** @var \Drupal\page_manager\Entity\PageVariant $page_variant */
    if ($page_variant = PageVariant::load($page_variant_id)) {

      /** @var \Drupal\ctools\Plugin\BlockVariantInterface $variant_plugin */
      $variant_plugin = $page_variant
        ->getVariantPlugin();
      foreach ($variant_plugin
        ->getRegionAssignments() as $blocks) {

        /** @var \Drupal\Core\Block\BlockPluginInterface[] $blocks */
        foreach ($blocks as $block) {
          if ($block
            ->label() == $block_label) {
            return $block;
          }
        }
      }
    }
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PageManagerAdminTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PageManagerAdminTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
PageManagerAdminTest::assertTheme protected function Asserts that a theme was used for the page.
PageManagerAdminTest::doTestAccessConditions protected function Tests access conditions step on both add and edit wizard.
PageManagerAdminTest::doTestAddBlock protected function Tests adding a block to a variant.
PageManagerAdminTest::doTestAddBlockWithAjax protected function Tests adding a block with #ajax to a variant.
PageManagerAdminTest::doTestAddPage protected function Tests adding a page.
PageManagerAdminTest::doTestAddPageWithDuplicatePath protected function Tests adding a page with a duplicate path.
PageManagerAdminTest::doTestAddVariant protected function Tests adding a variant.
PageManagerAdminTest::doTestAdminPath protected function Tests changing the admin theme of a page.
PageManagerAdminTest::doTestDeletePage protected function Tests deleting a page.
PageManagerAdminTest::doTestDisablePage protected function Tests disabling a page.
PageManagerAdminTest::doTestEditBlock protected function Tests editing a block.
PageManagerAdminTest::doTestEditVariant protected function Tests editing a variant.
PageManagerAdminTest::doTestExistingPathWithoutParameters protected function Tests adding a page with an existing path with no route parameters.
PageManagerAdminTest::doTestRemoveBlock protected function Tests removing a block.
PageManagerAdminTest::doTestRemoveVariant protected function Tests removing a variant.
PageManagerAdminTest::doTestReorderVariants protected function Tests reordering variants.
PageManagerAdminTest::doTestSecondPage protected function Creates a second page with another block display.
PageManagerAdminTest::doTestSelectionCriteria protected function Tests selection criteria step on both add and edit wizard.
PageManagerAdminTest::doTestUpdateSubmit protected function Tests the Update button on Variant forms.
PageManagerAdminTest::findBlockByLabel protected function Finds a block based on its variant and block label.
PageManagerAdminTest::setUp protected function Overrides BrowserTestBase::setUp
PageManagerAdminTest::testAdmin public function Tests the Page Manager admin UI.
PageManagerAdminTest::testExistingRoutes public function Tests that default arguments are not removed from existing routes.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.