|
| 1 | +# Copyright 2025 Google LLC |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | + |
| 16 | +import inspect |
| 17 | +from inspect import Parameter |
| 18 | + |
| 19 | +import pytest |
| 20 | + |
| 21 | +from toolbox_core.protocol import ParameterSchema |
| 22 | + |
| 23 | + |
| 24 | +def test_parameter_schema_float(): |
| 25 | + """Tests ParameterSchema with type 'float'.""" |
| 26 | + schema = ParameterSchema(name="price", type="float", description="The item price") |
| 27 | + expected_type = float |
| 28 | + # Use internal method directly for type check, though testing to_param implicitly tests it |
| 29 | + assert schema._ParameterSchema__get_type() == expected_type |
| 30 | + |
| 31 | + param = schema.to_param() |
| 32 | + assert isinstance(param, Parameter) |
| 33 | + assert param.name == "price" |
| 34 | + assert param.annotation == expected_type |
| 35 | + assert param.kind == Parameter.POSITIONAL_OR_KEYWORD |
| 36 | + assert param.default == Parameter.empty # No default specified |
| 37 | + |
| 38 | + |
| 39 | +def test_parameter_schema_boolean(): |
| 40 | + """Tests ParameterSchema with type 'boolean'.""" |
| 41 | + schema = ParameterSchema( |
| 42 | + name="is_active", type="boolean", description="Activity status" |
| 43 | + ) |
| 44 | + expected_type = bool |
| 45 | + assert schema._ParameterSchema__get_type() == expected_type |
| 46 | + |
| 47 | + param = schema.to_param() |
| 48 | + assert isinstance(param, Parameter) |
| 49 | + assert param.name == "is_active" |
| 50 | + assert param.annotation == expected_type |
| 51 | + assert param.kind == Parameter.POSITIONAL_OR_KEYWORD |
| 52 | + |
| 53 | + |
| 54 | +def test_parameter_schema_array_string(): |
| 55 | + """Tests ParameterSchema with type 'array' containing strings.""" |
| 56 | + item_schema = ParameterSchema( |
| 57 | + name="", type="string", description="" |
| 58 | + ) # Name/desc not relevant for item type |
| 59 | + schema = ParameterSchema( |
| 60 | + name="tags", type="array", description="List of tags", items=item_schema |
| 61 | + ) |
| 62 | + # Note: Direct comparison with list[str] might differ slightly depending on Python version's typing internals |
| 63 | + # We check the Parameter annotation which uses the correct runtime representation |
| 64 | + # assert schema._ParameterSchema__get_type() == list[str] # This might fail equality check |
| 65 | + |
| 66 | + param = schema.to_param() |
| 67 | + assert isinstance(param, Parameter) |
| 68 | + assert param.name == "tags" |
| 69 | + # Check annotation for list of strings. How typing represents this can vary slightly. |
| 70 | + # Using get_origin and get_args is robust across Python versions >= 3.8 |
| 71 | + if hasattr(inspect, "get_origin"): # Python 3.8+ |
| 72 | + from typing import get_args, get_origin |
| 73 | + |
| 74 | + assert get_origin(param.annotation) is list |
| 75 | + assert get_args(param.annotation) == (str,) |
| 76 | + else: # Fallback for older versions (might need adjustment) |
| 77 | + assert param.annotation == list[str] # For older typing |
| 78 | + |
| 79 | + assert param.kind == Parameter.POSITIONAL_OR_KEYWORD |
| 80 | + |
| 81 | + |
| 82 | +def test_parameter_schema_array_integer(): |
| 83 | + """Tests ParameterSchema with type 'array' containing integers.""" |
| 84 | + item_schema = ParameterSchema(name="", type="integer", description="") |
| 85 | + schema = ParameterSchema( |
| 86 | + name="scores", type="array", description="List of scores", items=item_schema |
| 87 | + ) |
| 88 | + |
| 89 | + param = schema.to_param() |
| 90 | + assert isinstance(param, Parameter) |
| 91 | + assert param.name == "scores" |
| 92 | + assert param.annotation == list[int] |
| 93 | + assert param.kind == Parameter.POSITIONAL_OR_KEYWORD |
| 94 | + |
| 95 | + |
| 96 | +def test_parameter_schema_array_no_items_error(): |
| 97 | + """Tests that 'array' type raises error if 'items' is None.""" |
| 98 | + schema = ParameterSchema( |
| 99 | + name="bad_list", type="array", description="List without item type" |
| 100 | + ) |
| 101 | + |
| 102 | + expected_error_msg = "Unexpected value: type is 'list' but items is None" |
| 103 | + with pytest.raises(Exception, match=expected_error_msg): |
| 104 | + schema._ParameterSchema__get_type() |
| 105 | + |
| 106 | + # Also test via to_param() |
| 107 | + with pytest.raises(Exception, match=expected_error_msg): |
| 108 | + schema.to_param() |
| 109 | + |
| 110 | + |
| 111 | +def test_parameter_schema_unsupported_type_error(): |
| 112 | + """Tests that an unsupported type raises ValueError.""" |
| 113 | + unsupported_type = "datetime" |
| 114 | + schema = ParameterSchema( |
| 115 | + name="event_time", type=unsupported_type, description="When it happened" |
| 116 | + ) |
| 117 | + |
| 118 | + expected_error_msg = f"Unsupported schema type: {unsupported_type}" |
| 119 | + with pytest.raises(ValueError, match=expected_error_msg): |
| 120 | + schema._ParameterSchema__get_type() # Call the method that raises |
| 121 | + |
| 122 | + # Also test via to_param() |
| 123 | + with pytest.raises(ValueError, match=expected_error_msg): |
| 124 | + schema.to_param() |
0 commit comments