add aws s3 adapter (#5)

Author: shiron

README.md

@@ -37,6 +37,16 @@ Provides a set of methods for checking and modifying files on remote storage.
                             password: "password"
                             port: "22"
                             root: "/"
+                    s3:
+                        builderAdapter: \Lamoda\Codeception\Extension\AdapterFactory\AwsS3AdapterFactory
+                        config:
+                            bucket: "your-bucket"
+                            endpoint: "endpoint" # if you are using S3-compatible object storage service
+                            credentials: 
+                                key: "key"
+                                secret: "secret"
+                            region: "region"
+                            version: "version"                         
     ```
 
 3. Include to suite
@@ -97,6 +107,33 @@ Usage:
 $fileSystem = $this->tester->getFileSystem('webdav');
 ```
 
+### [AWS S3](https://flysystem.thephpleague.com/adapter/aws-s3/)
+
+Configuration example:
+
+```yaml
+modules:
+    config:
+        \Lamoda\Codeception\Extension\FlySystemModule:
+            adapters:
+                s3:
+                    builderAdapter: \Lamoda\Codeception\Extension\AdapterFactory\AwsS3AdapterFactory
+                    config:
+                        bucket: "your-bucket"
+                        endpoint: "endpoint" # if you are using S3-compatible object storage service
+                        credentials: 
+                            key: "key"
+                            secret: "secret"
+                        region: "region"
+                        version: "version" 
+```
+
+Usage:
+
+```php
+$fileSystem = $this->tester->getFileSystem('s3');
+```
+
 ## Usage
 
 Get instance of FileSystem by name from config:

composer.json

@@ -8,6 +8,7 @@
     "php": ">=7.1",
     "codeception/codeception": "~2.5",
     "oneup/flysystem-bundle": "~3.0",
+    "league/flysystem-aws-s3-v3": "~1.0",
     "league/flysystem-sftp": "~1.0",
     "league/flysystem-webdav": "~1.0"
   },

src/Extension/AdapterFactory/AwsS3AdapterFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Lamoda\Codeception\Extension\AdapterFactory;
+
+use Codeception\Exception\ModuleConfigException;
+use League\Flysystem\AdapterInterface;
+use Aws\S3\S3Client;
+use League\Flysystem\AwsS3v3\AwsS3Adapter;
+
+class AwsS3AdapterFactory implements AdapterFactoryInterface
+{
+    /**
+     * @param array $config
+     *
+     * @return AdapterInterface
+     */
+    public static function createAdapter(array $config)
+    {
+        if(!isset($config['bucket']) or !is_string($config['bucket'])) {
+            $message = sprintf('Configuration for s3 is broken. Configuration must contains bucket parameter with string type.');
+            throw new ModuleConfigException(__CLASS__, $message);
+        }
+
+        $client = new S3Client($config);
+
+        return new AwsS3Adapter($client, $config['bucket']);
+    }
+}

tests/unit/Extension/AdapterFactory/AwsS3AdapterFactoryTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Lamoda\Codeception\Tests\Extension\AdapterFactory;
+
+use Codeception\Exception\ModuleConfigException;
+use Codeception\Test\Unit;
+use Lamoda\Codeception\Extension\AdapterFactory\AwsS3AdapterFactory;
+use League\Flysystem\AwsS3v3\AwsS3Adapter;
+
+class AwsS3AdapterFactoryTest extends Unit
+{
+    public function testCreateAdapter()
+    {
+        $adapter = AwsS3AdapterFactory::createAdapter(['bucket' => 'your-bucket', 'region' => 'your-region', 'version' => 'latest']);
+        $this->assertInstanceOf(AwsS3Adapter::class, $adapter);
+    }
+
+    /**
+     * @param array $config
+     *
+     * @throws \Codeception\Exception\ModuleConfigException
+     *
+     * @dataProvider dataFailedCreateAdapter
+     */
+    public function testFailedCreateAdapter($config)
+    {
+        $expectedExceptionMessage = 'Configuration for s3 is broken. Configuration must contains bucket parameter with string type.';
+        $this->expectException(ModuleConfigException::class);
+        $this->expectExceptionMessage($expectedExceptionMessage);
+
+        AwsS3AdapterFactory::createAdapter($config);
+    }
+
+    public function dataFailedCreateAdapter()
+    {
+        return [
+            [
+                []
+            ],
+            [
+                ['bucket' => ['str']]
+            ]
+        ];
+    }
+}