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
|
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License
from datetime import timedelta
from azure.kusto.data import ClientRequestProperties, KustoConnectionStringBuilder
from azure.kusto.data.client_base import ExecuteRequestParams
def test_properties():
"""positive tests"""
defer = False
timeout = timedelta(seconds=10)
crp = ClientRequestProperties()
crp.set_option(ClientRequestProperties.results_defer_partial_query_failures_option_name, defer)
crp.set_option(ClientRequestProperties.request_timeout_option_name, timeout)
result = crp.to_json()
assert '"{0}": false'.format(crp.results_defer_partial_query_failures_option_name) in result
assert '"{0}": "0:00:10"'.format(ClientRequestProperties.request_timeout_option_name) in result
assert crp.client_request_id is None
assert crp.application is None
assert crp.user is None
crp.client_request_id = "CRID"
assert crp.client_request_id == "CRID"
crp.application = "myApp"
assert crp.application == "myApp"
crp.user = "myUser"
assert crp.user == "myUser"
def test_default_tracing_properties():
kcsb = KustoConnectionStringBuilder("test")
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
ClientRequestProperties(),
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert len(params.request_headers["x-ms-app"]) > 0
assert len(params.request_headers["x-ms-user"]) > 0
assert params.request_headers["x-ms-client-version"].startswith("Kusto.Python.Client:")
def test_custom_kcsb_tracing_properties():
kcsb = KustoConnectionStringBuilder("test")
kcsb.application_for_tracing = "myApp"
kcsb.user_name_for_tracing = "myUser"
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
ClientRequestProperties(),
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert params.request_headers["x-ms-app"] == "myApp"
assert params.request_headers["x-ms-user"] == "myUser"
def test_custom_crp_tracing_properties():
kcsb = KustoConnectionStringBuilder("test")
crp = ClientRequestProperties()
crp.application = "myApp2"
crp.user = "myUser2"
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
crp,
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert params.request_headers["x-ms-app"] == "myApp2"
assert params.request_headers["x-ms-user"] == "myUser2"
assert params.request_headers["x-ms-client-version"].startswith("Kusto.Python.Client:")
def test_custom_crp_tracing_properties_override_kcsb():
kcsb = KustoConnectionStringBuilder("test")
kcsb.application_for_tracing = "myApp"
kcsb.user_name_for_tracing = "myUser"
crp = ClientRequestProperties()
crp.application = "myApp2"
crp.user = "myUser2"
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
crp,
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert params.request_headers["x-ms-app"] == "myApp2"
assert params.request_headers["x-ms-user"] == "myUser2"
assert params.request_headers["x-ms-client-version"].startswith("Kusto.Python.Client:")
def test_set_connector_name_and_version():
kcsb = KustoConnectionStringBuilder("test")
kcsb._set_connector_details("myConnector", "myVersion", send_user=False)
crp = ClientRequestProperties()
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
ClientRequestProperties(),
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert params.request_headers["x-ms-user"] == "[none]"
assert params.request_headers["x-ms-client-version"].startswith("Kusto.Python.Client:")
assert params.request_headers["x-ms-app"].startswith("Kusto.myConnector:{myVersion}|App.")
def test_set_connector_no_app_version():
kcsb = KustoConnectionStringBuilder("test")
kcsb._set_connector_details("myConnector", "myVersion", app_name="myApp", send_user=True)
crp = ClientRequestProperties()
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
ClientRequestProperties(),
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert len(params.request_headers["x-ms-user"]) > 0
assert params.request_headers["x-ms-client-version"].startswith("Kusto.Python.Client:")
assert params.request_headers["x-ms-app"].startswith("Kusto.myConnector:{myVersion}|App.")
def test_set_connector_full():
kcsb = KustoConnectionStringBuilder("test")
kcsb._set_connector_details(
"myConnector",
"myVersion",
app_name="myApp",
app_version="myAppVersion",
send_user=True,
override_user="myUser",
additional_fields=[("myField", "myValue")],
)
crp = ClientRequestProperties()
params = ExecuteRequestParams._from_query(
"somequery",
"somedatabase",
crp,
{},
timedelta(seconds=10),
timedelta(seconds=10),
timedelta(seconds=10),
kcsb.client_details,
)
assert params.request_headers["x-ms-client-request-id"] is not None
assert params.request_headers["x-ms-user"] == "myUser"
assert params.request_headers["x-ms-client-version"].startswith("Kusto.Python.Client:")
assert params.request_headers["x-ms-app"] == "Kusto.myConnector:{myVersion}|App.{myApp}:{myAppVersion}|myField:{myValue}"
|
