Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correctly template Glue Jobs create_job_kwargs arg #28403

Merged
merged 3 commits into from
Dec 18, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions airflow/providers/amazon/aws/operators/glue.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class GlueJobOperator(BaseOperator):
"job_name",
"script_location",
"script_args",
"create_job_kwargs",
"s3_bucket",
"iam_role_name",
)
Expand Down
63 changes: 52 additions & 11 deletions tests/providers/amazon/aws/operators/test_glue.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,62 @@
# under the License.
from __future__ import annotations

import copy
from unittest import mock

import pytest

from airflow.configuration import conf
from airflow.models import DAG, DagRun, TaskInstance
from airflow.providers.amazon.aws.hooks.glue import GlueJobHook
from airflow.providers.amazon.aws.hooks.s3 import S3Hook
from airflow.providers.amazon.aws.operators.glue import GlueJobOperator
from airflow.utils import timezone

TASK_ID = "test_glue_operator"
DAG_ID = "test_dag_id"
JOB_NAME = "test_job_name"
DEFAULT_DATE = timezone.datetime(2017, 1, 1)

BASE_LOCATION = "some-bucket/{{ task_instance_key_str }}"
SCRIPT_LOCATION = f"s3://{BASE_LOCATION}/script-location.py"
CREATE_JOB_KWARGS = {
"GlueVersion": "4.0",
"Command": {
"Name": "glueetl",
"ScriptLocation": SCRIPT_LOCATION,
},
"WorkerType": "G.1X",
"NumberOfWorkers": 2,
}
EXPECTED_BASE_LOCATION = f"some-bucket/{DAG_ID}__{TASK_ID}__20170101"


class TestGlueJobOperator:
def setup_method(self):
conf.load_test_config()

def test_render_template(self):
args = {"owner": "airflow", "start_date": DEFAULT_DATE}

dag = DAG(DAG_ID, default_args=args)
mock_operator = GlueJobOperator(
task_id=TASK_ID, dag=dag, create_job_kwargs=CREATE_JOB_KWARGS, s3_bucket=BASE_LOCATION
)

dag_run = DagRun(dag_id=mock_operator.dag_id, execution_date=DEFAULT_DATE, run_id="test")
ti = TaskInstance(task=mock_operator)
ti.dag_run = dag_run
ti.render_templates()

expected_rendered_template = copy.deepcopy(CREATE_JOB_KWARGS)
expected_rendered_template["Command"][
"ScriptLocation"
] = f"s3://{EXPECTED_BASE_LOCATION}/script-location.py"

assert expected_rendered_template == getattr(mock_operator, "create_job_kwargs")
assert EXPECTED_BASE_LOCATION == getattr(mock_operator, "s3_bucket")

@pytest.mark.parametrize(
"script_location",
[
Expand All @@ -52,8 +94,8 @@ def test_execute_without_failure(
script_location,
):
glue = GlueJobOperator(
task_id="test_glue_operator",
job_name="my_test_job",
task_id=TASK_ID,
job_name=JOB_NAME,
script_location=script_location,
aws_conn_id="aws_default",
region_name="us-west-2",
Expand All @@ -67,7 +109,7 @@ def test_execute_without_failure(

mock_initialize_job.assert_called_once_with({}, {})
mock_print_job_logs.assert_not_called()
assert glue.job_name == "my_test_job"
assert glue.job_name == JOB_NAME

@mock.patch.object(GlueJobHook, "print_job_logs")
@mock.patch.object(GlueJobHook, "get_job_state")
Expand All @@ -77,11 +119,10 @@ def test_execute_without_failure(
def test_execute_with_verbose_logging(
self, mock_load_file, mock_get_conn, mock_initialize_job, mock_get_job_state, mock_print_job_logs
):
job_name = "test_job_name"
job_run_id = "11111"
glue = GlueJobOperator(
task_id="test_glue_operator",
job_name=job_name,
task_id=TASK_ID,
job_name=JOB_NAME,
script_location="s3_uri",
s3_bucket="bucket_name",
iam_role_name="role_arn",
Expand All @@ -94,12 +135,12 @@ def test_execute_with_verbose_logging(

mock_initialize_job.assert_called_once_with({}, {})
mock_print_job_logs.assert_called_once_with(
job_name=job_name,
job_name=JOB_NAME,
run_id=job_run_id,
job_failed=False,
next_token=None,
)
assert glue.job_name == job_name
assert glue.job_name == JOB_NAME

@mock.patch.object(GlueJobHook, "print_job_logs")
@mock.patch.object(GlueJobHook, "job_completion")
Expand All @@ -110,8 +151,8 @@ def test_execute_without_waiting_for_completion(
self, mock_load_file, mock_get_conn, mock_initialize_job, mock_job_completion, mock_print_job_logs
):
glue = GlueJobOperator(
task_id="test_glue_operator",
job_name="my_test_job",
task_id=TASK_ID,
job_name=JOB_NAME,
script_location="s3://glue-examples/glue-scripts/sample_aws_glue_job.py",
aws_conn_id="aws_default",
region_name="us-west-2",
Expand All @@ -126,5 +167,5 @@ def test_execute_without_waiting_for_completion(
mock_initialize_job.assert_called_once_with({}, {})
mock_job_completion.assert_not_called()
mock_print_job_logs.assert_not_called()
assert glue.job_name == "my_test_job"
assert glue.job_name == JOB_NAME
assert job_run_id == "11111"