B2B-1754: Automate MC-38938

 - Adding test for S3 sync

Author: dhaecker

app/code/Magento/AwsS3/Test/Mftf/Helper/S3FileAssertions.php

@@ -146,7 +146,7 @@ public function deleteDirectory($path): void
      */
     public function assertFileExists($filePath, $message = ''): void
     {
-        $this->assertTrue($this->driver->isExists($filePath), $message);
+        $this->assertTrue($this->driver->isExists($filePath), "Failed asserting $filePath exists. " . $message);
     }
 
     /**
@@ -158,24 +158,38 @@ public function assertFileExists($filePath, $message = ''): void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertGlobbedFileExists($path, $pattern, $message = ""): void
+    public function assertGlobbedFileExists($path, $pattern, $message = ''): void
     {
         $files = $this->driver->search($pattern, $path);
-        $this->assertNotEmpty($files, $message);
+        $this->assertNotEmpty($files, "Failed asserting file matching glob pattern \"$pattern\" at location \"$path\" is not empty. " . $message);
     }
 
     /**
-     * Assert a file does not exist on the remote storage system
+     * Asserts that a file or directory exists on the remote storage system
      *
-     * @param string $filePath
+     * @param string $path
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertPathExists($path, $message = ''): void
+    {
+        $this->assertTrue($this->driver->isExists($path), "Failed asserting $path exists. " . $message);
+    }
+
+    /**
+     * Asserts that a file or directory does not exist on the remote storage system
+     *
+     * @param string $path
      * @param string $message
      * @return void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertFileDoesNotExist($filePath, $message = ''): void
+    public function assertPathDoesNotExist($path, $message = ''): void
     {
-        $this->assertFalse($this->driver->isExists($filePath), $message);
+        $this->assertFalse($this->driver->isExists($path), "Failed asserting $path does not exist. " . $message);
     }
 
     /**
@@ -187,9 +201,9 @@ public function assertFileDoesNotExist($filePath, $message = ''): void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertFileEmpty($filePath, $message = ""): void
+    public function assertFileEmpty($filePath, $message = ''): void
     {
-        $this->assertEmpty($this->driver->fileGetContents($filePath), $message);
+        $this->assertEmpty($this->driver->fileGetContents($filePath), "Failed asserting $filePath is empty. " . $message);
     }
 
     /**
@@ -201,9 +215,9 @@ public function assertFileEmpty($filePath, $message = ""): void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertFileNotEmpty($filePath, $message = ""): void
+    public function assertFileNotEmpty($filePath, $message = ''): void
     {
-        $this->assertNotEmpty($this->driver->fileGetContents($filePath), $message);
+        $this->assertNotEmpty($this->driver->fileGetContents($filePath), "Failed asserting $filePath is empty. " . $message);
     }
 
     /**
@@ -216,9 +230,9 @@ public function assertFileNotEmpty($filePath, $message = ""): void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertFileContainsString($filePath, $text, $message = ""): void
+    public function assertFileContainsString($filePath, $text, $message = ''): void
     {
-        $this->assertStringContainsString($text, $this->driver->fileGetContents($filePath), $message);
+        $this->assertStringContainsString($text, $this->driver->fileGetContents($filePath), "Failed asserting $filePath contains $text. " . $message);
     }
 
     /**
@@ -233,10 +247,10 @@ public function assertFileContainsString($filePath, $text, $message = ""): void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertGlobbedFileContainsString($path, $pattern, $text, $fileIndex = 0, $message = ""): void
+    public function assertGlobbedFileContainsString($path, $pattern, $text, $fileIndex = 0, $message = ''): void
     {
         $files = $this->driver->search($pattern, $path);
-        $this->assertStringContainsString($text, $this->driver->fileGetContents($files[$fileIndex] ?? ''), $message);
+        $this->assertStringContainsString($text, $this->driver->fileGetContents($files[$fileIndex] ?? ''), "Failed asserting file of index \"$fileIndex\" matching glob pattern \"$pattern\" at location \"$path\" contains $text. " . $message);
     }
 
     /**
@@ -249,9 +263,9 @@ public function assertGlobbedFileContainsString($path, $pattern, $text, $fileInd
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertFileDoesNotContain($filePath, $text, $message = ""): void
+    public function assertFileDoesNotContain($filePath, $text, $message = ''): void
     {
-        $this->assertStringNotContainsString($text, $this->driver->fileGetContents($filePath), $message);
+        $this->assertStringNotContainsString($text, $this->driver->fileGetContents($filePath), "Failed asserting $filePath does not contain $text. " . $message);
     }
 
     /**
@@ -263,8 +277,22 @@ public function assertFileDoesNotContain($filePath, $text, $message = ""): void
      *
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    public function assertDirectoryEmpty($path, $message = ""): void
+    public function assertDirectoryEmpty($path, $message = ''): void
+    {
+        $this->assertEmpty($this->driver->readDirectory($path), "Failed asserting $path is empty. " . $message);
+    }
+
+    /**
+     * Asserts that a directory on the remote storage system is not empty
+     *
+     * @param string $path
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertDirectoryNotEmpty($path, $message = ''): void
     {
-        $this->assertEmpty($this->driver->readDirectory($path), $message);
+        $this->assertNotEmpty($this->driver->readDirectory($path), "Failed asserting $path is not empty. " . $message);
     }
 }