Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created Superset request wrapper #1

Merged
merged 3 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions src/pySupersetCli/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@

from pySupersetCli.version import __version__, __author__, __email__, __repository__, __license__
from pySupersetCli.ret import Ret
from pySupersetCli.superset import Superset


################################################################################
Expand Down Expand Up @@ -115,6 +116,14 @@ def add_parser() -> argparse.ArgumentParser:
help="Print full command details before executing the command.\
Enables logs of type INFO and WARNING.")

parser.add_argument("--no_ssl",
action="store_true",
help="Disables SSL certificate verification.")

parser.add_argument("--basic_auth",
action="store_true",
help="Use basic authentication instead of LDAP.")

return parser


Expand Down Expand Up @@ -151,7 +160,25 @@ def main() -> Ret:
for arg in vars(args):
LOG.info("* %s = %s", arg, vars(args)[arg])

if Ret.OK == ret_status:
# Create Superset client.
try:
verify_ssl = not args.no_ssl
provider = Superset.Provider.LDAP

if args.basic_auth:
provider = Superset.Provider.DB

# pylint: disable=unused-variable
client = Superset(args.server,
args.user,
args.password,
provider,
verify_ssl=verify_ssl)

except RuntimeError as e:
LOG.error("Failed to create Superset client: %s", e)
ret_status = Ret.ERROR_LOGIN
else:
handler = None

# Find the command handler.
Expand All @@ -162,7 +189,7 @@ def main() -> Ret:

# Execute the command.
if handler is not None:
ret_status = Ret.OK
ret_status = handler(args, client)
else:
LOG.error("Command '%s' not found!", args.cmd)
ret_status = Ret.ERROR_INVALID_ARGUMENTS
Expand Down
212 changes: 212 additions & 0 deletions src/pySupersetCli/superset.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,212 @@
"""Server wrapper for requests to the Superset API."""

# BSD 3-Clause License
#
# Copyright (c) 2024, NewTec GmbH
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICU5LAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

################################################################################
# Imports
################################################################################

from dataclasses import dataclass
import logging
import requests
import urllib3


################################################################################
# Variables
################################################################################

LOG: logging.Logger = logging.getLogger(__name__)

################################################################################
# Classes
################################################################################


class Superset: # pylint: disable=too-few-public-methods
"""
Wrapper of the requests module for the Superset API.
Handles the authentication and the API calls.
Implements parts of the Superset API: https://superset.apache.org/docs/api/
"""

@dataclass
class Provider:
"""
Enum for the supported authentication providers.
"""
DB = "db"
LDAP = "ldap"

# pylint: disable=too-many-arguments
def __init__(self,
server_url: str,
username: str,
password: str,
provider: Provider,
verify_ssl: bool = True) -> None:
"""
Initializes the Superset object and logs in the user.

Args:
server_url (str): The URL of the Superset server.
username (str): The username of the user.
password (str): The password of the user.
provider (Provider): The authentication provider.
verify_ssl (bool): Verify the SSL certificate of the server.
"""
self._server_url: str = f"{server_url}/api/v1"
self._access_token: str = ""
self._csrf_token: str = ""
self._timeout: int = 60
self._verify_ssl: bool = verify_ssl

if not self._verify_ssl:
# Disable SSL warnings if SSL verification is disabled
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)

# Login the user and retrieve the access token and the CSRF token
self._login(username, password, provider)

def _login(self, username: str, password: str, provider: Provider) -> None:
"""
Logs in the user and retrieves the access token and the refresh token.

Args:
username (str): The username of the user.
password (str): The password of the user.
provider (Provider): The authentication provider.

Returns:
None
"""
login_endpoint: str = "/security/login"
crsf_token_endpoint: str = "/security/csrf_token/"

login_body: dict = {
"password": password,
"provider": provider,
"refresh": True,
"username": username
}

# Send the login request
ret_code, response = self.request("POST",
login_endpoint,
json=login_body)

if requests.codes.ok != ret_code: # pylint: disable=no-member
LOG.fatal("Login failed: %s", response.get("message"))
raise RuntimeError("Login failed")

self._access_token = response.get("access_token", "")

# Get the CSRF token
ret_code, response = self.request("GET", crsf_token_endpoint)

if requests.codes.ok != ret_code: # pylint: disable=no-member
LOG.fatal("Get CSRF token failed: %s", response.get("message"))
raise RuntimeError("Get CSRF token failed")

self._csrf_token = response.get("result", "")

if self._access_token == "" or self._csrf_token == "":
LOG.fatal("Tokens failed: Access token or CSRF token not received.")
raise RuntimeError("Tokens failed")

def request(self,
method: str,
endpoint: str,
**request_kwargs) -> tuple[int, dict]:
"""
Sends a request to the Superset API.

Args:
method (str): The HTTP method of the request.
endpoint (str): The endpoint of the request after '/api/v1'.
data (dict): The data of the request.
request_kwargs (dict): Additional keyword arguments for the request.
Can be any accepted by the Requests module.

Returns:
dict: The response of the request.
"""

url: str = f"{self._server_url}{endpoint}"
headers: dict = {}
response_code: int = 0
reponse_data: dict = {}

# If already logged in, add the access token to the headers
if self._access_token != "":
headers = {
'Authorization': f'Bearer {self._access_token}',
'referer': self._server_url,
'X-CSRFToken': self._csrf_token
}

try:
# Send the request
response: requests.Response = requests.request(
method=method,
url=url,
headers=headers,
timeout=self._timeout,
verify=self._verify_ssl,
** request_kwargs)
except requests.exceptions.SSLError as e:
LOG.error("SSL error: %s", e)

if self._verify_ssl is True:
LOG.error("If you trust the server you are connecting to (%s), " +
"consider deactivating SSL verification.", self._server_url)

else:
# Check if the token has expired
if (requests.codes.unauthorized == response_code) and \
(reponse_data.get('message') == "Token has expired"): # pylint: disable=no-member
LOG.error("Refreshing token is not implemented.")
else:
response_code = response.status_code
reponse_data = response.json()

LOG.info("Request: %s %s", method, url)
LOG.info("Response Code: %s", response_code)

return (response_code, reponse_data)


################################################################################
# Functions
################################################################################

################################################################################
# Main
################################################################################