test cache warmer extension

schmittjoh · Nov 19, 2017 · cb975a4 · cb975a4
1 parent b635851
commit cb975a4
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 6 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -177,8 +177,16 @@ private function addMetadataSection(NodeBuilder $builder)
                     ->arrayNode('warmup')
                         ->addDefaultsIfNotSet()
                         ->children()
-                            ->arrayNode('directories')
-                                ->prototype('scalar')->end()
+                            ->arrayNode('paths')
+                                ->addDefaultsIfNotSet()
+                                ->children()
+                                    ->arrayNode('included')
+                                        ->prototype('scalar')->end()
+                                    ->end()
+                                    ->arrayNode('excluded')
+                                        ->prototype('scalar')->end()
+                                    ->end()
+                                ->end()
                             ->end()
                         ->end()
                     ->end()

diff --git a/DependencyInjection/JMSSerializerExtension.php b/DependencyInjection/JMSSerializerExtension.php
@@ -109,10 +109,11 @@ public function loadInternal(array $config, ContainerBuilder $container)
             ->replaceArgument(2, $config['metadata']['debug']);
 
         // warmup
-        if ($config['metadata']['warmup']['directories']) {
+        if ($config['metadata']['warmup']['paths']['included']) {
             $container
                 ->getDefinition('jms_serializer.cache.cache_warmer')
-                ->replaceArgument(0, $config['metadata']['warmup']['directories']);
+                ->replaceArgument(0, $config['metadata']['warmup']['paths']['included'])
+                ->replaceArgument(2, $config['metadata']['warmup']['paths']['excluded']);
         } else {
             $container->removeDefinition('jms_serializer.cache.cache_warmer');
         }

diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -288,8 +288,9 @@
 
 
         <service id="jms_serializer.cache.cache_warmer" class="%jms_serializer.cache.cache_warmer.class%" public="false">
-            <argument/>
+            <argument/> <!-- included dirs -->
             <argument type="service" id="jms_serializer.metadata_factory"/>
+            <argument/> <!-- excluded dirs -->
             <tag name="kernel.cache_warmer" />
         </service>
 

diff --git a/Resources/doc/configuration.rst b/Resources/doc/configuration.rst
@@ -145,7 +145,9 @@ values:
                         path: "@MyBarBundle/Resources/config/serializer"
                 warmup:
                     # list of directories to scan searching for php classes to use when warming up the cache
-                    directories: []
+                    paths:
+                        included: []
+                        excluded: []
 
             expression_evaluator:
                 id: jms_serializer.expression_evaluator # auto detected

diff --git a/Tests/DependencyInjection/JMSSerializerExtensionTest.php b/Tests/DependencyInjection/JMSSerializerExtensionTest.php
@@ -308,6 +308,37 @@ public function testLoadExistentMetadataDir()
         $this->assertEquals(['foo_ns' => __DIR__], $directories);
     }
 
+    public function testWarmUpWithDirs()
+    {
+        $container = $this->getContainerForConfig([[
+            'metadata' => [
+                'warmup' => [
+                    'paths' => [
+                        'included' => ['a'],
+                        'excluded' => ['b']
+                    ]
+                ]
+            ]
+        ]], function ($container){
+            $container->getDefinition('jms_serializer.cache.cache_warmer')->setPublic(true);
+        });
+
+        $this->assertTrue($container->hasDefinition('jms_serializer.cache.cache_warmer'));
+
+        $def = $container->getDefinition('jms_serializer.cache.cache_warmer');
+
+        $this->assertEquals(['a'], $def->getArgument(0));
+        $this->assertEquals(['b'], $def->getArgument(2));
+    }
+
+    public function testWarmUpWithDirsWithNoPaths()
+    {
+        $this->getContainerForConfig([[]], function ($container) {
+            $this->assertFalse($container->hasDefinition('jms_serializer.cache.cache_warmer'));
+        });
+    }
+
+
     /**
      * @expectedException \JMS\Serializer\Exception\RuntimeException
      * @expectedExceptionMessage  The metadata directory "foo_dir" does not exist for the namespace "foo_ns"