forked from johannesboyne/gofakes3
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7c0cbc1
commit c68b81a
Showing
19 changed files
with
37 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,202 +1,3 @@ | ||
[![CircleCI](https://circleci.com/gh/johannesboyne/gofakes3.svg?style=svg)](https://circleci.com/gh/johannesboyne/gofakes3) | ||
[![Codecov](https://codecov.io/gh/johannesboyne/gofakes3/branch/master/graph/badge.svg)](https://codecov.io/gh/johannesboyne/gofakes3) | ||
|
||
![Logo](/GoFakeS3.png) | ||
# 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 (aws-sdk-go version 1) | ||
|
||
```golang | ||
// 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 | ||
``` | ||
|
||
### Example for V2 (aws-sdk-go-v2) | ||
|
||
```golang | ||
backend := s3mem.New() | ||
faker := gofakes3.New(backend) | ||
ts := httptest.NewServer(faker.Server()) | ||
defer ts.Close() | ||
|
||
// Difference in configuring the client | ||
|
||
// Setup a new config | ||
cfg, _ := config.LoadDefaultConfig( | ||
context.TODO(), | ||
config.WithCredentialsProvider(credentials.NewStaticCredentialsProvider("KEY", "SECRET", "SESSION")), | ||
config.WithHTTPClient(&http.Client{ | ||
Transport: &http.Transport{ | ||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, | ||
}, | ||
}), | ||
config.WithEndpointResolverWithOptions( | ||
aws.EndpointResolverWithOptionsFunc(func(_, _ string, _ ...interface{}) (aws.Endpoint, error) { | ||
return aws.Endpoint{URL: ts.URL}, nil | ||
}), | ||
), | ||
) | ||
|
||
// Create an Amazon S3 v2 client, important to use o.UsePathStyle | ||
// alternatively change local DNS settings, e.g., in /etc/hosts | ||
// to support requests to http://<bucketname>.127.0.0.1:32947/... | ||
client := s3.NewFromConfig(cfg, func(o *s3.Options) { | ||
o.UsePathStyle = true | ||
}) | ||
|
||
``` | ||
|
||
|
||
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 <bucket-name>.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 | ||
|
||
```javascript | ||
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: '<bucket-name>', | ||
}, function(err, data) { | ||
if (err) return console.log(err, err.stack); | ||
ctx.succeed(data) | ||
}); | ||
} | ||
``` | ||
|
||
### Upload Example | ||
|
||
```html | ||
<html> | ||
<head> | ||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | ||
</head> | ||
<body> | ||
|
||
<form action="http://localhost:9000/<bucket-name>/" method="post" enctype="multipart/form-data"> | ||
Key to upload: | ||
<input type="input" name="key" value="user/user1/test/<filename>" /><br /> | ||
<input type="hidden" name="acl" value="public-read" /> | ||
<input type="hidden" name="x-amz-meta-uuid" value="14365123651274" /> | ||
<input type="hidden" name="x-amz-server-side-encryption" value="AES256" /> | ||
<input type="text" name="X-Amz-Credential" value="AKIAIOSFODNN7EXAMPLE/20151229/us-east-1/s3/aws4_request" /> | ||
<input type="text" name="X-Amz-Algorithm" value="AWS4-HMAC-SHA256" /> | ||
<input type="text" name="X-Amz-Date" value="20151229T000000Z" /> | ||
|
||
Tags for File: | ||
<input type="input" name="x-amz-meta-tag" value="" /><br /> | ||
<input type="hidden" name="Policy" value='<Base64-encoded policy string>' /> | ||
<input type="hidden" name="X-Amz-Signature" value="<signature-value>" /> | ||
File: | ||
<input type="file" name="file" /> <br /> | ||
<!-- The elements after this will be ignored --> | ||
<input type="submit" name="submit" value="Upload to Amazon S3" /> | ||
</form> | ||
</html> | ||
``` | ||
|
||
## 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](https://github.com/johannesboyne/gofakes3/graphs/contributors), | ||
especially [Blake @shabbyrobe](https://github.com/shabbyrobe) who pushed this | ||
little project to the next level! | ||
|
||
**Help wanted** | ||
This is a fork of [GoFakeS3](https://github.com/SiaFoundation/gofakes3) by [johannesboyne](https://github.com/johannesboyne) used to make [renterd](https://github.com/SiaFoundation/renterd) S3 compatible. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.