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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
|
# -*- coding: utf-8 -*-
# The MIT License (MIT)
# Copyright (c) Microsoft Corporation. All rights reserved.
"""Tests for the CosmosHttpLoggingPolicy."""
import unittest
import uuid
import logging
import pytest
import azure.cosmos.aio._cosmos_client as cosmos_client
from azure.cosmos import PartitionKey
import test_config
from _fault_injection_transport_async import FaultInjectionTransportAsync
from test_fault_injection_transport_async import TestFaultInjectionTransportAsync
from test_cosmos_http_logging_policy import create_logger, L1, L2, CONFIG, \
get_locations_list, FilterStatusCode, MockHandler
try:
from unittest.mock import Mock
except ImportError: # python < 3.3
from mock import Mock # type: ignore
@pytest.mark.cosmosEmulator
class TestCosmosHttpLoggerAsync(unittest.IsolatedAsyncioTestCase):
mock_handler_diagnostic = None
mock_handler_default = None
config = test_config.TestConfig
host = config.host
masterKey = config.masterKey
connectionPolicy = config.connectionPolicy
@classmethod
def setUpClass(cls):
if (cls.masterKey == '[YOUR_KEY_HERE]' or
cls.host == '[YOUR_ENDPOINT_HERE]'):
raise Exception(
"You must specify your Azure Cosmos account values for "
"'masterKey' and 'host' at the top of this class to run the "
"tests.")
async def asyncSetUp(self):
self.mock_handler_default = MockHandler()
self.mock_handler_diagnostic = MockHandler()
self.mock_handler_filtered_diagnostic = MockHandler()
self.mock_handler_activity_id = MockHandler()
# Add filter to the filtered diagnostics handler
self.mock_handler_filtered_diagnostic.addFilter(FilterStatusCode())
self.logger = logging.getLogger("azure.cosmos")
self.logger.setLevel(logging.INFO)
self.client_default = None
self.client_diagnostic = None
self.client_filtered_diagnostic = None
self.client_activity_id = None
async def asyncTearDown(self):
if self.client_default:
await self.client_default.close()
if self.client_diagnostic:
await self.client_diagnostic.close()
if self.client_filtered_diagnostic:
await self.client_filtered_diagnostic.close()
if self.client_activity_id:
await self.client_activity_id.close()
async def test_default_http_logging_policy_async(self):
self.logger.addHandler(self.mock_handler_default)
# Create a client with the default logging policy
self.client_default = cosmos_client.CosmosClient(self.host, self.masterKey,
consistency_level="Session", logger=self.logger)
await self.client_default.__aenter__()
# Test if we can log info from creating a database
database_id = "database_test-" + str(uuid.uuid4())
await self.client_default.create_database(id=database_id)
assert all(m.levelname == 'INFO' for m in self.mock_handler_default.messages)
messages_request = self.mock_handler_default.messages[0].message.split("\n")
messages_response = self.mock_handler_default.messages[1].message.split("\n")
assert messages_request[1] == "Request method: 'GET'"
assert 'Request headers:' in messages_request[2]
assert messages_request[-1] == 'No body was attached to the request'
assert messages_response[0] == 'Response status: 200'
assert 'Response headers:' in messages_response[1]
self.mock_handler_default.reset()
self.logger.removeHandler(self.mock_handler_default)
# delete database
await self.client_default.delete_database(database_id)
async def test_cosmos_http_logging_policy_async(self):
self.logger.addHandler(self.mock_handler_diagnostic)
# Create a client with the diagnostic logging policy
self.client_diagnostic = cosmos_client.CosmosClient(self.host, self.masterKey,
consistency_level="Session", logger=self.logger,
enable_diagnostics_logging=True)
# Test if we can log into from reading a database
database_id = "database_test-" + str(uuid.uuid4())
await self.client_diagnostic.create_database(id=database_id)
assert all(m.levelname == 'INFO' for m in self.mock_handler_diagnostic.messages)
# Check that we made a databaseaccount read request only once and that we only logged it once
messages_request = self.mock_handler_diagnostic.messages[0]
messages_response = self.mock_handler_diagnostic.messages[1]
elapsed_time = messages_response.duration
assert "databaseaccount" == messages_request.resource_type
assert messages_request.verb == "GET"
assert 200 == messages_response.status_code
assert "Read" == messages_request.operation_type
assert elapsed_time is not None
assert "Response headers" in messages_response.message
# Verify we only have a total of 6 logged messages: 4 from databaseaccount read and 2 from create database
assert len(self.mock_handler_diagnostic.messages) == 6
# Test if we can log into from creating a database
# The request to create database should follow the databaseaccount read request immediately
messages_request = self.mock_handler_diagnostic.messages[4]
messages_response = self.mock_handler_diagnostic.messages[5]
elapsed_time = messages_response.duration
assert "dbs" == messages_request.resource_type
assert messages_request.verb == "POST"
assert 201 == messages_response.status_code
assert messages_request.operation_type == "Create"
assert elapsed_time is not None
assert "Response headers" in messages_response.message
self.mock_handler_diagnostic.reset()
# now test in case of an error
try:
await self.client_diagnostic.create_database(id=database_id)
except:
pass
assert all(m.levelname == 'INFO' for m in self.mock_handler_diagnostic.messages)
messages_request = self.mock_handler_diagnostic.messages[0]
messages_response = self.mock_handler_diagnostic.messages[1]
elapsed_time = messages_response.duration
assert "dbs" == messages_request.resource_type
assert messages_request.operation_type == "Create"
assert 'Request headers:' in messages_request.msg
assert 'A body is sent with the request' in messages_request.msg
assert messages_response.status_code == 409
assert elapsed_time is not None
assert "Response headers" in messages_response.msg
# delete database
await self.client_diagnostic.delete_database(database_id)
self.mock_handler_diagnostic.reset()
self.logger.removeHandler(self.mock_handler_diagnostic)
async def test_filtered_diagnostics_logging_policy_async(self):
self.logger.addHandler(self.mock_handler_filtered_diagnostic)
# Create a client with the filtered diagnostics logging policy
self.client_filtered_diagnostic = cosmos_client.CosmosClient(self.host, self.masterKey,
consistency_level="Session",
logger=self.logger,
enable_diagnostics_logging=True)
# Test if we can log errors with the filtered diagnostics logger
database_id = "database_test_" + str(uuid.uuid4())
container_id = "diagnostics_container_test_" + str(uuid.uuid4())
await self.client_filtered_diagnostic.create_database(id=database_id)
database = self.client_filtered_diagnostic.get_database_client(database_id)
await database.create_container(id=container_id, partition_key=PartitionKey(path="/pk"))
# Try to read an item that doesn't exist
try:
container = database.get_container_client(container_id)
await container.read_item(item="nonexistent_item", partition_key="nonexistent_pk")
except:
pass
# Assert that the filtered logger only captured the error
request_log = self.mock_handler_filtered_diagnostic.messages[0]
response_log = self.mock_handler_filtered_diagnostic.messages[1]
assert response_log.status_code == 404
assert request_log.resource_type == "docs"
assert request_log.operation_type == "Read"
assert len(self.mock_handler_filtered_diagnostic.messages) == 2
self.mock_handler_filtered_diagnostic.reset()
# Try to create an item with an invalid partition key
try:
await container.create_item(body={"FakeProperty": "item1", "NotPk": None})
except:
pass
# Assert that the filtered logger captured the error
request_log = self.mock_handler_filtered_diagnostic.messages[0]
response_log = self.mock_handler_filtered_diagnostic.messages[1]
assert response_log.status_code == 400
assert request_log.resource_type == "docs"
assert request_log.operation_type == "Create"
assert len(self.mock_handler_filtered_diagnostic.messages) == 2
# Clean up
await self.client_filtered_diagnostic.delete_database(database_id)
self.mock_handler_filtered_diagnostic.reset()
self.logger.removeHandler(self.mock_handler_filtered_diagnostic)
async def test_client_settings_async(self):
# Test data
all_locations = [L1, L2]
client_excluded_locations = [L1]
multiple_write_locations = True
# Client setup
mock_handler = MockHandler()
logger = create_logger("test_logger_client_settings", mock_handler)
custom_transport = FaultInjectionTransportAsync()
is_get_account_predicate = lambda r: FaultInjectionTransportAsync.predicate_is_database_account_call(r)
emulator_as_multi_write_region_account_transformation = \
lambda r, inner: FaultInjectionTransportAsync.transform_topology_mwr(
first_region_name=L1,
second_region_name=L2,
inner=inner,
)
custom_transport.add_response_transformation(
is_get_account_predicate,
emulator_as_multi_write_region_account_transformation)
initialized_objects = await TestFaultInjectionTransportAsync.setup_method_with_custom_transport(
custom_transport,
default_endpoint=CONFIG.host,
key=CONFIG.masterKey,
database_id=CONFIG.TEST_DATABASE_ID,
container_id=CONFIG.TEST_SINGLE_PARTITION_CONTAINER_ID,
custom_logger=logger,
preferred_locations=all_locations,
excluded_locations=client_excluded_locations,
multiple_write_locations=multiple_write_locations
)
mock_handler.reset()
# create an item
id_value = str(uuid.uuid4())
document_definition = {'id': id_value, 'pk': id_value}
container = initialized_objects["col"]
await container.create_item(body=document_definition)
# Verify endpoint locations
messages_split = mock_handler.messages[1].message.split("\n")
for message in messages_split:
if "Preferred Regions:" in message:
locations = get_locations_list(message)
assert all_locations == locations
elif "Excluded Regions:" in message:
locations = get_locations_list(message)
assert client_excluded_locations == locations
elif "Account Read Regions:" in message:
locations = get_locations_list(message)
assert all_locations == locations
elif "Account Write Regions:" in message:
locations = get_locations_list(message)
assert all_locations == locations
await initialized_objects["client"].close()
async def test_activity_id_logging_policy_async(self):
# Create a mock handler and logger for the new client
self.logger.addHandler(self.mock_handler_activity_id)
# Create a new client with the logger and enable diagnostics logging
self.client_activity_id = cosmos_client.CosmosClient(
self.host,
self.masterKey,
consistency_level="Session",
logger=self.logger,
enable_diagnostics_logging=True
)
# Generate a custom activity ID
custom_activity_id = str(uuid.uuid4())
# Create a database and container for the test
database_id = "database_test_activity_id_" + str(uuid.uuid4())
container_id = "container_test_activity_id_" + str(uuid.uuid4())
try:
database = await self.client_activity_id.create_database(id=database_id)
container = await database.create_container(id=container_id, partition_key=PartitionKey(path="/pk"))
# Reset the mock handler to clear previous messages
self.mock_handler_activity_id.reset()
# Upsert an item and verify the request and response activity IDs match
item_id = str(uuid.uuid4())
item_body = {"id": item_id, "pk": item_id}
await container.upsert_item(body=item_body)
# Verify that the request activity ID matches the response activity ID
log_record_request = self.mock_handler_activity_id.messages[0]
log_record_response = self.mock_handler_activity_id.messages[1]
assert log_record_request.activity_id == log_record_response.activity_id
# Upsert another item with the custom activity ID in the initial headers
headers = {"x-ms-activity-id": custom_activity_id}
item_id_2 = str(uuid.uuid4())
item_body_2 = {"id": item_id_2, "pk": item_id_2}
await container.upsert_item(body=item_body_2, initial_headers=headers)
# Verify that the custom activity ID does not match the request activity ID from the log record
log_record_request_2 = self.mock_handler_activity_id.messages[2]
assert log_record_request_2.activity_id != custom_activity_id
finally:
# Clean up by deleting the database
await self.client_activity_id.delete_database(database_id)
self.mock_handler_activity_id.reset()
self.logger.removeHandler(self.mock_handler_activity_id)
if __name__ == "__main__":
unittest.main()
|