You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by be...@apache.org on 2024/09/25 20:39:26 UTC
(superset) 01/01: feat: turn off autoflush on integration tests
This is an automated email from the ASF dual-hosted git repository.
beto pushed a commit to branch no-autoflush
in repository https://gitbox.apache.org/repos/asf/superset.git
commit e079aa6bdf4e6591aed2adca7babc01e06bbc593
Author: Beto Dealmeida <ro...@dealmeida.net>
AuthorDate: Wed Sep 25 15:56:27 2024 -0400
feat: turn off autoflush on integration tests
---
tests/integration_tests/conftest.py | 21 ++++--
tests/integration_tests/utils/decorators_test.py | 84 ++++++++++++++++++++++++
2 files changed, 101 insertions(+), 4 deletions(-)
diff --git a/tests/integration_tests/conftest.py b/tests/integration_tests/conftest.py
index 8e8a5ca20c..82682ce20b 100644
--- a/tests/integration_tests/conftest.py
+++ b/tests/integration_tests/conftest.py
@@ -43,6 +43,15 @@ CTAS_SCHEMA_NAME = "sqllab_test_db"
ADMIN_SCHEMA_NAME = "admin_database"
+# When running tests it's important to disable autoflush to prevent dirty reads. If a
+# command modifies the database but doesn't explicitly commit the transaction, a
+# subsequent read won't see the data because we use READ COMMITTED isolation level. But
+# many integration tests write and read in the same session, and because by default
+# SQLAlchemy uses autoflush, the test would see data that in real world wouldn't be
+# there.
+db.session.configure(autoflush=False)
+
+
@pytest.fixture
def app_context():
with app.app_context() as ctx:
@@ -292,7 +301,8 @@ def virtual_dataset():
dataset = SqlaTable(
table_name="virtual_dataset",
sql=(
- dedent("""\
+ dedent(
+ """\
SELECT 0 as col1, 'a' as col2, 1.0 as col3, NULL as col4, '2000-01-01 00:00:00' as col5, 1 as col6
UNION ALL
SELECT 1, 'b', 1.1, NULL, '2000-01-02 00:00:00', NULL
@@ -312,7 +322,8 @@ def virtual_dataset():
SELECT 8 as col1, 'i' as col2, 1.8, NULL, '2000-01-09 00:00:00', 9
UNION ALL
SELECT 9 as col1, 'j' as col2, 1.9, NULL, '2000-01-10 00:00:00', 10
- """)
+ """
+ )
),
database=get_example_database(),
)
@@ -341,7 +352,8 @@ def virtual_dataset_with_comments():
dataset = SqlaTable(
table_name="virtual_dataset_with_comments",
sql=(
- dedent("""\
+ dedent(
+ """\
--COMMENT
/*COMMENT*/
WITH cte as (--COMMENT
@@ -352,7 +364,8 @@ def virtual_dataset_with_comments():
UNION ALL/*COMMENT*/
SELECT 1 as col1, 'f' as col2, 1.5, NULL, '2000-01-06 00:00:00', 6 --COMMENT
UNION ALL--COMMENT
- SELECT * FROM cte --COMMENT""")
+ SELECT * FROM cte --COMMENT"""
+ )
),
database=get_example_database(),
)
diff --git a/tests/integration_tests/utils/decorators_test.py b/tests/integration_tests/utils/decorators_test.py
new file mode 100644
index 0000000000..2f01840a67
--- /dev/null
+++ b/tests/integration_tests/utils/decorators_test.py
@@ -0,0 +1,84 @@
+# 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.
+
+from unittest.mock import patch
+
+import pytest
+
+from superset import db, security_manager
+from superset.commands.chart.fave import AddFavoriteChartCommand
+from superset.commands.chart.unfave import DelFavoriteChartCommand
+from superset.daos.chart import ChartDAO
+from superset.models.slice import Slice
+from superset.utils.core import override_user
+from tests.integration_tests.base_tests import SupersetTestCase
+from tests.integration_tests.fixtures.energy_dashboard import (
+ load_energy_table_data, # noqa: F401
+ load_energy_table_with_slice, # noqa: F401
+)
+
+
+class TestTransactionDecorator(SupersetTestCase):
+ """
+ Test the transaction decorator.
+
+ These tests were created because we use the `transaction` decorator to perform
+ explicit commits in the code base. But because SQLAlchemy will autoflush by default,
+ some tests where doing dirty reads, and failing to capture that data was actually
+ not being written to the database.
+ """
+
+ @pytest.mark.usefixtures("load_energy_table_with_slice")
+ def test_with_commit(self) -> None:
+ """
+ Test that the decorator commits.
+ """
+ example_chart = db.session.query(Slice).all()[0]
+ assert example_chart is not None
+ ids = ChartDAO.favorited_ids([example_chart])
+ assert example_chart.id not in ids
+
+ with override_user(security_manager.find_user("admin")):
+ AddFavoriteChartCommand(example_chart.id).run()
+ ids = ChartDAO.favorited_ids([example_chart])
+ assert example_chart.id in ids
+
+ DelFavoriteChartCommand(example_chart.id).run()
+ ids = ChartDAO.favorited_ids([example_chart])
+ assert example_chart.id not in ids
+
+ @pytest.mark.usefixtures("load_energy_table_with_slice")
+ def test_without_commit(self) -> None:
+ """
+ Test that autoflush is off.
+
+ In this test we mock the `transaction` decorator so it doesn't autocommit. Since
+ the integration tests are configured with autoflush off, we should not see the
+ data in the same session.
+ """
+ with patch.object(db.session, "commit") as commit:
+ example_chart = db.session.query(Slice).all()[0]
+ assert example_chart is not None
+ ids = ChartDAO.favorited_ids([example_chart])
+ assert example_chart.id not in ids
+
+ with override_user(security_manager.find_user("admin")):
+ AddFavoriteChartCommand(example_chart.id).run()
+ ids = ChartDAO.favorited_ids([example_chart])
+ assert example_chart.id not in ids
+
+ commit.assert_called()