[snipets][compute_ip_address_reserve_new_external] (#11578)

irudykss · gcf-owl-bot[bot] · web-flow · commit e6517d868ee4 · 2024-04-25T11:15:52.000+03:00
* [snipets][compute_ip_address_reserve_new_external] * [snipets][compute_ip_address_reserve_new_external] fix sgs * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * [snipets][compute_ip_address_reserve_new_external] fix PR comments * 🦉 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>
diff --git a/compute/client_library/ingredients/instances/ip_address/reserve_new_external_ip_address.py b/compute/client_library/ingredients/instances/ip_address/reserve_new_external_ip_address.py
@@ -0,0 +1,68 @@
+#  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
+from typing import Optional
+
+from google.cloud.compute_v1.types import Address
+from google.cloud.compute_v1.services.addresses.client import AddressesClient
+from google.cloud.compute_v1.services.global_addresses import GlobalAddressesClient
+
+
+# <INGREDIENT reserve_new_external_ip_address>
+def reserve_new_external_ip_address(
+    project_id: str,
+    address_name: str,
+    is_v6: bool = False,
+    is_premium: bool = False,
+    region: Optional[str] = None,
+):
+    """
+    Reserves a new external IP address in the specified project and region.
+
+    Args:
+    project_id (str): Your Google Cloud project ID.
+    address_name (str): The name for the new IP address.
+    is_v6 (bool): 'IPV4' or 'IPV6' depending on the IP version. IPV6 if True. Option only for global regions.
+    is_premium (bool): 'STANDARD' or 'PREMIUM' network tier. Standard option available only in regional ip.
+    region (Optional[str]): The region to reserve the IP address in, if regional. Must be None if global.
+
+    Returns:
+    None
+    """
+
+    ip_version = "IPV6" if is_v6 else "IPV4"
+    network_tier = "STANDARD" if not is_premium and region else "PREMIUM"
+
+    address = Address(
+        name=address_name,
+        address_type="EXTERNAL",
+        network_tier=network_tier,
+    )
+    if not region:  # global IP address
+        client = GlobalAddressesClient()
+        address.ip_version = ip_version
+        operation = client.insert(project=project_id, address_resource=address)
+    else:  # regional IP address
+        address.region = region
+        client = AddressesClient()
+        operation = client.insert(
+            project=project_id, region=region, address_resource=address
+        )
+
+    operation.result()
+
+    print(f"External IP address '{address_name}' reserved successfully.")
+
+
+# </INGREDIENT>
diff --git a/compute/client_library/recipes/instances/ip_address/reserve_new_external_ip_address.py b/compute/client_library/recipes/instances/ip_address/reserve_new_external_ip_address.py
@@ -0,0 +1,48 @@
+#  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_ip_address_reserve_new_external>
+# <IMPORTS/>
+# <INGREDIENT reserve_new_external_ip_address />
+
+# </REGION compute_ip_address_reserve_new_external>
+
+if __name__ == "__main__":
+    import google.auth
+
+    PROJECT = google.auth.default()[1]
+    region = "us-central1"
+    address_name = "my-new-external-ip"
+
+    # ip4 global
+    reserve_new_external_ip_address(PROJECT, address_name + "ip4-global")
+    # ip4 regional premium
+    reserve_new_external_ip_address(
+        PROJECT,
+        address_name + "ip4-regional-premium",
+        region=region,
+        is_premium=True,
+    )
+    # ip4 regional
+    reserve_new_external_ip_address(
+        PROJECT, address_name + "ip4-regional", region=region
+    )
+    # ip6 global
+    reserve_new_external_ip_address(PROJECT, address_name + "ip6-global", is_v6=True)
+    # ip6 regional
+    reserve_new_external_ip_address(
+        PROJECT, address_name + "ip6-regional", is_v6=True, region=region
+    )
diff --git a/compute/client_library/snippets/instances/ip_address/reserve_new_external_ip_address.py b/compute/client_library/snippets/instances/ip_address/reserve_new_external_ip_address.py
@@ -0,0 +1,102 @@
+#  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_ip_address_reserve_new_external]
+from typing import Optional
+
+from google.cloud.compute_v1.services.addresses.client import AddressesClient
+from google.cloud.compute_v1.services.global_addresses import GlobalAddressesClient
+from google.cloud.compute_v1.types import Address
+
+
+def reserve_new_external_ip_address(
+    project_id: str,
+    address_name: str,
+    is_v6: bool = False,
+    is_premium: bool = False,
+    region: Optional[str] = None,
+):
+    """
+    Reserves a new external IP address in the specified project and region.
+
+    Args:
+    project_id (str): Your Google Cloud project ID.
+    address_name (str): The name for the new IP address.
+    is_v6 (bool): 'IPV4' or 'IPV6' depending on the IP version. IPV6 if True. Option only for global regions.
+    is_premium (bool): 'STANDARD' or 'PREMIUM' network tier. Standard option available only in regional ip.
+    region (Optional[str]): The region to reserve the IP address in, if regional. Must be None if global.
+
+    Returns:
+    None
+    """
+
+    ip_version = "IPV6" if is_v6 else "IPV4"
+    network_tier = "STANDARD" if not is_premium and region else "PREMIUM"
+
+    address = Address(
+        name=address_name,
+        address_type="EXTERNAL",
+        network_tier=network_tier,
+    )
+    if not region:  # global IP address
+        client = GlobalAddressesClient()
+        address.ip_version = ip_version
+        operation = client.insert(project=project_id, address_resource=address)
+    else:  # regional IP address
+        address.region = region
+        client = AddressesClient()
+        operation = client.insert(
+            project=project_id, region=region, address_resource=address
+        )
+
+    operation.result()
+
+    print(f"External IP address '{address_name}' reserved successfully.")
+
+
+# [END compute_ip_address_reserve_new_external]
+
+if __name__ == "__main__":
+    import google.auth
+
+    PROJECT = google.auth.default()[1]
+    region = "us-central1"
+    address_name = "my-new-external-ip"
+
+    # ip4 global
+    reserve_new_external_ip_address(PROJECT, address_name + "ip4-global")
+    # ip4 regional premium
+    reserve_new_external_ip_address(
+        PROJECT,
+        address_name + "ip4-regional-premium",
+        region=region,
+        is_premium=True,
+    )
+    # ip4 regional
+    reserve_new_external_ip_address(
+        PROJECT, address_name + "ip4-regional", region=region
+    )
+    # ip6 global
+    reserve_new_external_ip_address(PROJECT, address_name + "ip6-global", is_v6=True)
+    # ip6 regional
+    reserve_new_external_ip_address(
+        PROJECT, address_name + "ip6-regional", is_v6=True, region=region
+    )
diff --git a/compute/client_library/snippets/tests/test_ip_address.py b/compute/client_library/snippets/tests/test_ip_address.py
@@ -12,6 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+from typing import List, Optional, Union
 import uuid
 
 import google.auth
@@ -24,10 +25,12 @@
     disk_from_image,
     get_image_from_family,
 )
