Adding additional functions for bucket lock samples

Author: billyjacobson

storage/composer.json

@@ -1,6 +1,6 @@
 {
     "require": {
-        "google/cloud-storage": "^1.5.2",
+        "google/cloud-storage": "^1.9.0",
         "paragonie/random_compat": "^2.0",
         "symfony/console": " ^3.0"
     },
@@ -35,6 +35,8 @@
             "src/get_object_acl.php",
             "src/get_object_acl_for_entity.php",
             "src/get_requester_pays_status.php",
+            "src/get_retention_policy.php",
+            "src/get_default_event_based_hold.php",
             "src/list_buckets.php",
             "src/list_objects.php",
             "src/list_objects_with_prefix.php",

storage/src/get_default_event_based_hold.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * 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/api/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_get_default_event_based_hold]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Enables a default event based hold for a bucket.
+ *
+ * @param string $bucketName the name of your Cloud Storage bucket.
+ *
+ * @return void
+ */
+function get_default_event_based_hold($bucketName)
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+
+    if ($bucket->info()['defaultEventBasedHold']) {
+        printf('Default event-based hold is enabled for ' . $bucketName . PHP_EOL);
+    } else {
+        printf('Default event-based hold is not enabled for ' . $bucketName . PHP_EOL);
+    }
+
+}
+# [END storage_get_default_event_based_hold]

storage/src/get_retention_policy.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * 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/api/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_get_retention_policy]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Gets a bucket's retention policy.
+ *
+ * @param string $bucketName the name of your Cloud Storage bucket.
+ *
+ * @return void
+ */
+function get_retention_policy($bucketName)
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    $bucket->reload();
+
+    printf('Retention Policy for ' . $bucketName . PHP_EOL);
+    printf('Retention Period: ' . $bucket->info()['retentionPolicy']['retentionPeriod'] . PHP_EOL);
+    if ($bucket->info()['retentionPolicy']['isLocked']) {
+        printf('Retention Policy is locked' . PHP_EOL);
+    }
+    if ($bucket->info()['retentionPolicy']['effectiveTime']) {
+        printf('Effective Time: ' .  $bucket->info()['retentionPolicy']['effectiveTime'] . PHP_EOL);
+    }
+}
+# [END storage_get_retention_policy]

storage/src/object_metadata.php

@@ -52,6 +52,11 @@ function object_metadata($bucketName, $objectName)
     printf('Crc32c: %s' . PHP_EOL, $info['crc32c']);
     printf('MD5 Hash: %s' . PHP_EOL, $info['md5Hash']);
     printf('Content-type: %s' . PHP_EOL, $info['contentType']);
+    printf("Temporary hold: " . ($info['temporaryHold'] ? "enabled" : "disabled") . PHP_EOL);
+    printf("Event based hold: " . ($info['eventBasedHold'] ? "enabled" : "disabled") . PHP_EOL);
+    if ($info['retentionExpirationTime']) {
+        printf("retentionExpirationTime: " . $info['retentionExpirationTime'] . PHP_EOL);
+    }
     if (isset($info['metadata'])) {
         printf('Metadata: %s', print_r($info['metadata'], true));
     }

storage/storage.php

@@ -164,10 +164,12 @@
     ->addOption('set-retention-policy', null, InputOption::VALUE_NONE, 'Set the retention policy')
     ->addOption('remove-retention-policy', null, InputOption::VALUE_NONE, 'Remove the retention policy')
     ->addOption('lock-retention-policy', null, InputOption::VALUE_NONE, 'Lock the retention policy')
+    ->addOption('get-retention-policy', null, InputOption::VALUE_NONE, 'Gets the retention policy')
     ->addOption('set-event-based-hold', null, InputOption::VALUE_NONE, 'Set an event based hold')
     ->addOption('release-event-based-hold', null, InputOption::VALUE_NONE, 'Release an event based hold')
     ->addOption('enable-default-event-based-hold', null, InputOption::VALUE_NONE, 'Enable default event based hold')
     ->addOption('disable-default-event-based-hold', null, InputOption::VALUE_NONE, 'Disable default event based hold')
