aminghadersohi commented on code in PR #38403: URL: https://github.com/apache/superset/pull/38403#discussion_r3016338369
########## tests/unit_tests/mcp_service/chart/test_big_number_chart.py: ########## @@ -0,0 +1,505 @@ +# 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. + +"""Tests for Big Number chart type support in MCP service.""" + +import pytest +from pydantic import ValidationError + +from superset.mcp_service.chart.chart_utils import ( + _resolve_viz_type, + analyze_chart_capabilities, + analyze_chart_semantics, + generate_chart_name, + map_big_number_config, + map_config_to_form_data, +) +from superset.mcp_service.chart.schemas import ( + BigNumberChartConfig, + ColumnRef, + FilterConfig, +) +from superset.mcp_service.chart.validation.schema_validator import ( + SchemaValidator, +) + + +class TestBigNumberChartConfig: + """Test BigNumberChartConfig Pydantic schema.""" + + def test_minimal_config(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + ) + assert config.chart_type == "big_number" + assert config.metric.name == "revenue" + assert config.metric.aggregate == "SUM" + assert config.show_trendline is False + + def test_with_trendline(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + temporal_column="ds", + show_trendline=True, + ) + assert config.show_trendline is True + assert config.temporal_column == "ds" + + def test_trendline_without_temporal_column_fails(self) -> None: + with pytest.raises(ValidationError, match="requires 'temporal_column'"): + BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + show_trendline=True, + ) + + def test_metric_without_aggregate_fails(self) -> None: + with pytest.raises(ValidationError, match="must have an aggregate function"): + BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue"), + ) + + def test_with_subheader(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + subheader="Total revenue this quarter", + ) + assert config.subheader == "Total revenue this quarter" + + def test_with_y_axis_format(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + y_axis_format="$,.2f", + ) + assert config.y_axis_format == "$,.2f" + + def test_with_compare_lag(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + temporal_column="ds", + show_trendline=True, + compare_lag=1, + ) + assert config.compare_lag == 1 + + def test_compare_lag_zero_fails(self) -> None: + with pytest.raises(ValidationError, match="greater than or equal"): + BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + compare_lag=0, + ) + + def test_compare_lag_requires_trendline(self) -> None: + with pytest.raises( + ValidationError, match="compare_lag requires show_trendline" + ): + BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + compare_lag=1, + ) + + def test_with_filters(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + filters=[ + FilterConfig(column="region", op="=", value="US"), + ], + ) + assert config.filters is not None + assert len(config.filters) == 1 + + def test_extra_fields_forbidden(self) -> None: + with pytest.raises(ValueError, match="Unknown field 'unknown_field'"): + BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + unknown_field="bad", + ) + + def test_with_time_grain(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + temporal_column="ds", + show_trendline=True, + time_grain="P1M", + ) + assert config.time_grain == "P1M" + + def test_with_custom_label(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM", label="Total Sales"), + ) + assert config.metric.label == "Total Sales" + + +class TestMapBigNumberConfig: + """Test map_big_number_config function.""" + + def test_basic_total(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + ) + form_data = map_big_number_config(config) + assert form_data["viz_type"] == "big_number_total" + assert form_data["metric"]["aggregate"] == "SUM" + assert form_data["metric"]["column"]["column_name"] == "revenue" + + def test_with_trendline(self) -> None: Review Comment: Fixed — added `assert form_data["show_trend_line"] is True` to the trendline mapping test. Commit 1a8fddd5ae. ########## superset/mcp_service/chart/schemas.py: ########## @@ -851,6 +852,111 @@ def validate_query_fields(self) -> "HandlebarsChartConfig": return self +class BigNumberChartConfig(UnknownFieldCheckMixin): + model_config = ConfigDict(extra="ignore") + + chart_type: Literal["big_number"] = Field( + ..., + description=( + "Chart type discriminator - MUST be 'big_number'. " + "Creates Big Number charts that display a single prominent " + "metric value. Set show_trendline=True with a temporal_column " + "for a number with trendline, or leave show_trendline=False " + "for a standalone number." + ), + ) + metric: ColumnRef = Field( + ..., + description=( + "The metric to display as a big number. " + "Must include an aggregate function (e.g., SUM, COUNT)." + ), + ) + temporal_column: str | None = Field( + None, + description=( + "Temporal column for the trendline x-axis. " + "Required when show_trendline is True." + ), + min_length=1, + max_length=255, + pattern=r"^[a-zA-Z0-9_][a-zA-Z0-9_\s\-\.]*$", + ) + time_grain: TimeGrain | None = Field( + None, + description=( + "Time granularity for trendline data. " + "Common values: PT1H (hour), P1D (day), P1W (week), " + "P1M (month), P1Y (year)." + ), + ) + show_trendline: bool = Field( + False, + description=( + "Show a trendline below the big number. " + "Requires 'temporal_column' to be set." + ), + ) + subheader: str | None = Field( + None, + description="Subtitle text displayed below the big number", + max_length=500, + ) + y_axis_format: str | None = Field( + None, + description=( + "Number format string for the metric value " + "(e.g., '$,.2f' for currency, ',.0f' for integers, " + "'.2%' for percentages)" + ), + max_length=50, + ) + start_y_axis_at_zero: bool = Field( + True, + description="Anchor trendline y-axis at zero", + ) + compare_lag: int | None = Field( + None, + description=( + "Number of time periods to compare against. " + "Displays a percentage change vs the prior period." + ), + ge=1, + ) + filters: list[FilterConfig] | None = Field( + None, + description="Filters to apply", + ) + + @model_validator(mode="after") + def validate_trendline_fields(self) -> Self: + """Validate trendline requires temporal column.""" + if self.show_trendline and not self.temporal_column: + raise ValueError( + "Big Number chart with show_trendline=True requires " + "'temporal_column'. Specify a date/time column for " + "the trendline x-axis." + ) + if self.compare_lag and not self.show_trendline: + raise ValueError( + "compare_lag requires show_trendline=True. " + "Period comparison is only available for " + "trendline charts." + ) + return self + + @model_validator(mode="after") + def validate_metric_aggregate(self) -> Self: + """Ensure metric has an aggregate function.""" + if not self.metric.aggregate: + raise ValueError( + "Big Number metric must have an aggregate function " + "(e.g., SUM, COUNT, AVG). Add 'aggregate' to the " + "metric specification." Review Comment: Fixed — validator now uses `self.metric.is_metric` which accepts both `aggregate` and `saved_metric=True`. Added a `test_saved_metric_accepted` test case. Commit 1a8fddd5ae. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
