Skip to content

Commit 80e7e9b

Browse files
authored
Fix Neo4jOperator templated query validation (#70348)
1 parent d713e2d commit 80e7e9b

3 files changed

Lines changed: 23 additions & 16 deletions

File tree

‎providers/neo4j/src/airflow/providers/neo4j/operators/neo4j.py‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,20 @@ def __init__(
6363
AirflowProviderDeprecationWarning,
6464
stacklevel=2,
6565
)
66-
if cypher is not None:
67-
raise ValueError("Cannot provide both `sql` and `cypher`. Use `cypher` only.")
68-
cypher = sql
69-
if cypher is None:
70-
raise ValueError("Parameter `cypher` is required.")
7166
self.neo4j_conn_id = neo4j_conn_id
7267
self.cypher = cypher
68+
self.sql = sql
7369
self.parameters = parameters
7470

7571
def execute(self, context: Context) -> None:
76-
self.log.info("Executing: %s", self.cypher)
72+
cypher = self.cypher
73+
if self.sql is not None:
74+
if cypher is not None:
75+
raise ValueError("Cannot provide both `sql` and `cypher`. Use `cypher` only.")
76+
cypher = self.render_template(self.sql, context)
77+
if cypher is None:
78+
raise ValueError("Parameter `cypher` is required.")
79+
80+
self.log.info("Executing: %s", cypher)
7781
hook = Neo4jHook(conn_id=self.neo4j_conn_id)
78-
hook.run(self.cypher, self.parameters)
82+
hook.run(cypher, self.parameters)

‎providers/neo4j/tests/unit/neo4j/operators/test_neo4j.py‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,16 +61,20 @@ def test_neo4j_operator_sql_param_is_deprecated(self, mock_hook):
6161
AirflowProviderDeprecationWarning,
6262
match="`sql` parameter is deprecated, please use `cypher` instead.",
6363
):
64-
op = Neo4jOperator(task_id="basic_neo4j", sql=cypher)
65-
assert op.cypher == cypher
66-
op.execute(mock.MagicMock())
64+
op = Neo4jOperator(task_id="basic_neo4j", sql="{{ cypher }}")
65+
assert op.sql == "{{ cypher }}"
66+
op.execute({"cypher": cypher})
6767
mock_hook.return_value.run.assert_called_once_with(cypher, None)
6868

69-
def test_neo4j_operator_both_sql_and_cypher_raises(self):
69+
def test_neo4j_operator_both_sql_and_cypher_raises_on_execute(self):
7070
with pytest.warns(AirflowProviderDeprecationWarning):
71-
with pytest.raises(ValueError, match="Cannot provide both `sql` and `cypher`"):
72-
Neo4jOperator(task_id="basic_neo4j", sql="a", cypher="b")
71+
op = Neo4jOperator(task_id="basic_neo4j", sql="a", cypher="b")
72+
73+
with pytest.raises(ValueError, match="Cannot provide both `sql` and `cypher`"):
74+
op.execute(mock.MagicMock())
75+
76+
def test_neo4j_operator_missing_cypher_raises_on_execute(self):
77+
op = Neo4jOperator(task_id="basic_neo4j")
7378

74-
def test_neo4j_operator_missing_cypher_raises(self):
7579
with pytest.raises(ValueError, match="Parameter `cypher` is required."):
76-
Neo4jOperator(task_id="basic_neo4j")
80+
op.execute(mock.MagicMock())

‎scripts/ci/prek/validate_operators_init_exemptions.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ providers/google/src/airflow/providers/google/marketing_platform/operators/campa
6464
providers/microsoft/azure/src/airflow/providers/microsoft/azure/transfers/gcs_to_wasb.py::GCSToAzureBlobStorageOperator
6565
providers/microsoft/azure/src/airflow/providers/microsoft/azure/transfers/oracle_to_azure_data_lake.py::OracleToAzureDataLakeOperator
6666
providers/microsoft/psrp/src/airflow/providers/microsoft/psrp/operators/psrp.py::PsrpOperator
67-
providers/neo4j/src/airflow/providers/neo4j/operators/neo4j.py::Neo4jOperator
6867
providers/oracle/src/airflow/providers/oracle/transfers/oracle_to_oracle.py::OracleToOracleOperator
6968
providers/papermill/src/airflow/providers/papermill/operators/papermill.py::PapermillOperator
7069
providers/ssh/src/airflow/providers/ssh/operators/ssh.py::SSHOperator

0 commit comments

Comments
 (0)