Migrate DingTalk example DAGs to new design #22443

docs/apache-airflow-providers-dingding/index.rst

@@ -38,7 +38,7 @@ Content
     :maxdepth: 1
     :caption: Resources
 
-    Example DAGs <https://github.com/apache/airflow/tree/main/airflow/providers/dingding/example_dags>
+    Example DAGs <https://github.com/apache/airflow/tree/main/tests/system/providers/dingding>
     PyPI Repository <https://pypi.org/project/apache-airflow-providers-dingding/>
     Installing from sources <installing-providers-from-sources>
 

docs/apache-airflow-providers-dingding/operators.rst

@@ -37,7 +37,7 @@ Basic Usage
 Use the :class:`~airflow.providers.dingding.operators.dingding.DingdingOperator`
 to send Dingding message:
 
-.. exampleinclude:: /../../airflow/providers/dingding/example_dags/example_dingding.py
+.. exampleinclude:: /../../tests/system/providers/dingding/example_dingding.py
     :language: python
     :dedent: 4
     :start-after: [START howto_operator_dingding]
@@ -50,7 +50,7 @@ Remind users in message
 Use parameters ``at_mobiles`` and ``at_all`` to remind specific users when you send message,
 ``at_mobiles`` will be ignored When ``at_all`` is set to ``True``:
 
-.. exampleinclude:: /../../airflow/providers/dingding/example_dags/example_dingding.py
+.. exampleinclude:: /../../tests/system/providers/dingding/example_dingding.py
     :language: python
     :dedent: 4
     :start-after: [START howto_operator_dingding_remind_users]
@@ -63,7 +63,7 @@ Send rich text message
 The Dingding operator can send rich text messages including link, markdown, actionCard and feedCard.
 A rich text message can not remind specific users except by using markdown type message:
 
-.. exampleinclude:: /../../airflow/providers/dingding/example_dags/example_dingding.py
+.. exampleinclude:: /../../tests/system/providers/dingding/example_dingding.py
     :language: python
     :dedent: 4
     :start-after: [START howto_operator_dingding_rich_text]
@@ -77,7 +77,7 @@ Dingding operator could handle task callback by writing a function wrapper dingd
 and then pass the function to ``sla_miss_callback``, ``on_success_callback``, ``on_failure_callback``,
 or ``on_retry_callback``. Here we use ``on_failure_callback`` as an example:
 
-.. exampleinclude:: /../../airflow/providers/dingding/example_dags/example_dingding.py
+.. exampleinclude:: /../../tests/system/providers/dingding/example_dingding.py
     :language: python
     :start-after: [START howto_operator_dingding_failure_callback]
     :end-before: [END howto_operator_dingding_failure_callback]

airflow/providers/dingding/example_dags/example_dingding.py → tests/system/providers/dingding/example_dingding.py

@@ -18,11 +18,15 @@
 """
 This is an example dag for using the DingdingOperator.
 """
+import os
 from datetime import datetime, timedelta
 
 from airflow import DAG
 from airflow.providers.dingding.operators.dingding import DingdingOperator
 
+ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
+DAG_ID = "example_dingding_operator"
+
 
 # [START howto_operator_dingding_failure_callback]
 def failure_callback(context):
@@ -48,7 +52,7 @@ def failure_callback(context):
 # [END howto_operator_dingding_failure_callback]
 
 with DAG(
-    dag_id='example_dingding_operator',
+    dag_id=DAG_ID,
     default_args={'retries': 3, 'on_failure_callback': failure_callback},
     schedule_interval='@once',
     dagrun_timeout=timedelta(minutes=60),
@@ -201,3 +205,14 @@ def failure_callback(context):
         >> feed_card_msg
         >> msg_failure_callback
     )
+
+    from tests.system.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.system.utils import get_test_run  # noqa: E402
+
+# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
+test_run = get_test_run(dag)