Feat(Storage): add samples for soft-delete and restore buckets

[thiyaguk09]

Added Storage Samples:

1. Get a Soft Deleted Bucket
2. List Soft Deleted Buckets
3. Restore a Soft Deleted Bucket

[snippet-bot]

Here is the summary of changes.

You are about to add 3 region tags.

• storage/src/get_soft_deleted_bucket.php:26, tag storage_get_soft_deleted_bucket
• storage/src/list_soft_deleted_buckets.php:26, tag storage_list_soft_deleted_buckets
• storage/src/restore_soft_deleted_bucket.php:26, tag storage_restore_soft_deleted_bucket

---

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

• Refresh this comment

[danielduhh]

Hi @bshaffer, this should be ready for review when you get a second!

[bshaffer]

I ran these tests locally and received the following errors:

1) Google\Cloud\Samples\Storage\storageTest::testGetRestoreSoftDeletedBucket
Google\Cloud\Core\Exception\ServiceException: {"error":{"code":403,"message":"[email protected] does not have storage.buckets.get access to the Google Cloud Storage bucket. Permission 'storage.buckets.get' denied on resource (or it may not exist).","errors":[{"message":"[email protected] does not have storage.buckets.get access to the Google Cloud Storage bucket. Permission 'storage.buckets.get' denied on resource (or it may not exist).","domain":"global","reason":"forbidden"}]}}

vendor/google/cloud-core/src/RequestWrapper.php:434
vendor/google/cloud-core/src/RequestWrapper.php:230
vendor/google/cloud-core/src/RestTrait.php:103
vendor/google/cloud-storage/src/Connection/Rest.php:777
vendor/google/cloud-storage/src/Connection/Rest.php:202
vendor/google/cloud-storage/src/Bucket.php:1234
test/storageTest.php:959
--

There was 1 failure:

1) Google\Cloud\Samples\Storage\storageTest::testListSoftDeletedBuckets
Failed asserting that '' contains "Bucket:".

test/storageTest.php:153

Is it possible I need to enable something on the test project php-docs-samples-kokoro for these tests to pass?

[thiyaguk09]

Is it possible I need to enable something on the test project php-docs-samples-kokoro for these tests to pass?

Could you try giving the storage.legacyBucketOwner permission (roles/storage.legacyBucketOwner)?

[danielduhh]

@thiyaguk09 this is not the first test that creates a bucket, so I don't think permissions is an issue here

[thiyaguk09]

@thiyaguk09 this is not the first test that creates a bucket, so I don't think permissions is an issue here

@danielduhh Agreed. Permissions aren't the likely issue. I suspect the softDeletePolicy isn't being set correctly during bucket creation. I've manually configured it now. Let's add a kokoro:run to confirm.

@bshaffer Could you check if the buckets created are actually configured with the soft delete policy as intended?

*"Ruby repo also experiencing the same issue."

[bshaffer]

@thiyaguk09 the buckets are being created with the soft delete option here:

php-docs-samples/storage/test/storageTest.php

Lines 952 to 956 in 4ef3f1f

	$bucket = self::$storage->createBucket($bucketName, [
	'softDeletePolicy' => [
	'retentionDuration' => 604800,
	],
	]);

I can dig a little deeper to see if this bucket is being created as expected.

[bshaffer]

@thiyaguk09 I figured out the issue. The way you are supplying the soft delete options to $bucket->info() and $bucket->reload() is not how SoftDelete is currently supported in the Storage client library for PHP. Rather, you need to call it by supplying the options argument to StorageClient::bucket() like this:

$storage = new StorageClient();
$options = ['softDeleted' => true, 'generation' => $generation];
$softDeletedBucket = $storage->bucket($bucketName, options: $options);

[thiyaguk09]

@thiyaguk09 I figured out the issue. The way you are supplying the soft delete options to $bucket->info() and $bucket->reload() is not how SoftDelete is currently supported in the Storage client library for PHP. Rather, you need to call it by supplying the options argument to StorageClient::bucket() like this:

$storage = new StorageClient();
$options = ['softDeleted' => true, 'generation' => $generation];
$softDeletedBucket = $storage->bucket($bucketName, options: $options);

@bshaffer Thank you for your thorough investigation and for identifying the correct method for accessing soft-deleted buckets. Your explanation was very clear.

You're right, it appears there was an issue with how reload() was handling the soft delete options. We've implemented the changes you suggested, using StorageClient::bucket() with the options array. We're hoping this resolves the problem.

[bshaffer]

@thiyaguk09 The changes you made are still not correct, and do not follow the code example I provided. You're providing the softDelete option to the info method, while it needs to be supplied to the bucket method:

// What you have (INCORRECT)
$softDeletedBucket = self::$storage->bucket($bucketName);
$options = ['softDeleted' => true, 'generation' => $generation];
$info = $softDeletedBucket->info($options);

// What it should be (CORRECT)
$options = ['softDeleted' => true, 'generation' => $generation];
$softDeletedBucket = self::$storage->bucket($bucketName, options: $options);
$info = $softDeletedBucket->info();

[thiyaguk09]

The changes you made are still not correct, and do not follow the code example I provided. You're providing the softDelete option to the info method, while it needs to be supplied to the bucket method:

I apologize for the oversight. Thank you for pointing that out. I will make the necessary corrections to ensure the softDelete option is supplied to the bucket method as per your code example. The code has been updated; could you please review it?

[danielduhh]

@thiyaguk09 are the tests passing locally? Is this ready for a re-review?

[thiyaguk09]

@thiyaguk09 are the tests passing locally? Is this ready for a re-review?

Yes, it's passing locally and ready for re-review.

[thiyaguk09]

@bshaffer just a friendly nudge to check out this PR when you get a chance.