Merge pull request liip#484 from magnetik/cache-db

Add DisableCacheDb annotation

Author: alexislefebvre

CHANGELOG.md

@@ -8,6 +8,7 @@ This new major version introduces a number of breaking changes; see the [upgrade
  * Added `.gitattributes` to make package slimmer 
  * Applied `declare(strict_types=1)` everywhere
  * Added append fixture feature on `LoadFixtues`
+ * Added annotation `@DisableDatabaseCache` to disable database cache for a test
 
 ### Changed
  * Switched to PSR-4 dir structure with `src` and `tests` subfolders

src/Annotations/DisableDatabaseCache.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the Liip/FunctionalTestBundle
+ *
+ * (c) Baptiste Lafontaine <magnetik@magnetik.org>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Liip\FunctionalTestBundle\Annotations;
+
+/**
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+final class DisableDatabaseCache
+{
+}

src/Resources/config/database_tools.xml

@@ -43,6 +43,7 @@
         </service>
         <service id="liip_functional_test.services.database_tool_collection" class="Liip\FunctionalTestBundle\Services\DatabaseToolCollection" public="true">
             <argument type="service" id="service_container" />
+            <argument type="service" id="annotations.reader" />
             <call method="add">
                 <argument type="service" id="liip_functional_test.services_database_tools.orm_database_tool" />
             </call>

src/Services/DatabaseToolCollection.php

@@ -11,6 +11,8 @@
 
 namespace Liip\FunctionalTestBundle\Services;
 
+use Doctrine\Common\Annotations\AnnotationReader;
+use Liip\FunctionalTestBundle\Annotations\DisableDatabaseCache;
 use Liip\FunctionalTestBundle\Services\DatabaseTools\AbstractDatabaseTool;
 use Liip\FunctionalTestBundle\Test\WebTestCase;
 use Symfony\Bridge\Doctrine\ManagerRegistry;
@@ -23,14 +25,17 @@ final class DatabaseToolCollection
 {
     private $container;
 
+    private $annotationReader;
+
     /**
      * @var AbstractDatabaseTool[][]
      */
     private $items = [];
 
-    public function __construct(ContainerInterface $container)
+    public function __construct(ContainerInterface $container, AnnotationReader $annotationReader)
     {
         $this->container = $container;
+        $this->annotationReader = $annotationReader;
     }
 
     public function add(AbstractDatabaseTool $databaseTool): void
@@ -53,6 +58,27 @@ public function get($omName = null, $registryName = 'doctrine', $purgeMode = nul
         $databaseTool->setPurgeMode($purgeMode);
         $databaseTool->setWebTestCase($webTestCase);
 
+        $databaseTool->setDatabaseCacheEnabled($this->isCacheEnabled());
+
         return $databaseTool;
     }
+
+    public function isCacheEnabled(): bool
+    {
+        foreach (debug_backtrace() as $step) {
+            if ('test' === substr($step['function'], 0, 4)) { //TODO: handle tests with the @test annotation
+                $annotations = $this->annotationReader->getMethodAnnotations(
+                    new \ReflectionMethod($step['class'], $step['function'])
+                );
+
+                foreach ($annotations as $annotationClass) {
+                    if ($annotationClass instanceof DisableDatabaseCache) {
+                        return false;
+                    }
+                }
+            }
+        }
+
+        return true;
+    }
 }

src/Services/DatabaseTools/AbstractDatabaseTool.php

@@ -59,6 +59,11 @@ abstract class AbstractDatabaseTool
      */
     protected $webTestCase;
 
+    /**
+     * @var bool
+     */
+    protected $databaseCacheEnabled = true;
+
     /**
      * @var array
      */
@@ -77,6 +82,11 @@ public function setRegistry(ManagerRegistry $registry): void
         $this->registry = $registry;
     }
 
