[Workflow] Added tests for the is_valid() guard expression

Author: lyrixx

CHANGELOG.md

@@ -4,7 +4,7 @@ CHANGELOG
 3.4.0
 -----
 
- * Add guard `is_valid()` method support
+ * Added guard `is_valid()` method support.
  * Added support for `Event::getWorkflowName()` for "announce" events.
  * Added `workflow.completed` events which are fired after a transition is completed.
 

EventListener/ExpressionLanguage.php

@@ -36,7 +36,7 @@ protected function registerFunctions()
             return sprintf('0 === count($validator->validate(%s, null, %s))', $object, $groups);
         }, function (array $variables, $object = null, $groups = null) {
             if (!$variables['validator'] instanceof ValidatorInterface) {
-                throw new RuntimeException('Validator not defined, did you install the component?');
+                throw new RuntimeException('"is_valid" cannot be used as the Validator component is not installed.');
             }
 
             $errors = $variables['validator']->validate($object, null, $groups);

Tests/EventListener/GuardListenerTest.php

@@ -8,6 +8,7 @@
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 use Symfony\Component\Security\Core\Role\Role;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Workflow\EventListener\ExpressionLanguage;
 use Symfony\Component\Workflow\EventListener\GuardListener;
 use Symfony\Component\Workflow\Event\GuardEvent;
@@ -16,59 +17,85 @@
 
 class GuardListenerTest extends TestCase
 {
-    private $tokenStorage;
+    private $authenticationChecker;
+    private $validator;
     private $listener;
 
     protected function setUp()
     {
         $configuration = array(
-            'event_name_a' => 'true',
-            'event_name_b' => 'false',
+            'test_is_granted' => 'is_granted("something")',
+            'test_is_valid' => 'is_valid(subject)',
         );
-
         $expressionLanguage = new ExpressionLanguage();
-        $this->tokenStorage = $this->getMockBuilder(TokenStorageInterface::class)->getMock();
-        $authenticationChecker = $this->getMockBuilder(AuthorizationCheckerInterface::class)->getMock();
+        $token = $this->getMockBuilder(TokenInterface::class)->getMock();
+        $token->expects($this->any())->method('getRoles')->willReturn(array(new Role('ROLE_USER')));
+        $tokenStorage = $this->getMockBuilder(TokenStorageInterface::class)->getMock();
+        $tokenStorage->expects($this->any())->method('getToken')->willReturn($token);
+        $this->authenticationChecker = $this->getMockBuilder(AuthorizationCheckerInterface::class)->getMock();
         $trustResolver = $this->getMockBuilder(AuthenticationTrustResolverInterface::class)->getMock();
-
-        $this->listener = new GuardListener($configuration, $expressionLanguage, $this->tokenStorage, $authenticationChecker, $trustResolver);
+        $this->validator = $this->getMockBuilder(ValidatorInterface::class)->getMock();
+        $this->listener = new GuardListener($configuration, $expressionLanguage, $tokenStorage, $this->authenticationChecker, $trustResolver, null, $this->validator);
     }
 
     protected function tearDown()
     {
+        $this->authenticationChecker = null;
+        $this->validator = null;
         $this->listener = null;
     }
 
     public function testWithNotSupportedEvent()
     {
         $event = $this->createEvent();
-        $this->configureTokenStorage(false);
+        $this->configureAuthenticationChecker(false);
+        $this->configureValidator(false);
 
         $this->listener->onTransition($event, 'not supported');
 
         $this->assertFalse($event->isBlocked());
     }
 
-    public function testWithSupportedEventAndReject()
+    public function testWithSecuritySupportedEventAndReject()
     {
         $event = $this->createEvent();
-        $this->configureTokenStorage(true);
+        $this->configureAuthenticationChecker(true, false);
 
-        $this->listener->onTransition($event, 'event_name_a');
+        $this->listener->onTransition($event, 'test_is_granted');
+
+        $this->assertTrue($event->isBlocked());
+    }
+
+    public function testWithSecuritySupportedEventAndAccept()
+    {
+        $event = $this->createEvent();
+        $this->configureAuthenticationChecker(true, true);
+
+        $this->listener->onTransition($event, 'test_is_granted');
 
         $this->assertFalse($event->isBlocked());
     }
 
-    public function testWithSupportedEventAndAccept()
+    public function testWithValidatorSupportedEventAndReject()
     {
         $event = $this->createEvent();
-        $this->configureTokenStorage(true);
+        $this->configureValidator(true, false);
 
-        $this->listener->onTransition($event, 'event_name_b');
+        $this->listener->onTransition($event, 'test_is_valid');
 
         $this->assertTrue($event->isBlocked());
     }
 
+    public function testWithValidatorSupportedEventAndAccept()
+    {
+        $event = $this->createEvent();
+        $this->configureValidator(true, true);
+
+        $this->listener->onTransition($event, 'test_is_valid');
+
+        $this->assertFalse($event->isBlocked());
+    }
+
     private function createEvent()
     {
         $subject = new \stdClass();
@@ -78,28 +105,39 @@ private function createEvent()
         return new GuardEvent($subject, $subject->marking, $transition);
     }
 
-    private function configureTokenStorage($hasUser)
+    private function configureAuthenticationChecker($isUsed, $granted = true)
     {
-        if (!$hasUser) {
-            $this->tokenStorage
+        if (!$isUsed) {
+            $this->authenticationChecker
                 ->expects($this->never())
-                ->method('getToken')
+                ->method('isGranted')
             ;
 
             return;
         }
 
-        $token = $this->getMockBuilder(TokenInterface::class)->getMock();
-        $token
+        $this->authenticationChecker
             ->expects($this->once())
-            ->method('getRoles')
-            ->willReturn(array(new Role('ROLE_ADMIN')))
+            ->method('isGranted')
+            ->willReturn($granted)
         ;
+    }
+
+    private function configureValidator($isUsed, $valid = true)
+    {
+        if (!$isUsed) {
+            $this->validator
+                ->expects($this->never())
+                ->method('validate')
+            ;
+
+            return;
+        }
 
-        $this->tokenStorage
+        $this->validator
             ->expects($this->once())
-            ->method('getToken')
-            ->willReturn($token)
+            ->method('validate')
+            ->willReturn($valid ? array() : array('a violation'))
         ;
     }
 }

composer.json

@@ -28,7 +28,8 @@
         "symfony/dependency-injection": "~2.8|~3.0|~4.0",
         "symfony/event-dispatcher": "~2.1|~3.0|~4.0",
         "symfony/expression-language": "~2.8|~3.0|~4.0",
-        "symfony/security-core": "~2.8|~3.0|~4.0"
+        "symfony/security-core": "~2.8|~3.0|~4.0",
+        "symfony/validator": "~2.8|~3.4|~4.0"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\Workflow\\": "" }