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 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
|
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License
import asyncio
import csv
import dataclasses
import json
import os
import platform
import random
from datetime import datetime
from typing import Optional, ClassVar, Callable
from urllib.parse import urljoin
import pytest
from azure.identity import DefaultAzureCredential
from azure.kusto.data import KustoClient, KustoConnectionStringBuilder
from azure.kusto.data._cloud_settings import CloudSettings, DEFAULT_DEV_KUSTO_SERVICE_RESOURCE_ID
from azure.kusto.data._models import WellKnownDataSet
from azure.kusto.data.aio import KustoClient as AsyncKustoClient
from azure.kusto.data.env_utils import get_env, set_env, prepare_app_key_auth
from azure.kusto.data.exceptions import KustoServiceError
from azure.kusto.data.kusto_trusted_endpoints import MatchRule, well_known_kusto_endpoints
from azure.kusto.data.streaming_response import FrameType
@pytest.fixture(scope="module")
def event_loop_policy(request):
if platform.system() == "Windows":
return asyncio.WindowsSelectorEventLoopPolicy()
return asyncio.DefaultEventLoopPolicy()
@pytest.fixture(params=["ManagedStreaming", "NormalClient"])
def is_managed_streaming(request):
return request.param == "ManagedStreaming"
class TestE2E:
"""A class to define mappings to deft table."""
input_folder_path: ClassVar[str]
streaming_test_table: ClassVar[str]
streaming_test_table_query: ClassVar[str]
ai_test_table_cmd: ClassVar[str]
test_streaming_data_csv_raw: ClassVar[str]
engine_cs: ClassVar[Optional[str]]
ai_engine_cs: ClassVar[Optional[str]]
test_db: ClassVar[Optional[str]]
ai_test_db: ClassVar[Optional[str]]
cred: ClassVar[Callable[[], DefaultAzureCredential]]
async_cred: ClassVar[Callable[[], DefaultAzureCredential]]
CHUNK_SIZE = 1024
@staticmethod
def table_json_mapping_reference():
"""A method to get json mappings reference to test table."""
return """'['
' { "column" : "rownumber", "datatype" : "int", "Properties":{"Path":"$.rownumber"}},'
' { "column" : "rowguid", "datatype" : "string", "Properties":{"Path":"$.rowguid"}},'
' { "column" : "xdouble", "datatype" : "real", "Properties":{"Path":"$.xdouble"}},'
' { "column" : "xfloat", "datatype" : "real", "Properties":{"Path":"$.xfloat"}},'
' { "column" : "xbool", "datatype" : "bool", "Properties":{"Path":"$.xbool"}},'
' { "column" : "xint16", "datatype" : "int", "Properties":{"Path":"$.xint16"}},'
' { "column" : "xint32", "datatype" : "int", "Properties":{"Path":"$.xint32"}},'
' { "column" : "xint64", "datatype" : "long", "Properties":{"Path":"$.xint64"}},'
' { "column" : "xuint8", "datatype" : "long", "Properties":{"Path":"$.xuint8"}},'
' { "column" : "xuint16", "datatype" : "long", "Properties":{"Path":"$.xuint16"}},'
' { "column" : "xuint32", "datatype" : "long", "Properties":{"Path":"$.xuint32"}},'
' { "column" : "xuint64", "datatype" : "long", "Properties":{"Path":"$.xuint64"}},'
' { "column" : "xdate", "datatype" : "datetime", "Properties":{"Path":"$.xdate"}},'
' { "column" : "xsmalltext", "datatype" : "string", "Properties":{"Path":"$.xsmalltext"}},'
' { "column" : "xtext", "datatype" : "string", "Properties":{"Path":"$.xtext"}},'
' { "column" : "xnumberAsText", "datatype" : "string", "Properties":{"Path":"$.rowguid"}},'
' { "column" : "xtime", "datatype" : "timespan", "Properties":{"Path":"$.xtime"}},'
' { "column" : "xtextWithNulls", "datatype" : "string", "Properties":{"Path":"$.xtextWithNulls"}},'
' { "column" : "xdynamicWithNulls", "datatype" : "dynamic", "Properties":{"Path":"$.xdynamicWithNulls"}},'
']'"""
@staticmethod
def application_insights_tables():
"""A method to get the tables of an application insights instance"""
return [
"availabilityResults",
"browserTimings",
"customEvents",
"customMetrics",
"dependencies",
"exceptions",
"pageViews",
"performanceCounters",
"requests",
"traces",
]
@staticmethod
def get_file_path() -> str:
current_dir = os.getcwd()
path_parts = ["azure-kusto-data", "tests", "input"]
missing_path_parts = []
for path_part in path_parts:
if path_part not in current_dir:
missing_path_parts.append(path_part)
return os.path.join(current_dir, *missing_path_parts)
@classmethod
def engine_kcsb_from_env(cls, app_insights=False, is_async=False) -> KustoConnectionStringBuilder:
engine = cls.engine_cs if not app_insights else cls.ai_engine_cs
return KustoConnectionStringBuilder.with_azure_token_credential(
engine,
credential=cls.cred() if not is_async else cls.async_cred(),
)
@classmethod
def setup_class(cls):
cls.engine_cs = get_env("ENGINE_CONNECTION_STRING")
cls.ai_engine_cs = get_env("APPLICATION_INSIGHTS_ENGINE_CONNECTION_STRING", optional=True)
# Called to set the env variables for the default azure credentials
prepare_app_key_auth(optional=True)
set_env("AZURE_AUTHORITY_HOST", "login.microsoftonline.com")
cls.test_db = get_env("TEST_DATABASE")
cls.ai_test_db = get_env("APPLICATION_INSIGHTS_TEST_DATABASE", optional=True) # name of e2e database could be changed
cls.cred = lambda: DefaultAzureCredential(exclude_interactive_browser_credential=False)
# Async credentials don't support interactive browser authentication for now, so until they do, we'll use the sync default credential for async tests
cls.async_cred = lambda: DefaultAzureCredential(exclude_interactive_browser_credential=False)
cls.input_folder_path = cls.get_file_path()
with open(os.path.join(cls.input_folder_path, "big_source.csv")) as f:
cls.test_streaming_data_csv_raw = f.read()
reader = csv.reader(cls.test_streaming_data_csv_raw.splitlines())
cls.test_streaming_data = sorted(reader, key=lambda x: (float(x[0]), x[3])) # sort by AvgTicketPrice, Dest
# Init clients
cls.streaming_test_table = cls.create_streaming_table()
cls.streaming_test_table_query = cls.streaming_test_table + "| order by AvgTicketPrice asc, Dest asc"
cls.ai_test_table_cmd = ".show tables"
@classmethod
def create_streaming_table(cls):
with cls.get_client() as client:
table_name = f"StreamingTestTable{datetime.now():%Y%m%d%H%M%S}{random.randint(0, 10000)}"
streaming_table_format = (
"AvgTicketPrice:real,Cancelled:bool,Carrier:string,Dest:string,DestAirportID:string,DestCityName:string,"
"DestCountry:string,DestLocation:dynamic,DestRegion:string,DestWeather:string,DistanceKilometers:real,"
"DistanceMiles:real,FlightDelay:bool,FlightDelayMin:long,FlightDelayType:string,FlightNum:string,FlightTimeHour:real,"
"FlightTimeMin:real,Origin:string,OriginAirportID:string,OriginCityName:string,OriginCountry:string,"
"OriginLocation:dynamic,OriginRegion:string,OriginWeather:string,dayOfWeek:int,timestamp:datetime"
)
client.execute_mgmt(cls.test_db, f".create table {table_name} ({streaming_table_format})")
client.execute_mgmt(cls.test_db, f".ingest inline into table {table_name} <| {cls.test_streaming_data_csv_raw}")
return table_name
@classmethod
def teardown_class(cls):
with cls.get_client() as client:
client.execute_mgmt(cls.test_db, ".drop table {}".format(cls.streaming_test_table))
@classmethod
async def get_async_client(cls, app_insights=False) -> AsyncKustoClient:
return AsyncKustoClient(cls.engine_kcsb_from_env(app_insights, is_async=True))
@classmethod
def get_client(cls, app_insights=False) -> KustoClient:
kcsb = cls.engine_kcsb_from_env(app_insights, is_async=False)
kcsb.user_name_for_tracing = "E2E_Test_ΓΈ"
return KustoClient(kcsb)
@staticmethod
def normalize_row(row):
result = []
for r in row:
if type(r) == bool:
result.append(str(r).lower())
elif type(r) == datetime:
result.append(r.strftime("%Y-%m-%dT%H:%M:%SZ"))
elif type(r) == float:
result.append(r)
elif type(r) == dict:
result.append(json.dumps(r).replace(" ", ""))
else:
result.append(str(r))
return result
# assertions
def test_streaming_query(self):
with self.get_client() as client:
result = client.execute_streaming_query(self.test_db, self.streaming_test_table_query + ";" + self.streaming_test_table_query)
counter = 0
result.set_skip_incomplete_tables(True)
for primary in result.iter_primary_results():
counter += 1
for expected_row in self.test_streaming_data:
actual_row = self.normalize_row(next(primary).to_list())
for i in range(len(expected_row)):
if type(actual_row[i]) == float:
assert pytest.approx(float(expected_row[i]), 0.1) == actual_row[i]
else:
assert expected_row[i] == actual_row[i]
assert counter == 2
assert result.finished
assert result.errors_count == 0
assert result.get_exceptions() == []
@pytest.mark.asyncio
async def test_streaming_query_async(self):
async with await self.get_async_client() as client:
result = await client.execute_streaming_query(self.test_db, self.streaming_test_table_query + ";" + self.streaming_test_table_query)
counter = 0
result.set_skip_incomplete_tables(True)
async for primary in result.iter_primary_results():
counter += 1
streaming_data_iter = iter(self.test_streaming_data)
async for row in primary:
expected_row = next(streaming_data_iter, None)
if expected_row is None:
break
actual_row = self.normalize_row(row.to_list())
for i in range(len(expected_row)):
if type(actual_row[i]) == float:
assert pytest.approx(float(expected_row[i]), 0.1) == actual_row[i]
else:
assert expected_row[i] == actual_row[i]
assert counter == 2
assert result.finished
assert result.errors_count == 0
assert result.get_exceptions() == []
def test_streaming_query_internal(self):
with self.get_client() as client:
frames = client._execute_streaming_query_parsed(self.test_db, self.streaming_test_table_query)
initial_frame = next(frames)
expected_initial_frame = {
"FrameType": FrameType.DataSetHeader,
"IsProgressive": False,
"Version": "v2.0",
}
assert initial_frame == expected_initial_frame
query_props = next(frames)
assert query_props["FrameType"] == FrameType.DataTable
assert query_props["TableKind"] == WellKnownDataSet.QueryProperties.value
assert type(query_props["Columns"]) == list
assert type(query_props["Rows"]) == list
assert len(query_props["Rows"][0]) == len(query_props["Columns"])
primary_result = next(frames)
assert primary_result["FrameType"] == FrameType.DataTable
assert primary_result["TableKind"] == WellKnownDataSet.PrimaryResult.value
assert type(primary_result["Columns"]) == list
assert type(primary_result["Rows"]) != list
row = next(primary_result["Rows"])
assert len(row) == len(primary_result["Columns"])
@pytest.mark.asyncio
async def test_streaming_query_internal_async(self):
async with await self.get_async_client() as client:
frames = await client._execute_streaming_query_parsed(self.test_db, self.streaming_test_table_query)
frames.__aiter__()
initial_frame = await frames.__anext__()
expected_initial_frame = {
"FrameType": FrameType.DataSetHeader,
"IsProgressive": False,
"Version": "v2.0",
}
assert initial_frame == expected_initial_frame
query_props = await frames.__anext__()
assert query_props["FrameType"] == FrameType.DataTable
assert query_props["TableKind"] == WellKnownDataSet.QueryProperties.value
assert type(query_props["Columns"]) == list
assert type(query_props["Rows"]) == list
assert len(query_props["Rows"][0]) == len(query_props["Columns"])
primary_result = await frames.__anext__()
assert primary_result["FrameType"] == FrameType.DataTable
assert primary_result["TableKind"] == WellKnownDataSet.PrimaryResult.value
assert type(primary_result["Columns"]) == list
assert type(primary_result["Rows"]) != list
row = await primary_result["Rows"].__anext__()
assert len(row) == len(primary_result["Columns"])
def test_log_analytics_query(self):
if not self.ai_engine_cs:
pytest.skip("No application insights connection string provided")
with self.get_client(True) as client:
result = client.execute_mgmt(self.ai_test_db, self.ai_test_table_cmd)
counter = 0
expected_table_name = iter(self.application_insights_tables())
for primary in result.primary_results:
counter += 1
for row in primary.rows:
assert row["TableName"] == expected_table_name.__next__()
assert counter == 1
assert result.errors_count == 0
assert result.get_exceptions() == []
@pytest.mark.asyncio
async def test_log_analytics_query_async(self):
if not self.ai_engine_cs:
pytest.skip("No application insights connection string provided")
async with await self.get_async_client(True) as ai_client:
result = await ai_client.execute_mgmt(self.ai_test_db, self.ai_test_table_cmd)
counter = 0
expected_table_name = iter(self.application_insights_tables())
for primary in result.primary_results:
counter += 1
for row in primary.rows:
assert row["TableName"] == expected_table_name.__next__()
assert counter == 1
assert result.errors_count == 0
assert result.get_exceptions() == []
def test_cloud_info(self):
if ".dev." in self.engine_cs:
pytest.skip("This test is not relevant for dev clusters")
cloud_info = CloudSettings.get_cloud_info_for_cluster(self.engine_cs)
assert cloud_info is not CloudSettings.DEFAULT_CLOUD
assert cloud_info == CloudSettings.DEFAULT_CLOUD
assert cloud_info is CloudSettings.get_cloud_info_for_cluster(self.engine_cs)
assert cloud_info == CloudSettings.get_cloud_info_for_cluster(urljoin(self.engine_cs, "/test1/test2/test3"))
def test_cloud_info_404(self):
pytest.skip("This test is currently wrong - until all cluster are updated to the redirect uri, this test will fail")
cloud_info = CloudSettings.get_cloud_info_for_cluster("https://statusreturner.azurewebsites.net/404/test")
default_dev_cloud = dataclasses.replace(CloudSettings.DEFAULT_CLOUD, kusto_service_resource_id=DEFAULT_DEV_KUSTO_SERVICE_RESOURCE_ID)
assert cloud_info == CloudSettings.DEFAULT_CLOUD or cloud_info == default_dev_cloud
@pytest.mark.parametrize("code", [301, 302, 307, 308])
def test_no_redirects_fail_in_cloud(self, code):
pytest.skip("This test is currently not supported as it relies on the URI path witch we now ignore")
with KustoClient(
KustoConnectionStringBuilder.with_azure_token_credential(f"https://statusreturner.azurewebsites.net/{code}/nocloud", self.__class__.cred())
) as client:
with pytest.raises(KustoServiceError) as ex:
client.execute("db", "table")
assert ex.value.http_response.status_code == code
@pytest.mark.parametrize("code", [301, 302, 307, 308])
def test_no_redirects_fail_in_client(self, code):
well_known_kusto_endpoints.add_trusted_hosts([MatchRule("statusreturner.azurewebsites.net", False)], False)
with KustoClient(
KustoConnectionStringBuilder.with_azure_token_credential(f"https://statusreturner.azurewebsites.net/{code}/segment", self.__class__.cred())
) as client:
with pytest.raises(KustoServiceError) as ex:
client.execute("db", "table")
assert ex.value.http_response.status_code == code
@pytest.mark.asyncio
@pytest.mark.parametrize("code", [301, 302, 307, 308])
async def test_no_redirects_fail_in_cloud_async(self, code):
pytest.skip("This test is currently not supported as it relies on the URI path witch we now ignore")
async with AsyncKustoClient(
KustoConnectionStringBuilder.with_azure_token_credential(f"https://statusreturner.azurewebsites.net/{code}/nocloud", self.__class__.async_cred())
) as client:
with pytest.raises(KustoServiceError) as ex:
await client.execute("db", "table")
assert ex.value.http_response.status_code == code
@pytest.mark.asyncio
@pytest.mark.parametrize("code", [301, 302, 307, 308])
async def test_no_redirects_fail_in_client_async(self, code):
well_known_kusto_endpoints.add_trusted_hosts([MatchRule("statusreturner.azurewebsites.net", False)], False)
async with AsyncKustoClient(
KustoConnectionStringBuilder.with_azure_token_credential(f"https://statusreturner.azurewebsites.net/{code}/segment", self.__class__.async_cred())
) as client:
with pytest.raises(KustoServiceError) as ex:
await client.execute("db", "table")
assert ex.value.http_response.status == code
def test_semantic_error(self):
with self.get_client() as client:
with pytest.raises(KustoServiceError) as ex:
client.execute(self.test_db, "Nonexistent")
assert ex.value.is_semantic_error()
@pytest.mark.asyncio
async def test_semantic_error_async(self):
async with await self.get_async_client() as client:
with pytest.raises(KustoServiceError) as ex:
await client.execute(self.test_db, "Nonexistent")
assert ex.value.is_semantic_error()
|