class PreviewTest

Same name in this branch
  1. 11.x core/modules/views_ui/tests/src/FunctionalJavascript/PreviewTest.php \Drupal\Tests\views_ui\FunctionalJavascript\PreviewTest
Same name in other branches
  1. 9 core/modules/views_ui/tests/src/FunctionalJavascript/PreviewTest.php \Drupal\Tests\views_ui\FunctionalJavascript\PreviewTest
  2. 9 core/modules/views_ui/tests/src/Functional/PreviewTest.php \Drupal\Tests\views_ui\Functional\PreviewTest
  3. 8.9.x core/modules/views_ui/tests/src/FunctionalJavascript/PreviewTest.php \Drupal\Tests\views_ui\FunctionalJavascript\PreviewTest
  4. 8.9.x core/modules/views_ui/tests/src/Functional/PreviewTest.php \Drupal\Tests\views_ui\Functional\PreviewTest
  5. 10 core/modules/views_ui/tests/src/FunctionalJavascript/PreviewTest.php \Drupal\Tests\views_ui\FunctionalJavascript\PreviewTest
  6. 10 core/modules/views_ui/tests/src/Functional/PreviewTest.php \Drupal\Tests\views_ui\Functional\PreviewTest

Tests the UI preview functionality.

@group views_ui

Hierarchy

Expanded class hierarchy of PreviewTest

File

core/modules/views_ui/tests/src/Functional/PreviewTest.php, line 12

Namespace

