gkneighb commented on code in PR #41472: URL: https://github.com/apache/superset/pull/41472#discussion_r3555940874
########## tests/unit_tests/mcp_service/chart/tool/test_delete_chart.py: ########## @@ -0,0 +1,131 @@ +# 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. + +"""Unit tests for the delete_chart MCP tool. + +Run through the async MCP Client (not direct calls); auth is mocked via the +autouse mock_auth fixture, matching the other chart tool test files. +""" + +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp + + [email protected] +def mcp_server() -> object: + return mcp + + [email protected](autouse=True) +def mock_auth(): + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +def _mock_chart(chart_id: int = 10, slice_name: str = "Test Chart") -> Mock: + chart = Mock() + chart.id = chart_id + chart.slice_name = slice_name + return chart + + +@patch("superset.mcp_service.chart.tool.delete_chart.find_chart_by_identifier") [email protected] +async def test_delete_chart_not_found(mock_find: Mock, mcp_server: object) -> None: + mock_find.return_value = None + + async with Client(mcp_server) as client: + result = await client.call_tool( + "delete_chart", {"request": {"identifier": 999}} + ) + + content = result.structured_content + assert content["success"] is False + assert content["error_type"] == "NotFound" + assert "999" in (content["error"] or "") + + +@patch("superset.commands.chart.delete.DeleteChartCommand.run") +@patch("superset.mcp_service.chart.tool.delete_chart.find_chart_by_identifier") [email protected] +async def test_delete_chart_success( + mock_find: Mock, mock_run: Mock, mcp_server: object +) -> None: + mock_find.return_value = _mock_chart(chart_id=10, slice_name="Sales") + mock_run.return_value = None + + async with Client(mcp_server) as client: + result = await client.call_tool("delete_chart", {"request": {"identifier": 10}}) + + content = result.structured_content + assert content["success"] is True + assert content["deleted_id"] == 10 Review Comment: Fixed in 0439d6b2b2. Two tests added: CommandException passthrough and SQLAlchemyError-is-generic. ########## superset/mcp_service/dashboard/schemas.py: ########## @@ -1784,6 +1784,31 @@ def dashboard_layout_serializer(dashboard: "Dashboard") -> DashboardLayout: ) +class DeleteDashboardRequest(BaseModel): + """Request schema for delete_dashboard.""" + + identifier: int | str = Field( + ..., + description="Dashboard identifier - numeric ID, UUID string, or slug.", + ) Review Comment: Fixed in 0439d6b2b2. Boolean identifiers are rejected with a validator on both request schemas, with tests. ########## superset/mcp_service/chart/tool/delete_chart.py: ########## @@ -0,0 +1,140 @@ +# 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. + +""" +MCP tool: delete_chart +""" + +import logging + +from fastmcp import Context +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.commands.chart.exceptions import ( + ChartDeleteFailedReportsExistError, + ChartForbiddenError, + ChartNotFoundError, +) +from superset.commands.exceptions import CommandException +from superset.extensions import event_logger +from superset.mcp_service.chart.chart_helpers import find_chart_by_identifier +from superset.mcp_service.chart.schemas import ( + DeleteChartRequest, + DeleteChartResponse, +) +from superset.mcp_service.utils import escape_llm_context_delimiters + +logger = logging.getLogger(__name__) + + +def _rollback() -> None: + from superset import db + + try: + db.session.rollback() # pylint: disable=consider-using-transaction + except SQLAlchemyError: + logger.warning("Database rollback failed during delete_chart error handling") + + +@tool( + tags=["mutate"], + class_permission_name="Chart", + annotations=ToolAnnotations( + title="Delete chart", + readOnlyHint=False, + destructiveHint=True, + ), +) +async def delete_chart( + request: DeleteChartRequest, ctx: Context +) -> DeleteChartResponse: + """Permanently delete a saved chart. + + Identify the chart by numeric ID or UUID string (NOT chart name). This is + destructive and cannot be undone. The caller must own the chart (or be an + Admin); charts with attached alerts/reports cannot be deleted until those + are removed. + + Example: + ```json + {"identifier": 123} + ``` + + Returns success with the deleted chart's id/name, or an error. When the + caller lacks permission, ``permission_denied`` is true — do not retry; ask + the user. + """ + await ctx.info("Deleting chart: identifier=%s" % (request.identifier,)) + + chart = find_chart_by_identifier(request.identifier) + if not chart: + safe_id = escape_llm_context_delimiters(str(request.identifier)[:200]) + msg = ( + f"No chart found with identifier: {safe_id}. " + "Use list_charts to get valid chart IDs." + ) + return DeleteChartResponse(success=False, error=msg, error_type="NotFound") Review Comment: Fixed in 0439d6b2b2. Lookup wrapped; db failures return structured LookupFailed. ########## superset/mcp_service/dashboard/tool/delete_dashboard.py: ########## @@ -0,0 +1,166 @@ +# 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. + +""" +MCP tool: delete_dashboard +""" + +import logging +from typing import Any + +from fastmcp import Context +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.commands.dashboard.exceptions import ( + DashboardDeleteFailedReportsExistError, + DashboardForbiddenError, + DashboardNotFoundError, +) +from superset.commands.exceptions import CommandException +from superset.extensions import event_logger +from superset.mcp_service.dashboard.schemas import ( + DeleteDashboardRequest, + DeleteDashboardResponse, +) +from superset.mcp_service.utils import escape_llm_context_delimiters + +logger = logging.getLogger(__name__) + + +def _find_dashboard_by_identifier(identifier: int | str) -> Any | None: + """Resolve a dashboard by numeric ID, UUID string, or slug. Returns None.""" + from superset.daos.dashboard import DashboardDAO + + if isinstance(identifier, int) or ( + isinstance(identifier, str) and identifier.isdigit() + ): + return DashboardDAO.find_by_id(int(identifier)) + # Try UUID, then fall back to slug. + dashboard = DashboardDAO.find_by_id(identifier, id_column="uuid") + if dashboard: + return dashboard + try: + return DashboardDAO.get_by_id_or_slug(identifier) + except DashboardNotFoundError: + return None + + +def _rollback() -> None: + from superset import db + + try: + db.session.rollback() # pylint: disable=consider-using-transaction + except SQLAlchemyError: + logger.warning( + "Database rollback failed during delete_dashboard error handling" + ) + + +@tool( + tags=["mutate"], + class_permission_name="Dashboard", + annotations=ToolAnnotations( + title="Delete dashboard", + readOnlyHint=False, + destructiveHint=True, + ), +) +async def delete_dashboard( + request: DeleteDashboardRequest, ctx: Context +) -> DeleteDashboardResponse: + """Permanently delete a dashboard. + + Identify the dashboard by numeric ID, UUID string, or slug. This is + destructive and cannot be undone. It removes the dashboard container only — + the charts on it are NOT deleted. The caller must own the dashboard (or be + an Admin); dashboards with attached alerts/reports cannot be deleted until + those are removed. + + Example: + ```json + {"identifier": 42} + ``` + + Returns success with the deleted dashboard's id/title, or an error. When the + caller lacks permission, ``permission_denied`` is true — do not retry; ask + the user. + """ + await ctx.info("Deleting dashboard: identifier=%s" % (request.identifier,)) + + dashboard = _find_dashboard_by_identifier(request.identifier) + if not dashboard: + safe_id = escape_llm_context_delimiters(str(request.identifier)[:200]) + msg = ( + f"No dashboard found with identifier: {safe_id}. " + "Use list_dashboards to get valid dashboard IDs." + ) + return DeleteDashboardResponse(success=False, error=msg, error_type="NotFound") Review Comment: Fixed in 0439d6b2b2. Same guard as delete_chart. ########## tests/unit_tests/mcp_service/dashboard/tool/test_delete_dashboard.py: ########## @@ -0,0 +1,143 @@ +# 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. + +"""Unit tests for the delete_dashboard MCP tool. + +Run through the async MCP Client; auth is mocked via the autouse mock_auth +fixture, matching the other dashboard tool test files. +""" + +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp + +_FIND = ( + "superset.mcp_service.dashboard.tool.delete_dashboard._find_dashboard_by_identifier" +) +_RUN = "superset.commands.dashboard.delete.DeleteDashboardCommand.run" + + [email protected] +def mcp_server() -> object: + return mcp + + [email protected](autouse=True) +def mock_auth(): + with patch("superset.mcp_service.auth.get_user_from_request") as mock_get_user: + mock_user = Mock() + mock_user.id = 1 + mock_user.username = "admin" + mock_get_user.return_value = mock_user + yield mock_get_user + + +def _mock_dashboard(dashboard_id: int = 1, title: str = "Sales Dashboard") -> Mock: + dashboard = Mock() + dashboard.id = dashboard_id + dashboard.dashboard_title = title + return dashboard + + +@patch(_FIND) [email protected] +async def test_delete_dashboard_not_found(mock_find: Mock, mcp_server: object) -> None: + mock_find.return_value = None + + async with Client(mcp_server) as client: + result = await client.call_tool( + "delete_dashboard", {"request": {"identifier": 999}} + ) + + content = result.structured_content + assert content["success"] is False + assert content["error_type"] == "NotFound" + assert "999" in (content["error"] or "") + + +@patch(_RUN) +@patch(_FIND) [email protected] +async def test_delete_dashboard_success( + mock_find: Mock, mock_run: Mock, mcp_server: object +) -> None: + mock_find.return_value = _mock_dashboard(1, "Sales Dashboard") + mock_run.return_value = None + + async with Client(mcp_server) as client: + result = await client.call_tool( + "delete_dashboard", {"request": {"identifier": 1}} + ) + + content = result.structured_content + assert content["success"] is True + assert content["deleted_id"] == 1 + assert content["deleted_name"] == "Sales Dashboard" + assert content["permission_denied"] is False + mock_run.assert_called_once() Review Comment: Fixed in 0439d6b2b2. The success test now asserts the message content. ########## superset/mcp_service/dashboard/tool/delete_dashboard.py: ########## @@ -0,0 +1,166 @@ +# 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. + +""" +MCP tool: delete_dashboard +""" + +import logging +from typing import Any + +from fastmcp import Context +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.commands.dashboard.exceptions import ( + DashboardDeleteFailedReportsExistError, + DashboardForbiddenError, + DashboardNotFoundError, +) +from superset.commands.exceptions import CommandException +from superset.extensions import event_logger +from superset.mcp_service.dashboard.schemas import ( + DeleteDashboardRequest, + DeleteDashboardResponse, +) +from superset.mcp_service.utils import escape_llm_context_delimiters + +logger = logging.getLogger(__name__) + + +def _find_dashboard_by_identifier(identifier: int | str) -> Any | None: + """Resolve a dashboard by numeric ID, UUID string, or slug. Returns None.""" + from superset.daos.dashboard import DashboardDAO + + if isinstance(identifier, int) or ( + isinstance(identifier, str) and identifier.isdigit() + ): + return DashboardDAO.find_by_id(int(identifier)) Review Comment: Declining: digit-strings resolving as IDs first matches DashboardDAO.get_by_id_or_slug and the REST API's semantics; changing precedence would break numeric-ID addressing. A dashboard with a purely-numeric slug remains addressable by UUID or ID. ########## superset/mcp_service/dashboard/tool/delete_dashboard.py: ########## @@ -0,0 +1,166 @@ +# 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. + +""" +MCP tool: delete_dashboard +""" + +import logging +from typing import Any + +from fastmcp import Context +from sqlalchemy.exc import SQLAlchemyError +from superset_core.mcp.decorators import tool, ToolAnnotations + +from superset.commands.dashboard.exceptions import ( + DashboardDeleteFailedReportsExistError, + DashboardForbiddenError, + DashboardNotFoundError, +) +from superset.commands.exceptions import CommandException +from superset.extensions import event_logger +from superset.mcp_service.dashboard.schemas import ( + DeleteDashboardRequest, + DeleteDashboardResponse, +) +from superset.mcp_service.utils import escape_llm_context_delimiters + +logger = logging.getLogger(__name__) + + +def _find_dashboard_by_identifier(identifier: int | str) -> Any | None: + """Resolve a dashboard by numeric ID, UUID string, or slug. Returns None.""" + from superset.daos.dashboard import DashboardDAO + + if isinstance(identifier, int) or ( + isinstance(identifier, str) and identifier.isdigit() + ): + return DashboardDAO.find_by_id(int(identifier)) + # Try UUID, then fall back to slug. + dashboard = DashboardDAO.find_by_id(identifier, id_column="uuid") + if dashboard: + return dashboard + try: + return DashboardDAO.get_by_id_or_slug(identifier) + except DashboardNotFoundError: + return None Review Comment: Partially applied in 0439d6b2b2: lookup-time SQLAlchemy failures now return a structured LookupFailed response. On access-denied: the DAO find path applies base_filter silently (rows the user cannot see come back as None → NotFound) rather than raising, so there is no access exception to catch there; ownership enforcement happens in the command and maps to permission_denied. -- 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]
