MCLOUD-6814: Improve functional tests execution speed (#281)

Author: oshmyheliuk

codeception.dist.yml

@@ -26,6 +26,7 @@ modules:
       composer_magento_password: "%REPO_PASSWORD%"
       composer_github_token: "%GITHUB_TOKEN%"
       use_generated_images: false
+      use_cached_workdir: true
       version_generated_images: "%TRAVIS_BUILD_NUMBER%"
       printOutput: false
     Magento\CloudDocker\Test\Functional\Codeception\Docker:

src/Test/Functional/Acceptance/AbstractCest.php

@@ -23,6 +23,13 @@ abstract class AbstractCest
     public function _before(\CliTester $I): void
     {
         $I->cleanupWorkDir();
+
+        if ($I->isCacheWorkDirExists(static::TEMPLATE_VERSION)) {
+            $I->restoreWorkDirFromCache(static::TEMPLATE_VERSION);
+
+            return;
+        }
+
         $I->cloneTemplateToWorkDir(static::TEMPLATE_VERSION);
         $I->createAuthJson();
         $I->createArtifactsDir();
@@ -34,6 +41,7 @@ public function _before(\CliTester $I): void
         $I->addDependencyToComposer('magento/ece-tools', 'dev-develop as 2002.1.99');
 
         $I->composerUpdate();
+        $I->cacheWorkDir(static::TEMPLATE_VERSION);
     }
 
     /**

tests/functional/Codeception/BaseModule.php

@@ -37,6 +37,11 @@ class BaseModule extends Module implements BuilderAwareInterface, ContainerAware
      */
     const WORK_DIR = '_workdir';
 
+    /**
+     * Cached work directory name
+     */
+    const WORK_DIR_CACHE = '_workdir_cache';
+
     /**
      * The artifact directory name
      */
@@ -96,6 +101,17 @@ public function getWorkDirPath(): string
         return codecept_root_dir(self::WORK_DIR);
     }
 
+    /**
+     * Returns the path to cached work directory
+     *
+     * @param string $version
+     * @return string
+     */
+    public function getCachedWorkDirPath(string $version): string
+    {
+        return codecept_root_dir(self::WORK_DIR_CACHE) . '/' . $version;
+    }
+
     /**
      * Returns the path to directory that contains artifacts
      *

tests/functional/Codeception/TestInfrastructure.php

@@ -14,6 +14,8 @@
  */
 class TestInfrastructure extends BaseModule
 {
+    private const USE_CACHED_WORKDIR_OPTION = 'use_cached_workdir';
+
     /**
      * Creates the work directory
      *
@@ -69,6 +71,57 @@ public function cleanupWorkDir(): bool
         return $this->createWorkDir();
     }
 
+    /**
+     * @param string $version
+     * @return bool
+     */
+    public function isCacheWorkDirExists(string $version): bool
+    {
+        return $this->_getConfig(self::USE_CACHED_WORKDIR_OPTION) && is_dir($this->getCachedWorkDirPath($version));
+    }
+
+    /**
+     * @param string $version
+     * @return void
+     */
+    public function cacheWorkDir(string $version): void
+    {
+        if (!$this->_getConfig(self::USE_CACHED_WORKDIR_OPTION)) {
+            return;
+        }
+
+        $this->copyDir($this->getWorkDirPath(), $this->getCachedWorkDirPath($version));
+    }
+
+    /**
+     * @param string $version
+     */
+    public function restoreWorkDirFromCache(string $version): void
+    {
+        $this->copyDir($this->getCachedWorkDirPath($version), $this->getWorkDirPath());
+    }
+
+    /**
+     * Copy directory recursively.
+     *
+     * @param string $source The path of source folder
+     * @param string $destination The path of destination folder
+     * @return void
+     */
+    public function copyDir($source, $destination): void
+    {
+        if (!is_dir(dirname($destination))) {
+            mkdir(dirname($destination));
+        }
+
+        $this->taskRsync()
+            ->arg('-l')
+            ->recursive()
+            ->fromPath($source . '/')
+            ->toPath($destination . '/')
+            ->excludeVcs()
+            ->run();
+    }
 
     /**
      * Clones cloud template to the work directory
@@ -82,7 +135,7 @@ public function cloneTemplateToWorkDir(string $branch = 'master'): bool
             ->printOutput($this->_getConfig('printOutput'))
             ->interactive(false)
             ->stopOnFail()
-            ->cloneRepo($this->_getConfig('template_repo'), '.', $branch)
+            ->cloneShallow($this->_getConfig('template_repo'), '.', $branch)
             ->dir($this->getWorkDirPath())
             ->run()
             ->wasSuccessful();