ENGCOM-3132: 12696 Delete all test modules after integration tests magento#18459

Author: p-bystritsky

dev/tests/integration/framework/bootstrap.php

@@ -5,7 +5,9 @@
  */
 use Magento\Framework\Autoload\AutoloaderRegistry;
 
+// phpcs:ignore Magento2.Security.IncludeFile
 require_once __DIR__ . '/../../../../app/bootstrap.php';
+// phpcs:ignore Magento2.Security.IncludeFile
 require_once __DIR__ . '/autoload.php';
 
 $testsBaseDir = dirname(__DIR__);
@@ -19,15 +21,16 @@
     define('INTEGRATION_TESTS_DIR', $testsBaseDir);
 }
 
-$testFrameworkDir = __DIR__;
-require_once 'deployTestModules.php';
-
 try {
     setCustomErrorHandler();
 
     /* Bootstrap the application */
     $settings = new \Magento\TestFramework\Bootstrap\Settings($testsBaseDir, get_defined_constants());
 
+    $testFrameworkDir = __DIR__;
+    // phpcs:ignore Magento2.Security.IncludeFile
+    require_once 'deployTestModules.php';
+
     if ($settings->get('TESTS_EXTRA_VERBOSE_LOG')) {
         $filesystem = new \Magento\Framework\Filesystem\Driver\File();
         $exceptionHandler = new \Magento\Framework\Logger\Handler\Exception($filesystem);
@@ -51,7 +54,7 @@
     if (!file_exists($globalConfigFile)) {
         $globalConfigFile .= '.dist';
     }
-    $sandboxUniqueId = md5(sha1_file($installConfigFile));
+    $sandboxUniqueId = hash('sha256', sha1_file($installConfigFile));
     $installDir = TESTS_TEMP_DIR . "/sandbox-{$settings->get('TESTS_PARALLEL_THREAD', 0)}-{$sandboxUniqueId}";
     $application = new \Magento\TestFramework\Application(
         $shell,
@@ -99,7 +102,9 @@
     /* Unset declared global variables to release the PHPUnit from maintaining their values between tests */
     unset($testsBaseDir, $logWriter, $settings, $shell, $application, $bootstrap);
 } catch (\Exception $e) {
+    // phpcs:ignore Magento2.Security.LanguageConstruct.DirectOutput
     echo $e . PHP_EOL;
+    // phpcs:ignore Magento2.Security.LanguageConstruct.ExitUsage
     exit(1);
 }
 

dev/tests/integration/framework/deployTestModules.php

@@ -5,7 +5,8 @@
  */
 
 /**
- * @var $testFrameworkDir string - Must be defined in parent script.
+ * @var string $testFrameworkDir - Must be defined in parent script.
+ * @var \Magento\TestFramework\Bootstrap\Settings $settings - Must be defined in parent script.
  */
 
 /** Copy test modules to app/code/Magento to make them visible for Magento instance */
@@ -36,5 +37,35 @@
     throw new \RuntimeException('glob() returned error while searching in \'' . $pathPattern . '\'');
 }
 foreach ($files as $file) {
+    // phpcs:ignore Magento2.Security.IncludeFile
     include $file;
 }
+
+if ((int)$settings->get('TESTS_PARALLEL_RUN') !== 1) {
+    // Only delete modules if we are not using parallel executions
+    register_shutdown_function(
+        'deleteTestModules',
+        $pathToCommittedTestModules,
+        $pathToInstalledMagentoInstanceModules
+    );
+}
+
+/**
+ * Delete all test module directories which have been created before
+ *
+ * @param string $pathToCommittedTestModules
+ * @param string $pathToInstalledMagentoInstanceModules
+ */
+function deleteTestModules($pathToCommittedTestModules, $pathToInstalledMagentoInstanceModules)
+{
+    $filesystem = new \Symfony\Component\Filesystem\Filesystem();
+    $iterator = new DirectoryIterator($pathToCommittedTestModules);
+    /** @var SplFileInfo $file */
+    foreach ($iterator as $file) {
+        if ($file->isDir() && !in_array($file->getFilename(), ['.', '..'])) {
+            $targetDirPath = $pathToInstalledMagentoInstanceModules . '/' . $file->getFilename();
+            $filesystem->remove($targetDirPath);
+        }
+    }
+    unset($iterator, $file);
+}

dev/tests/integration/phpunit.xml.dist

@@ -74,6 +74,7 @@
         <!--<const name="MONGODB_DATABASE_NAME" value="magento_integration_tests"/>-->
         <!-- Connection parameters for RabbitMQ tests -->
         <!--<const name="RABBITMQ_MANAGEMENT_PORT" value="15672"/>-->
+        <!--<const name="TESTS_PARALLEL_RUN" value="1"/>-->
     </php>
     <!-- Test listeners -->
     <listeners>