OXDEV-9129 Use other var directory for testing

Author: AshrafOxid

.env.dist

@@ -5,3 +5,4 @@ OXID_DEBUG_MODE=false
 OXID_DB_URL=mysql://root:root@mysql:3306/example?charset=utf8&driverOptions[1002]="SET @@SESSION.sql_mode=\"\""
 OXID_BUILD_DIRECTORY=/var/www/var/cache/
 OXID_SHOP_BASE_URL=http://localhost.local/
+OXID_VAR_DIRECTORY=var

phpunit.xml

@@ -14,6 +14,9 @@
         displayDetailsOnTestsThatTriggerWarnings="true"
         displayDetailsOnTestsThatTriggerErrors="true"
 >
+    <php>
+        <env name="OXID_VAR_DIRECTORY" value="var-test" />
+    </php>
     <testsuites>
         <testsuite name="Unit">
             <directory>tests/Unit</directory>

source/Internal/Transition/Utility/BasicContext.php

@@ -36,7 +36,11 @@ public function getContainerCacheFilePath(int $shopId): string
 
     public function getGeneratedServicesFilePath(): string
     {
-        return Path::join($this->getShopRootPath(), 'var', 'generated', 'generated_services.yaml');
+        return Path::join(
+            $this->getVarDirectory(),
+            'generated',
+            'generated_services.yaml'
+        );
     }
 
     public function getActiveModuleServicesFilePath(int $shopId): string
@@ -86,7 +90,10 @@ public function getBackwardsCompatibilityClassMap(): array
 
     public function getProjectConfigurationDirectory(): string
     {
-        return Path::join($this->getShopRootPath(), 'var', 'configuration');
+        return Path::join(
+            $this->getVarDirectory(),
+            'configuration'
+        );
     }
 
     public function getShopConfigurationDirectory(int $shopId): string
@@ -143,4 +150,12 @@ public function getShopBaseUrl(): string
     {
         return getenv('OXID_SHOP_BASE_URL');
     }
+
+    private function getVarDirectory(): string
+    {
+        return Path::join(
+            $this->getShopRootPath(),
+            getenv('OXID_VAR_DIRECTORY') ?: 'var'
+        );
+    }
 }

tests/FilesystemTrait.php

@@ -16,30 +16,20 @@
 trait FilesystemTrait
 {
     private Filesystem $filesystem;
-    private string $varPath = '';
-    private string $varBackupPath = '';
+    private string $varTestPath = '';
 
-    public function backupVarDirectory(): void
+    public function createTestVarDirectory(): void
     {
-        $this->init();
-        $this->filesystem->mirror($this->varPath, $this->varBackupPath);
-    }
+        $shopRootPath = (new ProjectRootLocator())->getProjectRoot();
+        $this->filesystem = new Filesystem();
+        $varPath = Path::join($shopRootPath, 'var');
+        $this->varTestPath = Path::join($shopRootPath, getenv('OXID_VAR_DIRECTORY'));
 
-    public function restoreVarDirectory(): void
-    {
-        $this->filesystem->remove($this->varPath);
-        $this->filesystem->mirror($this->varBackupPath, $this->varPath);
-        $this->filesystem->remove($this->varBackupPath);
+        $this->filesystem->mirror($varPath, $this->varTestPath);
     }
 
-    private function init(): void
+    public function deleteTestVarDirectory(): void
     {
-        $shopRootPath = (new ProjectRootLocator())->getProjectRoot();
-        $this->filesystem = new Filesystem();
-        $this->varPath = Path::join($shopRootPath, 'var');
-        $this->varBackupPath = Path::join(
-            $shopRootPath,
-            uniqid('var.backup.', true)
-        );
+        $this->filesystem->remove($this->varTestPath);
     }
 }

tests/Integration/IntegrationTestCase.php

@@ -9,6 +9,8 @@
 
 namespace OxidEsales\EshopCommunity\Tests\Integration;
 
+use OxidEsales\EshopCommunity\Core\Di\ContainerFacade;
+use OxidEsales\EshopCommunity\Internal\Framework\Cache\ShopCacheCleanerInterface;
 use OxidEsales\EshopCommunity\Tests\ContainerTrait;
 use OxidEsales\EshopCommunity\Tests\DatabaseTrait;
 use OxidEsales\EshopCommunity\Tests\FilesystemTrait;
@@ -24,14 +26,12 @@ public function setUp(): void
     {
         parent::setUp();
 
-        $this->backupVarDirectory();
         $this->beginTransaction();
     }
 
     public function tearDown(): void
     {
         $this->rollBackTransaction();
-        $this->restoreVarDirectory();
 
         parent::tearDown();
     }

tests/bootstrap.php

@@ -11,6 +11,7 @@
 use OxidEsales\EshopCommunity\Core\Autoload\ModuleAutoload;
 use OxidEsales\EshopCommunity\Internal\Framework\Env\DotenvLoader;
 use OxidEsales\EshopCommunity\Internal\Framework\FileSystem\ProjectRootLocator;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Filesystem\Path;
 
 define('INSTALLATION_ROOT_PATH', (new ProjectRootLocator())->getProjectRoot());
@@ -25,3 +26,11 @@
 require_once Path::join(OX_BASE_PATH, 'overridablefunctions.php');
 
 (new DotenvLoader(INSTALLATION_ROOT_PATH))->loadEnvironmentVariables();
+
+$filesystem = new Filesystem();
+$varPath = Path::join(INSTALLATION_ROOT_PATH, 'var');
+$varTestPath = Path::join(INSTALLATION_ROOT_PATH, getenv('OXID_VAR_DIRECTORY'));
+
+$filesystem->remove($varTestPath);
+$filesystem->mirror($varPath, $varTestPath);
+$filesystem->remove(Path::join($varTestPath, 'cache'));

tests/scripts/integration.sh

@@ -43,7 +43,7 @@ function init() {
         fi
     fi
 
-    BOOTSTRAP="/var/www/source/bootstrap.php"
+    BOOTSTRAP="/var/www/tests/bootstrap.php"
     if [ ! -f "${BOOTSTRAP}" ]; then
         BOOTSTRAP="/var/www/vendor/oxid-esales/oxideshop-ce/tests/bootstrap.php"
         if [ ! -f "${BOOTSTRAP}" ]; then