class UnpublishByKeywordCommentTest

Same name in this branch
  1. 10 core/modules/comment/tests/src/Unit/Action/UnpublishByKeywordCommentTest.php \Drupal\Tests\comment\Unit\Action\UnpublishByKeywordCommentTest

@group action

Hierarchy

Expanded class hierarchy of UnpublishByKeywordCommentTest

File

core/modules/action/tests/src/Kernel/UnpublishByKeywordCommentTest.php, line 21

Namespace

Drupal\Tests\action\Kernel
View source
class UnpublishByKeywordCommentTest extends EntityKernelTestBase {
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'action',
        'comment',
        'entity_test',
    ];
    
    /**
     * Keywords used for testing.
     *
     * @var string[]
     */
    protected $keywords;
    
    /**
     * The comment entity.
     *
     * @var \Drupal\comment\CommentInterface
     */
    protected $comment;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'user',
            'comment',
        ]);
        $this->installSchema('comment', [
            'comment_entity_statistics',
        ]);
        // Create a comment type.
        CommentType::create([
            'id' => 'comment',
            'label' => 'Default comments',
            'description' => 'Default comment field',
            'target_entity_type_id' => 'entity_test',
        ])->save();
        $this->addDefaultCommentField('entity_test', 'entity_test', 'comment');
        // Setup date format to render comment date.
        DateFormat::create([
            'id' => 'fallback',
            'pattern' => 'D, m/d/Y - H:i',
            'label' => 'Fallback',
        ])->save();
        // Create format without filters to prevent filtering.
        FilterFormat::create([
            'format' => 'no_filters',
            'name' => 'No filters',
            'filters' => [],
        ])->save();
        // Set current user to allow filters display comment body.
        $this->drupalSetCurrentUser($this->drupalCreateUser());
        $this->keywords = [
            $this->randomMachineName(),
            $this->randomMachineName(),
        ];
        // Create a comment against a test entity.
        $host = EntityTest::create();
        $host->save();
        $this->comment = Comment::create([
            'entity_type' => 'entity_test',
            'name' => $this->randomString(),
            'hostname' => 'magic.example.com',
            'mail' => 'tonythemagicalpony@example.com',
            'subject' => $this->keywords[0],
            'comment_body' => $this->keywords[1],
            'entity_id' => $host->id(),
            'comment_type' => 'comment',
            'field_name' => 'comment',
        ]);
        $this->comment
            ->get('comment_body')->format = 'no_filters';
        $this->comment
            ->setPublished();
    }
    
    /**
     * Tests comment module's default config actions.
     *
     * @see \Drupal\Core\Entity\Form\DeleteMultipleForm::submitForm()
     * @see \Drupal\Core\Action\Plugin\Action\DeleteAction
     * @see \Drupal\Core\Action\Plugin\Action\Derivative\EntityDeleteActionDeriver
     * @see \Drupal\Core\Action\Plugin\Action\PublishAction
     * @see \Drupal\Core\Action\Plugin\Action\SaveAction
     */
    public function testCommentDefaultConfigActions() : void {
        $this->assertTrue($this->comment
            ->isNew());
        $action = Action::load('comment_save_action');
        $action->execute([
            $this->comment,
        ]);
        $this->assertFalse($this->comment
            ->isNew());
        $this->assertTrue($this->comment
            ->isPublished());
        // Tests comment unpublish.
        $action = Action::load('comment_unpublish_action');
        $action->execute([
            $this->comment,
        ]);
        $this->assertFalse($this->comment
            ->isPublished(), 'Comment was unpublished');
        $this->assertSame([
            'module' => [
                'comment',
            ],
        ], $action->getDependencies());
        // Tests comment publish.
        $action = Action::load('comment_publish_action');
        $action->execute([
            $this->comment,
        ]);
        $this->assertTrue($this->comment
            ->isPublished(), 'Comment was published');
        $action = Action::load('comment_delete_action');
        $action->execute([
            $this->comment,
        ]);
        
        /** @var \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store */
        $temp_store = $this->container
            ->get('tempstore.private');
        $account_id = $this->container
            ->get('current_user')
            ->id();
        $store_entries = $temp_store->get('entity_delete_multiple_confirm')
            ->get($account_id . ':comment');
        $this->assertSame([
            $account_id => [
                'en' => 'en',
            ],
        ], $store_entries);
    }
    
    /**
     * Tests the unpublish comment by keyword action.
     *
     * @see \Drupal\comment\Plugin\Action\UnpublishByKeywordComment
     */
    public function testCommentUnpublishByKeyword() : void {
        $this->comment
            ->save();
        $action = Action::create([
            'id' => 'comment_unpublish_by_keyword_action',
            'label' => $this->randomMachineName(),
            'type' => 'comment',
            'plugin' => 'comment_unpublish_by_keyword_action',
        ]);
        // Tests no keywords.
        $action->execute([
            $this->comment,
        ]);
        $this->assertTrue($this->comment
            ->isPublished(), 'The comment status was set to published.');
        // Tests keyword in subject.
        $action->set('configuration', [
            'keywords' => [
                $this->keywords[0],
            ],
        ]);
        $action->execute([
            $this->comment,
        ]);
        $this->assertFalse($this->comment
            ->isPublished(), 'The comment status was set to not published.');
        // Tests keyword in comment body.
        $this->comment
            ->setPublished();
        $action->set('configuration', [
            'keywords' => [
                $this->keywords[1],
            ],
        ]);
        $action->execute([
            $this->comment,
        ]);
        $this->assertFalse($this->comment
            ->isPublished(), 'The comment status was set to not published.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title 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 raw text IS NOT found escaped on 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::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.
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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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 Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
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::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.
RandomGeneratorTrait::randomStringValidate Deprecated 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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UnpublishByKeywordCommentTest::$comment protected property The comment entity.
UnpublishByKeywordCommentTest::$keywords protected property Keywords used for testing.
UnpublishByKeywordCommentTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
UnpublishByKeywordCommentTest::setUp protected function Overrides EntityKernelTestBase::setUp
UnpublishByKeywordCommentTest::testCommentDefaultConfigActions public function Tests comment module's default config actions.
UnpublishByKeywordCommentTest::testCommentUnpublishByKeyword public function Tests the unpublish comment by keyword action.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

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