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

test: improvements to requester pays tests and bucket metadata updates #2414

Merged
merged 4 commits into from
Mar 6, 2024
Merged

test: improvements to requester pays tests and bucket metadata updates #2414

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e62ae95
test: improvements to requester pays tests and bucket metadata updates
ddelgrosso1 Feb 28, 2024
dfac8f7
remove console.log statements
ddelgrosso1 Feb 28, 2024
69a9d51
adjust wait time slightly
ddelgrosso1 Feb 28, 2024
bccecd1
add retries to failed tests
ddelgrosso1 Feb 29, 2024
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
128 changes: 60 additions & 68 deletions system-test/storage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,18 @@ const RUNNING_IN_VPCSC = !!process.env['GOOGLE_CLOUD_TESTS_IN_VPCSC'];

const UNIFORM_ACCESS_TIMEOUT = 60 * 1000; // 60s see: https://cloud.google.com/storage/docs/consistency#eventually_consistent_operations
const UNIFORM_ACCESS_WAIT_TIME = 5 * 1000; // 5s
const BUCKET_METADATA_UPDATE_WAIT_TIME = 1000; // 1s buckets have a max rate of one metadata update per second.
const BUCKET_METADATA_UPDATE_WAIT_TIME = 1250; // 1.25s buckets have a max rate of one metadata update per second.

// block all attempts to chat with the metadata server (kokoro runs on GCE)
nock('http://metadata.google.internal')
.get(() => true)
.replyWithError({code: 'ENOTFOUND'})
.persist();

describe('storage', () => {
// eslint-disable-next-line prefer-arrow-callback
describe('storage', function () {
this.retries(3);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏽


const USER_ACCOUNT = 'user-spsawchuk@gmail.com';
const TESTS_PREFIX = `storage-tests-${shortUUID()}-`;
const RETENTION_DURATION_SECONDS = 10;
Expand Down Expand Up @@ -110,23 +113,18 @@ describe('storage', () => {
},
};

before(() => {
return bucket
.create()
.then(() => {
return pubsub.createTopic(generateName());
})
.then(data => {
topic = data[0];
return topic.iam.setPolicy({
bindings: [
{
role: 'roles/pubsub.editor',
members: ['allUsers'],
},
],
});
});
before(async () => {
await bucket.create();
const data = await pubsub.createTopic(generateName());
topic = data[0];
await topic.iam.setPolicy({
bindings: [
{
role: 'roles/pubsub.editor',
members: ['allUsers'],
},
],
});
});

after(() => {
Expand Down Expand Up @@ -231,8 +229,10 @@ describe('storage', () => {
describe('buckets', () => {
// Some bucket update operations have a rate limit.
// Introduce a delay between tests to avoid getting an error.
beforeEach(done => {
setTimeout(done, 1000);
beforeEach(async () => {
await new Promise(resolve =>
setTimeout(resolve, BUCKET_METADATA_UPDATE_WAIT_TIME)
);
});

it('should get access controls', async () => {
Expand Down Expand Up @@ -296,6 +296,9 @@ describe('storage', () => {
entity: 'allUsers',
role: 'READER',
});
await new Promise(resolve =>
setTimeout(resolve, BUCKET_METADATA_UPDATE_WAIT_TIME)
);
await bucket.acl.delete({entity: 'allUsers'});
});

Expand All @@ -319,6 +322,9 @@ describe('storage', () => {
it('should make a bucket private', async () => {
try {
await bucket.makePublic();
await new Promise(resolve =>
setTimeout(resolve, BUCKET_METADATA_UPDATE_WAIT_TIME)
);
await bucket.makePrivate();
assert.rejects(bucket.acl.get({entity: 'allUsers'}), err => {
assert.strictEqual((err as ApiError).code, 404);
Expand Down Expand Up @@ -1727,40 +1733,31 @@ describe('storage', () => {
//
// - file.save()
// -> file.createWriteStream()
before(() => {
before(async () => {
file = bucketNonAllowList.file(generateName());

return bucket
.enableRequesterPays()
.then(() => bucket.iam.getPolicy())
.then(data => {
const policy = data[0];

// Allow an absolute or relative path (from project root)
// for the key file.
let key2 = process.env.GCN_STORAGE_2ND_PROJECT_KEY;
if (key2 && key2.charAt(0) === '.') {
key2 = `${getDirName()}/../../../${key2}`;
}

// Get the service account for the "second" account (the
// one that will read the requester pays file).
const clientEmail = JSON.parse(
fs.readFileSync(key2!, 'utf-8')
).client_email;

policy.bindings.push({
role: 'roles/storage.admin',
members: [`serviceAccount:${clientEmail}`],
});

return bucket.iam.setPolicy(policy);
})
.then(() => file.save('abc', USER_PROJECT_OPTIONS))
.then(() => topic.getMetadata())
.then(data => {
topicName = data[0].name!;
});
await bucket.enableRequesterPays();
const data = await bucket.iam.getPolicy();
const policy = data[0];
// Allow an absolute or relative path (from project root)
// for the key file.
let key2 = process.env.GCN_STORAGE_2ND_PROJECT_KEY;
if (key2 && key2.charAt(0) === '.') {
key2 = `${getDirName()}/../../../${key2}`;
}
// Get the service account for the "second" account (the
// one that will read the requester pays file).
const clientEmail = JSON.parse(
fs.readFileSync(key2!, 'utf-8')
).client_email;
policy.bindings.push({
role: 'roles/storage.admin',
members: [`serviceAccount:${clientEmail}`],
});
await bucket.iam.setPolicy(policy);
await file.save('abc', USER_PROJECT_OPTIONS);
const data_2 = await topic.getMetadata();
topicName = data_2[0].name!;
});

// This acts as a test for the following methods:
Expand Down Expand Up @@ -1788,7 +1785,7 @@ describe('storage', () => {
type requesterPaysFunction<
T = {} | typeof USER_PROJECT_OPTIONS,
R = {} | void,
> = (options: T) => Promise<R>;
> = (options?: T) => Promise<R>;

/**
* Accepts a function and runs 2 tests - a test where the requester pays
Expand All @@ -1805,20 +1802,15 @@ describe('storage', () => {
const failureMessage =
'Bucket is a requester pays bucket but no user project provided.';

let expectedError: unknown = null;

try {
// Should raise an error on requester pays bucket
await testFunction({});
} catch (e) {
expectedError = e;
}

assert(expectedError instanceof Error);
assert(
expectedError.message.includes(failureMessage),
`Expected '${expectedError.message}' to include '${failureMessage}'`
);
await assert.rejects(testFunction(), err => {
assert(
(err as Error).message.includes(failureMessage),
`Expected '${
(err as Error).message
}' to include '${failureMessage}'`
);
return true;
});

// Validate the desired functionality
const results = await testFunction(USER_PROJECT_OPTIONS);
Expand Down
Loading