|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | + |
| 3 | +# Copyright 2026 Google LLC |
| 4 | +# |
| 5 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | +# you may not use this file except in compliance with the License. |
| 7 | +# You may obtain a copy of the License at |
| 8 | +# |
| 9 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +# |
| 11 | +# Unless required by applicable law or agreed to in writing, software |
| 12 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +# See the License for the specific language governing permissions and |
| 15 | +# limitations under the License. |
| 16 | +# |
| 17 | +"""Unit tests for `vertexai.types` resolving against `agentplatform.types`.""" |
| 18 | + |
| 19 | +import agentplatform |
| 20 | +import vertexai |
| 21 | +from agentplatform._genai import types as agentplatform_types |
| 22 | +from vertexai._genai import types as legacy_types |
| 23 | + |
| 24 | +import sys |
| 25 | + |
| 26 | +import pytest |
| 27 | + |
| 28 | +# Both modules resolve these out of `_evals_metric_loaders` on first access, so |
| 29 | +# they are checked on their own rather than in the bulk comparisons below. |
| 30 | +_LAZY_NAMES = frozenset({"PrebuiltMetric", "RubricMetric"}) |
| 31 | + |
| 32 | +_SHARED_NAMES = sorted( |
| 33 | + (set(agentplatform_types.__all__) & set(legacy_types.__all__)) - _LAZY_NAMES |
| 34 | +) |
| 35 | +_LEGACY_ONLY_NAMES = sorted( |
| 36 | + set(legacy_types.__all__) - set(agentplatform_types.__all__) |
| 37 | +) |
| 38 | +_AGENT_PLATFORM_ONLY_NAMES = sorted( |
| 39 | + set(agentplatform_types.__all__) - set(legacy_types.__all__) |
| 40 | +) |
| 41 | + |
| 42 | + |
| 43 | +def test_vertexai_types_is_the_alias_module(): |
| 44 | + assert sys.modules[vertexai.types.__name__] is vertexai.types |
| 45 | + assert vertexai.types is not legacy_types |
| 46 | + assert vertexai.types is not agentplatform_types |
| 47 | + |
| 48 | + |
| 49 | +def test_shared_names_are_the_agentplatform_objects(): |
| 50 | + """The point of the alias: one class per message rather than two.""" |
| 51 | + assert _SHARED_NAMES, "expected the two modules to share generated types" |
| 52 | + mismatched = [ |
| 53 | + name |
| 54 | + for name in _SHARED_NAMES |
| 55 | + if getattr(vertexai.types, name) is not getattr(agentplatform_types, name) |
| 56 | + ] |
| 57 | + assert not mismatched |
| 58 | + |
| 59 | + |
| 60 | +def test_memory_profile_survives_an_isinstance_check(): |
| 61 | + """Regression: an agentplatform object checked against the vertexai name.""" |
| 62 | + profile = agentplatform_types.MemoryProfile(schema_id="user-profile", profile={}) |
| 63 | + assert isinstance(profile, vertexai.types.MemoryProfile) |
| 64 | + |
| 65 | + |
| 66 | +def test_shared_types_still_nest_inside_a_legacy_only_model(): |
| 67 | + """The two halves have to interoperate, not just coexist. |
| 68 | +
|
| 69 | + `GenerateAgentEngineMemoriesConfig` stays a `vertexai` class because |
| 70 | + agentplatform renamed it, but its `metadata` values are now agentplatform |
| 71 | + objects. Pydantic accepts them because both models derive from the genai |
| 72 | + `BaseModel`, which sets `from_attributes=True`. |
| 73 | + """ |
| 74 | + config = vertexai.types.GenerateAgentEngineMemoriesConfig( |
| 75 | + metadata={"record": vertexai.types.MemoryMetadataValue(string_value="123")} |
| 76 | + ) |
| 77 | + assert type(config) is legacy_types.GenerateAgentEngineMemoriesConfig |
| 78 | + assert config.metadata["record"].string_value == "123" |
| 79 | + |
| 80 | + |
| 81 | +def test_legacy_only_names_still_resolve(): |
| 82 | + """The `AgentEngine*` surface agentplatform renamed is not taken away.""" |
| 83 | + assert "AgentEngine" in _LEGACY_ONLY_NAMES |
| 84 | + mismatched = [ |
| 85 | + name |
| 86 | + for name in _LEGACY_ONLY_NAMES |
| 87 | + if getattr(vertexai.types, name) is not getattr(legacy_types, name) |
| 88 | + ] |
| 89 | + assert not mismatched |
| 90 | + |
| 91 | + |
| 92 | +def test_agentplatform_only_names_are_reachable(): |
| 93 | + assert "Runtime" in _AGENT_PLATFORM_ONLY_NAMES |
| 94 | + mismatched = [ |
| 95 | + name |
| 96 | + for name in _AGENT_PLATFORM_ONLY_NAMES |
| 97 | + if getattr(vertexai.types, name) is not getattr(agentplatform_types, name) |
| 98 | + ] |
| 99 | + assert not mismatched |
| 100 | + |
| 101 | + |
| 102 | +@pytest.mark.parametrize("name", sorted(_LAZY_NAMES)) |
| 103 | +def test_lazily_loaded_metric_names_resolve_to_agentplatform(name): |
| 104 | + assert getattr(vertexai.types, name) is getattr(agentplatform_types, name) |
| 105 | + |
| 106 | + |
| 107 | +def test_all_is_the_union_of_both_modules(): |
| 108 | + expected = set(agentplatform_types.__all__) | set(legacy_types.__all__) |
| 109 | + assert set(vertexai.types.__all__) == expected |
| 110 | + assert set(dir(vertexai.types)) == expected |
| 111 | + |
| 112 | + |
| 113 | +def test_unknown_name_still_raises_attribute_error(): |
| 114 | + with pytest.raises(AttributeError): |
| 115 | + _ = vertexai.types.NoSuchTypeName |
| 116 | + |
| 117 | + |
| 118 | +def test_agentplatform_registers_its_own_types_alias(): |
| 119 | + """`agentplatform.types` must no longer claim the `vertexai.types` key.""" |
| 120 | + assert agentplatform.types is agentplatform_types |
| 121 | + assert sys.modules[f"{agentplatform.__name__}.types"] is agentplatform_types |
| 122 | + assert sys.modules[f"{vertexai.__name__}.types"] is not agentplatform_types |
0 commit comments