codeant-ai-for-open-source[bot] commented on code in PR #40746: URL: https://github.com/apache/superset/pull/40746#discussion_r3408249532
########## tests/unit_tests/mcp_service/user/test_schemas.py: ########## @@ -0,0 +1,177 @@ +# 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 user-related MCP schemas.""" + +from unittest.mock import MagicMock + +import pytest +from pydantic import ValidationError +from sqlalchemy.orm.exc import DetachedInstanceError + +from superset.mcp_service.user.schemas import ( + sanitize_for_llm_context, + serialize_user_object, + UserInfo, +) + + +def test_user_info_rejects_bare_string_for_roles() -> None: + """A plain string must not be silently split into individual characters.""" + with pytest.raises(ValidationError): + UserInfo(roles="Admin") + + +def test_user_info_preserves_empty_roles_list() -> None: + """Empty roles should remain [] so callers can distinguish it from None.""" + info = UserInfo(roles=[]) + assert info.roles == [] + + +def test_user_info_coerces_role_objects_to_names() -> None: + """Role-like ORM objects must be converted to their .name strings.""" + role_admin = MagicMock() + role_admin.name = "Admin" + role_alpha = MagicMock() + role_alpha.name = "Alpha" + + info = UserInfo(roles=[role_admin, role_alpha]) + + assert info.roles == ["Admin", "Alpha"] + + +def test_user_info_ignores_role_with_detached_instance() -> None: + """Detached ORM roles must not blow up serialization.""" + role_good = MagicMock() + role_good.name = "Admin" + + class DetachedRole: + """Mock ORM role that raises DetachedInstanceError on name access.""" + + @property + def name(self) -> str: + raise DetachedInstanceError() Review Comment: **Suggestion:** Add an inline docstring to the new `@property` method so all newly added functions/methods are documented. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a newly added method in the test file, and it lacks a docstring. The custom rule explicitly requires newly added Python functions and classes to be documented inline, so the suggestion correctly identifies a real violation. </details> [Fix in Cursor](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=196060af1e7a4cdda33256b82bb4abab&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) | [Fix in VSCode Claude](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=196060af1e7a4cdda33256b82bb4abab&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/user/test_schemas.py **Line:** 65:67 **Comment:** *Custom Rule: Add an inline docstring to the new `@property` method so all newly added functions/methods are documented. 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%2F40746&comment_hash=98bd6ec66f750447683a32464bb647b413a0a0e0a17618b54abcbc194c137fe6&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F40746&comment_hash=98bd6ec66f750447683a32464bb647b413a0a0e0a17618b54abcbc194c137fe6&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]
