trait PanelizerTestTrait in Panelizer 8.4

trait PanelizerTestTrait {

  /**
   * Log in as user 1.
   */
  protected function loginUser1() {

    // Log in as user 1.

    /* @var \Drupal\user\Entity\User $account */
    $account = User::load(1);
    $password = 'foo';
    $account
      ->setPassword($password)
      ->save();

    // Support old and new tests.
    $account->passRaw = $password;
    $account->pass_raw = $password;
    $this
      ->drupalLogin($account);
  }

  /**
   * Prep a content type for use with these tests.
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   */
  protected function setupContentType($content_type = 'page') {

    // Log in as user 1.
    $this
      ->loginUser1();

    // Create the content type.
    $this
      ->drupalCreateContentType([
      'type' => $content_type,
      'name' => 'Page',
    ]);

    // Allow each node to have a customized display.
    $this
      ->panelize($content_type, NULL, [
      'panelizer[custom]' => TRUE,
    ]);

    // Logout so that a new user can log in.
    $this
      ->drupalLogout();
  }

  /**
   * Create a test node.
   *
   * @param string $type
   *   The entity type to create, defaults to 'page'.
   *
   * @return object
   *   An example node.
   */
  protected function createTestNode($type = 'page') {

    // Create a test node.
    return $this
      ->drupalCreateNode([
      'title' => t('Hello, world!'),
      'type' => $type,
    ]);
  }

  /**
   * Panelizes a node type's default view display.
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   * @param string $display
   *   (optional) The view mode to work on.
   * @param array $values
   *   (optional) Additional form values.
   */
  protected function panelize($content_type = 'page', $display = NULL, array $values = []) {
    $this
      ->drupalGet("admin/structure/types");
    $this
      ->assertResponse(200);
    $this
      ->drupalGet("admin/structure/types/manage/{$content_type}");
    $this
      ->assertResponse(200);
    $path = "admin/structure/types/manage/{$content_type}/display";
    if (!empty($display)) {
      $path .= '/' . $display;
    }
    $this
      ->drupalGet($path);
    $this
      ->assertResponse(200);
    $edit = [
      'panelizer[enable]' => TRUE,
    ] + $values;
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertResponse(200);
    \Drupal::service('entity_display.repository')
      ->getFormDisplay('node', $content_type, 'default')
      ->setComponent('panelizer', [
      'type' => 'panelizer',
    ])
      ->save();
  }

  /**
   * Unpanelizes a node type's default view display.
   *
   * Panelizer is disabled for the display, but its configuration is retained.
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   * @param string $display
   *   (optional) The view mode to work on.
   * @param array $values
   *   (optional) Additional form values.
   */
  protected function unpanelize($content_type = 'page', $display = NULL, array $values = []) {
    $this
      ->drupalGet("admin/structure/types/manage/{$content_type}/display/{$display}");
    $this
      ->assertResponse(200);
    $edit = [
      'panelizer[enable]' => FALSE,
    ] + $values;
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertResponse(200);
    \Drupal::service('entity_display.repository')
      ->getFormDisplay('node', $content_type, 'default')
      ->removeComponent('panelizer')
      ->save();
  }

  /**
   *
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   */
  protected function addPanelizerDefault($content_type = 'page', $display = 'default') {
    $label = $this
      ->getRandomGenerator()
      ->word(16);
    $id = strtolower($label);
    $default_id = "node__{$content_type}__{$display}__{$id}";
    $options = [
      'query' => [
        'js' => 'nojs',
      ],
    ];
    $path = "admin/structure/types/manage/{$content_type}/display";
    if (!empty($display)) {
      $path .= '/' . $display;
    }
    $this
      ->drupalGet($path);
    $this
      ->assertResponse(200);
    $this
      ->clickLink('Add a new Panelizer default display');

    // Step 1: Enter the default's label and ID.
    $edit = [
      'id' => $id,
      'label' => $label,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Next'));
    $this
      ->assertResponse(200);

    // Step 2: Define contexts.
    $this
      ->assertUrl("admin/structure/panelizer/add/{$default_id}/contexts", $options);
    $this
      ->drupalPostForm(NULL, [], t('Next'));
    $this
      ->assertResponse(200);

    // Step 3: Select layout.
    $this
      ->assertUrl("admin/structure/panelizer/add/{$default_id}/layout", $options);
    $this
      ->drupalPostForm(NULL, [], t('Next'));
    $this
      ->assertResponse(200);

    // Step 4: If the layout has settings (new since Drupal 8.8), accept the
    // defaults.
    $layout_settings_form = $this
      ->getSession()
      ->getPage()
      ->find('css', '#panels-layout-settings-form');
    if ($layout_settings_form) {
      $layout_settings_form
        ->pressButton('Next');
    }

    // Step 5: Select content.
    $this
      ->assertUrl("admin/structure/panelizer/add/{$default_id}/content", $options);
    $this
      ->drupalPostForm(NULL, [], t('Finish'));
    $this
      ->assertResponse(200);
    return $id;
  }

  /**
   * Deletes a Panelizer default.
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   * @param string $display
   *   (optional) The view mode to work on.
   * @param string $id
   *   (optional) The default ID.
   */
  protected function deletePanelizerDefault($content_type = 'page', $display = 'default', $id = 'default') {
    $this
      ->drupalGet("admin/structure/panelizer/delete/node__{$content_type}__{$display}__{$id}");
    $this
      ->assertResponse(200);
    $this
      ->drupalPostForm(NULL, [], t('Confirm'));
    $this
      ->assertResponse(200);
  }

  /**
   * Asserts that a Panelizer default exists.
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   * @param string $display
   *   (optional) The view mode to work on.
   * @param string $id
   *   (optional) The default ID.
   */
  protected function assertDefaultExists($content_type = 'page', $display = 'default', $id = 'default') {
    $settings = \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', $content_type, $display)
      ->getThirdPartySettings('panelizer');
    $display_exists = isset($settings['displays'][$id]);
    $this
      ->assertTrue($display_exists);
  }

  /**
   * Asserts that a Panelizer default does not exist.
   *
   * @param string $content_type
   *   The content type, i.e. the node bundle ID, to configure; defaults to
   *  'page'.
   * @param string $display
   *   (optional) The view mode to work on.
   * @param string $id
   *   The default ID.
   */
  protected function assertDefaultNotExists($content_type = 'page', $display = 'default', $id = 'default') {
    $settings = \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', $content_type, $display)
      ->getThirdPartySettings('panelizer');
    $display_exists = isset($settings['displays'][$id]);
    $this
      ->assertFalse($display_exists);
  }

}