An Amazon S3 Filesystem module for Codeception
PHP
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/Codeception/Module
.gitignore
README.md
autoload.php
composer.json

README.md

s3-filesystem

An Amazon S3 Filesystem module for Codeception.

Installation

To install simply require the package in the composer.json file like

  "require-dev":
    {
      "polevaultweb/s3-filesystem": "master@dev"
    }

and then use composer update to fetch the package.
After that follow the configuration instructions below.

S3Filesystem configuration

S3Filesystem extends Filesystem module hence any parameter required and available to that module is required and available in S3Filesystem as well.
In the suite .yml configuration file add the module among the loaded ones:

  modules:
      enabled:
          - S3Filesystem
      config:
          S3Filesystem:
              accessKey: xxxxxxxxxxxx
              accessSecret: xxxxxxxxxxxxxxxxxxxxxxxx

Supports

  • doesFileExist
  • doesBucketExist
  • deleteBucket
  • getBucketLocation

And assertions

  • seeFile
  • seeBucket
  • seeBucketLocation

Usage

$I = new AcceptanceTester( $scenario );

$I->setBucket( 'my-bucket' );
$I->seeFile( 'path/to/file.jpg' );
$I->seeBucketLocation( 'eu-west-1' );

Or for single uses you can chain like so:

$I = new AcceptanceTester( $scenario );

$I->setBucket( 'my-bucket' )->seeFile( 'path/to/file.jpg' );