You are here

class CommentAdminViewTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/comment/tests/src/Kernel/Views/CommentAdminViewTest.php \Drupal\Tests\comment\Kernel\Views\CommentAdminViewTest

Tests comment admin view filters.

@group comment

Hierarchy

Expanded class hierarchy of CommentAdminViewTest

File

core/modules/comment/tests/src/Kernel/Views/CommentAdminViewTest.php, line 19

Namespace

Drupal\Tests\comment\Kernel\Views
View source
class CommentAdminViewTest extends ViewsKernelTestBase {

  /**
   * Comments.
   *
   * @var \Drupal\comment\Entity\Comment[]
   */
  protected $comments = [];

  /**
   * Admin user.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'user',
    'comment',
    'entity_test',
    'language',
    'locale',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp($import_test_views = TRUE) : void {
    parent::setUp($import_test_views);
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('comment');
    $this
      ->installEntitySchema('entity_test');

    // Create the anonymous role.
    $this
      ->installConfig([
      'user',
    ]);

    // Create user 1 so that the user created later in the test has a different
    // user ID.
    // @todo Remove in https://www.drupal.org/node/540008.
    User::create([
      'uid' => 1,
      'name' => 'user1',
    ])
      ->save();

    // Enable another language.
    ConfigurableLanguage::createFromLangcode('ur')
      ->save();

    // Rebuild the container to update the default language container variable.
    $this->container
      ->get('kernel')
      ->rebuildContainer();

    // Create an anonymous user.
    $storage = \Drupal::entityTypeManager()
      ->getStorage('user');

    // Insert a row for the anonymous user.
    $storage
      ->create([
      'uid' => 0,
      'name' => '',
      'status' => 0,
    ])
      ->save();

    // Created admin role.
    $admin_role = Role::create([
      'id' => 'admin',
      'permissions' => [
        'administer comments',
        'skip comment approval',
      ],
    ]);
    $admin_role
      ->save();

    // Create the admin user.
    $this->adminUser = User::create([
      'name' => $this
        ->randomMachineName(),
      'roles' => [
        $admin_role
          ->id(),
      ],
    ]);
    $this->adminUser
      ->save();

    // Create a comment type.
    CommentType::create([
      'id' => 'comment',
      'label' => 'Default comments',
      'target_entity_type_id' => 'entity_test',
      'description' => 'Default comment field',
    ])
      ->save();

    // Create a commented entity.
    $entity = EntityTest::create();
    $entity->name->value = $this
      ->randomMachineName();
    $entity
      ->save();

    // Create some comments.
    $comment = Comment::create([
      'subject' => 'My comment title',
      'uid' => $this->adminUser
        ->id(),
      'entity_type' => 'entity_test',
      'field_name' => 'comment',
      'comment_type' => 'comment',
      'status' => 1,
      'entity_id' => $entity
        ->id(),
    ]);
    $comment
      ->save();
    $this->comments[] = $comment;
    $comment_anonymous = Comment::create([
      'subject' => 'Anonymous comment title',
      'uid' => 0,
      'name' => 'barry',
      'mail' => 'test@example.com',
      'homepage' => 'https://example.com',
      'entity_type' => 'entity_test',
      'field_name' => 'comment',
      'comment_type' => 'comment',
      'created' => 123456,
      'status' => 1,
      'entity_id' => $entity
        ->id(),
    ]);
    $comment_anonymous
      ->save();
    $this->comments[] = $comment_anonymous;
  }

  /**
   * Tests comment admin view filters.
   */
  public function testFilters() {
    $this
      ->doTestFilters('page_published');

    // Unpublish the comments to test the Unapproved comments tab.
    foreach ($this->comments as $comment) {
      $comment
        ->setUnpublished();
      $comment
        ->save();
    }
    $this
      ->doTestFilters('page_unapproved');
  }

