2020-04-15 04:40:14 -04:00
|
|
|
# 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 superset import db
|
|
|
|
# from superset.models.dashboard import Dashboard
|
|
|
|
import urllib.request
|
2021-05-14 15:49:25 -04:00
|
|
|
from io import BytesIO
|
2020-04-15 04:40:14 -04:00
|
|
|
from unittest import skipUnless
|
2021-06-08 10:33:42 -04:00
|
|
|
from unittest.mock import ANY, call, patch
|
2020-04-15 04:40:14 -04:00
|
|
|
|
|
|
|
from flask_testing import LiveServerTestCase
|
|
|
|
from sqlalchemy.sql import func
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
from superset import db, is_feature_enabled, security_manager
|
2020-08-12 16:28:41 -04:00
|
|
|
from superset.extensions import machine_auth_provider_factory
|
2020-04-15 04:40:14 -04:00
|
|
|
from superset.models.dashboard import Dashboard
|
|
|
|
from superset.models.slice import Slice
|
2020-08-12 16:28:41 -04:00
|
|
|
from superset.utils.screenshots import ChartScreenshot, DashboardScreenshot
|
2021-06-08 10:33:42 -04:00
|
|
|
from superset.utils.urls import get_url_host, get_url_path
|
|
|
|
from superset.utils.webdriver import WebDriverProxy
|
2021-07-01 11:03:07 -04:00
|
|
|
from tests.integration_tests.conftest import with_feature_flags
|
|
|
|
from tests.integration_tests.test_app import app
|
2020-04-15 04:40:14 -04:00
|
|
|
|
|
|
|
from .base_tests import SupersetTestCase
|
|
|
|
|
|
|
|
|
2020-06-29 18:36:06 -04:00
|
|
|
class TestThumbnailsSeleniumLive(LiveServerTestCase):
|
2020-04-15 04:40:14 -04:00
|
|
|
def create_app(self):
|
|
|
|
return app
|
|
|
|
|
|
|
|
def url_open_auth(self, username: str, url: str):
|
|
|
|
admin_user = security_manager.find_user(username=username)
|
2020-08-12 16:28:41 -04:00
|
|
|
cookies = machine_auth_provider_factory.instance.get_auth_cookies(admin_user)
|
2020-04-15 04:40:14 -04:00
|
|
|
opener = urllib.request.build_opener()
|
|
|
|
opener.addheaders.append(("Cookie", f"session={cookies['session']}"))
|
|
|
|
return opener.open(f"{self.get_server_url()}/{url}")
|
|
|
|
|
|
|
|
@skipUnless((is_feature_enabled("THUMBNAILS")), "Thumbnails feature")
|
|
|
|
def test_get_async_dashboard_screenshot(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get async dashboard screenshot
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
dashboard = db.session.query(Dashboard).all()[0]
|
|
|
|
with patch("superset.dashboards.api.DashboardRestApi.get") as mock_get:
|
|
|
|
response = self.url_open_auth(
|
|
|
|
"admin",
|
|
|
|
f"api/v1/dashboard/{dashboard.id}/thumbnail/{dashboard.digest}/",
|
|
|
|
)
|
|
|
|
self.assertEqual(response.getcode(), 202)
|
|
|
|
|
|
|
|
|
2021-06-08 10:33:42 -04:00
|
|
|
class TestWebDriverProxy(SupersetTestCase):
|
|
|
|
@patch("superset.utils.webdriver.WebDriverWait")
|
|
|
|
@patch("superset.utils.webdriver.firefox")
|
|
|
|
@patch("superset.utils.webdriver.sleep")
|
|
|
|
def test_screenshot_selenium_headstart(
|
|
|
|
self, mock_sleep, mock_webdriver, mock_webdriver_wait
|
|
|
|
):
|
|
|
|
webdriver = WebDriverProxy("firefox")
|
|
|
|
user = security_manager.get_user_by_username(
|
|
|
|
app.config["THUMBNAIL_SELENIUM_USER"]
|
|
|
|
)
|
|
|
|
url = get_url_path("Superset.slice", slice_id=1, standalone="true")
|
|
|
|
app.config["SCREENSHOT_SELENIUM_HEADSTART"] = 5
|
|
|
|
webdriver.get_screenshot(url, "chart-container", user=user)
|
|
|
|
assert mock_sleep.call_args_list[0] == call(5)
|
|
|
|
|
|
|
|
@patch("superset.utils.webdriver.WebDriverWait")
|
|
|
|
@patch("superset.utils.webdriver.firefox")
|
|
|
|
def test_screenshot_selenium_locate_wait(self, mock_webdriver, mock_webdriver_wait):
|
|
|
|
app.config["SCREENSHOT_LOCATE_WAIT"] = 15
|
|
|
|
webdriver = WebDriverProxy("firefox")
|
|
|
|
user = security_manager.get_user_by_username(
|
|
|
|
app.config["THUMBNAIL_SELENIUM_USER"]
|
|
|
|
)
|
|
|
|
url = get_url_path("Superset.slice", slice_id=1, standalone="true")
|
|
|
|
webdriver.get_screenshot(url, "chart-container", user=user)
|
|
|
|
assert mock_webdriver_wait.call_args_list[0] == call(ANY, 15)
|
|
|
|
|
|
|
|
@patch("superset.utils.webdriver.WebDriverWait")
|
|
|
|
@patch("superset.utils.webdriver.firefox")
|
|
|
|
def test_screenshot_selenium_load_wait(self, mock_webdriver, mock_webdriver_wait):
|
|
|
|
app.config["SCREENSHOT_LOAD_WAIT"] = 15
|
|
|
|
webdriver = WebDriverProxy("firefox")
|
|
|
|
user = security_manager.get_user_by_username(
|
|
|
|
app.config["THUMBNAIL_SELENIUM_USER"]
|
|
|
|
)
|
|
|
|
url = get_url_path("Superset.slice", slice_id=1, standalone="true")
|
|
|
|
webdriver.get_screenshot(url, "chart-container", user=user)
|
|
|
|
assert mock_webdriver_wait.call_args_list[1] == call(ANY, 15)
|
|
|
|
|
2021-07-15 21:25:48 -04:00
|
|
|
@patch("superset.utils.webdriver.WebDriverWait")
|
|
|
|
@patch("superset.utils.webdriver.firefox")
|
|
|
|
@patch("superset.utils.webdriver.sleep")
|
|
|
|
def test_screenshot_selenium_animation_wait(
|
|
|
|
self, mock_sleep, mock_webdriver, mock_webdriver_wait
|
|
|
|
):
|
|
|
|
webdriver = WebDriverProxy("firefox")
|
|
|
|
user = security_manager.get_user_by_username(
|
|
|
|
app.config["THUMBNAIL_SELENIUM_USER"]
|
|
|
|
)
|
|
|
|
url = get_url_path("Superset.slice", slice_id=1, standalone="true")
|
|
|
|
app.config["SCREENSHOT_SELENIUM_ANIMATION_WAIT"] = 4
|
|
|
|
webdriver.get_screenshot(url, "chart-container", user=user)
|
|
|
|
assert mock_sleep.call_args_list[1] == call(4)
|
|
|
|
|
2021-06-08 10:33:42 -04:00
|
|
|
|
2020-06-29 18:36:06 -04:00
|
|
|
class TestThumbnails(SupersetTestCase):
|
2020-04-15 04:40:14 -04:00
|
|
|
|
|
|
|
mock_image = b"bytes mock image"
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=False)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_dashboard_thumbnail_disabled(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Dashboard thumbnail disabled
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
dashboard = db.session.query(Dashboard).all()[0]
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/dashboard/{dashboard.id}/thumbnail/{dashboard.digest}/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 404)
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=False)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_chart_thumbnail_disabled(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Chart thumbnail disabled
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
chart = db.session.query(Slice).all()[0]
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/chart/{chart}/thumbnail/{chart.digest}/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 404)
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_async_dashboard_screenshot(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get async dashboard screenshot
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
dashboard = db.session.query(Dashboard).all()[0]
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/dashboard/{dashboard.id}/thumbnail/{dashboard.digest}/"
|
|
|
|
with patch(
|
|
|
|
"superset.tasks.thumbnails.cache_dashboard_thumbnail.delay"
|
|
|
|
) as mock_task:
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 202)
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
expected_uri = f"{get_url_host()}superset/dashboard/{dashboard.id}/"
|
|
|
|
expected_digest = dashboard.digest
|
|
|
|
expected_kwargs = {"force": True}
|
|
|
|
mock_task.assert_called_with(
|
|
|
|
expected_uri, expected_digest, **expected_kwargs
|
|
|
|
)
|
|
|
|
|
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_async_dashboard_notfound(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get async dashboard not found
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
max_id = db.session.query(func.max(Dashboard.id)).scalar()
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/dashboard/{max_id + 1}/thumbnail/1234/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 404)
|
|
|
|
|
|
|
|
@skipUnless((is_feature_enabled("THUMBNAILS")), "Thumbnails feature")
|
|
|
|
def test_get_async_dashboard_not_allowed(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get async dashboard not allowed
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
dashboard = db.session.query(Dashboard).all()[0]
|
|
|
|
self.login(username="gamma")
|
|
|
|
uri = f"api/v1/dashboard/{dashboard.id}/thumbnail/{dashboard.digest}/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 404)
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_async_chart_screenshot(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get async chart screenshot
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
chart = db.session.query(Slice).all()[0]
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/chart/{chart.id}/thumbnail/{chart.digest}/"
|
|
|
|
with patch(
|
|
|
|
"superset.tasks.thumbnails.cache_chart_thumbnail.delay"
|
|
|
|
) as mock_task:
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 202)
|
2021-05-14 15:49:25 -04:00
|
|
|
expected_uri = f"{get_url_host()}superset/slice/{chart.id}/?standalone=true"
|
|
|
|
expected_digest = chart.digest
|
|
|
|
expected_kwargs = {"force": True}
|
|
|
|
mock_task.assert_called_with(
|
|
|
|
expected_uri, expected_digest, **expected_kwargs
|
|
|
|
)
|
2020-04-15 04:40:14 -04:00
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_async_chart_notfound(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get async chart not found
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
max_id = db.session.query(func.max(Slice.id)).scalar()
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/chart/{max_id + 1}/thumbnail/1234/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 404)
|
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_cached_chart_wrong_digest(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get chart with wrong digest
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
chart = db.session.query(Slice).all()[0]
|
2021-05-14 15:49:25 -04:00
|
|
|
with patch.object(
|
|
|
|
ChartScreenshot, "get_from_cache", return_value=BytesIO(self.mock_image)
|
|
|
|
):
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/chart/{chart.id}/thumbnail/1234/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 302)
|
|
|
|
self.assertRedirects(
|
|
|
|
rv, f"api/v1/chart/{chart.id}/thumbnail/{chart.digest}/"
|
|
|
|
)
|
2020-04-15 04:40:14 -04:00
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_cached_dashboard_screenshot(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get cached dashboard screenshot
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
dashboard = db.session.query(Dashboard).all()[0]
|
2021-05-14 15:49:25 -04:00
|
|
|
with patch.object(
|
|
|
|
DashboardScreenshot, "get_from_cache", return_value=BytesIO(self.mock_image)
|
|
|
|
):
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/dashboard/{dashboard.id}/thumbnail/{dashboard.digest}/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 200)
|
|
|
|
self.assertEqual(rv.data, self.mock_image)
|
2020-04-15 04:40:14 -04:00
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_cached_chart_screenshot(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get cached chart screenshot
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
chart = db.session.query(Slice).all()[0]
|
2021-05-14 15:49:25 -04:00
|
|
|
with patch.object(
|
|
|
|
ChartScreenshot, "get_from_cache", return_value=BytesIO(self.mock_image)
|
|
|
|
):
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/chart/{chart.id}/thumbnail/{chart.digest}/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 200)
|
|
|
|
self.assertEqual(rv.data, self.mock_image)
|
2020-04-15 04:40:14 -04:00
|
|
|
|
2021-05-14 15:49:25 -04:00
|
|
|
@with_feature_flags(THUMBNAILS=True)
|
2020-04-15 04:40:14 -04:00
|
|
|
def test_get_cached_dashboard_wrong_digest(self):
|
|
|
|
"""
|
2021-04-12 16:18:17 -04:00
|
|
|
Thumbnails: Simple get dashboard with wrong digest
|
2020-04-15 04:40:14 -04:00
|
|
|
"""
|
|
|
|
dashboard = db.session.query(Dashboard).all()[0]
|
2021-05-14 15:49:25 -04:00
|
|
|
with patch.object(
|
|
|
|
DashboardScreenshot, "get_from_cache", return_value=BytesIO(self.mock_image)
|
|
|
|
):
|
|
|
|
self.login(username="admin")
|
|
|
|
uri = f"api/v1/dashboard/{dashboard.id}/thumbnail/1234/"
|
|
|
|
rv = self.client.get(uri)
|
|
|
|
self.assertEqual(rv.status_code, 302)
|
|
|
|
self.assertRedirects(
|
|
|
|
rv, f"api/v1/dashboard/{dashboard.id}/thumbnail/{dashboard.digest}/"
|
|
|
|
)
|