bito-code-review[bot] commented on code in PR #38403: URL: https://github.com/apache/superset/pull/38403#discussion_r3012386319
########## tests/unit_tests/mcp_service/chart/test_big_number_chart.py: ########## @@ -0,0 +1,472 @@ +# 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_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(ValidationError, match="Extra inputs"): + 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: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + temporal_column="order_date", + show_trendline=True, + ) + form_data = map_big_number_config(config) + assert form_data["viz_type"] == "big_number" + assert "x_axis" not in form_data + assert form_data["granularity_sqla"] == "order_date" + assert form_data["start_y_axis_at_zero"] is True + + def test_with_time_grain(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + temporal_column="order_date", + show_trendline=True, + time_grain="P1M", + ) + form_data = map_big_number_config(config) + assert form_data["time_grain_sqla"] == "P1M" + + def test_with_subheader(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + subheader="Year to date", + ) + form_data = map_big_number_config(config) + assert form_data["subheader"] == "Year to date" + + def test_with_y_axis_format(self) -> None: + config = BigNumberChartConfig( + chart_type="big_number", + metric=ColumnRef(name="revenue", aggregate="SUM"), + y_axis_format="$,.2f", + ) + form_data = map_big_number_config(config) + assert form_data["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=7, + ) + form_data = map_big_number_config(config) + assert form_data["compare_lag"] == 7 + + 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"), + ], + ) + form_data = map_big_number_config(config) + assert "adhoc_filters" in form_data + assert len(form_data["adhoc_filters"]) == 1 + assert form_data["adhoc_filters"][0]["subject"] == "region" Review Comment: <!-- Bito Reply --> The test at lines 238-239 now includes assertions for both 'operator' and 'comparator', addressing the previous suggestion. ########## superset/mcp_service/chart/validation/schema_validator.py: ########## @@ -282,6 +286,60 @@ def _pre_validate_pie_config( return True, None + @staticmethod + def _pre_validate_big_number_config( + config: Dict[str, Any], + ) -> Tuple[bool, ChartGenerationError | None]: + """Pre-validate big number chart configuration.""" + if "metric" not in config: + return False, ChartGenerationError( + error_type="missing_metric", + message="Big Number chart missing required field: metric", + details="Big Number charts require a 'metric' field " + "specifying the value to display", + suggestions=[ + "Add 'metric' with name and aggregate: " + "{'name': 'revenue', 'aggregate': 'SUM'}", + "The aggregate function is required (SUM, COUNT, AVG, MIN, MAX)", + "Example: {'chart_type': 'big_number', " + "'metric': {'name': 'sales', 'aggregate': 'SUM'}}", + ], + error_code="MISSING_BIG_NUMBER_METRIC", + ) + + metric = config.get("metric", {}) + if isinstance(metric, dict) and not metric.get("aggregate"): + return False, ChartGenerationError( + error_type="missing_metric_aggregate", + message="Big Number metric must include an aggregate function", + details="The metric 'aggregate' field is required " + "for Big Number charts", + suggestions=[ + "Add 'aggregate' to your metric: " + "{'name': 'col', 'aggregate': 'SUM'}", + "Valid aggregates: SUM, COUNT, AVG, MIN, MAX", + ], + error_code="MISSING_BIG_NUMBER_AGGREGATE", + ) Review Comment: <!-- Bito Reply --> Yes, the isinstance check for the metric field has been added in the current change, ensuring the metric is a dict before validating the aggregate. This addresses the earlier suggestion for better input validation. -- 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]
