You are here

Home » API reference » Webform Views Integration 8.5 » WebformViewsTestBase.php

abstract class WebformViewsTestBase in Webform Views Integration 8.5

Reasonable starting point for testing integration between webform and views.

Hierarchy

Expanded class hierarchy of WebformViewsTestBase

4 files declare their use of WebformViewsTestBase
WebformViewsArgumentTestBase.php in tests/src/Kernel/argument/WebformViewsArgumentTestBase.php
WebformViewsFieldTestBase.php in tests/src/Kernel/field/WebformViewsFieldTestBase.php
WebformViewsRelationshipTestBase.php in tests/src/Kernel/relationship/WebformViewsRelationshipTestBase.php
WebformViewsSortTestBase.php in tests/src/Kernel/sort/WebformViewsSortTestBase.php

File

tests/src/Kernel/WebformViewsTestBase.php, line 15

Namespace

Drupal\Tests\webform_views\Kernel
View source 
abstract class WebformViewsTestBase extends KernelTestBase {
  protected static $modules = [
    'system',
    'user',
    'views',
    'webform',
    'webform_views',
    'webform_views_test',
  ];

  /**
   * Webform on which tests will be conducted.
   *
   * @var \Drupal\webform\WebformInterface
   */
  protected $webform;

  /**
   * Array of webform elements to apply to the webform.
   *
   * @var array
   */
  protected $webform_elements = [];

  /**
   * A list of webform submissions data to submit into the webform.
   *
   * Each sub array represents a single webform submission and its content will
   * be used as 'data' property of the webform submission.
   *
   * @var array
   */
  protected $webform_submissions_data = [];

  /**
   * A list of webform submissions data for the case of multivalue elements.
   *
   * Each sub array represents a single webform submission and its content will
   * be used as 'data' property of the webform submission.
   *
   * @var array
   */
  protected $webform_submission_multivalue_data = [];

  /**
   * View on which the tests will be executed.
   *
   * @var \Drupal\views\Entity\View
   */
  protected $view;

  /**
   * Array of additional handlers to apply to the view.
   *
   * It should be keyed by handler type. See View::getHandlerTypes() for the
   * list of known handler types.
   *
   * @var array
   */
  protected $view_handlers = [];

  /**
   * Account with super privileges.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $admin;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installSchema('user', [
      'users_data',
    ]);
    $this
      ->installSchema('webform', [
      'webform',
    ]);
    $this
      ->installConfig([
      'user',
      'views',
      'webform',
      'webform_views',
      'webform_views_test',
    ]);
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('webform_submission');
    $account = User::create([
      'name' => $this
        ->randomString(),
      'mail' => 'admin@example.com',
      'pass' => 1,
      'roles' => [
        'administrator',
      ],
    ]);
    $account
      ->save();
    \Drupal::currentUser()
      ->setAccount($account);
  }

  /**
   * Create a new webform with provided elements.
   *
   * @param array $webform_elements
   *   Array of elements to place into the webform.
   *
   * @return \Drupal\webform\WebformInterface
   *   Created and saved webform.
   */
  protected function createWebform(array $webform_elements) {
    $webform_entity_type = \Drupal::entityTypeManager()
      ->getDefinition('webform');
    $webform = Webform::create([
      $webform_entity_type
        ->getKey('id') => 'webform',
      $webform_entity_type
        ->getKey('label') => $this
        ->randomString(),
    ]);
    $webform
      ->setElements($webform_elements);
    $webform
      ->save();
    return $webform;
  }

  /**
   * Create webform submissions per provided submissions data.
   *
   * @param array $webform_submissions_data
   *   Array of webform submissions data. Each sub array represents a single
   *   webform submission to create and contents of the subarray will be
   *   utilized for 'data' property of the created submission.
   * @param \Drupal\webform\WebformInterface $webform
   *   Webform within which to create submissions.
   */
  protected function createWebformSubmissions(array $webform_submissions_data, WebformInterface $webform) {
    foreach ($webform_submissions_data as $submissions_data) {
      $webform_submission = WebformSubmission::create([
        'webform_id' => $webform
          ->id(),
      ]);
      $webform_submission
        ->setData($submissions_data);
      $webform_submission
        ->save();
    }
  }

  /**
   * Initialize and save the view.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   Webform to use as a filter condition in the view. View will contain
   *   submissions only from this webform.
   * @param array $handlers
   *   Array of additional handlers to apply to the view.
   * @param string $view_id
   *   ID of the view to initialize.
   *
   * @return \Drupal\views\Entity\View
   *   Initialized and saved into DB view.
   */
  protected function initView(WebformInterface $webform, array $handlers, $view_id = 'webform_views_test') {
    $view = View::load($view_id);

    /** @var \Drupal\views\ViewExecutable $executable */
    $executable = $view
      ->getExecutable();
    foreach ($handlers as $handler_type => $v) {
      foreach ($v as $handler) {
        $executable
          ->addHandler('default', $handler_type, $handler['table'], $handler['field'], $handler['options'], isset($handler['id']) ? $handler['id'] : NULL);
      }
    }
    $view
      ->save();

    // Let's reload the view because some handlers might initialize differently
    // since we've changed views configuration.
    $view = View::load($view
      ->id());
    return $view;
  }

  /**
   * Execute and render the view.
   *
   * @param \Drupal\views\Entity\View $view
   *   The view to execute and render.
   * @param array $args
   *   Optional array of argument to supply to the view during its execution.
   * @param array $exclude_fields
   *   Array of field handler IDs that should be excluded from returned array.
   *
   * @return array
   *   Array of rendered cells of this view. Each sub array will represent a
   *   single row of the results of the view. Such sub array will be keyed by
   *   field handlers and corresponding values will be rendered HTML markup that
   *   the view produced for that field.
   */
  protected function renderView(View $view, array $args = array(), $exclude_fields = [
    'sid',
  ]) {

    /** @var \Drupal\views\ViewExecutable $executable */
    $executable = $view
      ->getExecutable();
    $executable
      ->executeDisplay(NULL, $args);
    $rendered_cells = [];
    for ($i = 0; $i < $executable->total_rows; $i++) {
      foreach ($executable
        ->getHandlers('field') as $handler) {
        if (!in_array($handler['id'], $exclude_fields)) {
          $rendered_cells[$i][$handler['id']] = (string) $executable->style_plugin
            ->getField($i, $handler['id']);
        }
      }
    }
    return $rendered_cells;
  }

}

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. 1
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::assertOptionByText protected function Asserts that a select option with the visible text 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 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::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
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::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
WebformViewsTestBase::$admin protected property Account with super privileges.
WebformViewsTestBase::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
WebformViewsTestBase::$view protected property View on which the tests will be executed.
WebformViewsTestBase::$view_handlers protected property Array of additional handlers to apply to the view. 6
WebformViewsTestBase::$webform protected property Webform on which tests will be conducted.
WebformViewsTestBase::$webform_elements protected property Array of webform elements to apply to the webform. 6
WebformViewsTestBase::$webform_submissions_data protected property A list of webform submissions data to submit into the webform. 7
WebformViewsTestBase::$webform_submission_multivalue_data protected property A list of webform submissions data for the case of multivalue elements. 2
WebformViewsTestBase::createWebform protected function Create a new webform with provided elements.
WebformViewsTestBase::createWebformSubmissions protected function Create webform submissions per provided submissions data.
WebformViewsTestBase::initView protected function Initialize and save the view.
WebformViewsTestBase::renderView protected function Execute and render the view.
WebformViewsTestBase::setUp public function Overrides KernelTestBase::setUp 1