-
 from ..instances.delete import delete_instance
 from ..instances.ip_address.get_static_ip_address import get_static_ip_address
 from ..instances.ip_address.get_vm_address import get_instance_ip_address, IPType
+from ..instances.ip_address.reserve_new_external_ip_address import (
+    reserve_new_external_ip_address,
+)
 
 PROJECT = google.auth.default()[1]
 REGION = "us-central1"
@@ -101,6 +104,56 @@ def test_get_static_ip(static_ip: Address):
     assert static_ip.name == actual_address.name
 
 
+def delete_ip_address(
+    client: Union[AddressesClient, GlobalAddressesClient],
+    project_id: str,
+    address_name: str,
+    region: Optional[str] = None,
+):
+    """
+    Deletes ip address with given parameters.
+    Args:
+        client (Union[AddressesClient, GlobalAddressesClient]): global or regional address client
+        project_id (str): project id
+        address_name (str): ip address name to delete
+        region (Optional[str]): region of ip address. Marker to choose between clients (GlobalAddressesClient when None)
+    """
+    try:
+        if region:
+            operation = client.delete(
+                project=project_id, region=region, address=address_name
+            )
+        else:
+            operation = client.delete(project=project_id, address=address_name)
+        operation.result()
+    except Exception as e:
+        print(
+            f"Error deleting ip address: {e}"
+        )  # suppress potential errors during deletions
+
+
+def list_ip_addresses(
+    client: Union[AddressesClient, GlobalAddressesClient],
+    project_id: str,
+    region: Optional[str] = None,
+) -> List[str]:
+    """
+    Retrieves ip address names of project (global) or region.
+    Args:
+        client (Union[AddressesClient, GlobalAddressesClient]): global or regional address client
+        project_id (str): project id
+        region (Optional[str]): region of ip address. Marker to choose between clients (GlobalAddressesClient when None)
+
+    Returns:
+        list of ip address names as strings
+    """
+    if region:
+        return [
+            address.name for address in client.list(project=project_id, region=region)
+        ]
+    return [address.name for address in client.list(project=project_id)]
+
+
 def test_get_instance_external_ip_address(instance_with_ips):
     # Internal IP check
     internal_ips = get_instance_ip_address(instance_with_ips, ip_type=IPType.INTERNAL)
