codeant-ai-for-open-source[bot] commented on code in PR #41300: URL: https://github.com/apache/superset/pull/41300#discussion_r3457089769
########## 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 Review Comment: **Suggestion:** The subprocess environment inherits all parent variables, so a developer/CI `SUPERSET_CONFIG_PATH` (or other local config import path) can override `FAB_API_SWAGGER_UI` and even prepend extra stdout lines from config loading, making this test flaky and not actually validating the base default. Build a minimal env for the subprocess (or explicitly remove config-path-related vars) so only `SUPERSET_ENABLE_SWAGGER_UI` controls the result. [logic error] <details> <summary><b>Severity Level:</b> Major ⚠️</summary> ```mdx - ⚠️ Unit test flakily fails when SUPERSET_CONFIG_PATH is set. - ⚠️ CI using local superset_config sees nondeterministic test behavior. ``` </details> <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Create a local config file, e.g. `/tmp/local_superset_config.py`, containing a side effect and override, such as: `print("LOCAL CONFIG LOADED")` and `FAB_API_SWAGGER_UI = True`. 2. Export `SUPERSET_CONFIG_PATH=/tmp/local_superset_config.py` in your shell so it is present in the test process environment; this is the env var consumed by `superset.config` at `superset/config.py:2768-2776` to import and apply overrides from an arbitrary file. 3. Run `pytest tests/unit_tests/config_swagger_ui_test.py`; inside the test helper `_resolve_swagger_default()` at `tests/unit_tests/config_swagger_ui_test.py:31-47`, a subprocess is spawned with `env = dict(os.environ)` (line 32), so the child process inherits `SUPERSET_CONFIG_PATH`. 4. In the subprocess, `import superset.config as c` (from the `-c` snippet at `tests/unit_tests/config_swagger_ui_test.py:36-41`) executes the bottom-of-file logic in `superset/config.py:2768-33`, which: a) imports `/tmp/local_superset_config.py` and applies its uppercase attributes (including `FAB_API_SWAGGER_UI = True`), b) prints `Loaded your LOCAL configuration at [/tmp/local_superset_config.py]` via `click.secho` (line 19), c) then `print(c.FAB_API_SWAGGER_UI)` runs, so `result.stdout` from `subprocess.run()` (line 36) contains both the secho message and the value, e.g. `"Loaded your LOCAL configuration at [/tmp/local_superset_config.py]\nTrue\n"`. When `_resolve_swagger_default()` returns `result.stdout.strip()` at line 47, it yields the entire multi-line string, which does not equal `"True"` / `"False"`, causing `test_fab_api_swagger_ui_is_env_driven_and_off_by_default` at lines 60-63 to fail and demonstrating the test is affected by inherited environment and local config rather than purely the base default. ``` </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=c8429558b9fe484990b8f2242976e954&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=c8429558b9fe484990b8f2242976e954&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:** 32:35 **Comment:** *Logic Error: The subprocess environment inherits all parent variables, so a developer/CI `SUPERSET_CONFIG_PATH` (or other local config import path) can override `FAB_API_SWAGGER_UI` and even prepend extra stdout lines from config loading, making this test flaky and not actually validating the base default. Build a minimal env for the subprocess (or explicitly remove config-path-related vars) so only `SUPERSET_ENABLE_SWAGGER_UI` controls the result. 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=c6f66a634bd3ab4cb77a454a3f0a6ed1a3d35e2851286866fefa543dafb7e189&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41300&comment_hash=c6f66a634bd3ab4cb77a454a3f0a6ed1a3d35e2851286866fefa543dafb7e189&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]