+    public function setDatabaseCacheEnabled(bool $databaseCacheEnabled): void
+    {
+        $this->databaseCacheEnabled = $databaseCacheEnabled;
+    }
+
     public function setObjectManagerName(string $omName = null): void
     {
         $this->omName = $omName;

src/Services/DatabaseTools/ORMDatabaseTool.php

@@ -97,7 +97,7 @@ public function loadFixtures(array $classNames = [], bool $append = false): Abst
 
         $backupService = $this->getBackupService();
 
-        if ($backupService) {
+        if ($backupService && $this->databaseCacheEnabled) {
             $backupService->init($this->getMetadatas(), $classNames, $append);
 
             if ($backupService->isBackupActual()) {

src/Services/DatabaseTools/ORMSqliteDatabaseTool.php

@@ -35,7 +35,7 @@ public function loadFixtures(array $classNames = [], bool $append = false): Abst
         }
 
         $backupService = $this->getBackupService();
-        if ($backupService) {
+        if ($backupService && $this->databaseCacheEnabled) {
             $backupService->init($this->getMetadatas(), $classNames);
 
             if ($backupService->isBackupActual()) {

tests/Test/WebTestCaseConfigMysqlCacheDbTest.php

@@ -13,6 +13,7 @@
 
 namespace Liip\FunctionalTestBundle\Tests\Test;
 
+use Doctrine\Common\Annotations\Annotation\IgnoreAnnotation;
 use Liip\FunctionalTestBundle\Tests\AppConfigMysqlCacheDb\AppConfigMysqlKernelCacheDb;
 
 /**
@@ -31,6 +32,7 @@
  *
  * @runTestsInSeparateProcesses
  * @preserveGlobalState disabled
+ * @IgnoreAnnotation("group")
  */
 class WebTestCaseConfigMysqlCacheDbTest extends WebTestCaseConfigMysqlTest
 {

tests/Test/WebTestCaseConfigMysqlTest.php

@@ -13,6 +13,7 @@
 
 namespace Liip\FunctionalTestBundle\Tests\Test;
 
+use Doctrine\Common\Annotations\Annotation\IgnoreAnnotation;
 use Doctrine\Common\DataFixtures\Purger\ORMPurger;
 use Liip\FunctionalTestBundle\Test\WebTestCase;
 use Liip\FunctionalTestBundle\Tests\AppConfigMysql\AppConfigMysqlKernel;
@@ -33,6 +34,7 @@
  *
  * @runTestsInSeparateProcesses
  * @preserveGlobalState disabled
+ * @IgnoreAnnotation("group")
  */
 class WebTestCaseConfigMysqlTest extends WebTestCase
 {

tests/Test/WebTestCaseConfigTest.php

@@ -13,6 +13,8 @@
 
 namespace Liip\FunctionalTestBundle\Tests\Test;
 
+use Doctrine\Common\Annotations\Annotation\IgnoreAnnotation;
+use Liip\FunctionalTestBundle\Annotations\DisableDatabaseCache;
 use Liip\FunctionalTestBundle\Annotations\QueryCount;
 use Liip\FunctionalTestBundle\Test\WebTestCase;
 use Liip\FunctionalTestBundle\Tests\AppConfig\AppConfigKernel;
@@ -246,6 +248,42 @@ public function testLoadFixturesFilesWithCustomProvider(): void
         );
     }
 
+    /**
+     * @DisableDatabaseCache()
+     */
+    public function testCacheCanBeDisabled(): void
+    {
+        // MD5 hash corresponding to these fixtures files.
+        $md5 = '0ded9d8daaeaeca1056b18b9d0d433b2';
+        $databaseFilePath = $this->getContainer()->getParameter('kernel.cache_dir').'/test_sqlite_'.$md5.'.db';
+
+        $fixtures = [
+            'Liip\FunctionalTestBundle\Tests\App\DataFixtures\ORM\LoadDependentUserData',
+        ];
+
+        $this->loadFixtures($fixtures);
+
+        // Load data from database
+        $em = $this->getContainer()->get('doctrine.orm.entity_manager');
+
+        /** @var \Liip\FunctionalTestBundle\Tests\App\Entity\User $user1 */
+        $user1 = $em->getRepository('LiipFunctionalTestBundle:User')->findOneBy(['id' => 1]);
+
+        // Store random data, in order to check it after reloading fixtures.
+        $user1Salt = $user1->getSalt();
+
+        sleep(2);
+
+        // Reload the fixtures.
+        $this->loadFixtures($fixtures);
+
+        /** @var \Liip\FunctionalTestBundle\Tests\App\Entity\User $user1 */
+        $user1 = $em->getRepository('LiipFunctionalTestBundle:User')->findOneBy(['id' => 1]);
+
+        //The salt are not the same because cache were not used
+        $this->assertNotSame($user1Salt, $user1->getSalt());
+    }
+
     /**
      * Update a fixture file and check that the cache will be refreshed.
      */