Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for listObjectsV2 #45

Merged
merged 1 commit into from
Aug 11, 2017
Merged

Add support for listObjectsV2 #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This is a very simple interface that mocks the AWS SDK for Node.js. The implemen
Available:
- createBucket
- listObjects
- listObjectsV2
- deleteObjects
- deleteObject
- getObject
Expand Down
16 changes: 16 additions & 0 deletions lib/mock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,22 @@ function S3Mock(options) {
S3Mock.prototype = {
objectMetadataDictionary : [],

listObjectsV2: function (searchV2, callback) {
var searchV1 = _(searchV2).clone()
// Marker in V1 is StartAfter in V2
// ContinuationToken trumps marker on subsequent requests.
searchV1.Marker = searchV2.ContinuationToken || searchV2.StartAfter
this.listObjects(searchV1, function (err, resultV1) {
var resultV2 = _(resultV1).clone()
// Rewrite NextMarker to NextContinuationToken
resultV2.NextContinuationToken = resultV1.NextMarker
// Remember original ContinuationToken and StartAfter
resultV2.ContinuationToken = searchV2.ContinuationToken
resultV2.StartAfter = searchV2.StartAfter
callback(err, resultV2)
})
},

listObjects: function (search, callback) {

search = _.extend({}, this.defaultOptions, applyBasePath(search));
Expand Down
197 changes: 196 additions & 1 deletion test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ var fs = require('fs');
describe('S3', function () {

var s3 = AWS.S3();
var marker = null;
var marker = null; // for listObjects
var continuationToken = null; // for listObjectsV2

// createBucket tests
it('should create a bucket with valid arguments', function(done)
Expand Down Expand Up @@ -250,6 +251,200 @@ describe('S3', function () {
});
});

// listV2
it('should list files in bucket with less than 1000 objects and use Prefix to filter (listV2)', function (done) {

s3.listObjectsV2({Prefix: 'sea/', Bucket: __dirname + '/local/otters'}, function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(560);
expect(data.Contents[1].ETag).to.exist;
expect(data.Contents[1].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[1].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(1);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('sea/');
expect(data.IsTruncated).to.equal(false);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.not.exist;
expect(data.NextContinuationToken).to.not.exist;
done();
});
});

it('should limit number of files returned to MaxKeys (listV2)', function (done) {

s3.listObjectsV2({Prefix: 'sea/', Bucket: __dirname + '/local/otters', MaxKeys: 55 }, function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(55);
expect(data.IsTruncated).to.equal(true);
done();
});
});

it('should list files in bucket with less than 1000 objects and use Prefix to filter - 2 (listV2)', function (done) {

s3.listObjectsV2({Prefix: 'river/', Bucket: __dirname + '/local/otters'}, function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(912);
expect(data.Contents[1].ETag).to.exist;
expect(data.Contents[1].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[1].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(1);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('river/');
expect(data.IsTruncated).to.equal(false);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.not.exist;
expect(data.NextContinuationToken).to.not.exist;
done();
});
});

it('should list files in bucket with more than 1000 objects and use Prefix to filter - 3 (listV2)', function (done) {

s3.listObjectsV2({Prefix: 'mix/', Bucket: __dirname + '/local/otters', Delimiter:'/'},
function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(1000);
expect(data.Contents[1].ETag).to.exist;
expect(data.Contents[1].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[1].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(1);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('mix/');
expect(data.IsTruncated).to.equal(true);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.not.exist;
expect(data.NextContinuationToken).to.exist;
done();
});
});

it('should list files starting a marker with a partial filename (listV2)', function (done) {

s3.listObjectsV2({Prefix: '', Bucket: __dirname + '/local/otters', StartAfter: 'mix/yay copy 10',
Delimiter:'/' }, function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(1000);
expect(data.Contents[0].ETag).to.exist;
expect(data.Contents[0].Key).to.equal('mix/yay copy 10.txt');
expect(data.Contents[0].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.CommonPrefixes.length).to.equal(1);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('mix/');
expect(data.IsTruncated).to.equal(true);
expect(data.StartAfter).to.exist;
expect(data.ContinuationToken).to.not.exist;
expect(data.NextContinuationToken).to.exist;
done();
});
});

it('should list all files in bucket (more than 1000) (listV2)', function (done) {

s3.listObjectsV2({Prefix: '', Bucket: __dirname + '/local/otters', Delimiter:'/'}, function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(1000);
expect(data.Contents[1].ETag).to.exist;
expect(data.Contents[1].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[1].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(2);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('/');
expect(data.CommonPrefixes[1].Prefix).to.exist;
expect(data.CommonPrefixes[1].Prefix).to.equal('mix/');
expect(data.IsTruncated).to.equal(true);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.not.exist;
expect(data.NextContinuationToken).to.exist;

continuationToken = data.NextContinuationToken;

done();
});
});

it('should list more files in bucket (more than 1000) with continuationToken (listV2)', function (done) {

s3.listObjectsV2({Prefix: '', ContinuationToken: continuationToken, Bucket: __dirname + '/local/otters', Delimiter:'/'},
function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(1000);
expect(data.Contents[0].ETag).to.exist;
expect(data.Contents[0].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[0].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(2);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('mix/');
expect(data.CommonPrefixes[1].Prefix).to.exist;
expect(data.CommonPrefixes[1].Prefix).to.equal('river/');
expect(data.IsTruncated).to.equal(true);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.exist;
expect(data.NextContinuationToken).to.exist;

continuationToken = data.NextContinuationToken;

done();
});
});

it('should list more files in bucket (more than 1000) with marker - 2 (listV2)', function (done) {

s3.listObjectsV2({Prefix: '', ContinuationToken: continuationToken, Bucket: __dirname + '/local/otters', Delimiter:'/'},
function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(945);
expect(data.Contents[0].ETag).to.exist;
expect(data.Contents[0].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[0].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(2);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('river/');
expect(data.CommonPrefixes[1].Prefix).to.exist;
expect(data.CommonPrefixes[1].Prefix).to.equal('sea/');
expect(data.IsTruncated).to.equal(false);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.exist;
expect(data.NextContinuationToken).to.not.exist;

continuationToken = data.NextContinuationToken;

done();
});
});

it('should list all files in bucket (more than 1000) with no Prefix specified (listV2)', function (done) {

s3.listObjectsV2({Bucket: __dirname + '/local/otters'}, function (err, data) {

expect(err).to.equal(null);
expect(data.Contents.length).to.equal(1000);
expect(data.Contents[1].ETag).to.exist;
expect(data.Contents[1].ETag).to.equal('"d41d8cd98f00b204e9800998ecf8427e"');
expect(data.Contents[1].Key).to.exist;
expect(data.CommonPrefixes.length).to.equal(2);
expect(data.CommonPrefixes[0].Prefix).to.exist;
expect(data.CommonPrefixes[0].Prefix).to.equal('/');
expect(data.CommonPrefixes[1].Prefix).to.exist;
expect(data.CommonPrefixes[1].Prefix).to.equal('mix/');
expect(data.IsTruncated).to.equal(true);
expect(data.StartAfter).to.not.exist;
expect(data.ContinuationToken).to.not.exist;
expect(data.NextContinuationToken).to.not.exist; // only returned with delimter

done();
});
});

it('should delete the specified file', function (done) {

expect(fs.existsSync(__dirname + '/local/otters/sea/yo copy.txt')).to.equal(true);
Expand Down