class FilterEntityReferenceTest

Same name in this branch
  1. 11.x core/modules/views/tests/src/Kernel/Handler/FilterEntityReferenceTest.php \Drupal\Tests\views\Kernel\Handler\FilterEntityReferenceTest

Tests views creation wizard.

@group views_ui

Hierarchy

Expanded class hierarchy of FilterEntityReferenceTest

See also

\Drupal\views\Plugin\views\filter\EntityReference

File

core/modules/views_ui/tests/src/FunctionalJavascript/FilterEntityReferenceTest.php, line 17

Namespace

Drupal\Tests\views_ui\FunctionalJavascript
View source
class FilterEntityReferenceTest extends WebDriverTestBase {
    use FilterEntityReferenceTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'views',
        'views_ui',
        'views_test_entity_reference',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_entity_reference',
    ];
    
    /**
     * {@inheritdoc}
     */
    public function setUp() : void {
        parent::setUp();
        $admin_user = $this->drupalCreateUser([
            'administer views',
        ]);
        $this->drupalLogin($admin_user);
        $this->setUpEntityTypes();
    }
    
    /**
     * Tests end to end creation of a Content Entity Reference filter.
     */
    public function testAddEntityReferenceFieldWithDefaultSelectionHandler() : void {
        $this->drupalGet('admin/structure/views/view/content');
        $assert = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        // Open the dialog.
        $page->clickLink('views-add-filter');
        // Wait for the popup to open and the search field to be available.
        $assert->waitForField('override[controls][options_search]');
        // Test that the both entity_reference and numeric options are visible.
        $this->assertTrue($page->findField('name[node__field_test.field_test_target_id]')
            ->isVisible());
        $this->assertTrue($page->findField('name[node__field_test.field_test_target_id]')
            ->isVisible());
        $page->findField('name[node__field_test.field_test_target_id]')
            ->click();
        $this->assertTrue($page->find('css', 'button.button.button--primary.form-submit.ui-button')
            ->isVisible());
        $page->find('css', 'button.button.button--primary.form-submit.ui-button')
            ->click();
        // Wait for the selection handler to show up.
        $assert->waitForField('options[sub_handler]');
        $page->selectFieldOption('options[sub_handler]', 'default:node');
        // Check that that default handler target bundles are available.
        $this->assertTrue($page->findField('options[reference_default:node][target_bundles][article]')
            ->isVisible());
        $this->assertTrue($page->findField('options[reference_default:node][target_bundles][page]')
            ->isVisible());
        $this->assertTrue($page->findField('options[widget]')
            ->isVisible());
        // Ensure that disabled form elements from selection handler do not show up
        // @see \Drupal\views\Plugin\views\filter\EntityReference method
        // buildExtraOptionsForm.
        $this->assertFalse($page->hasField('options[reference_default:node][target_bundles_update]'));
        $this->assertFalse($page->hasField('options[reference_default:node][auto_create]'));
        $this->assertFalse($page->hasField('options[reference_default:node][auto_create_bundle]'));
        // Choose the default handler using the select widget with article type
        // checked.
        $page->checkField('options[reference_default:node][target_bundles][article]');
        $page->selectFieldOption('options[widget]', 'select');
        $this->assertSame($page->findField('options[widget]')
            ->getValue(), 'select');
        $page->find('xpath', "//*[contains(text(), 'Apply and continue')]")
            ->press();
        // Test the exposed filter options show up correctly.
        $assert->waitForField('options[expose_button][checkbox][checkbox]');
        $page->findField('options[expose_button][checkbox][checkbox]')
            ->click();
        $this->assertTrue($page->hasCheckedField('options[expose_button][checkbox][checkbox]'));
        // Check the exposed filters multiple option.
        $assert->waitForField('options[expose][multiple]');
        $page->findField('options[expose][multiple]')
            ->click();
        $this->assertTrue($page->hasCheckedField('options[expose][multiple]'));
        $page->find('css', '.ui-dialog .ui-dialog-buttonpane')
            ->pressButton('Apply');
        $assert->waitForElementRemoved('css', '.ui-dialog');
        // Wait for the Views Preview to show up with the new reference field.
        $assert->waitForField('field_test_config_target_id[]');
        $this->assertTrue($page->findField('field_test_target_id[]')
            ->isVisible());
        $this->assertTrue($page->find('css', 'select[name="field_test_target_id[]"]')
            ->hasAttribute('multiple'));
        // Opening the settings form and change the handler to use an Entity
        // Reference view.
        // @see views.view.test_entity_reference.yml
        $base_url = Url::fromRoute('entity.view.collection')->toString();
        $url = $base_url . '/nojs/handler-extra/content/page_1/filter/field_test_target_id';
        $extra_settings_selector = 'a[href="' . $url . '"]';
        $element = $this->assertSession()
            ->waitForElementVisible('css', $extra_settings_selector);
        $this->assertNotNull($element);
        $element->click();
        $assert->waitForField('options[sub_handler]');
        $page->selectFieldOption('options[sub_handler]', 'views');
        $page->selectFieldOption('options[reference_views][view][view_and_display]', 'test_entity_reference:entity_reference');
        $page->find('xpath', "//*[contains(text(), 'Apply')]")
            ->press();
        $assert->assertWaitOnAjaxRequest();
        // The Views Reference filter has a title Filter to a single result, so
        // ensure only that result is available as an option.
        $assert->waitForElementRemoved('css', '.ui-dialog');
        $this->assertCount(1, $page->findAll('css', 'select[name="field_test_target_id[]"] option'));
        // Change to an autocomplete filter.
        // Opening the settings form and change the handler to use an Entity
        // Reference view.
        // @see views.view.test_entity_reference.yml
        $page->find('css', $extra_settings_selector)
            ->click();
        $assert->waitForElementVisible('named', [
            'radio',
            'options[widget]',
        ]);
        $page->selectFieldOption('options[widget]', 'autocomplete');
        $this->assertSame($page->findField('options[widget]')
            ->getValue(), 'autocomplete');
        $this->getSession()
            ->getPage()
            ->find('xpath', "//*[contains(text(), 'Apply')]")
            ->press();
        // Check that it is now an autocomplete.
        $assert->waitForField('field_test_target_id');
        $page = $this->getSession()
            ->getPage();
        $this->assertTrue($page->findField('field_test_target_id')
            ->isVisible());
        $this->assertTrue($page->find('css', 'input[name="field_test_target_id"]')
            ->hasAttribute('data-autocomplete-path'));
    }
    
    /**
     * Tests end to end creation of a Config Entity Reference filter.
     */
    public function testAddConfigEntityReferenceFieldWithDefaultSelectionHandler() : void {
        $this->drupalGet('admin/structure/views/view/content');
        $assert = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        // Open the 'Add filter dialog'.
        $page->clickLink('views-add-filter');
        // Wait for the popup to open and the search field to be available.
        $assert->waitForField('override[controls][group]');
        // Test that the entity_reference option is visible.
        $this->assertTrue($page->findField('name[node__field_test_config.field_test_config_target_id]')
            ->isVisible());
        $page->findField('name[node__field_test_config.field_test_config_target_id]')
            ->click();
        $submitButton = $page->find('css', 'button.button.button--primary.form-submit.ui-button');
        $this->assertTrue($submitButton->isVisible());
        $submitButton->click();
        // Wait for the selection handler to show up.
        $assert->waitForField('options[sub_handler]');
        $page->selectFieldOption('options[sub_handler]', 'default:node_type');
        // Choose the default handler using the select widget with article type
        // checked.
        $page->selectFieldOption('options[widget]', 'select');
        $this->assertSame('select', $page->findField('options[widget]')
            ->getValue());
        $page->find('xpath', "//*[contains(text(), 'Apply and continue')]")
            ->press();
        // Test the exposed filter options show up correctly.
        $assert->waitForField('options[expose_button][checkbox][checkbox]');
        $page->findField('options[expose_button][checkbox][checkbox]')
            ->click();
        $this->assertTrue($page->hasCheckedField('options[expose_button][checkbox][checkbox]'));
        // Check the exposed filters multiple option.
        $assert->waitForField('options[expose][multiple]');
        $page->findField('options[expose][multiple]')
            ->click();
        $this->assertTrue($page->hasCheckedField('options[expose][multiple]'));
        $page->find('css', '.ui-dialog .ui-dialog-buttonpane')
            ->pressButton('Apply');
        $assert->waitForElementRemoved('css', '.ui-dialog');
        // Wait for the Views Preview to show up with the reference field.
        $assert->waitForField('field_test_config_target_id[]');
        $this->assertTrue($page->findField('field_test_config_target_id[]')
            ->isVisible());
        $this->assertTrue($page->find('css', 'select[name="field_test_config_target_id[]"]')
            ->hasAttribute('multiple'));
        // Check references config options.
        $options = $page->findAll('css', 'select[name="field_test_config_target_id[]"] option');
        $this->assertCount(2, $options);
        $this->assertSame('article', $options[0]->getValue());
        $this->assertSame('page', $options[1]->getValue());
        $base_url = Url::fromRoute('entity.view.collection')->toString();
        $url = $base_url . '/nojs/handler-extra/content/page_1/filter/field_test_config_target_id';
        $extra_settings_selector = 'a[href="' . $url . '"]';
        // Change to an autocomplete filter.
        $page->find('css', $extra_settings_selector)
            ->click();
        $assert->waitForField('options[widget]');
        $page->selectFieldOption('options[widget]', 'autocomplete');
        $this->assertSame('autocomplete', $page->findField('options[widget]')
            ->getValue());
        $page->find('css', '.ui-dialog .ui-dialog-buttonpane')
            ->pressButton('Apply');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        // Check that it is now an autocomplete input.
        $assert->waitForField('field_test_config_target_id');
        $this->assertTrue($page->findField('field_test_config_target_id')
            ->isVisible());
        $this->assertTrue($page->find('css', 'input[name="field_test_config_target_id"]')
            ->hasAttribute('data-autocomplete-path'));
    }

}

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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::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::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.
FilterEntityReferenceTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FilterEntityReferenceTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
FilterEntityReferenceTest::$testViews public static property Views used by this test.
FilterEntityReferenceTest::setUp public function Overrides BrowserTestBase::setUp
FilterEntityReferenceTest::testAddConfigEntityReferenceFieldWithDefaultSelectionHandler public function Tests end to end creation of a Config Entity Reference filter.
FilterEntityReferenceTest::testAddEntityReferenceFieldWithDefaultSelectionHandler public function Tests end to end creation of a Content Entity Reference filter.
FilterEntityReferenceTrait::$hostBundle protected property The host content type to add the entity reference field to.
FilterEntityReferenceTrait::$hostEntities protected property Host entities which contain the reference fields to the target entities.
FilterEntityReferenceTrait::$targetBundle protected property The content type to be referenced by the host content type.
FilterEntityReferenceTrait::$targetEntities protected property Entities to be used as reference targets.
FilterEntityReferenceTrait::setUpEntityTypes protected function Sets up the entity types and relationships.
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::$rootUser protected property The "#1" 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::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
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. 2
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::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::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.
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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors protected function Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
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.