class ModerationInformationTest

Same name in this branch
  1. 10 core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php \Drupal\Tests\content_moderation\Unit\ModerationInformationTest
Same name in other branches
  1. 9 core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php \Drupal\Tests\content_moderation\Unit\ModerationInformationTest
  2. 9 core/modules/content_moderation/tests/src/Kernel/ModerationInformationTest.php \Drupal\Tests\content_moderation\Kernel\ModerationInformationTest
  3. 8.9.x core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php \Drupal\Tests\content_moderation\Unit\ModerationInformationTest
  4. 8.9.x core/modules/content_moderation/tests/src/Kernel/ModerationInformationTest.php \Drupal\Tests\content_moderation\Kernel\ModerationInformationTest
  5. 11.x core/modules/content_moderation/tests/src/Unit/ModerationInformationTest.php \Drupal\Tests\content_moderation\Unit\ModerationInformationTest
  6. 11.x core/modules/content_moderation/tests/src/Kernel/ModerationInformationTest.php \Drupal\Tests\content_moderation\Kernel\ModerationInformationTest

@coversDefaultClass \Drupal\content_moderation\ModerationInformation @group content_moderation

Hierarchy

Expanded class hierarchy of ModerationInformationTest

File

core/modules/content_moderation/tests/src/Kernel/ModerationInformationTest.php, line 17

Namespace

