B2B-2081: Stabilize general tests along with S3 specific PR validation tests

rganin · rganin · commit e1241f8a4fae · 2021-11-24T12:07:16.000-06:00
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Helper/FileAssertions.php b/app/code/Magento/AwsS3/Test/Mftf/Helper/FileAssertions.php
@@ -57,15 +57,15 @@ public function __construct(ModuleContainer $moduleContainer, ?array $config = n
     {
         parent::__construct($moduleContainer, $config);
         $this->storageType = getenv('MEDIA_STORAGE_DRIVER') ?: self::STORAGE_TYPE_LOCAL;
-        if (!empty($this->storageType) && $this->storageType === 's3') {
+        if ($this->storageType === self::STORAGE_TYPE_S3) {
             $this->helperInstance = new S3FileAssertions($moduleContainer, $config);
         } else {
             $this->helperInstance = new LocalFileAssertions($moduleContainer, $config);
         }
     }
 
     /**
-     * Create text file.
+     * Create a file in the storage.
      *
      * @param string $filePath - path to file or json structure with paths by storage type.
      * @param string $text
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Helper/FileAssertionsInterface.php b/app/code/Magento/AwsS3/Test/Mftf/Helper/FileAssertionsInterface.php
@@ -82,6 +82,7 @@ public function assertFileExists($filePath, $message = ''): void;
      * @param string $path
      * @param string $pattern
      * @param string $message
+     * @return void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportBundleProductTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportBundleProductTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportBundleProductTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <after>
             <helper class="\Magento\AwsS3\Test\Mftf\Helper\FileAssertions" method="deleteDirectory" stepKey="deleteExportFileDirectory">
                 <argument name="path">{"local":"var/export","s3":"import_export/export"}</argument>
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportDownloadableProductWithFileLinksTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportDownloadableProductWithFileLinksTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportDownloadableProductWithFileLinksTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <after>
             <helper class="\Magento\AwsS3\Test\Mftf\Helper\FileAssertions" method="deleteDirectory" stepKey="deleteExportFileDirectory">
                 <argument name="path">{"local":"var/export","s3":"import_export/export"}</argument>
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportDownloadableProductWithURLLinksTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportDownloadableProductWithURLLinksTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportDownloadableProductWithURLLinksTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <after>
             <helper class="\Magento\AwsS3\Test\Mftf\Helper\FileAssertions" method="deleteDirectory" stepKey="deleteExportFileDirectory">
                 <argument name="path">{"local":"var/export","s3":"import_export/export"}</argument>
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportFilenameTimezoneTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportFilenameTimezoneTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportFilenameTimezoneTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <!-- Verify that the file exists on remote storage -->
         <helper class="Magento\AwsS3\Test\Mftf\Helper\FileAssertions"
                 method="assertFileExists"
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportGroupedProductWithSpecialPriceTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportGroupedProductWithSpecialPriceTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportGroupedProductWithSpecialPriceTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <after>
             <helper class="\Magento\AwsS3\Test\Mftf\Helper\FileAssertions" method="deleteDirectory" stepKey="deleteExportFileDirectory">
                 <argument name="path">{"local":"var/export","s3":"import_export/export"}</argument>
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportSimpleAndConfigurableProductsWithCustomOptionsTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportSimpleAndConfigurableProductsWithCustomOptionsTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportSimpleAndConfigurableProductsWithCustomOptionsTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <after>
             <helper class="\Magento\AwsS3\Test\Mftf\Helper\FileAssertions" method="deleteDirectory" stepKey="deleteExportFileDirectory">
                 <argument name="path">{"local":"var/export","s3":"import_export/export"}</argument>
diff --git a/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportSimpleProductAndConfigurableProductsWithAssignedImagesTest.xml b/app/code/Magento/AwsS3/Test/Mftf/Test/AdminExportSimpleProductAndConfigurableProductsWithAssignedImagesTest.xml
@@ -9,6 +9,11 @@
 <tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
     <test name="AdminExportSimpleProductAndConfigurableProductsWithAssignedImagesTest">
+
+        <!-- S3 stores import/export artifacts in a different path than the local file system.
+        This test is used to merge with the local file system test and allows the resulting merged test
+        to use the correct path when Magento is either installed with S3 enabled or with S3 disabled -->
+
         <after>
             <helper class="\Magento\AwsS3\Test\Mftf\Helper\FileAssertions" method="deleteDirectory" stepKey="deleteExportFileDirectory">
                 <argument name="path">{"local":"var/export","s3":"import_export/export"}</argument>

Original file line number	Diff line number	Diff line change
`@@ -57,15 +57,15 @@ public function __construct(ModuleContainer $moduleContainer, ?array $config = n`
`57`	`57`	`{`
`58`	`58`	`parent::__construct($moduleContainer, $config);`
`59`	`59`	`$this->storageType = getenv('MEDIA_STORAGE_DRIVER') ?: self::STORAGE_TYPE_LOCAL;`
`60`		`- if (!empty($this->storageType) && $this->storageType === 's3') {`
	`60`	`+ if ($this->storageType === self::STORAGE_TYPE_S3) {`
`61`	`61`	`$this->helperInstance = new S3FileAssertions($moduleContainer, $config);`
`62`	`62`	`} else {`
`63`	`63`	`$this->helperInstance = new LocalFileAssertions($moduleContainer, $config);`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
`68`		`- * Create text file.`
	`68`	`+ * Create a file in the storage.`
`69`	`69`	`*`
`70`	`70`	`* @param string $filePath - path to file or json structure with paths by storage type.`
`71`	`71`	`* @param string $text`
Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,7 @@ public function assertFileExists($filePath, $message = ''): void;`
`82`	`82`	`* @param string $path`
`83`	`83`	`* @param string $pattern`
`84`	`84`	`* @param string $message`
	`85`	`+ * @return void`
`85`	`86`	`*`
`86`	`87`	`* @throws \Magento\Framework\Exception\FileSystemException`
`87`	`88`	`*/`