[Tests] Move expectException closer to the place of the expectation to avoid false positives

Author: OskarStark

Tests/Command/TranslationDebugCommandTest.php

@@ -118,14 +118,16 @@ public function testDebugCustomDirectory()
 
     public function testDebugInvalidDirectory()
     {
-        $this->expectException(\InvalidArgumentException::class);
         $kernel = $this->createMock(KernelInterface::class);
         $kernel->expects($this->once())
             ->method('getBundle')
             ->with($this->equalTo('dir'))
             ->willThrowException(new \InvalidArgumentException());
 
         $tester = $this->createCommandTester([], [], $kernel);
+
+        $this->expectException(\InvalidArgumentException::class);
+
         $tester->execute(['locale' => 'en', 'bundle' => 'dir']);
     }
 

Tests/Command/YamlLintCommandTest.php

@@ -60,11 +60,12 @@ public function testLintIncorrectFile()
 
     public function testLintFileNotReadable()
     {
-        $this->expectException(\RuntimeException::class);
         $tester = $this->createCommandTester();
         $filename = $this->createFile('');
         unlink($filename);
 
+        $this->expectException(\RuntimeException::class);
+
         $tester->execute(['filename' => $filename], ['decorated' => false]);
     }
 

Tests/Controller/AbstractControllerTest.php

@@ -92,13 +92,14 @@ public function testGetParameter()
 
     public function testMissingParameterBag()
     {
-        $this->expectException(ServiceNotFoundException::class);
-        $this->expectExceptionMessage('TestAbstractController::getParameter()" method is missing a parameter bag');
         $container = new Container();
 
         $controller = $this->createController();
         $controller->setContainer($container);
 
+        $this->expectException(ServiceNotFoundException::class);
+        $this->expectExceptionMessage('TestAbstractController::getParameter()" method is missing a parameter bag');
+
         $controller->getParameter('foo');
     }
 
@@ -146,12 +147,12 @@ public function testGetUserWithEmptyTokenStorage()
 
     public function testGetUserWithEmptyContainer()
     {
-        $this->expectException(\LogicException::class);
-        $this->expectExceptionMessage('The SecurityBundle is not registered in your application.');
-
         $controller = $this->createController();
         $controller->setContainer(new Container());
 
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessage('The SecurityBundle is not registered in your application.');
+
         $controller->getUser();
     }
 
@@ -327,10 +328,10 @@ public function testFileFromPathWithCustomizedFileName()
 
     public function testFileWhichDoesNotExist()
     {
-        $this->expectException(FileNotFoundException::class);
-
         $controller = $this->createController();
 
+        $this->expectException(FileNotFoundException::class);
+
         $controller->file('some-file.txt', 'test.php');
     }
 
@@ -350,8 +351,6 @@ public function testIsGranted()
 
     public function testdenyAccessUnlessGranted()
     {
-        $this->expectException(AccessDeniedException::class);
-
         $authorizationChecker = $this->createMock(AuthorizationCheckerInterface::class);
         $authorizationChecker->expects($this->once())->method('isGranted')->willReturn(false);
 
@@ -361,6 +360,8 @@ public function testdenyAccessUnlessGranted()
         $controller = $this->createController();
         $controller->setContainer($container);
 
+        $this->expectException(AccessDeniedException::class);
+
         $controller->denyAccessUnlessGranted('foo');
     }
 

Tests/Controller/TemplateControllerTest.php

@@ -47,7 +47,7 @@ public function testNoTwigInvokeMethod()
         $controller = new TemplateController();
 
         $this->expectException(\LogicException::class);
-        $this->expectExceptionMessage('You cannot use the TemplateController if the Twig Bundle is not available.');
+        $this->expectExceptionMessage('You cannot use the TemplateController if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
 
         $controller('mytemplate')->getContent();
     }

Tests/DependencyInjection/Compiler/ProfilerPassTest.php

@@ -34,13 +34,15 @@ class ProfilerPassTest extends TestCase
      */
     public function testTemplateNoIdThrowsException()
     {
-        $this->expectException(\InvalidArgumentException::class);
         $builder = new ContainerBuilder();
         $builder->register('profiler', 'ProfilerClass');
         $builder->register('my_collector_service')
             ->addTag('data_collector', ['template' => 'foo']);
 
         $profilerPass = new ProfilerPass();
+
+        $this->expectException(\InvalidArgumentException::class);
+
         $profilerPass->process($builder);
     }
 

Tests/DependencyInjection/Compiler/WorkflowGuardListenerPassTest.php

