codeant-ai-for-open-source[bot] commented on code in PR #41300: URL: https://github.com/apache/superset/pull/41300#discussion_r3457077498
########## tests/unit_tests/config_swagger_ui_test.py: ########## @@ -0,0 +1,63 @@ +# 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 environment-driven Swagger UI config defaults. + +``superset.config`` is imported in a fresh subprocess for each case so the +module is evaluated under a controlled environment without reloading (and +mutating) the config module shared by the rest of the test session. +""" + +import os +import subprocess +import sys + +import pytest + + +def _resolve_swagger_default(env_value: str | None) -> str: + env = dict(os.environ) + env.pop("SUPERSET_ENABLE_SWAGGER_UI", None) + if env_value is not None: + env["SUPERSET_ENABLE_SWAGGER_UI"] = env_value + result = subprocess.run( # noqa: S603 + [ + sys.executable, + "-c", + "import superset.config as c; print(c.FAB_API_SWAGGER_UI)", + ], + env=env, + capture_output=True, + text=True, + check=True, + ) + return result.stdout.strip() Review Comment: **Suggestion:** Add a short function-level docstring describing the purpose and behavior of this helper. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a newly added Python function with no docstring in the final file. The stated rule requires newly added functions and classes to include docstrings, so the violation is real. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=35a48323e7dc434f879ff0c58536ec0d&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=35a48323e7dc434f879ff0c58536ec0d&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/config_swagger_ui_test.py **Line:** 31:47 **Comment:** *Custom Rule: Add a short function-level docstring describing the purpose and behavior of this helper. 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%2F41300&comment_hash=c127f108e671069a357b73957520a5857ffb1c762ed16b4262db79d7fd6321cb&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41300&comment_hash=c127f108e671069a357b73957520a5857ffb1c762ed16b4262db79d7fd6321cb&reaction=dislike'>👎</a> ########## tests/unit_tests/config_swagger_ui_test.py: ########## @@ -0,0 +1,63 @@ +# 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 environment-driven Swagger UI config defaults. + +``superset.config`` is imported in a fresh subprocess for each case so the +module is evaluated under a controlled environment without reloading (and +mutating) the config module shared by the rest of the test session. +""" + +import os +import subprocess +import sys + +import pytest + + +def _resolve_swagger_default(env_value: str | None) -> str: + env = dict(os.environ) + env.pop("SUPERSET_ENABLE_SWAGGER_UI", None) + if env_value is not None: + env["SUPERSET_ENABLE_SWAGGER_UI"] = env_value + result = subprocess.run( # noqa: S603 + [ + sys.executable, + "-c", + "import superset.config as c; print(c.FAB_API_SWAGGER_UI)", + ], + env=env, + capture_output=True, + text=True, + check=True, + ) + return result.stdout.strip() + + [email protected]( + "env_value, expected", + [ + (None, "False"), # unset -> off by default + ("true", "True"), + ("True", "True"), + ("false", "False"), + ("", "False"), + ], +) +def test_fab_api_swagger_ui_is_env_driven_and_off_by_default( + env_value: str | None, expected: str +) -> None: + assert _resolve_swagger_default(env_value) == expected Review Comment: **Suggestion:** Add a concise docstring to this new test function to explain the scenario being validated. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a newly added Python function and it does not include a docstring. That directly violates the custom rule requiring new functions and classes to be documented inline. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=681095dac2c74ce0990b2a75ab25a265&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=681095dac2c74ce0990b2a75ab25a265&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/config_swagger_ui_test.py **Line:** 60:63 **Comment:** *Custom Rule: Add a concise docstring to this new test function to explain the scenario being validated. 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%2F41300&comment_hash=d182aa27b8b6afc000ddd7d097cee16c29e68e3eb94b3a2c79bcab9d0281b3ee&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41300&comment_hash=d182aa27b8b6afc000ddd7d097cee16c29e68e3eb94b3a2c79bcab9d0281b3ee&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]
