feat(Storage): Dual-Region Sample (#1618)

Author: danielbankhead

storage/src/create_bucket_dual_region.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * 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_create_bucket_dual_region]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Create a new bucket with a custom default storage class and location.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ * @param string $location1 First location for the bucket's regions. Case-insensitive.
+ * @param string $location2 Second location for the bucket's regions. Case-insensitive.
+ */
+function create_bucket_dual_region($bucketName, $location1, $location2)
+{
+    // $bucketName = 'my-bucket';
+    // $location1 = 'US-EAST1';
+    // $location2 = 'US-WEST1';
+
+    $storage = new StorageClient();
+    $bucket = $storage->createBucket($bucketName, [
+        'location' => "${location1}+${location2}",
+    ]);
+
+    printf("Created dual-region bucket '%s' in '%s+%s'", $bucket->name(), $location1, $location2);
+}
+# [END storage_create_bucket_dual_region]
+
+// 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/src/create_bucket_turbo_replication.php

@@ -31,7 +31,8 @@
  * The bucket must be a dual-region bucket for this setting to take effect.
  *
  * @param string $bucketName The name of your Cloud Storage bucket.
- * @param string $location The Dual Region location where you want your bucket to reside. (Read more at https://cloud.google.com/storage/docs/locations#location-dr)
+ * @param string $location The Dual-Region location where you want your bucket to reside (e.g. "US-CENTRAL1+US-WEST1").
+                                           Read more at https://cloud.google.com/storage/docs/locations#location-dr
  */
 function create_bucket_turbo_replication($bucketName, $location = 'nam4')
 {
@@ -40,7 +41,7 @@ function create_bucket_turbo_replication($bucketName, $location = 'nam4')
     $storage = new StorageClient();
     $rpo = 'ASYNC_TURBO';
 
-    // providing a location which is a dual region location
+    // providing a location which is a dual-region location
     // makes sure the locationType is set to 'dual-region' implicitly
     // we can pass 'locationType' => 'dual-region'
     // to make it explicit

storage/test/storageTest.php

@@ -672,6 +672,27 @@ public function testCreateBucketClassLocation()
         $this->assertStringContainsString('Created bucket', $output);
     }
 
+    public function testCreateBucketDualRegion()
+    {
+        $location1 = 'US-EAST1';
+        $location2 = 'US-WEST1';
+
+        $bucketName = uniqid('samples-create-bucket-dual-region-');
+        $output = self::runFunctionSnippet('create_bucket_dual_region', [
+            $bucketName,
+            $location1,
+            $location2
+        ]);
+
+        $bucket = self::$storage->bucket($bucketName);
+        $exists = $bucket->exists();
+        $bucket->delete();
+
+        $this->assertTrue($exists);
+        $this->assertStringContainsString('Created dual-region bucket', $output);
+        $this->assertStringContainsString("${location1}+${location2}", $output);
+    }
+
     public function testObjectCsekToCmek()
     {
         $objectName = uniqid('samples-object-csek-to-cmek-');