Migrate Neo4j example DAGs to new design #22454

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

@@ -39,7 +39,7 @@ Content
     :maxdepth: 1
     :caption: Resources
 
-    Example DAGs <https://github.com/apache/airflow/tree/main/airflow/providers/neo4j/example_dags>
+    Example DAGs <https://github.com/apache/airflow/tree/main/tests/system/providers/neo4j>
 
 .. toctree::
     :maxdepth: 1

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

@@ -48,3 +48,9 @@ the connection metadata is structured as follows:
      - Neo4j user password
    * - Port: int
      - Neo4j port
+
+.. exampleinclude:: /../../tests/system/providers/neo4j/example_neo4j.py
+    :language: python
+    :dedent: 4
+    :start-after: [START run_query_neo4j_operator]
+    :end-before: [END run_query_neo4j_operator]

airflow/providers/neo4j/example_dags/example_neo4j.py → tests/system/providers/neo4j/example_neo4j.py

@@ -18,26 +18,34 @@
 """
 Example use of Neo4j related operators.
 """
-
+import os
 from datetime import datetime
 
 from airflow import DAG
 from airflow.providers.neo4j.operators.neo4j import Neo4jOperator
 
-dag = DAG(
-    'example_neo4j',
+ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
+DAG_ID = "example_neo4j"
+
+with DAG(
+    DAG_ID,
     start_date=datetime(2021, 1, 1),
     tags=['example'],
     catchup=False,
-)
+) as dag:
+
+    # [START run_query_neo4j_operator]
+
+    neo4j_task = Neo4jOperator(
+        task_id='run_neo4j_query',
+        neo4j_conn_id='neo4j_conn_id',
+        sql='MATCH (tom {name: "Tom Hanks", date: "{{ds}}"}) RETURN tom',
+        dag=dag,
+    )
 
-# [START run_query_neo4j_operator]
+    # [END run_query_neo4j_operator]
 
-neo4j_task = Neo4jOperator(
-    task_id='run_neo4j_query',
-    neo4j_conn_id='neo4j_conn_id',
-    sql='MATCH (tom {name: "Tom Hanks", date: "{{ds}}"}) RETURN tom',
-    dag=dag,
-)
+from tests.system.utils import get_test_run  # noqa: E402
 
-# [END run_query_neo4j_operator]
+# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
+test_run = get_test_run(dag)