gofakes3

by johannesboyne

johannesboyne / gofakes3

A simple fake AWS S3 object storage (used for local test-runs against AWS S3 APIs)

150 Stars 27 Forks Last release: Not found MIT License 234 Commits 1 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

CircleCI Codecov

Logo

AWS (GOFAKE)S3

AWS S3 fake server and testing library for extensive S3 test integrations. Either by running a test-server, e.g. for testing of AWS Lambda functions accessing S3. Or, to have a simple and convencience S3 mock- and test-server.

What to use it for?

We're using it for the local development of S3 dependent Lambda functions, to test AWS S3 golang implementations and access, and to test browser based direct uploads to S3 locally.

What not to use it for?

Please don't use gofakes3 as a production service. The intended use case for gofakes3 is currently to facilitate testing. It's not meant to be used for safe, persistent access to production data at the moment.

There's no reason we couldn't set that as a stretch goal at a later date, but it's a long way down the road, especially while we have so much of the API left to implement; breaking changes are inevitable.

In the meantime, there are more battle-hardened solutions for production workloads out there, some of which are listed in the "Similar Notable Projects" section below.

How to use it?

Example

// fake s3
backend := s3mem.New()
faker := gofakes3.New(backend)
ts := httptest.NewServer(faker.Server())
defer ts.Close()

// configure S3 client s3Config := &aws.Config{ Credentials: credentials.NewStaticCredentials("YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", ""), Endpoint: aws.String(ts.URL), Region: aws.String("eu-central-1"), DisableSSL: aws.Bool(true), S3ForcePathStyle: aws.Bool(true), } newSession := session.New(s3Config)

s3Client := s3.New(newSession) cparams := &s3.CreateBucketInput{ Bucket: aws.String("newbucket"), }

// Create a new bucket using the CreateBucket call. _, err := s3Client.CreateBucket(cparams) if err != nil { // Message from an error. fmt.Println(err.Error()) return }

// Upload a new object "testobject" with the string "Hello World!" to our "newbucket". _, err = s3Client.PutObject(&s3.PutObjectInput{ Body: strings.NewReader({"configuration": {"main_color": "#333"}, "screens": []}), Bucket: aws.String("newbucket"), Key: aws.String("test.txt"), })

// ... accessing of test.txt through any S3 client would now be possible

Please feel free to check it out and to provide useful feedback (using github issues), but be aware, this software is used internally and for the local development only. Thus, it has no demand for correctness, performance or security.

There are two ways to run locally: using DNS, or using S3 path mode.

S3 path mode is the most flexible and least restrictive, but it does require that you are able to modify your client code.In Go, the modification would look like so:

config := aws.Config{}
config.WithS3ForcePathStyle(true)

S3 path mode works over the network by default for all bucket names.

If you are unable to modify the code, DNS mode can be used, but it comes with further restrictions and requires you to be able to modify your local DNS resolution.

If using

localhost
as your endpoint, you will need to add the following to
/etc/hosts
for every bucket you want to fake:
127.0.0.1 .localhost

It is trickier if you want other machines to be able to use your fake S3 server as you need to be able to modify their DNS resolution as well.

Exemplary usage

Lambda Example

var AWS   = require('aws-sdk')

var ep = new AWS.Endpoint('http://localhost:9000'); var s3 = new AWS.S3({endpoint: ep});

exports.handle = function (e, ctx) { s3.createBucket({ Bucket: '', }, function(err, data) { if (err) return console.log(err, err.stack); ctx.succeed(data) }); }

Upload Example

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

Key to upload:

Tags for File: 
<input type="input" name="x-amz-meta-tag" value=""><br>
<input type="hidden" name="Policy" value="&lt;Base64-encoded policy string&gt;">
<input type="hidden" name="X-Amz-Signature" value="&lt;signature-value&gt;">
File: 
<input type="file" name="file"> <br>
<!-- The elements after this will be ignored -->
<input type="submit" name="submit" value="Upload to Amazon S3">

Similar notable projects

  • https://github.com/minio/minio not similar but powerfull ;-)
  • https://github.com/andrewgaul/s3proxy by @andrewgaul

Contributors

A big thank you to all the contributors, especially Blake @shabbyrobe who pushed this little project to the next level!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.