codeant-ai-for-open-source[bot] commented on code in PR #41421: URL: https://github.com/apache/superset/pull/41421#discussion_r3484712805
########## tests/unit_tests/db_engine_specs/test_databricks_multi_cloud.py: ########## @@ -0,0 +1,124 @@ +# 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. +# pylint: disable=unused-argument, import-outside-toplevel, protected-access + +from typing import Any +from unittest.mock import MagicMock +from urllib.parse import parse_qs, urlparse + +import pytest +from pytest_mock import MockerFixture + +from superset.db_engine_specs.databricks import ( + DatabricksNativeEngineSpec, + DatabricksPythonConnectorEngineSpec, +) +from superset.superset_typing import OAuth2ClientConfig +from superset.utils.oauth2 import decode_oauth2_state + +# Multi-Cloud Provider Tests +# +# Databricks fronts the user-to-machine OAuth2 flow on every workspace at +# `https://<workspace-host>/oidc/v1/{authorize,token}`, regardless of cloud, so +# the authorization endpoint derives from the connection host with no per-cloud +# account/tenant identifier. + +SPECS = [DatabricksNativeEngineSpec, DatabricksPythonConnectorEngineSpec] + +# Representative workspace hosts for each cloud provider. +CLOUD_HOSTS = [ + "my-cluster.cloud.databricks.com", # AWS + "adb-123456789.12.azuredatabricks.net", # Azure + "123456789.gcp.databricks.com", # GCP +] + + [email protected] +def oauth2_config_no_uri() -> OAuth2ClientConfig: + """ + Config for Databricks OAuth2 without a pre-configured endpoint, so the + authorization endpoint is derived from the workspace host. + """ + return { + "id": "databricks-client-id", + "secret": "databricks-client-secret", + "scope": "sql", + "redirect_uri": "http://localhost:8088/api/v1/database/oauth2/";, + "authorization_request_uri": "", + "token_request_uri": "", + "request_content_type": "json", + } + + +def _mock_database(mocker: MockerFixture, host: str) -> MagicMock: + database = mocker.MagicMock() + database.url_object.host = host + database.id = 1 + return database Review Comment: **Suggestion:** Add a short docstring to this new helper function to describe what mock object it creates and returns. [custom_rule] **Severity Level:** Minor ⚠️ <details> <summary><b>Why it matters? 🤔 </b></summary> This is a newly added Python helper function and it does not include a docstring. The custom rule explicitly requires new functions and classes to be documented inline, so the suggestion identifies a real violation. </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=2209d47f76024517967ad3dd196e41ec&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=2209d47f76024517967ad3dd196e41ec&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/db_engine_specs/test_databricks_multi_cloud.py **Line:** 67:71 **Comment:** *Custom Rule: Add a short docstring to this new helper function to describe what mock object it creates and returns. 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%2F41421&comment_hash=d1aff0fbf5515b4a2923cc3ddeeea7187af147162ae0b2f9c5cc8b29ecc7bb0f&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F41421&comment_hash=d1aff0fbf5515b4a2923cc3ddeeea7187af147162ae0b2f9c5cc8b29ecc7bb0f&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]