  /**
   * Tests comment admin view display.
   *
   * @param string $display_id
   *   The display ID.
   */
  protected function doTestFilters($display_id) {
    $comment = $this->comments[0];
    $comment_anonymous = $this->comments[1];

    /** @var \Drupal\Core\Session\AccountSwitcherInterface $account_switcher */
    $account_switcher = \Drupal::service('account_switcher');

    /** @var \Drupal\Core\Render\RendererInterface $renderer */
    $renderer = \Drupal::service('renderer');
    $account_switcher
      ->switchTo($this->adminUser);
    $executable = Views::getView('comment');
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));

    // Assert the exposed filters on the admin page.
    $this
      ->assertField('subject');
    $this
      ->assertField('author_name');
    $this
      ->assertField('langcode');
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(2, $elements, 'There are two comments on the page.');
    $this
      ->assertText($comment
      ->label());
    $this
      ->assertText($comment_anonymous
      ->label());
    $executable
      ->destroy();

    // Test the Subject filter.
    $executable
      ->setExposedInput([
      'subject' => 'Anonymous',
    ]);
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(1, $elements, 'Only anonymous comment is visible.');
    $this
      ->assertNoText($comment
      ->label());
    $this
      ->assertText($comment_anonymous
      ->label());
    $executable
      ->destroy();
    $executable
      ->setExposedInput([
      'subject' => 'My comment',
    ]);
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(1, $elements, 'Only admin comment is visible.');
    $this
      ->assertText($comment
      ->label());
    $this
      ->assertNoText($comment_anonymous
      ->label());
    $executable
      ->destroy();

    // Test the combine filter using author name.
    $executable
      ->setExposedInput([
      'author_name' => 'barry',
    ]);
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(1, $elements, 'Only anonymous comment is visible.');
    $this
      ->assertNoText($comment
      ->label());
    $this
      ->assertText($comment_anonymous
      ->label());
    $executable
      ->destroy();

    // Test the combine filter using username.
    $executable
      ->setExposedInput([
      'author_name' => $this->adminUser
        ->label(),
    ]);
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(1, $elements, 'Only admin comment is visible.');
    $this
      ->assertText($comment
      ->label());
    $this
      ->assertNoText($comment_anonymous
      ->label());
    $executable
      ->destroy();

    // Test the language filter.
    $executable
      ->setExposedInput([
      'langcode' => '***LANGUAGE_site_default***',
    ]);
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(2, $elements, 'Both comments are visible.');
    $this
      ->assertText($comment
      ->label());
    $this
      ->assertText($comment_anonymous
      ->label());
    $executable
      ->destroy();

    // Tests comment translation filter.
    if (!$comment
      ->hasTranslation('ur')) {

      // If we don't have the translation then create one.
      $comment_translation = $comment
        ->addTranslation('ur', [
        'subject' => 'ur title',
      ]);
      $comment_translation
        ->save();
    }
    else {

      // If we have the translation then unpublish it.
      $comment_translation = $comment
        ->getTranslation('ur');
      $comment_translation
        ->setUnpublished();
      $comment_translation
        ->save();
    }
    if (!$comment_anonymous
      ->hasTranslation('ur')) {

      // If we don't have the translation then create one.
      $comment_anonymous_translation = $comment_anonymous
        ->addTranslation('ur', [
        'subject' => 'ur Anonymous title',
      ]);
      $comment_anonymous_translation
        ->save();
    }
    else {

      // If we have the translation then unpublish it.
      $comment_anonymous_translation = $comment_anonymous
        ->getTranslation('ur');
      $comment_anonymous_translation
        ->setUnpublished();
      $comment_anonymous_translation
        ->save();
    }
    $executable
      ->setExposedInput([
      'langcode' => 'ur',
    ]);
    $build = $executable
      ->preview($display_id);
    $this
      ->setRawContent($renderer
      ->renderRoot($build));
    $elements = $this
      ->cssSelect('input[type="checkbox"]');
    $this
      ->assertCount(2, $elements, 'Both comments are visible.');
    $this
      ->assertNoText($comment
      ->label());
    $this
      ->assertNoText($comment_anonymous
      ->label());
    $this
      ->assertText($comment_translation
      ->label());
    $this
      ->assertText($comment_anonymous_translation
      ->label());
    $executable
      ->destroy();
  }

}

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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
CommentAdminViewTest::$adminUser protected property Admin user.
CommentAdminViewTest::$comments protected property Comments.
CommentAdminViewTest::$modules protected static property Modules to enable. Overrides ViewsKernelTestBase::$modules
CommentAdminViewTest::doTestFilters protected function Tests comment admin view display.
CommentAdminViewTest::setUp protected function Overrides ViewsKernelTestBase::setUp
CommentAdminViewTest::testFilters public function Tests comment admin view filters.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
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.
ViewsKernelTestBase::$testViews public static property Views to be enabled. 131
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 8
ViewsKernelTestBase::executeView protected function Executes a view.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition protected function Returns the schema definition. 6
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 7
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 22