codeant-ai-for-open-source[bot] commented on code in PR #40399: URL: https://github.com/apache/superset/pull/40399#discussion_r3422467964
########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,307 @@ +# 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. + +"""Tests for the update_dashboard MCP tool.""" + +from datetime import datetime +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + + [email protected] +def mcp_server(): + return mcp Review Comment: **Suggestion:** Add an explicit return type annotation to `mcp_server` so the new fixture is fully typed. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a newly added Python fixture function and it has no return type annotation. The custom rule requires new Python code to be fully typed, so this is a real violation. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=0f43a9257b3c4553abc8e2a9be993747&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=0f43a9257b3c4553abc8e2a9be993747&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py **Line:** 30:32 **Comment:** *Custom Rule: Add an explicit return type annotation to `mcp_server` so the new fixture is fully typed. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=4fc3a30e58e59cbd71be0e7a50735597b1664ff5244f03b3ea0468891069978c&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=4fc3a30e58e59cbd71be0e7a50735597b1664ff5244f03b3ea0468891069978c&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,307 @@ +# 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. + +"""Tests for the update_dashboard MCP tool.""" + +from datetime import datetime +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + + [email protected] +def mcp_server(): + return mcp + + [email protected](autouse=True) +def mock_auth(): + """Mock authentication for all tests in this module.""" + with patch( + "superset.mcp_service.auth.get_user_from_request" + ) as mock_get_user: + with patch("superset.security_manager.raise_for_ownership"): + 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( + id: int = 42, + title: str = "Test Dashboard", + slug: str | None = "test-slug", + published: bool = True, + css: str | None = None, + json_metadata: str | None = None, + position_json: str | None = None, +): + """Build a Mock with EVERY field the DashboardInfo serializer touches + explicitly set. Without this, Mock returns auto-Mock objects for + unset attributes, which Pydantic rejects as wrong-type.""" + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = title + dashboard.slug = slug + dashboard.description = "desc" + dashboard.published = published + dashboard.css = css + dashboard.json_metadata = json_metadata or json.dumps({"label_colors": {}}) + dashboard.position_json = position_json + dashboard.certified_by = None + dashboard.certification_details = None + dashboard.is_managed_externally = False + dashboard.external_url = None + dashboard.created_on = datetime(2024, 1, 1) + dashboard.changed_on = datetime(2024, 1, 1) + dashboard.created_by = Mock(username="admin") + dashboard.changed_by = Mock(username="admin") + dashboard.created_by_name = "admin" + dashboard.changed_by_name = "admin" + dashboard.created_on_humanized = "a day ago" + dashboard.changed_on_humanized = "a day ago" + dashboard.uuid = f"dashboard-uuid-{id}" + dashboard.slices = [] + dashboard.owners = [] + dashboard.tags = [] + return dashboard + + +class TestUpdateDashboard: + """update_dashboard patches existing dashboard layout/theme/CSS.""" + + @patch("superset.daos.dashboard.DashboardDAO.get_by_id_or_slug") + @patch("superset.extensions.db.session") + @pytest.mark.asyncio + async def test_update_layout_theme_and_css( + self, mock_session, mock_get, mcp_server + ) -> None: Review Comment: **Suggestion:** Add type annotations for all parameters in this new async test method so the function signature is fully typed. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> The method is newly added and its parameters `mock_session`, `mock_get`, and `mcp_server` are untyped. Under the custom rule, new Python methods must be fully typed, so this is a genuine violation. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=d6a591cba951457881665a7bacf719ec&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=d6a591cba951457881665a7bacf719ec&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py **Line:** 95:97 **Comment:** *Custom Rule: Add type annotations for all parameters in this new async test method so the function signature is fully typed. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=f65afeee3619fa5bfbd763671805e8557c54276ba0d25588efe3e7a299a715a0&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=f65afeee3619fa5bfbd763671805e8557c54276ba0d25588efe3e7a299a715a0&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,307 @@ +# 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. + +"""Tests for the update_dashboard MCP tool.""" + +from datetime import datetime +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + + [email protected] +def mcp_server(): + return mcp + + [email protected](autouse=True) +def mock_auth(): + """Mock authentication for all tests in this module.""" + with patch( + "superset.mcp_service.auth.get_user_from_request" + ) as mock_get_user: + with patch("superset.security_manager.raise_for_ownership"): + 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( + id: int = 42, + title: str = "Test Dashboard", + slug: str | None = "test-slug", + published: bool = True, + css: str | None = None, + json_metadata: str | None = None, + position_json: str | None = None, +): Review Comment: **Suggestion:** Add a return type annotation to `_mock_dashboard` so helper construction is fully typed. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> The helper function already has typed parameters, but it still omits a return type annotation. That violates the rule that new Python code should be fully typed. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=17471c7084ac4e1291144a2a7dc3ed84&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=17471c7084ac4e1291144a2a7dc3ed84&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py **Line:** 49:57 **Comment:** *Custom Rule: Add a return type annotation to `_mock_dashboard` so helper construction is fully typed. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=cdb3a7166000389c7c3d23c1b1ce2378327a70cf4c0f28614c5bdb28bf8c16e8&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=cdb3a7166000389c7c3d23c1b1ce2378327a70cf4c0f28614c5bdb28bf8c16e8&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,307 @@ +# 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. + +"""Tests for the update_dashboard MCP tool.""" + +from datetime import datetime +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + + [email protected] +def mcp_server(): + return mcp + + [email protected](autouse=True) Review Comment: **Suggestion:** Add a return type annotation to `mock_auth` (generator fixture return type) to satisfy full typing requirements. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This newly added fixture lacks both parameter annotations and a return type annotation. Since the rule requires new Python functions to be fully typed, the omission is real. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=c7677285c85544d4ba6bf578727daf0c&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=c7677285c85544d4ba6bf578727daf0c&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py **Line:** 35:35 **Comment:** *Custom Rule: Add a return type annotation to `mock_auth` (generator fixture return type) to satisfy full typing requirements. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=6f63d5e1f69ab45cdd64cfa4fcb61e48d9fdac2b4886f209fc20acd7de3ba1be&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=6f63d5e1f69ab45cdd64cfa4fcb61e48d9fdac2b4886f209fc20acd7de3ba1be&reaction=dislike'>👎</a> ########## tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py: ########## @@ -0,0 +1,307 @@ +# 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. + +"""Tests for the update_dashboard MCP tool.""" + +from datetime import datetime +from unittest.mock import Mock, patch + +import pytest +from fastmcp import Client + +from superset.mcp_service.app import mcp +from superset.utils import json + + [email protected] +def mcp_server(): + return mcp + + [email protected](autouse=True) +def mock_auth(): + """Mock authentication for all tests in this module.""" + with patch( + "superset.mcp_service.auth.get_user_from_request" + ) as mock_get_user: + with patch("superset.security_manager.raise_for_ownership"): + 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( + id: int = 42, + title: str = "Test Dashboard", + slug: str | None = "test-slug", + published: bool = True, + css: str | None = None, + json_metadata: str | None = None, + position_json: str | None = None, +): + """Build a Mock with EVERY field the DashboardInfo serializer touches + explicitly set. Without this, Mock returns auto-Mock objects for + unset attributes, which Pydantic rejects as wrong-type.""" + dashboard = Mock() + dashboard.id = id + dashboard.dashboard_title = title + dashboard.slug = slug + dashboard.description = "desc" + dashboard.published = published + dashboard.css = css + dashboard.json_metadata = json_metadata or json.dumps({"label_colors": {}}) + dashboard.position_json = position_json + dashboard.certified_by = None + dashboard.certification_details = None + dashboard.is_managed_externally = False + dashboard.external_url = None + dashboard.created_on = datetime(2024, 1, 1) + dashboard.changed_on = datetime(2024, 1, 1) + dashboard.created_by = Mock(username="admin") + dashboard.changed_by = Mock(username="admin") + dashboard.created_by_name = "admin" + dashboard.changed_by_name = "admin" + dashboard.created_on_humanized = "a day ago" + dashboard.changed_on_humanized = "a day ago" + dashboard.uuid = f"dashboard-uuid-{id}" + dashboard.slices = [] + dashboard.owners = [] + dashboard.tags = [] + return dashboard + + +class TestUpdateDashboard: + """update_dashboard patches existing dashboard layout/theme/CSS.""" + + @patch("superset.daos.dashboard.DashboardDAO.get_by_id_or_slug") + @patch("superset.extensions.db.session") + @pytest.mark.asyncio + async def test_update_layout_theme_and_css( + self, mock_session, mock_get, mcp_server + ) -> None: + dash = _mock_dashboard( + id=42, + json_metadata=json.dumps( + {"label_colors": {"Old": "#000"}, "cross_filters_enabled": True} + ), + ) + mock_get.return_value = dash + + position = {"ROOT_ID": {"type": "ROOT", "children": ["GRID_ID"]}} + overrides = { + "label_colors": {"Electronics": "#4C78A8"}, + "cross_filters_enabled": False, + } + + async with Client(mcp_server) as client: + result = await client.call_tool( + "update_dashboard", + {"request": { + "identifier": 42, + "position_json": position, + "json_metadata_overrides": overrides, + "css": ".x{color:red}", + }}, + ) + + # All three top-level writes applied to the model + assert dash.position_json == json.dumps(position) + assert dash.css == ".x{color:red}" + # json_metadata is shallow-merged: label_colors REPLACED (top-level + # key), but other keys not in overrides preserved + merged = json.loads(dash.json_metadata) + assert merged["label_colors"] == {"Electronics": "#4C78A8"} + assert merged["cross_filters_enabled"] is False + assert mock_session.commit.call_count >= 1 + # changed_fields enumerates what actually changed. + # StructuredContentStripperMiddleware strips structured_content; + # the JSON-encoded response lives in content[0].text. + payload = json.loads(result.content[0].text) + changed = set(payload.get("changed_fields") or []) + assert {"position_json", "json_metadata", "css"} <= changed + + @patch("superset.daos.dashboard.DashboardDAO.get_by_id_or_slug") + @patch("superset.extensions.db.session") + @pytest.mark.asyncio + async def test_update_with_no_fields_is_noop( + self, mock_session, mock_get, mcp_server + ) -> None: Review Comment: **Suggestion:** Add an inline docstring to this newly added test function to comply with the documentation requirement for new functions. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This newly added test function has no docstring immediately under the definition. The custom rule explicitly requires new functions and classes to include docstrings. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=776b15d57f094f01833b253ee49e1cba&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=776b15d57f094f01833b253ee49e1cba&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** tests/unit_tests/mcp_service/dashboard/tool/test_update_dashboard.py **Line:** 142:144 **Comment:** *Custom Rule: Add an inline docstring to this newly added test function to comply with the documentation requirement for new functions. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=b7e95621e312aa7ba5361fe24be116a2c559dec57a3fb1c94b577057c0f80969&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40399&comment_hash=b7e95621e312aa7ba5361fe24be116a2c559dec57a3fb1c94b577057c0f80969&reaction=dislike'>👎</a> -- 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]
