Antonio-RiveroMartnez commented on code in PR #21912:
URL: https://github.com/apache/superset/pull/21912#discussion_r1037558816
##########
setup.py:
##########
@@ -113,6 +113,7 @@ def get_git_sha() -> str:
"PyJWT>=2.4.0, <3.0",
"redis",
"selenium>=3.141.0",
+ "sshtunnel>=0.4.0",
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
##########
superset/migrations/versions/2022-10-20_10-48_f3c2d8ec8595_create_ssh_tunnel_credentials_tbl.py:
##########
@@ -0,0 +1,78 @@
+# 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.
+"""create_ssh_tunnel_credentials_tbl
+
+Revision ID: f3c2d8ec8595
+Revises: deb4c9d4a4ef
+Create Date: 2022-10-20 10:48:08.722861
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "f3c2d8ec8595"
+down_revision = "deb4c9d4a4ef"
+
+from uuid import uuid4
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy_utils import UUIDType
+
+from superset import app
+from superset.extensions import encrypted_field_factory
+
+app_config = app.config
+
+
+def upgrade():
+ op.create_table(
+ "ssh_tunnels",
+ # AuditMixinNullable
+ sa.Column("created_on", sa.DateTime(), nullable=True),
+ sa.Column("changed_on", sa.DateTime(), nullable=True),
+ sa.Column("created_by_fk", sa.Integer(), nullable=True),
+ sa.Column("changed_by_fk", sa.Integer(), nullable=True),
+ # ExtraJSONMixin
+ sa.Column("extra_json", sa.Text(), nullable=True),
+ # ImportExportMixin
+ sa.Column("uuid", UUIDType(binary=True), primary_key=False,
default=uuid4),
+ # SSHTunnelCredentials
+ sa.Column("id", sa.Integer(), primary_key=True),
+ sa.Column("database_id", sa.INTEGER(), sa.ForeignKey("dbs.id")),
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
##########
superset/databases/ssh_tunnel/models.py:
##########
@@ -0,0 +1,86 @@
+# 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.
+
+from typing import Any, Dict
+
+import sqlalchemy as sa
+from flask_appbuilder import Model
+from sqlalchemy.orm import backref, relationship
+from sqlalchemy_utils import EncryptedType
+
+from superset import app
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
##########
superset/models/core.py:
##########
@@ -419,6 +450,13 @@ def _get_sqla_engine(
sqlalchemy_url, params, effective_username, security_manager,
source
)
+ if ssh_tunnel_server:
+ # update sqlalchemy_url
+ url = make_url_safe(sqlalchemy_url)
+ sqlalchemy_url = url.set(
+ host="127.0.0.1", port=ssh_tunnel_server.local_bind_port
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
##########
tests/unit_tests/databases/ssh_tunnel/commands/__init__.py:
##########
@@ -0,0 +1,16 @@
+# 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
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
##########
superset/databases/ssh_tunnel/models.py:
##########
@@ -0,0 +1,86 @@
+# 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.
+
+from typing import Any, Dict
+
+import sqlalchemy as sa
+from flask_appbuilder import Model
+from sqlalchemy.orm import backref, relationship
+from sqlalchemy_utils import EncryptedType
+
+from superset import app
+from superset.models.core import Database
+from superset.models.helpers import (
+ AuditMixinNullable,
+ ExtraJSONMixin,
+ ImportExportMixin,
+)
+
+app_config = app.config
+
+
+class SSHTunnel(Model, AuditMixinNullable, ExtraJSONMixin, ImportExportMixin):
+ """
+ A ssh tunnel configuration in a database.
+ """
+
+ __tablename__ = "ssh_tunnels"
+
+ id = sa.Column(sa.Integer, primary_key=True)
+ database_id = sa.Column(sa.Integer, sa.ForeignKey("dbs.id"),
nullable=False)
+ database: Database = relationship(
+ "Database",
+ backref=backref("ssh_tunnels", cascade="all, delete-orphan"),
+ foreign_keys=[database_id],
+ )
+
+ server_address = sa.Column(EncryptedType(sa.String,
app_config["SECRET_KEY"]))
+ server_port = sa.Column(EncryptedType(sa.Integer,
app_config["SECRET_KEY"]))
+ username = sa.Column(EncryptedType(sa.String, app_config["SECRET_KEY"]))
+
+ # basic authentication
+ password = sa.Column(
+ EncryptedType(sa.String, app_config["SECRET_KEY"]), nullable=True
+ )
+
+ # password protected pkey authentication
+ private_key = sa.Column(
+ EncryptedType(sa.String, app_config["SECRET_KEY"]), nullable=True
+ )
+ private_key_password = sa.Column(
+ EncryptedType(sa.String, app_config["SECRET_KEY"]), nullable=True
+ )
+
+ bind_host = sa.Column(EncryptedType(sa.String, app_config["SECRET_KEY"]))
+ bind_port = sa.Column(EncryptedType(sa.Integer, app_config["SECRET_KEY"]))
+
+ def parameters(self) -> Dict[str, Any]:
+ params = {
+ "ssh_address_or_host": self.server_address,
+ "ssh_port": self.server_port,
+ "ssh_username": self.username,
+ "remote_bind_address": (self.bind_host, self.bind_port),
+ "local_bind_address": ("127.0.0.1",),
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
##########
superset/databases/ssh_tunnel/models.py:
##########
@@ -0,0 +1,86 @@
+# 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.
+
+from typing import Any, Dict
+
+import sqlalchemy as sa
+from flask_appbuilder import Model
+from sqlalchemy.orm import backref, relationship
+from sqlalchemy_utils import EncryptedType
+
+from superset import app
+from superset.models.core import Database
+from superset.models.helpers import (
+ AuditMixinNullable,
+ ExtraJSONMixin,
+ ImportExportMixin,
+)
+
+app_config = app.config
+
+
+class SSHTunnel(Model, AuditMixinNullable, ExtraJSONMixin, ImportExportMixin):
+ """
+ A ssh tunnel configuration in a database.
+ """
+
+ __tablename__ = "ssh_tunnels"
+
+ id = sa.Column(sa.Integer, primary_key=True)
+ database_id = sa.Column(sa.Integer, sa.ForeignKey("dbs.id"),
nullable=False)
+ database: Database = relationship(
+ "Database",
+ backref=backref("ssh_tunnels", cascade="all, delete-orphan"),
+ foreign_keys=[database_id],
+ )
+
+ server_address = sa.Column(EncryptedType(sa.String,
app_config["SECRET_KEY"]))
+ server_port = sa.Column(EncryptedType(sa.Integer,
app_config["SECRET_KEY"]))
+ username = sa.Column(EncryptedType(sa.String, app_config["SECRET_KEY"]))
+
+ # basic authentication
+ password = sa.Column(
+ EncryptedType(sa.String, app_config["SECRET_KEY"]), nullable=True
+ )
+
+ # password protected pkey authentication
+ private_key = sa.Column(
+ EncryptedType(sa.String, app_config["SECRET_KEY"]), nullable=True
+ )
+ private_key_password = sa.Column(
+ EncryptedType(sa.String, app_config["SECRET_KEY"]), nullable=True
+ )
+
+ bind_host = sa.Column(EncryptedType(sa.String, app_config["SECRET_KEY"]))
+ bind_port = sa.Column(EncryptedType(sa.Integer, app_config["SECRET_KEY"]))
+
+ def parameters(self) -> Dict[str, Any]:
+ params = {
+ "ssh_address_or_host": self.server_address,
+ "ssh_port": self.server_port,
+ "ssh_username": self.username,
+ "remote_bind_address": (self.bind_host, self.bind_port),
+ "local_bind_address": ("127.0.0.1",),
+ }
+
+ if self.password:
+ params["ssh_password"] = self.password
+ elif self.private_key:
+ params["ssh_pkey"] = self.private_key
+ params["ssh_private_key_password"] = self.private_key_password
Review Comment:
Should be fixed as part of: https://github.com/apache/superset/pull/22306
--
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: notifications-unsubscr...@superset.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org
For additional commands, e-mail: notifications-h...@superset.apache.org
