You are here

Home » API reference » Workbench Moderation 8 » EntityStateChangeValidationTest.php

class EntityStateChangeValidationTest in Workbench Moderation 8

Same name and namespace in other branches
  1. 8.2 tests/src/Kernel/EntityStateChangeValidationTest.php \Drupal\Tests\workbench_moderation\Kernel\EntityStateChangeValidationTest

@coversDefaultClass \Drupal\workbench_moderation\Plugin\Validation\Constraint\ModerationStateValidator @group workbench_moderation

Hierarchy

Expanded class hierarchy of EntityStateChangeValidationTest

File

tests/src/Kernel/EntityStateChangeValidationTest.php, line 15

Namespace

Drupal\Tests\workbench_moderation\Kernel
View source 
class EntityStateChangeValidationTest extends KernelTestBase {
  use UserCreationTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'node',
    'workbench_moderation',
    'user',
    'system',
    'language',
    'content_translation',
  ];

  /**
   * An admin user account.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $adminUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('node', 'node_access');
    $this
      ->installSchema('system', [
      'sequences',
    ]);
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('user');
    $this
      ->installConfig('workbench_moderation');
    $this->adminUser = $this
      ->createUser(array_keys($this->container
      ->get('user.permissions')
      ->getPermissions()));
  }

  /**
   * Test valid transitions.
   *
   * @covers ::validate
   */
  public function testValidTransition() {
    $this
      ->setCurrentUser($this->adminUser);
    $node_type = NodeType::create([
      'type' => 'example',
    ]);
    $node_type
      ->save();
    $node = Node::create([
      'type' => 'example',
      'title' => 'Test title',
      'moderation_state' => 'draft',
    ]);
    $node
      ->save();
    $node->moderation_state->target_id = 'needs_review';
    $this
      ->assertCount(0, $node
      ->validate());
  }

  /**
   * Test invalid transitions.
   *
   * @covers ::validate
   */
  public function testInvalidTransition() {
    $this
      ->setCurrentUser($this->adminUser);
    $node_type = NodeType::create([
      'type' => 'example',
    ]);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'enabled', TRUE);
    $node_type
      ->save();
    $node = Node::create([
      'type' => 'example',
      'title' => 'Test title',
      'moderation_state' => 'draft',
    ]);
    $node
      ->save();
    $node->moderation_state->target_id = 'archived';
    $violations = $node
      ->validate();
    $this
      ->assertCount(1, $violations);
    $this
      ->assertEquals('Invalid state transition from <em class="placeholder">Draft</em> to <em class="placeholder">Archived</em>', $violations
      ->get(0)
      ->getMessage());
  }

  /**
   * Verifies if content without prior moderation information can be moderated.
   */
  public function testContent() {
    $this
      ->setCurrentUser($this->adminUser);
    $node_type = NodeType::create([
      'type' => 'example',
    ]);
    $node_type
      ->save();

    /** @var \Drupal\node\Entity\NodeInterface $node */
    $node = Node::create([
      'type' => 'example',
      'title' => 'Test title',
    ]);
    $node
      ->save();
    $nid = $node
      ->id();

    // Enable moderation for our node type.

    /** @var \Drupal\node\Entity\NodeType $node_type */
    $node_type = NodeType::load('example');
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'enabled', TRUE);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'allowed_moderation_states', [
      'draft',
      'needs_review',
      'published',
    ]);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'default_moderation_state', 'draft');
    $node_type
      ->save();
    $node = Node::load($nid);

    // Having no previous state should not break validation.
    $violations = $node
      ->validate();
    $this
      ->assertCount(0, $violations);

    // Having no previous state should not break saving the node.
    $node
      ->setTitle('New');
    $node
      ->save();
  }

  /**
   * Verifies content without prior moderation information can be translated.
   */
  public function testMultilingualContent() {

    // Enable French.
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();
    $node_type = NodeType::create([
      'type' => 'example',
    ]);
    $node_type
      ->save();

    /** @var \Drupal\node\Entity\NodeInterface $node */
    $node = Node::create([
      'type' => 'example',
      'title' => 'Test title',
      'langcode' => 'en',
    ]);
    $node
      ->save();
    $nid = $node
      ->id();
    $node = Node::load($nid);

    // Creating a translation shouldn't break, even though there's no previous
    // moderated revision for the new language.
    $node_fr = $node
      ->addTranslation('fr');
    $node_fr
      ->setTitle('Francais');
    $node_fr
      ->save();

    // Enable moderation for our node type.

    /** @var \Drupal\node\Entity\NodeType $node_type */
    $node_type = NodeType::load('example');
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'enabled', TRUE);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'allowed_moderation_states', [
      'draft',
      'needs_review',
      'published',
    ]);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'default_moderation_state', 'draft');
    $node_type
      ->save();

    // Reload the French version of the node.
    $node = Node::load($nid);
    $node_fr = $node
      ->getTranslation('fr');

    /** @var \Drupal\node\Entity\NodeInterface $node_fr */
    $node_fr
      ->setTitle('Nouveau');
    $node_fr
      ->save();
  }

  /**
   * Test transistion access validation on new entity creation.
   *
   * @dataProvider transitionAccessValidationTestCases
   */
  public function testTransitionAccessValidationNewEntity($permissions, $default_state, $target_state, $messages) {
    $this
      ->setCurrentUser($this
      ->createUser($permissions));
    $this
      ->createExampleModeratedContentType($default_state, [
      'draft',
      'needs_review',
      'published',
      'archived',
    ]);
    $node = Node::create([
      'type' => 'example',
      'title' => 'Test content',
      'moderation_state' => $target_state,
    ]);
    $this
      ->assertTrue($node
      ->isNew());
    $violations = $node
      ->validate();
    $this
      ->assertCount(count($messages), $violations);
    foreach ($messages as $i => $message) {
      $this
        ->assertEquals($message, $violations
        ->get($i)
        ->getMessage());
    }
  }

  /**
   * Test transition access validation on entity save.
   *
   * @dataProvider transitionAccessValidationTestCases
   */
  public function testTransitionAccessValidationSavedEntity($permissions, $default_state, $target_state, $messages) {
    $this
      ->setCurrentUser($this
      ->createUser($permissions));
    $this
      ->createExampleModeratedContentType($default_state, [
      'draft',
      'needs_review',
      'published',
      'archived',
    ]);
    $node = Node::create([
      'type' => 'example',
      'title' => 'Test content',
      'moderation_state' => $default_state,
    ]);
    $node
      ->save();
    $node->moderation_state = $target_state;
    $violations = $node
      ->validate();
    $this
      ->assertCount(count($messages), $violations);
    foreach ($messages as $i => $message) {
      $this
        ->assertEquals($message, $violations
        ->get($i)
        ->getMessage());
    }
  }

  /**
   * Test cases for access validation.
   */
  public function transitionAccessValidationTestCases() {
    return [
      'Invalid transition, no permissions validated' => [
        [],
        'draft',
        'archived',
        [
          'Invalid state transition from <em class="placeholder">Draft</em> to <em class="placeholder">Archived</em>',
        ],
      ],
      'Valid transition, missing permission' => [
        [],
        'draft',
        'published',
        [
          'You do not have access to transition from <em class="placeholder">Draft</em> to <em class="placeholder">Published</em>',
        ],
      ],
      'Valid transition, granted published permission' => [
        [
          'use draft_published transition',
        ],
        'draft',
        'published',
        [],
      ],
      'Valid transition, granted draft permission' => [
        [
          'use draft_draft transition',
        ],
        'draft',
        'draft',
        [],
      ],
      'Valid transition, incorrect permission granted' => [
        [
          'use draft_draft transition',
        ],
        'draft',
        'published',
        [
          'You do not have access to transition from <em class="placeholder">Draft</em> to <em class="placeholder">Published</em>',
        ],
      ],
      'Non-draft default state, incorrect permission granted' => [
        [
          'use draft_draft transition',
        ],
        'archived',
        'published',
        [
          'You do not have access to transition from <em class="placeholder">Archived</em> to <em class="placeholder">Published</em>',
        ],
      ],
      'Non-draft default state, correct permission granted' => [
        [
          'use archived_published transition',
        ],
        'archived',
        'published',
        [],
      ],
      'Non-draft default state, invalid transition' => [
        [
          'use published_archived transition',
        ],
        'archived',
        'draft',
        [
          'Invalid state transition from <em class="placeholder">Archived</em> to <em class="placeholder">Draft</em>',
        ],
      ],
    ];
  }

  /**
   * Create an example content type.
   *
   * @param string $default_state
   *   The default state.
   * @param array $allowed_states
   *   The allowed states.
   */
  protected function createExampleModeratedContentType($default_state, array $allowed_states) {
    $node_type = NodeType::create([
      'type' => 'example',
    ]);
    $node_type
      ->save();
    $node_type = NodeType::load('example');
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'enabled', TRUE);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'allowed_moderation_states', $allowed_states);
    $node_type
      ->setThirdPartySetting('workbench_moderation', 'default_moderation_state', $default_state);
    $node_type
      ->save();
  }

}

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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
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.
EntityStateChangeValidationTest::$adminUser protected property An admin user account.
EntityStateChangeValidationTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
EntityStateChangeValidationTest::createExampleModeratedContentType protected function Create an example content type.
EntityStateChangeValidationTest::setUp protected function Overrides KernelTestBase::setUp
EntityStateChangeValidationTest::testContent public function Verifies if content without prior moderation information can be moderated.
EntityStateChangeValidationTest::testInvalidTransition public function Test invalid transitions.
EntityStateChangeValidationTest::testMultilingualContent public function Verifies content without prior moderation information can be translated.
EntityStateChangeValidationTest::testTransitionAccessValidationNewEntity public function Test transistion access validation on new entity creation.
EntityStateChangeValidationTest::testTransitionAccessValidationSavedEntity public function Test transition access validation on entity save.
EntityStateChangeValidationTest::testValidTransition public function Test valid transitions.
EntityStateChangeValidationTest::transitionAccessValidationTestCases public function Test cases for access validation.
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
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.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
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.