Initial commit

Author: Dorozhkin Anton Vyacheslavovich

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+/composer.lock
+/.php_cs.cache

.php_cs

@@ -0,0 +1,15 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('vendor')
+    ->in(__DIR__);
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@Symfony' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'phpdoc_align' => false,
+        'phpdoc_to_comment' => false,
+        'header_comment' => false,
+    ])
+    ->setFinder($finder);

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 Lamoda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,7 @@
+WORKING_DIR=$(CURDIR)
+
+php-cs-check:
+	$(WORKING_DIR)/vendor/bin/php-cs-fixer fix --dry-run --format=junit --diff
+
+php-cs-fix:
+	$(WORKING_DIR)/vendor/bin/php-cs-fixer fix

README.md

@@ -0,0 +1,135 @@
+# Codeception FlySystem Extension
+
+This extension supports working with [FlySystem](https://flysystem.thephpleague.com/) with several adapters.
+
+Provides a set of methods for checking and modifying files on remote storage.
+
+## Installation
+
+1. Install library
+    ```bash
+    composer require lamoda/codeception-flysystem
+    ```
+
+2. Add configuration to codeception.yml
+    ```yaml
+    modules:
+        config:
+            \Lamoda\Codeception\Extension\FlySystemModule:
+                adapters:
+                    webdav:
+                        builderAdapter: \Lamoda\Codeception\Extension\AdapterBuilder\WebdavAdapterBuilder
+                        config:
+                            baseUri: "http://webdav-host"
+                            userName: "userName"
+                            password: "password"
+                            authType: "authType"
+                    sftp:
+                        builderAdapter: \Lamoda\Codeception\Extension\AdapterBuilder\SftpAdapterBuilder
+                        config:
+                            host: "http://sftp-host"
+                            username: "username"
+                            password: "password"
+                            port: "22"
+                            root: "/"
+    ```
+
+3. Include to suite
+    ```yaml
+    modules:
+        enabled:
+            - \Lamoda\Codeception\Extension\FlySystemModule
+    ```
+
+## Supported adapters
+
+### [sftp](https://flysystem.thephpleague.com/adapter/sftp/)
+
+Configuration example:
+
+```yaml
+modules:
+    config:
+        \Lamoda\Codeception\Extension\FlySystemModule:
+            adapters:
+                sftp:
+                    builderAdapter: \Lamoda\Codeception\Extension\AdapterBuilder\SftpAdapterBuilder
+                    config:
+                        host: "http://sftp-host"
+                        username: "username"
+                        password: "password"
+                        port: "22"
+                        root: "/"
+```
+
+Usage:
+
+```php
+$fileSystem = $this->tester->getFileSystem('sftp');
+```
+
+### [webdav](https://flysystem.thephpleague.com/adapter/webdav/)
+
+Configuration example:
+
+```yaml
+modules:
+    config:
+        \Lamoda\Codeception\Extension\FlySystemModule:
+            adapters:
+                webdav:
+                    builderAdapter: \Lamoda\Codeception\Extension\AdapterBuilder\WebdavAdapterBuilder
+                    config:
+                        baseUri: "http://webdav-host"
+                        userName: "userName"
+                        password: "password"
+                        authType: "authType"
+```
+
+Usage:
+
+```php
+$fileSystem = $this->tester->getFileSystem('webdav');
+```
+
+## Usage
+
+Get instance of FileSystem by name from config:
+
+```php
+$fileSystem = $this->tester->getFileSystem('sftp');
+```
+
+Modify file on remote server:
+
+```php
+$fileSystem->clearDir('/path/to/dir');
+$fileSystem->writeFile('test.txt', 'Hello world!');
+$fileSystem->copyFile('test.txt', 'test_copy.txt');
+$fileSystem->deleteFile('test.txt');
+
+$files = $fileSystem->grabFileList('/path/to/dir');
+```
+
+Check files on remote server:
+
+```php
+$fileSystem->canSeeFile('test_copy.txt');
+$fileSystem->cantSeeFile('test.txt');
+
+$fileSystem->seeInFile('test_copy.txt', 'Hello');
+
+$fileSystem->seeFilesCount('/path/to/dir', 1);
+
+$fileSystem->seeFileFoundMatches('/copy$/', '/path/to/dir');
+$fileSystem->dontSeeFileFoundMatches('/test$/', '/path/to/dir');
+```
+
+## Development
+
+### PHP Coding Standards Fixer
+
+```bash
+make php-cs-check
+make php-cs-fix
+```

composer.json

@@ -0,0 +1,22 @@
+{
+  "name": "lamoda/codeception-flysystem",
+  "description": "Remote files checker for codeception tests",
+  "type": "library",
+  "license": "MIT",
+  "minimum-stability": "stable",
+  "require": {
+    "php": ">=5.6",
+    "codeception/codeception": "~2.3.0",
+    "oneup/flysystem-bundle": "~1.7.0",
+    "league/flysystem-sftp": "~1.0.0",
+    "league/flysystem-webdav": "~1.0.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "Lamoda\\Codeception\\Extension\\": "src/Extension/"
+    }
+  },
+  "require-dev": {
+    "friendsofphp/php-cs-fixer": "^2.13"
+  }
+}

src/Extension/AdapterFactory/AdapterFactoryInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Lamoda\Codeception\Extension\AdapterFactory;
+
+use League\Flysystem\AdapterInterface;
+
+interface AdapterFactoryInterface
+{
+    /**
+     * @param array $config
+     *
+     * @return AdapterInterface
+     */
+    public static function createAdapter(array $config);
+}

src/Extension/AdapterFactory/SftpAdapterFactory.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Lamoda\Codeception\Extension\AdapterFactory;
+
+use League\Flysystem\AdapterInterface;
+use League\Flysystem\Sftp\SftpAdapter;
+
+class SftpAdapterFactory implements AdapterFactoryInterface
+{
+    /**
+     * @param array $config
+     *
+     * @return AdapterInterface
+     */
+    public static function createAdapter(array $config)
+    {
+        return new SftpAdapter($config);
+    }
+}

src/Extension/AdapterFactory/WebdavAdapterFactory.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Lamoda\Codeception\Extension\AdapterFactory;
+
+use League\Flysystem\AdapterInterface;
+use League\Flysystem\WebDAV\WebDAVAdapter;
+use Sabre\DAV\Client;
+
+class WebdavAdapterFactory implements AdapterFactoryInterface
+{
+    /**
+     * @param array $config
+     *
+     * @return AdapterInterface
+     */
+    public static function createAdapter(array $config)
+    {
+        $client = new Client($config);
+
+        return new WebDAVAdapter($client);
+    }
+}