feat: add subscription detach sample (GoogleCloudPlatform#1150)

Author: jdpedrie

pubsub/api/composer.json

@@ -1,7 +1,7 @@
 {
     "require": {
         "php": ">=5.4",
-        "google/cloud-pubsub": "^1.5",
+        "google/cloud-pubsub": "^1.27",
         "symfony/console": " ^3.0"
     },
     "autoload": {
@@ -11,6 +11,7 @@
             "src/create_push_subscription.php",
             "src/delete_subscription.php",
             "src/delete_topic.php",
+            "src/detach_subscription.php",
             "src/get_subscription_policy.php",
             "src/get_topic_policy.php",
             "src/list_subscriptions.php",

pubsub/api/pubsub.php

@@ -40,6 +40,7 @@
     ->addOption('topic', null, InputOption::VALUE_REQUIRED, 'The topic for the subscription (when using --create).')
     ->addOption('endpoint', null, InputOption::VALUE_REQUIRED, 'An optional endpoint for push subscriptions.')
     ->addOption('delete', null, InputOption::VALUE_NONE, 'Delete the subscription.')
+    ->addOption('detach', null, InputOption::VALUE_NONE, 'Detach the subscription.')
     ->setCode(function ($input, $output) {
         $projectId = $input->getArgument('project');
         $subscriptionName = $input->getArgument('subscription');
@@ -56,6 +57,8 @@
             }
         } elseif ($input->getOption('delete')) {
             delete_subscription($projectId, $subscriptionName);
+        } elseif ($input->getOption('detach')) {
+            detach_subscription($projectId, $subscriptionName);
         } else {
             pull_messages($projectId, $subscriptionName);
         }

pubsub/api/src/detach_subscription.php

@@ -0,0 +1,45 @@
+
+/**
+ * Copyright 2020 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/blob/master/pubsub/api/README.md
+ */
+
+namespace Google\Cloud\Samples\PubSub;
+
+# [START pubsub_detach_subscription]
+use Google\Cloud\PubSub\PubSubClient;
+
+/**
+ * Detach a Pub/Sub subscription from a topic.
+ *
+ * @param string $projectId  The Google project ID.
+ * @param string $subscriptionName  The Pub/Sub subscription name.
+ */
+function detach_subscription($projectId, $subscriptionName)
+{
+    $pubsub = new PubSubClient([
+        'projectId' => $projectId,
+    ]);
+    $subscription = $pubsub->subscription($subscriptionName);
+    $subscription->detach();
+
+    printf('Subscription detached: %s' . PHP_EOL, $subscription->name());
+}
+# [END pubsub_detach_subscription]

pubsub/api/test/pubsubTest.php

@@ -231,6 +231,40 @@ public function testCreateAndDeletePushSubscription()
         $this->assertRegExp(sprintf('/%s/', $subscription), $output);
     }
 
+    public function testCreateAndDetachSubscription()
+    {
+        $topic = $this->requireEnv('GOOGLE_PUBSUB_TOPIC');
+        $subscription = 'testdetachsubsxyz-' . rand();
+        $output = $this->runCommand('subscription', [
+            'subscription' => $subscription,
+            '--topic' => $topic,
+            '--create' => true,
+            'project' => self::$projectId,
+        ]);
+
+        $this->assertRegExp('/Subscription created:/', $output);
+        $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+
+        $output = $this->runCommand('subscription', [
+            'subscription' => $subscription,
+            '--detach' => true,
+            'project' => self::$projectId,
+        ]);
+
+        $this->assertRegExp('/Subscription detached:/', $output);
+        $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+
+        // delete test resource
+        $output = $this->runCommand('subscription', [
+            'subscription' => $subscription,
+            '--delete' => true,
+            'project' => self::$projectId,
+        ]);
+
+        $this->assertRegExp('/Subscription deleted:/', $output);
+        $this->assertRegExp(sprintf('/%s/', $subscription), $output);
+    }
+
     public function testPullMessages()
     {
         $topic = $this->requireEnv('GOOGLE_PUBSUB_TOPIC');