class CommentTypeTest

Same name in this branch
  1. 11.x core/modules/jsonapi/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\jsonapi\Functional\CommentTypeTest
  2. 11.x core/modules/comment/tests/src/Kernel/Plugin/migrate/source/CommentTypeTest.php \Drupal\Tests\comment\Kernel\Plugin\migrate\source\CommentTypeTest
Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\jsonapi\Functional\CommentTypeTest
  2. 9 core/modules/comment/tests/src/Kernel/Plugin/migrate/source/CommentTypeTest.php \Drupal\Tests\comment\Kernel\Plugin\migrate\source\CommentTypeTest
  3. 9 core/modules/comment/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\comment\Functional\CommentTypeTest
  4. 8.9.x core/modules/jsonapi/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\jsonapi\Functional\CommentTypeTest
  5. 8.9.x core/modules/comment/tests/src/Kernel/Plugin/migrate/source/d7/CommentTypeTest.php \Drupal\Tests\comment\Kernel\Plugin\migrate\source\d7\CommentTypeTest
  6. 8.9.x core/modules/comment/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\comment\Functional\CommentTypeTest
  7. 10 core/modules/jsonapi/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\jsonapi\Functional\CommentTypeTest
  8. 10 core/modules/comment/tests/src/Kernel/Plugin/migrate/source/CommentTypeTest.php \Drupal\Tests\comment\Kernel\Plugin\migrate\source\CommentTypeTest
  9. 10 core/modules/comment/tests/src/Functional/CommentTypeTest.php \Drupal\Tests\comment\Functional\CommentTypeTest

Ensures that comment type functions work correctly.

@group comment

Hierarchy

Expanded class hierarchy of CommentTypeTest

File

core/modules/comment/tests/src/Functional/CommentTypeTest.php, line 20

Namespace