Drupal\Tests\content_moderation\Kernel
View source
class ModerationInformationTest extends KernelTestBase {
    use ContentModerationTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'content_moderation',
        'entity_test',
        'user',
        'workflows',
        'language',
        'content_translation',
    ];
    
    /**
     * The moderation information service.
     *
     * @var \Drupal\content_moderation\ModerationInformationInterface
     */
    protected $moderationInformation;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('entity_test_rev');
        $this->installEntitySchema('entity_test_mulrevpub');
        $this->installEntitySchema('content_moderation_state');
        $this->installConfig([
            'content_moderation',
        ]);
        $this->moderationInformation = $this->container
            ->get('content_moderation.moderation_information');
        ConfigurableLanguage::createFromLangcode('de')->save();
        $workflow = $this->createEditorialWorkflow();
        $workflow->getTypePlugin()
            ->addEntityTypeAndBundle('entity_test_mulrevpub', 'entity_test_mulrevpub');
        $workflow->getTypePlugin()
            ->addEntityTypeAndBundle('entity_test_rev', 'entity_test_rev');
        $workflow->save();
        $this->container
            ->get('content_translation.manager')
            ->setEnabled('entity_test_mulrevpub', 'entity_test_mulrevpub', TRUE);
    }
    
    /**
     * @covers ::getDefaultRevisionId
     */
    public function testGetDefaultRevisionId() : void {
        $entity_test_rev = EntityTestRev::create([
            'name' => 'Default Revision',
            'moderation_state' => 'published',
        ]);
        $entity_test_rev->save();
        $entity_test_rev->name = 'Pending revision';
        $entity_test_rev->moderation_state = 'draft';
        $entity_test_rev->save();
        // Check that moderation information service returns the correct default
        // revision ID.
        $default_revision_id = $this->moderationInformation
            ->getDefaultRevisionId('entity_test_rev', $entity_test_rev->id());
        $this->assertSame(1, $default_revision_id);
    }
    
    /**
     * @covers ::isDefaultRevisionPublished
     * @dataProvider isDefaultRevisionPublishedTestCases
     */
    public function testIsDefaultRevisionPublished($initial_state, $final_state, $initial_is_default_published, $final_is_default_published) : void {
        $entity = EntityTestMulRevPub::create([
            'moderation_state' => $initial_state,
        ]);
        $entity->save();
        $this->assertEquals($initial_is_default_published, $this->moderationInformation
            ->isDefaultRevisionPublished($entity));
        $entity->moderation_state = $final_state;
        $entity->save();
        $this->assertEquals($final_is_default_published, $this->moderationInformation
            ->isDefaultRevisionPublished($entity));
    }
    
    /**
     * Test cases for ::testIsDefaultRevisionPublished.
     */
    public static function isDefaultRevisionPublishedTestCases() {
        return [
            'Draft to draft' => [
                'draft',
                'draft',
                FALSE,
                FALSE,
            ],
            'Draft to published' => [
                'draft',
                'published',
                FALSE,
                TRUE,
            ],
            'Published to published' => [
                'published',
                'published',
                TRUE,
                TRUE,
            ],
            'Published to draft' => [
                'published',
                'draft',
                TRUE,
                TRUE,
            ],
        ];
    }
    
    /**
     * @covers ::isDefaultRevisionPublished
     */
    public function testIsDefaultRevisionPublishedMultilingual() : void {
        $entity = EntityTestMulRevPub::create([
            'moderation_state' => 'draft',
        ]);
        $entity->save();
        $this->assertEquals('draft', $entity->moderation_state->value);
        $translated = $entity->addTranslation('de');
        $translated->moderation_state = 'published';
        $translated->save();
        $this->assertEquals('published', $translated->moderation_state->value);
        // Test a scenario where the default revision exists with the default
        // language in a draft state and a non-default language in a published
        // state. The method returns TRUE if any of the languages for the default
        // revision are in a published state.
        $this->assertTrue($this->moderationInformation
            ->isDefaultRevisionPublished($entity));
    }
    
    /**
     * @covers ::hasPendingRevision
     */
    public function testHasPendingRevision() : void {
        $entity = EntityTestMulRevPub::create([
            'moderation_state' => 'published',
        ]);
        $entity->save();
        // Add a translation as a new revision.
        $translated = $entity->addTranslation('de');
        $translated->moderation_state = 'published';
        $translated->setNewRevision(TRUE);
        // Test a scenario where the default revision exists with the default
        // language in a published state and a non-default language in an unsaved
        // state.
        $this->assertFalse($this->moderationInformation
            ->hasPendingRevision($translated));
        // Save the translation and assert there is no pending revision.
        $translated->save();
        $this->assertFalse($this->moderationInformation
            ->hasPendingRevision($translated));
        // Create a new draft for the translation and assert there is a pending
        // revision.
        $translated->moderation_state = 'draft';
        $translated->setNewRevision(TRUE);
        $translated->save();
        $this->assertTrue($this->moderationInformation
            ->hasPendingRevision($translated));
    }
    
    /**
     * @covers ::getOriginalState
     */
    public function testGetOriginalState() : void {
        $entity = EntityTestMulRevPub::create([
            'moderation_state' => 'published',
        ]);
        $entity->save();
        $entity->moderation_state = 'foo';
        $this->assertEquals('published', $this->moderationInformation
            ->getOriginalState($entity)
            ->id());
    }
    
    /**
     * @covers ::getOriginalState
     */
    public function testGetOriginalStateMultilingual() : void {
        $entity = EntityTestMulRevPub::create([
            'moderation_state' => 'draft',
        ]);
        $entity->save();
        $translated = $entity->addTranslation('de', $entity->toArray());
        $translated->moderation_state = 'published';
        $translated->save();
        $translated->moderation_state = 'foo';
        $this->assertEquals('published', $this->moderationInformation
            ->getOriginalState($translated)
            ->id());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary 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.
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.
ContentModerationTestTrait::addEntityTypeAndBundleToWorkflow protected function Adds an entity type ID / bundle ID to the given workflow. 1
ContentModerationTestTrait::createEditorialWorkflow protected function Creates the editorial workflow. 1
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.
ModerationInformationTest::$moderationInformation protected property The moderation information service.
ModerationInformationTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
ModerationInformationTest::isDefaultRevisionPublishedTestCases public static function Test cases for ::testIsDefaultRevisionPublished.
ModerationInformationTest::setUp protected function Overrides KernelTestBase::setUp
ModerationInformationTest::testGetDefaultRevisionId public function @covers ::getDefaultRevisionId
ModerationInformationTest::testGetOriginalState public function @covers ::getOriginalState
ModerationInformationTest::testGetOriginalStateMultilingual public function @covers ::getOriginalState
ModerationInformationTest::testHasPendingRevision public function @covers ::hasPendingRevision
ModerationInformationTest::testIsDefaultRevisionPublished public function @covers ::isDefaultRevisionPublished
@dataProvider isDefaultRevisionPublishedTestCases
ModerationInformationTest::testIsDefaultRevisionPublishedMultilingual public function @covers ::isDefaultRevisionPublished
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.

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