From 2e416592ee83f6b495acd22ff4b9ffb2c4d023e6 Mon Sep 17 00:00:00 2001 From: Maciej Strzelczyk Date: Thu, 15 Sep 2022 15:43:13 +0200 Subject: [PATCH] docs(samples): Adding first sample code + tests (#22) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(samples): Adding basic code samples + tests * Checking something * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Fixing noxfile * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Fixing noxfile with new test detection * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Trying to understand what's wrong * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * use latest post processor image * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Fixing the requirements * Making tests more resilent * Improving tests * Tests no longer use logging * Another fix... * Fixing lint problems * Fixing tests Co-authored-by: Owl Bot Co-authored-by: Anthonios Partheniou --- compute/batch/__init__.py | 13 + compute/batch/noxfile.py | 313 ++++++++++++++++++ compute/batch/noxfile_config.py | 17 + compute/batch/requirements-test.txt | 2 + compute/batch/requirements.txt | 3 + compute/batch/snippets/__init__.py | 0 compute/batch/snippets/create/__init__.py | 0 .../create_with_container_no_mounting.py | 86 +++++ .../create/create_with_script_no_mounting.py | 86 +++++ compute/batch/snippets/delete/delete_job.py | 37 +++ compute/batch/snippets/get/get_job.py | 35 ++ compute/batch/snippets/list/list_jobs.py | 34 ++ compute/batch/snippets/tests/__init__.py | 0 compute/batch/snippets/tests/test_basics.py | 79 +++++ 14 files changed, 705 insertions(+) create mode 100644 compute/batch/__init__.py create mode 100644 compute/batch/noxfile.py create mode 100644 compute/batch/noxfile_config.py create mode 100644 compute/batch/requirements-test.txt create mode 100644 compute/batch/requirements.txt create mode 100644 compute/batch/snippets/__init__.py create mode 100644 compute/batch/snippets/create/__init__.py create mode 100644 compute/batch/snippets/create/create_with_container_no_mounting.py create mode 100644 compute/batch/snippets/create/create_with_script_no_mounting.py create mode 100644 compute/batch/snippets/delete/delete_job.py create mode 100644 compute/batch/snippets/get/get_job.py create mode 100644 compute/batch/snippets/list/list_jobs.py create mode 100644 compute/batch/snippets/tests/__init__.py create mode 100644 compute/batch/snippets/tests/test_basics.py diff --git a/compute/batch/__init__.py b/compute/batch/__init__.py new file mode 100644 index 000000000000..4bbe0ffdb061 --- /dev/null +++ b/compute/batch/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2022 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. diff --git a/compute/batch/noxfile.py b/compute/batch/noxfile.py new file mode 100644 index 000000000000..b053ca568f63 --- /dev/null +++ b/compute/batch/noxfile.py @@ -0,0 +1,313 @@ +# 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 +# +# 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. + +from __future__ import print_function + +import glob +import os +from pathlib import Path +import sys +from typing import Callable, Dict, List, Optional + +import nox + + +# 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 + +BLACK_VERSION = "black==22.3.0" +ISORT_VERSION = "isort==5.10.1" + +# Copy `noxfile_config.py` to your directory and modify it instead. + +# `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": [], + # 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 = {} + +# Update the TEST_CONFIG with the user supplied values. +TEST_CONFIG.update(TEST_CONFIG_OVERRIDE) + + +def get_pytest_env_vars() -> Dict[str, str]: + """Returns a dict for pytest invocation.""" + ret = {} + + # 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 test samples. +ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10"] + +# 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 = os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False) in ( + "True", + "true", +) + +# Error if a python version is missing +nox.options.error_on_missing_interpreters = True + +# +# 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. + """ + 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: + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + python_files = [path for path in os.listdir(".") if path.endswith(".py")] + + session.run("black", *python_files) + + +# +# format = isort + black +# + + +@nox.session +def format(session: nox.sessions.Session) -> None: + """ + Run isort to sort imports. Then run black + to format code to uniform standard. + """ + session.install(BLACK_VERSION, ISORT_VERSION) + python_files = [path for path in os.listdir(".") if path.endswith(".py")] + + # Use the --fss option to sort imports using strict alphabetical order. + # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections + session.run("isort", "--fss", *python_files) + 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: + # check for presence of tests + test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob( + "**/test_*.py", recursive=True + ) + test_list.extend(glob.glob("**/tests", recursive=True)) + + if len(test_list) == 0: + print("No tests found, skipping directory.") + return + + 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.""" + concurrent_args = [] + 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") + with open("requirements.txt") as rfile: + packages = rfile.read() + + 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") + with open("requirements-test.txt") as rtfile: + packages += rtfile.read() + + if INSTALL_LIBRARY_FROM_SOURCE: + session.install("-e", _get_repo_root()) + + if post_install: + post_install(session) + + if "pytest-parallel" in packages: + concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"]) + elif "pytest-xdist" in packages: + concurrent_args.extend(["-n", "auto"]) + + session.run( + "pytest", + *(PYTEST_COMMON_ARGS + session.posargs + concurrent_args), + # 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=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.") + + +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/compute/batch/noxfile_config.py b/compute/batch/noxfile_config.py new file mode 100644 index 000000000000..d27b90b5086b --- /dev/null +++ b/compute/batch/noxfile_config.py @@ -0,0 +1,17 @@ +# Copyright 2022 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. + +TEST_CONFIG_OVERRIDE = { + "gcloud_project_env": "BUILD_SPECIFIC_GCLOUD_PROJECT", +} diff --git a/compute/batch/requirements-test.txt b/compute/batch/requirements-test.txt new file mode 100644 index 000000000000..698bc68df1fb --- /dev/null +++ b/compute/batch/requirements-test.txt @@ -0,0 +1,2 @@ +pytest==7.1.2 +pytest-parallel==0.1.1 diff --git a/compute/batch/requirements.txt b/compute/batch/requirements.txt new file mode 100644 index 000000000000..84827e746394 --- /dev/null +++ b/compute/batch/requirements.txt @@ -0,0 +1,3 @@ +isort==5.10.1 +black==22.6.0 +google-cloud-batch==0.1.2 diff --git a/compute/batch/snippets/__init__.py b/compute/batch/snippets/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/compute/batch/snippets/create/__init__.py b/compute/batch/snippets/create/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/compute/batch/snippets/create/create_with_container_no_mounting.py b/compute/batch/snippets/create/create_with_container_no_mounting.py new file mode 100644 index 000000000000..9c54318f2a57 --- /dev/null +++ b/compute/batch/snippets/create/create_with_container_no_mounting.py @@ -0,0 +1,86 @@ +# Copyright 2022 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. + +# [START batch_create_container_job] +from google.cloud import batch_v1 + + +def create_container_job(project_id: str, region: str, job_name: str) -> batch_v1.Job: + """ + This method shows how to create a sample Batch Job that will run + a simple command inside a container on Cloud Compute instances. + + Args: + project_id: project ID or project number of the Cloud project you want to use. + region: name of the region you want to use to run the job. Regions that are + available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations + job_name: the name of the job that will be created. + It needs to be unique for each project and region pair. + + Returns: + A job object representing the job created. + """ + client = batch_v1.BatchServiceClient() + + # Define what will be done as part of the job. + runnable = batch_v1.Runnable() + runnable.container = batch_v1.Runnable.Container() + runnable.container.image_uri = "gcr.io/google-containers/busybox" + runnable.container.entrypoint = "/bin/sh" + runnable.container.commands = ["-c", "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."] + + # Jobs can be divided into tasks. In this case, we have only one task. + task = batch_v1.TaskSpec() + task.runnables = [runnable] + + # We can specify what resources are requested by each task. + resources = batch_v1.ComputeResource() + resources.cpu_milli = 2000 # in milliseconds per cpu-second. This means the task requires 2 whole CPUs. + resources.memory_mib = 16 # in MiB + task.compute_resource = resources + + task.max_retry_count = 2 + task.max_run_duration = "3600s" + + # Tasks are grouped inside a job using TaskGroups. + group = batch_v1.TaskGroup() + group.task_count = 4 + group.task_spec = task + + # Policies are used to define on what kind of virtual machines the tasks will run on. + # In this case, we tell the system to use "e2-standard-4" machine type. + # Read more about machine types here: https://cloud.google.com/compute/docs/machine-types + policy = batch_v1.AllocationPolicy.InstancePolicy() + policy.machine_type = "e2-standard-4" + instances = batch_v1.AllocationPolicy.InstancePolicyOrTemplate() + instances.policy = policy + allocation_policy = batch_v1.AllocationPolicy() + allocation_policy.instances = [instances] + + job = batch_v1.Job() + job.task_groups = [group] + job.allocation_policy = allocation_policy + job.labels = {"env": "testing", "type": "container"} + # We use Cloud Logging as it's an out of the box available option + job.logs_policy = batch_v1.LogsPolicy() + job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING + + create_request = batch_v1.CreateJobRequest() + create_request.job = job + create_request.job_id = job_name + # The job's parent is the region in which the job will run + create_request.parent = f"projects/{project_id}/locations/{region}" + + return client.create_job(create_request) +# [END batch_create_container_job] diff --git a/compute/batch/snippets/create/create_with_script_no_mounting.py b/compute/batch/snippets/create/create_with_script_no_mounting.py new file mode 100644 index 000000000000..29942cb4d50d --- /dev/null +++ b/compute/batch/snippets/create/create_with_script_no_mounting.py @@ -0,0 +1,86 @@ +# Copyright 2022 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. + +# [START batch_create_script_job] +from google.cloud import batch_v1 + + +def create_script_job(project_id: str, region: str, job_name: str) -> batch_v1.Job: + """ + This method shows how to create a sample Batch Job that will run + a simple command on Cloud Compute instances. + + Args: + project_id: project ID or project number of the Cloud project you want to use. + region: name of the region you want to use to run the job. Regions that are + available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations + job_name: the name of the job that will be created. + It needs to be unique for each project and region pair. + + Returns: + A job object representing the job created. + """ + client = batch_v1.BatchServiceClient() + + # Define what will be done as part of the job. + task = batch_v1.TaskSpec() + runnable = batch_v1.Runnable() + runnable.script = batch_v1.Runnable.Script() + runnable.script.text = "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks." + # You can also run a script from a file. Just remember, that needs to be a script that's + # already on the VM that will be running the job. Using runnable.script.text and runnable.script.path is mutually + # exclusive. + # runnable.script.path = '/tmp/test.sh' + task.runnables = [runnable] + + # We can specify what resources are requested by each task. + resources = batch_v1.ComputeResource() + resources.cpu_milli = 2000 # in milliseconds per cpu-second. This means the task requires 2 whole CPUs. + resources.memory_mib = 16 + task.compute_resource = resources + + task.max_retry_count = 2 + task.max_run_duration = "3600s" + + # Tasks are grouped inside a job using TaskGroups. + group = batch_v1.TaskGroup() + group.task_count = 4 + group.task_spec = task + + # Policies are used to define on what kind of virtual machines the tasks will run on. + # In this case, we tell the system to use "e2-standard-4" machine type. + # Read more about machine types here: https://cloud.google.com/compute/docs/machine-types + allocation_policy = batch_v1.AllocationPolicy() + policy = batch_v1.AllocationPolicy.InstancePolicy() + policy.machine_type = "e2-standard-4" + instances = batch_v1.AllocationPolicy.InstancePolicyOrTemplate() + instances.policy = policy + allocation_policy.instances = [instances] + + job = batch_v1.Job() + job.task_groups = [group] + job.allocation_policy = allocation_policy + job.labels = {"env": "testing", "type": "script"} + # We use Cloud Logging as it's an out of the box available option + job.logs_policy = batch_v1.LogsPolicy() + job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING + + create_request = batch_v1.CreateJobRequest() + create_request.job = job + create_request.job_id = job_name + # The job's parent is the region in which the job will run + create_request.parent = f"projects/{project_id}/locations/{region}" + + return client.create_job(create_request) +# [END batch_create_script_job] diff --git a/compute/batch/snippets/delete/delete_job.py b/compute/batch/snippets/delete/delete_job.py new file mode 100644 index 000000000000..f4ebdcdea0ab --- /dev/null +++ b/compute/batch/snippets/delete/delete_job.py @@ -0,0 +1,37 @@ +# Copyright 2022 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. + +# [START batch_delete_job] +from google.api_core.operation import Operation + +from google.cloud import batch_v1 + + +def delete_job(project_id: str, region: str, job_name: str) -> Operation: + """ + Triggers the deletion of a Job. + + Args: + project_id: project ID or project number of the Cloud project you want to use. + region: name of the region hosts the job. + job_name: the name of the job that you want to delete. + + Returns: + An operation object related to the deletion. You can call `.result()` + on it to wait for its completion. + """ + client = batch_v1.BatchServiceClient() + + return client.delete_job(name=f"projects/{project_id}/locations/{region}/jobs/{job_name}") +# [END batch_delete_job] diff --git a/compute/batch/snippets/get/get_job.py b/compute/batch/snippets/get/get_job.py new file mode 100644 index 000000000000..8dff7376ecf7 --- /dev/null +++ b/compute/batch/snippets/get/get_job.py @@ -0,0 +1,35 @@ +# Copyright 2022 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. + +# [START batch_get_job] + +from google.cloud import batch_v1 + + +def get_job(project_id: str, region: str, job_name: str) -> batch_v1.Job: + """ + Retrieve information about a Batch Job. + + Args: + project_id: project ID or project number of the Cloud project you want to use. + region: name of the region hosts the job. + job_name: the name of the job you want to retrieve information about. + + Returns: + A Job object representing the specified job. + """ + client = batch_v1.BatchServiceClient() + + return client.get_job(name=f"projects/{project_id}/locations/{region}/jobs/{job_name}") +# [END batch_get_job] diff --git a/compute/batch/snippets/list/list_jobs.py b/compute/batch/snippets/list/list_jobs.py new file mode 100644 index 000000000000..77c39b5ce0cf --- /dev/null +++ b/compute/batch/snippets/list/list_jobs.py @@ -0,0 +1,34 @@ +# Copyright 2022 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. +from typing import Iterable + +# [START batch_list_jobs] +from google.cloud import batch_v1 + + +def list_jobs(project_id: str, region: str) -> Iterable[batch_v1.Job]: + """ + Get a list of all jobs defined in given region. + + Args: + project_id: project ID or project number of the Cloud project you want to use. + region: name of the region hosting the jobs. + + Returns: + An iterable collection of Job object. + """ + client = batch_v1.BatchServiceClient() + + return client.list_jobs(parent=f"projects/{project_id}/locations/{region}") +# [END batch_list_jobs] diff --git a/compute/batch/snippets/tests/__init__.py b/compute/batch/snippets/tests/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/compute/batch/snippets/tests/test_basics.py b/compute/batch/snippets/tests/test_basics.py new file mode 100644 index 000000000000..88dfa75c0ef8 --- /dev/null +++ b/compute/batch/snippets/tests/test_basics.py @@ -0,0 +1,79 @@ +# Copyright 2022 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 time +import uuid + + +import google.auth +from google.cloud import batch_v1 +import pytest + +from ..create.create_with_container_no_mounting import create_container_job +from ..create.create_with_script_no_mounting import create_script_job + +from ..delete.delete_job import delete_job +from ..get.get_job import get_job +from ..list.list_jobs import list_jobs + +PROJECT = google.auth.default()[1] +REGION = 'europe-north1' + +TIMEOUT = 600 # 10 minutes + +WAIT_STATES = { + batch_v1.JobStatus.State.STATE_UNSPECIFIED, + batch_v1.JobStatus.State.QUEUED, + batch_v1.JobStatus.State.RUNNING, + batch_v1.JobStatus.State.SCHEDULED, +} + + +@pytest.fixture +def job_name(): + return f"test-job-{uuid.uuid4().hex[:10]}" + + +def _test_body(test_job: batch_v1.Job): + start_time = time.time() + try: + while test_job.status.state in WAIT_STATES: + if time.time() - start_time > TIMEOUT: + pytest.fail("Timed out while waiting for job to complete!") + test_job = get_job(PROJECT, REGION, test_job.name.rsplit('/', maxsplit=1)[1]) + time.sleep(5) + + assert test_job.status.state in (batch_v1.JobStatus.State.SUCCEEDED, + batch_v1.JobStatus.State.DELETION_IN_PROGRESS) + + for job in list_jobs(PROJECT, REGION): + if test_job.uid == job.uid: + break + else: + pytest.fail(f"Couldn't find job {test_job.uid} on the list of jobs.") + finally: + delete_job(PROJECT, REGION, test_job.name.rsplit('/', maxsplit=1)[1]).result() + + for job in list_jobs(PROJECT, REGION): + if job.uid == test_job.uid: + pytest.fail("The test job should be deleted at this point!") + + +def test_script_job(job_name): + job = create_script_job(PROJECT, REGION, job_name) + _test_body(job) + + +def test_container_job(job_name): + job = create_container_job(PROJECT, REGION, job_name) + _test_body(job)