@@ -58,49 +58,53 @@ public function testNoExeptionIfAllDependenciesArePresent()
 
     public function testExceptionIfTheTokenStorageServiceIsNotPresent()
     {
-        $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('The "security.token_storage" service is needed to be able to use the workflow guard listener.');
         $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);
 
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('The "security.token_storage" service is needed to be able to use the workflow guard listener.');
+
         $this->compilerPass->process($this->container);
     }
 
     public function testExceptionIfTheAuthorizationCheckerServiceIsNotPresent()
     {
-        $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('The "security.authorization_checker" service is needed to be able to use the workflow guard listener.');
         $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);
 
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('The "security.authorization_checker" service is needed to be able to use the workflow guard listener.');
+
         $this->compilerPass->process($this->container);
     }
 
     public function testExceptionIfTheAuthenticationTrustResolverServiceIsNotPresent()
     {
-        $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('The "security.authentication.trust_resolver" service is needed to be able to use the workflow guard listener.');
         $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);
 
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('The "security.authentication.trust_resolver" service is needed to be able to use the workflow guard listener.');
+
         $this->compilerPass->process($this->container);
     }
 
     public function testExceptionIfTheRoleHierarchyServiceIsNotPresent()
     {
-        $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('The "security.role_hierarchy" service is needed to be able to use the workflow guard listener.');
         $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->expectException(LogicException::class);
+        $this->expectExceptionMessage('The "security.role_hierarchy" service is needed to be able to use the workflow guard listener.');
+
         $this->compilerPass->process($this->container);
     }
 }

Tests/DependencyInjection/ConfigurationTest.php

@@ -61,8 +61,10 @@ public function getTestValidSessionName()
      */
     public function testInvalidSessionName($sessionName)
     {
-        $this->expectException(InvalidConfigurationException::class);
         $processor = new Processor();
+
+        $this->expectException(InvalidConfigurationException::class);
+
         $processor->processConfiguration(
             new Configuration(true),
             [[
@@ -177,11 +179,12 @@ public static function provideValidAssetsPackageNameConfigurationTests(): array
      */
     public function testInvalidAssetsConfiguration(array $assetConfig, $expectedMessage)
     {
+        $processor = new Processor();
+        $configuration = new Configuration(true);
+
         $this->expectException(InvalidConfigurationException::class);
         $this->expectExceptionMessage($expectedMessage);
 
-        $processor = new Processor();
-        $configuration = new Configuration(true);
         $processor->processConfiguration($configuration, [
                 [
                     'http_method_override' => false,

Tests/DependencyInjection/FrameworkExtensionTestCase.php

@@ -634,9 +634,11 @@ public function testRouter()
 
     public function testRouterRequiresResourceOption()
     {
-        $this->expectException(InvalidConfigurationException::class);
         $container = $this->createContainer();
         $loader = new FrameworkExtension();
+
+        $this->expectException(InvalidConfigurationException::class);
+
         $loader->load([['http_method_override' => false, 'handle_all_throwables' => true, 'php_errors' => ['log' => true], 'router' => true]], $container);
     }
 

Tests/Functional/RouterDebugCommandTest.php

@@ -81,9 +81,11 @@ public function testSearchMultipleRoutesWithoutInteraction()
 
     public function testSearchWithThrow()
     {
+        $tester = $this->createCommandTester();
+
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionMessage('The route "gerard" does not exist.');
-        $tester = $this->createCommandTester();
+
         $tester->execute(['name' => 'gerard'], ['interactive' => true]);
     }
 

Tests/Routing/RouterTest.php

@@ -299,25 +299,29 @@ public function testPatternPlaceholdersWithSfContainer()
 
     public function testEnvPlaceholders()
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Using "%env(FOO)%" is not allowed in routing configuration.');
         $routes = new RouteCollection();
 
         $routes->add('foo', new Route('/%env(FOO)%'));
 
         $router = new Router($this->getPsr11ServiceContainer($routes), 'foo', [], null, $this->getParameterBag());
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Using "%env(FOO)%" is not allowed in routing configuration.');
+
         $router->getRouteCollection();
     }
 
     public function testEnvPlaceholdersWithSfContainer()
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('Using "%env(FOO)%" is not allowed in routing configuration.');
         $routes = new RouteCollection();
 
         $routes->add('foo', new Route('/%env(FOO)%'));
 
         $router = new Router($this->getServiceContainer($routes), 'foo');
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Using "%env(FOO)%" is not allowed in routing configuration.');
+
         $router->getRouteCollection();
     }
 
@@ -381,22 +385,22 @@ public function testHostPlaceholdersWithSfContainer()
 
     public function testExceptionOnNonExistentParameterWithSfContainer()
     {
-        $this->expectException(ParameterNotFoundException::class);
-        $this->expectExceptionMessage('You have requested a non-existent parameter "nope".');
         $routes = new RouteCollection();
 
         $routes->add('foo', new Route('/%nope%'));
 
         $sc = $this->getServiceContainer($routes);
 
         $router = new Router($sc, 'foo');
+
+        $this->expectException(ParameterNotFoundException::class);
+        $this->expectExceptionMessage('You have requested a non-existent parameter "nope".');
+
         $router->getRouteCollection()->get('foo');
     }
 
     public function testExceptionOnNonStringParameter()
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('The container parameter "object", used in the route configuration value "/%object%", must be a string or numeric, but it is of type "stdClass".');
         $routes = new RouteCollection();
 
         $routes->add('foo', new Route('/%object%'));
@@ -405,6 +409,10 @@ public function testExceptionOnNonStringParameter()
         $parameters = $this->getParameterBag(['object' => new \stdClass()]);
 
         $router = new Router($sc, 'foo', [], null, $parameters);
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('The container parameter "object", used in the route configuration value "/%object%", must be a string or numeric, but it is of type "stdClass".');
+
         $router->getRouteCollection()->get('foo');
     }