Source code for tests.system.google.cloud.cloud_batch.example_cloud_batch

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you 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.
"""
Example Airflow DAG that uses Google Cloud Batch Operators.
"""

from __future__ import annotations

import os
from datetime import datetime

from google.cloud import batch_v1

from airflow.models.dag import DAG
from airflow.providers.google.cloud.operators.cloud_batch import (
    CloudBatchDeleteJobOperator,
    CloudBatchListJobsOperator,
    CloudBatchListTasksOperator,
    CloudBatchSubmitJobOperator,
)
from airflow.providers.standard.operators.python import PythonOperator
from airflow.utils.trigger_rule import TriggerRule

from providers.tests.system.google import DEFAULT_GCP_SYSTEM_TEST_PROJECT_ID

[docs]PROJECT_ID = os.environ.get("SYSTEM_TESTS_GCP_PROJECT") or DEFAULT_GCP_SYSTEM_TEST_PROJECT_ID
[docs]ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID", "default")
[docs]DAG_ID = "cloud_batch"
[docs]REGION = "us-central1"
[docs]job_name_prefix = "batch"
[docs]job1_name = f"{job_name_prefix}-{DAG_ID}-{ENV_ID}-1".replace("_", "-")
[docs]job2_name = f"{job_name_prefix}-{DAG_ID}-{ENV_ID}-2".replace("_", "-")
[docs]list_jobs_task_name = "list-jobs"
[docs]list_tasks_task_name = "list-tasks"
def _assert_jobs(ti): job_names = ti.xcom_pull(task_ids=[list_jobs_task_name], key="return_value") job_names_str = "" if job_names and len(job_names) > 0: for job in job_names[0]: job_names_str += job["name"].split("/")[-1] + " " assert job1_name in job_names_str assert job2_name in job_names_str def _assert_tasks(ti): tasks_names = ti.xcom_pull(task_ids=[list_tasks_task_name], key="return_value") assert len(tasks_names[0]) == 2 assert "tasks/0" in tasks_names[0][0]["name"] assert "tasks/1" in tasks_names[0][1]["name"] # [START howto_operator_batch_job_creation] def _create_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.", ] task = batch_v1.TaskSpec() task.runnables = [runnable] resources = batch_v1.ComputeResource() resources.cpu_milli = 2000 resources.memory_mib = 16 task.compute_resource = resources task.max_retry_count = 2 group = batch_v1.TaskGroup() group.task_count = 2 group.task_spec = task 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"} job.logs_policy = batch_v1.LogsPolicy() job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING return job # [END howto_operator_batch_job_creation] with DAG( DAG_ID, schedule="@once", start_date=datetime(2021, 1, 1), catchup=False, tags=["example", "batch"], ) as dag: # [START howto_operator_batch_submit_job]
[docs] submit1 = CloudBatchSubmitJobOperator( task_id="submit-job1", project_id=PROJECT_ID, region=REGION, job_name=job1_name, job=_create_job(), dag=dag, deferrable=False, )
# [END howto_operator_batch_submit_job] # [START howto_operator_batch_submit_job_deferrable_mode] submit2 = CloudBatchSubmitJobOperator( task_id="submit-job2", project_id=PROJECT_ID, region=REGION, job_name=job2_name, job=batch_v1.Job.to_dict(_create_job()), dag=dag, deferrable=True, ) # [END howto_operator_batch_submit_job_deferrable_mode] # [START howto_operator_batch_list_tasks] list_tasks = CloudBatchListTasksOperator( task_id=list_tasks_task_name, project_id=PROJECT_ID, region=REGION, job_name=job1_name, dag=dag ) # [END howto_operator_batch_list_tasks] assert_tasks = PythonOperator(task_id="assert-tasks", python_callable=_assert_tasks, dag=dag) # [START howto_operator_batch_list_jobs] list_jobs = CloudBatchListJobsOperator( task_id=list_jobs_task_name, project_id=PROJECT_ID, region=REGION, limit=10, filter=f"name:projects/{PROJECT_ID}/locations/{REGION}/jobs/{job_name_prefix}*", dag=dag, ) # [END howto_operator_batch_list_jobs] get_name = PythonOperator(task_id="assert-jobs", python_callable=_assert_jobs, dag=dag) # [START howto_operator_delete_job] delete_job1 = CloudBatchDeleteJobOperator( task_id="delete-job1", project_id=PROJECT_ID, region=REGION, job_name=job1_name, dag=dag, trigger_rule=TriggerRule.ALL_DONE, ) # [END howto_operator_delete_job] delete_job2 = CloudBatchDeleteJobOperator( task_id="delete-job2", project_id=PROJECT_ID, region=REGION, job_name=job2_name, dag=dag, trigger_rule=TriggerRule.ALL_DONE, ) ([submit1, submit2] >> list_tasks >> assert_tasks >> list_jobs >> get_name >> [delete_job1, delete_job2]) from tests_common.test_utils.watcher import watcher # This test needs watcher in order to properly mark success/failure # when "tearDown" task with trigger rule is part of the DAG list(dag.tasks) >> watcher() from tests_common.test_utils.system_tests import get_test_run # noqa: E402 # Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
[docs]test_run = get_test_run(dag)

Was this entry helpful?