class StateTransitionValidationTest

Same name in other branches
  1. 9 core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php \Drupal\Tests\content_moderation\Unit\StateTransitionValidationTest
  2. 8.9.x core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php \Drupal\Tests\content_moderation\Unit\StateTransitionValidationTest
  3. 10 core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php \Drupal\Tests\content_moderation\Unit\StateTransitionValidationTest

@coversDefaultClass \Drupal\content_moderation\StateTransitionValidation @group content_moderation

Hierarchy

Expanded class hierarchy of StateTransitionValidationTest

File

core/modules/content_moderation/tests/src/Unit/StateTransitionValidationTest.php, line 22

Namespace

Drupal\Tests\content_moderation\Unit
View source
class StateTransitionValidationTest extends UnitTestCase {
    
    /**
     * A test workflow.
     *
     * @var \Drupal\workflows\WorkflowInterface
     */
    protected $workflow;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create a container so that the plugin manager and workflow type can be
        // mocked.
        $container = new ContainerBuilder();
        $workflow_manager = $this->prophesize(WorkflowTypeManager::class);
        $workflow_manager->createInstance('content_moderation', Argument::any())
            ->willReturn(new TestType([], '', []));
        $container->set('plugin.manager.workflows.type', $workflow_manager->reveal());
        \Drupal::setContainer($container);
        $this->workflow = new Workflow([
            'id' => 'process',
            'type' => 'content_moderation',
        ], 'workflow');
        $this->workflow
            ->getTypePlugin()
            ->addState('draft', 'draft')
            ->addState('needs_review', 'needs_review')
            ->addState('published', 'published')
            ->addTransition('draft', 'draft', [
            'draft',
        ], 'draft')
            ->addTransition('review', 'review', [
            'draft',
        ], 'needs_review')
            ->addTransition('publish', 'publish', [
            'needs_review',
            'published',
        ], 'published');
    }
    
    /**
     * Verifies user-aware transition validation.
     *
     * @param string $from_id
     *   The state to transition from.
     * @param string $to_id
     *   The state to transition to.
     * @param string $permission
     *   The permission to give the user, or not.
     * @param bool $allowed
     *   Whether or not to grant a user this permission.
     * @param bool $result
     *   Whether getValidTransitions() is expected to have the.
     *
     * @dataProvider userTransitionsProvider
     */
    public function testUserSensitiveValidTransitions($from_id, $to_id, $permission, $allowed, $result) : void {
        $user = $this->prophesize(AccountInterface::class);
        // The one listed permission will be returned as instructed; Any others are
        // always denied.
        $user->hasPermission($permission)
            ->willReturn($allowed);
        $user->hasPermission(Argument::type('string'))
            ->willReturn(FALSE);
        $entity = $this->prophesize(ContentEntityInterface::class);
        $entity = $entity->reveal();
        $entity->moderation_state = new \stdClass();
        $entity->moderation_state->value = $from_id;
        $moderation_info = $this->prophesize(ModerationInformationInterface::class);
        $moderation_info->getWorkflowForEntity($entity)
            ->willReturn($this->workflow);
        $validator = new StateTransitionValidation($moderation_info->reveal());
        $has_transition = FALSE;
        foreach ($validator->getValidTransitions($entity, $user->reveal()) as $transition) {
            if ($transition->to()
                ->id() === $to_id) {
                $has_transition = TRUE;
                break;
            }
        }
        $this->assertSame($result, $has_transition);
    }
    
    /**
     * Data provider for the user transition test.
     */
    public static function userTransitionsProvider() {
        // The user has the right permission, so let it through.
        $ret[] = [
            'draft',
            'draft',
            'use process transition draft',
            TRUE,
            TRUE,
        ];
        // The user doesn't have the right permission, block it.
        $ret[] = [
            'draft',
            'draft',
            'use process transition draft',
            FALSE,
            FALSE,
        ];
        // The user has some other permission that doesn't matter.
        $ret[] = [
            'draft',
            'draft',
            'use process transition review',
            TRUE,
            FALSE,
        ];
        return $ret;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
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.
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.
StateTransitionValidationTest::$workflow protected property A test workflow.
StateTransitionValidationTest::setUp protected function Overrides UnitTestCase::setUp
StateTransitionValidationTest::testUserSensitiveValidTransitions public function Verifies user-aware transition validation.
StateTransitionValidationTest::userTransitionsProvider public static function Data provider for the user transition test.
UnitTestCase::$root protected property The app root.
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function

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