mirror of
https://github.com/apache/superset.git
synced 2026-04-19 08:04:53 +00:00
feat: new Excel upload form and API (#28105)
This commit is contained in:
Daniel Vaz Gaspar
committed by
GitHub
GitHub
parent
37f900a264
commit
e465876ed4
@@ -1448,6 +1448,7 @@ class TestDatabaseApi(SupersetTestCase):
|
||||
assert set(data["permissions"]) == {
|
||||
"can_read",
|
||||
"can_csv_upload",
|
||||
"can_excel_upload",
|
||||
"can_write",
|
||||
"can_export",
|
||||
}
|
||||
|
||||
257
tests/integration_tests/databases/commands/excel_upload_test.py
Normal file
257
tests/integration_tests/databases/commands/excel_upload_test.py
Normal file
@@ -0,0 +1,257 @@
|
||||
# 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 json
|
||||
from datetime import datetime
|
||||
|
||||
import pytest
|
||||
|
||||
from superset import db, security_manager
|
||||
from superset.commands.database.excel_import import ExcelImportCommand
|
||||
from superset.commands.database.exceptions import (
|
||||
DatabaseNotFoundError,
|
||||
DatabaseSchemaUploadNotAllowed,
|
||||
DatabaseUploadFailed,
|
||||
)
|
||||
from superset.models.core import Database
|
||||
from superset.utils.core import override_user
|
||||
from superset.utils.database import get_or_create_db
|
||||
from tests.integration_tests.conftest import only_postgresql
|
||||
from tests.integration_tests.test_app import app
|
||||
from tests.unit_tests.fixtures.common import create_excel_file
|
||||
|
||||
EXCEL_UPLOAD_DATABASE = "excel_explore_db"
|
||||
EXCEL_UPLOAD_TABLE = "excel_upload"
|
||||
EXCEL_UPLOAD_TABLE_W_SCHEMA = "excel_upload_w_schema"
|
||||
|
||||
|
||||
EXCEL_FILE_1 = {
|
||||
"Name": ["name1", "name2", "name3"],
|
||||
"Age": [30, 29, 28],
|
||||
"City": ["city1", "city2", "city3"],
|
||||
"Birth": ["1-1-1980", "1-1-1981", "1-1-1982"],
|
||||
}
|
||||
|
||||
EXCEL_FILE_2 = {
|
||||
"Name": ["name1", "name2", "name3"],
|
||||
"Age": ["N/A", 29, 28],
|
||||
"City": ["city1", "None", "city3"],
|
||||
"Birth": ["1-1-1980", "1-1-1981", "1-1-1982"],
|
||||
}
|
||||
|
||||
|
||||
def _setup_excel_upload(allowed_schemas: list[str] | None = None):
|
||||
upload_db = get_or_create_db(
|
||||
EXCEL_UPLOAD_DATABASE, app.config["SQLALCHEMY_EXAMPLES_URI"]
|
||||
)
|
||||
upload_db.allow_file_upload = True
|
||||
extra = upload_db.get_extra()
|
||||
allowed_schemas = allowed_schemas or []
|
||||
extra["schemas_allowed_for_file_upload"] = allowed_schemas
|
||||
upload_db.extra = json.dumps(extra)
|
||||
|
||||
db.session.commit()
|
||||
|
||||
yield
|
||||
|
||||
upload_db = get_upload_db()
|
||||
with upload_db.get_sqla_engine_with_context() as engine:
|
||||
engine.execute(f"DROP TABLE IF EXISTS {EXCEL_UPLOAD_TABLE}")
|
||||
engine.execute(f"DROP TABLE IF EXISTS {EXCEL_UPLOAD_TABLE_W_SCHEMA}")
|
||||
db.session.delete(upload_db)
|
||||
db.session.commit()
|
||||
|
||||
|
||||
def get_upload_db():
|
||||
return (
|
||||
db.session.query(Database).filter_by(database_name=EXCEL_UPLOAD_DATABASE).one()
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def setup_excel_upload_with_context():
|
||||
with app.app_context():
|
||||
yield from _setup_excel_upload()
|
||||
|
||||
|
||||
@pytest.fixture(scope="function")
|
||||
def setup_excel_upload_with_context_schema():
|
||||
with app.app_context():
|
||||
yield from _setup_excel_upload(["public"])
|
||||
|
||||
|
||||
@only_postgresql
|
||||
@pytest.mark.parametrize(
|
||||
"excel_data,options, table_data",
|
||||
[
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{},
|
||||
[
|
||||
("name1", 30, "city1", "1-1-1980"),
|
||||
("name2", 29, "city2", "1-1-1981"),
|
||||
("name3", 28, "city3", "1-1-1982"),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"columns_read": ["Name", "Age"]},
|
||||
[("name1", 30), ("name2", 29), ("name3", 28)],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"columns_read": []},
|
||||
[
|
||||
("name1", 30, "city1", "1-1-1980"),
|
||||
("name2", 29, "city2", "1-1-1981"),
|
||||
("name3", 28, "city3", "1-1-1982"),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"rows_to_read": 1},
|
||||
[
|
||||
("name1", 30, "city1", "1-1-1980"),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"rows_to_read": 1, "columns_read": ["Name", "Age"]},
|
||||
[
|
||||
("name1", 30),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"skip_rows": 1},
|
||||
[("name2", 29, "city2", "1-1-1981"), ("name3", 28, "city3", "1-1-1982")],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"rows_to_read": 2},
|
||||
[
|
||||
("name1", 30, "city1", "1-1-1980"),
|
||||
("name2", 29, "city2", "1-1-1981"),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_1,
|
||||
{"column_dates": ["Birth"]},
|
||||
[
|
||||
("name1", 30, "city1", datetime(1980, 1, 1, 0, 0)),
|
||||
("name2", 29, "city2", datetime(1981, 1, 1, 0, 0)),
|
||||
("name3", 28, "city3", datetime(1982, 1, 1, 0, 0)),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_2,
|
||||
{"null_values": ["N/A", "None"]},
|
||||
[
|
||||
("name1", None, "city1", "1-1-1980"),
|
||||
("name2", 29, None, "1-1-1981"),
|
||||
("name3", 28, "city3", "1-1-1982"),
|
||||
],
|
||||
),
|
||||
(
|
||||
EXCEL_FILE_2,
|
||||
{
|
||||
"null_values": ["N/A", "None"],
|
||||
"column_dates": ["Birth"],
|
||||
"columns_read": ["Name", "Age", "Birth"],
|
||||
},
|
||||
[
|
||||
("name1", None, datetime(1980, 1, 1, 0, 0)),
|
||||
("name2", 29, datetime(1981, 1, 1, 0, 0)),
|
||||
("name3", 28, datetime(1982, 1, 1, 0, 0)),
|
||||
],
|
||||
),
|
||||
],
|
||||
)
|
||||
@pytest.mark.usefixtures("setup_excel_upload_with_context")
|
||||
def test_excel_upload_options(excel_data, options, table_data):
|
||||
admin_user = security_manager.find_user(username="admin")
|
||||
upload_database = get_upload_db()
|
||||
|
||||
with override_user(admin_user):
|
||||
ExcelImportCommand(
|
||||
upload_database.id,
|
||||
EXCEL_UPLOAD_TABLE,
|
||||
create_excel_file(excel_data),
|
||||
options=options,
|
||||
).run()
|
||||
with upload_database.get_sqla_engine_with_context() as engine:
|
||||
data = engine.execute(f"SELECT * from {EXCEL_UPLOAD_TABLE}").fetchall()
|
||||
assert data == table_data
|
||||
|
||||
|
||||
@only_postgresql
|
||||
@pytest.mark.usefixtures("setup_excel_upload_with_context")
|
||||
def test_excel_upload_database_not_found():
|
||||
admin_user = security_manager.find_user(username="admin")
|
||||
|
||||
with override_user(admin_user):
|
||||
with pytest.raises(DatabaseNotFoundError):
|
||||
ExcelImportCommand(
|
||||
1000,
|
||||
EXCEL_UPLOAD_TABLE,
|
||||
create_excel_file(EXCEL_FILE_1),
|
||||
options={},
|
||||
).run()
|
||||
|
||||
|
||||
@only_postgresql
|
||||
@pytest.mark.usefixtures("setup_excel_upload_with_context_schema")
|
||||
def test_excel_upload_schema_not_allowed():
|
||||
admin_user = security_manager.find_user(username="admin")
|
||||
upload_db_id = get_upload_db().id
|
||||
with override_user(admin_user):
|
||||
with pytest.raises(DatabaseSchemaUploadNotAllowed):
|
||||
ExcelImportCommand(
|
||||
upload_db_id,
|
||||
EXCEL_UPLOAD_TABLE,
|
||||
create_excel_file(EXCEL_FILE_1),
|
||||
options={},
|
||||
).run()
|
||||
|
||||
with pytest.raises(DatabaseSchemaUploadNotAllowed):
|
||||
ExcelImportCommand(
|
||||
upload_db_id,
|
||||
EXCEL_UPLOAD_TABLE,
|
||||
create_excel_file(EXCEL_FILE_1),
|
||||
options={"schema": "schema1"},
|
||||
).run()
|
||||
|
||||
ExcelImportCommand(
|
||||
upload_db_id,
|
||||
EXCEL_UPLOAD_TABLE,
|
||||
create_excel_file(EXCEL_FILE_1),
|
||||
options={"schema": "public"},
|
||||
).run()
|
||||
|
||||
|
||||
@only_postgresql
|
||||
@pytest.mark.usefixtures("setup_excel_upload_with_context")
|
||||
def test_excel_upload_broken_file():
|
||||
admin_user = security_manager.find_user(username="admin")
|
||||
|
||||
with override_user(admin_user):
|
||||
with pytest.raises(DatabaseUploadFailed):
|
||||
ExcelImportCommand(
|
||||
get_upload_db().id,
|
||||
EXCEL_UPLOAD_TABLE,
|
||||
create_excel_file([""]),
|
||||
options={"column_dates": ["Birth"]},
|
||||
).run()
|
||||
Reference in New Issue
Block a user