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

Author: lyrixx

DependencyInjection/Compiler/WorkflowGuardListenerPass.php

@@ -17,6 +17,7 @@
 
 /**
  * @author Christian Flothmann <[email protected]>
+ * @author Grégoire Pineau <[email protected]>
  */
 class WorkflowGuardListenerPass implements CompilerPassInterface
 {
@@ -31,20 +32,17 @@ public function process(ContainerBuilder $container)
 
         $container->getParameterBag()->remove('workflow.has_guard_listeners');
 
-        if (!$container->has('security.token_storage')) {
-            throw new LogicException('The "security.token_storage" service is needed to be able to use the workflow guard listener.');
-        }
-
-        if (!$container->has('security.authorization_checker')) {
-            throw new LogicException('The "security.authorization_checker" service is needed to be able to use the workflow guard listener.');
-        }
-
-        if (!$container->has('security.authentication.trust_resolver')) {
-            throw new LogicException('The "security.authentication.trust_resolver" service is needed to be able to use the workflow guard listener.');
-        }
-
-        if (!$container->has('security.role_hierarchy')) {
-            throw new LogicException('The "security.role_hierarchy" service is needed to be able to use the workflow guard listener.');
+        $servicesNeeded = array(
+            'security.token_storage',
+            'security.authorization_checker',
+            'security.authentication.trust_resolver',
+            'security.role_hierarchy',
+        );
+
+        foreach ($servicesNeeded as $service) {
+            if (!$container->has($service)) {
+                throw new LogicException(sprintf('The "%s" service is needed to be able to use the workflow guard listener.', $service));
+            }
         }
     }
 }

DependencyInjection/FrameworkExtension.php

@@ -85,6 +85,7 @@
 use Symfony\Component\Translation\Translator;
 use Symfony\Component\Validator\ConstraintValidatorInterface;
 use Symfony\Component\Validator\ObjectInitializerInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\WebLink\HttpHeaderSerializer;
 use Symfony\Component\Workflow;
 use Symfony\Component\Yaml\Command\LintCommand as BaseYamlLintCommand;

Tests/DependencyInjection/Compiler/WorkflowGuardListenerPassTest.php

@@ -14,12 +14,11 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\WorkflowGuardListenerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Exception\LogicException;
 use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 use Symfony\Component\Security\Core\Role\RoleHierarchy;
