bito-code-review[bot] commented on code in PR #34875:
URL: https://github.com/apache/superset/pull/34875#discussion_r4162773906
##########
tests/unit_tests/migrations/shared/catalogs_test.py:
##########
@@ -15,594 +15,147 @@
# specific language governing permissions and limitations
# under the License.
-import json # noqa: TID251
+from typing import Any
import pytest
-from flask import current_app
+import sqlalchemy as sa
from pytest_mock import MockerFixture
from sqlalchemy.orm.session import Session
from superset.migrations.shared.catalogs import (
downgrade_catalog_perms,
upgrade_catalog_perms,
)
-from superset.migrations.shared.security_converge import (
- Permission,
- PermissionView,
- ViewMenu,
-)
-from superset.superset_typing import OAuth2ClientConfig
-
-
[email protected]
-def oauth2_config() -> OAuth2ClientConfig:
- """
- Config for GSheets OAuth2.
- """
- return {
- "id": "XXX.apps.googleusercontent.com",
- "secret": "GOCSPX-YYY",
- "scope": " ".join(
- [
- "https://www.googleapis.com/auth/drive.readonly "
- "https://www.googleapis.com/auth/spreadsheets "
- "https://spreadsheets.google.com/feeds";
- ]
- ),
- "redirect_uri": "http://localhost:8088/api/v1/oauth2/";,
- "authorization_request_uri":
"https://accounts.google.com/o/oauth2/v2/auth";,
- "token_request_uri": "https://oauth2.googleapis.com/token";,
- "request_content_type": "json",
- }
-
-
-def test_upgrade_catalog_perms(mocker: MockerFixture, session: Session) ->
None:
- """
- Test the `upgrade_catalog_perms` function.
-
- The function is called when catalogs are introduced into a new DB engine
spec.
- """
- from superset.connectors.sqla.models import SqlaTable
- from superset.models.core import Database
- from superset.models.slice import Slice
- from superset.models.sql_lab import Query, SavedQuery, TableSchema,
TabState
-
- engine = session.get_bind()
- Database.metadata.create_all(engine)
-
- mocker.patch("superset.migrations.shared.catalogs.op")
- db = mocker.patch("superset.migrations.shared.catalogs.db")
- db.Session.return_value = session
-
- mocker.patch.object(
- Database,
- "get_all_schema_names",
- return_value=["public", "information_schema"],
- )
- mocker.patch.object(
- Database,
- "get_all_catalog_names",
- return_value=["db", "other_catalog"],
- )
-
- database = Database(
- database_name="my_db",
- sqlalchemy_uri="postgresql://localhost/db",
- )
- dataset = SqlaTable(
- table_name="my_table",
- database=database,
- catalog=None,
- schema="public",
- catalog_perm=None,
- schema_perm="[my_db].[public]",
- )
- session.add(dataset)
- session.commit()
-
- chart = Slice(
- slice_name="my_chart",
- datasource_type="table",
- datasource_id=dataset.id,
- catalog_perm=None,
- schema_perm="[my_db].[public]",
- )
- query = Query(
- client_id="foo",
- database=database,
- catalog=None,
- schema="public",
- )
- saved_query = SavedQuery(
- database=database,
- sql="SELECT * FROM public.t",
- catalog=None,
- schema="public",
- )
- tab_state = TabState(
- database=database,
- catalog=None,
- schema="public",
- )
- table_schema = TableSchema(
- database=database,
- catalog=None,
- schema="public",
- )
- session.add_all([chart, query, saved_query, tab_state, table_schema])
- session.commit()
-
- # before migration
- assert dataset.catalog is None
- assert query.catalog is None
- assert saved_query.catalog is None
- assert tab_state.catalog is None
- assert table_schema.catalog is None
- assert dataset.catalog_perm is None
- assert dataset.schema_perm == "[my_db].[public]"
- assert chart.catalog_perm is None
- assert chart.schema_perm == "[my_db].[public]"
- assert (
- session.query(ViewMenu.name, Permission.name)
- .join(PermissionView, ViewMenu.id == PermissionView.view_menu_id)
- .join(Permission, PermissionView.permission_id == Permission.id)
- .all()
- ) == [
- ("[my_db].(id:1)", "database_access"),
- ("[my_db].[my_table](id:1)", "datasource_access"),
- ("[my_db].[public]", "schema_access"),
- ]
-
- upgrade_catalog_perms()
- session.commit()
-
- # add dataset/chart in new catalog
- new_dataset = SqlaTable(
- table_name="my_table",
- database=database,
- catalog="other_catalog",
- schema="public",
- schema_perm="[my_db].[other_catalog].[public]",
- catalog_perm="[my_db].[other_catalog]",
- )
- session.add(new_dataset)
- session.commit()
-
- new_chart = Slice(
- slice_name="my_chart",
- datasource_type="table",
- datasource_id=new_dataset.id,
- )
- session.add(new_chart)
- session.commit()
-
- # after migration
- assert dataset.catalog == "db"
- assert query.catalog == "db"
- assert saved_query.catalog == "db"
- assert tab_state.catalog == "db"
- assert table_schema.catalog == "db"
- assert dataset.catalog_perm == "[my_db].[db]"
- assert dataset.schema_perm == "[my_db].[db].[public]"
- assert chart.catalog_perm == "[my_db].[db]"
- assert chart.schema_perm == "[my_db].[db].[public]"
- assert (
- session.query(ViewMenu.name, Permission.name)
- .join(PermissionView, ViewMenu.id == PermissionView.view_menu_id)
- .join(Permission, PermissionView.permission_id == Permission.id)
- .all()
- ) == [
- ("[my_db].(id:1)", "database_access"),
- ("[my_db].[my_table](id:1)", "datasource_access"),
- ("[my_db].[db].[public]", "schema_access"),
- ("[my_db].[db]", "catalog_access"),
- ("[my_db].[other_catalog]", "catalog_access"),
- ("[my_db].[other_catalog].[public]", "schema_access"),
- ("[my_db].[other_catalog].[information_schema]", "schema_access"),
- ("[my_db].[my_table](id:2)", "datasource_access"),
- ]
-
- # do a downgrade
- downgrade_catalog_perms()
- session.commit()
-
- # revert
- assert dataset.catalog is None
- assert query.catalog is None
- assert saved_query.catalog is None
- assert tab_state.catalog is None
- assert table_schema.catalog is None
- assert dataset.catalog_perm is None
- assert dataset.schema_perm == "[my_db].[public]"
- assert chart.catalog_perm is None
- assert chart.schema_perm == "[my_db].[public]"
- assert (
- session.query(ViewMenu.name, Permission.name)
- .join(PermissionView, ViewMenu.id == PermissionView.view_menu_id)
- .join(Permission, PermissionView.permission_id == Permission.id)
- .all()
- ) == [
- ("[my_db].(id:1)", "database_access"),
- ("[my_db].[my_table](id:1)", "datasource_access"),
- ("[my_db].[public]", "schema_access"),
- ]
-
- # make sure new dataset/chart were deleted
- assert session.query(SqlaTable).all() == [dataset]
- assert session.query(Slice).all() == [chart]
-
-
-def test_upgrade_catalog_perms_graceful(
- mocker: MockerFixture,
- session: Session,
-) -> None:
- """
- Test the `upgrade_catalog_perms` function when it fails to connect to the
DB.
-
- During the migration we try to connect to the analytical database to get
the list of
- schemas. This should fail gracefully and not raise an exception, since the
database
- could be offline, and the permissions can be generated later then the
admin enables
- catalog browsing on the database (permissions are always synced on a DB
update, see
- `UpdateDatabaseCommand`).
- """
- from superset.connectors.sqla.models import SqlaTable
- from superset.models.core import Database
- from superset.models.slice import Slice
- from superset.models.sql_lab import Query, SavedQuery, TableSchema,
TabState
-
- engine = session.get_bind()
- Database.metadata.create_all(engine)
-
- mocker.patch("superset.migrations.shared.catalogs.op")
- db = mocker.patch("superset.migrations.shared.catalogs.db")
- db.Session.return_value = session
-
- mocker.patch.object(
- Database,
- "get_all_schema_names",
- side_effect=Exception("Failed to connect to the database"),
- )
- mocker.patch("superset.migrations.shared.catalogs.op", session)
-
- database = Database(
- database_name="my_db",
- sqlalchemy_uri="postgresql://localhost/db",
- )
- dataset = SqlaTable(
- table_name="my_table",
- database=database,
- catalog=None,
- schema="public",
- schema_perm="[my_db].[public]",
- )
- session.add(dataset)
- session.commit()
- chart = Slice(
- slice_name="my_chart",
- datasource_type="table",
- datasource_id=dataset.id,
- )
- query = Query(
- client_id="foo",
- database=database,
- catalog=None,
- schema="public",
- )
- saved_query = SavedQuery(
- database=database,
- sql="SELECT * FROM public.t",
- catalog=None,
- schema="public",
- )
- tab_state = TabState(
- database=database,
- catalog=None,
- schema="public",
- )
- table_schema = TableSchema(
- database=database,
- catalog=None,
- schema="public",
- )
- session.add_all([chart, query, saved_query, tab_state, table_schema])
- session.commit()
-
- # before migration
- assert dataset.catalog is None
- assert query.catalog is None
- assert saved_query.catalog is None
- assert tab_state.catalog is None
- assert table_schema.catalog is None
- assert dataset.schema_perm == "[my_db].[public]"
- assert chart.schema_perm == "[my_db].[public]"
- assert session.query(ViewMenu.name).all() == [
- ("[my_db].(id:1)",),
- ("[my_db].[my_table](id:1)",),
- ("[my_db].[public]",),
- ]
+metadata = sa.MetaData()
- upgrade_catalog_perms()
- session.commit()
+dbs = sa.Table(
+ "dbs",
+ metadata,
+ sa.Column("id", sa.Integer, primary_key=True),
+ sa.Column("database_name", sa.String(250)),
+ sa.Column("sqlalchemy_uri", sa.String(1024)),
+ sa.Column("encrypted_extra", sa.Text),
+)
+view_menu = sa.Table(
+ "ab_view_menu",
+ metadata,
+ sa.Column("id", sa.Integer, primary_key=True),
+ sa.Column("name", sa.String(250)),
+)
+tables = sa.Table(
+ "tables",
+ metadata,
+ sa.Column("id", sa.Integer, primary_key=True),
+ sa.Column("database_id", sa.Integer),
+ sa.Column("schema", sa.String(255)),
+ sa.Column("schema_perm", sa.String(1000)),
+ sa.Column("catalog", sa.String(256)),
+ sa.Column("catalog_perm", sa.String(1000)),
+)
+query = sa.Table(
+ "query",
+ metadata,
+ sa.Column("id", sa.Integer, primary_key=True),
+ sa.Column("database_id", sa.Integer),
+ sa.Column("catalog", sa.String(256)),
+)
- # after migration
- assert dataset.catalog == "db"
- assert query.catalog == "db"
- assert saved_query.catalog == "db"
- assert tab_state.catalog == "db"
- assert table_schema.catalog == "db"
- assert dataset.schema_perm == "[my_db].[db].[public]"
- assert chart.schema_perm == "[my_db].[db].[public]"
- assert session.query(ViewMenu.name).all() == [
- ("[my_db].(id:1)",),
- ("[my_db].[my_table](id:1)",),
- ("[my_db].[db].[public]",),
- ("[my_db].[db]",),
- ]
+# Engine sets passed by the migrations that call these helpers.
+MIGRATION_ENGINES = [
+ {"postgresql"},
+ {"databricks"},
+ {"trino", "presto", "bigquery", "snowflake"},
+ None,
+]
- downgrade_catalog_perms()
- session.commit()
- # revert
- assert dataset.catalog is None
- assert query.catalog is None
- assert saved_query.catalog is None
- assert tab_state.catalog is None
- assert table_schema.catalog is None
- assert dataset.schema_perm == "[my_db].[public]"
- assert chart.schema_perm == "[my_db].[public]"
- assert session.query(ViewMenu.name).all() == [
- ("[my_db].(id:1)",),
- ("[my_db].[my_table](id:1)",),
- ("[my_db].[public]",),
- ]
+def _snapshot(session: Session) -> dict[str, list[Any]]:
Review Comment:
<div>
<div id="suggestion">
<div id="issue"><b>Missing docstring on helper</b></div>
<div id="fix">
BITO.md adaptive rule 12147 requires docstrings on all newly introduced
Python functions, including test helpers. The new helper `_snapshot` (consumed
by `populated_session`-based tests to diff metadata state around
`upgrade_catalog_perms`/`downgrade_catalog_perms`) has none. Add a one-line
docstring documenting the returned {table_name: [row_tuples]} mapping.
</div>
</div>
<small><i>Code Review Run #ae5f4a</i></small>
</div>
---
Should Bito avoid suggestions like this for future reviews? (<a
href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>)
- [ ] Yes, avoid them
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