Drupal\Tests\views_ui\Functional
View source
class PreviewTest extends UITestBase {
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_preview',
        'test_preview_error',
        'test_pager_full',
        'test_mini_pager',
        'test_click_sort',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests contextual links in the preview form.
     */
    public function testPreviewContextual() : void {
        \Drupal::service('module_installer')->install([
            'contextual',
        ]);
        $this->resetAll();
        $this->drupalGet('admin/structure/views/view/test_preview/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->submitForm($edit = [], 'Update preview');
        // Verify that the contextual link to add a new field is shown.
        $selector = $this->assertSession()
            ->buildXPathQuery('//div[@id="views-live-preview"]//ul[contains(@class, :ul-class)]/li/a[contains(@href, :href)]', [
            ':ul-class' => 'contextual-links',
            ':href' => '/admin/structure/views/nojs/add-handler/test_preview/default/filter',
        ]);
        $this->assertSession()
            ->elementsCount('xpath', $selector, 1);
        $this->submitForm([
            'view_args' => '100',
        ], 'Update preview');
        // Test that area text and exposed filters are present and rendered.
        $this->assertSession()
            ->fieldExists('id');
        $this->assertSession()
            ->pageTextContains('Test header text');
        $this->assertSession()
            ->pageTextContains('Test footer text');
        $this->assertSession()
            ->pageTextContains('Test empty text');
        $this->submitForm([
            'view_args' => '0',
        ], 'Update preview');
        // Test that area text and exposed filters are present and rendered.
        $this->assertSession()
            ->fieldExists('id');
        $this->assertSession()
            ->pageTextContains('Test header text');
        $this->assertSession()
            ->pageTextContains('Test footer text');
        $this->assertSession()
            ->pageTextContains('Test empty text');
    }
    
    /**
     * Tests arguments in the preview form.
     */
    public function testPreviewUI() : void {
        $this->drupalGet('admin/structure/views/view/test_preview/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->submitForm($edit = [], 'Update preview');
        $selector = '//div[@class = "views-row"]';
        $this->assertSession()
            ->elementsCount('xpath', $selector, 5);
        // Filter just the first result.
        $this->submitForm($edit = [
            'view_args' => '1',
        ], 'Update preview');
        $this->assertSession()
            ->elementsCount('xpath', $selector, 1);
        // Filter for no results.
        $this->submitForm($edit = [
            'view_args' => '100',
        ], 'Update preview');
        $this->assertSession()
            ->elementNotExists('xpath', $selector);
        // Test that area text and exposed filters are present and rendered.
        $this->assertSession()
            ->fieldExists('id');
        $this->assertSession()
            ->pageTextContains('Test header text');
        $this->assertSession()
            ->pageTextContains('Test footer text');
        $this->assertSession()
            ->pageTextContains('Test empty text');
        // Test feed preview.
        $view = [];
        $view['label'] = $this->randomMachineName(16);
        $view['id'] = $this->randomMachineName(16);
        $view['page[create]'] = 1;
        $view['page[title]'] = $this->randomMachineName(16);
        $view['page[path]'] = $this->randomMachineName(16);
        $view['page[feed]'] = 1;
        $view['page[feed_properties][path]'] = $this->randomMachineName(16);
        $this->drupalGet('admin/structure/views/add');
        $this->submitForm($view, 'Save and edit');
        $this->clickLink('Feed');
        $this->submitForm([], 'Update preview');
        $this->assertSession()
            ->elementTextContains('xpath', '//div[@id="views-live-preview"]/pre', '<title>' . $view['page[title]'] . '</title>');
        // Test the non-default UI display options.
        // Statistics only, no query.
        $settings = \Drupal::configFactory()->getEditable('views.settings');
        $settings->set('ui.show.performance_statistics', TRUE)
            ->save();
        $this->drupalGet('admin/structure/views/view/test_preview/edit');
        $this->submitForm($edit = [
            'view_args' => '100',
        ], 'Update preview');
        $this->assertSession()
            ->pageTextContains('Query build time');
        $this->assertSession()
            ->pageTextContains('Query execute time');
        $this->assertSession()
            ->pageTextContains('View render time');
        $this->assertSession()
            ->responseNotContains('<strong>Query</strong>');
        // Statistics and query.
        $settings->set('ui.show.sql_query.enabled', TRUE)
            ->save();
        $this->submitForm($edit = [
            'view_args' => '100',
        ], 'Update preview');
        $this->assertSession()
            ->pageTextContains('Query build time');
        $this->assertSession()
            ->pageTextContains('Query execute time');
        $this->assertSession()
            ->pageTextContains('View render time');
        $this->assertSession()
            ->responseContains('<strong>Query</strong>');
        $query_string = <<<SQL
SELECT "views_test_data"."name" AS "views_test_data_name"
FROM
{views_test_data} "views_test_data"
WHERE (views_test_data.id = '100')
SQL;
        $this->assertSession()
            ->assertEscaped($query_string);
        // Test that the statistics and query are rendered above the preview.
        $this->assertLessThan(strpos($this->getSession()
            ->getPage()
            ->getContent(), 'js-view-dom-id'), strpos($this->getSession()
            ->getPage()
            ->getContent(), 'views-query-info'));
        // Test that statistics and query rendered below the preview.
        $settings->set('ui.show.sql_query.where', 'below')
            ->save();
        $this->submitForm($edit = [
            'view_args' => '100',
        ], 'Update preview');
        $this->assertLessThan(strpos($this->getSession()
            ->getPage()
            ->getContent(), 'views-query-info'), strpos($this->getSession()
            ->getPage()
            ->getContent(), 'js-view-dom-id'), 'Statistics shown below the preview.');
        // Test that the preview title isn't double escaped.
        $this->drupalGet("admin/structure/views/nojs/display/test_preview/default/title");
        $this->submitForm($edit = [
            'title' => 'Double & escaped',
        ], 'Apply');
        $this->submitForm([], 'Update preview');
        $this->assertSession()
            ->elementsCount('xpath', '//div[@id="views-live-preview"]/div[contains(@class, views-query-info)]//td[text()="Double & escaped"]', 1);
    }
    
    /**
     * Tests the additional information query info area.
     */
    public function testPreviewAdditionalInfo() : void {
        \Drupal::service('module_installer')->install([
            'views_ui_test',
        ]);
        $this->resetAll();
        $this->drupalGet('admin/structure/views/view/test_preview/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->submitForm($edit = [], 'Update preview');
        // Check for implementation of hook_views_preview_info_alter().
        // @see views_ui_test.module
        // Verify that Views Query Preview Info area was altered.
        $this->assertSession()
            ->elementsCount('xpath', '//div[@id="views-live-preview"]/div[contains(@class, views-query-info)]//td[text()="Test row count"]', 1);
        // Check that additional assets are attached.
        $this->assertStringContainsString('views_ui_test/views_ui_test.test', $this->getDrupalSettings()['ajaxPageState']['libraries'], 'Attached library found.');
        $this->assertSession()
            ->responseContains('css/views_ui_test.test.css');
    }
    
    /**
     * Tests view validation error messages in the preview.
     */
    public function testPreviewError() : void {
        $this->drupalGet('admin/structure/views/view/test_preview_error/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->submitForm($edit = [], 'Update preview');
        $this->assertSession()
            ->pageTextContains('Unable to preview due to validation errors.');
    }
    
    /**
     * Tests HTML is filtered from the view title when previewing.
     */
    public function testPreviewTitle() : void {
        // Update the view and change title with html tags.
        \Drupal::configFactory()->getEditable('views.view.test_preview')
            ->set('display.default.display_options.title', '<strong>Test preview title</strong>')
            ->save();
        $this->drupalGet('admin/structure/views/view/test_preview/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->submitForm([], 'Update preview');
        $this->assertSession()
            ->pageTextContains('Test preview title');
        // Ensure allowed HTML tags are still displayed.
        $this->assertCount(2, $this->xpath('//div[@id="views-live-preview"]//strong[text()=:text]', [
            ':text' => 'Test preview title',
        ]));
        // Ensure other tags are filtered.
        \Drupal::configFactory()->getEditable('views.view.test_preview')
            ->set('display.default.display_options.title', '<b>Test preview title</b>')
            ->save();
        $this->submitForm([], 'Update preview');
        $this->assertCount(0, $this->xpath('//div[@id="views-live-preview"]//b[text()=:text]', [
            ':text' => 'Test preview title',
        ]));
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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 enabled.
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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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 SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 41
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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 test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
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. 1
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
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. 4
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. 1
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
PreviewTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
PreviewTest::$testViews public static property Views used by this test.
PreviewTest::testPreviewAdditionalInfo public function Tests the additional information query info area.
PreviewTest::testPreviewContextual public function Tests contextual links in the preview form.
PreviewTest::testPreviewError public function Tests view validation error messages in the preview.
PreviewTest::testPreviewTitle public function Tests HTML is filtered from the view title when previewing.
PreviewTest::testPreviewUI public function Tests arguments in the preview form.
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::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. 3
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
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::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UITestBase::$adminUser protected property An admin user with the &#039;administer views&#039; permission. 5
UITestBase::$fullAdminUser protected property An admin user with administrative permissions for views, blocks, and nodes.
UITestBase::$modules protected static property Overrides ViewTestBase::$modules 24
UITestBase::drupalGet protected function Overrides UiHelperTrait::drupalGet
UITestBase::randomView public function A helper method which creates a random view.
UITestBase::setUp protected function Overrides ViewTestBase::setUp 16
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::viewsData protected function Returns the views data definition. 8
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.