polevaultweb/s3-filesystem

Amazon S3 extension of the Codeception Filesystem module.

Maintainers

Details

github.com/polevaultweb/s3-filesystem

Homepage

Source

Issues

Installs: 38 898

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 2

Forks: 4

Open Issues: 2

1.2 2020-07-31 13:53 UTC

Requires

MIT ac2030334001a0f2fe57830c5192e29cb6082d27

s3codeceptionaws

This package is auto-updated.

Last update: 2024-12-15 13:48:52 UTC

README

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' );