tests/operators/test_trigger_dagrun.py - airflow - Git at Google

 #
 # 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.

 import pathlib
 import tempfile
 from datetime import datetime
 from unittest import TestCase

 from airflow.exceptions import AirflowException, DagRunAlreadyExists
 from airflow.models import DAG, DagBag, DagModel, DagRun, Log, TaskInstance
 from airflow.models.serialized_dag import SerializedDagModel
 from airflow.operators.trigger_dagrun import TriggerDagRunOperator
 from airflow.utils import timezone
 from airflow.utils.session import create_session
 from airflow.utils.state import State

 DEFAULT_DATE = datetime(2019, 1, 1, tzinfo=timezone.utc)
 TEST_DAG_ID = "testdag"
 TRIGGERED_DAG_ID = "triggerdag"
 DAG_SCRIPT = (
     "from datetime import datetime\n\n"
     "from airflow.models import DAG\n"
     "from airflow.operators.dummy import DummyOperator\n\n"
     "dag = DAG(\n"
     'dag_id="{dag_id}", \n'
     'default_args={{"start_date": datetime(2019, 1, 1)}}, \n'
     "schedule_interval=None,\n"
     ")\n"
     'task = DummyOperator(task_id="test", dag=dag)'
 ).format(dag_id=TRIGGERED_DAG_ID)


 class TestDagRunOperator(TestCase):
     def setUp(self):
         # Airflow relies on reading the DAG from disk when triggering it.
         # Therefore write a temp file holding the DAG to trigger.
         with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
             self._tmpfile = f.name
             f.write(DAG_SCRIPT)
             f.flush()

         with create_session() as session:
             session.add(DagModel(dag_id=TRIGGERED_DAG_ID, fileloc=self._tmpfile))
             session.commit()

         self.dag = DAG(TEST_DAG_ID, default_args={"owner": "airflow", "start_date": DEFAULT_DATE})
         dagbag = DagBag(f.name, read_dags_from_db=False, include_examples=False)
         dagbag.bag_dag(self.dag, root_dag=self.dag)
         dagbag.sync_to_db()

     def tearDown(self):
         """Cleanup state after testing in DB."""
         with create_session() as session:
             session.query(Log).filter(Log.dag_id == TEST_DAG_ID).delete(synchronize_session=False)
             for dbmodel in [DagModel, DagRun, TaskInstance, SerializedDagModel]:
                 session.query(dbmodel).filter(dbmodel.dag_id.in_([TRIGGERED_DAG_ID, TEST_DAG_ID])).delete(
                     synchronize_session=False
                 )

         pathlib.Path(self._tmpfile).unlink()

     def test_trigger_dagrun(self):
         """Test TriggerDagRunOperator."""
         task = TriggerDagRunOperator(task_id="test_task", trigger_dag_id=TRIGGERED_DAG_ID, dag=self.dag)
         task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].external_trigger)

     def test_trigger_dagrun_with_execution_date(self):
         """Test TriggerDagRunOperator with custom execution_date."""
         utc_now = timezone.utcnow()
         task = TriggerDagRunOperator(
             task_id="test_trigger_dagrun_with_execution_date",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date=utc_now,
             dag=self.dag,
         )
         task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].external_trigger)
             self.assertEqual(dagruns[0].execution_date, utc_now)

     def test_trigger_dagrun_twice(self):
         """Test TriggerDagRunOperator with custom execution_date."""
         utc_now = timezone.utcnow()
         task = TriggerDagRunOperator(
             task_id="test_trigger_dagrun_with_execution_date",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date=utc_now,
             dag=self.dag,
             poke_interval=1,
             reset_dag_run=True,
             wait_for_completion=True,
         )
         run_id = f"manual__{utc_now.isoformat()}"
         with create_session() as session:
             dag_run = DagRun(
                 dag_id=TRIGGERED_DAG_ID,
                 execution_date=utc_now,
                 state=State.SUCCESS,
                 run_type="manual",
                 run_id=run_id,
             )
             session.add(dag_run)
             session.commit()
             task.execute(None)

             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].external_trigger)
             self.assertEqual(dagruns[0].execution_date, utc_now)

     def test_trigger_dagrun_with_templated_execution_date(self):
         """Test TriggerDagRunOperator with templated execution_date."""
         task = TriggerDagRunOperator(
             task_id="test_trigger_dagrun_with_str_execution_date",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date="{{ execution_date }}",
             dag=self.dag,
         )
         task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].external_trigger)
             self.assertEqual(dagruns[0].execution_date, DEFAULT_DATE)

     def test_trigger_dagrun_operator_conf(self):
         """Test passing conf to the triggered DagRun."""
         task = TriggerDagRunOperator(
             task_id="test_trigger_dagrun_with_str_execution_date",
             trigger_dag_id=TRIGGERED_DAG_ID,
             conf={"foo": "bar"},
             dag=self.dag,
         )
         task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].conf, {"foo": "bar"})

     def test_trigger_dagrun_operator_templated_conf(self):
         """Test passing a templated conf to the triggered DagRun."""
         task = TriggerDagRunOperator(
             task_id="test_trigger_dagrun_with_str_execution_date",
             trigger_dag_id=TRIGGERED_DAG_ID,
             conf={"foo": "{{ dag.dag_id }}"},
             dag=self.dag,
         )
         task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].conf, {"foo": TEST_DAG_ID})

     def test_trigger_dagrun_with_reset_dag_run_false(self):
         """Test TriggerDagRunOperator with reset_dag_run."""
         execution_date = DEFAULT_DATE
         task = TriggerDagRunOperator(
             task_id="test_task",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date=execution_date,
             reset_dag_run=False,
             dag=self.dag,
         )
         task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)

         with self.assertRaises(DagRunAlreadyExists):
             task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)

     def test_trigger_dagrun_with_reset_dag_run_true(self):
         """Test TriggerDagRunOperator with reset_dag_run."""
         execution_date = DEFAULT_DATE
         task = TriggerDagRunOperator(
             task_id="test_task",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date=execution_date,
             reset_dag_run=True,
             dag=self.dag,
         )
         task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)
         task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)
             self.assertTrue(dagruns[0].external_trigger)

     def test_trigger_dagrun_with_wait_for_completion_true(self):
         """Test TriggerDagRunOperator with wait_for_completion."""
         execution_date = DEFAULT_DATE
         task = TriggerDagRunOperator(
             task_id="test_task",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date=execution_date,
             wait_for_completion=True,
             poke_interval=10,
             allowed_states=[State.RUNNING],
             dag=self.dag,
         )
         task.run(start_date=execution_date, end_date=execution_date)

         with create_session() as session:
             dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
             self.assertEqual(len(dagruns), 1)

     def test_trigger_dagrun_with_wait_for_completion_true_fail(self):
         """Test TriggerDagRunOperator with wait_for_completion but triggered dag fails."""
         execution_date = DEFAULT_DATE
         task = TriggerDagRunOperator(
             task_id="test_task",
             trigger_dag_id=TRIGGERED_DAG_ID,
             execution_date=execution_date,
             wait_for_completion=True,
             poke_interval=10,
             failed_states=[State.RUNNING],
             dag=self.dag,
         )
         with self.assertRaises(AirflowException):
             task.run(start_date=execution_date, end_date=execution_date)
	#
	# 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.

	import pathlib
	import tempfile
	from datetime import datetime
	from unittest import TestCase

	from airflow.exceptions import AirflowException, DagRunAlreadyExists
	from airflow.models import DAG, DagBag, DagModel, DagRun, Log, TaskInstance
	from airflow.models.serialized_dag import SerializedDagModel
	from airflow.operators.trigger_dagrun import TriggerDagRunOperator
	from airflow.utils import timezone
	from airflow.utils.session import create_session
	from airflow.utils.state import State

	DEFAULT_DATE = datetime(2019, 1, 1, tzinfo=timezone.utc)
	TEST_DAG_ID = "testdag"
	TRIGGERED_DAG_ID = "triggerdag"
	DAG_SCRIPT = (
	"from datetime import datetime\n\n"
	"from airflow.models import DAG\n"
	"from airflow.operators.dummy import DummyOperator\n\n"
	"dag = DAG(\n"
	'dag_id="{dag_id}", \n'
	'default_args={{"start_date": datetime(2019, 1, 1)}}, \n'
	"schedule_interval=None,\n"
	")\n"
	'task = DummyOperator(task_id="test", dag=dag)'
	).format(dag_id=TRIGGERED_DAG_ID)


	class TestDagRunOperator(TestCase):
	def setUp(self):
	# Airflow relies on reading the DAG from disk when triggering it.
	# Therefore write a temp file holding the DAG to trigger.
	with tempfile.NamedTemporaryFile(mode="w", delete=False) as f:
	self._tmpfile = f.name
	f.write(DAG_SCRIPT)
	f.flush()

	with create_session() as session:
	session.add(DagModel(dag_id=TRIGGERED_DAG_ID, fileloc=self._tmpfile))
	session.commit()

	self.dag = DAG(TEST_DAG_ID, default_args={"owner": "airflow", "start_date": DEFAULT_DATE})
	dagbag = DagBag(f.name, read_dags_from_db=False, include_examples=False)
	dagbag.bag_dag(self.dag, root_dag=self.dag)
	dagbag.sync_to_db()

	def tearDown(self):
	"""Cleanup state after testing in DB."""
	with create_session() as session:
	session.query(Log).filter(Log.dag_id == TEST_DAG_ID).delete(synchronize_session=False)
	for dbmodel in [DagModel, DagRun, TaskInstance, SerializedDagModel]:
	session.query(dbmodel).filter(dbmodel.dag_id.in_([TRIGGERED_DAG_ID, TEST_DAG_ID])).delete(
	synchronize_session=False
	)

	pathlib.Path(self._tmpfile).unlink()

	def test_trigger_dagrun(self):
	"""Test TriggerDagRunOperator."""
	task = TriggerDagRunOperator(task_id="test_task", trigger_dag_id=TRIGGERED_DAG_ID, dag=self.dag)
	task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].external_trigger)

	def test_trigger_dagrun_with_execution_date(self):
	"""Test TriggerDagRunOperator with custom execution_date."""
	utc_now = timezone.utcnow()
	task = TriggerDagRunOperator(
	task_id="test_trigger_dagrun_with_execution_date",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date=utc_now,
	dag=self.dag,
	)
	task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].external_trigger)
	self.assertEqual(dagruns[0].execution_date, utc_now)

	def test_trigger_dagrun_twice(self):
	"""Test TriggerDagRunOperator with custom execution_date."""
	utc_now = timezone.utcnow()
	task = TriggerDagRunOperator(
	task_id="test_trigger_dagrun_with_execution_date",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date=utc_now,
	dag=self.dag,
	poke_interval=1,
	reset_dag_run=True,
	wait_for_completion=True,
	)
	run_id = f"manual__{utc_now.isoformat()}"
	with create_session() as session:
	dag_run = DagRun(
	dag_id=TRIGGERED_DAG_ID,
	execution_date=utc_now,
	state=State.SUCCESS,
	run_type="manual",
	run_id=run_id,
	)
	session.add(dag_run)
	session.commit()
	task.execute(None)

	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].external_trigger)
	self.assertEqual(dagruns[0].execution_date, utc_now)

	def test_trigger_dagrun_with_templated_execution_date(self):
	"""Test TriggerDagRunOperator with templated execution_date."""
	task = TriggerDagRunOperator(
	task_id="test_trigger_dagrun_with_str_execution_date",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date="{{ execution_date }}",
	dag=self.dag,
	)
	task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].external_trigger)
	self.assertEqual(dagruns[0].execution_date, DEFAULT_DATE)

	def test_trigger_dagrun_operator_conf(self):
	"""Test passing conf to the triggered DagRun."""
	task = TriggerDagRunOperator(
	task_id="test_trigger_dagrun_with_str_execution_date",
	trigger_dag_id=TRIGGERED_DAG_ID,
	conf={"foo": "bar"},
	dag=self.dag,
	)
	task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].conf, {"foo": "bar"})

	def test_trigger_dagrun_operator_templated_conf(self):
	"""Test passing a templated conf to the triggered DagRun."""
	task = TriggerDagRunOperator(
	task_id="test_trigger_dagrun_with_str_execution_date",
	trigger_dag_id=TRIGGERED_DAG_ID,
	conf={"foo": "{{ dag.dag_id }}"},
	dag=self.dag,
	)
	task.run(start_date=DEFAULT_DATE, end_date=DEFAULT_DATE, ignore_ti_state=True)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].conf, {"foo": TEST_DAG_ID})

	def test_trigger_dagrun_with_reset_dag_run_false(self):
	"""Test TriggerDagRunOperator with reset_dag_run."""
	execution_date = DEFAULT_DATE
	task = TriggerDagRunOperator(
	task_id="test_task",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date=execution_date,
	reset_dag_run=False,
	dag=self.dag,
	)
	task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)

	with self.assertRaises(DagRunAlreadyExists):
	task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)

	def test_trigger_dagrun_with_reset_dag_run_true(self):
	"""Test TriggerDagRunOperator with reset_dag_run."""
	execution_date = DEFAULT_DATE
	task = TriggerDagRunOperator(
	task_id="test_task",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date=execution_date,
	reset_dag_run=True,
	dag=self.dag,
	)
	task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)
	task.run(start_date=execution_date, end_date=execution_date, ignore_ti_state=True)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)
	self.assertTrue(dagruns[0].external_trigger)

	def test_trigger_dagrun_with_wait_for_completion_true(self):
	"""Test TriggerDagRunOperator with wait_for_completion."""
	execution_date = DEFAULT_DATE
	task = TriggerDagRunOperator(
	task_id="test_task",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date=execution_date,
	wait_for_completion=True,
	poke_interval=10,
	allowed_states=[State.RUNNING],
	dag=self.dag,
	)
	task.run(start_date=execution_date, end_date=execution_date)

	with create_session() as session:
	dagruns = session.query(DagRun).filter(DagRun.dag_id == TRIGGERED_DAG_ID).all()
	self.assertEqual(len(dagruns), 1)

	def test_trigger_dagrun_with_wait_for_completion_true_fail(self):
	"""Test TriggerDagRunOperator with wait_for_completion but triggered dag fails."""
	execution_date = DEFAULT_DATE
	task = TriggerDagRunOperator(
	task_id="test_task",
	trigger_dag_id=TRIGGERED_DAG_ID,
	execution_date=execution_date,
	wait_for_completion=True,
	poke_interval=10,
	failed_states=[State.RUNNING],
	dag=self.dag,
	)
	with self.assertRaises(AirflowException):
	task.run(start_date=execution_date, end_date=execution_date)