mik-laj commented on a change in pull request #9153:
URL: https://github.com/apache/airflow/pull/9153#discussion_r438010702
##########
File path: tests/api_connexion/endpoints/test_dag_run_endpoint.py
##########
@@ -15,41 +15,347 @@
# specific language governing permissions and limitations
# under the License.
import unittest
+from datetime import timedelta
import pytest
+from parameterized import parameterized
+from airflow.models import DagRun
+from airflow.utils import timezone
+from airflow.utils.session import provide_session
+from airflow.utils.types import DagRunType
from airflow.www import app
+from tests.test_utils.db import clear_db_runs
class TestDagRunEndpoint(unittest.TestCase):
@classmethod
def setUpClass(cls) -> None:
super().setUpClass()
+
cls.app = app.create_app(testing=True) # type:ignore
def setUp(self) -> None:
self.client = self.app.test_client() # type:ignore
+ self.now = '2020-06-11T18:00:00+00:00'
+ self.now2 = '2020-06-12T18:00:00+00:00'
+ clear_db_runs()
+
+ def tearDown(self) -> None:
+ clear_db_runs()
+
+ def _create_test_dag_run(self, state='running'):
+ dagrun_model_1 = DagRun(
+ dag_id='TEST_DAG_ID',
+ run_id='TEST_DAG_RUN_ID_1',
+ run_type=DagRunType.MANUAL.value,
+ execution_date=timezone.parse(self.now),
+ start_date=timezone.parse(self.now),
+ external_trigger=True,
+ state=state,
+ )
+ dagrun_model_2 = DagRun(
+ dag_id='TEST_DAG_ID',
+ run_id='TEST_DAG_RUN_ID_2',
+ run_type=DagRunType.MANUAL.value,
+ execution_date=timezone.parse(self.now2),
+ start_date=timezone.parse(self.now),
+ external_trigger=True,
+ )
+ return [dagrun_model_1, dagrun_model_2]
class TestDeleteDagRun(TestDagRunEndpoint):
@pytest.mark.skip(reason="Not implemented yet")
def test_should_response_200(self):
- response =
self.client.delete("/dags/TEST_DAG_ID}/dagRuns/TEST_DAG_RUN_ID")
+ response =
self.client.delete("api/v1/dags/TEST_DAG_ID}/dagRuns/TEST_DAG_RUN_ID")
assert response.status_code == 204
class TestGetDagRun(TestDagRunEndpoint):
- @pytest.mark.skip(reason="Not implemented yet")
- def test_should_response_200(self):
- response = self.client.get("/dags/TEST_DAG_ID/dagRuns/TEST_DAG_RUN_ID")
+ @provide_session
+ def test_should_response_200(self, session):
+ dagrun_model = DagRun(
+ dag_id='TEST_DAG_ID',
+ run_id='TEST_DAG_RUN_ID',
+ run_type=DagRunType.MANUAL.value,
+ execution_date=timezone.parse(self.now),
+ start_date=timezone.parse(self.now),
+ external_trigger=True,
+ )
+ session.add(dagrun_model)
+ session.commit()
+ result = session.query(DagRun).all()
+ assert len(result) == 1
+ response =
self.client.get("api/v1/dags/TEST_DAG_ID/dagRuns/TEST_DAG_RUN_ID")
assert response.status_code == 200
+ self.assertEqual(
+ response.json,
+ {
+ 'dag_id': 'TEST_DAG_ID',
+ 'dag_run_id': 'TEST_DAG_RUN_ID',
+ 'end_date': None,
+ 'state': 'running',
+ 'execution_date': self.now,
+ 'external_trigger': True,
+ 'start_date': self.now,
+ 'conf': {},
+ },
+ )
+
+ def test_should_response_404(self):
+ response = self.client.get("api/v1/dags/invalid-id/dagRuns/invalid-id")
+ assert response.status_code == 404
+ self.assertEqual(
+ {'detail': None, 'status': 404, 'title': 'DAGRun not found',
'type': 'about:blank'}, response.json
+ )
class TestGetDagRuns(TestDagRunEndpoint):
- @pytest.mark.skip(reason="Not implemented yet")
- def test_should_response_200(self):
- response = self.client.get("/dags/TEST_DAG_ID/dagRuns/")
+ @provide_session
+ def test_should_response_200(self, session):
+ dagruns = self._create_test_dag_run()
+ session.add_all(dagruns)
+ session.commit()
+ result = session.query(DagRun).all()
+ assert len(result) == 2
+ response = self.client.get("api/v1/dags/TEST_DAG_ID/dagRuns")
+ assert response.status_code == 200
+ self.assertEqual(
+ response.json,
+ {
+ "dag_runs": [
+ {
+ 'dag_id': 'TEST_DAG_ID',
+ 'dag_run_id': 'TEST_DAG_RUN_ID_1',
+ 'end_date': None,
+ 'state': 'running',
+ 'execution_date': self.now,
+ 'external_trigger': True,
+ 'start_date': self.now,
+ 'conf': {},
+ },
+ {
+ 'dag_id': 'TEST_DAG_ID',
+ 'dag_run_id': 'TEST_DAG_RUN_ID_2',
+ 'end_date': None,
+ 'state': 'running',
+ 'execution_date': self.now2,
+ 'external_trigger': True,
+ 'start_date': self.now,
+ 'conf': {},
+ },
+ ],
+ "total_entries": 2,
+ },
+ )
+
+ @provide_session
+ def test_should_return_all_with_tilde_as_dag_id(self, session):
+ dagruns = self._create_test_dag_run()
+ session.add_all(dagruns)
+ session.commit()
+ result = session.query(DagRun).all()
+ assert len(result) == 2
+ assert result[0].dag_id == result[1].dag_id == 'TEST_DAG_ID'
+ response = self.client.get("api/v1/dags/~/dagRuns")
+ assert response.status_code == 200
+ self.assertEqual(
+ response.json,
+ {
+ "dag_runs": [
+ {
+ 'dag_id': 'TEST_DAG_ID',
+ 'dag_run_id': 'TEST_DAG_RUN_ID_1',
+ 'end_date': None,
+ 'state': 'running',
+ 'execution_date': self.now,
+ 'external_trigger': True,
+ 'start_date': self.now,
+ 'conf': {},
+ },
+ {
+ 'dag_id': 'TEST_DAG_ID',
+ 'dag_run_id': 'TEST_DAG_RUN_ID_2',
+ 'end_date': None,
+ 'state': 'running',
+ 'execution_date': self.now2,
+ 'external_trigger': True,
+ 'start_date': self.now,
+ 'conf': {},
+ },
+ ],
+ "total_entries": 2,
+ },
+ )
+
+
+class TestGetDagRunsPagination(TestDagRunEndpoint):
+ @parameterized.expand(
+ [
+ ("api/v1/dags/TEST_DAG_ID/dagRuns?limit=1", ["TEST_DAG_RUN_ID1"]),
+ ("api/v1/dags/TEST_DAG_ID/dagRuns?limit=2", ["TEST_DAG_RUN_ID1",
"TEST_DAG_RUN_ID2"]),
+ (
+ "api/v1/dags/TEST_DAG_ID/dagRuns?offset=5",
+ [
+ "TEST_DAG_RUN_ID6",
+ "TEST_DAG_RUN_ID7",
+ "TEST_DAG_RUN_ID8",
+ "TEST_DAG_RUN_ID9",
+ "TEST_DAG_RUN_ID10",
+ ],
+ ),
+ (
+ "api/v1/dags/TEST_DAG_ID/dagRuns?offset=0",
+ [
+ "TEST_DAG_RUN_ID1",
+ "TEST_DAG_RUN_ID2",
+ "TEST_DAG_RUN_ID3",
+ "TEST_DAG_RUN_ID4",
+ "TEST_DAG_RUN_ID5",
+ "TEST_DAG_RUN_ID6",
+ "TEST_DAG_RUN_ID7",
+ "TEST_DAG_RUN_ID8",
+ "TEST_DAG_RUN_ID9",
+ "TEST_DAG_RUN_ID10",
+ ],
+ ),
+ ("api/v1/dags/TEST_DAG_ID/dagRuns?limit=1&offset=5",
["TEST_DAG_RUN_ID6"]),
+ ("api/v1/dags/TEST_DAG_ID/dagRuns?limit=1&offset=1",
["TEST_DAG_RUN_ID2"]),
+ ("api/v1/dags/TEST_DAG_ID/dagRuns?limit=2&offset=2",
["TEST_DAG_RUN_ID3", "TEST_DAG_RUN_ID4"],),
+ ]
+ )
+ @provide_session
+ def test_handle_limit_and_offset(self, url, expected_dag_run_ids, session):
+ dagrun_models = self._create_dag_runs(10)
+ session.add_all(dagrun_models)
+ session.commit()
+
+ response = self.client.get(url)
+ assert response.status_code == 200
+
+ self.assertEqual(response.json["total_entries"], 10)
+ dag_run_ids = [dag_run["dag_run_id"] for dag_run in
response.json["dag_runs"]]
+ self.assertEqual(dag_run_ids, expected_dag_run_ids)
+
+ @provide_session
+ def test_should_respect_page_size_limit(self, session):
+ dagrun_models = self._create_dag_runs(200)
+ session.add_all(dagrun_models)
+ session.commit()
+
+ response = self.client.get("api/v1/dags/TEST_DAG_ID/dagRuns?limit=150")
+ assert response.status_code == 200
+
+ self.assertEqual(response.json["total_entries"], 200)
+ self.assertEqual(len(response.json["dag_runs"]), 100)
+
+ def _create_dag_runs(self, count):
+ return [
+ DagRun(
+ dag_id="TEST_DAG_ID",
+ run_id="TEST_DAG_RUN_ID" + str(i),
+ run_type=DagRunType.MANUAL.value,
+ execution_date=timezone.parse(self.now) + timedelta(minutes=i),
+ start_date=timezone.parse(self.now),
+ external_trigger=True,
+ )
+ for i in range(1, count + 1)
+ ]
+
+
+class TestGetDagRunsPaginationFilters(TestDagRunEndpoint):
+ @parameterized.expand(
+ [
+ (
+
"api/v1/dags/TEST_DAG_ID/dagRuns?start_date_gte=2020-06-18T18:00:00+00:00",
+ ["TEST_DAG_RUN_ID8", "TEST_DAG_RUN_ID9"],
Review comment:
What do you think to assert the start/execution dates here? Identifiers
poorly describe these objectshere.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