+    ->addOption('get-default-event-based-hold', null, InputOption::VALUE_NONE, 'Gets default event based hold')
     ->addOption('set-temporary-hold', null, InputOption::VALUE_NONE, 'Set a temporary hold')
     ->addOption('release-temporary-hold', null, InputOption::VALUE_NONE, 'Release a temporary hold')
     ->setCode(function ($input, $output) {
@@ -177,10 +179,14 @@
                 remove_retention_policy($bucketName);
             } elseif ($input->getOption('lock-retention-policy')) {
                 lock_retention_policy($bucketName);
+            } elseif ($input->getOption('get-retention-policy')) {
+                get_retention_policy($bucketName);
             } elseif ($input->getOption('enable-default-event-based-hold')) {
                 enable_default_event_based_hold($bucketName);
             } elseif ($input->getOption('disable-default-event-based-hold')) {
                 disable_default_event_based_hold($bucketName);
+            } elseif ($input->getOption('get-default-event-based-hold')) {
+                get_default_event_based_hold($bucketName);
             } elseif ($input->getOption('set-retention-policy')) {
                 if ($retentionPeriod = $input->getArgument('retention-period')) {
                     set_retention_policy($bucketName, $retentionPeriod);

storage/test/BucketLockCommandTest.php

@@ -80,11 +80,20 @@ public function testRetentionPolicyNoLock()
             ['interactive' => false]
         );
         $this->bucket->reload();
+        $effectiveTime = $this->bucket->info()['retentionPolicy']['effectiveTime'];
 
-        $this->assertFalse($this->bucket->info()['retentionPolicy']['isLocked']);
-        $this->assertNotNull($this->bucket->info()['retentionPolicy']['effectiveTime']);
+        $this->assertNull($this->bucket->info()['retentionPolicy']['isLocked']);
+        $this->assertNotNull($effectiveTime);
         $this->assertEquals($this->bucket->info()['retentionPolicy']['retentionPeriod'], $retentionPeriod);
 
+        $this->commandTester->execute(
+            [
+                'bucket' => $this->bucket->name(),
+                '--get-retention-policy' => true,
+            ],
+            ['interactive' => false]
+        );
+
         $this->uploadObject();
         $this->assertNotNull($this->object->info()['retentionExpirationTime']);
 
@@ -101,6 +110,9 @@ public function testRetentionPolicyNoLock()
 
         $outputString = <<<EOF
 Bucket {$this->bucket->name()} retention period set for $retentionPeriod seconds
+Retention Policy for {$this->bucket->name()}
+Retention Period: 5
+Effective Time: $effectiveTime
 Removed bucket {$this->bucket->name()} retention policy
 
 EOF;
@@ -142,7 +154,7 @@ public function testRetentionPolicyLock()
         $this->expectOutputString($outputString);
     }
 
-    public function testEnableDisableDefaultEventBasedHold()
+    public function testEnableDisableGetDefaultEventBasedHold()
     {
         $this->commandTester->execute(
             [
@@ -155,6 +167,14 @@ public function testEnableDisableDefaultEventBasedHold()
 
         $this->assertTrue($this->bucket->info()['defaultEventBasedHold']);
 
+        $this->commandTester->execute(
+            [
+                'bucket' => $this->bucket->name(),
+                '--get-default-event-based-hold' => true,
+            ],
+            ['interactive' => false]
+        );
+
         $this->uploadObject();
         $this->assertTrue($this->object->info()['eventBasedHold']);
 
@@ -179,10 +199,20 @@ public function testEnableDisableDefaultEventBasedHold()
         $this->bucket->reload();
         $this->assertFalse($this->bucket->info()['defaultEventBasedHold']);
 
+        $this->commandTester->execute(
+            [
+                'bucket' => $this->bucket->name(),
+                '--get-default-event-based-hold' => true,
+            ],
+            ['interactive' => false]
+        );
+
         $outputString = <<<EOF
 Default event based hold was enabled for {$this->bucket->name()}
+Default event-based hold is enabled for {$this->bucket->name()}
 Event based hold was released for {$this->object->name()}
 Default event based hold was disabled for {$this->bucket->name()}
+Default event-based hold is not enabled for {$this->bucket->name()}
 
 EOF;
         $this->expectOutputString($outputString);