-use Symfony\Component\Workflow\EventListener\GuardListener;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
 
 class WorkflowGuardListenerPassTest extends TestCase
 {
@@ -29,53 +28,37 @@ class WorkflowGuardListenerPassTest extends TestCase
     protected function setUp()
     {
         $this->container = new ContainerBuilder();
-        $this->container->register('foo.listener.guard', GuardListener::class);
-        $this->container->register('bar.listener.guard', GuardListener::class);
         $this->compilerPass = new WorkflowGuardListenerPass();
     }
 
-    public function testListenersAreNotRemovedIfParameterIsNotSet()
+    public function testNoExeptionIfParameterIsNotSet()
     {
         $this->compilerPass->process($this->container);
 
-        $this->assertTrue($this->container->hasDefinition('foo.listener.guard'));
-        $this->assertTrue($this->container->hasDefinition('bar.listener.guard'));
-    }
-
-    public function testParameterIsRemovedWhenThePassIsProcessed()
-    {
-        $this->container->setParameter('workflow.has_guard_listeners', array('foo.listener.guard', 'bar.listener.guard'));
-
-        try {
-            $this->compilerPass->process($this->container);
-        } catch (LogicException $e) {
-            // Here, we are not interested in the exception handling. This is tested further down.
-        }
-
         $this->assertFalse($this->container->hasParameter('workflow.has_guard_listeners'));
     }
 
-    public function testListenersAreNotRemovedIfAllDependenciesArePresent()
+    public function testNoExeptionIfAllDependenciesArePresent()
     {
-        $this->container->setParameter('workflow.has_guard_listeners', array('foo.listener.guard', 'bar.listener.guard'));
+        $this->container->setParameter('workflow.has_guard_listeners', true);
         $this->container->register('security.token_storage', TokenStorageInterface::class);
         $this->container->register('security.authorization_checker', AuthorizationCheckerInterface::class);
         $this->container->register('security.authentication.trust_resolver', AuthenticationTrustResolverInterface::class);
         $this->container->register('security.role_hierarchy', RoleHierarchy::class);
+        $this->container->register('validator', ValidatorInterface::class);
 
         $this->compilerPass->process($this->container);
 
-        $this->assertTrue($this->container->hasDefinition('foo.listener.guard'));
-        $this->assertTrue($this->container->hasDefinition('bar.listener.guard'));
+        $this->assertFalse($this->container->hasParameter('workflow.has_guard_listeners'));
     }
 
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\LogicException
      * @expectedExceptionMessage The "security.token_storage" service is needed to be able to use the workflow guard listener.
      */
-    public function testListenersAreRemovedIfTheTokenStorageServiceIsNotPresent()
+    public function testExceptionIfTheTokenStorageServiceIsNotPresent()
     {
-        $this->container->setParameter('workflow.has_guard_listeners', array('foo.listener.guard', 'bar.listener.guard'));
+        $this->container->setParameter('workflow.has_guard_listeners', true);
         $this->container->register('security.authorization_checker', AuthorizationCheckerInterface::class);
         $this->container->register('security.authentication.trust_resolver', AuthenticationTrustResolverInterface::class);
         $this->container->register('security.role_hierarchy', RoleHierarchy::class);
@@ -87,9 +70,9 @@ public function testListenersAreRemovedIfTheTokenStorageServiceIsNotPresent()
      * @expectedException \Symfony\Component\DependencyInjection\Exception\LogicException
      * @expectedExceptionMessage The "security.authorization_checker" service is needed to be able to use the workflow guard listener.
      */
-    public function testListenersAreRemovedIfTheAuthorizationCheckerServiceIsNotPresent()
+    public function testExceptionIfTheAuthorizationCheckerServiceIsNotPresent()
     {
-        $this->container->setParameter('workflow.has_guard_listeners', array('foo.listener.guard', 'bar.listener.guard'));
+        $this->container->setParameter('workflow.has_guard_listeners', true);
         $this->container->register('security.token_storage', TokenStorageInterface::class);
         $this->container->register('security.authentication.trust_resolver', AuthenticationTrustResolverInterface::class);
         $this->container->register('security.role_hierarchy', RoleHierarchy::class);
@@ -101,9 +84,9 @@ public function testListenersAreRemovedIfTheAuthorizationCheckerServiceIsNotPres
      * @expectedException \Symfony\Component\DependencyInjection\Exception\LogicException
      * @expectedExceptionMessage The "security.authentication.trust_resolver" service is needed to be able to use the workflow guard listener.
      */
-    public function testListenersAreRemovedIfTheAuthenticationTrustResolverServiceIsNotPresent()
+    public function testExceptionIfTheAuthenticationTrustResolverServiceIsNotPresent()
     {
-        $this->container->setParameter('workflow.has_guard_listeners', array('foo.listener.guard', 'bar.listener.guard'));
+        $this->container->setParameter('workflow.has_guard_listeners', true);
         $this->container->register('security.token_storage', TokenStorageInterface::class);
         $this->container->register('security.authorization_checker', AuthorizationCheckerInterface::class);
         $this->container->register('security.role_hierarchy', RoleHierarchy::class);
@@ -115,9 +98,9 @@ public function testListenersAreRemovedIfTheAuthenticationTrustResolverServiceIs
      * @expectedException \Symfony\Component\DependencyInjection\Exception\LogicException
      * @expectedExceptionMessage The "security.role_hierarchy" service is needed to be able to use the workflow guard listener.
      */
-    public function testListenersAreRemovedIfTheRoleHierarchyServiceIsNotPresent()
+    public function testExceptionIfTheRoleHierarchyServiceIsNotPresent()
     {
-        $this->container->setParameter('workflow.has_guard_listeners', array('foo.listener.guard', 'bar.listener.guard'));
+        $this->container->setParameter('workflow.has_guard_listeners', true);
         $this->container->register('security.token_storage', TokenStorageInterface::class);
         $this->container->register('security.authorization_checker', AuthorizationCheckerInterface::class);
         $this->container->register('security.authentication.trust_resolver', AuthenticationTrustResolverInterface::class);