Skip to content

Commit e151aee

Browse files
trivikrtrivikr
authored
feat(cucumber): use waiters in integration tests (#1792)
1 parent 4f9e56f commit e151aee

File tree

5 files changed

+78
-158
lines changed

5 files changed

+78
-158
lines changed

Diff for: ‎features/dynamodb/step_definitions/dynamodb.js

+23-60
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,28 @@
11
const jmespath = require("jmespath");
2-
const { DynamoDB } = require("../../../clients/client-dynamodb");
2+
const { DynamoDB, waitForTableExists, waitForTableNotExists } = require("../../../clients/client-dynamodb");
33

4-
/**
5-
* Waits for the tableExists state by periodically calling the underlying
6-
* DynamoDB.describeTable() operation every 5 seconds (at most 25 times).
7-
*/
8-
function waitForTableExists(world, callback) {
9-
const params = {
10-
TableName: world.tableName,
11-
};
12-
13-
const maxAttempts = 25;
14-
const delay = 5000;
15-
let currentAttempt = 0;
16-
17-
const checkForTableExists = () => {
18-
currentAttempt++;
19-
world.service.describeTable(params, function (err, data) {
20-
if (currentAttempt > maxAttempts) {
21-
callback(new Error("waitForTableExists: max attempts exceeded"));
22-
} else if (data && data.Table && data.Table.TableStatus === "ACTIVE") {
23-
callback();
24-
} else {
25-
setTimeout(function () {
26-
checkForTableExists();
27-
}, delay);
28-
}
29-
});
30-
};
31-
checkForTableExists();
4+
function waitForTableExistsCallback(world, callback) {
5+
waitForTableExists({ client: world.service }, { TableName: world.tableName }).then(
6+
function (data) {
7+
callback();
8+
},
9+
function (err) {
10+
callback(err);
11+
}
12+
);
3213
}
3314

34-
/**
35-
* Waits for the tableNotExists state by periodically calling the underlying
36-
* DynamoDB.describeTable() operation every 5 seconds (at most 25 times).
37-
*/
38-
function waitForTableNotExists(world, callback) {
39-
const params = {
40-
TableName: world.tableName,
41-
};
42-
43-
const maxAttempts = 25;
44-
const delay = 5000;
45-
let currentAttempt = 0;
46-
47-
const checkForTableNotExists = () => {
48-
currentAttempt++;
49-
world.service.describeTable(params, function (err, data) {
50-
if (currentAttempt > maxAttempts) {
51-
callback(new Error("waitForTableNotExists: max attempts exceeded"));
52-
} else if (err && err.name === "ResourceNotFoundException") {
53-
callback();
54-
} else {
55-
setTimeout(function () {
56-
checkForTableNotExists();
57-
}, delay);
58-
}
59-
});
60-
};
61-
checkForTableNotExists();
15+
function waitForTableNotExistsWithCallback(world, callback) {
16+
waitForTableNotExists({ client: world.service }, { TableName: world.tableName }).then(
17+
function (data) {
18+
callback();
19+
},
20+
function (err) {
21+
callback(err);
22+
}
23+
);
6224
}
25+
6326
const { Before, Given, Then, When } = require("cucumber");
6427

6528
Before({ tags: "@dynamodb" }, function (scenario, next) {
@@ -82,7 +45,7 @@ function createTable(world, callback) {
8245
callback(err);
8346
return;
8447
}
85-
waitForTableExists(world, callback);
48+
waitForTableExistsCallback(world, callback);
8649
});
8750
}
8851

@@ -154,11 +117,11 @@ When("I delete the table", function (next) {
154117
});
155118

156119
Then("the table should eventually exist", function (callback) {
157-
waitForTableExists(this, callback);
120+
waitForTableExistsCallback(this, callback);
158121
});
159122

160123
Then("the table should eventually not exist", function (callback) {
161-
waitForTableNotExists(this, callback);
124+
waitForTableNotExistsWithCallback(this, callback);
162125
});
163126

164127
Given("my first request is corrupted with CRC checking (ON|OFF)", function (toggle, callback) {

Diff for: ‎features/ec2/step_definitions/ec2.js

+11-34
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,15 @@
1-
const { EC2 } = require("../../../clients/client-ec2");
1+
const { EC2, waitForVolumeAvailable } = require("../../../clients/client-ec2");
22
const { Before, Given, Then } = require("cucumber");
33

4-
/**
5-
* Waits for the volumeAvailable state by periodically calling the underlying
6-
* EC2.describeVolumes() operation every 5 seconds (at most 40 times)
7-
*/
8-
const waitForVolumeAvailable = (ec2, volumeId, callback) => {
9-
const maxAttempts = 40;
10-
let currentAttempt = 0;
11-
const delay = 5000;
12-
13-
const checkForVolumeAvailable = () => {
14-
currentAttempt++;
15-
ec2.describeVolumes({ VolumeIds: [volumeId] }, (err, data) => {
16-
if (currentAttempt > maxAttempts) {
17-
callback(new Error("waitForVolumeAvailable: max attempts exceeded"));
18-
} else if (data && data.Volumes) {
19-
if (data.Volumes[0].State === "available") {
20-
callback();
21-
} else if (data.Volumes[0].State === "deleted") {
22-
callback(new Error(`VolumeId ${data.Volumes[i].VolumeId} is in failure state`));
23-
} else {
24-
setTimeout(function () {
25-
checkForVolumeAvailable();
26-
}, delay);
27-
}
28-
} else {
29-
setTimeout(function () {
30-
checkForVolumeAvailable();
31-
}, delay);
32-
}
33-
});
34-
};
35-
checkForVolumeAvailable();
4+
const waitForVolumeAvailableCallback = (ec2, volumeId, callback) => {
5+
waitForVolumeAvailable({ client: ec2 }, { VolumeIds: [volumeId] }).then(
6+
function (data) {
7+
callback();
8+
},
9+
function (err) {
10+
callback(err);
11+
}
12+
);
3613
};
3714

3815
Before({ tags: "@ec2" }, function (scenario, callback) {
@@ -82,7 +59,7 @@ Given("I attempt to copy an encrypted snapshot across regions", function (callba
8259
}
8360
volId = data.VolumeId;
8461

85-
waitForVolumeAvailable(srcEc2, volId, function (err) {
62+
waitForVolumeAvailableCallback(srcEc2, volId, function (err) {
8663
if (err) {
8764
teardown();
8865
return callback(err);

Diff for: ‎features/extra/helpers.js

+21-46
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
const {
2+
waitForBucketExists: bucketExists,
3+
waitForBucketNotExists: bucketNotExists,
4+
} = require("../../clients/client-s3");
5+
16
module.exports = {
27
assert: require("./assertions").assert,
38

@@ -189,55 +194,25 @@ module.exports = {
189194
return buffer;
190195
},
191196

192-
/**
193-
* Waits for the bucketExists state by periodically calling the underlying S3.headBucket() operation
194-
* every 5 seconds (at most 20 times).
195-
*/
196197
waitForBucketExists: function (s3client, params, callback) {
197-
const maxAttempts = 20;
198-
let currentAttempt = 0;
199-
const delay = 5000;
200-
201-
const checkForBucketExists = () => {
202-
currentAttempt++;
203-
s3client.headBucket(params, function (err, data) {
204-
if (currentAttempt > maxAttempts) {
205-
callback(new Error("waitForBucketExists: max attempts exceeded"));
206-
} else if (data) {
207-
callback();
208-
} else {
209-
setTimeout(function () {
210-
checkForBucketExists();
211-
}, delay);
212-
}
213-
});
214-
};
215-
checkForBucketExists();
198+
bucketExists({ client: s3client }, params).then(
199+
function (data) {
200+
callback();
201+
},
202+
function (err) {
203+
callback(err);
204+
}
205+
);
216206
},
217207

218-
/**
219-
* Waits for the bucketNotExists state by periodically calling the underlying S3.headBucket() operation
220-
* every 5 seconds (at most 20 times).
221-
*/
222208
waitForBucketNotExists: function (s3client, params, callback) {
223-
const maxAttempts = 20;
224-
let currentAttempt = 0;
225-
const delay = 5000;
226-
227-
const checkForBucketNotExists = () => {
228-
currentAttempt++;
229-
s3client.headBucket(params, function (err, data) {
230-
if (currentAttempt > maxAttempts) {
231-
callback(new Error("waitForBucketNotExists: max attempts exceeded"));
232-
} else if (err && err.name === "NotFound") {
233-
callback();
234-
} else {
235-
setTimeout(function () {
236-
checkForBucketNotExists();
237-
}, delay);
238-
}
239-
});
240-
};
241-
checkForBucketNotExists();
209+
bucketNotExists({ client: s3client }, params).then(
210+
function (data) {
211+
callback();
212+
},
213+
function (err) {
214+
callback(err);
215+
}
216+
);
242217
},
243218
};

Diff for: ‎features/s3/buckets.feature

+12-11
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Feature: Working with Buckets
4747

4848
Scenario: Access bucket following 307 redirects
4949
Given I am using the S3 "us-east-1" region with signatureVersion "s3"
50-
When I create a bucket with the location constraint "EU"
51-
Then the bucket should exist
52-
Then the bucket should have a location constraint of "EU"
53-
Then I delete the bucket
50+
When I create a bucket with the location constraint "eu-west-1"
51+
Then the bucket should exist in region "eu-west-1"
52+
Then the bucket should have a location constraint of "eu-west-1"
53+
Then I delete the bucket in region "eu-west-1"
5454

5555
Scenario: Working with bucket names that contain '.'
5656
When I create a bucket with a DNS compatible name that contains a dot
@@ -69,10 +69,11 @@ Feature: Working with Buckets
6969
Then I delete the object "hello" from the bucket
7070
Then I delete the bucket
7171

72-
Scenario: Follow 307 redirect on new buckets
73-
Given I am using the S3 "us-east-1" region with signatureVersion "s3"
74-
When I create a bucket with the location constraint "us-west-2"
75-
And I put a large buffer to the key "largeobject" in the bucket
76-
Then the object "largeobject" should exist in the bucket
77-
Then I delete the object "largeobject" from the bucket
78-
Then I delete the bucket
72+
# Known bug: https://github.com/aws/aws-sdk-js-v3/issues/1802
73+
# Scenario: Follow 307 redirect on new buckets
74+
# Given I am using the S3 "us-east-1" region with signatureVersion "s3"
75+
# When I create a bucket with the location constraint "us-west-2"
76+
# And I put a large buffer to the key "largeobject" in the bucket
77+
# Then the object "largeobject" should exist in the bucket
78+
# Then I delete the object "largeobject" from the bucket
79+
# Then I delete the bucket

Diff for: ‎features/s3/step_definitions/buckets.js

+11-7
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,15 @@ When("I create a bucket with the location constraint {string}", function (locati
3131
if (err) {
3232
return callback(err);
3333
}
34-
this.waitForBucketExists(
35-
this.s3,
36-
{
37-
Bucket: bucket,
38-
},
39-
callback
40-
);
34+
callback();
4135
});
4236
});
4337

38+
Then("the bucket should exist in region {string}", function (location, next) {
39+
// Bug: https://github.com/aws/aws-sdk-js-v3/issues/1799
40+
this.waitForBucketExists(new S3({ region: location }), { Bucket: this.bucket }, next);
41+
});
42+
4443
Then("the bucket should have a location constraint of {string}", function (loc, callback) {
4544
const self = this;
4645
self.s3.getBucketLocation(
@@ -55,6 +54,11 @@ Then("the bucket should have a location constraint of {string}", function (loc,
5554
);
5655
});
5756

57+
When("I delete the bucket in region {string}", function (location, callback) {
58+
// Bug: https://github.com/aws/aws-sdk-js-v3/issues/1799
59+
this.request(new S3({ region: location }), "deleteBucket", { Bucket: this.bucket }, callback);
60+
});
61+
5862
When("I put a transition lifecycle configuration on the bucket with prefix {string}", function (prefix, callback) {
5963
const params = {
6064
Bucket: this.bucket,

0 commit comments

Comments
 (0)