feature #23499 [Workflow] add guard is_valid() method support (alain-flaus, lyrixx)

fabpot · fabpot · commit 9be01bc49cce · 2017-10-06T08:47:04.000-07:00
This PR was merged into the 3.4 branch.

Discussion
----------

[Workflow] add guard is_valid() method support

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | Yes
| License       | MIT

Workflow guard configuration support expression language like **is_fully_authenticated()**, **has_role()** or **is_granted()**, etc...
I would like to add the support for a new **is_valid()** expression.
Configuration allow to validate subject against specific validation groups to check if a transition can be applied.

In the next configuration exemple, my issue must validate "affectable" validation group to apply "affect" transistion:

```yaml
framework:
    workflows:
        issue:
            marking_store:
                type: single_state
                arguments:
                    - state
            supports: AppBundle\Entity\Issue
            initial_place: created
            places:
                - created
                - affected
                - closed
            transitions:
                affect:
                    guard: "is_valid(subject, ['affectable'])"
                    from: created
                    to:   affected
                close:
                    from: completed
                    to: closed
```

Commits
-------

06d8198714 [Workflow] Added tests for the is_valid() guard expression
9499bc291c [Workflow] Added guard 'is_valid()' method support
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 3.4.0
 -----
 
+ * 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.
 
diff --git a/EventListener/ExpressionLanguage.php b/EventListener/ExpressionLanguage.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\Workflow\EventListener;
 
 use Symfony\Component\Security\Core\Authorization\ExpressionLanguage as BaseExpressionLanguage;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Symfony\Component\Workflow\Exception\RuntimeException;
 
 /**
  * Adds some function to the default Symfony Security ExpressionLanguage.
@@ -29,5 +31,17 @@ protected function registerFunctions()
         }, function (array $variables, $attributes, $object = null) {
             return $variables['auth_checker']->isGranted($attributes, $object);
         });
+
+        $this->register('is_valid', function ($object = 'null', $groups = 'null') {
+            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('"is_valid" cannot be used as the Validator component is not installed.');
+            }
+
+            $errors = $variables['validator']->validate($object, null, $groups);
+
+            return 0 === count($errors);
+        });
     }
 }
diff --git a/EventListener/GuardListener.php b/EventListener/GuardListener.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Workflow\Event\GuardEvent;
 use Symfony\Component\Workflow\Exception\InvalidTokenConfigurationException;
 
@@ -29,15 +30,17 @@ class GuardListener
     private $authenticationChecker;
     private $trustResolver;
     private $roleHierarchy;
+    private $validator;
 
-    public function __construct($configuration, ExpressionLanguage $expressionLanguage, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authenticationChecker, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null)
+    public function __construct($configuration, ExpressionLanguage $expressionLanguage, TokenStorageInterface $tokenStorage, AuthorizationCheckerInterface $authenticationChecker, AuthenticationTrustResolverInterface $trustResolver, RoleHierarchyInterface $roleHierarchy = null, ValidatorInterface $validator = null)
     {
         $this->configuration = $configuration;
         $this->expressionLanguage = $expressionLanguage;
         $this->tokenStorage = $tokenStorage;
         $this->authenticationChecker = $authenticationChecker;
         $this->trustResolver = $trustResolver;
         $this->roleHierarchy = $roleHierarchy;
+        $this->validator = $validator;
     }
 
     public function onTransition(GuardEvent $event, $eventName)
@@ -77,6 +80,8 @@ private function getVariables(GuardEvent $event)
             'auth_checker' => $this->authenticationChecker,
             // needed for the is_* expression function
             'trust_resolver' => $this->trustResolver,
+            // needed for the is_valid expression function
+            'validator' => $this->validator,
         );
 
         return $variables;
diff --git a/Exception/RuntimeException.php b/Exception/RuntimeException.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Workflow\Exception;
+
+/**
+ * Base RuntimeException for the Workflow component.
+ *
+ * @author Alain Flaus <alain.flaus@gmail.com>
+ */
+class RuntimeException extends \RuntimeException implements ExceptionInterface
+{
+}
diff --git a/Tests/EventListener/GuardListenerTest.php b/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,69 +17,83 @@
 
 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());
     }
 
-    /**
-     * @expectedException \Symfony\Component\Workflow\Exception\InvalidTokenConfigurationException
-     * @expectedExceptionMessage There are no tokens available for workflow unnamed.
-     */
-    public function testWithNoTokensInTokenStorage()
+    public function testWithValidatorSupportedEventAndAccept()
     {
         $event = $this->createEvent();
-        $this->tokenStorage->setToken(null);
+        $this->configureValidator(true, true);
+
+        $this->listener->onTransition($event, 'test_is_valid');
 
-        $this->listener->onTransition($event, 'event_name_a');
+        $this->assertFalse($event->isBlocked());
     }
 
     private function createEvent()
@@ -90,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'))
         ;
     }
 }
diff --git a/composer.json b/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\\": "" }
