From edbabb225d6874c7b0cbefdd751d1b836a06989c Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Wed, 19 May 2021 15:59:33 +0200 Subject: [PATCH 01/15] feat: Adding code samples and tests for them --- .github/CODEOWNERS | 2 +- CONTRIBUTING.rst | 18 ++ noxfile.py | 24 ++- samples/snippets/README.md | 38 ++++ samples/snippets/quickstart.py | 246 +++++++++++++++++++++++++ samples/snippets/requirements-test.txt | 2 + samples/snippets/requirements.txt | 1 + samples/snippets/test_quickstart.py | 36 ++++ 8 files changed, 364 insertions(+), 3 deletions(-) create mode 100644 samples/snippets/README.md create mode 100644 samples/snippets/quickstart.py create mode 100644 samples/snippets/requirements-test.txt create mode 100644 samples/snippets/requirements.txt create mode 100644 samples/snippets/test_quickstart.py diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d08d98456..779791b16 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -8,4 +8,4 @@ * @googleapis/yoshi-python -/samples/ @googleapis/python-samples-owners \ No newline at end of file +/samples/ m-strzelczyk @googleapis/python-samples-owners \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index afc0cdfb1..c8bd4fe5f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -182,6 +182,24 @@ Build the docs via: $ nox -s docs +************************* +Samples and code snippets +************************* + +Code samples and snippets live in the `samples/` catalogue. Feel free to +provide more examples, but make sure to write tests for those examples. + +The tests will run against a real Google Cloud Project, so you should +configure them just like the System Tests. + +- To run sample tests, you can execute:: + + # Run all system tests + $ nox -s samples-3.8 + + # Run a single sample test + $ nox -s system-3.8 -- -k + ******************************************** Note About ``README`` as it pertains to PyPI ******************************************** diff --git a/noxfile.py b/noxfile.py index ae624edf3..2cd8d65a1 100644 --- a/noxfile.py +++ b/noxfile.py @@ -25,11 +25,12 @@ BLACK_VERSION = "black==19.10b0" -BLACK_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] +BLACK_PATHS = ["docs", "google", "samples", "tests", "noxfile.py", "setup.py"] DEFAULT_PYTHON_VERSION = "3.8" SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"] UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"] +SAMPLE_TEST_PYTHON_VERSIONS = ["3.8", "3.9"] CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() @@ -59,7 +60,7 @@ def lint(session): session.run( "black", "--check", *BLACK_PATHS, ) - session.run("flake8", "google", "tests") + session.run("flake8", "google", "tests", "samples") @nox.session(python=DEFAULT_PYTHON_VERSION) @@ -112,6 +113,25 @@ def unit(session): default(session) +@nox.session(python=SAMPLE_TEST_PYTHON_VERSIONS) +def samples(session): + """Run tests for samples""" + samples_test_folder_path = CURRENT_DIRECTORY / "samples" + requirements_path = ( + CURRENT_DIRECTORY / "samples" / "snippets" / "requirements-test.txt" + ) + + if not samples_test_folder_path.is_dir(): + session.skip("Sample tests not found.") + return + + session.install("-U", "pip", "setuptools") + session.install("-Ur", str(requirements_path)) + session.install("-e", ".") + + session.run("py.test", "--quiet", str(samples_test_folder_path), *session.posargs) + + @nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) def system(session): """Run the system test suite.""" diff --git a/samples/snippets/README.md b/samples/snippets/README.md new file mode 100644 index 000000000..db5baf403 --- /dev/null +++ b/samples/snippets/README.md @@ -0,0 +1,38 @@ +# google-cloud-compute library samples + +These samples demonstrate usage of the google-cloud-compute library to interact +with the Google Compute Engine API. + +## Running the quickstart script + +### Before you begin + +1. If you haven't already, set up a Python Development Environment by following the [python setup guide](https://cloud.google.com/python/setup) and +[create a project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project). + +1. Create a service account with the 'Editor' permissions by following these +[instructions](https://cloud.google.com/iam/docs/creating-managing-service-accounts). + +1. [Download a JSON key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) to use to authenticate your script. + +1. Configure your local environment to use the acquired key. +```bash +export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json +``` + +### Install requirements + +Create a new virtual environment and install the required libraries. +```bash +virtualenv --python python3 name-of-your-virtualenv +source name-of-your-virtualenv/bin/activate +pip install -r requirements.txt +``` + +### Run the demo + +Run the quickstart script, providing it with your project name, a GCP zone and a name for the instance that will be created and destroyed: +```bash +# For example, to create machine "test-instance" in europe-central2-a in project "my-test-project": +python quickstart.py my-test-project europe-central2-a test-instance +``` diff --git a/samples/snippets/quickstart.py b/samples/snippets/quickstart.py new file mode 100644 index 000000000..85f774f97 --- /dev/null +++ b/samples/snippets/quickstart.py @@ -0,0 +1,246 @@ +#!/usr/bin/env python + +# Copyright 2021 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. +""" +A sample script showing how to create, list and delete Google Compute Engine +instances using the google-cloud-compute library. It can be run from command +line to create, list and delete an instance in a given project in a given zone. +""" + +import argparse + +# [START compute_instances_list] +# [START compute_instances_list_all] +# [START compute_instances_create] +# [START compute_instances_delete] +# [START compute_instances_operation_check] +import typing + +import google.cloud.compute_v1 as gce + +# [END compute_instances_operation_check] +# [END compute_instances_delete] +# [END compute_instances_create] +# [END compute_instances_list_all] +# [END compute_instances_list] + + +# [START compute_instances_list] +def list_instances(project: str, zone: str) -> typing.Iterable[gce.Instance]: + """ + Gets a list of instances created in given project in given zone. + Returns an iterable collection of Instance objects. + + Args: + project: Name of the project you want to use. + zone: Name of the zone you want to check, for example: us-west3-b + + Returns: + An iterable collection of Instance objects. + """ + instance_client = gce.InstancesClient() + instance_list = instance_client.list(project=project, zone=zone) + return instance_list + + +# [END compute_instances_list] + + +# [START compute_instances_list_all] +def list_all_instances(project: str) -> typing.Dict[str, typing.Iterable[gce.Instance]]: + """ + Returns a dictionary of all instances present in a project, grouped by their zone. + + Args: + project: Name of the project you want to use. + + Returns: + A dictionary with zone names as keys (in form of "zones/{zone_name}") and + iterable collections of Instance objects as values. + """ + instance_client = gce.InstancesClient() + agg_list = instance_client.aggregated_list(project=project) + all_instances = {} + for zone, response in agg_list: + if response.instances: + all_instances[zone] = response.instances + return all_instances + + +# [END compute_instances_list_all] + + +# [START compute_instances_create] +def create_instance( + project: str, zone: str, machine_type: str, machine_name: str, source_image: str +) -> gce.Instance: + """ + Sends an instance creation request to GCP and waits for it to complete. + + Args: + project: Name of the project you want to use. + zone: Name of the zone you want to use, for example: us-west3-b + machine_type: Machine type you want to create in following format: + "zones/{zone}/machineTypes/{type_name}". For example: + "zones/europe-west3-c/machineTypes/f1-micro" + machine_name: Name of the new machine. + source_image: Path the the disk image you want to use for your boot + disk. This can be one of the public images + (e.g. "projects/debian-cloud/global/images/family/debian-10") + or a private image you have access to. + + Returns: + Instance object. + """ + instance_client = gce.InstancesClient() + + # Every machine requires at least one persistent disk + disk = gce.AttachedDisk() + initialize_params = gce.AttachedDiskInitializeParams() + initialize_params.source_image = ( + source_image # "projects/debian-cloud/global/images/family/debian-10" + ) + initialize_params.disk_size_gb = "10" + disk.initialize_params = initialize_params + disk.auto_delete = True + disk.boot = True + disk.type_ = gce.AttachedDisk.Type.PERSISTENT + + # Every machine needs to be connected to a VPC network. + # The 'default' network is created automatically in every project. + network_interface = gce.NetworkInterface() + network_interface.name = "default" + + # Collecting all the information into the Instance object + instance = gce.Instance() + instance.name = machine_name + instance.disks = [disk] + instance.machine_type = ( + machine_type # "zones/europe-central2-a/machineTypes/n1-standard-8" + ) + instance.network_interfaces = [network_interface] + + # Preparing the InsertInstanceRequest + request = gce.InsertInstanceRequest() + request.zone = zone # "europe-central2-a" + request.project = project # "diregapic-mestiv" + request.instance_resource = instance + + print(f"Creating the {machine_name} instance in {zone}...") + operation = instance_client.insert(request=request) + # wait_result = operation_client.wait(operation=operation.name, zone=zone, project=project) + operation = wait_for_operation(operation, project) + if operation.error: + pass + if operation.warnings: + pass + print(f"Instance {machine_name} created.") + return instance + + +# [END compute_instances_create] + + +# [START compute_instances_delete] +def delete_instance(project: str, zone: str, machine_name: str) -> None: + """ + Sends a delete request to GCP and waits for it to complete. + + Args: + project: Name of the project you want to use. + zone: Name of the zone you want to use, for example: us-west3-b + machine_name: Name of the machine you want to delete. + """ + instance_client = gce.InstancesClient() + + print(f"Deleting {machine_name} from {zone}...") + operation = instance_client.delete( + project=project, zone=zone, instance=machine_name + ) + operation = wait_for_operation(operation, project) + if operation.error: + pass + if operation.warnings: + pass + print(f"Instance {machine_name} deleted.") + return + + +# [END compute_instances_delete] + + +# [START compute_instances_operation_check] +def wait_for_operation(operation: gce.Operation, project: str) -> gce.Operation: + """ + This method waits for an operation to be completed. Calling this function + will block until the operation is finished. + + Args: + operation: The Operation object representing the operation you want to + wait on. + project: Name of the project owning the operation. + + Returns: + Finished Operation object. + """ + kwargs = {"project": project, "operation": operation.name} + if operation.zone: + client = gce.ZoneOperationsClient() + # Operation.zone is a full URL address of a zone, so we need to extract just the name + kwargs["zone"] = operation.zone.rsplit("/", maxsplit=1)[1] + elif operation.region: + client = gce.RegionOperationsClient() + # Operation.region is a full URL address of a zone, so we need to extract just the name + kwargs["region"] = operation.region.rsplit("/", maxsplit=1)[1] + else: + client = gce.GlobalOperationsClient() + return client.wait(**kwargs) + + +# [END compute_instances_operation_check] + + +def main(project: str, zone: str, machine_name: str) -> None: + # You can find the list of available machine types using: + # https://cloud.google.com/sdk/gcloud/reference/compute/machine-types/list + machine_type = f"zones/{zone}/machineTypes/f1-micro" + # You can check the list of available public images using: + # gcloud compute images list + source_image = "projects/debian-cloud/global/images/family/debian-10" + + create_instance(project, zone, machine_type, machine_name, source_image) + + zone_instances = list_instances(project, zone) + print(f"Instances found in {zone}:", ", ".join(i.name for i in zone_instances)) + + all_instances = list_all_instances(project) + print(f"Instances found in project {project}:") + for i_zone, instances in all_instances.items(): + print(f"{i_zone}:", ", ".join(i.name for i in instances)) + + delete_instance(project, zone, machine_name) + + +if __name__ == "__main__": + parser = argparse.ArgumentParser( + description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter, + ) + parser.add_argument("project_id", help="Google Cloud project ID") + parser.add_argument("zone", help="Google Cloud zone name") + parser.add_argument("machine_name", help="Name for the demo machine") + + args = parser.parse_args() + + main(args.project_id, args.zone, args.machine_name) diff --git a/samples/snippets/requirements-test.txt b/samples/snippets/requirements-test.txt new file mode 100644 index 000000000..1de9c6f0d --- /dev/null +++ b/samples/snippets/requirements-test.txt @@ -0,0 +1,2 @@ +google-cloud-compute +pytest \ No newline at end of file diff --git a/samples/snippets/requirements.txt b/samples/snippets/requirements.txt new file mode 100644 index 000000000..8a2294e1e --- /dev/null +++ b/samples/snippets/requirements.txt @@ -0,0 +1 @@ +google-cloud-compute==0.3.0 \ No newline at end of file diff --git a/samples/snippets/test_quickstart.py b/samples/snippets/test_quickstart.py new file mode 100644 index 000000000..253e87be8 --- /dev/null +++ b/samples/snippets/test_quickstart.py @@ -0,0 +1,36 @@ +# Copyright 2021 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 os +import re +import typing +import uuid +import google.auth + +from samples.snippets.quickstart import main + +PROJECT = google.auth.default()[1] +INSTANCE_NAME = "i" + uuid.uuid4().hex[:10] +INSTANCE_ZONE = "europe-central2-b" + + +def test_main(capsys: typing.Any) -> None: + main(PROJECT, INSTANCE_ZONE, INSTANCE_NAME) + + out, _ = capsys.readouterr() + + assert f"Instance {INSTANCE_NAME} created." in out + assert re.search(f"Instances found in {INSTANCE_ZONE}:.+{INSTANCE_NAME}", out) + assert re.search(f"zones/{INSTANCE_ZONE}:.+{INSTANCE_NAME}", out) + assert f"Instance {INSTANCE_NAME} deleted." in out From 5c53f10cac39bd363ba135969184628a198ea1f0 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Wed, 19 May 2021 18:21:49 +0200 Subject: [PATCH 02/15] chore: Remove unused import. --- samples/snippets/test_quickstart.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/snippets/test_quickstart.py b/samples/snippets/test_quickstart.py index 253e87be8..91a2d3642 100644 --- a/samples/snippets/test_quickstart.py +++ b/samples/snippets/test_quickstart.py @@ -12,10 +12,10 @@ # See the License for the specific language governing permissions and # limitations under the License. -import os import re import typing import uuid + import google.auth from samples.snippets.quickstart import main From 9bca18c3c7daf354091d40da78a867acfaa88232 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Thu, 20 May 2021 13:23:19 +0200 Subject: [PATCH 03/15] Update .github/CODEOWNERS Co-authored-by: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 779791b16..ddbdfe696 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -8,4 +8,4 @@ * @googleapis/yoshi-python -/samples/ m-strzelczyk @googleapis/python-samples-owners \ No newline at end of file +/samples/ @m-strzelczyk @googleapis/python-samples-owners From 1178ae0039ff232389af64a760370c8ea3f3c0bc Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Thu, 20 May 2021 14:13:47 +0200 Subject: [PATCH 04/15] chore: Updating samples to meet reviewers suggestions. --- samples/snippets/quickstart.py | 193 ++++++++++++++----------- samples/snippets/requirements-test.txt | 3 +- 2 files changed, 109 insertions(+), 87 deletions(-) diff --git a/samples/snippets/quickstart.py b/samples/snippets/quickstart.py index 85f774f97..fa8d9e3d9 100644 --- a/samples/snippets/quickstart.py +++ b/samples/snippets/quickstart.py @@ -19,8 +19,6 @@ line to create, list and delete an instance in a given project in a given zone. """ -import argparse - # [START compute_instances_list] # [START compute_instances_list_all] # [START compute_instances_create] @@ -28,7 +26,7 @@ # [START compute_instances_operation_check] import typing -import google.cloud.compute_v1 as gce +import google.cloud.compute_v1 as compute_v1 # [END compute_instances_operation_check] # [END compute_instances_delete] @@ -38,20 +36,25 @@ # [START compute_instances_list] -def list_instances(project: str, zone: str) -> typing.Iterable[gce.Instance]: +def list_instances(project_id: str, zone: str) -> typing.Iterable[compute_v1.Instance]: """ Gets a list of instances created in given project in given zone. Returns an iterable collection of Instance objects. Args: - project: Name of the project you want to use. + project_id: ID or number of the project you want to use. zone: Name of the zone you want to check, for example: us-west3-b Returns: An iterable collection of Instance objects. """ - instance_client = gce.InstancesClient() - instance_list = instance_client.list(project=project, zone=zone) + instance_client = compute_v1.InstancesClient() + instance_list = instance_client.list(project=project_id, zone=zone) + + print(f"Instances found in zone {zone}:") + for instance in instance_list: + print(f" - {instance.name} ({instance.machine_type})") + return instance_list @@ -59,56 +62,44 @@ def list_instances(project: str, zone: str) -> typing.Iterable[gce.Instance]: # [START compute_instances_list_all] -def list_all_instances(project: str) -> typing.Dict[str, typing.Iterable[gce.Instance]]: - """ - Returns a dictionary of all instances present in a project, grouped by their zone. - - Args: - project: Name of the project you want to use. - - Returns: - A dictionary with zone names as keys (in form of "zones/{zone_name}") and - iterable collections of Instance objects as values. - """ - instance_client = gce.InstancesClient() - agg_list = instance_client.aggregated_list(project=project) - all_instances = {} - for zone, response in agg_list: - if response.instances: - all_instances[zone] = response.instances - return all_instances - - -# [END compute_instances_list_all] - - -# [START compute_instances_create] def create_instance( - project: str, zone: str, machine_type: str, machine_name: str, source_image: str -) -> gce.Instance: + project_id: str, + zone: str, + instance_name: str, + machine_type: str = "n1-standard-1", + source_image: str = "projects/debian-cloud/global/images/family/debian-10", + network_name: str = "global/networks/default", +) -> compute_v1.Instance: """ Sends an instance creation request to GCP and waits for it to complete. Args: - project: Name of the project you want to use. + project_id: ID or number of the project you want to use. zone: Name of the zone you want to use, for example: us-west3-b + instance_name: Name of the new machine. machine_type: Machine type you want to create in following format: "zones/{zone}/machineTypes/{type_name}". For example: "zones/europe-west3-c/machineTypes/f1-micro" - machine_name: Name of the new machine. + You can find the list of available machine types using: + https://cloud.google.com/sdk/gcloud/reference/compute/machine-types/list source_image: Path the the disk image you want to use for your boot disk. This can be one of the public images (e.g. "projects/debian-cloud/global/images/family/debian-10") or a private image you have access to. + You can check the list of available public images using: + $ gcloud compute images list + network_name: Name of the network you want the new instance to use. + For example: global/networks/default - if you want to use the + default network. Returns: Instance object. """ - instance_client = gce.InstancesClient() + instance_client = compute_v1.InstancesClient() # Every machine requires at least one persistent disk - disk = gce.AttachedDisk() - initialize_params = gce.AttachedDiskInitializeParams() + disk = compute_v1.AttachedDisk() + initialize_params = compute_v1.AttachedDiskInitializeParams() initialize_params.source_image = ( source_image # "projects/debian-cloud/global/images/family/debian-10" ) @@ -116,60 +107,91 @@ def create_instance( disk.initialize_params = initialize_params disk.auto_delete = True disk.boot = True - disk.type_ = gce.AttachedDisk.Type.PERSISTENT + disk.type_ = compute_v1.AttachedDisk.Type.PERSISTENT # Every machine needs to be connected to a VPC network. # The 'default' network is created automatically in every project. - network_interface = gce.NetworkInterface() - network_interface.name = "default" + network_interface = compute_v1.NetworkInterface() + network_interface.name = network_name # Collecting all the information into the Instance object - instance = gce.Instance() - instance.name = machine_name + instance = compute_v1.Instance() + instance.name = instance_name instance.disks = [disk] - instance.machine_type = ( - machine_type # "zones/europe-central2-a/machineTypes/n1-standard-8" - ) + full_machine_type_name = f"zones/{zone}/machineTypes/{machine_type}" + instance.machine_type = full_machine_type_name instance.network_interfaces = [network_interface] # Preparing the InsertInstanceRequest - request = gce.InsertInstanceRequest() - request.zone = zone # "europe-central2-a" - request.project = project # "diregapic-mestiv" + request = compute_v1.InsertInstanceRequest() + request.zone = zone + request.project = project_id request.instance_resource = instance - print(f"Creating the {machine_name} instance in {zone}...") + print(f"Creating the {instance_name} instance in {zone}...") operation = instance_client.insert(request=request) # wait_result = operation_client.wait(operation=operation.name, zone=zone, project=project) - operation = wait_for_operation(operation, project) + operation = wait_for_operation(operation, project_id) if operation.error: pass if operation.warnings: pass - print(f"Instance {machine_name} created.") + print(f"Instance {instance_name} created.") return instance +# [END compute_instances_list_all] + + +def list_all_instances( + project_id: str, +) -> typing.Dict[str, typing.Iterable[compute_v1.Instance]]: + """ + Returns a dictionary of all instances present in a project, grouped by their zone. + + Args: + project_id: ID or number of the project you want to use. + + Returns: + A dictionary with zone names as keys (in form of "zones/{zone_name}") and + iterable collections of Instance objects as values. + """ + instance_client = compute_v1.InstancesClient() + agg_list = instance_client.aggregated_list(project=project_id) + all_instances = {} + print("Instances found:") + for zone, response in agg_list: + if response.instances: + all_instances[zone] = response.instances + print(f" {zone}:") + for instance in response.instances: + print(f" - {instance.name} ({instance.machine_type})") + return all_instances + + +# [START compute_instances_create] + + # [END compute_instances_create] # [START compute_instances_delete] -def delete_instance(project: str, zone: str, machine_name: str) -> None: +def delete_instance(project_id: str, zone: str, machine_name: str) -> None: """ Sends a delete request to GCP and waits for it to complete. Args: - project: Name of the project you want to use. + project_id: ID or number of the project you want to use. zone: Name of the zone you want to use, for example: us-west3-b machine_name: Name of the machine you want to delete. """ - instance_client = gce.InstancesClient() + instance_client = compute_v1.InstancesClient() print(f"Deleting {machine_name} from {zone}...") operation = instance_client.delete( - project=project, zone=zone, instance=machine_name + project=project_id, zone=zone, instance=machine_name ) - operation = wait_for_operation(operation, project) + operation = wait_for_operation(operation, project_id) if operation.error: pass if operation.warnings: @@ -182,7 +204,9 @@ def delete_instance(project: str, zone: str, machine_name: str) -> None: # [START compute_instances_operation_check] -def wait_for_operation(operation: gce.Operation, project: str) -> gce.Operation: +def wait_for_operation( + operation: compute_v1.Operation, project_id: str +) -> compute_v1.Operation: """ This method waits for an operation to be completed. Calling this function will block until the operation is finished. @@ -190,57 +214,56 @@ def wait_for_operation(operation: gce.Operation, project: str) -> gce.Operation: Args: operation: The Operation object representing the operation you want to wait on. - project: Name of the project owning the operation. + project_id: ID or number of the project owning the operation. Returns: Finished Operation object. """ - kwargs = {"project": project, "operation": operation.name} + kwargs = {"project": project_id, "operation": operation.name} if operation.zone: - client = gce.ZoneOperationsClient() + client = compute_v1.ZoneOperationsClient() # Operation.zone is a full URL address of a zone, so we need to extract just the name kwargs["zone"] = operation.zone.rsplit("/", maxsplit=1)[1] elif operation.region: - client = gce.RegionOperationsClient() + client = compute_v1.RegionOperationsClient() # Operation.region is a full URL address of a zone, so we need to extract just the name kwargs["region"] = operation.region.rsplit("/", maxsplit=1)[1] else: - client = gce.GlobalOperationsClient() + client = compute_v1.GlobalOperationsClient() return client.wait(**kwargs) # [END compute_instances_operation_check] -def main(project: str, zone: str, machine_name: str) -> None: - # You can find the list of available machine types using: - # https://cloud.google.com/sdk/gcloud/reference/compute/machine-types/list - machine_type = f"zones/{zone}/machineTypes/f1-micro" - # You can check the list of available public images using: - # gcloud compute images list - source_image = "projects/debian-cloud/global/images/family/debian-10" +def main(project_id: str, zone: str, instance_name: str) -> None: - create_instance(project, zone, machine_type, machine_name, source_image) + create_instance(project_id, zone, instance_name) - zone_instances = list_instances(project, zone) + zone_instances = list_instances(project_id, zone) print(f"Instances found in {zone}:", ", ".join(i.name for i in zone_instances)) - all_instances = list_all_instances(project) - print(f"Instances found in project {project}:") + all_instances = list_all_instances(project_id) + print(f"Instances found in project {project_id}:") for i_zone, instances in all_instances.items(): print(f"{i_zone}:", ", ".join(i.name for i in instances)) - delete_instance(project, zone, machine_name) + delete_instance(project_id, zone, instance_name) if __name__ == "__main__": - parser = argparse.ArgumentParser( - description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter, - ) - parser.add_argument("project_id", help="Google Cloud project ID") - parser.add_argument("zone", help="Google Cloud zone name") - parser.add_argument("machine_name", help="Name for the demo machine") - - args = parser.parse_args() - - main(args.project_id, args.zone, args.machine_name) + import uuid + import google.auth + import google.auth.exceptions + + try: + default_project_id = google.auth.default()[1] + except google.auth.exceptions.DefaultCredentialsError: + print( + "Please use `gcloud auth application-default login` " + "or set GOOGLE_APPLICATION_CREDENTIALS to use this script." + ) + else: + test_instance_name = "i" + uuid.uuid4().hex[:10] + instance_zone = "europe-central2-b" + main(default_project_id, instance_zone, test_instance_name) diff --git a/samples/snippets/requirements-test.txt b/samples/snippets/requirements-test.txt index 1de9c6f0d..11b890fae 100644 --- a/samples/snippets/requirements-test.txt +++ b/samples/snippets/requirements-test.txt @@ -1,2 +1 @@ -google-cloud-compute -pytest \ No newline at end of file +pytest==6.2.4 \ No newline at end of file From 48b5162a8d6b1e1d1d4f30d138097f93fb25336e Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Fri, 21 May 2021 11:43:21 +0200 Subject: [PATCH 05/15] chore: Fixing regions. --- samples/snippets/quickstart.py | 63 ++++++++++++++++------------------ 1 file changed, 30 insertions(+), 33 deletions(-) diff --git a/samples/snippets/quickstart.py b/samples/snippets/quickstart.py index fa8d9e3d9..cae208beb 100644 --- a/samples/snippets/quickstart.py +++ b/samples/snippets/quickstart.py @@ -60,8 +60,37 @@ def list_instances(project_id: str, zone: str) -> typing.Iterable[compute_v1.Ins # [END compute_instances_list] - # [START compute_instances_list_all] +def list_all_instances( + project_id: str, +) -> typing.Dict[str, typing.Iterable[compute_v1.Instance]]: + """ + Returns a dictionary of all instances present in a project, grouped by their zone. + + Args: + project_id: ID or number of the project you want to use. + + Returns: + A dictionary with zone names as keys (in form of "zones/{zone_name}") and + iterable collections of Instance objects as values. + """ + instance_client = compute_v1.InstancesClient() + agg_list = instance_client.aggregated_list(project=project_id) + all_instances = {} + print("Instances found:") + for zone, response in agg_list: + if response.instances: + all_instances[zone] = response.instances + print(f" {zone}:") + for instance in response.instances: + print(f" - {instance.name} ({instance.machine_type})") + return all_instances + + +# [END compute_instances_list_all] + + +# [START compute_instances_create] def create_instance( project_id: str, zone: str, @@ -140,38 +169,6 @@ def create_instance( return instance -# [END compute_instances_list_all] - - -def list_all_instances( - project_id: str, -) -> typing.Dict[str, typing.Iterable[compute_v1.Instance]]: - """ - Returns a dictionary of all instances present in a project, grouped by their zone. - - Args: - project_id: ID or number of the project you want to use. - - Returns: - A dictionary with zone names as keys (in form of "zones/{zone_name}") and - iterable collections of Instance objects as values. - """ - instance_client = compute_v1.InstancesClient() - agg_list = instance_client.aggregated_list(project=project_id) - all_instances = {} - print("Instances found:") - for zone, response in agg_list: - if response.instances: - all_instances[zone] = response.instances - print(f" {zone}:") - for instance in response.instances: - print(f" - {instance.name} ({instance.machine_type})") - return all_instances - - -# [START compute_instances_create] - - # [END compute_instances_create] From 6d0b4276bfed8d2571f5d081e81b61bcd85fdd51 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Mon, 24 May 2021 13:00:38 +0200 Subject: [PATCH 06/15] chore: Adjusting the testing scripts in .kokoro/samples. --- .kokoro/samples/python3.6/common.cfg | 2 +- .kokoro/samples/python3.7/common.cfg | 2 +- .kokoro/samples/python3.8/common.cfg | 2 +- .kokoro/test-samples-impl.sh | 54 +++++++++++++--------------- 4 files changed, 27 insertions(+), 33 deletions(-) diff --git a/.kokoro/samples/python3.6/common.cfg b/.kokoro/samples/python3.6/common.cfg index 10658818e..c620cd085 100644 --- a/.kokoro/samples/python3.6/common.cfg +++ b/.kokoro/samples/python3.6/common.cfg @@ -10,7 +10,7 @@ action { # Specify which tests to run env_vars: { key: "RUN_TESTS_SESSION" - value: "py-3.6" + value: "samples-3.6" } # Declare build specific Cloud project. diff --git a/.kokoro/samples/python3.7/common.cfg b/.kokoro/samples/python3.7/common.cfg index cd1580266..1bd70bd6a 100644 --- a/.kokoro/samples/python3.7/common.cfg +++ b/.kokoro/samples/python3.7/common.cfg @@ -10,7 +10,7 @@ action { # Specify which tests to run env_vars: { key: "RUN_TESTS_SESSION" - value: "py-3.7" + value: "samples-3.7" } # Declare build specific Cloud project. diff --git a/.kokoro/samples/python3.8/common.cfg b/.kokoro/samples/python3.8/common.cfg index af9384375..96fa78aa5 100644 --- a/.kokoro/samples/python3.8/common.cfg +++ b/.kokoro/samples/python3.8/common.cfg @@ -10,7 +10,7 @@ action { # Specify which tests to run env_vars: { key: "RUN_TESTS_SESSION" - value: "py-3.8" + value: "samples-3.8" } # Declare build specific Cloud project. diff --git a/.kokoro/test-samples-impl.sh b/.kokoro/test-samples-impl.sh index cf5de74c1..dd57c7380 100755 --- a/.kokoro/test-samples-impl.sh +++ b/.kokoro/test-samples-impl.sh @@ -64,38 +64,32 @@ set +e # Use RTN to return a non-zero value if the test fails. RTN=0 ROOT=$(pwd) -# Find all requirements.txt in the samples directory (may break on whitespace). -for file in samples/**/requirements.txt; do - cd "$ROOT" - # Navigate to the project folder. - file=$(dirname "$file") - cd "$file" - - echo "------------------------------------------------------------" - echo "- testing $file" - echo "------------------------------------------------------------" - - # Use nox to execute the tests for the project. - python3.6 -m nox -s "$RUN_TESTS_SESSION" - EXIT=$? - - # If this is a periodic build, send the test log to the FlakyBot. - # See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot. - if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then - chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot - $KOKORO_GFILE_DIR/linux_amd64/flakybot - fi - - if [[ $EXIT -ne 0 ]]; then - RTN=1 - echo -e "\n Testing failed: Nox returned a non-zero exit code. \n" - else - echo -e "\n Testing completed.\n" - fi - -done + cd "$ROOT" +echo "------------------------------------------------------------" +echo "- testing $file" +echo "------------------------------------------------------------" + +# Use nox to execute the tests for the project. +python3.6 -m nox -s "$RUN_TESTS_SESSION" +EXIT=$? + +# If this is a periodic build, send the test log to the FlakyBot. +# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot. +if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then + chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot + $KOKORO_GFILE_DIR/linux_amd64/flakybot +fi + +if [[ $EXIT -ne 0 ]]; then + RTN=1 + echo -e "\n Testing failed: Nox returned a non-zero exit code. \n" +else + echo -e "\n Testing completed.\n" +fi + + # Workaround for Kokoro permissions issue: delete secrets rm testing/{test-env.sh,client-secrets.json,service-account.json} From 3348ef4b43ecd8da69527064ce74fe0918bae530 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Mon, 24 May 2021 13:08:10 +0200 Subject: [PATCH 07/15] Revert "chore: Adjusting the testing scripts in .kokoro/samples." This reverts commit 6d0b4276 --- .kokoro/samples/python3.6/common.cfg | 2 +- .kokoro/samples/python3.7/common.cfg | 2 +- .kokoro/samples/python3.8/common.cfg | 2 +- .kokoro/test-samples-impl.sh | 54 +++++++++++++++------------- 4 files changed, 33 insertions(+), 27 deletions(-) diff --git a/.kokoro/samples/python3.6/common.cfg b/.kokoro/samples/python3.6/common.cfg index c620cd085..10658818e 100644 --- a/.kokoro/samples/python3.6/common.cfg +++ b/.kokoro/samples/python3.6/common.cfg @@ -10,7 +10,7 @@ action { # Specify which tests to run env_vars: { key: "RUN_TESTS_SESSION" - value: "samples-3.6" + value: "py-3.6" } # Declare build specific Cloud project. diff --git a/.kokoro/samples/python3.7/common.cfg b/.kokoro/samples/python3.7/common.cfg index 1bd70bd6a..cd1580266 100644 --- a/.kokoro/samples/python3.7/common.cfg +++ b/.kokoro/samples/python3.7/common.cfg @@ -10,7 +10,7 @@ action { # Specify which tests to run env_vars: { key: "RUN_TESTS_SESSION" - value: "samples-3.7" + value: "py-3.7" } # Declare build specific Cloud project. diff --git a/.kokoro/samples/python3.8/common.cfg b/.kokoro/samples/python3.8/common.cfg index 96fa78aa5..af9384375 100644 --- a/.kokoro/samples/python3.8/common.cfg +++ b/.kokoro/samples/python3.8/common.cfg @@ -10,7 +10,7 @@ action { # Specify which tests to run env_vars: { key: "RUN_TESTS_SESSION" - value: "samples-3.8" + value: "py-3.8" } # Declare build specific Cloud project. diff --git a/.kokoro/test-samples-impl.sh b/.kokoro/test-samples-impl.sh index dd57c7380..cf5de74c1 100755 --- a/.kokoro/test-samples-impl.sh +++ b/.kokoro/test-samples-impl.sh @@ -64,32 +64,38 @@ set +e # Use RTN to return a non-zero value if the test fails. RTN=0 ROOT=$(pwd) - +# Find all requirements.txt in the samples directory (may break on whitespace). +for file in samples/**/requirements.txt; do + cd "$ROOT" + # Navigate to the project folder. + file=$(dirname "$file") + cd "$file" + + echo "------------------------------------------------------------" + echo "- testing $file" + echo "------------------------------------------------------------" + + # Use nox to execute the tests for the project. + python3.6 -m nox -s "$RUN_TESTS_SESSION" + EXIT=$? + + # If this is a periodic build, send the test log to the FlakyBot. + # See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot. + if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then + chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot + $KOKORO_GFILE_DIR/linux_amd64/flakybot + fi + + if [[ $EXIT -ne 0 ]]; then + RTN=1 + echo -e "\n Testing failed: Nox returned a non-zero exit code. \n" + else + echo -e "\n Testing completed.\n" + fi + +done cd "$ROOT" -echo "------------------------------------------------------------" -echo "- testing $file" -echo "------------------------------------------------------------" - -# Use nox to execute the tests for the project. -python3.6 -m nox -s "$RUN_TESTS_SESSION" -EXIT=$? - -# If this is a periodic build, send the test log to the FlakyBot. -# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot. -if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then - chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot - $KOKORO_GFILE_DIR/linux_amd64/flakybot -fi - -if [[ $EXIT -ne 0 ]]; then - RTN=1 - echo -e "\n Testing failed: Nox returned a non-zero exit code. \n" -else - echo -e "\n Testing completed.\n" -fi - - # Workaround for Kokoro permissions issue: delete secrets rm testing/{test-env.sh,client-secrets.json,service-account.json} From 1a36afa717fec506300021413fb9dec2df229f09 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Mon, 24 May 2021 13:23:30 +0200 Subject: [PATCH 08/15] chore: Moving samples tests to dedicated noxfile.py. --- noxfile.py | 24 +----------- samples/snippets/noxfile.py | 78 +++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 22 deletions(-) create mode 100644 samples/snippets/noxfile.py diff --git a/noxfile.py b/noxfile.py index 2cd8d65a1..ae624edf3 100644 --- a/noxfile.py +++ b/noxfile.py @@ -25,12 +25,11 @@ BLACK_VERSION = "black==19.10b0" -BLACK_PATHS = ["docs", "google", "samples", "tests", "noxfile.py", "setup.py"] +BLACK_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] DEFAULT_PYTHON_VERSION = "3.8" SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"] UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"] -SAMPLE_TEST_PYTHON_VERSIONS = ["3.8", "3.9"] CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() @@ -60,7 +59,7 @@ def lint(session): session.run( "black", "--check", *BLACK_PATHS, ) - session.run("flake8", "google", "tests", "samples") + session.run("flake8", "google", "tests") @nox.session(python=DEFAULT_PYTHON_VERSION) @@ -113,25 +112,6 @@ def unit(session): default(session) -@nox.session(python=SAMPLE_TEST_PYTHON_VERSIONS) -def samples(session): - """Run tests for samples""" - samples_test_folder_path = CURRENT_DIRECTORY / "samples" - requirements_path = ( - CURRENT_DIRECTORY / "samples" / "snippets" / "requirements-test.txt" - ) - - if not samples_test_folder_path.is_dir(): - session.skip("Sample tests not found.") - return - - session.install("-U", "pip", "setuptools") - session.install("-Ur", str(requirements_path)) - session.install("-e", ".") - - session.run("py.test", "--quiet", str(samples_test_folder_path), *session.posargs) - - @nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS) def system(session): """Run the system test suite.""" diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py new file mode 100644 index 000000000..ccde0d80f --- /dev/null +++ b/samples/snippets/noxfile.py @@ -0,0 +1,78 @@ +# -*- coding: utf-8 -*- +# +# Copyright 2021 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 +# +# https://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. + +# Generated by synthtool. DO NOT EDIT! + +from __future__ import absolute_import + +import pathlib + +import nox + +BLACK_VERSION = "black==19.10b0" + +DEFAULT_PYTHON_VERSION = "3.8" +SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"] +UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"] +SAMPLE_TEST_PYTHON_VERSIONS = ["3.8", "3.9"] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + + +nox.options.sessions = [ + "lint", + "blacken", + "py", +] + + +# Error if a python version is missing +nox.options.error_on_missing_interpreters = True + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", "--check", ".", + ) + session.run("flake8", ".") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", ".", + ) + + +@nox.session(python=SAMPLE_TEST_PYTHON_VERSIONS) +def py(session): + """Run tests for samples""" + + session.install("-U", "pip", "setuptools") + session.install("-Ur", "requirements.txt") + session.install("-Ur", "requirements-test.txt") + session.install("-e", "../../") + + session.run("py.test", "--quiet", ".", *session.posargs) From f2a02f17ba9b1c1f33036149fac54af6225e5b93 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Mon, 24 May 2021 13:48:21 +0200 Subject: [PATCH 09/15] chore: Adding 3.6 and 3.7 Python versions to samples noxfile.py --- samples/snippets/noxfile.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py index ccde0d80f..12b73fb64 100644 --- a/samples/snippets/noxfile.py +++ b/samples/snippets/noxfile.py @@ -25,9 +25,7 @@ BLACK_VERSION = "black==19.10b0" DEFAULT_PYTHON_VERSION = "3.8" -SYSTEM_TEST_PYTHON_VERSIONS = ["3.8"] -UNIT_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"] -SAMPLE_TEST_PYTHON_VERSIONS = ["3.8", "3.9"] +SAMPLE_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"] CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() From 0107c58973d66895c0039992225d0b805371adcc Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Tue, 25 May 2021 07:48:51 +0200 Subject: [PATCH 10/15] chore: Updating the Samples section to reflect new testing setup. --- CONTRIBUTING.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c8bd4fe5f..cefabb377 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -188,17 +188,23 @@ Samples and code snippets Code samples and snippets live in the `samples/` catalogue. Feel free to provide more examples, but make sure to write tests for those examples. +Each folder containing example code requires its own `noxfile.py` script +which automates testing. If you decide to create a new folder, you can +base it on the `samples/snippets` folder (providing `noxfile.py` and +the requirements files). The tests will run against a real Google Cloud Project, so you should configure them just like the System Tests. - To run sample tests, you can execute:: - # Run all system tests - $ nox -s samples-3.8 + # Run all tests in a folder + $ cd samples/snippets + $ nox -s py-3.8 # Run a single sample test - $ nox -s system-3.8 -- -k + $ cd samples/snippets + $ nox -s py-3.8 -- -k ******************************************** Note About ``README`` as it pertains to PyPI From 8f0e8698a5d806ec5378044e78280596ec1d339a Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Tue, 25 May 2021 08:07:52 +0200 Subject: [PATCH 11/15] chore: Updating the Samples README. --- samples/snippets/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/samples/snippets/README.md b/samples/snippets/README.md index db5baf403..05bc9cd1c 100644 --- a/samples/snippets/README.md +++ b/samples/snippets/README.md @@ -31,8 +31,8 @@ pip install -r requirements.txt ### Run the demo -Run the quickstart script, providing it with your project name, a GCP zone and a name for the instance that will be created and destroyed: +Run the quickstart script, it will create and destroy a `n1-standard-1` +type machine in the `europe-central2-b` zone. ```bash -# For example, to create machine "test-instance" in europe-central2-a in project "my-test-project": -python quickstart.py my-test-project europe-central2-a test-instance +python quickstart.py ``` From 80405887171999d9701062192a0e63c21f827e79 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Thu, 27 May 2021 20:05:49 +0000 Subject: [PATCH 12/15] chore: add standardized samples noxfile --- samples/snippets/noxfile.py | 267 ++++++++++++++++++++++++++++++------ synth.py | 47 ++++--- 2 files changed, 251 insertions(+), 63 deletions(-) diff --git a/samples/snippets/noxfile.py b/samples/snippets/noxfile.py index 12b73fb64..5ff9e1db5 100644 --- a/samples/snippets/noxfile.py +++ b/samples/snippets/noxfile.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- -# -# Copyright 2021 Google LLC +# Copyright 2019 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 # -# https://www.apache.org/licenses/LICENSE-2.0 +# 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, @@ -14,63 +12,248 @@ # See the License for the specific language governing permissions and # limitations under the License. -# Generated by synthtool. DO NOT EDIT! - -from __future__ import absolute_import +from __future__ import print_function -import pathlib +import os +from pathlib import Path +import sys +from typing import Callable, Dict, List, Optional import nox -BLACK_VERSION = "black==19.10b0" -DEFAULT_PYTHON_VERSION = "3.8" -SAMPLE_TEST_PYTHON_VERSIONS = ["3.6", "3.7", "3.8", "3.9"] +# WARNING - WARNING - WARNING - WARNING - WARNING +# WARNING - WARNING - WARNING - WARNING - WARNING +# DO NOT EDIT THIS FILE EVER! +# WARNING - WARNING - WARNING - WARNING - WARNING +# WARNING - WARNING - WARNING - WARNING - WARNING -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() +# Copy `noxfile_config.py` to your directory and modify it instead. -nox.options.sessions = [ - "lint", - "blacken", - "py", -] +# `TEST_CONFIG` dict is a configuration hook that allows users to +# modify the test configurations. The values here should be in sync +# with `noxfile_config.py`. Users will copy `noxfile_config.py` into +# their directory and modify it. + +TEST_CONFIG = { + # You can opt out from the test for specific Python versions. + 'ignored_versions': ["2.7"], + + # Old samples are opted out of enforcing Python type hints + # All new samples should feature them + 'enforce_type_hints': False, + + # An envvar key for determining the project id to use. Change it + # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a + # build specific Cloud project. You can also use your own string + # to use your own Cloud project. + 'gcloud_project_env': 'GOOGLE_CLOUD_PROJECT', + # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT', + # If you need to use a specific version of pip, + # change pip_version_override to the string representation + # of the version number, for example, "20.2.4" + "pip_version_override": None, + # A dictionary you want to inject into your test. Don't put any + # secrets here. These values will override predefined values. + 'envs': {}, +} + +try: + # Ensure we can import noxfile_config in the project's directory. + sys.path.append('.') + from noxfile_config import TEST_CONFIG_OVERRIDE +except ImportError as e: + print("No user noxfile_config found: detail: {}".format(e)) + TEST_CONFIG_OVERRIDE = {} -# Error if a python version is missing -nox.options.error_on_missing_interpreters = True +# Update the TEST_CONFIG with the user supplied values. +TEST_CONFIG.update(TEST_CONFIG_OVERRIDE) -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. +def get_pytest_env_vars() -> Dict[str, str]: + """Returns a dict for pytest invocation.""" + ret = {} - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. + # Override the GCLOUD_PROJECT and the alias. + env_key = TEST_CONFIG['gcloud_project_env'] + # This should error out if not set. + ret['GOOGLE_CLOUD_PROJECT'] = os.environ[env_key] + + # Apply user supplied envs. + ret.update(TEST_CONFIG['envs']) + return ret + + +# DO NOT EDIT - automatically generated. +# All versions used to tested samples. +ALL_VERSIONS = ["2.7", "3.6", "3.7", "3.8", "3.9"] + +# Any default versions that should be ignored. +IGNORED_VERSIONS = TEST_CONFIG['ignored_versions'] + +TESTED_VERSIONS = sorted([v for v in ALL_VERSIONS if v not in IGNORED_VERSIONS]) + +INSTALL_LIBRARY_FROM_SOURCE = bool(os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False)) +# +# Style Checks +# + + +def _determine_local_import_names(start_dir: str) -> List[str]: + """Determines all import names that should be considered "local". + + This is used when running the linter to insure that import order is + properly checked. """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", "--check", ".", - ) - session.run("flake8", ".") + file_ext_pairs = [os.path.splitext(path) for path in os.listdir(start_dir)] + return [ + basename + for basename, extension in file_ext_pairs + if extension == ".py" + or os.path.isdir(os.path.join(start_dir, basename)) + and basename not in ("__pycache__") + ] + + +# Linting with flake8. +# +# We ignore the following rules: +# E203: whitespace before ‘:’ +# E266: too many leading ‘#’ for block comment +# E501: line too long +# I202: Additional newline in a section of imports +# +# We also need to specify the rules which are ignored by default: +# ['E226', 'W504', 'E126', 'E123', 'W503', 'E24', 'E704', 'E121'] +FLAKE8_COMMON_ARGS = [ + "--show-source", + "--builtin=gettext", + "--max-complexity=20", + "--import-order-style=google", + "--exclude=.nox,.cache,env,lib,generated_pb2,*_pb2.py,*_pb2_grpc.py", + "--ignore=E121,E123,E126,E203,E226,E24,E266,E501,E704,W503,W504,I202", + "--max-line-length=88", +] + + +@nox.session +def lint(session: nox.sessions.Session) -> None: + if not TEST_CONFIG['enforce_type_hints']: + session.install("flake8", "flake8-import-order") + else: + session.install("flake8", "flake8-import-order", "flake8-annotations") + local_names = _determine_local_import_names(".") + args = FLAKE8_COMMON_ARGS + [ + "--application-import-names", + ",".join(local_names), + "." + ] + session.run("flake8", *args) +# +# Black +# + + +@nox.session +def blacken(session: nox.sessions.Session) -> None: + session.install("black") + python_files = [path for path in os.listdir(".") if path.endswith(".py")] + + session.run("black", *python_files) + +# +# Sample Tests +# + + +PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"] + + +def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None: + if TEST_CONFIG["pip_version_override"]: + pip_version = TEST_CONFIG["pip_version_override"] + session.install(f"pip=={pip_version}") + """Runs py.test for a particular project.""" + if os.path.exists("requirements.txt"): + if os.path.exists("constraints.txt"): + session.install("-r", "requirements.txt", "-c", "constraints.txt") + else: + session.install("-r", "requirements.txt") + + if os.path.exists("requirements-test.txt"): + if os.path.exists("constraints-test.txt"): + session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt") + else: + session.install("-r", "requirements-test.txt") + + if INSTALL_LIBRARY_FROM_SOURCE: + session.install("-e", _get_repo_root()) + + if post_install: + post_install(session) -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) session.run( - "black", ".", + "pytest", + *(PYTEST_COMMON_ARGS + session.posargs), + # Pytest will return 5 when no tests are collected. This can happen + # on travis where slow and flaky tests are excluded. + # See http://doc.pytest.org/en/latest/_modules/_pytest/main.html + success_codes=[0, 5], + env=get_pytest_env_vars() ) -@nox.session(python=SAMPLE_TEST_PYTHON_VERSIONS) -def py(session): - """Run tests for samples""" +@nox.session(python=ALL_VERSIONS) +def py(session: nox.sessions.Session) -> None: + """Runs py.test for a sample using the specified version of Python.""" + if session.python in TESTED_VERSIONS: + _session_tests(session) + else: + session.skip("SKIPPED: {} tests are disabled for this sample.".format( + session.python + )) + + +# +# Readmegen +# + + +def _get_repo_root() -> Optional[str]: + """ Returns the root folder of the project. """ + # Get root of this repository. Assume we don't have directories nested deeper than 10 items. + p = Path(os.getcwd()) + for i in range(10): + if p is None: + break + if Path(p / ".git").exists(): + return str(p) + # .git is not available in repos cloned via Cloud Build + # setup.py is always in the library's root, so use that instead + # https://github.com/googleapis/synthtool/issues/792 + if Path(p / "setup.py").exists(): + return str(p) + p = p.parent + raise Exception("Unable to detect repository root.") - session.install("-U", "pip", "setuptools") - session.install("-Ur", "requirements.txt") - session.install("-Ur", "requirements-test.txt") - session.install("-e", "../../") - session.run("py.test", "--quiet", ".", *session.posargs) +GENERATED_READMES = sorted([x for x in Path(".").rglob("*.rst.in")]) + + +@nox.session +@nox.parametrize("path", GENERATED_READMES) +def readmegen(session: nox.sessions.Session, path: str) -> None: + """(Re-)generates the readme for a sample.""" + session.install("jinja2", "pyyaml") + dir_ = os.path.dirname(path) + + if os.path.exists(os.path.join(dir_, "requirements.txt")): + session.install("-r", os.path.join(dir_, "requirements.txt")) + + in_file = os.path.join(dir_, "README.rst.in") + session.run( + "python", _get_repo_root() + "/scripts/readme-gen/readme_gen.py", in_file + ) diff --git a/synth.py b/synth.py index 44f47480b..ec8db64be 100644 --- a/synth.py +++ b/synth.py @@ -23,27 +23,32 @@ gapic = gcp.GAPICBazel() common = gcp.CommonTemplates() -# ---------------------------------------------------------------------------- -# Generate Compute Engine GAPIC layer -# ---------------------------------------------------------------------------- -versions = ["v1"] -for version in versions: - library = gapic.py_library( - service="compute", - version="v1", - bazel_target="//google/cloud/compute/v1:compute-v1-py", - diregapic=True, - ) - s.move(library, excludes=["setup.py", "README.rst", "docs/index.rst", "docs/multiprocessing.rst", "scripts/fixup*"]) - -# ---------------------------------------------------------------------------- -# Add templated files -# ---------------------------------------------------------------------------- - -templated_files = common.py_library(cov_level=99, microgenerator=True) -s.move( - templated_files, excludes=[".coveragerc"] # the microgenerator has a good coveragerc file -) +# # ---------------------------------------------------------------------------- +# # Generate Compute Engine GAPIC layer +# # ---------------------------------------------------------------------------- +# versions = ["v1"] +# for version in versions: +# library = gapic.py_library( +# service="compute", +# version="v1", +# bazel_target="//google/cloud/compute/v1:compute-v1-py", +# diregapic=True, +# ) +# s.move(library, excludes=["setup.py", "README.rst", "docs/index.rst", "docs/multiprocessing.rst", "scripts/fixup*"]) + +# # ---------------------------------------------------------------------------- +# # Add templated files +# # ---------------------------------------------------------------------------- + +# templated_files = common.py_library(cov_level=99, microgenerator=True) +# s.move( +# templated_files, excludes=[".coveragerc"] # the microgenerator has a good coveragerc file +# ) + +# -------------------------------------------------------------------------- +# Samples templates +# -------------------------------------------------------------------------- +python.py_samples() # Don't treat docs warnings as errors # A few errors like: From 4c9b0fb19e9e93f3f840fe892804e47da2b1d778 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim Date: Thu, 27 May 2021 20:08:44 +0000 Subject: [PATCH 13/15] chore: uncomment sections in synth.py --- synth.py | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/synth.py b/synth.py index ec8db64be..addd7a3d3 100644 --- a/synth.py +++ b/synth.py @@ -23,27 +23,27 @@ gapic = gcp.GAPICBazel() common = gcp.CommonTemplates() -# # ---------------------------------------------------------------------------- -# # Generate Compute Engine GAPIC layer -# # ---------------------------------------------------------------------------- -# versions = ["v1"] -# for version in versions: -# library = gapic.py_library( -# service="compute", -# version="v1", -# bazel_target="//google/cloud/compute/v1:compute-v1-py", -# diregapic=True, -# ) -# s.move(library, excludes=["setup.py", "README.rst", "docs/index.rst", "docs/multiprocessing.rst", "scripts/fixup*"]) - -# # ---------------------------------------------------------------------------- -# # Add templated files -# # ---------------------------------------------------------------------------- - -# templated_files = common.py_library(cov_level=99, microgenerator=True) -# s.move( -# templated_files, excludes=[".coveragerc"] # the microgenerator has a good coveragerc file -# ) +# ---------------------------------------------------------------------------- +# Generate Compute Engine GAPIC layer +# ---------------------------------------------------------------------------- +versions = ["v1"] +for version in versions: + library = gapic.py_library( + service="compute", + version="v1", + bazel_target="//google/cloud/compute/v1:compute-v1-py", + diregapic=True, + ) + s.move(library, excludes=["setup.py", "README.rst", "docs/index.rst", "docs/multiprocessing.rst", "scripts/fixup*"]) + +# ---------------------------------------------------------------------------- +# Add templated files +# ---------------------------------------------------------------------------- + +templated_files = common.py_library(cov_level=99, microgenerator=True) +s.move( + templated_files, excludes=[".coveragerc"] # the microgenerator has a good coveragerc file +) # -------------------------------------------------------------------------- # Samples templates From 572244a862e22cfecd6fe752967ee7003b572f15 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Tue, 1 Jun 2021 14:08:12 +0200 Subject: [PATCH 14/15] chore: Changing the waiting for operation part. --- samples/snippets/quickstart.py | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/samples/snippets/quickstart.py b/samples/snippets/quickstart.py index cae208beb..1f0435878 100644 --- a/samples/snippets/quickstart.py +++ b/samples/snippets/quickstart.py @@ -19,20 +19,22 @@ line to create, list and delete an instance in a given project in a given zone. """ -# [START compute_instances_list] -# [START compute_instances_list_all] # [START compute_instances_create] # [START compute_instances_delete] +import sys + +# [START compute_instances_list] +# [START compute_instances_list_all] # [START compute_instances_operation_check] import typing import google.cloud.compute_v1 as compute_v1 # [END compute_instances_operation_check] -# [END compute_instances_delete] -# [END compute_instances_create] # [END compute_instances_list_all] # [END compute_instances_list] +# [END compute_instances_delete] +# [END compute_instances_create] # [START compute_instances_list] @@ -159,12 +161,15 @@ def create_instance( print(f"Creating the {instance_name} instance in {zone}...") operation = instance_client.insert(request=request) - # wait_result = operation_client.wait(operation=operation.name, zone=zone, project=project) - operation = wait_for_operation(operation, project_id) + if operation.status == compute_v1.Operation.Status.RUNNING: + operation_client = compute_v1.ZoneOperationsClient() + operation = operation_client.wait( + operation=operation.name, zone=zone, project=project_id + ) if operation.error: - pass + print("Error during creation:", operation.error, file=sys.stderr) if operation.warnings: - pass + print("Warning during creation:", operation.warnings, file=sys.stderr) print(f"Instance {instance_name} created.") return instance @@ -188,11 +193,15 @@ def delete_instance(project_id: str, zone: str, machine_name: str) -> None: operation = instance_client.delete( project=project_id, zone=zone, instance=machine_name ) - operation = wait_for_operation(operation, project_id) + if operation.status == compute_v1.Operation.Status.RUNNING: + operation_client = compute_v1.ZoneOperationsClient() + operation = operation_client.wait( + operation=operation.name, zone=zone, project=project_id + ) if operation.error: - pass + print("Error during deletion:", operation.error, file=sys.stderr) if operation.warnings: - pass + print("Warning during deletion:", operation.warnings, file=sys.stderr) print(f"Instance {machine_name} deleted.") return From c1670b9ce4ef4fb8807c5a91e4d0b768e7dc5a35 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Thu, 3 Jun 2021 14:58:09 +0200 Subject: [PATCH 15/15] chore: Minor changes based on review. * README suggests using `gcloud auth application-default login` which is safer than Service Account key. * The name of created instance now starts with "quickstart-". * Changed one variable name. --- samples/snippets/README.md | 11 ++--------- samples/snippets/quickstart.py | 4 ++-- 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/samples/snippets/README.md b/samples/snippets/README.md index 05bc9cd1c..966f4dfe9 100644 --- a/samples/snippets/README.md +++ b/samples/snippets/README.md @@ -10,15 +10,8 @@ with the Google Compute Engine API. 1. If you haven't already, set up a Python Development Environment by following the [python setup guide](https://cloud.google.com/python/setup) and [create a project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project). -1. Create a service account with the 'Editor' permissions by following these -[instructions](https://cloud.google.com/iam/docs/creating-managing-service-accounts). - -1. [Download a JSON key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) to use to authenticate your script. - -1. Configure your local environment to use the acquired key. -```bash -export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json -``` +1. Use `gcloud auth application-default login` to allow the script to authenticate using +your credentials to the Google Cloud APIs. ### Install requirements diff --git a/samples/snippets/quickstart.py b/samples/snippets/quickstart.py index 1f0435878..478a5f707 100644 --- a/samples/snippets/quickstart.py +++ b/samples/snippets/quickstart.py @@ -270,6 +270,6 @@ def main(project_id: str, zone: str, instance_name: str) -> None: "or set GOOGLE_APPLICATION_CREDENTIALS to use this script." ) else: - test_instance_name = "i" + uuid.uuid4().hex[:10] + instance_name = "quickstart-" + uuid.uuid4().hex[:10] instance_zone = "europe-central2-b" - main(default_project_id, instance_zone, test_instance_name) + main(default_project_id, instance_zone, instance_name)