Drupal\Tests\comment\Functional
View source
class CommentTypeTest extends CommentTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Admin user.
     *
     * @var \Drupal\Core\Session\AccountInterface
     */
    protected $adminUser;
    
    /**
     * Permissions to grant admin user.
     *
     * @var array
     */
    protected $permissions = [
        'administer comments',
        'administer comment fields',
        'administer comment types',
    ];
    
    /**
     * Sets the test up.
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('page_title_block');
        $this->drupalPlaceBlock('system_breadcrumb_block');
        $this->adminUser = $this->drupalCreateUser($this->permissions);
    }
    
    /**
     * Tests creating a comment type programmatically and via a form.
     */
    public function testCommentTypeCreation() : void {
        // Create a comment type programmatically.
        $type = $this->createCommentType('other');
        $comment_type = CommentType::load('other');
        $this->assertInstanceOf(CommentType::class, $comment_type);
        // Log in a test user.
        $this->drupalLogin($this->adminUser);
        // Ensure that the new comment type admin page can be accessed.
        $this->drupalGet('admin/structure/comment/manage/' . $type->id());
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->elementTextEquals('css', 'h1', "Edit {$comment_type->label()} comment type");
        // Create a comment type via the user interface.
        $edit = [
            'id' => 'foo',
            'label' => 'title for foo',
            'description' => '',
        ];
        $this->drupalGet('admin/structure/comment/types/add');
        // Ensure that target entity type is a required field.
        $this->submitForm($edit, 'Save and manage fields');
        $this->assertSession()
            ->pageTextContains('Target entity type field is required.');
        // Ensure that comment type is saved when target entity type is provided.
        $edit['target_entity_type_id'] = 'node';
        $this->submitForm($edit, 'Save and manage fields');
        $this->assertSession()
            ->pageTextContains('Comment type title for foo has been added.');
        // Asserts that form submit redirects to the expected manage fields page.
        $this->assertSession()
            ->addressEquals('admin/structure/comment/manage/' . $edit['id'] . '/fields');
        // Asserts that the comment type is visible in breadcrumb.
        $this->assertTrue($this->assertSession()
            ->elementExists('css', 'nav[role="navigation"]')
            ->hasLink('title for foo'));
        $comment_type = CommentType::load('foo');
        $this->assertInstanceOf(CommentType::class, $comment_type);
        // Check that the comment type was created in site default language.
        $default_langcode = \Drupal::languageManager()->getDefaultLanguage()
            ->getId();
        $this->assertEquals($default_langcode, $comment_type->language()
            ->getId());
        // Edit the comment-type and ensure that we cannot change the entity-type.
        $this->drupalGet('admin/structure/comment/manage/foo');
        $this->assertSession()
            ->fieldNotExists('target_entity_type_id');
        $this->assertSession()
            ->pageTextContains('Target entity type');
        // Save the form and ensure the entity-type value is preserved even though
        // the field isn't present.
        $this->submitForm([], 'Save');
        \Drupal::entityTypeManager()->getStorage('comment_type')
            ->resetCache([
            'foo',
        ]);
        $comment_type = CommentType::load('foo');
        $this->assertEquals('node', $comment_type->getTargetEntityTypeId());
        // Ensure that target type is displayed in the comment type list.
        $this->drupalGet('admin/structure/comment');
        $this->assertSession()
            ->elementExists('xpath', '//td[text() = "Content"]');
    }
    
    /**
     * Tests editing a comment type using the UI.
     */
    public function testCommentTypeEditing() : void {
        $this->drupalLogin($this->adminUser);
        $field = FieldConfig::loadByName('comment', 'comment', 'comment_body');
        $this->assertEquals('Comment', $field->getLabel(), 'Comment body field was found.');
        // Change the comment type name.
        $this->drupalGet('admin/structure/comment');
        $edit = [
            'label' => 'Bar',
        ];
        $this->drupalGet('admin/structure/comment/manage/comment');
        $this->submitForm($edit, 'Save');
        $this->drupalGet('admin/structure/comment');
        $this->assertSession()
            ->pageTextContains('Bar');
        $this->clickLink('Manage fields');
        // Verify that the original machine name was used in the URL.
        $this->assertSession()
            ->addressEquals(Url::fromRoute('entity.comment.field_ui_fields', [
            'comment_type' => 'comment',
        ]));
        $this->assertCount(1, $this->cssSelect('tr#comment-body'), 'Body field exists.');
        // Remove the body field.
        $this->drupalGet('admin/structure/comment/manage/comment/fields/comment.comment.comment_body/delete');
        $this->submitForm([], 'Delete');
        // Resave the settings for this type.
        $this->drupalGet('admin/structure/comment/manage/comment');
        $this->submitForm([], 'Save');
        // Check that the body field doesn't exist.
        $this->drupalGet('admin/structure/comment/manage/comment/fields');
        $this->assertCount(0, $this->cssSelect('tr#comment-body'), 'Body field does not exist.');
    }
    
    /**
     * Tests deleting a comment type that still has content.
     */
    public function testCommentTypeDeletion() : void {
        // Create a comment type programmatically.
        $type = $this->createCommentType('foo');
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->addDefaultCommentField('node', 'page', 'foo', CommentItemInterface::OPEN, 'foo');
        $field_storage = FieldStorageConfig::loadByName('node', 'foo');
        $this->drupalLogin($this->adminUser);
        // Create a node.
        $node = Node::create([
            'type' => 'page',
            'title' => 'foo',
        ]);
        $node->save();
        // Add a new comment of this type.
        $comment = Comment::create([
            'comment_type' => 'foo',
            'entity_type' => 'node',
            'field_name' => 'foo',
            'entity_id' => $node->id(),
        ]);
        $comment->save();
        // Attempt to delete the comment type, which should not be allowed.
        $this->drupalGet('admin/structure/comment/manage/' . $type->id() . '/delete');
        $this->assertSession()
            ->pageTextContains($type->label() . ' is used by 1 comment on your site. You can not remove this comment type until you have removed all of the ' . $type->label() . ' comments.');
        $this->assertSession()
            ->pageTextContains('foo is used by the node.foo field on your site. You can not remove this comment type until you have removed the field.');
        $this->assertSession()
            ->pageTextNotContains('This action cannot be undone.');
        // Delete the comment and the field.
        $comment->delete();
        $field_storage->delete();
        // Attempt to delete the comment type, which should now be allowed.
        $this->drupalGet('admin/structure/comment/manage/' . $type->id() . '/delete');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to delete the comment type ' . $type->id() . '?');
        $this->assertSession()
            ->pageTextContains('This action cannot be undone.');
        // Test exception thrown when re-using an existing comment type.
        try {
            $this->addDefaultCommentField('comment', 'comment', 'bar');
            $this->fail('Exception not thrown.');
        } catch (\InvalidArgumentException) {
            // Expected exception; just continue testing.
        }
        // Delete the comment type.
        $this->drupalGet('admin/structure/comment/manage/' . $type->id() . '/delete');
        $this->submitForm([], 'Delete');
        $this->assertNull(CommentType::load($type->id()), 'Comment type deleted.');
        $this->assertSession()
            ->pageTextContains('The comment type ' . $type->label() . ' has been deleted.');
    }

}

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.
CommentTestBase::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules 11
CommentTestBase::$node protected property A test node to which comments will be posted.
CommentTestBase::$webUser protected property A normal user with permission to post comments.
CommentTestBase::commentContactInfoAvailable protected function Checks whether the commenter's contact information is displayed.
CommentTestBase::commentExists protected function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment type (bundle).
CommentTestBase::deleteComment protected function Deletes a comment.
CommentTestBase::getUnapprovedComment protected function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation protected function Performs the specified operation on the specified comment.
CommentTestBase::postComment protected function Posts a comment.
CommentTestBase::setCommentAnonymous protected function Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm protected function Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview protected function Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings protected function Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage protected function Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject protected function Sets the value governing whether the subject field should be enabled.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
CommentTypeTest::$adminUser protected property Admin user. Overrides CommentTestBase::$adminUser
CommentTypeTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentTypeTest::$permissions protected property Permissions to grant admin user.
CommentTypeTest::setUp protected function Sets the test up. Overrides CommentTestBase::setUp
CommentTypeTest::testCommentTypeCreation public function Tests creating a comment type programmatically and via a form.
CommentTypeTest::testCommentTypeDeletion public function Tests deleting a comment type that still has content.
CommentTypeTest::testCommentTypeEditing public function Tests editing a comment type using the UI.
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 '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. 3
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
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::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.
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.