Files
superset2/tests/unit_tests/reports/api_test.py

94 lines
3.4 KiB
Python

# 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
from unittest.mock import patch
import rison
from superset.exceptions import SupersetException
from tests.unit_tests.conftest import with_feature_flags
@with_feature_flags(ALERT_REPORTS=True)
@patch("superset.reports.api.get_channels_with_search")
def test_slack_channels_success(
mock_search: Any,
client: Any,
full_api_access: None,
) -> None:
mock_search.return_value = [{"id": "C123", "name": "general"}]
params = rison.dumps({})
rv = client.get(f"/api/v1/report/slack_channels/?q={params}")
assert rv.status_code == 200
data = rv.json
assert data["result"] == [{"id": "C123", "name": "general"}]
assert data["count"] == 1
@with_feature_flags(ALERT_REPORTS=True)
@patch("superset.reports.api.get_channels_with_search")
def test_slack_channels_paginates(
mock_search: Any,
client: Any,
full_api_access: None,
) -> None:
# A large workspace: the endpoint must return only the requested page while
# reporting the full count, so the browser never receives every channel.
mock_search.return_value = [
{"id": f"C{i}", "name": f"channel-{i}"} for i in range(250)
]
params = rison.dumps({"page": 1, "page_size": 100})
rv = client.get(f"/api/v1/report/slack_channels/?q={params}")
assert rv.status_code == 200
data = rv.json
assert data["count"] == 250
assert len(data["result"]) == 100
assert data["result"][0] == {"id": "C100", "name": "channel-100"}
@with_feature_flags(ALERT_REPORTS=True)
@patch("superset.reports.api.get_channels_with_search")
def test_slack_channels_page_without_page_size_returns_all(
mock_search: Any,
client: Any,
full_api_access: None,
) -> None:
# Pagination only kicks in when both page and page_size are supplied; a page
# without page_size falls through to the full (unsliced) list.
mock_search.return_value = [
{"id": f"C{i}", "name": f"channel-{i}"} for i in range(30)
]
params = rison.dumps({"page": 1})
rv = client.get(f"/api/v1/report/slack_channels/?q={params}")
assert rv.status_code == 200
assert rv.json["count"] == 30
assert len(rv.json["result"]) == 30
@with_feature_flags(ALERT_REPORTS=True)
@patch("superset.reports.api.get_channels_with_search")
def test_slack_channels_handles_superset_exception(
mock_search: Any,
client: Any,
full_api_access: None,
) -> None:
mock_search.side_effect = SupersetException("Slack API error")
params = rison.dumps({})
rv = client.get(f"/api/v1/report/slack_channels/?q={params}")
assert rv.status_code == 422
assert "Slack API error" in rv.json["message"]