# 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. import logging from contextlib import closing from typing import Any, Dict, Optional from flask_appbuilder.security.sqla.models import User from sqlalchemy import select from superset.commands.base import BaseCommand from superset.databases.commands.exceptions import DatabaseSecurityUnsafeError from superset.databases.dao import DatabaseDAO from superset.models.core import Database from superset.security.analytics_db_safety import DBSecurityException logger = logging.getLogger(__name__) class TestConnectionDatabaseCommand(BaseCommand): def __init__(self, user: User, data: Dict[str, Any]): self._actor = user self._properties = data.copy() self._model: Optional[Database] = None def run(self) -> None: self.validate() try: uri = self._properties.get("sqlalchemy_uri", "") if self._model and uri == self._model.safe_sqlalchemy_uri(): uri = self._model.sqlalchemy_uri_decrypted database = DatabaseDAO.build_db_for_connection_test( server_cert=self._properties.get("server_cert", ""), extra=self._properties.get("extra", "{}"), impersonate_user=self._properties.get("impersonate_user", False), encrypted_extra=self._properties.get("encrypted_extra", "{}"), ) if database is not None: database.set_sqlalchemy_uri(uri) database.db_engine_spec.mutate_db_for_connection_test(database) username = self._actor.username if self._actor is not None else None engine = database.get_sqla_engine(user_name=username) with closing(engine.connect()) as conn: conn.scalar(select([1])) except DBSecurityException as ex: logger.warning(ex) raise DatabaseSecurityUnsafeError() def validate(self) -> None: database_name = self._properties.get("database_name") if database_name is not None: self._model = DatabaseDAO.get_database_by_name(database_name)