You are here

class IntegrationTest in Acquia Content Hub 8

Tests the overall functionality of the Acquia Content Hub module.

@group acquia_contenthub @group orca_ignore

Hierarchy

Expanded class hierarchy of IntegrationTest

File

tests/src/Functional/IntegrationTest.php, line 18

Namespace

Drupal\Tests\acquia_contenthub\Functional
View source
class IntegrationTest extends ContentHubTestBase {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'node',
    'acquia_contenthub',
    'field',
    'field_test_boolean_access_denied',
  ];

  /**
   * The sample article we generate.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $article;

  /**
   * The sample unpublished article we generate.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $unpublishedArticle;

  /**
   * The sample page we generate.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $page;

  /**
   * Admin role.
   *
   * @var string
   */
  protected $adminRole;

  /**
   * Limited role.
   *
   * @var string
   */
  protected $limitedRole;

  /**
   * A field to use in this test class.
   *
   * @var \Drupal\field\Entity\FieldStorageConfig
   */
  protected $fieldStorage;

  /**
   * The field used in this test class.
   *
   * @var \Drupal\field\Entity\FieldConfig
   */
  protected $field;

  /**
   * Default theme for test.
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $this->adminRole = $this
      ->createAdminRole();
    $this->limitedRole = $this
      ->createRole([
      'access content',
    ]);

    // Create a field to test access.
    $this->fieldStorage = FieldStorageConfig::create([
      'field_name' => 'test_field_01',
      'entity_type' => 'node',
      'type' => 'boolean',
    ]);
    $this->fieldStorage
      ->save();
    $this->field = FieldConfig::create([
      'field_name' => 'test_field_01',
      'entity_type' => 'node',
      'bundle' => 'article',
      'label' => 'Test',
      'required' => TRUE,
      'settings' => [
        'on_label' => 'field_test_01_on',
        'off_label' => 'field_test_01_off',
      ],
    ]);
    $this->field
      ->save();

    // Create a display for the full view mode.
    \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', 'article', 'full')
      ->setComponent('test_field_01', [
      'type' => 'boolean',
    ])
      ->save();

    // Create a display for the teaser view mode.
    \Drupal::service('entity_display.repository')
      ->getViewDisplay('node', 'article', 'teaser')
      ->setComponent('test_field_01', [
      'type' => 'boolean',
    ])
      ->save();
  }

  /**
   * Tests various operations via the Acquia Content Hub admin UI.
   */
  public function testFramework() {

    // Enable dumpHeaders when you are having caching issues.
    $this->dumpHeaders = TRUE;
    $this
      ->drupalLogin($this->adminUser);

    // Create sample content.
    $this
      ->createSampleContent();

    // Configure Acquia Content Hub for article nodes with view modes.
    $this
      ->configureContentHubContentTypes('node', [
      'article',
    ]);
    $this
      ->checkCdfOutput($this->article);

    // Check CDF access on published node.
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);
    $this
      ->checkCdfAccess($this->article);
    $this
      ->checkCdfFormat($this->article);
    $this
      ->setRoleFor($this->limitedRole);
    $this
      ->checkCdfAccess($this->article);
    $this
      ->setRoleFor($this->adminRole);
    $this
      ->checkCdfAccess($this->article);

    // Check CDF access on unpublished node.
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);
    $this
      ->checkCdfAccess($this->unpublishedArticle, FALSE);
    $this
      ->setRoleFor($this->limitedRole);
    $visible_roles = $this
      ->getUserWarningRole();
    $this
      ->assertFalse(array_key_exists($this->limitedRole, $visible_roles), 'The role warning message absent');
    $this
      ->checkCdfAccess($this->unpublishedArticle, FALSE);
    $this
      ->setRoleFor($this->adminRole);
    $visible_roles = $this
      ->getUserWarningRole();
    $this
      ->assertTrue(array_key_exists($this->adminRole, $visible_roles), 'The role warning message present');
    $this
      ->checkCdfAccess($this->unpublishedArticle);

    // Check if the test field presents in CDF attributes.
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);
    $this
      ->checkCdfFieldAccess($this->article);
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);
    $this
      ->checkCdfFieldAccess($this->article, FALSE, FALSE);
    $this
      ->setRoleFor($this->adminRole);
    $this
      ->checkCdfFieldAccess($this->article);
    $this
      ->setRoleFor($this->adminRole);
    $this
      ->checkCdfFieldAccess($this->article, FALSE, FALSE);

    // Access test cleanup.
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);

    // Enable view-modes for article nodes.
    $this
      ->enableViewModeFor('node', 'article', 'teaser');
    $this
      ->checkCdfOutput($this->article, 'teaser');
    $this
      ->ConfigureAndUsePreviewImageStyle();

    // Access to view modes as admin should be allowed.
    $this
      ->checkAccessViewMode($this->article, 'teaser', TRUE);

    // Access to view modes on unpublished content as admin should be allowed.
    $this
      ->drupalGet("acquia-contenthub/display/node/{$this->unpublishedArticle->id()}/teaser");
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertNoText($this->unpublishedArticle
      ->label(), 'An unpublished content should not be rendered for admin user if anonymous role selected');

    // Check if the test field rendered properly.
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);
    $this
      ->checkFieldAccessViewMode($this->article, 'teaser');
    $this
      ->checkCdfMarkup($this->article);
    $this
      ->setRoleFor(AccountInterface::ANONYMOUS_ROLE);
    $this
      ->checkFieldAccessViewMode($this->article, 'teaser', FALSE, FALSE);
    $this
      ->setRoleFor($this->adminRole);
    $this
      ->checkFieldAccessViewMode($this->article, 'teaser');
    $this
      ->setRoleFor($this->adminRole);
    $this
      ->checkFieldAccessViewMode($this->article, 'teaser', FALSE, FALSE);
    $this
      ->setRoleFor($this->adminRole);

    // Access to view modes as admin should be allowed.
    $this
      ->checkAccessViewMode($this->article, 'teaser', TRUE);

    // Access to view modes on unpublished content as admin should be allowed.
    $this
      ->checkAccessViewMode($this->unpublishedArticle, 'teaser', TRUE);
    $this
      ->drupalLogout();

    // Access to view modes as anonymous should be denied.
    $this
      ->checkAccessViewMode($this->article, 'teaser', FALSE);
    $this
      ->checkAccessViewMode($this->unpublishedArticle, 'teaser', FALSE);
  }

  /**
   * Ensures the CDF output is present or not depending of selected role.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity to be used.
   * @param bool $access
   *   Expected result.
   */
  public function checkCdfAccess(NodeInterface $entity, $access = TRUE) {
    $output = $this
      ->drupalGetCdf('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    if ($access) {
      $this
        ->assertTrue(isset($output['entities']['0']), 'CDF is present');
    }
    else {
      $this
        ->assertFalse(isset($output['entities']['0']), 'CDF is not present');
    }
  }

  /**
   * Ensures the CDF output is present for expected formats.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity to be used.
   */
  public function checkCdfFormat(NodeInterface $entity) {
    $output = $this
      ->drupalGetCdf('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(200, 'Accept acquia_contenthub_cdf format.');
    $this
      ->assertEquals($output['entities']['0']['uuid'], $entity
      ->uuid(), 'CDF is present for acquia_contenthub_cdf format.');
    $output = $this
      ->drupalGetWithFormat('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id(), 'html');
    $output = Json::decode($output);
    $this
      ->assertSession()
      ->statusCodeEquals(200, 'Accept html format (browser default).');
    $this
      ->assertEquals($output['entities']['0']['uuid'], $entity
      ->uuid(), 'CDF is present for html format.');
    $output = $this
      ->drupalGetWithFormat('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id(), 'json');
    $output = Json::decode($output);
    $this
      ->assertSession()
      ->statusCodeEquals(200, 'Accept json format.');
    $this
      ->assertEquals($output['entities']['0']['uuid'], $entity
      ->uuid(), 'CDF is present for json format.');
    $output = $this
      ->drupalGet('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id());
    $output = Json::decode($output);
    $this
      ->assertSession()
      ->statusCodeEquals(200, 'Accept default format (json is default for tests).');
    $this
      ->assertEquals($output['entities']['0']['uuid'], $entity
      ->uuid(), 'CDF is present for default format.');
    $this
      ->drupalGetWithFormat('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id(), 'xml');
    $this
      ->assertSession()
      ->statusCodeEquals(406, 'A 406 response was returned when XML was requested.');
  }

  /**
   * Ensures the rendered view mode have no extra markup.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity to be used.
   */
  public function checkCdfMarkup(NodeInterface $entity) {
    $this
      ->enableViewModeFor('node', 'article', [
      'default',
      'full',
      'teaser',
    ]);
    $output = $this
      ->drupalGetCdf('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id());

    // Drupal 8.5 has added off-canvas links to the main template.
    // https://www.drupal.org/project/drupal/issues/2784443
    $dialog_off_canvas_openning = floatval(\Drupal::VERSION) <= 8.4 ? '' : '<div class="dialog-off-canvas-main-canvas" data-off-canvas-main-canvas>';
    $dialog_off_canvas_closing = floatval(\Drupal::VERSION) <= 8.4 ? '' : '</div>';
    $this
      ->setRawContent($output['entities'][0]['metadata']['view_modes']['default']['html']);
    $this
      ->removeWhiteSpace();
    $expected = '</head><body>' . $dialog_off_canvas_openning . '<article role="article" class="node node--type-article node--promoted node--view-mode-default"><h2><a href="/node/1" rel="bookmark"><span class="field field--name-title field--type-string field--label-hidden">';
    $this
      ->assertRaw($expected, 'Default view mode have no extra markup.');
    $expected = '</article>' . $dialog_off_canvas_closing . '<div data-content-barrier-exclude="true"></div></body></html>';
    $this
      ->assertRaw($expected, 'Default view mode footer JS is wrapped into div with data-content-barrier-exclude attribute.');
    $this
      ->setRawContent($output['entities'][0]['metadata']['view_modes']['full']['html']);
    $this
      ->removeWhiteSpace();
    $expected = '</head><body>' . $dialog_off_canvas_openning . '<article role="article" class="node node--type-article node--promoted node--view-mode-full"><h2><a href="/node/1" rel="bookmark"><span class="field field--name-title field--type-string field--label-hidden">';
    $this
      ->assertRaw($expected, 'Full view mode have no extra markup.');
    $expected = '</article>' . $dialog_off_canvas_closing . '<div data-content-barrier-exclude="true"></div></body></html>';
    $this
      ->assertRaw($expected, 'Full view mode footer JS is wrapped into div with data-content-barrier-exclude attribute.');
    $this
      ->setRawContent($output['entities'][0]['metadata']['view_modes']['teaser']['html']);
    $this
      ->removeWhiteSpace();
    $expected = '</head><body>' . $dialog_off_canvas_openning . '<article role="article" class="node node--type-article node--promoted node--view-mode-teaser"><h2><a href="/node/1" rel="bookmark"><span class="field field--name-title field--type-string field--label-hidden">';
    $this
      ->assertRaw($expected, 'Teaser view mode have no extra markup.');
    $expected = '</article>' . $dialog_off_canvas_closing . '<div data-content-barrier-exclude="true"></div></body></html>';
    $this
      ->assertRaw($expected, 'Teaser view mode footer JS is wrapped into div with data-content-barrier-exclude attribute.');
    $this
      ->enableViewModeFor('node', 'article', 'teaser');
  }

  /**
   * Ensures the test field is present or not in CDF output.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity to be used.
   * @param bool $access
   *   Expected result.
   * @param bool $field_access
   *   Access to the test field.
   */
  public function checkCdfFieldAccess(NodeInterface $entity, $access = TRUE, $field_access = TRUE) {

    // Tell the test module to disable access to the field.
    \Drupal::state()
      ->set('field.test_boolean_field_access_field', $field_access ? '' : 'test_field_01');
    $output = $this
      ->drupalGetCdf('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    if ($access) {
      $this
        ->assertTrue(isset($output['entities']['0']['attributes']['test_field_01']), 'Test Field is present');
    }
    else {
      $this
        ->assertFalse(isset($output['entities']['0']['attributes']['test_field_01']), 'Test Field is not present');
    }
  }

  /**
   * Create some basic sample content so that we can later verify if the CDF.
   */
  public function createSampleContent() {

    // Add one article and a page.
    $this->article = $this
      ->drupalCreateNode([
      'type' => 'article',
      'test_field_01' => [
        'value' => 1,
      ],
    ]);
    $this->page = $this
      ->drupalCreateNode([
      'type' => 'page',
    ]);
    $this->unpublishedArticle = $this
      ->drupalCreateNode([
      'type' => 'article',
      'status' => FALSE,
    ]);
  }

  /**
   * Ensures the CDF output is what we expect it to be.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity to be used.
   * @param string|null $view_mode
   *   The view mode to check in the CDF.
   */
  public function checkCdfOutput(NodeInterface $entity, $view_mode = NULL) {
    $output = $this
      ->drupalGetCdf('acquia-contenthub-cdf/' . $entity
      ->getEntityTypeId() . '/' . $entity
      ->id());
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    if (!empty($view_mode)) {
      $this
        ->assertTrue(isset($output['entities']['0']['metadata']), 'Metadata is present');
      $this
        ->assertTrue(isset($output['entities']['0']['metadata']['view_modes'][$view_mode]), $this
        ->t('View mode %view_mode is present', [
        '%view_mode' => $view_mode,
      ]));
    }
    else {
      $this
        ->assertFalse(isset($output['entities']['0']['metadata']), 'Metadata is not present');
    }
  }

  /**
   * Configure and use content hub preview image style.
   */
  public function configureAndUsePreviewImageStyle() {
    $this
      ->drupalGet('admin/config/services/acquia-contenthub/configuration');
    $this
      ->assertRaw('admin/structure/types/manage/article#edit-acquia-contenthub', 'Preview image shortcut links exist on the page.');
    $this
      ->drupalGet('admin/structure/types/manage/article');
    $this
      ->assertText($this
      ->t('Acquia Content Hub'));
  }

  /**
   * Checks access to View Modes endpoint.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity.
   * @param string $view_mode
   *   The view mode.
   * @param bool $access
   *   Expected result.
   */
  public function checkAccessViewMode(NodeInterface $entity, $view_mode, $access = TRUE) {
    $this
      ->drupalGet("acquia-contenthub/display/node/{$entity->id()}/{$view_mode}");
    if ($access) {
      $this
        ->assertSession()
        ->statusCodeEquals(200);
      $this
        ->assertText($entity
        ->label());
    }
    else {
      $this
        ->assertSession()
        ->statusCodeEquals(403);
    }
  }

  /**
   * Checks if the Test Field rendered at View Modes endpoint.
   *
   * @param \Drupal\node\NodeInterface $entity
   *   The entity.
   * @param string $view_mode
   *   The view mode.
   * @param bool $access
   *   Expected result.
   * @param bool $field_access
   *   Access to the field.
   */
  public function checkFieldAccessViewMode(NodeInterface $entity, $view_mode, $access = TRUE, $field_access = TRUE) {

    // Tell the test module to disable access to the field.
    \Drupal::state()
      ->set('field.test_boolean_field_access_field', $field_access ? '' : 'test_field_01');
    $this
      ->drupalGet("acquia-contenthub/display/node/{$entity->id()}/{$view_mode}");
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    if ($access) {
      $this
        ->assertText('field_test_01_on');
    }
    else {
      $this
        ->assertNoText('field_test_01_on');
    }
  }

  /**
   * Returns list of the roles with security implications.
   *
   * @return array
   *   Array of roles.
   */
  public function getUserWarningRole() {
    $markup = $this
      ->xpath('//div[@id="user-warning-role"]');
    $states = (array) json_decode($markup[0]['data-drupal-states']);
    $visible_roles = [];
    if (isset($states['visible'])) {
      foreach ($states['visible'] as $state) {
        $visible_role = (array) $state;
        $visible_roles[] = $visible_role[':input[name="user_role"]']->value;
      }
      return array_flip($visible_roles);
    }
    return [];
  }

}

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.
ContentHubTestBase::$adminUser protected property An admin user used for this test.
ContentHubTestBase::$adminUserPermissions protected property The permissions of the admin user. 6
ContentHubTestBase::$anonymousUser protected property The anonymous user used for this test.
ContentHubTestBase::$config protected property The Configuration Object for acquia_contenthub.admin_settings.
ContentHubTestBase::$unauthorizedUser protected property A user without Acquia Content Hub admin permission.
ContentHubTestBase::$urlGenerator protected property The URL generator.
ContentHubTestBase::configureContentHubContentTypes public function Configures Content types to be exported to Content Hub.
ContentHubTestBase::drupalGetCdf protected function Retrieves a Drupal or an absolute CDF path and JSON decodes the result.
ContentHubTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
ContentHubTestBase::enableViewModeFor public function Enables a view mode to be rendered in CDF.
ContentHubTestBase::setContentHubConnection public function Configures the Content Hub Connection.
ContentHubTestBase::setRoleFor public function Sets a role to be used in CDF render.
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.
IntegrationTest::$adminRole protected property Admin role.
IntegrationTest::$article protected property The sample article we generate.
IntegrationTest::$defaultTheme protected property Default theme for test. Overrides ContentHubTestBase::$defaultTheme
IntegrationTest::$field protected property The field used in this test class.
IntegrationTest::$fieldStorage protected property A field to use in this test class.
IntegrationTest::$limitedRole protected property Limited role.
IntegrationTest::$modules public static property Modules to enable for this test. Overrides ContentHubTestBase::$modules
IntegrationTest::$page protected property The sample page we generate.
IntegrationTest::$unpublishedArticle protected property The sample unpublished article we generate.
IntegrationTest::checkAccessViewMode public function Checks access to View Modes endpoint.
IntegrationTest::checkCdfAccess public function Ensures the CDF output is present or not depending of selected role.
IntegrationTest::checkCdfFieldAccess public function Ensures the test field is present or not in CDF output.
IntegrationTest::checkCdfFormat public function Ensures the CDF output is present for expected formats.
IntegrationTest::checkCdfMarkup public function Ensures the rendered view mode have no extra markup.
IntegrationTest::checkCdfOutput public function Ensures the CDF output is what we expect it to be.
IntegrationTest::checkFieldAccessViewMode public function Checks if the Test Field rendered at View Modes endpoint.
IntegrationTest::configureAndUsePreviewImageStyle public function Configure and use content hub preview image style.
IntegrationTest::createSampleContent public function Create some basic sample content so that we can later verify if the CDF.
IntegrationTest::getUserWarningRole public function Returns list of the roles with security implications.
IntegrationTest::setUp public function Overrides ContentHubTestBase::setUp
IntegrationTest::testFramework public function Tests various operations via the Acquia Content Hub admin UI.
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
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
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.