class SearchCommentCountToggleTest
Tests that comment count display toggles properly on comment status of node.
Issue 537278
- Nodes with comment status set to Open should always how comment counts
- Nodes with comment status set to Closed should show comment counts only when there are comments
- Nodes with comment status set to Hidden should never show comment counts
Attributes
#[Group('search')]#[RunTestsInSeparateProcesses]
Hierarchy
- class \Drupal\Tests\BrowserTestBase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait extends \PHPUnit\Framework\TestCase
- class \Drupal\Tests\search\Functional\SearchCommentCountToggleTest uses \Drupal\comment\Tests\CommentTestTrait extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of SearchCommentCountToggleTest
File
-
core/
modules/ search/ tests/ src/ Functional/ SearchCommentCountToggleTest.php, line 23
Namespace
Drupal\Tests\search\FunctionalView source
class SearchCommentCountToggleTest extends BrowserTestBase { use CommentTestTrait; /** * {@inheritdoc} */ protected static $modules = [ 'node', 'comment', 'search', 'dblog', ]; /** * {@inheritdoc} */ protected $defaultTheme = 'stark'; /** * A user with permission to search and post comments. * * @var \Drupal\user\UserInterface */ protected $searchingUser; /** * Array of nodes available to search. * * @var \Drupal\node\NodeInterface[] */ protected $searchableNodes; /** * {@inheritdoc} */ protected function setUp() : void { parent::setUp(); $this->drupalCreateContentType([ 'type' => 'article', 'name' => 'Article', ]); // Create searching user. $this->searchingUser = $this->drupalCreateUser([ 'search content', 'access content', 'access comments', 'post comments', 'skip comment approval', ]); // Log in with sufficient privileges. $this->drupalLogin($this->searchingUser); // Add a comment field. $this->addDefaultCommentField('node', 'article'); // Create initial nodes. $node_params = [ 'type' => 'article', 'body' => [ [ 'value' => 'SearchCommentToggleTestCase', ], ], ]; $this->searchableNodes['1 comment'] = $this->drupalCreateNode($node_params); $this->searchableNodes['0 comments'] = $this->drupalCreateNode($node_params); // Create a comment array. $edit_comment = []; $edit_comment['subject[0][value]'] = $this->randomMachineName(); $edit_comment['comment_body[0][value]'] = $this->randomMachineName(); // Post comment to the test node with comment. $this->drupalGet('comment/reply/node/' . $this->searchableNodes['1 comment'] ->id() . '/comment'); $this->submitForm($edit_comment, 'Save'); // First update the index. This does the initial processing. $this->container ->get('plugin.manager.search') ->createInstance('node_search') ->updateIndex(); } /** * Verify that comment count display toggles properly on comment status of node. */ public function testSearchCommentCountToggle() : void { // Search for the nodes by string in the node body. $edit = [ 'keys' => "'SearchCommentToggleTestCase'", ]; $this->drupalGet('search/node'); // Test comment count display for nodes with comment status set to Open. $this->submitForm($edit, 'Search'); $this->assertSession() ->pageTextContains('0 comments'); $this->assertSession() ->pageTextContains('1 comment'); // Test comment count display for nodes with comment status set to Closed. $this->searchableNodes['0 comments'] ->set('comment', CommentItemInterface::CLOSED); $this->searchableNodes['0 comments'] ->save(); $this->searchableNodes['1 comment'] ->set('comment', CommentItemInterface::CLOSED); $this->searchableNodes['1 comment'] ->save(); $this->submitForm($edit, 'Search'); $this->assertSession() ->pageTextNotContains('0 comments'); $this->assertSession() ->pageTextContains('1 comment'); // Test comment count display for nodes with comment status set to Hidden. $this->searchableNodes['0 comments'] ->set('comment', CommentItemInterface::HIDDEN); $this->searchableNodes['0 comments'] ->save(); $this->searchableNodes['1 comment'] ->set('comment', CommentItemInterface::HIDDEN); $this->searchableNodes['1 comment'] ->save(); $this->submitForm($edit, 'Search'); $this->assertSession() ->pageTextNotContains('0 comments'); $this->assertSession() ->pageTextNotContains('1 comment'); } }Members
Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock BodyFieldCreationTrait::createBodyField protected function Creates a field of an body field storage on the specified bundle. 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::$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::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. BrowserTestBase::$profile protected property The profile to install as a basis for testing. 42 BrowserTestBase::$timeLimit protected property Time limit in seconds for the test. 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 Deprecated 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::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled. BrowserTestBase::setUpAppRoot protected function Sets up the root application path. 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. CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity. 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::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 '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. FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1 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 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 SearchCommentCountToggleTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme SearchCommentCountToggleTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules SearchCommentCountToggleTest::$searchableNodes protected property Array of nodes available to search. SearchCommentCountToggleTest::$searchingUser protected property A user with permission to search and post comments. SearchCommentCountToggleTest::setUp protected function Overrides BrowserTestBase::setUp SearchCommentCountToggleTest::testSearchCommentCountToggle public function Verify that comment count display toggles properly on comment status of node. 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. 4 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::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 1 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. Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
- class \Drupal\Tests\BrowserTestBase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait extends \PHPUnit\Framework\TestCase