feat: compute create reservation from template sample (#12541)

* feat: compute create reservation from template sample

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: BigBlackWolf

compute/client_library/ingredients/instance-templates/create_reservation_from_template.py

@@ -0,0 +1,65 @@
+#  Copyright 2024 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.
+
+# This is an ingredient file. It is not meant to be run directly. Check the samples/snippets
+# folder for complete code samples that are ready to be used.
+# Disabling flake8 for the ingredients file, as it would fail F821 - undefined name check.
+# flake8: noqa
+
+from google.cloud import compute_v1
+
+
+# <INGREDIENT create_reservation_from_template>
+def create_reservation_from_template(
+    project_id: str, reservation_name: str, template: str
+) -> compute_v1.Reservation:
+    """
+    Create a new reservation based on an existing template.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        reservation_name: the name of new reservation.
+        template: existing template path. Following formats are allowed:
+            - projects/{project_id}/global/instanceTemplates/{template_name}
+            - projects/{project_id}/regions/{region}/instanceTemplates/{template_name}
+            - https://www.googleapis.com/compute/v1/projects/{project_id}/global/instanceTemplates/instanceTemplate
+            - https://www.googleapis.com/compute/v1/projects/{project_id}/regions/{region}/instanceTemplates/instanceTemplate
+
+    Returns:
+        Reservation object that represents the new reservation.
+    """
+
+    reservations_client = compute_v1.ReservationsClient()
+    request = compute_v1.InsertReservationRequest()
+    request.project = project_id
+    request.zone = "us-central1-a"
+
+    specific_reservation = compute_v1.AllocationSpecificSKUReservation()
+    specific_reservation.count = 1
+    specific_reservation.source_instance_template = template
+
+    reservation = compute_v1.Reservation()
+    reservation.name = reservation_name
+    reservation.specific_reservation = specific_reservation
+
+    request.reservation_resource = reservation
+    operation = reservations_client.insert(request)
+    wait_for_extended_operation(operation, "Reservation creation")
+
+    return reservations_client.get(
+        project=project_id, zone="us-central1-a", reservation=reservation_name
+    )
+
+
+# </INGREDIENT>

compute/client_library/recipes/instance_templates/create_reservation_from_template.py

@@ -0,0 +1,22 @@
+#  Copyright 2024 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.
+# flake8: noqa
+
+# <REGION compute_reservation_create_template>
+# <IMPORTS/>
+
+# <INGREDIENT wait_for_extended_operation />
+
+# <INGREDIENT create_reservation_from_template />
+# </REGION compute_reservation_create_template>

compute/client_library/snippets/instance_templates/create_reservation_from_template.py

@@ -0,0 +1,121 @@
+#  Copyright 2024 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.
+# flake8: noqa
+
+
+# This file is automatically generated. Please do not modify it directly.
+# Find the relevant recipe file in the samples/recipes or samples/ingredients
+# directory and apply your changes there.
+
+
+# [START compute_reservation_create_template]
+from __future__ import annotations
+
+import sys
+from typing import Any
+
+from google.api_core.extended_operation import ExtendedOperation
+from google.cloud import compute_v1
+
+
+def wait_for_extended_operation(
+    operation: ExtendedOperation, verbose_name: str = "operation", timeout: int = 300
+) -> Any:
+    """
+    Waits for the extended (long-running) operation to complete.
+
+    If the operation is successful, it will return its result.
+    If the operation ends with an error, an exception will be raised.
+    If there were any warnings during the execution of the operation
+    they will be printed to sys.stderr.
+
+    Args:
+        operation: a long-running operation you want to wait on.
+        verbose_name: (optional) a more verbose name of the operation,
+            used only during error and warning reporting.
+        timeout: how long (in seconds) to wait for operation to finish.
+            If None, wait indefinitely.
+
+    Returns:
+        Whatever the operation.result() returns.
+
+    Raises:
+        This method will raise the exception received from `operation.exception()`
+        or RuntimeError if there is no exception set, but there is an `error_code`
+        set for the `operation`.
+
+        In case of an operation taking longer than `timeout` seconds to complete,
+        a `concurrent.futures.TimeoutError` will be raised.
+    """
+    result = operation.result(timeout=timeout)
+
+    if operation.error_code:
+        print(
+            f"Error during {verbose_name}: [Code: {operation.error_code}]: {operation.error_message}",
+            file=sys.stderr,
+            flush=True,
+        )
+        print(f"Operation ID: {operation.name}", file=sys.stderr, flush=True)
+        raise operation.exception() or RuntimeError(operation.error_message)
+
+    if operation.warnings:
+        print(f"Warnings during {verbose_name}:\n", file=sys.stderr, flush=True)
+        for warning in operation.warnings:
+            print(f" - {warning.code}: {warning.message}", file=sys.stderr, flush=True)
+
+    return result
+
+
+def create_reservation_from_template(
+    project_id: str, reservation_name: str, template: str
+) -> compute_v1.Reservation:
+    """
+    Create a new reservation based on an existing template.
+
+    Args:
+        project_id: project ID or project number of the Cloud project you use.
+        reservation_name: the name of new reservation.
+        template: existing template path. Following formats are allowed:
+            - projects/{project_id}/global/instanceTemplates/{template_name}
+            - projects/{project_id}/regions/{region}/instanceTemplates/{template_name}
+            - https://www.googleapis.com/compute/v1/projects/{project_id}/global/instanceTemplates/instanceTemplate
+            - https://www.googleapis.com/compute/v1/projects/{project_id}/regions/{region}/instanceTemplates/instanceTemplate
+
+    Returns:
+        Reservation object that represents the new reservation.
+    """
+
+    reservations_client = compute_v1.ReservationsClient()
+    request = compute_v1.InsertReservationRequest()
+    request.project = project_id
+    request.zone = "us-central1-a"
+
+    specific_reservation = compute_v1.AllocationSpecificSKUReservation()
+    specific_reservation.count = 1
+    specific_reservation.source_instance_template = template
+
+    reservation = compute_v1.Reservation()
+    reservation.name = reservation_name
+    reservation.specific_reservation = specific_reservation
+
+    request.reservation_resource = reservation
+    operation = reservations_client.insert(request)
+    wait_for_extended_operation(operation, "Reservation creation")
+
+    return reservations_client.get(
+        project=project_id, zone="us-central1-a", reservation=reservation_name
+    )
+
+
+# [END compute_reservation_create_template]

compute/client_library/snippets/tests/test_reservations.py

@@ -0,0 +1,87 @@
+#  Copyright 2024 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.
+import uuid
+
+import google.auth
+from google.cloud import compute_v1
+import pytest
+
+from ..instance_templates.create_reservation_from_template import (
+    create_reservation_from_template,
+)
+
+PROJECT = google.auth.default()[1]
+INSTANCE_ZONE = "us-central1-a"
+
+
+@pytest.fixture
+def instance_template():
+    disk = compute_v1.AttachedDisk()
+    initialize_params = compute_v1.AttachedDiskInitializeParams()
+    initialize_params.source_image = (
+        "projects/debian-cloud/global/images/family/debian-11"
+    )
+    initialize_params.disk_size_gb = 25
+    initialize_params.disk_type = "pd-balanced"
+    disk.initialize_params = initialize_params
+    disk.auto_delete = True
+    disk.boot = True
+
+    network_interface = compute_v1.NetworkInterface()
+    network_interface.name = "global/networks/default"
+
+    template = compute_v1.InstanceTemplate()
+    template.name = "test-template-" + uuid.uuid4().hex[:10]
+    template.properties.disks = [disk]
+    template.properties.machine_type = "n1-standard-4"
+    template.properties.network_interfaces = [network_interface]
+
+    template_client = compute_v1.InstanceTemplatesClient()
+    operation_client = compute_v1.GlobalOperationsClient()
+    op = template_client.insert_unary(
+        project=PROJECT, instance_template_resource=template
+    )
+    operation_client.wait(project=PROJECT, operation=op.name)
+
+    template = template_client.get(project=PROJECT, instance_template=template.name)
+
+    yield template
+
+    op = template_client.delete_unary(project=PROJECT, instance_template=template.name)
+    operation_client.wait(project=PROJECT, operation=op.name)
+
+
+@pytest.fixture()
+def autodelete_reservation_name():
+    instance_name = "test-reservation-" + uuid.uuid4().hex[:10]
+    yield instance_name
+    reservations_client = compute_v1.ReservationsClient()
+    reservations_client.delete(
+        project=PROJECT, zone=INSTANCE_ZONE, reservation=instance_name
+    )
+
+
+def test_create_reservation_from_template(
+    instance_template, autodelete_reservation_name
+):
+    reservation = create_reservation_from_template(
+        PROJECT, autodelete_reservation_name, instance_template.self_link
+    )
+
+    assert reservation.name == autodelete_reservation_name
+    assert reservation.zone.endswith(INSTANCE_ZONE)
+    assert (
+        reservation.specific_reservation.source_instance_template
+        == instance_template.self_link
+    )