class WorkflowStateTransitionOperationsAccessCheckTest

Same name in other branches
  1. 9 core/modules/workflows/tests/src/Unit/WorkflowStateTransitionOperationsAccessCheckTest.php \Drupal\Tests\workflows\Unit\WorkflowStateTransitionOperationsAccessCheckTest
  2. 8.9.x core/modules/workflows/tests/src/Unit/WorkflowStateTransitionOperationsAccessCheckTest.php \Drupal\Tests\workflows\Unit\WorkflowStateTransitionOperationsAccessCheckTest
  3. 11.x core/modules/workflows/tests/src/Unit/WorkflowStateTransitionOperationsAccessCheckTest.php \Drupal\Tests\workflows\Unit\WorkflowStateTransitionOperationsAccessCheckTest

@coversDefaultClass \Drupal\workflows\WorkflowStateTransitionOperationsAccessCheck @group workflows

Hierarchy

Expanded class hierarchy of WorkflowStateTransitionOperationsAccessCheckTest

File

core/modules/workflows/tests/src/Unit/WorkflowStateTransitionOperationsAccessCheckTest.php, line 20

Namespace

Drupal\Tests\workflows\Unit
View source 
class WorkflowStateTransitionOperationsAccessCheckTest extends UnitTestCase {
    
    /**
     * Tests the access method correctly proxies to the entity access system.
     *
     * @covers ::access
     * @dataProvider accessTestCases
     */
    public function testAccess($route_requirement, $resulting_entity_access_check, $route_parameters = []) : void {
        $workflow_entity_access_result = AccessResult::allowed();
        $workflow = $this->prophesize(WorkflowInterface::class);
        $workflow->access($resulting_entity_access_check, Argument::type(AccountInterface::class), TRUE)
            ->shouldBeCalled()
            ->willReturn($workflow_entity_access_result);
        $route = new Route('', [
            'workflow' => NULL,
            'workflow_transition' => NULL,
            'workflow_state' => NULL,
        ], [
            '_workflow_access' => $route_requirement,
        ]);
        $route_match_params = [
            'workflow' => $workflow->reveal(),
        ] + $route_parameters;
        $route_match = new RouteMatch(NULL, $route, $route_match_params);
        $access_check = new WorkflowStateTransitionOperationsAccessCheck();
        $account = $this->prophesize(AccountInterface::class);
        $this->assertEquals($workflow_entity_access_result, $access_check->access($route_match, $account->reveal()));
    }
    
    /**
     * Test cases for ::testAccess.
     */
    public static function accessTestCases() {
        return [
            'Transition add' => [
                'add-transition',
                'add-transition',
            ],
            'Transition update' => [
                'update-transition',
                'update-transition:foo-transition',
                [
                    'workflow_transition' => 'foo-transition',
                ],
            ],
            'Transition delete' => [
                'delete-transition',
                'delete-transition:foo-transition',
                [
                    'workflow_transition' => 'foo-transition',
                ],
            ],
            'State add' => [
                'add-state',
                'add-state',
            ],
            'State update' => [
                'update-state',
                'update-state:bar-state',
                [
                    'workflow_state' => 'bar-state',
                ],
            ],
            'State delete' => [
                'delete-state',
                'delete-state:bar-state',
                [
                    'workflow_state' => 'bar-state',
                ],
            ],
        ];
    }
    
    /**
     * @covers ::access
     */
    public function testMissingRouteParams() : void {
        $workflow = $this->prophesize(WorkflowInterface::class);
        $workflow->access()
            ->shouldNotBeCalled();
        $route = new Route('', [
            'workflow' => NULL,
            'workflow_state' => NULL,
        ], [
            '_workflow_access' => 'update-state',
        ]);
        $access_check = new WorkflowStateTransitionOperationsAccessCheck();
        $account = $this->prophesize(AccountInterface::class);
        $missing_both = new RouteMatch(NULL, $route, []);
        $this->assertEquals(AccessResult::neutral(), $access_check->access($missing_both, $account->reveal()));
        $missing_state = new RouteMatch(NULL, $route, [
            'workflow' => $workflow->reveal(),
        ]);
        $this->assertEquals(AccessResult::neutral(), $access_check->access($missing_state, $account->reveal()));
        $missing_workflow = new RouteMatch(NULL, $route, [
            'workflow_state' => 'foo',
        ]);
        $this->assertEquals(AccessResult::neutral(), $access_check->access($missing_workflow, $account->reveal()));
    }
    
    /**
     * @covers ::access
     * @dataProvider invalidOperationNameTestCases
     */
    public function testInvalidOperationName($operation_name) : void {
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage("Invalid _workflow_access operation '{$operation_name}' specified for route 'Foo Route'.");
        $route = new Route('', [], [
            '_workflow_access' => $operation_name,
        ]);
        $access_check = new WorkflowStateTransitionOperationsAccessCheck();
        $account = $this->prophesize(AccountInterface::class);
        $access_check->access(new RouteMatch('Foo Route', $route, []), $account->reveal());
    }
    
    /**
     * Test cases for ::testInvalidOperationName.
     */
    public static function invalidOperationNameTestCases() {
        return [
            [
                'invalid-op',
            ],
            [
                'foo-add-transition',
            ],
            [
                'add-transition-bar',
            ],
        ];
    }

}

Members

Title Deprecated Modifiers Object type Summary Overrides
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.
UnitTestCase::$root protected property The app root. 1
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::setUp protected function 358
UnitTestCase::setUpBeforeClass public static function
UnitTestCase::__get public function
WorkflowStateTransitionOperationsAccessCheckTest::accessTestCases public static function Test cases for ::testAccess.
WorkflowStateTransitionOperationsAccessCheckTest::invalidOperationNameTestCases public static function Test cases for ::testInvalidOperationName.
WorkflowStateTransitionOperationsAccessCheckTest::testAccess public function Tests the access method correctly proxies to the entity access system.
WorkflowStateTransitionOperationsAccessCheckTest::testInvalidOperationName public function @covers ::access
@dataProvider invalidOperationNameTestCases
WorkflowStateTransitionOperationsAccessCheckTest::testMissingRouteParams public function @covers ::access

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