Refactoring compute_instances_operation_check sample (GoogleCloudPlatform#1506)

* Refactoring compute_instances_operation_check sample

- moved wait_for_operation to a separate file
- added autoDelete flag to disks created with the instance to make sure they are cleaned up after VM deletion
- update google/cloud-compute version

Co-authored-by: Brent Shaffer 

Author: rsamborski

compute/cloud-client/instances/composer.json

@@ -1,6 +1,6 @@
 {
     "require": {
-        "google/cloud-compute": "^0.3.1",
+        "google/cloud-compute": "^0.4.0",
         "google/cloud-storage": "^1.23"
     }
 }

compute/cloud-client/instances/src/create_instance.php

@@ -23,14 +23,15 @@
 
 namespace Google\Cloud\Samples\Compute;
 
+include_once "wait_for_operation.php";
+
 # [START compute_instances_create]
 use Google\Cloud\Compute\V1\InstancesClient;
 use Google\Cloud\Compute\V1\AttachedDisk;
 use Google\Cloud\Compute\V1\AttachedDiskInitializeParams;
 use Google\Cloud\Compute\V1\Instance;
 use Google\Cloud\Compute\V1\NetworkInterface;
 use Google\Cloud\Compute\V1\Operation;
-use Google\Cloud\Compute\V1\ZoneOperationsClient;
 
 /**
  * Create an instance in the specified project and zone.
@@ -64,6 +65,7 @@ function create_instance(
         ->setSourceImage($sourceImage);
     $disk = (new AttachedDisk())
         ->setBoot(true)
+        ->setAutoDelete(true)
         ->setInitializeParams($diskInitializeParams);
 
     // Use the network interface provided in the $networkName argument.
@@ -81,13 +83,14 @@ function create_instance(
     $instancesClient = new InstancesClient();
     $operation = $instancesClient->insert($instance, $projectId, $zone);
 
-    // Wait for the create operation to complete.
-    if ($operation->getStatus() === Operation\Status::RUNNING) {
-        $operationClient = new ZoneOperationsClient();
-        $operationClient->wait($operation->getName(), $projectId, $zone);
+    // Wait for the create operation to complete using a custom helper function.
+    // @see src/wait_for_operation.php
+    $operation = wait_for_operation($operation, $projectId, $zone);
+    if (empty($operation->getError())) {
+        printf('Created instance %s' . PHP_EOL, $instanceName);
+    } else {
+        printf('Instance creation failed!' . PHP_EOL);
     }
-
-    printf('Created instance %s' . PHP_EOL, $instanceName);
 }
 # [END compute_instances_create]
 

compute/cloud-client/instances/src/delete_instance.php

@@ -23,13 +23,10 @@
 
 namespace Google\Cloud\Samples\Compute;
 
+include_once "wait_for_operation.php";
+
 # [START compute_instances_delete]
 use Google\Cloud\Compute\V1\InstancesClient;
-# [START compute_instances_operation_check]
-use Google\Cloud\Compute\V1\Operation;
-use Google\Cloud\Compute\V1\ZoneOperationsClient;
-
-# [END compute_instances_operation_check]
 
 /**
  * Delete an instance.
@@ -53,19 +50,14 @@ function delete_instance(
     $instancesClient = new InstancesClient();
     $operation = $instancesClient->delete($instanceName, $projectId, $zone);
 
-    # [START compute_instances_operation_check]
-    if ($operation->getStatus() === Operation\Status::RUNNING) {
-        // Wait for the operation to complete.
-        $operationClient = new ZoneOperationsClient();
-
-        // Default timeout of 60 s is not always enough for operation to finish,
-        // to avoid an exception we set timeout to 180000 ms = 180 s = 3 minutes
-        $optionalArgs = ['timeoutMillis' => 180000];
-        $operationClient->wait($operation->getName(), $projectId, $zone, $optionalArgs);
+    // Wait for the create operation to complete using a custom helper function.
+    // @see src/wait_for_operation.php
+    $operation = wait_for_operation($operation, $projectId, $zone);
+    if (empty($operation->getError())) {
+        printf('Deleted instance %s' . PHP_EOL, $instanceName);
+    } else {
+        printf('Instance deletion failed!' . PHP_EOL);
     }
-    # [END compute_instances_operation_check]
-
-    printf('Deleted instance %s' . PHP_EOL, $instanceName);
 }
 # [END compute_instances_delete]
 

compute/cloud-client/instances/src/wait_for_operation.php

@@ -0,0 +1,62 @@
+
+/**
+ * Copyright 2021 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/compute/cloud-client/README.md
+ */
+
+namespace Google\Cloud\Samples\Compute;
+
+# [START compute_instances_operation_check]
+use Google\Cloud\Compute\V1\Operation;
+use Google\Cloud\Compute\V1\ZoneOperationsClient;
+
+/**
+ * This method waits for an operation to be completed. Calling this function
+ * will block until the operation is finished.
+ *
+ * @param Operation $operation The Operation object representing the operation you want to
+wait on.
+ * @param string $projectId Your Google Cloud project ID.
+ * @param string $zone Zone where the instance you want to delete is (like "us-central1-a").
+ *
+ * @throws \Google\ApiCore\ApiException if the remote call fails.
+ * @return Operation Finished Operation object.
+ */
+function wait_for_operation(
+    Operation $operation,
+    string $projectId,
+    string $zone
+): Operation {
+    $operationClient = new ZoneOperationsClient();
+
+    while ($operation->getStatus() != Operation\Status::DONE) {
+        // Wait for the operation to complete.
+        $operation = $operationClient->wait($operation->getName(), $projectId, $zone);
+
+        if ($operation->hasError()) {
+            printf('Operation failed with error(s): %s' . PHP_EOL, $operation->getError()->serializeToString());
+            return $operation;
+        }
+    }
+
+    print('Operation successful' . PHP_EOL);
+    return $operation;
+}
+# [END compute_instances_operation_check]