You are here

Home » API reference » Zircon Profile 8 » ResponsiveImageFieldDisplayTest.php

class ResponsiveImageFieldDisplayTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/responsive_image/src/Tests/ResponsiveImageFieldDisplayTest.php \Drupal\responsive_image\Tests\ResponsiveImageFieldDisplayTest

Tests responsive image display formatter.

@group responsive_image

Hierarchy

Expanded class hierarchy of ResponsiveImageFieldDisplayTest

File

core/modules/responsive_image/src/Tests/ResponsiveImageFieldDisplayTest.php, line 23
Contains \Drupal\responsive_image\Tests\ResponsiveImageFieldDisplayTest.

Namespace

Drupal\responsive_image\Tests
View source 
class ResponsiveImageFieldDisplayTest extends ImageFieldTestBase {
  protected $dumpHeaders = TRUE;

  /**
   * Responsive image style entity instance we test with.
   *
   * @var \Drupal\responsive_image\Entity\ResponsiveImageStyle
   */
  protected $responsiveImgStyle;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field_ui',
    'responsive_image',
    'responsive_image_test_module',
  );

  /**
   * Drupal\simpletest\WebTestBase\setUp().
   */
  protected function setUp() {
    parent::setUp();

    // Create user.
    $this->adminUser = $this
      ->drupalCreateUser(array(
      'administer responsive images',
      'access content',
      'access administration pages',
      'administer site configuration',
      'administer content types',
      'administer node display',
      'administer nodes',
      'create article content',
      'edit any article content',
      'delete any article content',
      'administer image styles',
    ));
    $this
      ->drupalLogin($this->adminUser);

    // Add responsive image style.
    $this->responsiveImgStyle = entity_create('responsive_image_style', array(
      'id' => 'style_one',
      'label' => 'Style One',
      'breakpoint_group' => 'responsive_image_test_module',
      'fallback_image_style' => 'large',
    ));
  }

  /**
   * Tests responsive image formatters on node display for public files.
   */
  public function testResponsiveImageFieldFormattersPublic() {
    $this
      ->addTestImageStyleMappings();
    $this
      ->doTestResponsiveImageFieldFormatters('public');
  }

  /**
   * Tests responsive image formatters on node display for private files.
   */
  public function testResponsiveImageFieldFormattersPrivate() {
    $this
      ->addTestImageStyleMappings();

    // Remove access content permission from anonymous users.
    user_role_change_permissions(RoleInterface::ANONYMOUS_ID, array(
      'access content' => FALSE,
    ));
    $this
      ->doTestResponsiveImageFieldFormatters('private');
  }

  /**
   * Test responsive image formatters when image style is empty.
   */
  public function testResponsiveImageFieldFormattersEmptyStyle() {
    $this
      ->addTestImageStyleMappings(TRUE);
    $this
      ->doTestResponsiveImageFieldFormatters('public', TRUE);
  }

  /**
   * Add image style mappings to the responsive image style entity.
   *
   * @param bool $empty_styles
   *   If true, the image style mappings will get empty image styles.
   */
  protected function addTestImageStyleMappings($empty_styles = FALSE) {
    if ($empty_styles) {
      $this->responsiveImgStyle
        ->addImageStyleMapping('responsive_image_test_module.mobile', '1x', array(
        'image_mapping_type' => 'image_style',
        'image_mapping' => '',
      ))
        ->addImageStyleMapping('responsive_image_test_module.narrow', '1x', array(
        'image_mapping_type' => 'sizes',
        'image_mapping' => array(
          'sizes' => '(min-width: 700px) 700px, 100vw',
          'sizes_image_styles' => array(),
        ),
      ))
        ->addImageStyleMapping('responsive_image_test_module.wide', '1x', array(
        'image_mapping_type' => 'image_style',
        'image_mapping' => '',
      ))
        ->save();
    }
    else {
      $this->responsiveImgStyle
        ->addImageStyleMapping('responsive_image_test_module.mobile', '1x', array(
        'image_mapping_type' => 'image_style',
        'image_mapping' => RESPONSIVE_IMAGE_EMPTY_IMAGE,
      ))
        ->addImageStyleMapping('responsive_image_test_module.mobile', '1.5x', array(
        'image_mapping_type' => 'image_style',
        'image_mapping' => 'thumbnail',
      ))
        ->addImageStyleMapping('responsive_image_test_module.narrow', '1x', array(
        'image_mapping_type' => 'sizes',
        'image_mapping' => array(
          'sizes' => '(min-width: 700px) 700px, 100vw',
          'sizes_image_styles' => array(
            'large',
            'medium',
          ),
        ),
      ))
        ->addImageStyleMapping('responsive_image_test_module.wide', '1x', array(
        'image_mapping_type' => 'image_style',
        'image_mapping' => 'large',
      ))
        ->addImageStyleMapping('responsive_image_test_module.wide', '3x', array(
        'image_mapping_type' => 'image_style',
        'image_mapping' => RESPONSIVE_IMAGE_ORIGINAL_IMAGE,
      ))
        ->save();
    }
  }

  /**
   * Test responsive image formatters on node display.
   *
   * If the empty styles param is set, then the function only tests for the
   * fallback image style (large).
   *
   * @param string $scheme
   *   File scheme to use.
   * @param bool $empty_styles
   *   If true, use an empty string for image style names.
   * Defaults to false.
   */
  protected function doTestResponsiveImageFieldFormatters($scheme, $empty_styles = FALSE) {

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = $this->container
      ->get('renderer');
    $node_storage = $this->container
      ->get('entity.manager')
      ->getStorage('node');
    $field_name = Unicode::strtolower($this
      ->randomMachineName());
    $this
      ->createImageField($field_name, 'article', array(
      'uri_scheme' => $scheme,
    ));

    // Create a new node with an image attached. Make sure we use a large image
    // so the scale effects of the image styles always have an effect.
    $test_image = current($this
      ->drupalGetTestFiles('image', 39325));

    // Create alt text for the image.
    $alt = $this
      ->randomMachineName();
    $nid = $this
      ->uploadNodeImage($test_image, $field_name, 'article', $alt);
    $node_storage
      ->resetCache(array(
      $nid,
    ));
    $node = $node_storage
      ->load($nid);

    // Test that the default formatter is being used.
    $image_uri = File::load($node->{$field_name}->target_id)
      ->getFileUri();
    $image = array(
      '#theme' => 'image',
      '#uri' => $image_uri,
      '#width' => 360,
      '#height' => 240,
      '#alt' => $alt,
    );
    $default_output = str_replace("\n", NULL, $renderer
      ->renderRoot($image));
    $this
      ->assertRaw($default_output, 'Default formatter displaying correctly on full node view.');

    // Test field not being configured. This should not cause a fatal error.
    $display_options = array(
      'type' => 'responsive_image_test',
      'settings' => ResponsiveImageFormatter::defaultSettings(),
    );
    $display = $this->container
      ->get('entity.manager')
      ->getStorage('entity_view_display')
      ->load('node.article.default');
    if (!$display) {
      $values = [
        'targetEntityType' => 'node',
        'bundle' => 'article',
        'mode' => 'default',
        'status' => TRUE,
      ];
      $display = $this->container
        ->get('entity.manager')
        ->getStorage('entity_view_display')
        ->create($values);
    }
    $display
      ->setComponent($field_name, $display_options)
      ->save();
    $this
      ->drupalGet('node/' . $nid);

    // Test theme function for responsive image, but using the test formatter.
    $display_options = array(
      'type' => 'responsive_image_test',
      'settings' => array(
        'image_link' => 'file',
        'responsive_image_style' => 'style_one',
      ),
    );
    $display = entity_get_display('node', 'article', 'default');
    $display
      ->setComponent($field_name, $display_options)
      ->save();
    $this
      ->drupalGet('node/' . $nid);

    // Use the responsive image formatter linked to file formatter.
    $display_options = array(
      'type' => 'responsive_image',
      'settings' => array(
        'image_link' => 'file',
        'responsive_image_style' => 'style_one',
      ),
    );
    $display = entity_get_display('node', 'article', 'default');
    $display
      ->setComponent($field_name, $display_options)
      ->save();
    $default_output = '<a href="' . file_create_url($image_uri) . '"><picture';
    $this
      ->drupalGet('node/' . $nid);
    $cache_tags_header = $this
      ->drupalGetHeader('X-Drupal-Cache-Tags');
    $this
      ->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
    $this
      ->removeWhiteSpace();
    $this
      ->assertRaw($default_output, 'Image linked to file formatter displaying correctly on full node view.');

    // Verify that the image can be downloaded.
    $this
      ->assertEqual(file_get_contents($test_image->uri), $this
      ->drupalGet(file_create_url($image_uri)), 'File was downloaded successfully.');
    if ($scheme == 'private') {

      // Only verify HTTP headers when using private scheme and the headers are
      // sent by Drupal.
      $this
        ->assertEqual($this
        ->drupalGetHeader('Content-Type'), 'image/png', 'Content-Type header was sent.');
      $this
        ->assertTrue(strstr($this
        ->drupalGetHeader('Cache-Control'), 'private') !== FALSE, 'Cache-Control header was sent.');

      // Log out and try to access the file.
      $this
        ->drupalLogout();
      $this
        ->drupalGet(file_create_url($image_uri));
      $this
        ->assertResponse('403', 'Access denied to original image as anonymous user.');

      // Log in again.
      $this
        ->drupalLogin($this->adminUser);
    }

    // Use the responsive image formatter with a responsive image style.
    $display_options['settings']['responsive_image_style'] = 'style_one';
    $display_options['settings']['image_link'] = '';
    $display
      ->setComponent($field_name, $display_options)
      ->save();

    // Create a derivative so at least one MIME type will be known.
    $large_style = ImageStyle::load('large');
    $large_style
      ->createDerivative($image_uri, $large_style
      ->buildUri($image_uri));

    // Output should contain all image styles and all breakpoints.
    $this
      ->drupalGet('node/' . $nid);
    if (!$empty_styles) {
      $this
        ->assertRaw('/styles/medium/');

      // Make sure the IE9 workaround is present.
      $this
        ->assertRaw('<!--[if IE 9]><video style="display: none;"><![endif]-->');
      $this
        ->assertRaw('<!--[if IE 9]></video><![endif]-->');

      // Assert the empty image is present.
      $this
        ->assertRaw('data:image/gif;base64,R0lGODlhAQABAIABAP///wAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==');
      $thumbnail_style = ImageStyle::load('thumbnail');

      // Assert the output of the 'srcset' attribute (small multipliers first).
      $this
        ->assertRaw('data:image/gif;base64,R0lGODlhAQABAIABAP///wAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw== 1x, ' . $thumbnail_style
        ->buildUrl($image_uri) . ' 1.5x');
      $this
        ->assertRaw('/styles/medium/');

      // Assert the output of the original image.
      $this
        ->assertRaw(file_create_url($image_uri) . ' 3x');

      // Assert the output of the breakpoints.
      $this
        ->assertRaw('media="(min-width: 0px)"');
      $this
        ->assertRaw('media="(min-width: 560px)"');

      // Assert the output of the 'sizes' attribute.
      $this
        ->assertRaw('sizes="(min-width: 700px) 700px, 100vw"');
      $this
        ->assertPattern('/media="\\(min-width: 560px\\)".+?sizes="\\(min-width: 700px\\) 700px, 100vw"/');

      // Assert the output of the 'srcset' attribute (small images first).
      $medium_style = ImageStyle::load('medium');
      $this
        ->assertRaw($medium_style
        ->buildUrl($image_uri) . ' 220w, ' . $large_style
        ->buildUrl($image_uri) . ' 360w');
      $this
        ->assertRaw('media="(min-width: 851px)"');
    }
    $this
      ->assertRaw('/styles/large/');
    $cache_tags = explode(' ', $this
      ->drupalGetHeader('X-Drupal-Cache-Tags'));
    $this
      ->assertTrue(in_array('config:responsive_image.styles.style_one', $cache_tags));
    if (!$empty_styles) {
      $this
        ->assertTrue(in_array('config:image.style.medium', $cache_tags));
      $this
        ->assertTrue(in_array('config:image.style.thumbnail', $cache_tags));
      $this
        ->assertRaw('type="image/png"');
    }
    $this
      ->assertTrue(in_array('config:image.style.large', $cache_tags));

    // Test the fallback image style.
    $image = \Drupal::service('image.factory')
      ->get($image_uri);
    $fallback_image = array(
      '#theme' => 'image',
      '#alt' => $alt,
      '#srcset' => array(
        array(
          'uri' => $large_style
            ->buildUrl($image
            ->getSource()),
        ),
      ),
    );

    // The image.html.twig template has a newline after the <img> tag but
    // responsive-image.html.twig doesn't have one after the fallback image, so
    // we remove it here.
    $default_output = trim($renderer
      ->renderRoot($fallback_image));
    $this
      ->assertRaw($default_output, 'Image style large formatter displaying correctly on full node view.');
    if ($scheme == 'private') {

      // Log out and try to access the file.
      $this
        ->drupalLogout();
      $this
        ->drupalGet($large_style
        ->buildUrl($image_uri));
      $this
        ->assertResponse('403', 'Access denied to image style large as anonymous user.');
      $cache_tags_header = $this
        ->drupalGetHeader('X-Drupal-Cache-Tags');
      $this
        ->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
    }
  }

  /**
   * Tests responsive image formatters on node display linked to the file.
   */
  public function testResponsiveImageFieldFormattersLinkToFile() {
    $this
      ->addTestImageStyleMappings();
    $this
      ->assertResponsiveImageFieldFormattersLink('file');
  }

  /**
   * Tests responsive image formatters on node display linked to the node.
   */
  public function testResponsiveImageFieldFormattersLinkToNode() {
    $this
      ->addTestImageStyleMappings();
    $this
      ->assertResponsiveImageFieldFormattersLink('content');
  }

  /**
   * Tests responsive image formatter on node display with an empty media query.
   */
  public function testResponsiveImageFieldFormattersEmptyMediaQuery() {
    $this->responsiveImgStyle
      ->addImageStyleMapping('responsive_image_test_module.empty', '1x', array(
      'image_mapping_type' => 'image_style',
      'image_mapping' => RESPONSIVE_IMAGE_EMPTY_IMAGE,
    ))
      ->addImageStyleMapping('responsive_image_test_module.mobile', '1x', array(
      'image_mapping_type' => 'image_style',
      'image_mapping' => 'thumbnail',
    ))
      ->save();
    $node_storage = $this->container
      ->get('entity.manager')
      ->getStorage('node');
    $field_name = Unicode::strtolower($this
      ->randomMachineName());
    $this
      ->createImageField($field_name, 'article', array(
      'uri_scheme' => 'public',
    ));

    // Create a new node with an image attached.
    $test_image = current($this
      ->drupalGetTestFiles('image'));
    $nid = $this
      ->uploadNodeImage($test_image, $field_name, 'article', $this
      ->randomMachineName());
    $node_storage
      ->resetCache(array(
      $nid,
    ));

    // Use the responsive image formatter linked to file formatter.
    $display_options = array(
      'type' => 'responsive_image',
      'settings' => array(
        'image_link' => '',
        'responsive_image_style' => 'style_one',
      ),
    );
    $display = entity_get_display('node', 'article', 'default');
    $display
      ->setComponent($field_name, $display_options)
      ->save();

    // View the node.
    $this
      ->drupalGet('node/' . $nid);

    // Assert an empty media attribute is not output.
    $this
      ->assertNoPattern('@srcset="data:image/gif;base64,R0lGODlhAQABAIABAP///wAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw== 1x".+?media=".+?/><source@');

    // Assert the media attribute is present if it has a value.
    $thumbnail_style = ImageStyle::load('thumbnail');
    $node = $node_storage
      ->load($nid);
    $image_uri = File::load($node->{$field_name}->target_id)
      ->getFileUri();
    $this
      ->assertPattern('/srcset="' . preg_quote($thumbnail_style
      ->buildUrl($image_uri), '/') . ' 1x".+?media="\\(min-width: 0px\\)"/');
  }

  /**
   * Tests responsive image formatter on node display with one source.
   */
  public function testResponsiveImageFieldFormattersOneSource() {
    $this->responsiveImgStyle
      ->addImageStyleMapping('responsive_image_test_module.empty', '1x', array(
      'image_mapping_type' => 'image_style',
      'image_mapping' => 'medium',
    ))
      ->addImageStyleMapping('responsive_image_test_module.empty', '2x', array(
      'image_mapping_type' => 'image_style',
      'image_mapping' => 'large',
    ))
      ->save();
    $node_storage = $this->container
      ->get('entity.manager')
      ->getStorage('node');
    $field_name = Unicode::strtolower($this
      ->randomMachineName());
    $this
      ->createImageField($field_name, 'article', array(
      'uri_scheme' => 'public',
    ));

    // Create a new node with an image attached.
    $test_image = current($this
      ->drupalGetTestFiles('image'));
    $nid = $this
      ->uploadNodeImage($test_image, $field_name, 'article', $this
      ->randomMachineName());
    $node_storage
      ->resetCache(array(
      $nid,
    ));

    // Use the responsive image formatter linked to file formatter.
    $display_options = array(
      'type' => 'responsive_image',
      'settings' => array(
        'image_link' => '',
        'responsive_image_style' => 'style_one',
      ),
    );
    $display = entity_get_display('node', 'article', 'default');
    $display
      ->setComponent($field_name, $display_options)
      ->save();

    // View the node.
    $this
      ->drupalGet('node/' . $nid);

    // Assert the media attribute is present if it has a value.
    $large_style = ImageStyle::load('large');
    $medium_style = ImageStyle::load('medium');
    $node = $node_storage
      ->load($nid);
    $image_uri = File::load($node->{$field_name}->target_id)
      ->getFileUri();
    $this
      ->assertRaw('<img srcset="' . $medium_style
      ->buildUrl($image_uri) . ' 1x, ' . $large_style
      ->buildUrl($image_uri) . ' 2x"');
  }

  /**
   * Tests responsive image formatters linked to the file or node.
   *
   * @param string $link_type
   *   The link type to test. Either 'file' or 'content'.
   */
  private function assertResponsiveImageFieldFormattersLink($link_type) {
    $field_name = Unicode::strtolower($this
      ->randomMachineName());
    $field_settings = array(
      'alt_field_required' => 0,
    );
    $this
      ->createImageField($field_name, 'article', array(
      'uri_scheme' => 'public',
    ), $field_settings);

    // Create a new node with an image attached.
    $test_image = current($this
      ->drupalGetTestFiles('image'));

    // Test the image linked to file formatter.
    $display_options = array(
      'type' => 'responsive_image',
      'settings' => array(
        'image_link' => $link_type,
        'responsive_image_style' => 'style_one',
      ),
    );
    entity_get_display('node', 'article', 'default')
      ->setComponent($field_name, $display_options)
      ->save();

    // Ensure that preview works.
    $this
      ->previewNodeImage($test_image, $field_name, 'article');

    // Look for a picture tag in the preview output
    $this
      ->assertPattern('/picture/');
    $nid = $this
      ->uploadNodeImage($test_image, $field_name, 'article');
    $this->container
      ->get('entity.manager')
      ->getStorage('node')
      ->resetCache(array(
      $nid,
    ));
    $node = Node::load($nid);

    // Use the responsive image formatter linked to file formatter.
    $display_options = array(
      'type' => 'responsive_image',
      'settings' => array(
        'image_link' => $link_type,
        'responsive_image_style' => 'style_one',
      ),
    );
    entity_get_display('node', 'article', 'default')
      ->setComponent($field_name, $display_options)
      ->save();

    // Create a derivative so at least one MIME type will be known.
    $large_style = ImageStyle::load('large');
    $image_uri = File::load($node->{$field_name}->target_id)
      ->getFileUri();
    $large_style
      ->createDerivative($image_uri, $large_style
      ->buildUri($image_uri));

    // Output should contain all image styles and all breakpoints.
    $this
      ->drupalGet('node/' . $nid);
    $this
      ->removeWhiteSpace();
    switch ($link_type) {
      case 'file':

        // Make sure the link to the file is present.
        $this
          ->assertPattern('/<a(.*?)href="' . preg_quote(file_create_url($image_uri), '/') . '"(.*?)><picture/');
        break;
      case 'content':

        // Make sure the link to the node is present.
        $this
          ->assertPattern('/<a(.*?)href="' . preg_quote($node
          ->url(), '/') . '"(.*?)><picture/');
        break;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 2
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
ImageFieldTestBase::$adminUser protected property An user with permissions to administer content types and image styles.
ImageFieldTestBase::createImageField function Create a new image field.
ImageFieldTestBase::previewNodeImage function Preview an image in a node.
ImageFieldTestBase::uploadNodeImage function Upload an image to a node.
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.
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.
ResponsiveImageFieldDisplayTest::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. Overrides WebTestBase::$dumpHeaders
ResponsiveImageFieldDisplayTest::$modules public static property Modules to enable. Overrides ImageFieldTestBase::$modules
ResponsiveImageFieldDisplayTest::$responsiveImgStyle protected property Responsive image style entity instance we test with.
ResponsiveImageFieldDisplayTest::addTestImageStyleMappings protected function Add image style mappings to the responsive image style entity.
ResponsiveImageFieldDisplayTest::assertResponsiveImageFieldFormattersLink private function Tests responsive image formatters linked to the file or node.
ResponsiveImageFieldDisplayTest::doTestResponsiveImageFieldFormatters protected function Test responsive image formatters on node display.
ResponsiveImageFieldDisplayTest::setUp protected function Drupal\simpletest\WebTestBase\setUp(). Overrides ImageFieldTestBase::setUp
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersEmptyMediaQuery public function Tests responsive image formatter on node display with an empty media query.
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersEmptyStyle public function Test responsive image formatters when image style is empty.
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersLinkToFile public function Tests responsive image formatters on node display linked to the file.
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersLinkToNode public function Tests responsive image formatters on node display linked to the node.
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersOneSource public function Tests responsive image formatter on node display with one source.
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersPrivate public function Tests responsive image formatters on node display for private files.
ResponsiveImageFieldDisplayTest::testResponsiveImageFieldFormattersPublic public function Tests responsive image formatters on node display for public files.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public 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::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is 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::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
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.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
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::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
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 private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
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::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code.
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
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. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
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::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
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 Logs a user out of the internal browser and confirms.
WebTestBase::drupalPlaceBlock protected function Creates a block instance based on default settings.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1