@@ -128,3 +181,64 @@ def test_get_instance_external_ip_address(instance_with_ips):
         if ipv6_config.type_ == "DIRECT_IPV6"
     }
     assert set(ipv6_ips) == expected_ipv6_ips, "IPv6 IPs do not match"
+
+
+def test_reserve_new_external_ip_address_global():
+    global_client = GlobalAddressesClient()
+    unique_string = uuid.uuid4()
+    ip_4_global = f"ip4-global-{unique_string}"
+    ip_6_global = f"ip6-global-{unique_string}"
+
+    expected_ips = {ip_4_global, ip_6_global}
+    try:
+        # ip4 global
+        reserve_new_external_ip_address(PROJECT, ip_4_global)
+        # ip6 global
+        reserve_new_external_ip_address(PROJECT, ip_6_global, is_v6=True)
+
+        ips = list_ip_addresses(global_client, PROJECT)
+        assert set(ips).issuperset(expected_ips)
+    finally:
+        # cleanup
+        for address in expected_ips:
+            delete_ip_address(global_client, PROJECT, address)
+
+
+def test_reserve_new_external_ip_address_regional():
+    regional_client = AddressesClient()
+    unique_string = uuid.uuid4()
+    region = "us-central1"
+
+    ip_4_regional = f"ip4-regional-{unique_string}"
+    ip_4_regional_premium = f"ip4-regional-premium-{unique_string}"
+    ip_6_regional = f"ip6-regional-{unique_string}"
+    ip_6_regional_premium = f"ip6-regional-premium-{unique_string}"
+
+    expected_ips = {
+        ip_4_regional,
+        ip_4_regional_premium,
+        ip_6_regional,
+        ip_6_regional_premium,
+    }
+    try:
+        # ip4 regional standard
+        reserve_new_external_ip_address(PROJECT, ip_4_regional, region=region)
+        # ip4 regional premium
+        reserve_new_external_ip_address(
+            PROJECT, ip_4_regional_premium, region=region, is_premium=True
+        )
+        # ip6 regional standard
+        reserve_new_external_ip_address(
+            PROJECT, ip_6_regional, region=region, is_v6=True
+        )
+        # ip6 regional premium
+        reserve_new_external_ip_address(
+            PROJECT, ip_6_regional_premium, region=region, is_premium=True, is_v6=True
+        )
+
+        ips = list_ip_addresses(regional_client, PROJECT, region=region)
+        assert set(ips).issuperset(expected_ips)
+    finally:
+        # cleanup
+        for address in expected_ips:
+            delete_ip_address(regional_client, PROJECT, address, region=region)
