indigobio/fake-s3

fake s3 that simulates an s3 object having the glacier storage class

Introduction

Fake S3 is a lightweight server that responds to the same API of Amazon S3.

It is extremely useful for testing of S3 in a sandbox environment without actually making calls to Amazon, which not only requires a network connection, but also costs money with every use.

The goal of Fake S3 is to minimize runtime dependencies and be more of a development tool to test S3 calls in your code rather than a production server looking to duplicate S3 functionality.

Many commands are supported, including put, get, list, copy, and make bucket.

Installation

gem install fakes3

Running

To run the server, you just specify a root and a port.

fakes3 -r /mnt/fakes3_root -p 4567

Licensing

As of the latest version, we are licensing with Super Source. To get a license, visit:

https://supso.org/projects/fake-s3

Depending on your company's size, the license may be free. It is also free for individuals.

Connecting to Fake S3

Take a look at the test cases to see client example usage. For now, Fake S3 is mainly tested with s3cmd, aws-s3 gem, and right_aws. There are plenty more libraries out there, and please do mention if other clients work or not.

Here is a running list of supported clients

Install test dependencies

s3cmd (not the gem)

echo "Installing S3cmd..."
wget -O- -q http://s3tools.org/repo/deb-all/stable/s3tools.key | sudo apt-key add -
sudo wget -O/etc/apt/sources.list.d/s3tools.list http://s3tools.org/repo/deb-all/stable/s3tools.list
sudo apt-get update && sudo apt-get install s3cmd
echo "Done"

python boto

sudo apt-get install python-boto

add the following line to /etc/hosts

127.0.1.1   posttest.localhost

Backdoor development REST api

This REST api is for simulating lifecycle events on the S3 objects.

List all the S3 objects with their bucket, name, location(storage class), and 'state'

GET /ADMIN_CONTROL

Move object to glacier storage class

PUT /ADMIN_CONTROL/TO_GLACIER/<full_object_name>

Move object to standard storage class

PUT /ADMIN_CONTROL/TO_STANDARD/<full_object_name>

Move object to 'restoring from glacier' status

PUT /ADMIN_CONTROL/TO_RESTORING/<full_object_name>

Move object to 'restored' status

PUT /ADMIN_CONTROL/TO_RESTORED/<full_object_name>

Move object to 'restored but restored copy is expired' status

PUT /ADMIN_CONTROL/TO_RESTORED_EXPIRED/<full_object_name>

Contributing

Contributions in the form of pull requests, bug reports, documentation, or anything else are welcome! Please read the CONTRIBUTING.md file for more info: CONTRIBUTING.md