mirror of
https://github.com/apache/superset.git
synced 2026-09-05 15:01:44 +00:00
Enzo MartellucciandClaude Sonnet 5
2e85d7b290
Add json_schema_extra hints to DataBinding and BalloonsControls fields so the frontend Inspector can render dataset-aware column/metric pickers: - DataBinding.metrics: x-control "metric-multi" (was "code") - DataBinding.dimensions: x-control "column-multi" (new) - BalloonsControls.colorDimension: x-control "column" (new) Also improve metrics field documentation to clarify the picker behavior. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
141 lines
5.0 KiB
Python
141 lines
5.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 __future__ import annotations
|
|
|
|
import pytest
|
|
from superset_core.widgets import Widget, widget
|
|
|
|
from superset.widgets.controls import BalloonsControls
|
|
from superset.widgets.registry import registry
|
|
|
|
|
|
def _block(widget_type: str) -> type[Widget]:
|
|
widget_cls = registry.get(widget_type)
|
|
assert widget_cls is not None
|
|
return widget_cls
|
|
|
|
|
|
def test_registry_lists_built_in_widget_types() -> None:
|
|
ids = {cls.widget_type for cls in registry.values()}
|
|
assert {"metric-tile", "ag-grid-table", "balloons"} <= ids
|
|
|
|
|
|
def test_core_contract_is_importable() -> None:
|
|
# Extensions register widgets via exactly these two public symbols.
|
|
assert Widget is not None
|
|
assert callable(widget)
|
|
|
|
|
|
def test_duplicate_widget_type_raises_naming_both() -> None:
|
|
@widget(widget_type="dup-test-widget", name="First")
|
|
class First(Widget):
|
|
controls_class = BalloonsControls
|
|
|
|
try:
|
|
with pytest.raises(ValueError, match="already registered"):
|
|
|
|
@widget(widget_type="dup-test-widget", name="Second")
|
|
class Second(Widget):
|
|
controls_class = BalloonsControls
|
|
finally:
|
|
registry.pop("dup-test-widget", None)
|
|
|
|
|
|
def test_get_control_schema_base_shape() -> None:
|
|
schema = _block("balloons").get_control_schema(None, None)
|
|
# Field order preserved (dataBinding before customize), $defs present.
|
|
assert list(schema["properties"]) == [
|
|
"dataBinding",
|
|
"colorDimension",
|
|
"customize",
|
|
]
|
|
assert schema["required"] == ["dataBinding"]
|
|
assert {"DataBinding", "Customization", "SeriesStyle"} <= set(schema["$defs"])
|
|
|
|
|
|
def test_get_control_schema_tolerates_invalid_values() -> None:
|
|
# Partial / malformed control values during editing must not raise; the base
|
|
# schema is returned instead.
|
|
schema = _block("balloons").get_control_schema(
|
|
{"dataBinding": "not-an-object"}, None
|
|
)
|
|
assert "properties" in schema
|
|
|
|
|
|
def test_get_control_schema_accepts_camel_case_props() -> None:
|
|
# node.props uses camelCase aliases; validation must accept them.
|
|
schema = _block("metric-tile").get_control_schema(
|
|
{"dataBinding": {"datasetId": 1, "metrics": ["count"]}, "decimals": 2}, None
|
|
)
|
|
assert "dataBinding" in schema["properties"]
|
|
|
|
|
|
def test_minimal_object_validates_against_model() -> None:
|
|
# datasetId + metrics are the only mandatory leaves; everything else is
|
|
# optional, so this minimal object is a valid instance.
|
|
BalloonsControls.model_validate(
|
|
{"dataBinding": {"datasetId": 1, "metrics": ["count"]}}
|
|
)
|
|
|
|
|
|
def test_validate_control_values_passes_for_valid_props() -> None:
|
|
errors = _block("balloons").validate_control_values(
|
|
{
|
|
"dataBinding": {
|
|
"datasetId": 1,
|
|
"metrics": ["count"],
|
|
"dimensions": ["gender"],
|
|
},
|
|
"colorDimension": "gender",
|
|
}
|
|
)
|
|
assert errors == []
|
|
|
|
|
|
def test_validate_control_values_flags_color_dimension_not_grouped() -> None:
|
|
# colorDimension names a dimension that isn't in dataBinding.dimensions —
|
|
# the declarative cross-field rule must surface an actionable error.
|
|
errors = _block("balloons").validate_control_values(
|
|
{
|
|
"dataBinding": {
|
|
"datasetId": 1,
|
|
"metrics": ["count"],
|
|
"dimensions": ["name"],
|
|
},
|
|
"colorDimension": "gender",
|
|
}
|
|
)
|
|
assert errors
|
|
assert any("colorDimension" in error["message"] for error in errors)
|
|
|
|
|
|
def test_validate_control_values_empty_when_no_values() -> None:
|
|
# Nothing to validate (required-field checks live elsewhere).
|
|
assert _block("balloons").validate_control_values(None) == []
|
|
|
|
|
|
def test_data_binding_declares_column_and_metric_controls() -> None:
|
|
schema = _block("balloons").get_control_schema(None, None)
|
|
data_binding_props = schema["$defs"]["DataBinding"]["properties"]
|
|
assert data_binding_props["dimensions"]["x-control"] == "column-multi"
|
|
assert data_binding_props["metrics"]["x-control"] == "metric-multi"
|
|
|
|
|
|
def test_color_dimension_declares_column_control() -> None:
|
|
schema = _block("balloons").get_control_schema(None, None)
|
|
assert schema["properties"]["colorDimension"]["x-control"] == "column"
|