Merge branch '2.4-develop' into bugfix/issue-12584

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

@@ -0,0 +1,63 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\AwsS3\Test\Mftf\Helper;
+
+use Psr\Log\LoggerInterface;
+
+/**
+ * Mocked logger for using the AwsS3 driver in testing
+ *
+ * Ignores most log messages but throws errors on error/critical/emergency logs so tests will fail
+ */
+class MockTestLogger implements LoggerInterface {
+
+    public function emergency($message, array $context = array())
+    {
+        throw new \Exception($message);
+    }
+
+    public function alert($message, array $context = array())
+    {
+        // noop
+    }
+
+    public function critical($message, array $context = array())
+    {
+        throw new \Exception($message);
+    }
+
+    public function error($message, array $context = array())
+    {
+        throw new \Exception($message);
+    }
+
+    public function warning($message, array $context = array())
+    {
+        // noop
+    }
+
+    public function notice($message, array $context = array())
+    {
+        // noop
+    }
+
+    public function info($message, array $context = array())
+    {
+        // noop
+    }
+
+    public function debug($message, array $context = array())
+    {
+        // noop
+    }
+
+    public function log($level, $message, array $context = array())
+    {
+        // noop
+    }
+}

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

@@ -0,0 +1,180 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\AwsS3\Test\Mftf\Helper;
+
+use Aws\S3\S3Client;
+use Codeception\Lib\ModuleContainer;
+use League\Flysystem\AwsS3v3\AwsS3Adapter;
+use Magento\AwsS3\Driver\AwsS3;
+use Magento\FunctionalTestingFramework\Helper\Helper;
+use Magento\Framework\Filesystem\DriverInterface;
+
+/**
+ * Class for MFTF helpers for doing file assertions using S3.
+ */
+class S3FileAssertions extends Helper
+{
+    /**
+     * @var DriverInterface $driver
+     */
+    private $driver;
+
+    /**
+     * Call the parent constructor then create the AwsS3 driver from environment variables
+     *
+     * @param ModuleContainer $moduleContainer
+     * @param array|null $config
+     * @return void
+     */
+    public function __construct(ModuleContainer $moduleContainer, ?array $config = null)
+    {
+        parent::__construct($moduleContainer, $config);
+
+        $region = getenv('REMOTE_STORAGE_AWSS3_REGION');
+        $prefix = getenv('REMOTE_STORAGE_AWSS3_PREFIX');
+        $bucket = getenv('REMOTE_STORAGE_AWSS3_BUCKET');
+        $accessKey = getenv('REMOTE_STORAGE_AWSS3_ACCESS_KEY');
+        $secretKey = getenv('REMOTE_STORAGE_AWSS3_SECRET_KEY');
+
+        $config = [
+            'version' => 'latest',
+            'credentials' => [
+                'key' => $accessKey,
+                'secret' => $secretKey
+            ],
+            'bucket' => $bucket,
+            'region' => $region
+        ];
+
+        if (empty($config['credentials']['key']) || empty($config['credentials']['secret'])) {
+            unset($config['credentials']);
+        }
+
+        $client = new S3Client($config);
+        $adapter = new AwsS3Adapter($client, $config['bucket'], $prefix);
+        $objectUrl = $client->getObjectUrl($adapter->getBucket(), $adapter->applyPathPrefix('.'));
+        $s3Driver = new AwsS3($adapter, new MockTestLogger(), $objectUrl);
+
+        $this->driver = $s3Driver;
+    }
+
+    /**
+     * Create a file in the S3 bucket
+     *
+     * @param string $filePath
+     * @param string $text
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function createTextFile($filePath, $text): void
+    {
+        $this->driver->filePutContents($filePath, $text);
+    }
+
+    /**
+     * Delete a file from the S3 bucket if it exists
+     *
+     * @param string $filePath
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function deleteFileIfExists($filePath): void
+    {
+        if ($this->driver->isExists($filePath)) {
+            $this->driver->deleteFile($filePath);
+        }
+    }
+
+    /**
+     * Assert a file exists on the remote storage system
+     *
+     * @param string $filePath
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertFileExists($filePath, $message = ''): void
+    {
+        $this->assertTrue($this->driver->isExists($filePath), $message);
+    }
+
+    /**
+     * Assert a file does not exist on the remote storage system
+     *
+     * @param string $filePath
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertFileDoesNotExist($filePath, $message = ''): void
+    {
+        $this->assertFalse($this->driver->isExists($filePath), $message);
+    }
+
+    /**
+     * Assert a file on the remote storage system has no contents
+     *
+     * @param string $filePath
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertFileEmpty($filePath, $message = ""): void
+    {
+        $this->assertEmpty($this->driver->fileGetContents($filePath), $message);
+    }
+
+    /**
+     * Assert a file on the remote storage system is not empty
+     *
+     * @param string $filePath
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertFileNotEmpty($filePath, $message = ""): void
+    {
+        $this->assertNotEmpty($this->driver->fileGetContents($filePath), $message);
+    }
+
+    /**
+     * Assert a file on the remote storage system contains a given string
+     *
+     * @param string $filePath
+     * @param string $text
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertFileContainsString($filePath, $text, $message = ""): void
+    {
+        $this->assertStringContainsString($text, $this->driver->fileGetContents($filePath), $message);
+    }
+
+    /**
+     * Assert a file on the remote storage system does not contain a given string
+     *
+     * @param string $filePath
+     * @param string $text
+     * @param string $message
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     */
+    public function assertFileDoesNotContain($filePath, $text, $message = ""): void
+    {
+        $this->assertStringNotContainsString($text, $this->driver->fileGetContents($filePath), $message);
+    }
+}