mirror of
https://github.com/apache/superset.git
synced 2024-09-12 00:29:39 -04:00
* first pass private gsheets * made encrypted extra into string, refactored onParametersChanged * private sheets working, credential_info errors * all but test connection working * first pass private gsheets * made encrypted extra into string, refactored onParametersChanged * private sheets working, credential_info errors * all but test connection working * Regenerate package-lock.json Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
172 lines
6.0 KiB
Python
172 lines
6.0 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 flask.ctx import AppContext
|
|
from pytest_mock import MockFixture
|
|
|
|
from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
|
|
|
|
|
|
class ProgrammingError(Exception):
|
|
"""
|
|
Dummy ProgrammingError so we don't need to import the optional gsheets.
|
|
"""
|
|
|
|
|
|
def test_validate_parameters_simple(
|
|
mocker: MockFixture, app_context: AppContext,
|
|
) -> None:
|
|
from superset.db_engine_specs.gsheets import (
|
|
GSheetsEngineSpec,
|
|
GSheetsParametersType,
|
|
)
|
|
|
|
parameters: GSheetsParametersType = {
|
|
"service_account_info": "",
|
|
"catalog": {},
|
|
}
|
|
errors = GSheetsEngineSpec.validate_parameters(parameters)
|
|
assert errors == []
|
|
|
|
|
|
def test_validate_parameters_catalog(
|
|
mocker: MockFixture, app_context: AppContext,
|
|
) -> None:
|
|
from superset.db_engine_specs.gsheets import (
|
|
GSheetsEngineSpec,
|
|
GSheetsParametersType,
|
|
)
|
|
|
|
g = mocker.patch("superset.db_engine_specs.gsheets.g")
|
|
g.user.email = "admin@example.com"
|
|
|
|
create_engine = mocker.patch("superset.db_engine_specs.gsheets.create_engine")
|
|
conn = create_engine.return_value.connect.return_value
|
|
results = conn.execute.return_value
|
|
results.fetchall.side_effect = [
|
|
ProgrammingError("The caller does not have permission"),
|
|
[(1,)],
|
|
ProgrammingError("Unsupported table: https://www.google.com/"),
|
|
]
|
|
|
|
parameters: GSheetsParametersType = {
|
|
"service_account_info": "",
|
|
"catalog": {
|
|
"private_sheet": "https://docs.google.com/spreadsheets/d/1/edit",
|
|
"public_sheet": "https://docs.google.com/spreadsheets/d/1/edit#gid=1",
|
|
"not_a_sheet": "https://www.google.com/",
|
|
},
|
|
}
|
|
errors = GSheetsEngineSpec.validate_parameters(parameters) # ignore: type
|
|
|
|
assert errors == [
|
|
SupersetError(
|
|
message="URL could not be identified",
|
|
error_type=SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR,
|
|
level=ErrorLevel.WARNING,
|
|
extra={
|
|
"catalog": {"idx": 0, "url": True,},
|
|
"issue_codes": [
|
|
{
|
|
"code": 1003,
|
|
"message": "Issue 1003 - There is a syntax error in the SQL query. Perhaps there was a misspelling or a typo.",
|
|
},
|
|
{
|
|
"code": 1005,
|
|
"message": "Issue 1005 - The table was deleted or renamed in the database.",
|
|
},
|
|
],
|
|
},
|
|
),
|
|
SupersetError(
|
|
message="URL could not be identified",
|
|
error_type=SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR,
|
|
level=ErrorLevel.WARNING,
|
|
extra={
|
|
"catalog": {"idx": 2, "url": True,},
|
|
"issue_codes": [
|
|
{
|
|
"code": 1003,
|
|
"message": "Issue 1003 - There is a syntax error in the SQL query. Perhaps there was a misspelling or a typo.",
|
|
},
|
|
{
|
|
"code": 1005,
|
|
"message": "Issue 1005 - The table was deleted or renamed in the database.",
|
|
},
|
|
],
|
|
},
|
|
),
|
|
]
|
|
|
|
create_engine.assert_called_with(
|
|
"gsheets://", service_account_info={}, subject="admin@example.com",
|
|
)
|
|
|
|
|
|
def test_validate_parameters_catalog_and_credentials(
|
|
mocker: MockFixture, app_context: AppContext,
|
|
) -> None:
|
|
from superset.db_engine_specs.gsheets import (
|
|
GSheetsEngineSpec,
|
|
GSheetsParametersType,
|
|
)
|
|
|
|
g = mocker.patch("superset.db_engine_specs.gsheets.g")
|
|
g.user.email = "admin@example.com"
|
|
|
|
create_engine = mocker.patch("superset.db_engine_specs.gsheets.create_engine")
|
|
conn = create_engine.return_value.connect.return_value
|
|
results = conn.execute.return_value
|
|
results.fetchall.side_effect = [
|
|
[(2,)],
|
|
[(1,)],
|
|
ProgrammingError("Unsupported table: https://www.google.com/"),
|
|
]
|
|
|
|
parameters: GSheetsParametersType = {
|
|
"service_account_info": "",
|
|
"catalog": {
|
|
"private_sheet": "https://docs.google.com/spreadsheets/d/1/edit",
|
|
"public_sheet": "https://docs.google.com/spreadsheets/d/1/edit#gid=1",
|
|
"not_a_sheet": "https://www.google.com/",
|
|
},
|
|
}
|
|
errors = GSheetsEngineSpec.validate_parameters(parameters) # ignore: type
|
|
assert errors == [
|
|
SupersetError(
|
|
message="URL could not be identified",
|
|
error_type=SupersetErrorType.TABLE_DOES_NOT_EXIST_ERROR,
|
|
level=ErrorLevel.WARNING,
|
|
extra={
|
|
"catalog": {"idx": 2, "url": True,},
|
|
"issue_codes": [
|
|
{
|
|
"code": 1003,
|
|
"message": "Issue 1003 - There is a syntax error in the SQL query. Perhaps there was a misspelling or a typo.",
|
|
},
|
|
{
|
|
"code": 1005,
|
|
"message": "Issue 1005 - The table was deleted or renamed in the database.",
|
|
},
|
|
],
|
|
},
|
|
)
|
|
]
|
|
|
|
create_engine.assert_called_with(
|
|
"gsheets://", service_account_info={}, subject="admin@example.com",
|
|
)
|