chore: upgrade some storage samples (GoogleCloudPlatform#1384)

bshaffer · web-flow · commit b36a4e74c8f0 · 2021-06-22T09:55:18.000-07:00
diff --git a/storage/README.md b/storage/README.md
@@ -32,15 +32,10 @@ This simple command-line application demonstrates how to invoke
 4.  **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md).
     Run `php composer.phar install` (if composer is installed locally) or `composer install`
     (if composer is installed globally).
-5.  Run `php storage.php`. The following commands are available:
+5.  Run `php storage.php` to see a list of commands:
 
     ```sh
-    bucket-acl                       Manage the ACL for Cloud Storage buckets.
-    bucket-default-acl               Manage the default ACL for Cloud Storage buckets.
-    bucket-labels                    Manage Cloud Storage bucket labels
     bucket-lock                      Manage Cloud Storage retention policies and holds
-    buckets                          Manage Cloud Storage buckets
-    encryption                       Upload and download Cloud Storage objects with encryption
     object-acl                       Manage the ACL for Cloud Storage objects
     objects                          Manage Cloud Storage objects
     requester-pays                   Manage Cloud Storage requester pays buckets and objects
diff --git a/storage/composer.json b/storage/composer.json
@@ -6,18 +6,11 @@
     },
     "autoload": {
         "files": [
-            "src/add_bucket_acl.php",
             "src/add_bucket_conditional_iam_binding.php",
-            "src/add_bucket_default_acl.php",
             "src/add_bucket_iam_member.php",
-            "src/add_bucket_label.php",
             "src/add_object_acl.php",
             "src/copy_object.php",
-            "src/create_bucket.php",
             "src/create_hmac_key.php",
-            "src/delete_bucket.php",
-            "src/delete_bucket_acl.php",
-            "src/delete_bucket_default_acl.php",
             "src/delete_object.php",
             "src/delete_object_acl.php",
             "src/delete_hmac_key.php",
@@ -26,23 +19,14 @@
             "src/disable_default_event_based_hold.php",
             "src/disable_requester_pays.php",
             "src/deactivate_hmac_key.php",
-            "src/download_encrypted_object.php",
             "src/download_file_requester_pays.php",
             "src/download_object.php",
             "src/enable_bucket_lifecycle_management.php",
             "src/enable_uniform_bucket_level_access.php",
             "src/enable_default_event_based_hold.php",
-            "src/enable_default_kms_key.php",
             "src/enable_requester_pays.php",
             "src/activate_hmac_key.php",
-            "src/generate_encryption_key.php",
             "src/generate_v4_post_policy.php",
-            "src/bucket_metadata.php",
-            "src/get_bucket_acl.php",
-            "src/get_bucket_acl_for_entity.php",
-            "src/get_bucket_default_acl.php",
-            "src/get_bucket_default_acl_for_entity.php",
-            "src/get_bucket_labels.php",
             "src/get_uniform_bucket_level_access.php",
             "src/get_object_acl.php",
             "src/get_object_acl_for_entity.php",
@@ -53,7 +37,6 @@
             "src/get_retention_policy.php",
             "src/get_default_event_based_hold.php",
             "src/get_hmac_key.php",
-            "src/list_buckets.php",
             "src/list_objects.php",
             "src/list_objects_with_prefix.php",
             "src/list_hmac_keys.php",
@@ -65,15 +48,11 @@
             "src/release_temporary_hold.php",
             "src/remove_bucket_iam_member.php",
             "src/remove_bucket_conditional_iam_binding.php",
-            "src/remove_bucket_label.php",
             "src/remove_retention_policy.php",
-            "src/rotate_encryption_key.php",
             "src/set_event_based_hold.php",
             "src/set_retention_policy.php",
             "src/set_temporary_hold.php",
-            "src/upload_encrypted_object.php",
             "src/upload_object.php",
-            "src/upload_with_kms_key.php",
             "src/view_bucket_iam_members.php"
         ]
     },
diff --git a/storage/src/add_bucket_acl.php b/storage/src/add_bucket_acl.php
@@ -46,3 +46,6 @@ function add_bucket_acl($bucketName, $entity, $role, $options = [])
     printf('Added %s (%s) to gs://%s ACL' . PHP_EOL, $entity, $role, $bucketName);
 }
 # [END storage_add_bucket_owner]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/add_bucket_default_acl.php b/storage/src/add_bucket_default_acl.php
@@ -46,3 +46,6 @@ function add_bucket_default_acl($bucketName, $entity, $role, $options = [])
     printf('Added %s (%s) to gs://%s default ACL' . PHP_EOL, $entity, $role, $bucketName);
 }
 # [END storage_add_bucket_default_owner]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/add_bucket_label.php b/storage/src/add_bucket_label.php
@@ -42,3 +42,6 @@ function add_bucket_label($bucketName, $labelName, $labelValue)
     printf('Added label %s (%s) to %s' . PHP_EOL, $labelName, $labelValue, $bucketName);
 }
 # [END storage_add_bucket_label]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/create_bucket.php b/storage/src/create_bucket.php
@@ -40,3 +40,6 @@ function create_bucket($bucketName, $options = [])
     printf('Bucket created: %s' . PHP_EOL, $bucket->name());
 }
 # [END storage_create_bucket]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/delete_bucket.php b/storage/src/delete_bucket.php
@@ -41,3 +41,6 @@ function delete_bucket($bucketName)
     printf('Bucket deleted: %s' . PHP_EOL, $bucket->name());
 }
 # [END storage_delete_bucket]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/delete_bucket_acl.php b/storage/src/delete_bucket_acl.php
@@ -44,3 +44,6 @@ function delete_bucket_acl($bucketName, $entity, $options = [])
     printf('Deleted %s from gs://%s ACL' . PHP_EOL, $entity, $bucketName);
 }
 # [END storage_remove_bucket_owner]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/delete_bucket_default_acl.php b/storage/src/delete_bucket_default_acl.php
@@ -44,3 +44,6 @@ function delete_bucket_default_acl($bucketName, $entity, $options = [])
     printf('Deleted %s from gs://%s default ACL' . PHP_EOL, $entity, $bucketName);
 }
 # [END storage_remove_bucket_default_owner]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/download_encrypted_object.php b/storage/src/download_encrypted_object.php
@@ -48,3 +48,6 @@ function download_encrypted_object($bucketName, $objectName, $destination, $base
         $bucketName, $objectName, basename($destination));
 }
 # [END storage_download_encrypted_file]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/enable_default_kms_key.php b/storage/src/enable_default_kms_key.php
@@ -51,3 +51,6 @@ function enable_default_kms_key($projectId, $bucketName, $kmsKeyName)
         $bucket->info()['encryption']['defaultKmsKeyName']);
 }
 # [END storage_set_bucket_default_kms_key]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/generate_encryption_key.php b/storage/src/generate_encryption_key.php
@@ -37,3 +37,6 @@ function generate_encryption_key()
     printf('Your encryption key: %s' . PHP_EOL, $encodedKey);
 }
 # [END storage_generate_encryption_key]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/get_bucket_acl.php b/storage/src/get_bucket_acl.php
@@ -43,3 +43,6 @@ function get_bucket_acl($bucketName)
     }
 }
 # [END storage_print_bucket_acl]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/get_bucket_acl_for_entity.php b/storage/src/get_bucket_acl_for_entity.php
@@ -43,3 +43,6 @@ function get_bucket_acl_for_entity($bucketName, $entity)
     printf('%s: %s' . PHP_EOL, $item['entity'], $item['role']);
 }
 # [END get_bucket_acl_for_entity]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/get_bucket_default_acl.php b/storage/src/get_bucket_default_acl.php
@@ -43,3 +43,6 @@ function get_bucket_default_acl($bucketName)
     }
 }
 # [END get_bucket_default_acl]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/get_bucket_default_acl_for_entity.php b/storage/src/get_bucket_default_acl_for_entity.php
@@ -43,3 +43,6 @@ function get_bucket_default_acl_for_entity($bucketName, $entity)
     printf('%s: %s' . PHP_EOL, $item['entity'], $item['role']);
 }
 # [END get_bucket_default_acl_for_entity]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/get_bucket_labels.php b/storage/src/get_bucket_labels.php
@@ -43,3 +43,6 @@ function get_bucket_labels($bucketName)
     }
 }
 # [END storage_get_bucket_labels]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/get_bucket_metadata.php b/storage/src/get_bucket_metadata.php
@@ -42,3 +42,6 @@ function get_bucket_metadata($bucketName)
     printf("Bucket Metadata: %s" . PHP_EOL, print_r($info));
 }
 # [END storage_get_bucket_metadata]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/list_buckets.php b/storage/src/list_buckets.php
@@ -39,3 +39,6 @@ function list_buckets()
     }
 }
 # [END storage_list_buckets]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/remove_bucket_label.php b/storage/src/remove_bucket_label.php
@@ -41,3 +41,6 @@ function remove_bucket_label($bucketName, $labelName)
     printf('Removed label %s from %s' . PHP_EOL, $labelName, $bucketName);
 }
 # [END storage_remove_bucket_label]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/rotate_encryption_key.php b/storage/src/rotate_encryption_key.php
@@ -54,3 +54,6 @@ function rotate_encryption_key(
         $bucketName, $objectName);
 }
 # [END storage_rotate_encryption_key]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/upload_encrypted_object.php b/storage/src/upload_encrypted_object.php
@@ -49,3 +49,6 @@ function upload_encrypted_object($bucketName, $objectName, $source, $base64Encry
         basename($source), $bucketName, $objectName);
 }
 # [END storage_upload_encrypted_file]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/src/upload_with_kms_key.php b/storage/src/upload_with_kms_key.php
@@ -55,3 +55,6 @@ function upload_with_kms_key($projectId, $bucketName, $objectName, $source, $kms
         $kmsKeyName);
 }
 # [END storage_upload_with_kms_key]
+
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
diff --git a/storage/storage.php b/storage/storage.php
diff --git a/storage/test/storageTest.php b/storage/test/storageTest.php

Original file line number	Diff line number	Diff line change
`@@ -46,3 +46,6 @@ function add_bucket_acl($bucketName, $entity, $role, $options = [])`
`46`	`46`	`printf('Added %s (%s) to gs://%s ACL' . PHP_EOL, $entity, $role, $bucketName);`
`47`	`47`	`}`
`48`	`48`	`# [END storage_add_bucket_owner]`
	`49`	`+`
	`50`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`51`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -46,3 +46,6 @@ function add_bucket_default_acl($bucketName, $entity, $role, $options = [])`
`46`	`46`	`printf('Added %s (%s) to gs://%s default ACL' . PHP_EOL, $entity, $role, $bucketName);`
`47`	`47`	`}`
`48`	`48`	`# [END storage_add_bucket_default_owner]`
	`49`	`+`
	`50`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`51`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -42,3 +42,6 @@ function add_bucket_label($bucketName, $labelName, $labelValue)`
`42`	`42`	`printf('Added label %s (%s) to %s' . PHP_EOL, $labelName, $labelValue, $bucketName);`
`43`	`43`	`}`
`44`	`44`	`# [END storage_add_bucket_label]`
	`45`	`+`
	`46`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`47`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -40,3 +40,6 @@ function create_bucket($bucketName, $options = [])`
`40`	`40`	`printf('Bucket created: %s' . PHP_EOL, $bucket->name());`
`41`	`41`	`}`
`42`	`42`	`# [END storage_create_bucket]`
	`43`	`+`
	`44`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`45`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -41,3 +41,6 @@ function delete_bucket($bucketName)`
`41`	`41`	`printf('Bucket deleted: %s' . PHP_EOL, $bucket->name());`
`42`	`42`	`}`
`43`	`43`	`# [END storage_delete_bucket]`
	`44`	`+`
	`45`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`46`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -44,3 +44,6 @@ function delete_bucket_acl($bucketName, $entity, $options = [])`
`44`	`44`	`printf('Deleted %s from gs://%s ACL' . PHP_EOL, $entity, $bucketName);`
`45`	`45`	`}`
`46`	`46`	`# [END storage_remove_bucket_owner]`
	`47`	`+`
	`48`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`49`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -48,3 +48,6 @@ function download_encrypted_object($bucketName, $objectName, $destination, $base`
`48`	`48`	`$bucketName, $objectName, basename($destination));`
`49`	`49`	`}`
`50`	`50`	`# [END storage_download_encrypted_file]`
	`51`	`+`
	`52`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`53`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -51,3 +51,6 @@ function enable_default_kms_key($projectId, $bucketName, $kmsKeyName)`
`51`	`51`	`$bucket->info()['encryption']['defaultKmsKeyName']);`
`52`	`52`	`}`
`53`	`53`	`# [END storage_set_bucket_default_kms_key]`
	`54`	`+`
	`55`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`56`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -37,3 +37,6 @@ function generate_encryption_key()`
`37`	`37`	`printf('Your encryption key: %s' . PHP_EOL, $encodedKey);`
`38`	`38`	`}`
`39`	`39`	`# [END storage_generate_encryption_key]`
	`40`	`+`
	`41`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`42`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`
Original file line number	Diff line number	Diff line change
`@@ -43,3 +43,6 @@ function get_bucket_acl($bucketName)`
`43`	`43`	`}`
`44`	`44`	`}`
`45`	`45`	`# [END storage_print_bucket_acl]`
	`46`	`+`
	`47`	`+require_once __DIR__ . '/../../testing/sample_helpers.php';`
	`48`	`+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);`