Spaces:
Build error
Build error
File size: 10,501 Bytes
0827183 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
from unittest.mock import Mock
import azure.cosmos.errors as cosmos_errors
from azure.cosmos.cosmos_client import CosmosClient
import pytest
from botbuilder.core import StoreItem
from botbuilder.azure import CosmosDbStorage, CosmosDbConfig
from botbuilder.testing import StorageBaseTests
# local cosmosdb emulator instance cosmos_db_config
COSMOS_DB_CONFIG = CosmosDbConfig(
endpoint="https://localhost:8081",
masterkey="C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==",
database="test-db",
container="bot-storage",
)
EMULATOR_RUNNING = False
def get_storage():
return CosmosDbStorage(COSMOS_DB_CONFIG)
async def reset():
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
try:
storage.client.DeleteDatabase(database_link="dbs/" + COSMOS_DB_CONFIG.database)
except cosmos_errors.HTTPFailure:
pass
def get_mock_client(identifier: str = "1"):
# pylint: disable=attribute-defined-outside-init, invalid-name
mock = MockClient()
mock.QueryDatabases = Mock(return_value=[])
mock.QueryContainers = Mock(return_value=[])
mock.CreateDatabase = Mock(return_value={"id": identifier})
mock.CreateContainer = Mock(return_value={"id": identifier})
return mock
class MockClient(CosmosClient):
def __init__(self): # pylint: disable=super-init-not-called
pass
class SimpleStoreItem(StoreItem):
def __init__(self, counter=1, e_tag="*"):
super(SimpleStoreItem, self).__init__()
self.counter = counter
self.e_tag = e_tag
class TestCosmosDbStorageConstructor:
@pytest.mark.asyncio
async def test_cosmos_storage_init_should_error_without_cosmos_db_config(self):
try:
CosmosDbStorage(CosmosDbConfig())
except Exception as error:
assert error
@pytest.mark.asyncio
async def test_creation_request_options_are_being_called(self):
# pylint: disable=protected-access
test_config = CosmosDbConfig(
endpoint="https://localhost:8081",
masterkey="C2y6yDjf5/R+ob0N8A7Cgv30VRDJIWEHLM+4QDU5DE2nQ9nDuVTqobD4b8mGGyPMbIZnqyMsEcaGQy67XIw/Jw==",
database="test-db",
container="bot-storage",
database_creation_options={"OfferThroughput": 1000},
container_creation_options={"OfferThroughput": 500},
)
test_id = "1"
client = get_mock_client(identifier=test_id)
storage = CosmosDbStorage(test_config, client)
storage.database = test_id
assert storage._get_or_create_database(doc_client=client, id=test_id), test_id
client.CreateDatabase.assert_called_with(
{"id": test_id}, test_config.database_creation_options
)
assert storage._get_or_create_container(
doc_client=client, container=test_id
), test_id
client.CreateContainer.assert_called_with(
"dbs/" + test_id, {"id": test_id}, test_config.container_creation_options
)
class TestCosmosDbStorageBaseStorageTests:
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_return_empty_object_when_reading_unknown_key(self):
await reset()
test_ran = await StorageBaseTests.return_empty_object_when_reading_unknown_key(
get_storage()
)
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_handle_null_keys_when_reading(self):
await reset()
test_ran = await StorageBaseTests.handle_null_keys_when_reading(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_handle_null_keys_when_writing(self):
await reset()
test_ran = await StorageBaseTests.handle_null_keys_when_writing(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_does_not_raise_when_writing_no_items(self):
await reset()
test_ran = await StorageBaseTests.does_not_raise_when_writing_no_items(
get_storage()
)
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_create_object(self):
await reset()
test_ran = await StorageBaseTests.create_object(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_handle_crazy_keys(self):
await reset()
test_ran = await StorageBaseTests.handle_crazy_keys(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_update_object(self):
await reset()
test_ran = await StorageBaseTests.update_object(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_delete_object(self):
await reset()
test_ran = await StorageBaseTests.delete_object(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_perform_batch_operations(self):
await reset()
test_ran = await StorageBaseTests.perform_batch_operations(get_storage())
assert test_ran
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_proceeds_through_waterfall(self):
await reset()
test_ran = await StorageBaseTests.proceeds_through_waterfall(get_storage())
assert test_ran
class TestCosmosDbStorage:
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_init_should_work_with_just_endpoint_and_key(self):
storage = CosmosDbStorage(
CosmosDbConfig(
endpoint=COSMOS_DB_CONFIG.endpoint, masterkey=COSMOS_DB_CONFIG.masterkey
)
)
await storage.write({"user": SimpleStoreItem()})
data = await storage.read(["user"])
assert "user" in data
assert data["user"].counter == 1
assert len(data.keys()) == 1
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_read_update_should_return_new_etag(self):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
await storage.write({"test": SimpleStoreItem(counter=1)})
data_result = await storage.read(["test"])
data_result["test"].counter = 2
await storage.write(data_result)
data_updated = await storage.read(["test"])
assert data_updated["test"].counter == 2
assert data_updated["test"].e_tag != data_result["test"].e_tag
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_read_with_invalid_key_should_return_empty_dict(self):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
data = await storage.read(["test"])
assert isinstance(data, dict)
assert not data.keys()
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_write_should_overwrite_when_new_e_tag_is_an_asterisk(
self,
):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
await storage.write({"user": SimpleStoreItem()})
await storage.write({"user": SimpleStoreItem(counter=10, e_tag="*")})
data = await storage.read(["user"])
assert data["user"].counter == 10
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_delete_should_delete_multiple_values_when_given_multiple_valid_keys(
self,
):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
await storage.write({"test": SimpleStoreItem(), "test2": SimpleStoreItem(2)})
await storage.delete(["test", "test2"])
data = await storage.read(["test", "test2"])
assert not data.keys()
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_delete_should_delete_values_when_given_multiple_valid_keys_and_ignore_other_data(
self,
):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
await storage.write(
{
"test": SimpleStoreItem(),
"test2": SimpleStoreItem(counter=2),
"test3": SimpleStoreItem(counter=3),
}
)
await storage.delete(["test", "test2"])
data = await storage.read(["test", "test2", "test3"])
assert len(data.keys()) == 1
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_delete_invalid_key_should_do_nothing_and_not_affect_cached_data(
self,
):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
await storage.write({"test": SimpleStoreItem()})
await storage.delete(["foo"])
data = await storage.read(["test"])
assert len(data.keys()) == 1
data = await storage.read(["foo"])
assert not data.keys()
@pytest.mark.skipif(not EMULATOR_RUNNING, reason="Needs the emulator to run.")
@pytest.mark.asyncio
async def test_cosmos_storage_delete_invalid_keys_should_do_nothing_and_not_affect_cached_data(
self,
):
await reset()
storage = CosmosDbStorage(COSMOS_DB_CONFIG)
await storage.write({"test": SimpleStoreItem()})
await storage.delete(["foo", "bar"])
data = await storage.read(["test"])
assert len(data.keys()) == 1
|