|
| 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 | +from unittest.mock import MagicMock |
| 16 | +from unittest.mock import patch |
| 17 | + |
| 18 | +from google.adk.tools.spanner import metadata_tool |
| 19 | +from google.cloud.spanner_admin_database_v1.types import DatabaseDialect |
| 20 | +import pytest |
| 21 | + |
| 22 | + |
| 23 | +@pytest.fixture |
| 24 | +def mock_credentials(): |
| 25 | + return MagicMock() |
| 26 | + |
| 27 | + |
| 28 | +@pytest.fixture |
| 29 | +def mock_spanner_ids(): |
| 30 | + return { |
| 31 | + "project_id": "test-project", |
| 32 | + "instance_id": "test-instance", |
| 33 | + "database_id": "test-database", |
| 34 | + "table_name": "test-table", |
| 35 | + } |
| 36 | + |
| 37 | + |
| 38 | +@patch("google.adk.tools.spanner.client.get_spanner_client") |
| 39 | +def test_list_table_names_success( |
| 40 | + mock_get_spanner_client, mock_spanner_ids, mock_credentials |
| 41 | +): |
| 42 | + """Test list_table_names function with success.""" |
| 43 | + mock_spanner_client = MagicMock() |
| 44 | + mock_instance = MagicMock() |
| 45 | + mock_database = MagicMock() |
| 46 | + mock_table = MagicMock() |
| 47 | + mock_table.table_id = "table1" |
| 48 | + mock_database.list_tables.return_value = [mock_table] |
| 49 | + mock_instance.database.return_value = mock_database |
| 50 | + mock_spanner_client.instance.return_value = mock_instance |
| 51 | + mock_get_spanner_client.return_value = mock_spanner_client |
| 52 | + |
| 53 | + result = metadata_tool.list_table_names( |
| 54 | + mock_spanner_ids["project_id"], |
| 55 | + mock_spanner_ids["instance_id"], |
| 56 | + mock_spanner_ids["database_id"], |
| 57 | + mock_credentials, |
| 58 | + ) |
| 59 | + assert result["status"] == "SUCCESS" |
| 60 | + assert result["results"] == ["table1"] |
| 61 | + |
| 62 | + |
| 63 | +@patch("google.adk.tools.spanner.client.get_spanner_client") |
| 64 | +def test_list_table_names_error( |
| 65 | + mock_get_spanner_client, mock_spanner_ids, mock_credentials |
| 66 | +): |
| 67 | + """Test list_table_names function with error.""" |
| 68 | + mock_get_spanner_client.side_effect = Exception("Test Exception") |
| 69 | + result = metadata_tool.list_table_names( |
| 70 | + mock_spanner_ids["project_id"], |
| 71 | + mock_spanner_ids["instance_id"], |
| 72 | + mock_spanner_ids["database_id"], |
| 73 | + mock_credentials, |
| 74 | + ) |
| 75 | + assert result["status"] == "ERROR" |
| 76 | + assert result["error_details"] == "Test Exception" |
| 77 | + |
| 78 | + |
| 79 | +@patch("google.adk.tools.spanner.client.get_spanner_client") |
| 80 | +def test_get_table_schema_success( |
| 81 | + mock_get_spanner_client, mock_spanner_ids, mock_credentials |
| 82 | +): |
| 83 | + """Test get_table_schema function with success.""" |
| 84 | + mock_spanner_client = MagicMock() |
| 85 | + mock_instance = MagicMock() |
| 86 | + mock_database = MagicMock() |
| 87 | + mock_snapshot = MagicMock() |
| 88 | + |
| 89 | + mock_columns_result = [( |
| 90 | + "col1", # COLUMN_NAME |
| 91 | + "", # TABLE_SCHEMA |
| 92 | + "STRING(MAX)", # SPANNER_TYPE |
| 93 | + 1, # ORDINAL_POSITION |
| 94 | + None, # COLUMN_DEFAULT |
| 95 | + "NO", # IS_NULLABLE |
| 96 | + "NEVER", # IS_GENERATED |
| 97 | + None, # GENERATION_EXPRESSION |
| 98 | + None, # IS_STORED |
| 99 | + )] |
| 100 | + |
| 101 | + mock_key_columns_result = [( |
| 102 | + "col1", # COLUMN_NAME |
| 103 | + "PK_Table", # CONSTRAINT_NAME |
| 104 | + 1, # ORDINAL_POSITION |
| 105 | + None, # POSITION_IN_UNIQUE_CONSTRAINT |
| 106 | + )] |
| 107 | + |
| 108 | + mock_table_metadata_result = [( |
| 109 | + "", # TABLE_SCHEMA |
| 110 | + "test_table", # TABLE_NAME |
| 111 | + "BASE TABLE", # TABLE_TYPE |
| 112 | + None, # PARENT_TABLE_NAME |
| 113 | + None, # ON_DELETE_ACTION |
| 114 | + "COMMITTED", # SPANNER_STATE |
| 115 | + None, # INTERLEAVE_TYPE |
| 116 | + "OLDER_THAN(CreatedAt, INTERVAL 1 DAY)", # ROW_DELETION_POLICY_EXPRESSION |
| 117 | + )] |
| 118 | + |
| 119 | + mock_snapshot.execute_sql.side_effect = [ |
| 120 | + mock_columns_result, |
| 121 | + mock_key_columns_result, |
| 122 | + mock_table_metadata_result, |
| 123 | + ] |
| 124 | + |
| 125 | + mock_database.snapshot.return_value.__enter__.return_value = mock_snapshot |
| 126 | + mock_database.database_dialect = DatabaseDialect.GOOGLE_STANDARD_SQL |
| 127 | + mock_instance.database.return_value = mock_database |
| 128 | + mock_spanner_client.instance.return_value = mock_instance |
| 129 | + mock_get_spanner_client.return_value = mock_spanner_client |
| 130 | + |
| 131 | + result = metadata_tool.get_table_schema( |
| 132 | + mock_spanner_ids["project_id"], |
| 133 | + mock_spanner_ids["instance_id"], |
| 134 | + mock_spanner_ids["database_id"], |
| 135 | + mock_spanner_ids["table_name"], |
| 136 | + mock_credentials, |
| 137 | + ) |
| 138 | + |
| 139 | + assert result["status"] == "SUCCESS" |
| 140 | + assert "col1" in result["results"]["schema"] |
| 141 | + assert result["results"]["schema"]["col1"]["SPANNER_TYPE"] == "STRING(MAX)" |
| 142 | + assert "KEY_COLUMN_USAGE" in result["results"]["schema"]["col1"] |
| 143 | + assert ( |
| 144 | + result["results"]["schema"]["col1"]["KEY_COLUMN_USAGE"][0][ |
| 145 | + "CONSTRAINT_NAME" |
| 146 | + ] |
| 147 | + == "PK_Table" |
| 148 | + ) |
| 149 | + assert "metadata" in result["results"] |
| 150 | + assert result["results"]["metadata"][0]["TABLE_NAME"] == "test_table" |
| 151 | + assert ( |
| 152 | + result["results"]["metadata"][0]["ROW_DELETION_POLICY_EXPRESSION"] |
| 153 | + == "OLDER_THAN(CreatedAt, INTERVAL 1 DAY)" |
| 154 | + ) |
| 155 | + |
| 156 | + |
| 157 | +@patch("google.adk.tools.spanner.client.get_spanner_client") |
| 158 | +def test_list_table_indexes_success( |
| 159 | + mock_get_spanner_client, mock_spanner_ids, mock_credentials |
| 160 | +): |
| 161 | + """Test list_table_indexes function with success.""" |
| 162 | + mock_spanner_client = MagicMock() |
| 163 | + mock_instance = MagicMock() |
| 164 | + mock_database = MagicMock() |
| 165 | + mock_snapshot = MagicMock() |
| 166 | + mock_result_set = MagicMock() |
| 167 | + mock_result_set.__iter__.return_value = iter([( |
| 168 | + "PRIMARY_KEY", |
| 169 | + "", |
| 170 | + "PRIMARY_KEY", |
| 171 | + "", |
| 172 | + True, |
| 173 | + False, |
| 174 | + None, |
| 175 | + )]) |
| 176 | + mock_snapshot.execute_sql.return_value = mock_result_set |
| 177 | + mock_database.snapshot.return_value.__enter__.return_value = mock_snapshot |
| 178 | + mock_database.database_dialect = DatabaseDialect.GOOGLE_STANDARD_SQL |
| 179 | + mock_instance.database.return_value = mock_database |
| 180 | + mock_spanner_client.instance.return_value = mock_instance |
| 181 | + mock_get_spanner_client.return_value = mock_spanner_client |
| 182 | + |
| 183 | + result = metadata_tool.list_table_indexes( |
| 184 | + mock_spanner_ids["project_id"], |
| 185 | + mock_spanner_ids["instance_id"], |
| 186 | + mock_spanner_ids["database_id"], |
| 187 | + mock_spanner_ids["table_name"], |
| 188 | + mock_credentials, |
| 189 | + ) |
| 190 | + assert result["status"] == "SUCCESS" |
| 191 | + assert len(result["results"]) == 1 |
| 192 | + assert result["results"][0]["INDEX_NAME"] == "PRIMARY_KEY" |
| 193 | + |
| 194 | + |
| 195 | +@patch("google.adk.tools.spanner.client.get_spanner_client") |
| 196 | +def test_list_table_index_columns_success( |
| 197 | + mock_get_spanner_client, mock_spanner_ids, mock_credentials |
| 198 | +): |
| 199 | + """Test list_table_index_columns function with success.""" |
| 200 | + mock_spanner_client = MagicMock() |
| 201 | + mock_instance = MagicMock() |
| 202 | + mock_database = MagicMock() |
| 203 | + mock_snapshot = MagicMock() |
| 204 | + mock_result_set = MagicMock() |
| 205 | + mock_result_set.__iter__.return_value = iter([( |
| 206 | + "PRIMARY_KEY", |
| 207 | + "", |
| 208 | + "col1", |
| 209 | + 1, |
| 210 | + "NO", |
| 211 | + "STRING(MAX)", |
| 212 | + )]) |
| 213 | + mock_snapshot.execute_sql.return_value = mock_result_set |
| 214 | + mock_database.snapshot.return_value.__enter__.return_value = mock_snapshot |
| 215 | + mock_database.database_dialect = DatabaseDialect.GOOGLE_STANDARD_SQL |
| 216 | + mock_instance.database.return_value = mock_database |
| 217 | + mock_spanner_client.instance.return_value = mock_instance |
| 218 | + mock_get_spanner_client.return_value = mock_spanner_client |
| 219 | + |
| 220 | + result = metadata_tool.list_table_index_columns( |
| 221 | + mock_spanner_ids["project_id"], |
| 222 | + mock_spanner_ids["instance_id"], |
| 223 | + mock_spanner_ids["database_id"], |
| 224 | + mock_spanner_ids["table_name"], |
| 225 | + mock_credentials, |
| 226 | + ) |
| 227 | + assert result["status"] == "SUCCESS" |
| 228 | + assert len(result["results"]) == 1 |
| 229 | + assert result["results"][0]["COLUMN_NAME"] == "col1" |
| 230 | + |
| 231 | + |
| 232 | +@patch("google.adk.tools.spanner.client.get_spanner_client") |
| 233 | +def test_list_named_schemas_success( |
| 234 | + mock_get_spanner_client, mock_spanner_ids, mock_credentials |
| 235 | +): |
| 236 | + """Test list_named_schemas function with success.""" |
| 237 | + mock_spanner_client = MagicMock() |
| 238 | + mock_instance = MagicMock() |
| 239 | + mock_database = MagicMock() |
| 240 | + mock_snapshot = MagicMock() |
| 241 | + mock_result_set = MagicMock() |
| 242 | + mock_result_set.__iter__.return_value = iter([("schema1",), ("schema2",)]) |
| 243 | + mock_snapshot.execute_sql.return_value = mock_result_set |
| 244 | + mock_database.snapshot.return_value.__enter__.return_value = mock_snapshot |
| 245 | + mock_database.database_dialect = DatabaseDialect.GOOGLE_STANDARD_SQL |
| 246 | + mock_instance.database.return_value = mock_database |
| 247 | + mock_spanner_client.instance.return_value = mock_instance |
| 248 | + mock_get_spanner_client.return_value = mock_spanner_client |
| 249 | + |
| 250 | + result = metadata_tool.list_named_schemas( |
| 251 | + mock_spanner_ids["project_id"], |
| 252 | + mock_spanner_ids["instance_id"], |
| 253 | + mock_spanner_ids["database_id"], |
| 254 | + mock_credentials, |
| 255 | + ) |
| 256 | + assert result["status"] == "SUCCESS" |
| 257 | + assert result["results"] == ["schema1", "schema2"] |
0 commit comments