feat(Storage): object get kms key (GoogleCloudPlatform#1695)

Author: yash30201

storage/src/object_get_kms_key.php

@@ -0,0 +1,53 @@
+
+/**
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_object_get_kms_key]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Retrieve the KMS key of an object.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ *        (e.g. 'my-bucket')
+ * @param string $objectName The name of your object in the bucket.
+ *        (e.g. 'my-object')
+ */
+function object_get_kms_key(string $bucketName, string $objectName): void
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    $object = $bucket->object($objectName);
+    $info = $object->info();
+
+    printf(
+        'The KMS key of the object is %s' . PHP_EOL,
+        $info['kmsKeyName'],
+    );
+}
+# [END storage_object_get_kms_key]
+
+// The following 2 lines are only needed to run the samples
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

storage/test/storageTest.php

@@ -71,8 +71,8 @@ public function testPrintDefaultBucketAcl()
         $defaultAcl = self::$tempBucket->defaultAcl()->get();
         foreach ($defaultAcl as $item) {
             $this->assertStringContainsString(
-              sprintf('%s: %s' . PHP_EOL, $item['entity'], $item['role']),
-              $output,
+                sprintf('%s: %s' . PHP_EOL, $item['entity'], $item['role']),
+                $output,
             );
         }
     }
@@ -475,8 +475,30 @@ public function testUploadWithKmsKey()
             $objectName,
             $this->keyName()
         ));
+
+        return $objectName;
     }
 
+    /** @depends testUploadWithKmsKey */
+    public function testObjectGetKmsKey(string $objectName)
+    {
+        $kmsEncryptedBucketName = self::$bucketName . '-kms-encrypted';
+        $bucket = self::$storage->bucket($kmsEncryptedBucketName);
+        $objectInfo = $bucket->object($objectName)->info();
+
+        $output = $this->runFunctionSnippet('object_get_kms_key', [
+            $kmsEncryptedBucketName,
+            $objectName,
+        ]);
+
+        $this->assertEquals(
+            sprintf(
+                'The KMS key of the object is %s' . PHP_EOL,
+                $objectInfo['kmsKeyName'],
+            ),
+            $output,
+        );
+    }
     public function testBucketVersioning()
     {
         $output = self::runFunctionSnippet('enable_versioning', [
@@ -510,8 +532,8 @@ public function testBucketWebsiteConfiguration()
         ]);
 
         $this->assertEquals(
-          sprintf('Bucket website configuration not set' . PHP_EOL),
-          $output,
+            sprintf('Bucket website configuration not set' . PHP_EOL),
+            $output,
         );
 
         $output = self::runFunctionSnippet('define_bucket_website_configuration', [
@@ -521,13 +543,13 @@ public function testBucketWebsiteConfiguration()
         ]);
 
         $this->assertEquals(
-          sprintf(
-            'Static website bucket %s is set up to use %s as the index page and %s as the 404 page.',
-            $bucket->name(),
-            $obj->name(),
-            $obj->name(),
-          ),
-          $output
+            sprintf(
+                'Static website bucket %s is set up to use %s as the index page and %s as the 404 page.',
+                $bucket->name(),
+                $obj->name(),
+                $obj->name(),
+            ),
+            $output
         );
 
         $info = $bucket->reload();
@@ -537,12 +559,12 @@ public function testBucketWebsiteConfiguration()
         ]);
 
         $this->assertEquals(
-          sprintf(
-            'Index page: %s' . PHP_EOL . '404 page: %s' . PHP_EOL,
-            $info['website']['mainPageSuffix'],
-            $info['website']['notFoundPage'],
-          ),
-          $output,
+            sprintf(
+                'Index page: %s' . PHP_EOL . '404 page: %s' . PHP_EOL,
+                $info['website']['mainPageSuffix'],
+                $info['website']['notFoundPage'],
+            ),
+            $output,
         );
 
         $obj->delete();